1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4 ;;; Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
34 "Backups of edited data files."
37 (defgroup find-file nil
42 (defcustom delete-auto-save-files t
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
50 (defcustom directory-abbrev-alist
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
64 :type '(repeat (cons :format "%v"
71 ;; Turn off backup files on VMS since it has version numbers.
72 (defcustom make-backup-files (not (eq system-type 'vax-vms))
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The 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'."
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.
97 This variable is intended for use by making it local to a buffer.
98 But it is local only if you make it local.")
99 (put 'backup-inhibited 'permanent-local t)
101 (defcustom backup-by-copying nil
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
107 (defcustom backup-by-copying-when-linked nil
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
114 (defcustom backup-by-copying-when-mismatch nil
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
124 (defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
136 (defvar backup-enable-predicate 'normal-backup-enable-predicate
137 "Predicate that looks at a file name and decides whether to make backups.
138 Called with an absolute file name as argument, it returns t to enable backup.")
140 (defcustom buffer-offer-save nil
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
146 (make-variable-buffer-local 'buffer-offer-save)
148 (defcustom find-file-existing-other-name t
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
155 (defcustom find-file-visit-truename nil
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
162 (defcustom revert-without-query
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
169 :type '(repeat regexp)
172 (defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
176 If 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)
180 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
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)
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:"))
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 "The directory for writing temporary files."
199 (defcustom small-temporary-file-directory
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
206 :type '(choice (const nil) directory))
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
209 (defvar null-device "/dev/null" "The system null device.")
211 (defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
215 "[\000-\031]\\|" ; control characters
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
218 ((memq system-type '(ms-dos windows-nt))
219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
220 "[|<>\"?*\000-\031]")) ; invalid characters
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
224 (defcustom file-precious-flag nil
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
239 (defcustom version-control nil
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil 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))
250 (defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
256 (defcustom delete-old-versions nil
257 "*If t, delete excess backup versions silently.
258 If 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))
264 (defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
269 (defcustom kept-new-versions 2
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
275 (defcustom require-final-newline nil
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
279 :type '(choice (const :tag "Off" nil)
281 (other :tag "Ask" ask))
282 :group 'editing-basics)
284 (defcustom auto-save-default t
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
289 (defcustom auto-save-visited-file-name nil
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
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.
301 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
302 REGEXP is a regular expression to match against the file name.
303 If it matches, `replace-match' is used to replace the
304 matching part with REPLACEMENT.
305 If the optional element UNIQUIFY is non-nil, the auto-save file name is
306 constructed by taking the directory part of the replaced file-name,
307 concatenated with the buffer file name with all directory separators
308 changed to `!' to prevent clashes. This will not work
309 correctly if your filesystem truncates the resulting name.
311 All the transforms in the list are tried, in the order they are listed.
312 When one transform applies, its result is final;
313 no further transforms are tried.
315 The default value is set up to put the auto-save file into the
316 temporary directory (see the variable `temporary-file-directory') for
317 editing a remote file.
319 On MS-DOS filesystems without long names this variable is always
322 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
323 (boolean :tag "Uniquify")))
326 (defcustom save-abbrevs t
327 "*Non-nil means save word abbrevs too when files are saved.
328 If `silently', don't ask the user before saving."
329 :type '(choice (const t) (const nil) (const silently))
332 (defcustom find-file-run-dired t
333 "*Non-nil means allow `find-file' to visit directories.
334 To visit the directory, `find-file' runs `find-directory-functions'."
338 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
339 "*List of functions to try in sequence to visit a directory.
340 Each function is called with the directory name as the sole argument
341 and should return either a buffer or nil."
342 :type '(hook :options (cvs-dired-noselect dired-noselect))
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.
349 These functions are called as soon as the error is detected.
350 Variable `buffer-file-name' is already set up.
351 The 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")
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.
360 The buffer's local variables (if any) will have been processed before the
361 functions are called.")
362 (defvaralias 'find-file-hooks 'find-file-hook)
363 (make-obsolete-variable 'find-file-hooks 'find-file-hook "21.4")
365 (defvar write-file-functions nil
366 "List of functions to be called before writing out a buffer to a file.
367 If one of them returns non-nil, the file is considered already written
368 and the rest are not called.
369 These hooks are considered to pertain to the visited file.
370 So any buffer-local binding of this variable is discarded if you change
371 the visited file name with \\[set-visited-file-name], but not when you
372 change the major mode.
374 See 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")
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")
384 (defvar write-contents-functions nil
385 "List of functions to be called before writing out a buffer to a file.
386 If one of them returns non-nil, the file is considered already written
387 and the rest are not called.
389 This variable is meant to be used for hooks that pertain to the
390 buffer's contents, not to the particular visited file; thus,
391 `set-visited-file-name' does not clear this variable; but changing the
392 major mode does clear it.
394 See 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")
399 (defcustom enable-local-variables t
400 "*Control use of local variables in files you visit.
401 The value can be t, nil or something else.
402 A value of t means file local variables specifications are obeyed;
403 nil means they are ignored; anything else means query.
404 This variable also controls use of major modes specified in
407 The command \\[normal-mode], when used interactively,
408 always obeys file local variable specifications and the -*- line,
409 and ignores this variable."
410 :type '(choice (const :tag "Obey" t)
411 (const :tag "Ignore" nil)
412 (other :tag "Query" other))
415 (defvar local-enable-local-variables t
416 "Like `enable-local-variables' but meant for buffer-local bindings.
417 The meaningful values are nil and non-nil. The default is non-nil.
418 If a major mode sets this to nil, buffer-locally, then any local
419 variables list in the file will be ignored.
421 This variable does not affect the use of major modes
422 specified in a -*- line.")
424 (defcustom enable-local-eval 'maybe
425 "*Control processing of the \"variable\" `eval' in a file's local variables.
426 The value can be t, nil or something else.
427 A value of t means obey `eval' variables;
428 nil means ignore them; anything else means query.
430 The command \\[normal-mode] always obeys local-variables lists
431 and ignores this variable."
432 :type '(choice (const :tag "Obey" t)
433 (const :tag "Ignore" nil)
434 (other :tag "Query" other))
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))
445 (defvar view-read-only nil
446 "*Non-nil means buffers visiting files read-only, do it in view mode.")
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.
451 Runs 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
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))
463 (defun convert-standard-filename (filename)
464 "Convert a standard file's name to something suitable for the current OS.
465 This function's standard definition is trivial; it just returns the argument.
466 However, on some systems, the function is redefined with a definition
467 that really does change some file names to canonicalize certain
468 patterns and to guarantee valid names."
471 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
472 "Read directory name, prompting with PROMPT and completing in directory DIR.
473 Value is not expanded---you must call `expand-file-name' yourself.
474 Default 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.)
477 Fourth arg MUSTMATCH non-nil means require existing directory's name.
478 Non-nil and non-t means also require confirmation after completion.
479 Fifth arg INITIAL specifies text to start with.
480 DIR defaults to current buffer's directory default."
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
491 "Show the current default directory."
493 (message "Directory %s" default-directory))
496 "Value of the CDPATH environment variable, as a list.
497 Not actually set up until the first time you use it.")
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.
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))
509 (list (if (= cd-start cd-colon)
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)))
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))))
533 "Make DIR become the current buffer's default directory.
534 If your environment includes a `CDPATH' variable, try each one of that
535 colon-separated list of directories when resolving a relative directory name."
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))
544 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
545 (setq cd-path (or trypath (list "./")))))
546 (if (not (catch 'found
548 (function (lambda (x)
549 (let ((f (expand-file-name (concat x dir))))
550 (if (file-directory-p f)
553 (throw 'found t))))))
556 (error "No such directory found via CDPATH environment variable"))))
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))
566 (defun locate-file (filename path &optional suffixes predicate)
567 "Search for FILENAME through PATH.
568 If SUFFIXES is non-nil, it should be a list of suffixes to append to
569 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
570 If non-nil, PREDICATE is used instead of `file-readable-p'.
571 PREDICATE can also be an integer to pass to the `access' system call,
572 in which case file-name handlers are ignored. This usage is deprecated.
574 For compatibility, PREDICATE can also be one of the symbols
575 `executable', `readable', `writable', or `exists', or a list of
576 one 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)))
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))
586 (defun locate-file-completion (string path-and-suffixes action)
587 "Do completion for file names passed to `locate-file'.
588 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
589 (if (file-name-absolute-p string)
590 (read-file-name-internal string nil action)
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)))))
604 ((eq action t) (all-completions string names))
605 ((null action) (try-completion string names))
606 (t (test-completion string names))))))
608 (defun load-library (library)
609 "Load the library named LIBRARY.
610 This is an interface to the function `load'."
612 (list (completing-read "Load library: "
613 'locate-file-completion
614 (cons load-path load-suffixes))))
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)))
621 (get handler 'file-remote-p))))
623 (defun file-local-copy (file)
624 "Copy the file FILE into a temporary file on this machine.
625 Returns the name of the local copy, or nil, if FILE is directly
627 ;; This formerly had an optional BUFFER argument that wasn't used by
629 (let ((handler (find-file-name-handler file 'file-local-copy)))
631 (funcall handler 'file-local-copy file)
634 (defun file-truename (filename &optional counter prev-dirs)
635 "Return the truename of FILENAME, which should be absolute.
636 The truename of a file name is found by chasing symbolic links
637 both at the level of the file and at the level of the directories
638 containing it, until no links are left at any level.
640 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
641 Do 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.
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)))
652 (setq filename (expand-file-name filename))
653 (if (string= filename "")
654 (setq filename "/"))))
655 (or counter (setq counter (list 100)))
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)))
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))
680 ;; For file name that has a special handler, call handler.
681 ;; This is so that ange-ftp can save time by doing a no-op.
683 (setq filename (funcall handler 'file-truename filename))
684 ;; If filename contains a wildcard, newname will be the old name.
685 (if (string-match "[[*?]" filename)
686 (setq newname filename)
687 ;; If filename doesn't exist, newname will be nil.
688 (setq newname (w32-long-file-name filename)))
689 (setq filename (or newname filename)))
692 ;; If this file directly leads to a link, process that iteratively
693 ;; so that we don't use lots of stack.
695 (setcar counter (1- (car counter)))
696 (if (< (car counter) 0)
697 (error "Apparent cycle of symbolic links for %s" filename))
698 (let ((handler (find-file-name-handler filename 'file-truename)))
699 ;; For file name that has a special handler, call handler.
700 ;; This is so that ange-ftp can save time by doing a no-op.
702 (setq filename (funcall handler 'file-truename filename)
704 (let ((dir (or (file-name-directory filename) default-directory))
706 ;; Get the truename of the directory.
707 (setq dirfile (directory-file-name dir))
708 ;; If these are equal, we have the (or a) root directory.
709 (or (string= dir dirfile)
710 ;; If this is the same dir we last got the truename for,
711 ;; save time--don't recalculate.
712 (if (assoc dir (car prev-dirs))
713 (setq dir (cdr (assoc dir (car prev-dirs))))
715 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
716 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
718 (if (equal ".." (file-name-nondirectory filename))
720 (directory-file-name (file-name-directory (directory-file-name dir)))
722 (if (equal "." (file-name-nondirectory filename))
723 (setq filename (directory-file-name dir)
725 ;; Put it back on the file name.
726 (setq filename (concat dir (file-name-nondirectory filename)))
727 ;; Is the file name the name of a link?
728 (setq target (file-symlink-p filename))
730 ;; Yes => chase that link, then start all over
731 ;; since the link may point to a directory name that uses links.
732 ;; We can't safely use expand-file-name here
733 ;; since target might look like foo/../bar where foo
734 ;; is itself a link. Instead, we handle . and .. above.
736 (if (file-name-absolute-p target)
744 (defun file-chase-links (filename)
745 "Chase links in FILENAME until a name that is not a link.
746 Does not examine containing directories for links,
747 unlike `file-truename'."
748 (let (tem (count 100) (newname filename))
749 (while (setq tem (file-symlink-p newname))
752 (error "Apparent cycle of symbolic links for %s" filename))
753 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
754 (while (string-match "//+" tem)
755 (setq tem (replace-match "/" nil nil tem)))
756 ;; Handle `..' by hand, since it needs to work in the
757 ;; target of any directory symlink.
758 ;; This code is not quite complete; it does not handle
759 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
760 (while (string-match "\\`\\.\\./" tem)
761 (setq tem (substring tem 3))
762 (setq newname (expand-file-name newname))
763 ;; Chase links in the default dir of the symlink.
766 (directory-file-name (file-name-directory newname))))
767 ;; Now find the parent of that dir.
768 (setq newname (file-name-directory newname)))
769 (setq newname (expand-file-name tem (file-name-directory newname)))
770 (setq count (1- count))))
773 (defun switch-to-buffer-other-window (buffer &optional norecord)
774 "Select buffer BUFFER in another window.
775 Optional second arg NORECORD non-nil means
776 do not put this buffer at the front of the list of recently selected ones.
778 This uses the function `display-buffer' as a subroutine; see its
779 documentation for additional customization information."
780 (interactive "BSwitch to buffer in other window: ")
781 (let ((pop-up-windows t))
782 (pop-to-buffer buffer t norecord)))
784 (defun switch-to-buffer-other-frame (buffer &optional norecord)
785 "Switch to buffer BUFFER in another frame.
786 Optional second arg NORECORD non-nil means
787 do not put this buffer at the front of the list of recently selected ones.
789 This uses the function `display-buffer' as a subroutine; see its
790 documentation for additional customization information."
791 (interactive "BSwitch to buffer in other frame: ")
792 (let ((pop-up-frames t))
793 (pop-to-buffer buffer t norecord)
794 (raise-frame (window-frame (selected-window)))))
796 (defvar find-file-default nil
797 "Used within `find-file-read-args'.")
799 (defun find-file-read-args (prompt mustmatch)
800 (list (let ((find-file-default
801 (and buffer-file-name
802 (abbreviate-file-name buffer-file-name)))
805 (setq minibuffer-default find-file-default)
806 ;; Clear out this hook so it does not interfere
807 ;; with any recursive minibuffer usage.
808 (pop minibuffer-setup-hook)))
809 (minibuffer-setup-hook
810 minibuffer-setup-hook))
811 (add-hook 'minibuffer-setup-hook munge-default-fun)
812 (read-file-name prompt nil default-directory mustmatch))
815 (defun find-file (filename &optional wildcards)
817 Switch to a buffer visiting file FILENAME,
818 creating one if none already exists.
819 Interactively, the default if you just type RET is the current directory,
820 but the visited file name is available through the minibuffer history:
821 type M-n to pull it into the minibuffer.
823 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
824 expand wildcards (if any) and visit multiple files. Wildcard expansion
825 can be suppressed by setting `find-file-wildcards'."
827 (find-file-read-args "Find file: " nil))
828 (let ((value (find-file-noselect filename nil nil wildcards)))
830 (mapcar 'switch-to-buffer (nreverse value))
831 (switch-to-buffer value))))
833 (defun find-file-other-window (filename &optional wildcards)
834 "Edit file FILENAME, in another window.
835 May create a new window, or reuse an existing one.
836 See the function `display-buffer'.
838 Interactively, the default if you just type RET is the current directory,
839 but the visited file name is available through the minibuffer history:
840 type M-n to pull it into the minibuffer.
842 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
843 expand wildcards (if any) and visit multiple files."
844 (interactive (find-file-read-args "Find file in other window: " nil))
845 (let ((value (find-file-noselect filename nil nil wildcards)))
848 (setq value (nreverse value))
849 (switch-to-buffer-other-window (car value))
850 (mapcar 'switch-to-buffer (cdr value)))
851 (switch-to-buffer-other-window value))))
853 (defun find-file-other-frame (filename &optional wildcards)
854 "Edit file FILENAME, in another frame.
855 May create a new frame, or reuse an existing one.
856 See the function `display-buffer'.
858 Interactively, the default if you just type RET is the current directory,
859 but the visited file name is available through the minibuffer history:
860 type M-n to pull it into the minibuffer.
862 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
863 expand wildcards (if any) and visit multiple files."
864 (interactive (find-file-read-args "Find file in other frame: " nil))
865 (let ((value (find-file-noselect filename nil nil wildcards)))
868 (setq value (nreverse value))
869 (switch-to-buffer-other-frame (car value))
870 (mapcar 'switch-to-buffer (cdr value)))
871 (switch-to-buffer-other-frame value))))
873 (defun find-file-read-only (filename &optional wildcards)
874 "Edit file FILENAME but don't allow changes.
875 Like \\[find-file] but marks buffer as read-only.
876 Use \\[toggle-read-only] to permit editing."
877 (interactive (find-file-read-args "Find file read-only: " t))
878 (find-file filename wildcards)
882 (defun find-file-read-only-other-window (filename &optional wildcards)
883 "Edit file FILENAME in another window but don't allow changes.
884 Like \\[find-file-other-window] but marks buffer as read-only.
885 Use \\[toggle-read-only] to permit editing."
886 (interactive (find-file-read-args "Find file read-only other window: " t))
887 (find-file-other-window filename wildcards)
891 (defun find-file-read-only-other-frame (filename &optional wildcards)
892 "Edit file FILENAME in another frame but don't allow changes.
893 Like \\[find-file-other-frame] but marks buffer as read-only.
894 Use \\[toggle-read-only] to permit editing."
895 (interactive (find-file-read-args "Find file read-only other frame: " t))
896 (find-file-other-frame filename wildcards)
900 (defun find-alternate-file-other-window (filename)
901 "Find file FILENAME as a replacement for the file in the next window.
902 This command does not select that window."
904 (save-selected-window
906 (let ((file buffer-file-name)
910 (setq file-name (file-name-nondirectory file)
911 file-dir (file-name-directory file)))
912 (list (read-file-name
913 "Find alternate file: " file-dir nil nil file-name)))))
915 (find-file-other-window filename)
916 (save-selected-window
918 (find-alternate-file filename))))
920 (defun find-alternate-file (filename)
921 "Find file FILENAME, select its buffer, kill previous buffer.
922 If the current buffer now contains an empty file that you just visited
923 \(presumably by mistake), use this command to visit the file you really want."
925 (let ((file buffer-file-name)
929 (setq file-name (file-name-nondirectory file)
930 file-dir (file-name-directory file)))
931 (list (read-file-name
932 "Find alternate file: " file-dir nil nil file-name))))
933 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
935 (when (and (buffer-modified-p) (buffer-file-name))
936 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
939 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
941 (let ((obuf (current-buffer))
942 (ofile buffer-file-name)
943 (onum buffer-file-number)
944 (otrue buffer-file-truename)
945 (oname (buffer-name)))
946 (if (get-buffer " **lose**")
947 (kill-buffer " **lose**"))
948 (rename-buffer " **lose**")
952 (setq buffer-file-name nil)
953 (setq buffer-file-number nil)
954 (setq buffer-file-truename nil)
955 (find-file filename))
956 (when (eq obuf (current-buffer))
957 ;; This executes if find-file gets an error
958 ;; and does not really find anything.
959 ;; We put things back as they were.
960 ;; If find-file actually finds something, we kill obuf below.
961 (setq buffer-file-name ofile)
962 (setq buffer-file-number onum)
963 (setq buffer-file-truename otrue)
965 (rename-buffer oname)))
966 (unless (eq (current-buffer) obuf)
967 (with-current-buffer obuf
968 ;; We already asked; don't ask again.
969 (let ((kill-buffer-query-functions))
970 (kill-buffer obuf))))))
972 (defun create-file-buffer (filename)
973 "Create a suitably named buffer for visiting FILENAME, and return it.
974 FILENAME (sans directory) is used unchanged if that name is free;
975 otherwise a string <2> or <3> or ... is appended to get an unused name."
976 (let ((lastname (file-name-nondirectory filename)))
977 (if (string= lastname "")
978 (setq lastname filename))
979 (generate-new-buffer lastname)))
981 (defun generate-new-buffer (name)
982 "Create and return a buffer with a name based on NAME.
983 Choose the buffer's name using `generate-new-buffer-name'."
984 (get-buffer-create (generate-new-buffer-name name)))
986 (defcustom automount-dir-prefix "^/tmp_mnt/"
987 "Regexp to match the automounter prefix in a directory name."
991 (defvar abbreviated-home-dir nil
992 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
994 (defun abbreviate-file-name (filename)
995 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
996 This also substitutes \"~\" for the user's home directory.
997 Type \\[describe-variable] directory-abbrev-alist RET for more information."
998 ;; Get rid of the prefixes added by the automounter.
999 (if (and automount-dir-prefix
1000 (string-match automount-dir-prefix filename)
1001 (file-exists-p (file-name-directory
1002 (substring filename (1- (match-end 0))))))
1003 (setq filename (substring filename (1- (match-end 0)))))
1004 (let ((tail directory-abbrev-alist))
1005 ;; If any elt of directory-abbrev-alist matches this name,
1006 ;; abbreviate accordingly.
1008 (if (string-match (car (car tail)) filename)
1010 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1011 (setq tail (cdr tail)))
1012 ;; Compute and save the abbreviated homedir name.
1013 ;; We defer computing this until the first time it's needed, to
1014 ;; give time for directory-abbrev-alist to be set properly.
1015 ;; We include a slash at the end, to avoid spurious matches
1016 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1017 (or abbreviated-home-dir
1018 (setq abbreviated-home-dir
1019 (let ((abbreviated-home-dir "$foo"))
1020 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1023 ;; If FILENAME starts with the abbreviated homedir,
1024 ;; make it start with `~' instead.
1025 (if (and (string-match abbreviated-home-dir filename)
1026 ;; If the home dir is just /, don't change it.
1027 (not (and (= (match-end 0) 1)
1028 (= (aref filename 0) ?/)))
1029 ;; MS-DOS root directories can come with a drive letter;
1030 ;; Novell Netware allows drive letters beyond `Z:'.
1031 (not (and (or (eq system-type 'ms-dos)
1032 (eq system-type 'windows-nt))
1034 (string-match "^[a-zA-`]:/$" filename)))))
1037 (substring filename (match-beginning 1) (match-end 1))
1038 (substring filename (match-end 0)))))
1041 (defcustom find-file-not-true-dirname-list nil
1042 "*List of logical names for which visiting shouldn't save the true dirname.
1043 On VMS, when you visit a file using a logical name that searches a path,
1044 you may or may not want the visited file name to record the specific
1045 directory where the file was found. If you *do not* want that, add the logical
1046 name to this list as a string."
1047 :type '(repeat (string :tag "Name"))
1050 (defun find-buffer-visiting (filename)
1051 "Return the buffer visiting file FILENAME (a string).
1052 This is like `get-file-buffer', except that it checks for any buffer
1053 visiting the same file, possibly under a different name.
1054 If there is no such live buffer, return nil."
1055 (let ((buf (get-file-buffer filename))
1056 (truename (abbreviate-file-name (file-truename filename))))
1058 (let ((list (buffer-list)) found)
1059 (while (and (not found) list)
1061 (set-buffer (car list))
1062 (if (and buffer-file-name
1063 (string= buffer-file-truename truename))
1064 (setq found (car list))))
1065 (setq list (cdr list)))
1067 (let* ((attributes (file-attributes truename))
1068 (number (nthcdr 10 attributes))
1069 (list (buffer-list)) found)
1070 (and buffer-file-numbers-unique
1072 (while (and (not found) list)
1073 (with-current-buffer (car list)
1074 (if (and buffer-file-name
1075 (equal buffer-file-number number)
1076 ;; Verify this buffer's file number
1077 ;; still belongs to its file.
1078 (file-exists-p buffer-file-name)
1079 (equal (file-attributes buffer-file-truename)
1081 (setq found (car list))))
1082 (setq list (cdr list))))
1085 (defcustom find-file-wildcards t
1086 "*Non-nil means file-visiting commands should handle wildcards.
1087 For example, if you specify `*.c', that would visit all the files
1088 whose names match the pattern."
1093 (defcustom find-file-suppress-same-file-warnings nil
1094 "*Non-nil means suppress warning messages for symlinked files.
1095 When nil, Emacs prints a warning when visiting a file that is already
1096 visited, but with a different name. Setting this option to t
1097 suppresses this warning."
1102 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1103 "Read file FILENAME into a buffer and return the buffer.
1104 If a buffer exists visiting FILENAME, return that one, but
1105 verify that the file has not changed since visited or saved.
1106 The buffer is not selected, just returned to the caller.
1107 Optional first arg NOWARN non-nil means suppress any warning messages.
1108 Optional second arg RAWFILE non-nil means the file is read literally.
1109 Optional third arg WILDCARDS non-nil means do wildcard processing
1110 and visit all the matching files. When wildcards are actually
1111 used and expanded, the value is a list of buffers
1112 that are visiting the various files."
1114 (abbreviate-file-name
1115 (expand-file-name filename)))
1116 (if (file-directory-p filename)
1117 (or (and find-file-run-dired
1118 (run-hook-with-args-until-success
1119 'find-directory-functions
1120 (if find-file-visit-truename
1121 (abbreviate-file-name (file-truename filename))
1123 (error "%s is a directory" filename))
1126 (not (string-match "\\`/:" filename))
1127 (string-match "[[*?]" filename))
1128 (let ((files (condition-case nil
1129 (file-expand-wildcards filename t)
1130 (error (list filename))))
1131 (find-file-wildcards nil))
1133 (find-file-noselect filename)
1134 (mapcar #'find-file-noselect files)))
1135 (let* ((buf (get-file-buffer filename))
1136 (truename (abbreviate-file-name (file-truename filename)))
1137 (number (nthcdr 10 (file-attributes truename)))
1138 ;; Find any buffer for a file which has same truename.
1139 (other (and (not buf) (find-buffer-visiting filename))))
1140 ;; Let user know if there is a buffer with the same truename.
1144 find-file-suppress-same-file-warnings
1145 (string-equal filename (buffer-file-name other))
1146 (message "%s and %s are the same file"
1147 filename (buffer-file-name other)))
1148 ;; Optionally also find that buffer.
1149 (if (or find-file-existing-other-name find-file-visit-truename)
1152 ;; We are using an existing buffer.
1155 (verify-visited-file-modtime buf)
1156 (cond ((not (file-exists-p filename))
1157 (error "File %s no longer exists!" filename))
1158 ;; Certain files should be reverted automatically
1159 ;; if they have changed on disk and not in the buffer.
1160 ((and (not (buffer-modified-p buf))
1161 (let ((tail revert-without-query)
1164 (if (string-match (car tail) filename)
1166 (setq tail (cdr tail)))
1168 (with-current-buffer buf
1169 (message "Reverting file %s..." filename)
1171 (message "Reverting file %s...done" filename)))
1173 (if (string= (file-name-nondirectory filename)
1176 (if (buffer-modified-p buf)
1177 "File %s changed on disk. Discard your edits? "
1178 "File %s changed on disk. Reread from disk? ")
1179 (file-name-nondirectory filename))
1181 (if (buffer-modified-p buf)
1182 "File %s changed on disk. Discard your edits in %s? "
1183 "File %s changed on disk. Reread from disk into %s? ")
1184 (file-name-nondirectory filename)
1185 (buffer-name buf))))
1186 (with-current-buffer buf
1187 (revert-buffer t t)))))
1188 (with-current-buffer buf
1190 ;; Check if a formerly read-only file has become
1191 ;; writable and vice versa, but if the buffer agrees
1192 ;; with the new state of the file, that is ok too.
1193 (let ((read-only (not (file-writable-p buffer-file-name))))
1194 (unless (or (eq read-only buffer-file-read-only)
1195 (eq read-only buffer-read-only))
1198 (format "File %s is %s on disk. Change buffer mode? "
1200 (if read-only "read-only" "writable"))))
1201 (y-or-n-p question)))
1202 (setq buffer-read-only read-only)))
1203 (setq buffer-file-read-only read-only))
1205 (when (and (not (eq (not (null rawfile))
1206 (not (null find-file-literally))))
1207 ;; It is confusing to ask whether to visit
1208 ;; non-literally if they have the file in
1210 (not (eq major-mode 'hexl-mode)))
1211 (if (buffer-modified-p)
1212 (if (y-or-n-p (if rawfile
1213 "Save file and revisit literally? "
1214 "Save file and revisit non-literally? "))
1217 (find-file-noselect-1 buf filename nowarn
1218 rawfile truename number))
1219 (if (y-or-n-p (if rawfile
1220 "Discard your edits and revisit file literally? "
1221 "Discard your edits and revisit file non-literally? "))
1222 (find-file-noselect-1 buf filename nowarn
1223 rawfile truename number)
1224 (error (if rawfile "File already visited non-literally"
1225 "File already visited literally"))))
1226 (if (y-or-n-p (if rawfile
1227 "Revisit file literally? "
1228 "Revisit file non-literally? "))
1229 (find-file-noselect-1 buf filename nowarn
1230 rawfile truename number)
1231 (error (if rawfile "File already visited non-literally"
1232 "File already visited literally"))))))
1233 ;; Return the buffer we are using.
1235 ;; Create a new buffer.
1236 (setq buf (create-file-buffer filename))
1237 (set-buffer-major-mode buf)
1238 ;; find-file-noselect-1 may use a different buffer.
1239 (find-file-noselect-1 buf filename nowarn
1240 rawfile truename number))))))
1242 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1243 (let ((inhibit-read-only t)
1245 (with-current-buffer buf
1246 (kill-local-variable 'find-file-literally)
1247 ;; Needed in case we are re-visiting the file with a different
1248 ;; text representation.
1249 (kill-local-variable 'buffer-file-coding-system)
1251 (and (default-value 'enable-multibyte-characters)
1253 (set-buffer-multibyte t))
1256 (insert-file-contents-literally filename t)
1258 (when (and (file-exists-p filename)
1259 (not (file-readable-p filename)))
1261 (signal 'file-error (list "File is not readable"
1263 ;; Unconditionally set error
1266 (insert-file-contents filename t)
1268 (when (and (file-exists-p filename)
1269 (not (file-readable-p filename)))
1271 (signal 'file-error (list "File is not readable"
1273 ;; Run find-file-not-found-hooks until one returns non-nil.
1274 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1275 ;; If they fail too, set error.
1277 ;; Record the file's truename, and maybe use that as visited name.
1278 (if (equal filename buffer-file-name)
1279 (setq buffer-file-truename truename)
1280 (setq buffer-file-truename
1281 (abbreviate-file-name (file-truename buffer-file-name))))
1282 (setq buffer-file-number number)
1283 ;; On VMS, we may want to remember which directory in a search list
1284 ;; the file was found in.
1285 (and (eq system-type 'vax-vms)
1287 (if (string-match ":" (file-name-directory filename))
1288 (setq logical (substring (file-name-directory filename)
1289 0 (match-beginning 0))))
1290 (not (member logical find-file-not-true-dirname-list)))
1291 (setq buffer-file-name buffer-file-truename))
1292 (if find-file-visit-truename
1293 (setq buffer-file-name
1295 (expand-file-name buffer-file-truename))))
1296 ;; Set buffer's default directory to that of the file.
1297 (setq default-directory (file-name-directory buffer-file-name))
1298 ;; Turn off backup files for certain file names. Since
1299 ;; this is a permanent local, the major mode won't eliminate it.
1300 (and (not (funcall backup-enable-predicate buffer-file-name))
1302 (make-local-variable 'backup-inhibited)
1303 (setq backup-inhibited t)))
1306 (set-buffer-multibyte nil)
1307 (setq buffer-file-coding-system 'no-conversion)
1308 (make-local-variable 'find-file-literally)
1309 (setq find-file-literally t))
1310 (after-find-file error (not nowarn)))
1313 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1314 "Like `insert-file-contents', but only reads in the file literally.
1315 A buffer may be modified in several ways after reading into the buffer,
1316 to Emacs features such as format decoding, character code
1317 conversion, `find-file-hook', automatic uncompression, etc.
1319 This function ensures that none of these modifications will take place."
1320 (let ((format-alist nil)
1321 (after-insert-file-functions nil)
1322 (coding-system-for-read 'no-conversion)
1323 (coding-system-for-write 'no-conversion)
1324 (find-buffer-file-type-function
1325 (if (fboundp 'find-buffer-file-type)
1326 (symbol-function 'find-buffer-file-type)
1328 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1329 (inhibit-file-name-operation 'insert-file-contents))
1332 (fset 'find-buffer-file-type (lambda (filename) t))
1333 (insert-file-contents filename visit beg end replace))
1334 (if find-buffer-file-type-function
1335 (fset 'find-buffer-file-type find-buffer-file-type-function)
1336 (fmakunbound 'find-buffer-file-type)))))
1338 (defun insert-file-literally (filename)
1339 "Insert contents of file FILENAME into buffer after point with no conversion.
1341 This function is meant for the user to run interactively.
1342 Don't call it from programs! Use `insert-file-contents-literally' instead.
1343 \(Its calling sequence is different; see its documentation)."
1344 (interactive "*fInsert file literally: ")
1345 (if (file-directory-p filename)
1346 (signal 'file-error (list "Opening input file" "file is a directory"
1348 (let ((tem (insert-file-contents-literally filename)))
1349 (push-mark (+ (point) (car (cdr tem))))))
1351 (defvar find-file-literally nil
1352 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1353 This is a permanent local.")
1354 (put 'find-file-literally 'permanent-local t)
1356 (defun find-file-literally (filename)
1357 "Visit file FILENAME with no conversion of any kind.
1358 Format conversion and character code conversion are both disabled,
1359 and multibyte characters are disabled in the resulting buffer.
1360 The major mode used is Fundamental mode regardless of the file name,
1361 and local variable specifications in the file are ignored.
1362 Automatic uncompression and adding a newline at the end of the
1363 file due to `require-final-newline' is also disabled.
1365 You cannot absolutely rely on this function to result in
1366 visiting the file literally. If Emacs already has a buffer
1367 which is visiting the file, you get the existing buffer,
1368 regardless of whether it was created literally or not.
1370 In a Lisp program, if you want to be sure of accessing a file's
1371 contents literally, you should create a temporary buffer and then read
1372 the file contents into it using `insert-file-contents-literally'."
1373 (interactive "FFind file literally: ")
1374 (switch-to-buffer (find-file-noselect filename nil t)))
1376 (defvar after-find-file-from-revert-buffer nil)
1378 (defun after-find-file (&optional error warn noauto
1379 after-find-file-from-revert-buffer
1381 "Called after finding a file and by the default revert function.
1382 Sets buffer mode, parses local variables.
1383 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1384 error in reading the file. WARN non-nil means warn if there
1385 exists an auto-save file more recent than the visited file.
1386 NOAUTO means don't mess with auto-save mode.
1387 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1388 means this call was from `revert-buffer'.
1389 Fifth arg NOMODES non-nil means don't alter the file's modes.
1390 Finishes by calling the functions in `find-file-hook'
1391 unless NOMODES is non-nil."
1392 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1399 ((and error (file-attributes buffer-file-name))
1400 (setq buffer-read-only t)
1401 "File exists, but cannot be read")
1402 ((not buffer-read-only)
1404 ;; No need to warn if buffer is auto-saved
1405 ;; under the name of the visited file.
1406 (not (and buffer-file-name
1407 auto-save-visited-file-name))
1408 (file-newer-than-file-p (or buffer-auto-save-file-name
1409 (make-auto-save-file-name))
1411 (format "%s has auto save data; consider M-x recover-this-file"
1412 (file-name-nondirectory buffer-file-name))
1413 (setq not-serious t)
1414 (if error "(New file)" nil)))
1416 (setq not-serious t)
1417 "Note: file is write protected")
1418 ((file-attributes (directory-file-name default-directory))
1419 "File not found and directory write-protected")
1420 ((file-exists-p (file-name-directory buffer-file-name))
1421 (setq buffer-read-only nil))
1423 (setq buffer-read-only nil)
1424 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1425 "Use M-x make-directory RET RET to create the directory"
1426 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1429 (or not-serious (sit-for 1 nil t))))
1430 (when (and auto-save-default (not noauto))
1431 (auto-save-mode t)))
1432 ;; Make people do a little extra work (C-x C-q)
1433 ;; before altering a backup file.
1434 (when (backup-file-name-p buffer-file-name)
1435 (setq buffer-read-only t))
1436 ;; When a file is marked read-only,
1437 ;; make the buffer read-only even if root is looking at it.
1438 (when (and (file-modes (buffer-file-name))
1439 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1440 (setq buffer-read-only t))
1442 (when (and view-read-only view-mode)
1443 (view-mode-disable))
1445 (when (and buffer-read-only
1447 (not (eq (get major-mode 'mode-class) 'special)))
1449 (run-hooks 'find-file-hook)))
1451 (defun normal-mode (&optional find-file)
1452 "Choose the major mode for this buffer automatically.
1453 Also sets up any specified local variables of the file.
1454 Uses the visited file name, the -*- line, and the local variables spec.
1456 This function is called automatically from `find-file'. In that case,
1457 we may set up the file-specified mode and local variables,
1458 depending on the value of `enable-local-variables': if it is t, we do;
1459 if it is nil, we don't; otherwise, we query.
1460 In addition, if `local-enable-local-variables' is nil, we do
1461 not set local variables (though we do notice a mode specified with -*-.)
1463 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1464 or from Lisp without specifying the optional argument FIND-FILE;
1465 in that case, this function acts as if `enable-local-variables' were t."
1467 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1470 (error (message "File mode specification error: %s"
1471 (prin1-to-string err))))
1473 (let ((enable-local-variables (or (not find-file)
1474 enable-local-variables)))
1475 (hack-local-variables))
1476 (error (message "File local-variables error: %s"
1477 (prin1-to-string err)))))
1479 (defvar auto-mode-alist
1482 (cons (purecopy (car elt)) (cdr elt)))
1483 '(("\\.te?xt\\'" . text-mode)
1484 ("\\.c\\'" . c-mode)
1485 ("\\.h\\'" . c-mode)
1486 ("\\.tex\\'" . tex-mode)
1487 ("\\.ltx\\'" . latex-mode)
1488 ("\\.el\\'" . emacs-lisp-mode)
1489 ("\\.scm\\'" . scheme-mode)
1490 ("\\.l\\'" . lisp-mode)
1491 ("\\.lisp\\'" . lisp-mode)
1492 ("\\.f\\'" . fortran-mode)
1493 ("\\.F\\'" . fortran-mode)
1494 ("\\.for\\'" . fortran-mode)
1495 ("\\.p\\'" . pascal-mode)
1496 ("\\.pas\\'" . pascal-mode)
1497 ("\\.ad[abs]\\'" . ada-mode)
1498 ("\\.ad[bs].dg\\'" . ada-mode)
1499 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
1500 ("\\.s?html?\\'" . html-mode)
1501 ("\\.cc\\'" . c++-mode)
1502 ("\\.hh\\'" . c++-mode)
1503 ("\\.hpp\\'" . c++-mode)
1504 ("\\.C\\'" . c++-mode)
1505 ("\\.H\\'" . c++-mode)
1506 ("\\.cpp\\'" . c++-mode)
1507 ("\\.cxx\\'" . c++-mode)
1508 ("\\.hxx\\'" . c++-mode)
1509 ("\\.c\\+\\+\\'" . c++-mode)
1510 ("\\.h\\+\\+\\'" . c++-mode)
1511 ("\\.m\\'" . objc-mode)
1512 ("\\.java\\'" . java-mode)
1513 ("\\.mk\\'" . makefile-mode)
1514 ("\\(M\\|m\\|GNUm\\)akefile\\'" . makefile-mode)
1515 ("\\.am\\'" . makefile-mode) ;For Automake.
1516 ;; Less common extensions come here
1517 ;; so more common ones above are found faster.
1518 ("\\.texinfo\\'" . texinfo-mode)
1519 ("\\.te?xi\\'" . texinfo-mode)
1520 ("\\.s\\'" . asm-mode)
1521 ("\\.S\\'" . asm-mode)
1522 ("\\.asm\\'" . asm-mode)
1523 ("ChangeLog\\'" . change-log-mode)
1524 ("change\\.log\\'" . change-log-mode)
1525 ("changelo\\'" . change-log-mode)
1526 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1527 ;; for MSDOS and MS-Windows (which are case-insensitive)
1528 ("changelog\\'" . change-log-mode)
1529 ("changelog\\.[0-9]+\\'" . change-log-mode)
1530 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1531 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1532 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1533 ("\\.bash\\'" . sh-mode)
1534 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1535 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1536 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1537 ("\\.m?spec\\'" . sh-mode)
1538 ("\\.mm\\'" . nroff-mode)
1539 ("\\.me\\'" . nroff-mode)
1540 ("\\.ms\\'" . nroff-mode)
1541 ("\\.man\\'" . nroff-mode)
1542 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
1543 ("\\.TeX\\'" . tex-mode)
1544 ("\\.sty\\'" . latex-mode)
1545 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1546 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1547 ("\\.bbl\\'" . latex-mode)
1548 ("\\.bib\\'" . bibtex-mode)
1549 ("\\.sql\\'" . sql-mode)
1550 ("\\.m4\\'" . m4-mode)
1551 ("\\.mc\\'" . m4-mode)
1552 ("\\.mf\\'" . metafont-mode)
1553 ("\\.mp\\'" . metapost-mode)
1554 ("\\.vhdl?\\'" . vhdl-mode)
1555 ("\\.article\\'" . text-mode)
1556 ("\\.letter\\'" . text-mode)
1557 ("\\.tcl\\'" . tcl-mode)
1558 ("\\.exp\\'" . tcl-mode)
1559 ("\\.itcl\\'" . tcl-mode)
1560 ("\\.itk\\'" . tcl-mode)
1561 ("\\.icn\\'" . icon-mode)
1562 ("\\.sim\\'" . simula-mode)
1563 ("\\.mss\\'" . scribe-mode)
1564 ("\\.f90\\'" . f90-mode)
1565 ("\\.f95\\'" . f90-mode)
1566 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1567 ("\\.pro\\'" . idlwave-mode)
1568 ("\\.lsp\\'" . lisp-mode)
1569 ("\\.awk\\'" . awk-mode)
1570 ("\\.prolog\\'" . prolog-mode)
1571 ("\\.tar\\'" . tar-mode)
1572 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|ear\\|jar\\|war\\)\\'" . archive-mode)
1573 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|EAR\\|JAR\\|WAR\\)\\'" . archive-mode)
1574 ("\\.sx[dmicw]\\'" . archive-mode) ; OpenOffice.org
1575 ;; Mailer puts message to be edited in
1576 ;; /tmp/Re.... or Message
1577 ("\\`/tmp/Re" . text-mode)
1578 ("/Message[0-9]*\\'" . text-mode)
1579 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1580 ("\\.zone\\'" . zone-mode)
1581 ;; some news reader is reported to use this
1582 ("\\`/tmp/fol/" . text-mode)
1583 ("\\.y\\'" . c-mode)
1584 ("\\.lex\\'" . c-mode)
1585 ("\\.oak\\'" . scheme-mode)
1586 ("\\.sgml?\\'" . sgml-mode)
1587 ("\\.xml\\'" . sgml-mode)
1588 ("\\.dtd\\'" . sgml-mode)
1589 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1590 ("\\.idl\\'" . idl-mode)
1591 ;; .emacs or .gnus or .viper following a directory delimiter in
1592 ;; Unix, MSDOG or VMS syntax.
1593 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
1594 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1595 ;; _emacs following a directory delimiter
1597 ("[:/]_emacs\\'" . emacs-lisp-mode)
1598 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1599 ("\\.ml\\'" . lisp-mode)
1600 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1601 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1602 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1603 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1604 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1605 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1606 ("BROWSE\\'" . ebrowse-tree-mode)
1607 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1608 ("#\\*mail\\*" . mail-mode)
1609 ;; Get rid of any trailing .n.m and try again.
1610 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1611 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1612 ;; Using mode nil rather than `ignore' would let the search continue
1613 ;; through this list (with the shortened name) rather than start over.
1614 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1615 ;; The following should come after the ChangeLog pattern
1616 ;; for the sake of ChangeLog.1, etc.
1617 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1618 ("\\.[1-9]\\'" . nroff-mode)
1619 ("\\.g\\'" . antlr-mode)
1620 ("\\.ses\\'" . ses-mode)
1621 ("\\.in\\'" nil t)))
1622 "Alist of filename patterns vs corresponding major mode functions.
1623 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1624 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1625 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1626 mode function to use. FUNCTION will be called, unless it is nil.
1628 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1629 calling FUNCTION (if it's not nil), we delete the suffix that matched
1630 REGEXP and search the list again for another match.")
1633 (defvar interpreter-mode-alist
1636 (cons (purecopy (car l)) (cdr l)))
1637 '(("perl" . perl-mode)
1638 ("perl5" . perl-mode)
1639 ("miniperl" . perl-mode)
1641 ("wishx" . tcl-mode)
1643 ("tclsh" . tcl-mode)
1648 ("scm" . scheme-mode)
1668 ("tail" . text-mode)
1669 ("more" . text-mode)
1670 ("less" . text-mode)
1672 ("make" . makefile-mode) ; Debian uses this
1673 ("guile" . scheme-mode)
1674 ("clisp" . lisp-mode)))
1675 "Alist mapping interpreter names to major modes.
1676 This alist applies to files whose first line starts with `#!'.
1677 Each element looks like (INTERPRETER . MODE).
1678 The car of each element is compared with
1679 the name of the interpreter specified in the first line.
1680 If it matches, mode MODE is selected.")
1682 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1683 "List of regexps; if one matches a file name, don't look for `-*-'.")
1685 (defvar inhibit-first-line-modes-suffixes nil
1686 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1687 When checking `inhibit-first-line-modes-regexps', we first discard
1688 from the end of the file name anything that matches one of these regexps.")
1690 (defvar auto-mode-interpreter-regexp
1691 "#![ \t]?\\([^ \t\n]*\
1692 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1693 "Regular expression matching interpreters, for file mode determination.
1694 This regular expression is matched against the first line of a file
1695 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1696 a mode from the file's name. If it matches, the file is assumed to
1697 be interpreted by the interpreter matched by the second group of the
1698 regular expression. The mode is then determined as the mode associated
1699 with that interpreter in `interpreter-mode-alist'.")
1701 (defun set-auto-mode (&optional just-from-file-name)
1702 "Select major mode appropriate for current buffer.
1703 This checks for a -*- mode tag in the buffer's text,
1704 compares the filename against the entries in `auto-mode-alist',
1705 or checks the interpreter that runs this file against
1706 `interpreter-mode-alist'.
1708 It does not check for the `mode:' local variable in the
1709 Local Variables section of the file; for that, use `hack-local-variables'.
1711 If `enable-local-variables' is nil, this function does not check for a
1714 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1715 then we do not set anything but the major mode,
1716 and we don't even do that unless it would come from the file name."
1717 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1718 (let (end done modes)
1720 (goto-char (point-min))
1721 (skip-chars-forward " \t\n")
1722 (and enable-local-variables
1723 (setq end (set-auto-mode-1))
1724 (if (save-excursion (search-forward ":" end t))
1725 ;; Find all specifications for the `mode:' variable
1726 ;; and execute them left to right.
1727 (while (let ((case-fold-search t))
1728 (or (and (looking-at "mode:")
1729 (goto-char (match-end 0)))
1730 (re-search-forward "[ \t;]mode:" end t)))
1731 (skip-chars-forward " \t")
1732 (let ((beg (point)))
1733 (if (search-forward ";" end t)
1736 (skip-chars-backward " \t")
1737 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1739 ;; Simple -*-MODE-*- case.
1740 (push (intern (concat (downcase (buffer-substring (point) end))
1743 ;; If we found modes to use, invoke them now,
1744 ;; outside the save-excursion.
1745 (unless just-from-file-name
1746 (dolist (mode (nreverse modes))
1747 (if (not (functionp mode))
1748 (message "Ignoring unknown mode `%s'" mode)
1751 ;; If we didn't find a mode from a -*- line, try using the file name.
1752 (if (and (not done) buffer-file-name)
1753 (let ((name buffer-file-name)
1755 ;; Remove backup-suffixes from file name.
1756 (setq name (file-name-sans-versions name))
1758 (setq keep-going nil)
1759 (let ((alist auto-mode-alist)
1761 ;; Find first matching alist entry.
1762 (let ((case-fold-search
1763 (memq system-type '(vax-vms windows-nt))))
1764 (while (and (not mode) alist)
1765 (if (string-match (car (car alist)) name)
1766 (if (and (consp (cdr (car alist)))
1767 (nth 2 (car alist)))
1768 (setq mode (car (cdr (car alist)))
1769 name (substring name 0 (match-beginning 0))
1771 (setq mode (cdr (car alist))
1773 (setq alist (cdr alist))))
1775 ;; When JUST-FROM-FILE-NAME is set,
1776 ;; we are working on behalf of set-visited-file-name.
1777 ;; In that case, if the major mode specified is the
1778 ;; same one we already have, don't actually reset it.
1779 ;; We don't want to lose minor modes such as Font Lock.
1780 (unless (and just-from-file-name (eq mode major-mode))
1782 ;; If we can't deduce a mode from the file name,
1783 ;; look for an interpreter specified in the first line.
1784 ;; As a special case, allow for things like "#!/bin/env perl",
1785 ;; which finds the interpreter anywhere in $PATH.
1788 (goto-char (point-min))
1789 (if (looking-at auto-mode-interpreter-regexp)
1793 ;; Map interpreter name to a mode.
1794 (setq elt (assoc (file-name-nondirectory interpreter)
1795 interpreter-mode-alist))
1796 (unless just-from-file-name
1798 (funcall (cdr elt))))))))))))
1801 (defun set-auto-mode-1 ()
1802 "Find the -*- spec in the buffer.
1803 Call with point at the place to start searching from.
1804 If one is found, set point to the beginning
1805 and return the position of the end.
1806 Otherwise, return nil; point may be changed."
1809 ;; Don't look for -*- if this file name matches any
1810 ;; of the regexps in inhibit-first-line-modes-regexps.
1811 (let ((temp inhibit-first-line-modes-regexps)
1812 (name (if buffer-file-name
1813 (file-name-sans-versions buffer-file-name)
1815 (while (let ((sufs inhibit-first-line-modes-suffixes))
1816 (while (and sufs (not (string-match (car sufs) name)))
1817 (setq sufs (cdr sufs)))
1819 (setq name (substring name 0 (match-beginning 0))))
1821 (not (string-match (car temp) name)))
1822 (setq temp (cdr temp)))
1825 (search-forward "-*-" (save-excursion
1826 ;; If the file begins with "#!"
1827 ;; (exec interpreter magic), look
1828 ;; for mode frobs in the first two
1829 ;; lines. You cannot necessarily
1830 ;; put them in the first line of
1831 ;; such a file without screwing up
1832 ;; the interpreter invocation.
1833 (end-of-line (and (looking-at "^#!") 2))
1836 (skip-chars-forward " \t")
1838 (search-forward "-*-"
1839 (save-excursion (end-of-line) (point))
1843 (skip-chars-backward " \t")
1848 (defun hack-local-variables-prop-line ()
1849 "Set local variables specified in the -*- line.
1850 Ignore any specification for `mode:' and `coding:';
1851 `set-auto-mode' should already have handled `mode:',
1852 `set-auto-coding' should already have handled `coding:'."
1854 (goto-char (point-min))
1856 (end (set-auto-mode-1))
1857 (enable-local-variables
1858 (and local-enable-local-variables enable-local-variables)))
1859 ;; Parse the -*- line into the `result' alist.
1862 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1863 ;; Simple form: "-*- MODENAME -*-". Already handled.
1866 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1867 ;; (last ";" is optional).
1868 (while (< (point) end)
1869 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1870 (error "Malformed -*- line"))
1871 (goto-char (match-end 0))
1872 ;; There used to be a downcase here,
1873 ;; but the manual didn't say so,
1874 ;; and people want to set var names that aren't all lc.
1875 (let ((key (intern (buffer-substring
1878 (val (save-restriction
1879 (narrow-to-region (point) end)
1880 (read (current-buffer)))))
1881 ;; It is traditional to ignore
1882 ;; case when checking for `mode' in set-auto-mode,
1883 ;; so we must do that here as well.
1884 ;; That is inconsistent, but we're stuck with it.
1885 ;; The same can be said for `coding' in set-auto-coding.
1886 (or (equal (downcase (symbol-name key)) "mode")
1887 (equal (downcase (symbol-name key)) "coding")
1888 (setq result (cons (cons key val) result)))
1889 (skip-chars-forward " \t;")))
1890 (setq result (nreverse result))))
1893 (or (eq enable-local-variables t)
1894 (and enable-local-variables
1895 (save-window-excursion
1897 (switch-to-buffer (current-buffer))
1899 ;; If we fail to switch in the selected window,
1900 ;; it is probably a minibuffer.
1901 ;; So try another window.
1903 (switch-to-buffer-other-window (current-buffer))
1905 (switch-to-buffer-other-frame (current-buffer))))))
1906 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1907 (file-name-nondirectory buffer-file-name)))))))
1908 (let ((enable-local-eval enable-local-eval))
1910 (hack-one-local-variable (car (car result)) (cdr (car result)))
1911 (setq result (cdr result))))))))
1913 (defvar hack-local-variables-hook nil
1914 "Normal hook run after processing a file's local variables specs.
1915 Major modes can use this to examine user-specified local variables
1916 in order to initialize other data structure based on them.")
1918 (defun hack-local-variables (&optional mode-only)
1919 "Parse and put into effect this buffer's local variables spec.
1920 If MODE-ONLY is non-nil, all we do is check whether the major mode
1921 is specified, returning t if it is specified."
1923 (hack-local-variables-prop-line))
1924 ;; Look for "Local variables:" line in last page.
1925 (let (mode-specified
1926 (enable-local-variables
1927 (and local-enable-local-variables enable-local-variables)))
1929 (goto-char (point-max))
1930 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1931 (if (let ((case-fold-search t))
1932 (and (search-forward "Local Variables:" nil t)
1933 (or (eq enable-local-variables t)
1935 (and enable-local-variables
1936 (save-window-excursion
1937 (switch-to-buffer (current-buffer))
1940 (set-window-start (selected-window) (point)))
1941 (y-or-n-p (format "Set local variables as specified at end of %s? "
1942 (if buffer-file-name
1943 (file-name-nondirectory
1946 (buffer-name))))))))))
1948 prefix prefixlen suffix beg
1950 (enable-local-eval enable-local-eval))
1951 ;; The prefix is what comes before "local variables:" in its line.
1952 ;; The suffix is what comes after "local variables:" in its line.
1953 (skip-chars-forward " \t")
1955 (setq suffix (buffer-substring (point)
1956 (progn (end-of-line) (point)))))
1957 (goto-char (match-beginning 0))
1960 (buffer-substring (point)
1961 (progn (beginning-of-line) (point)))))
1963 (if prefix (setq prefixlen (length prefix)
1964 prefix (regexp-quote prefix)))
1965 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1967 ;; Look at next local variable spec.
1968 (if selective-display (re-search-forward "[\n\C-m]")
1970 ;; Skip the prefix, if any.
1972 (if (looking-at prefix)
1973 (forward-char prefixlen)
1974 (error "Local variables entry is missing the prefix")))
1975 ;; Find the variable name; strip whitespace.
1976 (skip-chars-forward " \t")
1978 (skip-chars-forward "^:\n")
1979 (if (eolp) (error "Missing colon in local variables entry"))
1980 (skip-chars-backward " \t")
1981 (let* ((str (buffer-substring beg (point)))
1984 ;; Setting variable named "end" means end of list.
1985 (if (string-equal (downcase str) "end")
1987 ;; Otherwise read the variable value.
1988 (skip-chars-forward "^:")
1990 (setq val (read (current-buffer)))
1991 (skip-chars-backward "\n")
1992 (skip-chars-forward " \t")
1993 (or (if suffix (looking-at suffix) (eolp))
1994 (error "Local variables entry is terminated incorrectly"))
1997 (setq mode-specified t))
1998 ;; Set the variable. "Variables" mode and eval are funny.
1999 (hack-one-local-variable var val))))))))
2001 (run-hooks 'hack-local-variables-hook))
2004 (defvar ignored-local-variables
2005 '(enable-local-eval)
2006 "Variables to be ignored in a file's local variable spec.")
2008 ;; Get confirmation before setting these variables as locals in a file.
2009 (put 'debugger 'risky-local-variable t)
2010 (put 'enable-local-eval 'risky-local-variable t)
2011 (put 'ignored-local-variables 'risky-local-variable t)
2012 (put 'eval 'risky-local-variable t)
2013 (put 'file-name-handler-alist 'risky-local-variable t)
2014 (put 'inhibit-quit 'risky-local-variable t)
2015 (put 'minor-mode-alist 'risky-local-variable t)
2016 (put 'minor-mode-map-alist 'risky-local-variable t)
2017 (put 'minor-mode-overriding-map-alist 'risky-local-variable t)
2018 (put 'overriding-local-map 'risky-local-variable t)
2019 (put 'overriding-terminal-local-map 'risky-local-variable t)
2020 (put 'auto-mode-alist 'risky-local-variable t)
2021 (put 'after-load-alist 'risky-local-variable t)
2022 (put 'buffer-file-name 'risky-local-variable t)
2023 (put 'buffer-undo-list 'risky-local-variable t)
2024 (put 'buffer-auto-save-file-name 'risky-local-variable t)
2025 (put 'buffer-file-truename 'risky-local-variable t)
2026 (put 'default-text-properties 'risky-local-variable t)
2027 (put 'exec-path 'risky-local-variable t)
2028 (put 'load-path 'risky-local-variable t)
2029 (put 'exec-directory 'risky-local-variable t)
2030 (put 'process-environment 'risky-local-variable t)
2031 (put 'dabbrev-case-fold-search 'risky-local-variable t)
2032 (put 'dabbrev-case-replace 'risky-local-variable t)
2033 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2034 (put 'outline-level 'risky-local-variable t)
2035 (put 'rmail-output-file-alist 'risky-local-variable t)
2036 (put 'font-lock-defaults 'risky-local-variable t)
2037 (put 'special-display-buffer-names 'risky-local-variable t)
2038 (put 'frame-title-format 'risky-local-variable t)
2039 (put 'global-mode-string 'risky-local-variable t)
2040 (put 'header-line-format 'risky-local-variable t)
2041 (put 'icon-title-format 'risky-local-variable t)
2042 (put 'input-method-alist 'risky-local-variable t)
2043 (put 'format-alist 'risky-local-variable t)
2044 (put 'vc-mode 'risky-local-variable t)
2045 (put 'imenu-generic-expression 'risky-local-variable t)
2046 (put 'imenu-index-alist 'risky-local-variable t)
2047 (put 'standard-input 'risky-local-variable t)
2048 (put 'standard-output 'risky-local-variable t)
2049 (put 'unread-command-events 'risky-local-variable t)
2050 (put 'max-lisp-eval-depth 'risky-local-variable t)
2051 (put 'max-specpdl-size 'risky-local-variable t)
2052 (put 'mode-line-format 'risky-local-variable t)
2053 (put 'mode-line-modified 'risky-local-variable t)
2054 (put 'mode-line-mule-info 'risky-local-variable t)
2055 (put 'mode-line-buffer-identification 'risky-local-variable t)
2056 (put 'mode-line-modes 'risky-local-variable t)
2057 (put 'mode-line-position 'risky-local-variable t)
2058 (put 'display-time-string 'risky-local-variable t)
2060 ;; This case is safe because the user gets to check it before it is used.
2061 (put 'compile-command 'safe-local-variable 'stringp)
2063 (defun risky-local-variable-p (sym val)
2064 "Non-nil if SYM could be dangerous as a file-local variable with value VAL."
2065 (let ((safep (get sym 'safe-local-variable)))
2066 (or (memq sym ignored-local-variables)
2067 (get sym 'risky-local-variable)
2068 (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$"
2071 ;; If the safe-local-variable property isn't t or nil,
2072 ;; then it must return non-nil on the proposed value to be safe.
2073 (and (not (memq safep '(t nil)))
2074 (not (funcall safep val))))))
2076 (defcustom safe-local-eval-forms nil
2077 "*Expressions that are considered \"safe\" in an `eval:' local variable.
2078 Add expressions to this list if you want Emacs to evaluate them, when
2079 they appear in an `eval' local variable specification, without first
2080 asking you for confirmation."
2083 :type '(repeat sexp))
2085 (put 'c-set-style 'safe-local-eval-function t)
2087 (defun hack-one-local-variable-quotep (exp)
2088 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2090 (defun hack-one-local-variable-constantp (exp)
2091 (or (and (not (symbolp exp)) (not (consp exp)))
2094 (hack-one-local-variable-quotep exp)))
2096 (defun hack-one-local-variable-eval-safep (exp)
2097 "Return t if it is safe to eval EXP when it is found in a file."
2098 (or (not (consp exp))
2099 ;; Detect certain `put' expressions.
2100 (and (eq (car exp) 'put)
2101 (hack-one-local-variable-quotep (nth 1 exp))
2102 (hack-one-local-variable-quotep (nth 2 exp))
2103 (memq (nth 1 (nth 2 exp))
2104 '(lisp-indent-hook))
2105 ;; Only allow safe values of lisp-indent-hook;
2107 (or (numberp (nth 3 exp))
2108 (equal (nth 3 exp) ''defun)))
2109 ;; Allow expressions that the user requested.
2110 (member exp safe-local-eval-forms)
2111 ;; Certain functions can be allowed with safe arguments
2112 ;; or can specify verification functions to try.
2113 (and (symbolp (car exp))
2114 (let ((prop (get (car exp) 'safe-local-eval-function)))
2117 (dolist (arg (cdr exp))
2118 (unless (hack-one-local-variable-constantp arg)
2125 (dolist (function prop)
2126 (if (funcall function exp)
2130 (defun hack-one-local-variable (var val)
2131 "\"Set\" one variable in a local variables spec.
2132 A few patterns are specified so that any name which matches one
2133 is considered risky."
2134 (cond ((eq var 'mode)
2135 (funcall (intern (concat (downcase (symbol-name val))
2138 ;; We have already handled coding: tag in set-auto-coding.
2140 ;; "Setting" eval means either eval it or do nothing.
2141 ;; Likewise for setting hook variables.
2142 ((risky-local-variable-p var val)
2143 ;; Permit evalling a put of a harmless property.
2144 ;; if the args do nothing tricky.
2145 (if (or (and (eq var 'eval)
2146 (hack-one-local-variable-eval-safep val))
2147 ;; Permit eval if not root and user says ok.
2148 (and (not (zerop (user-uid)))
2149 (or (eq enable-local-eval t)
2150 (and enable-local-eval
2151 (save-window-excursion
2152 (switch-to-buffer (current-buffer))
2155 (set-window-start (selected-window) (point)))
2156 (setq enable-local-eval
2157 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
2158 (if buffer-file-name
2159 (concat "file " (file-name-nondirectory buffer-file-name))
2160 (concat "buffer " (buffer-name)))))))))))
2162 (save-excursion (eval val))
2163 (make-local-variable var)
2165 (message "Ignoring risky spec in the local variables list")))
2166 ;; Ordinary variable, really set it.
2167 (t (make-local-variable var)
2168 ;; Make sure the string has no text properties.
2169 ;; Some text properties can get evaluated in various ways,
2170 ;; so it is risky to put them on with a local variable list.
2172 (set-text-properties 0 (length val) nil val))
2176 (defcustom change-major-mode-with-file-name t
2177 "*Non-nil means \\[write-file] should set the major mode from the file name.
2178 However, the mode will not be changed if
2179 \(1) a local variables list or the `-*-' line specifies a major mode, or
2180 \(2) the current major mode is a \"special\" mode,
2181 \ not suitable for ordinary files, or
2182 \(3) the new file name does not particularly specify any mode."
2184 :group 'editing-basics)
2186 (defun set-visited-file-name (filename &optional no-query along-with-file)
2187 "Change name of file visited in current buffer to FILENAME.
2188 The next time the buffer is saved it will go in the newly specified file.
2189 nil or empty string as argument means make buffer not be visiting any file.
2190 Remember to delete the initial contents of the minibuffer
2191 if you wish to pass an empty string as the argument.
2193 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2194 confirmation in the case where another buffer is already visiting FILENAME.
2196 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2197 the old visited file has been renamed to the new name FILENAME."
2198 (interactive "FSet visited file name: ")
2199 (if (buffer-base-buffer)
2200 (error "An indirect buffer cannot visit a file"))
2204 (if (string-equal filename "")
2206 (expand-file-name filename))))
2209 (setq truename (file-truename filename))
2210 (if find-file-visit-truename
2211 (setq filename truename))))
2212 (let ((buffer (and filename (find-buffer-visiting filename))))
2213 (and buffer (not (eq buffer (current-buffer)))
2215 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2218 (or (equal filename buffer-file-name)
2220 (and filename (lock-buffer filename))
2222 (setq buffer-file-name filename)
2223 (if filename ; make buffer name reflect filename.
2224 (let ((new-name (file-name-nondirectory buffer-file-name)))
2225 (if (string= new-name "")
2226 (error "Empty file name"))
2227 (if (eq system-type 'vax-vms)
2228 (setq new-name (downcase new-name)))
2229 (setq default-directory (file-name-directory buffer-file-name))
2230 (or (string= new-name (buffer-name))
2231 (rename-buffer new-name t))))
2232 (setq buffer-backed-up nil)
2234 (clear-visited-file-modtime))
2235 ;; Abbreviate the file names of the buffer.
2238 (setq buffer-file-truename (abbreviate-file-name truename))
2239 (if find-file-visit-truename
2240 (setq buffer-file-name buffer-file-truename))))
2241 (setq buffer-file-number
2243 (nthcdr 10 (file-attributes buffer-file-name))
2245 ;; write-file-functions is normally used for things like ftp-find-file
2246 ;; that visit things that are not local files as if they were files.
2247 ;; Changing to visit an ordinary local file instead should flush the hook.
2248 (kill-local-variable 'write-file-functions)
2249 (kill-local-variable 'local-write-file-hooks)
2250 (kill-local-variable 'revert-buffer-function)
2251 (kill-local-variable 'backup-inhibited)
2252 ;; If buffer was read-only because of version control,
2253 ;; that reason is gone now, so make it writable.
2255 (setq buffer-read-only nil))
2256 (kill-local-variable 'vc-mode)
2257 ;; Turn off backup files for certain file names.
2258 ;; Since this is a permanent local, the major mode won't eliminate it.
2259 (and buffer-file-name
2260 (not (funcall backup-enable-predicate buffer-file-name))
2262 (make-local-variable 'backup-inhibited)
2263 (setq backup-inhibited t)))
2264 (let ((oauto buffer-auto-save-file-name))
2265 ;; If auto-save was not already on, turn it on if appropriate.
2266 (if (not buffer-auto-save-file-name)
2267 (and buffer-file-name auto-save-default
2269 ;; If auto save is on, start using a new name.
2270 ;; We deliberately don't rename or delete the old auto save
2271 ;; for the old visited file name. This is because perhaps
2272 ;; the user wants to save the new state and then compare with the
2273 ;; previous state from the auto save file.
2274 (setq buffer-auto-save-file-name
2275 (make-auto-save-file-name)))
2276 ;; Rename the old auto save file if any.
2277 (and oauto buffer-auto-save-file-name
2278 (file-exists-p oauto)
2279 (rename-file oauto buffer-auto-save-file-name t)))
2280 (and buffer-file-name
2281 (not along-with-file)
2282 (set-buffer-modified-p t))
2283 ;; Update the major mode, if the file name determines it.
2285 ;; Don't change the mode if it is special.
2286 (or (not change-major-mode-with-file-name)
2287 (get major-mode 'mode-class)
2288 ;; Don't change the mode if the local variable list specifies it.
2289 (hack-local-variables t)
2293 (defun write-file (filename &optional confirm)
2294 "Write current buffer into file FILENAME.
2295 This makes the buffer visit that file, and marks it as not modified.
2297 If you specify just a directory name as FILENAME, that means to use
2298 the default file name but in that directory. You can also yank
2299 the default file name into the minibuffer to edit it, using M-n.
2301 If the buffer is not already visiting a file, the default file name
2302 for the output file is the buffer name.
2304 If optional second arg CONFIRM is non-nil, this function
2305 asks for confirmation before overwriting an existing file.
2306 Interactively, confirmation is required unless you supply a prefix argument."
2307 ;; (interactive "FWrite file: ")
2309 (list (if buffer-file-name
2310 (read-file-name "Write file: "
2312 (read-file-name "Write file: " default-directory
2314 (file-name-nondirectory (buffer-name))
2317 (not current-prefix-arg)))
2318 (or (null filename) (string-equal filename "")
2320 ;; If arg is just a directory,
2321 ;; use the default file name, but in that directory.
2322 (if (file-directory-p filename)
2323 (setq filename (concat (file-name-as-directory filename)
2324 (file-name-nondirectory
2325 (or buffer-file-name (buffer-name))))))
2327 (file-exists-p filename)
2328 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2329 (error "Canceled")))
2330 (set-visited-file-name filename (not confirm))))
2331 (set-buffer-modified-p t)
2332 ;; Make buffer writable if file is writable.
2333 (and buffer-file-name
2334 (file-writable-p buffer-file-name)
2335 (setq buffer-read-only nil))
2338 (defun backup-buffer ()
2339 "Make a backup of the disk file visited by the current buffer, if appropriate.
2340 This is normally done before saving the buffer the first time.
2342 A backup may be done by renaming or by copying; see documentation of
2343 variable `make-backup-files'. If it's done by renaming, then the file is
2344 no longer accessible under its old name.
2346 The value is non-nil after a backup was made by renaming.
2347 It has the form (MODES . BACKUPNAME).
2348 MODES is the result of `file-modes' on the original
2349 file; this means that the caller, after saving the buffer, should change
2350 the modes of the new file to agree with the old modes.
2351 BACKUPNAME is the backup file name, which is the old file renamed."
2352 (if (and make-backup-files (not backup-inhibited)
2353 (not buffer-backed-up)
2354 (file-exists-p buffer-file-name)
2355 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2357 (let ((real-file-name buffer-file-name)
2358 backup-info backupname targets setmodes)
2359 ;; If specified name is a symbolic link, chase it to the target.
2360 ;; Thus we make the backups in the directory where the real file is.
2361 (setq real-file-name (file-chase-links real-file-name))
2362 (setq backup-info (find-backup-file-name real-file-name)
2363 backupname (car backup-info)
2364 targets (cdr backup-info))
2365 ;; (if (file-directory-p buffer-file-name)
2366 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2369 (let ((delete-old-versions
2370 ;; If have old versions to maybe delete,
2371 ;; ask the user to confirm now, before doing anything.
2372 ;; But don't actually delete til later.
2374 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2375 (or delete-old-versions
2376 (y-or-n-p (format "Delete excess backup versions of %s? "
2378 (modes (file-modes buffer-file-name)))
2379 ;; Actually write the back up file.
2381 (if (or file-precious-flag
2382 ; (file-symlink-p buffer-file-name)
2384 ;; Don't rename a suid or sgid file.
2385 (< 0 (logand modes #o6000))
2386 (and backup-by-copying-when-linked
2387 (> (file-nlinks real-file-name) 1))
2388 (and (or backup-by-copying-when-mismatch
2389 (integerp backup-by-copying-when-privileged-mismatch))
2390 (let ((attr (file-attributes real-file-name)))
2391 (and (or backup-by-copying-when-mismatch
2392 (and (integerp (nth 2 attr))
2393 (integerp backup-by-copying-when-privileged-mismatch)
2394 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2396 (not (file-ownership-preserved-p real-file-name)))))))
2397 (backup-buffer-copy real-file-name backupname modes)
2398 ;; rename-file should delete old backup.
2399 (rename-file real-file-name backupname t)
2400 (setq setmodes (cons modes backupname)))
2402 ;; If trouble writing the backup, write it in ~.
2403 (setq backupname (expand-file-name
2404 (convert-standard-filename
2406 (message "Cannot write backup file; backing up in %s"
2407 (file-name-nondirectory backupname))
2409 (backup-buffer-copy real-file-name backupname modes)))
2410 (setq buffer-backed-up t)
2411 ;; Now delete the old versions, if desired.
2412 (if delete-old-versions
2415 (delete-file (car targets))
2417 (setq targets (cdr targets))))
2419 (file-error nil))))))
2421 (defun backup-buffer-copy (from-name to-name modes)
2423 (copy-file from-name to-name t t)
2425 ;; If copying fails because file TO-NAME
2426 ;; is not writable, delete that file and try again.
2427 (if (and (file-exists-p to-name)
2428 (not (file-writable-p to-name)))
2429 (delete-file to-name))
2430 (copy-file from-name to-name t t)))
2431 (set-file-modes to-name (logand modes #o1777)))
2433 (defun file-name-sans-versions (name &optional keep-backup-version)
2434 "Return file NAME sans backup versions or strings.
2435 This is a separate procedure so your site-init or startup file can
2437 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2438 we do not remove backup version numbers, only true file version numbers."
2439 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2441 (funcall handler 'file-name-sans-versions name keep-backup-version)
2443 (if (eq system-type 'vax-vms)
2444 ;; VMS version number is (a) semicolon, optional
2445 ;; sign, zero or more digits or (b) period, option
2446 ;; sign, zero or more digits, provided this is the
2447 ;; second period encountered outside of the
2448 ;; device/directory part of the file name.
2449 (or (string-match ";[-+]?[0-9]*\\'" name)
2450 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2452 (match-beginning 1))
2454 (if keep-backup-version
2456 (or (string-match "\\.~[0-9.]+~\\'" name)
2457 (string-match "~\\'" name)
2458 (length name))))))))
2460 (defun file-ownership-preserved-p (file)
2461 "Return t if deleting FILE and rewriting it would preserve the owner."
2462 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2464 (funcall handler 'file-ownership-preserved-p file)
2465 (let ((attributes (file-attributes file)))
2466 ;; Return t if the file doesn't exist, since it's true that no
2467 ;; information would be lost by an (attempted) delete and create.
2468 (or (null attributes)
2469 (= (nth 2 attributes) (user-uid)))))))
2471 (defun file-name-sans-extension (filename)
2472 "Return FILENAME sans final \"extension\".
2473 The extension, in a file name, is the part that follows the last `.',
2474 except that a leading `.', if any, doesn't count."
2476 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2478 (if (and (string-match "\\.[^.]*\\'" file)
2479 (not (eq 0 (match-beginning 0))))
2480 (if (setq directory (file-name-directory filename))
2481 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2482 ;; we don't want to expand it.
2483 (concat directory (substring file 0 (match-beginning 0)))
2484 (substring file 0 (match-beginning 0)))
2487 (defun file-name-extension (filename &optional period)
2488 "Return FILENAME's final \"extension\".
2489 The extension, in a file name, is the part that follows the last `.',
2490 except that a leading `.', if any, doesn't count.
2491 Return nil for extensionless file names such as `foo'.
2492 Return the empty string for file names such as `foo.'.
2494 If PERIOD is non-nil, then the returned value includes the period
2495 that delimits the extension, and if FILENAME has no extension,
2498 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2499 (if (and (string-match "\\.[^.]*\\'" file)
2500 (not (eq 0 (match-beginning 0))))
2501 (substring file (+ (match-beginning 0) (if period 0 1)))
2505 (defcustom make-backup-file-name-function nil
2506 "A function to use instead of the default `make-backup-file-name'.
2507 A value of nil gives the default `make-backup-file-name' behaviour.
2509 This could be buffer-local to do something special for specific
2510 files. If you define it, you may need to change `backup-file-name-p'
2511 and `file-name-sans-versions' too.
2513 See also `backup-directory-alist'."
2515 :type '(choice (const :tag "Default" nil)
2516 (function :tag "Your function")))
2518 (defcustom backup-directory-alist nil
2519 "Alist of filename patterns and backup directory names.
2520 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2521 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2522 relative or absolute. If it is absolute, so that all matching files
2523 are backed up into the same directory, the file names in this
2524 directory will be the full name of the file backed up with all
2525 directory separators changed to `!' to prevent clashes. This will not
2526 work correctly if your filesystem truncates the resulting name.
2528 For the common case of all backups going into one directory, the alist
2529 should contain a single element pairing \".\" with the appropriate
2532 If this variable is nil, or it fails to match a filename, the backup
2533 is made in the original file's directory.
2535 On MS-DOS filesystems without long names this variable is always
2538 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2539 (directory :tag "Backup directory name"))))
2541 (defun normal-backup-enable-predicate (name)
2542 "Default `backup-enable-predicate' function.
2543 Checks for files in `temporary-file-directory' or
2544 `small-temporary-file-directory'."
2545 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2547 ;; Directory is under temporary-file-directory.
2548 (and (not (eq comp t))
2549 (< comp (- (length temporary-file-directory)))))
2550 (if small-temporary-file-directory
2551 (let ((comp (compare-strings small-temporary-file-directory
2554 ;; Directory is under small-temporary-file-directory.
2555 (and (not (eq comp t))
2556 (< comp (- (length small-temporary-file-directory)))))))))
2558 (defun make-backup-file-name (file)
2559 "Create the non-numeric backup file name for FILE.
2560 Normally this will just be the file's name with `~' appended.
2561 Customization hooks are provided as follows.
2563 If the variable `make-backup-file-name-function' is non-nil, its value
2564 should be a function which will be called with FILE as its argument;
2565 the resulting name is used.
2567 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2568 the documentation of that variable. If the directory for the backup
2569 doesn't exist, it is created."
2570 (if make-backup-file-name-function
2571 (funcall make-backup-file-name-function file)
2572 (if (and (eq system-type 'ms-dos)
2573 (not (msdos-long-file-names)))
2574 (let ((fn (file-name-nondirectory file)))
2575 (concat (file-name-directory file)
2576 (or (and (string-match "\\`[^.]+\\'" fn)
2577 (concat (match-string 0 fn) ".~"))
2578 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2579 (concat (match-string 0 fn) "~")))))
2580 (concat (make-backup-file-name-1 file) "~"))))
2582 (defun make-backup-file-name-1 (file)
2583 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2584 (let ((alist backup-directory-alist)
2585 elt backup-directory failed)
2587 (setq elt (pop alist))
2588 (if (string-match (car elt) file)
2589 (setq backup-directory (cdr elt)
2591 (if (and backup-directory (not (file-exists-p backup-directory)))
2593 (make-directory backup-directory 'parents)
2594 (file-error (setq backup-directory nil))))
2595 (if (null backup-directory)
2597 (if (file-name-absolute-p backup-directory)
2599 (when (memq system-type '(windows-nt ms-dos))
2600 ;; Normalize DOSish file names: downcase the drive
2601 ;; letter, if any, and replace the leading "x:" with
2603 (or (file-name-absolute-p file)
2604 (setq file (expand-file-name file))) ; make defaults explicit
2605 ;; Replace any invalid file-name characters (for the
2606 ;; case of backing up remote files).
2607 (setq file (expand-file-name (convert-standard-filename file)))
2608 (if (eq (aref file 1) ?:)
2609 (setq file (concat "/"
2611 (char-to-string (downcase (aref file 0)))
2612 (if (eq (aref file 2) ?/)
2615 (substring file 2)))))
2616 ;; Make the name unique by substituting directory
2617 ;; separators. It may not really be worth bothering about
2618 ;; doubling `!'s in the original name...
2620 (subst-char-in-string
2622 (replace-regexp-in-string "!" "!!" file))
2624 (expand-file-name (file-name-nondirectory file)
2625 (file-name-as-directory
2626 (expand-file-name backup-directory
2627 (file-name-directory file))))))))
2629 (defun backup-file-name-p (file)
2630 "Return non-nil if FILE is a backup file name (numeric or not).
2631 This is a separate function so you can redefine it for customization.
2632 You may need to redefine `file-name-sans-versions' as well."
2633 (string-match "~\\'" file))
2635 (defvar backup-extract-version-start)
2637 ;; This is used in various files.
2638 ;; The usage of backup-extract-version-start is not very clean,
2639 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2640 (defun backup-extract-version (fn)
2641 "Given the name of a numeric backup file, FN, return the backup number.
2642 Uses the free variable `backup-extract-version-start', whose value should be
2643 the index in the name where the version number begins."
2644 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2645 (= (match-beginning 0) backup-extract-version-start))
2646 (string-to-int (substring fn backup-extract-version-start -1))
2649 ;; I believe there is no need to alter this behavior for VMS;
2650 ;; since backup files are not made on VMS, it should not get called.
2651 (defun find-backup-file-name (fn)
2652 "Find a file name for a backup file FN, and suggestions for deletions.
2653 Value is a list whose car is the name for the backup file
2654 and whose cdr is a list of old versions to consider deleting now.
2655 If the value is nil, don't make a backup.
2656 Uses `backup-directory-alist' in the same way as does
2657 `make-backup-file-name'."
2658 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2659 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2661 (funcall handler 'find-backup-file-name fn)
2662 (if (or (eq version-control 'never)
2663 ;; We don't support numbered backups on plain MS-DOS
2664 ;; when long file names are unavailable.
2665 (and (eq system-type 'ms-dos)
2666 (not (msdos-long-file-names))))
2667 (list (make-backup-file-name fn))
2668 (let* ((basic-name (make-backup-file-name-1 fn))
2669 (base-versions (concat (file-name-nondirectory basic-name)
2671 (backup-extract-version-start (length base-versions))
2673 (number-to-delete 0)
2674 possibilities deserve-versions-p versions)
2676 (setq possibilities (file-name-all-completions
2678 (file-name-directory basic-name))
2679 versions (sort (mapcar #'backup-extract-version
2682 high-water-mark (apply 'max 0 versions)
2683 deserve-versions-p (or version-control
2684 (> high-water-mark 0))
2685 number-to-delete (- (length versions)
2689 (file-error (setq possibilities nil)))
2690 (if (not deserve-versions-p)
2691 (list (make-backup-file-name fn))
2692 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
2693 (if (and (> number-to-delete 0)
2694 ;; Delete nothing if there is overflow
2695 ;; in the number of versions to keep.
2696 (>= (+ kept-new-versions kept-old-versions -1) 0))
2698 (format "%s.~%d~" basic-name n))
2699 (let ((v (nthcdr kept-old-versions versions)))
2700 (rplacd (nthcdr (1- number-to-delete) v) ())
2703 (defun file-nlinks (filename)
2704 "Return number of names file FILENAME has."
2705 (car (cdr (file-attributes filename))))
2707 (defun file-relative-name (filename &optional directory)
2708 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2709 This function returns a relative file name which is equivalent to FILENAME
2710 when used with that default directory as the default.
2711 If this is impossible (which can happen on MSDOS and Windows
2712 when the file name and directory use different drive names)
2713 then it returns FILENAME."
2715 (let ((fname (expand-file-name filename)))
2716 (setq directory (file-name-as-directory
2717 (expand-file-name (or directory default-directory))))
2718 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2719 ;; drive names, they can't be relative, so return the absolute name.
2720 (if (and (or (eq system-type 'ms-dos)
2721 (eq system-type 'windows-nt))
2722 (not (string-equal (substring fname 0 2)
2723 (substring directory 0 2))))
2725 (let ((ancestor ".")
2726 (fname-dir (file-name-as-directory fname)))
2727 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2728 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2729 (setq directory (file-name-directory (substring directory 0 -1))
2730 ancestor (if (equal ancestor ".")
2732 (concat "../" ancestor))))
2733 ;; Now ancestor is empty, or .., or ../.., etc.
2734 (if (string-match (concat "^" (regexp-quote directory)) fname)
2735 ;; We matched within FNAME's directory part.
2736 ;; Add the rest of FNAME onto ANCESTOR.
2737 (let ((rest (substring fname (match-end 0))))
2738 (if (and (equal ancestor ".")
2739 (not (equal rest "")))
2740 ;; But don't bother with ANCESTOR if it would give us `./'.
2742 (concat (file-name-as-directory ancestor) rest)))
2743 ;; We matched FNAME's directory equivalent.
2746 (defun save-buffer (&optional args)
2747 "Save current buffer in visited file if modified. Versions described below.
2748 By default, makes the previous version into a backup file
2749 if previously requested or if this is the first save.
2750 With 1 \\[universal-argument], marks this version
2751 to become a backup when the next save is done.
2752 With 2 \\[universal-argument]'s,
2753 unconditionally makes the previous version into a backup file.
2754 With 3 \\[universal-argument]'s, marks this version
2755 to become a backup when the next save is done,
2756 and unconditionally makes the previous version into a backup file.
2758 With argument of 0, never make the previous version into a backup file.
2760 If a file's name is FOO, the names of its numbered backup versions are
2761 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2762 Numeric backups (rather than FOO~) will be made if value of
2763 `version-control' is not the atom `never' and either there are already
2764 numeric versions of the file being backed up, or `version-control' is
2766 We don't want excessive versions piling up, so there are variables
2767 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2768 and `kept-new-versions', which tells how many newest versions to keep.
2769 Defaults are 2 old versions and 2 new.
2770 `dired-kept-versions' controls dired's clean-directory (.) command.
2771 If `delete-old-versions' is nil, system will query user
2772 before trimming versions. Otherwise it does it silently.
2774 If `vc-make-backup-files' is nil, which is the default,
2775 no backup files are made for files managed by version control.
2776 (This is because the version control system itself records previous versions.)
2778 See the subroutine `basic-save-buffer' for more information."
2780 (let ((modp (buffer-modified-p))
2781 (large (> (buffer-size) 50000))
2782 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2783 (memq args '(16 64)))))
2784 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2785 (if (and modp large (buffer-file-name))
2786 (message "Saving file %s..." (buffer-file-name)))
2788 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2790 (defun delete-auto-save-file-if-necessary (&optional force)
2791 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2792 Normally delete only if the file was written by this Emacs since
2793 the last real save, but optional arg FORCE non-nil means delete anyway."
2794 (and buffer-auto-save-file-name delete-auto-save-files
2795 (not (string= buffer-file-name buffer-auto-save-file-name))
2796 (or force (recent-auto-save-p))
2799 (delete-file buffer-auto-save-file-name)
2801 (set-buffer-auto-saved))))
2803 (defvar auto-save-hook nil
2804 "Normal hook run just before auto-saving.")
2806 (defcustom after-save-hook nil
2807 "Normal hook that is run after a buffer is saved to its file."
2808 :options '(executable-make-buffer-file-executable-if-script-p)
2812 (defvar save-buffer-coding-system nil
2813 "If non-nil, use this coding system for saving the buffer.
2814 More precisely, use this coding system in place of the
2815 value of `buffer-file-coding-system', when saving the buffer.
2816 Calling `write-region' for any purpose other than saving the buffer
2817 will still use `buffer-file-coding-system'; this variable has no effect
2820 (make-variable-buffer-local 'save-buffer-coding-system)
2821 (put 'save-buffer-coding-system 'permanent-local t)
2823 (defun basic-save-buffer ()
2824 "Save the current buffer in its visited file, if it has been modified.
2825 The hooks `write-contents-functions' and `write-file-functions' get a chance
2826 to do the job of saving; if they do not, then the buffer is saved in
2827 the visited file file in the usual way.
2828 After saving the buffer, this function runs `after-save-hook'."
2830 (save-current-buffer
2831 ;; In an indirect buffer, save its base buffer instead.
2832 (if (buffer-base-buffer)
2833 (set-buffer (buffer-base-buffer)))
2834 (if (buffer-modified-p)
2835 (let ((recent-save (recent-auto-save-p))
2836 setmodes tempsetmodes)
2837 ;; On VMS, rename file and buffer to get rid of version number.
2838 (if (and (eq system-type 'vax-vms)
2839 (not (string= buffer-file-name
2840 (file-name-sans-versions buffer-file-name))))
2841 (let (buffer-new-name)
2842 ;; Strip VMS version number before save.
2843 (setq buffer-file-name
2844 (file-name-sans-versions buffer-file-name))
2845 ;; Construct a (unique) buffer name to correspond.
2846 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2847 (setq buffer-new-name (buffer-name buf))
2849 (rename-buffer buffer-new-name)))
2850 ;; If buffer has no file name, ask user for one.
2851 (or buffer-file-name
2854 (read-file-name "File to save in: ") nil)))
2855 (and (file-exists-p filename)
2856 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2858 (error "Canceled")))
2859 (set-visited-file-name filename)))
2860 (or (verify-visited-file-modtime (current-buffer))
2861 (not (file-exists-p buffer-file-name))
2863 (format "%s has changed since visited or saved. Save anyway? "
2864 (file-name-nondirectory buffer-file-name)))
2865 (error "Save not confirmed"))
2869 (and (> (point-max) (point-min))
2870 (not find-file-literally)
2871 (/= (char-after (1- (point-max))) ?\n)
2872 (not (and (eq selective-display t)
2873 (= (char-after (1- (point-max))) ?\r)))
2874 (or (eq require-final-newline t)
2875 (and require-final-newline
2877 (format "Buffer %s does not end in newline. Add one? "
2880 (goto-char (point-max))
2882 ;; Support VC version backups.
2884 (or (run-hook-with-args-until-success 'write-contents-functions)
2885 (run-hook-with-args-until-success 'local-write-file-hooks)
2886 (run-hook-with-args-until-success 'write-file-functions)
2887 ;; If a hook returned t, file is already "written".
2888 ;; Otherwise, write it the usual way now.
2889 (setq setmodes (basic-save-buffer-1)))
2890 ;; Now we have saved the current buffer. Let's make sure
2891 ;; that buffer-file-coding-system is fixed to what
2892 ;; actually used for saving by binding it locally.
2893 (if save-buffer-coding-system
2894 (setq save-buffer-coding-system last-coding-system-used)
2895 (setq buffer-file-coding-system last-coding-system-used))
2896 (setq buffer-file-number
2897 (nthcdr 10 (file-attributes buffer-file-name)))
2900 (set-file-modes buffer-file-name (car setmodes))
2902 ;; If the auto-save file was recent before this command,
2904 (delete-auto-save-file-if-necessary recent-save)
2905 ;; Support VC `implicit' locking.
2907 (run-hooks 'after-save-hook))
2908 (message "(No changes need to be saved)"))))
2910 ;; This does the "real job" of writing a buffer into its visited file
2911 ;; and making a backup file. This is what is normally done
2912 ;; but inhibited if one of write-file-functions returns non-nil.
2913 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
2914 (defun basic-save-buffer-1 ()
2915 (if save-buffer-coding-system
2916 (let ((coding-system-for-write save-buffer-coding-system))
2917 (basic-save-buffer-2))
2918 (basic-save-buffer-2)))
2920 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
2921 (defun basic-save-buffer-2 ()
2922 (let (tempsetmodes setmodes)
2923 (if (not (file-writable-p buffer-file-name))
2924 (let ((dir (file-name-directory buffer-file-name)))
2925 (if (not (file-directory-p dir))
2926 (if (file-exists-p dir)
2927 (error "%s is not a directory" dir)
2928 (error "%s: no such directory" buffer-file-name))
2929 (if (not (file-exists-p buffer-file-name))
2930 (error "Directory %s write-protected" dir)
2932 (format "File %s is write-protected; try to save anyway? "
2933 (file-name-nondirectory
2935 (setq tempsetmodes t)
2936 (error "Attempt to save to a file which you aren't allowed to write"))))))
2937 (or buffer-backed-up
2938 (setq setmodes (backup-buffer)))
2939 (let ((dir (file-name-directory buffer-file-name)))
2940 (if (and file-precious-flag
2941 (file-writable-p dir))
2942 ;; If file is precious, write temp name, then rename it.
2943 ;; This requires write access to the containing dir,
2944 ;; which is why we don't try it if we don't have that access.
2945 (let ((realname buffer-file-name)
2946 tempname temp nogood i succeed
2947 (old-modtime (visited-file-modtime)))
2950 ;; Find the temporary name to write under.
2952 (setq tempname (format
2953 (if (and (eq system-type 'ms-dos)
2954 (not (msdos-long-file-names)))
2955 "%s#%d.tm#" ; MSDOS limits files to 8+3
2956 (if (memq system-type '(vax-vms axp-vms))
2960 (setq nogood (file-exists-p tempname))
2963 (progn (clear-visited-file-modtime)
2964 (write-region (point-min) (point-max)
2965 tempname nil realname
2966 buffer-file-truename)
2968 ;; If writing the temp file fails,
2969 ;; delete the temp file.
2973 (delete-file tempname)
2975 (set-visited-file-modtime old-modtime))))
2976 ;; Since we have created an entirely new file
2977 ;; and renamed it, make sure it gets the
2978 ;; right permission bits set.
2979 (setq setmodes (or setmodes (cons (file-modes buffer-file-name)
2981 ;; We succeeded in writing the temp file,
2983 (rename-file tempname buffer-file-name t))
2984 ;; If file not writable, see if we can make it writable
2985 ;; temporarily while we write it.
2986 ;; But no need to do so if we have just backed it up
2987 ;; (setmodes is set) because that says we're superseding.
2988 (cond ((and tempsetmodes (not setmodes))
2989 ;; Change the mode back, after writing.
2990 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
2991 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
2995 (write-region (point-min) (point-max)
2996 buffer-file-name nil t buffer-file-truename)
2998 ;; If we get an error writing the new file, and we made
2999 ;; the backup by renaming, undo the backing-up.
3000 (and setmodes (not success)
3001 (rename-file (cdr setmodes) buffer-file-name))))))
3004 (defun diff-buffer-with-file (&optional buffer)
3005 "View the differences between BUFFER and its associated file.
3006 This requires the external program `diff' to be in your `exec-path'."
3007 (interactive "bBuffer: ")
3008 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3009 (if (and buffer-file-name
3010 (file-exists-p buffer-file-name))
3011 (let ((tempfile (make-temp-file "buffer-content-")))
3015 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3016 (diff buffer-file-name tempfile nil t)
3018 (when (file-exists-p tempfile)
3019 (delete-file tempfile))))
3020 (message "Buffer %s has no associated file on disc" (buffer-name))
3021 ;; Display that message for 1 second so that user can read it
3022 ;; in the minibuffer.
3024 ;; return always nil, so that save-buffers-kill-emacs will not move
3025 ;; over to the next unsaved buffer when calling `d'.
3028 (defvar save-some-buffers-action-alist
3033 (exit-recursive-edit)))
3035 ;; Return nil to ask about BUF again.
3037 "display the current buffer")
3038 (?d diff-buffer-with-file
3039 "show difference to last saved version"))
3040 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3041 (put 'save-some-buffers-action-alist 'risky-local-variable t)
3043 (defun save-some-buffers (&optional arg pred)
3044 "Save some modified file-visiting buffers. Asks user about each one.
3045 You can answer `y' to save, `n' not to save, `C-r' to look at the
3046 buffer in question with `view-buffer' before deciding or `d' to
3047 view the differences using `diff-buffer-to-file'.
3049 Optional argument (the prefix) non-nil means save all with no questions.
3050 Optional second argument PRED determines which buffers are considered:
3051 If PRED is nil, all the file-visiting buffers are considered.
3052 If PRED is t, then certain non-file buffers will also be considered.
3053 If PRED is a zero-argument function, it indicates for each buffer whether
3054 to consider it or not when called with that buffer current.
3056 See `save-some-buffers-action-alist' if you want to
3057 change the additional actions you can take on files."
3059 (save-window-excursion
3060 (let* ((queried nil)
3065 (and (buffer-modified-p buffer)
3066 (not (buffer-base-buffer buffer))
3068 (buffer-file-name buffer)
3072 (and buffer-offer-save (> (buffer-size) 0)))))
3073 (or (not (functionp pred))
3074 (with-current-buffer buffer (funcall pred)))
3078 (if (buffer-file-name buffer)
3079 (format "Save file %s? "
3080 (buffer-file-name buffer))
3081 (format "Save buffer %s? "
3082 (buffer-name buffer)))))))
3088 '("buffer" "buffers" "save")
3089 save-some-buffers-action-alist))
3091 (and save-abbrevs abbrevs-changed
3094 (eq save-abbrevs 'silently)
3095 (y-or-n-p (format "Save abbrevs in %s? "
3097 (write-abbrev-file nil))
3098 ;; Don't keep bothering user if he says no.
3099 (setq abbrevs-changed nil)
3101 (or queried (> files-done 0) abbrevs-done
3102 (message "(No files need saving)")))))
3104 (defun not-modified (&optional arg)
3105 "Mark current buffer as unmodified, not needing to be saved.
3106 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3108 It is not a good idea to use this function in Lisp programs, because it
3109 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3111 (message (if arg "Modification-flag set"
3112 "Modification-flag cleared"))
3113 (set-buffer-modified-p arg))
3115 (defun toggle-read-only (&optional arg)
3116 "Change whether this buffer is visiting its file read-only.
3117 With arg, set read-only iff arg is positive.
3118 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3121 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3122 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3126 ((and buffer-read-only view-mode)
3127 (View-exit-and-edit)
3128 (make-local-variable 'view-read-only)
3129 (setq view-read-only t)) ; Must leave view mode.
3130 ((and (not buffer-read-only) view-read-only
3131 (not (eq (get major-mode 'mode-class) 'special)))
3133 (t (setq buffer-read-only (not buffer-read-only))
3134 (force-mode-line-update)))
3135 (if (vc-backend buffer-file-name)
3136 (message (substitute-command-keys
3137 (concat "File is under version-control; "
3138 "use \\[vc-next-action] to check in/out"))))))
3140 (defun insert-file (filename)
3141 "Insert contents of file FILENAME into buffer after point.
3142 Set mark after the inserted text.
3144 This function is meant for the user to run interactively.
3145 Don't call it from programs! Use `insert-file-contents' instead.
3146 \(Its calling sequence is different; see its documentation)."
3147 (interactive "*fInsert file: ")
3148 (if (file-directory-p filename)
3149 (signal 'file-error (list "Opening input file" "file is a directory"
3151 (let ((tem (insert-file-contents filename)))
3152 (push-mark (+ (point) (car (cdr tem))))))
3154 (defun append-to-file (start end filename)
3155 "Append the contents of the region to the end of file FILENAME.
3156 When called from a function, expects three arguments,
3157 START, END and FILENAME. START and END are buffer positions
3158 saying what text to write."
3159 (interactive "r\nFAppend to file: ")
3160 (write-region start end filename t))
3162 (defun file-newest-backup (filename)
3163 "Return most recent backup file for FILENAME or nil if no backups exist."
3164 ;; `make-backup-file-name' will get us the right directory for
3165 ;; ordinary or numeric backups. It might create a directory for
3166 ;; backups as a side-effect, according to `backup-directory-alist'.
3167 (let* ((filename (file-name-sans-versions
3168 (make-backup-file-name filename)))
3169 (file (file-name-nondirectory filename))
3170 (dir (file-name-directory filename))
3171 (comp (file-name-all-completions file dir))
3175 (setq tem (pop comp))
3176 (cond ((and (backup-file-name-p tem)
3177 (string= (file-name-sans-versions tem) file))
3178 (setq tem (concat dir tem))
3179 (if (or (null newest)
3180 (file-newer-than-file-p tem newest))
3181 (setq newest tem)))))
3184 (defun rename-uniquely ()
3185 "Rename current buffer to a similar name not already taken.
3186 This function is useful for creating multiple shell process buffers
3187 or multiple mail buffers, etc."
3190 (let ((base-name (buffer-name)))
3191 (and (string-match "<[0-9]+>\\'" base-name)
3192 (not (and buffer-file-name
3194 (file-name-nondirectory buffer-file-name))))
3195 ;; If the existing buffer name has a <NNN>,
3196 ;; which isn't part of the file name (if any),
3197 ;; then get rid of that.
3198 (setq base-name (substring base-name 0 (match-beginning 0))))
3199 (rename-buffer (generate-new-buffer-name base-name))
3200 (force-mode-line-update))))
3202 (defun make-directory (dir &optional parents)
3203 "Create the directory DIR and any nonexistent parent dirs.
3204 Interactively, the default choice of directory to create
3205 is the current default directory for file names.
3206 That is useful when you have visited a file in a nonexistent directory.
3208 Noninteractively, the second (optional) argument PARENTS says whether
3209 to create parent directories if they don't exist."
3211 (list (read-file-name "Make directory: " default-directory default-directory
3214 ;; If default-directory is a remote directory,
3215 ;; make sure we find its make-directory handler.
3216 (setq dir (expand-file-name dir))
3217 (let ((handler (find-file-name-handler dir 'make-directory)))
3219 (funcall handler 'make-directory dir parents)
3221 (make-directory-internal dir)
3222 (let ((dir (directory-file-name (expand-file-name dir)))
3224 (while (not (file-exists-p dir))
3225 (setq create-list (cons dir create-list)
3226 dir (directory-file-name (file-name-directory dir))))
3228 (make-directory-internal (car create-list))
3229 (setq create-list (cdr create-list))))))))
3231 (put 'revert-buffer-function 'permanent-local t)
3232 (defvar revert-buffer-function nil
3233 "Function to use to revert this buffer, or nil to do the default.
3234 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3235 which are the arguments that `revert-buffer' received.")
3237 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3238 (defvar revert-buffer-insert-file-contents-function nil
3239 "Function to use to insert contents when reverting this buffer.
3240 Gets two args, first the nominal file name to use,
3241 and second, t if reading the auto-save file.
3243 The function you specify is responsible for updating (or preserving) point.")
3245 (defvar before-revert-hook nil
3246 "Normal hook for `revert-buffer' to run before reverting.
3247 If `revert-buffer-function' is used to override the normal revert
3248 mechanism, this hook is not used.")
3250 (defvar after-revert-hook nil
3251 "Normal hook for `revert-buffer' to run after reverting.
3252 Note that the hook value that it runs is the value that was in effect
3253 before reverting; that makes a difference if you have buffer-local
3256 If `revert-buffer-function' is used to override the normal revert
3257 mechanism, this hook is not used.")
3259 (defvar revert-buffer-internal-hook)
3261 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
3262 "Replace current buffer text with the text of the visited file on disk.
3263 This undoes all changes since the file was visited or saved.
3264 With a prefix argument, offer to revert from latest auto-save file, if
3265 that is more recent than the visited file.
3267 This command also works for special buffers that contain text which
3268 doesn't come from a file, but reflects some other data base instead:
3269 for example, Dired buffers and buffer-list buffers. In these cases,
3270 it reconstructs the buffer contents from the appropriate data base.
3272 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3273 to revert from the auto-save file when this is nil. Note that the
3274 sense of this argument is the reverse of the prefix argument, for the
3275 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3278 Optional second argument NOCONFIRM means don't ask for confirmation at
3279 all. (The local variable `revert-without-query', if non-nil, prevents
3282 Optional third argument PRESERVE-MODES non-nil means don't alter
3283 the files modes. Normally we reinitialize them using `normal-mode'.
3285 If the value of `revert-buffer-function' is non-nil, it is called to
3286 do all the work for this command. Otherwise, the hooks
3287 `before-revert-hook' and `after-revert-hook' are run at the beginning
3288 and the end, and if `revert-buffer-insert-file-contents-function' is
3289 non-nil, it is called instead of rereading visited file contents."
3291 ;; I admit it's odd to reverse the sense of the prefix argument, but
3292 ;; there is a lot of code out there which assumes that the first
3293 ;; argument should be t to avoid consulting the auto-save file, and
3294 ;; there's no straightforward way to encourage authors to notice a
3295 ;; reversal of the argument sense. So I'm just changing the user
3296 ;; interface, but leaving the programmatic interface the same.
3297 (interactive (list (not current-prefix-arg)))
3298 (if revert-buffer-function
3299 (funcall revert-buffer-function ignore-auto noconfirm)
3300 (let* ((auto-save-p (and (not ignore-auto)
3301 (recent-auto-save-p)
3302 buffer-auto-save-file-name
3303 (file-readable-p buffer-auto-save-file-name)
3305 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3306 (file-name (if auto-save-p
3307 buffer-auto-save-file-name
3309 (cond ((null file-name)
3310 (error "Buffer does not seem to be associated with any file"))
3312 (and (not (buffer-modified-p))
3313 (let ((tail revert-without-query)
3316 (if (string-match (car tail) file-name)
3318 (setq tail (cdr tail)))
3320 (yes-or-no-p (format "Revert buffer from file %s? "
3322 (run-hooks 'before-revert-hook)
3323 ;; If file was backed up but has changed since,
3324 ;; we shd make another backup.
3325 (and (not auto-save-p)
3326 (not (verify-visited-file-modtime (current-buffer)))
3327 (setq buffer-backed-up nil))
3328 ;; Get rid of all undo records for this buffer.
3329 (or (eq buffer-undo-list t)
3330 (setq buffer-undo-list nil))
3331 ;; Effectively copy the after-revert-hook status,
3332 ;; since after-find-file will clobber it.
3333 (let ((global-hook (default-value 'after-revert-hook))
3334 (local-hook-p (local-variable-p 'after-revert-hook))
3335 (local-hook (and (local-variable-p 'after-revert-hook)
3336 after-revert-hook)))
3337 (let (buffer-read-only
3338 ;; Don't make undo records for the reversion.
3339 (buffer-undo-list t))
3340 (if revert-buffer-insert-file-contents-function
3341 (funcall revert-buffer-insert-file-contents-function
3342 file-name auto-save-p)
3343 (if (not (file-exists-p file-name))
3344 (error "File %s no longer exists!" file-name))
3345 ;; Bind buffer-file-name to nil
3346 ;; so that we don't try to lock the file.
3347 (let ((buffer-file-name nil))
3351 (let ((coding-system-for-read
3352 ;; Auto-saved file shoule be read without
3353 ;; any code conversion.
3354 (if auto-save-p 'emacs-mule-unix
3355 (or coding-system-for-read
3356 buffer-file-coding-system))))
3358 ;; after-insert-file-set-buffer-file-coding-system
3359 ;; (called from insert-file-contents) to set
3360 ;; buffer-file-coding-system to a proper value.
3361 (kill-local-variable 'buffer-file-coding-system)
3363 ;; Note that this preserves point in an intelligent way.
3365 (let ((buffer-file-format buffer-file-format))
3366 (insert-file-contents file-name (not auto-save-p)
3368 (insert-file-contents file-name (not auto-save-p)
3370 ;; Recompute the truename in case changes in symlinks
3371 ;; have changed the truename.
3372 (setq buffer-file-truename
3373 (abbreviate-file-name (file-truename buffer-file-name)))
3374 (after-find-file nil nil t t preserve-modes)
3375 ;; Run after-revert-hook as it was before we reverted.
3376 (setq-default revert-buffer-internal-hook global-hook)
3379 (make-local-variable 'revert-buffer-internal-hook)
3380 (setq revert-buffer-internal-hook local-hook))
3381 (kill-local-variable 'revert-buffer-internal-hook))
3382 (run-hooks 'revert-buffer-internal-hook))
3385 (defun recover-this-file ()
3386 "Recover the visited file--get contents from its last auto-save file."
3388 (recover-file buffer-file-name))
3390 (defun recover-file (file)
3391 "Visit file FILE, but get contents from its last auto-save file."
3392 ;; Actually putting the file name in the minibuffer should be used
3394 ;; Not just because users often use the default.
3395 (interactive "FRecover file: ")
3396 (setq file (expand-file-name file))
3397 (if (auto-save-file-name-p (file-name-nondirectory file))
3398 (error "%s is an auto-save file" file))
3399 (let ((file-name (let ((buffer-file-name file))
3400 (make-auto-save-file-name))))
3401 (cond ((if (file-exists-p file)
3402 (not (file-newer-than-file-p file-name file))
3403 (not (file-exists-p file-name)))
3404 (error "Auto-save file %s not current" file-name))
3405 ((save-window-excursion
3406 (with-output-to-temp-buffer "*Directory*"
3407 (buffer-disable-undo standard-output)
3409 (let ((switches dired-listing-switches))
3410 (if (file-symlink-p file)
3411 (setq switches (concat switches "L")))
3412 (set-buffer standard-output)
3413 ;; Use insert-directory-safely, not insert-directory,
3414 ;; because these files might not exist. In particular,
3415 ;; FILE might not exist if the auto-save file was for
3416 ;; a buffer that didn't visit a file, such as "*mail*".
3417 ;; The code in v20.x called `ls' directly, so we need
3418 ;; to emulate what `ls' did in that case.
3419 (insert-directory-safely file switches)
3420 (insert-directory-safely file-name switches))))
3421 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3422 (switch-to-buffer (find-file-noselect file t))
3423 (let ((buffer-read-only nil)
3424 ;; Keep the current buffer-file-coding-system.
3425 (coding-system buffer-file-coding-system)
3426 ;; Auto-saved file shoule be read without any code conversion.
3427 (coding-system-for-read 'emacs-mule-unix))
3429 (insert-file-contents file-name nil)
3430 (set-buffer-file-coding-system coding-system))
3431 (after-find-file nil nil t))
3432 (t (error "Recover-file cancelled")))))
3434 (defun recover-session ()
3435 "Recover auto save files from a previous Emacs session.
3436 This command first displays a Dired buffer showing you the
3437 previous sessions that you could recover from.
3438 To choose one, move point to the proper line and then type C-c C-c.
3439 Then you'll be asked about a number of files to recover."
3441 (if (null auto-save-list-file-prefix)
3442 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3443 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3444 (unless (file-directory-p dir)
3445 (make-directory dir t)))
3446 (let ((ls-lisp-support-shell-wildcards t))
3447 (dired (concat auto-save-list-file-prefix "*")
3448 (concat dired-listing-switches "t")))
3450 (goto-char (point-min))
3451 (or (looking-at " Move to the session you want to recover,")
3452 (let ((inhibit-read-only t))
3453 ;; Each line starts with a space
3454 ;; so that Font Lock mode won't highlight the first character.
3455 (insert " Move to the session you want to recover,\n"
3456 " then type C-c C-c to select it.\n\n"
3457 " You can also delete some of these files;\n"
3458 " type d on a line to mark that file for deletion.\n\n"))))
3459 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3460 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3462 (defun recover-session-finish ()
3463 "Choose one saved session to recover auto-save files from.
3464 This command is used in the special Dired buffer created by
3465 \\[recover-session]."
3467 ;; Get the name of the session file to recover from.
3468 (let ((file (dired-get-filename))
3470 (buffer (get-buffer-create " *recover*")))
3472 (dired-do-flagged-delete t)
3475 ;; Read in the auto-save-list file.
3478 (insert-file-contents file)
3479 ;; Loop thru the text of that file
3480 ;; and get out the names of the files to recover.
3482 (let (thisfile autofile)
3484 ;; This is a pair of lines for a non-file-visiting buffer.
3485 ;; Get the auto-save file name and manufacture
3486 ;; a "visited file name" from that.
3490 (buffer-substring-no-properties
3498 (file-name-nondirectory autofile)
3500 (file-name-directory autofile)))
3502 ;; This pair of lines is a file-visiting
3503 ;; buffer. Use the visited file name.
3506 (buffer-substring-no-properties
3507 (point) (progn (end-of-line) (point))))
3510 (buffer-substring-no-properties
3511 (point) (progn (end-of-line) (point))))
3513 ;; Ignore a file if its auto-save file does not exist now.
3514 (if (file-exists-p autofile)
3515 (setq files (cons thisfile files)))))
3516 (setq files (nreverse files))
3517 ;; The file contains a pair of line for each auto-saved buffer.
3518 ;; The first line of the pair contains the visited file name
3519 ;; or is empty if the buffer was not visiting a file.
3520 ;; The second line is the auto-save file name.
3522 (map-y-or-n-p "Recover %s? "
3525 (save-excursion (recover-file file))
3527 "Failed to recover `%s'" file)))
3529 '("file" "files" "recover"))
3530 (message "No files can be recovered from this session now")))
3531 (kill-buffer buffer))))
3533 (defun kill-some-buffers (&optional list)
3534 "For each buffer in LIST, ask whether to kill it.
3535 LIST defaults to all existing live buffers."
3538 (setq list (buffer-list)))
3540 (let* ((buffer (car list))
3541 (name (buffer-name buffer)))
3542 (and (not (string-equal name ""))
3543 (/= (aref name 0) ? )
3545 (format "Buffer %s %s. Kill? "
3547 (if (buffer-modified-p buffer)
3548 "HAS BEEN EDITED" "is unmodified")))
3549 (kill-buffer buffer)))
3550 (setq list (cdr list))))
3552 (defun auto-save-mode (arg)
3553 "Toggle auto-saving of contents of current buffer.
3554 With prefix argument ARG, turn auto-saving on if positive, else off."
3556 (setq buffer-auto-save-file-name
3558 (or (not buffer-auto-save-file-name)
3559 ;; If auto-save is off because buffer has shrunk,
3560 ;; then toggling should turn it on.
3561 (< buffer-saved-size 0))
3562 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3563 (if (and buffer-file-name auto-save-visited-file-name
3564 (not buffer-read-only))
3566 (make-auto-save-file-name))))
3567 ;; If -1 was stored here, to temporarily turn off saving,
3569 (and (< buffer-saved-size 0)
3570 (setq buffer-saved-size 0))
3572 (message "Auto-save %s (in this buffer)"
3573 (if buffer-auto-save-file-name "on" "off")))
3574 buffer-auto-save-file-name)
3576 (defun rename-auto-save-file ()
3577 "Adjust current buffer's auto save file name for current conditions.
3578 Also rename any existing auto save file, if it was made in this session."
3579 (let ((osave buffer-auto-save-file-name))
3580 (setq buffer-auto-save-file-name
3581 (make-auto-save-file-name))
3582 (if (and osave buffer-auto-save-file-name
3583 (not (string= buffer-auto-save-file-name buffer-file-name))
3584 (not (string= buffer-auto-save-file-name osave))
3585 (file-exists-p osave)
3586 (recent-auto-save-p))
3587 (rename-file osave buffer-auto-save-file-name t))))
3589 (defun make-auto-save-file-name ()
3590 "Return file name to use for auto-saves of current buffer.
3591 Does not consider `auto-save-visited-file-name' as that variable is checked
3592 before calling this function. You can redefine this for customization.
3593 See also `auto-save-file-name-p'."
3594 (if buffer-file-name
3595 (let ((list auto-save-file-name-transforms)
3596 (filename buffer-file-name)
3598 ;; Apply user-specified translations
3599 ;; to the file name.
3600 (while (and list (not result))
3601 (if (string-match (car (car list)) filename)
3602 (setq result (replace-match (cadr (car list)) t nil
3604 uniq (car (cddr (car list)))))
3605 (setq list (cdr list)))
3608 (setq filename (concat
3609 (file-name-directory result)
3610 (subst-char-in-string
3612 (replace-regexp-in-string "!" "!!"
3614 (setq filename result)))
3616 (if (and (eq system-type 'ms-dos)
3617 (not (msdos-long-file-names)))
3618 ;; We truncate the file name to DOS 8+3 limits
3619 ;; before doing anything else, because the regexp
3620 ;; passed to string-match below cannot handle
3621 ;; extensions longer than 3 characters, multiple
3622 ;; dots, and other atrocities.
3623 (let ((fn (dos-8+3-filename
3624 (file-name-nondirectory buffer-file-name))))
3626 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
3628 (concat (file-name-directory buffer-file-name)
3629 "#" (match-string 1 fn)
3630 "." (match-string 3 fn) "#"))
3631 (concat (file-name-directory filename)
3633 (file-name-nondirectory filename)
3635 ;; Make sure auto-save file names don't contain characters
3636 ;; invalid for the underlying filesystem.
3637 (if (and (memq system-type '(ms-dos windows-nt))
3638 ;; Don't modify remote (ange-ftp) filenames
3639 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
3640 (convert-standard-filename result)
3643 ;; Deal with buffers that don't have any associated files. (Mail
3644 ;; mode tends to create a good number of these.)
3646 (let ((buffer-name (buffer-name))
3649 ;; Eliminate all slashes and backslashes by
3650 ;; replacing them with sequences that start with %.
3651 ;; Quote % also, to keep distinct names distinct.
3652 (while (string-match "[/\\%]" buffer-name limit)
3653 (let* ((character (aref buffer-name (match-beginning 0)))
3655 (cond ((eq character ?%) "%%")
3656 ((eq character ?/) "%+")
3657 ((eq character ?\\) "%-"))))
3658 (setq buffer-name (replace-match replacement t t buffer-name))
3659 (setq limit (1+ (match-end 0)))))
3660 ;; Generate the file name.
3665 (format "#%s#" buffer-name)
3666 ;; Try a few alternative directories, to get one we can
3669 ((file-writable-p default-directory) default-directory)
3670 ((file-writable-p "/var/tmp/") "/var/tmp/")
3672 (if (and (memq system-type '(ms-dos windows-nt))
3673 ;; Don't modify remote (ange-ftp) filenames
3674 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
3675 ;; The call to convert-standard-filename is in case
3676 ;; buffer-name includes characters not allowed by the
3677 ;; DOS/Windows filesystems. make-temp-file writes to the
3678 ;; file it creates, so we must fix the file name _before_
3679 ;; make-temp-file is called.
3680 (convert-standard-filename fname)
3683 ;; make-temp-file creates the file,
3684 ;; but we don't want it to exist until we do an auto-save.
3686 (delete-file file-name)
3690 (defun auto-save-file-name-p (filename)
3691 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3692 FILENAME should lack slashes. You can redefine this for customization."
3693 (string-match "^#.*#$" filename))
3695 (defun wildcard-to-regexp (wildcard)
3696 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3697 The generated regexp will match a filename iff the filename
3698 matches that wildcard according to shell rules. Only wildcards known
3699 by `sh' are supported."
3700 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3701 ;; Copy the initial run of non-special characters.
3702 (result (substring wildcard 0 i))
3703 (len (length wildcard)))
3704 ;; If no special characters, we're almost done.
3707 (let ((ch (aref wildcard i))
3715 (eq (aref wildcard (1+ i)) ?\]))
3717 ((eq ch ?\[) ; [...] maps to regexp char class
3722 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3725 (if (eq (aref wildcard i) ?\])
3730 ((eq (aref wildcard i) ?^)
3731 ;; Found "[^". Insert a `\0' character
3732 ;; (which cannot happen in a filename)
3733 ;; into the character class, so that `^'
3734 ;; is not the first character after `[',
3735 ;; and thus non-special in a regexp.
3739 ((eq (aref wildcard i) ?\])
3740 ;; I don't think `]' can appear in a
3741 ;; character class in a wildcard, but
3742 ;; let's be general here.
3747 (prog1 ; copy everything upto next `]'.
3750 (setq j (string-match
3752 (setq i (if j (1- j) (1- len)))))))
3754 ((eq ch ?*) "[^\000]*")
3758 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3759 ((eq ch ??) "[^\000]")
3760 (t (char-to-string ch)))))
3762 ;; Shell wildcards should match the entire filename,
3763 ;; not its part. Make the regexp say so.
3764 (concat "\\`" result "\\'")))
3766 (defcustom list-directory-brief-switches
3767 (if (eq system-type 'vax-vms) "" "-CF")
3768 "*Switches for `list-directory' to pass to `ls' for brief listing."
3772 (defcustom list-directory-verbose-switches
3773 (if (eq system-type 'vax-vms)
3774 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3776 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3780 (defun file-expand-wildcards (pattern &optional full)
3781 "Expand wildcard pattern PATTERN.
3782 This returns a list of file names which match the pattern.
3784 If PATTERN is written as an absolute relative file name,
3785 the values are absolute also.
3787 If PATTERN is written as a relative file name, it is interpreted
3788 relative to the current default directory, `default-directory'.
3789 The file names returned are normally also relative to the current
3790 default directory. However, if FULL is non-nil, they are absolute."
3792 (let* ((nondir (file-name-nondirectory pattern))
3793 (dirpart (file-name-directory pattern))
3794 ;; A list of all dirs that DIRPART specifies.
3795 ;; This can be more than one dir
3796 ;; if DIRPART contains wildcards.
3797 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
3798 (mapcar 'file-name-as-directory
3799 (file-expand-wildcards (directory-file-name dirpart)))
3803 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3804 (file-directory-p (directory-file-name (car dirs))))
3805 (let ((this-dir-contents
3806 ;; Filter out "." and ".."
3808 (mapcar #'(lambda (name)
3809 (unless (string-match "\\`\\.\\.?\\'"
3810 (file-name-nondirectory name))
3812 (directory-files (or (car dirs) ".") full
3813 (wildcard-to-regexp nondir))))))
3816 (if (and (car dirs) (not full))
3817 (mapcar (function (lambda (name) (concat (car dirs) name)))
3821 (setq dirs (cdr dirs)))
3824 (defun list-directory (dirname &optional verbose)
3825 "Display a list of files in or matching DIRNAME, a la `ls'.
3826 DIRNAME is globbed by the shell if necessary.
3827 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3828 Actions controlled by variables `list-directory-brief-switches'
3829 and `list-directory-verbose-switches'."
3830 (interactive (let ((pfx current-prefix-arg))
3831 (list (read-file-name (if pfx "List directory (verbose): "
3832 "List directory (brief): ")
3833 nil default-directory nil)
3835 (let ((switches (if verbose list-directory-verbose-switches
3836 list-directory-brief-switches))
3838 (or dirname (setq dirname default-directory))
3839 (setq dirname (expand-file-name dirname))
3840 (with-output-to-temp-buffer "*Directory*"
3841 (setq buffer standard-output)
3842 (buffer-disable-undo standard-output)
3843 (princ "Directory ")
3847 (set-buffer "*Directory*")
3848 (let ((wildcard (not (file-directory-p dirname))))
3849 (insert-directory dirname switches wildcard (not wildcard)))))
3850 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
3851 (with-current-buffer buffer
3852 (setq default-directory
3853 (if (file-directory-p dirname)
3854 (file-name-as-directory dirname)
3855 (file-name-directory dirname))))))
3857 (defun shell-quote-wildcard-pattern (pattern)
3858 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3860 PATTERN is assumed to represent a file-name wildcard suitable for the
3861 underlying filesystem. For Unix and GNU/Linux, the characters from the
3862 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
3863 the parts of the pattern which don't include wildcard characters are
3864 quoted with double quotes.
3865 Existing quote characters in PATTERN are left alone, so you can pass
3866 PATTERN that already quotes some of the special characters."
3869 ((memq system-type '(ms-dos windows-nt))
3870 ;; DOS/Windows don't allow `"' in file names. So if the
3871 ;; argument has quotes, we can safely assume it is already
3872 ;; quoted by the caller.
3873 (if (or (string-match "[\"]" pattern)
3874 ;; We quote [&()#$'] in case their shell is a port of a
3875 ;; Unixy shell. We quote [,=+] because stock DOS and
3876 ;; Windows shells require that in some cases, such as
3877 ;; passing arguments to batch files that use positional
3878 ;; arguments like %1.
3879 (not (string-match "[ \t;&()#$',=+]" pattern)))
3884 (while (string-match "[*?]+" pattern beg)
3885 (setq end (match-beginning 0)
3886 result (concat result (substring pattern beg end)
3888 (substring pattern end (match-end 0))
3891 (concat result (substring pattern beg) "\""))))
3894 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3896 (concat (substring pattern 0 (match-beginning 0))
3898 (substring pattern (match-beginning 0)))
3899 beg (1+ (match-end 0)))))
3903 (defvar insert-directory-program "ls"
3904 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3906 (defcustom directory-free-space-program "df"
3907 "*Program to get the amount of free space on a file system.
3908 We assume the output has the format of `df'.
3909 The value of this variable must be just a command name or file name;
3910 if you want to specify options, use `directory-free-space-args'.
3912 A value of nil disables this feature.
3914 If the function `file-system-info' is defined, it is always used in
3915 preference to the program given by this variable."
3916 :type '(choice (string :tag "Program") (const :tag "None" nil))
3919 (defcustom directory-free-space-args
3920 (if (eq system-type 'darwin) "-k" "-Pk")
3921 "*Options to use when running `directory-free-space-program'."
3925 (defun get-free-disk-space (dir)
3926 "Return the mount of free space on directory DIR's file system.
3927 The result is a string that gives the number of free 1KB blocks,
3928 or nil if the system call or the program which retrieve the infornmation
3931 This function calls `file-system-info' if it is available, or invokes the
3932 program specified by `directory-free-space-program' if that is non-nil."
3933 ;; Try to find the number of free blocks. Non-Posix systems don't
3934 ;; always have df, but might have an equivalent system call.
3935 (if (fboundp 'file-system-info)
3936 (let ((fsinfo (file-system-info dir)))
3938 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
3941 (when (and directory-free-space-program
3942 (zerop (call-process directory-free-space-program
3944 directory-free-space-args
3946 ;; Usual format is a header line followed by a line of
3948 (goto-char (point-min))
3952 ;; Move to the end of the "available blocks" number.
3953 (skip-chars-forward "^ \t")
3955 ;; Copy it into AVAILABLE.
3956 (let ((end (point)))
3958 (buffer-substring (point) end)))))))))
3962 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3963 ;; FULL-DIRECTORY-P is nil.
3964 ;; The single line of output must display FILE's name as it was
3965 ;; given, namely, an absolute path name.
3966 ;; - must insert exactly one line for each file if WILDCARD or
3967 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3968 ;; before the file lines, plus optional text after the file lines.
3969 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3971 ;; File lines should display the basename.
3972 ;; - must be consistent with
3973 ;; - functions dired-move-to-filename, (these two define what a file line is)
3974 ;; dired-move-to-end-of-filename,
3975 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3976 ;; dired-insert-headerline
3977 ;; dired-after-subdir-garbage (defines what a "total" line is)
3978 ;; - variable dired-subdir-regexp
3979 ;; - may be passed "--dired" as the first argument in SWITCHES.
3980 ;; Filename handlers might have to remove this switch if their
3981 ;; "ls" command does not support it.
3982 (defun insert-directory (file switches &optional wildcard full-directory-p)
3983 "Insert directory listing for FILE, formatted according to SWITCHES.
3984 Leaves point after the inserted text.
3985 SWITCHES may be a string of options, or a list of strings.
3986 Optional third arg WILDCARD means treat FILE as shell wildcard.
3987 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3988 switches do not contain `d', so that a full listing is expected.
3990 This works by running a directory listing program
3991 whose name is in the variable `insert-directory-program'.
3992 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3993 ;; We need the directory in order to find the right handler.
3994 (let ((handler (find-file-name-handler (expand-file-name file)
3995 'insert-directory)))
3997 (funcall handler 'insert-directory file switches
3998 wildcard full-directory-p)
3999 (if (eq system-type 'vax-vms)
4000 (vms-read-directory file switches (current-buffer))
4001 (let (result available (beg (point)))
4003 ;; Read the actual directory using `insert-directory-program'.
4004 ;; RESULT gets the status code.
4005 (let* ((coding-system-for-read
4006 (and enable-multibyte-characters
4007 (or file-name-coding-system
4008 default-file-name-coding-system)))
4009 ;; This is to control encoding the arguments in call-process.
4010 (coding-system-for-write coding-system-for-read))
4013 ;; Run ls in the directory part of the file pattern
4014 ;; using the last component as argument.
4015 (let ((default-directory
4016 (if (file-name-absolute-p file)
4017 (file-name-directory file)
4018 (file-name-directory (expand-file-name file))))
4019 (pattern (file-name-nondirectory file)))
4021 shell-file-name nil t nil
4023 (concat (if (memq system-type '(ms-dos windows-nt))
4025 "\\") ; Disregard Unix shell aliases!
4026 insert-directory-program
4028 (if (stringp switches)
4030 (mapconcat 'identity switches " "))
4032 ;; Quote some characters that have
4033 ;; special meanings in shells; but
4034 ;; don't quote the wildcards--we want
4035 ;; them to be special. We also
4036 ;; currently don't quote the quoting
4037 ;; characters in case people want to
4038 ;; use them explicitly to quote
4039 ;; wildcard characters.
4040 (shell-quote-wildcard-pattern pattern))))
4041 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4042 ;; directory if FILE is a symbolic link.
4043 (apply 'call-process
4044 insert-directory-program nil t nil
4046 (if (listp switches) switches
4047 (unless (equal switches "")
4048 ;; Split the switches at any spaces so we can
4049 ;; pass separate options as separate args.
4050 (split-string switches)))
4051 ;; Avoid lossage if FILE starts with `-'.
4054 (if (string-match "\\`~" file)
4055 (setq file (expand-file-name file)))
4057 (if full-directory-p
4058 (concat (file-name-as-directory file) ".")
4061 ;; If `insert-directory-program' failed, signal an error.
4063 ;; On non-Posix systems, we cannot open a directory, so
4064 ;; don't even try, because that will always result in
4065 ;; the ubiquitous "Access denied". Instead, show the
4066 ;; command line so the user can try to guess what went wrong.
4067 (if (and (file-directory-p file)
4068 (memq system-type '(ms-dos windows-nt)))
4070 "Reading directory: \"%s %s -- %s\" exited with status %s"
4071 insert-directory-program
4072 (if (listp switches) (concat switches) switches)
4074 ;; Unix. Access the file to get a suitable error.
4075 (access-file file "Reading directory")
4076 (error "Listing directory failed but `access-file' worked")))
4078 (when (string-match "--dired\\>" switches)
4080 (when (looking-at "//SUBDIRED//")
4081 (delete-region (point) (progn (forward-line 1) (point)))
4083 (let ((end (line-end-position)))
4086 (while (< (point) end)
4087 (let ((start (+ beg (read (current-buffer))))
4088 (end (+ beg (read (current-buffer)))))
4089 (put-text-property start end 'dired-filename t)))
4092 (delete-region (point) (progn (forward-line 2) (point)))))
4094 ;; Try to insert the amount of free space.
4097 ;; First find the line to put it on.
4098 (when (re-search-forward "^ *\\(total\\)" nil t)
4099 (let ((available (get-free-disk-space ".")))
4101 ;; Replace "total" with "used", to avoid confusion.
4102 (replace-match "total used in directory" nil nil nil 1)
4104 (insert " available " available))))))))))
4106 (defun insert-directory-safely (file switches
4107 &optional wildcard full-directory-p)
4108 "Insert directory listing for FILE, formatted according to SWITCHES.
4110 Like `insert-directory', but if FILE does not exist, it inserts a
4111 message to that effect instead of signaling an error."
4112 (if (file-exists-p file)
4113 (insert-directory file switches wildcard full-directory-p)
4114 ;; Simulate the message printed by `ls'.
4115 (insert (format "%s: No such file or directory\n" file))))
4117 (defvar kill-emacs-query-functions nil
4118 "Functions to call with no arguments to query about killing Emacs.
4119 If any of these functions returns nil, killing Emacs is cancelled.
4120 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
4121 but `kill-emacs', the low level primitive, does not.
4122 See also `kill-emacs-hook'.")
4124 (defcustom confirm-kill-emacs nil
4125 "How to ask for confirmation when leaving Emacs.
4126 If nil, the default, don't ask at all. If the value is non-nil, it should
4127 be a predicate function such as `yes-or-no-p'."
4128 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
4129 (const :tag "Ask with y-or-n-p" y-or-n-p)
4130 (const :tag "Don't confirm" nil))
4134 (defun save-buffers-kill-emacs (&optional arg)
4135 "Offer to save each buffer, then kill this Emacs process.
4136 With prefix arg, silently save all file-visiting buffers, then kill."
4138 (save-some-buffers arg t)
4139 (and (or (not (memq t (mapcar (function
4140 (lambda (buf) (and (buffer-file-name buf)
4141 (buffer-modified-p buf))))
4143 (yes-or-no-p "Modified buffers exist; exit anyway? "))
4144 (or (not (fboundp 'process-list))
4145 ;; process-list is not defined on VMS.
4146 (let ((processes (process-list))
4149 (and (memq (process-status (car processes)) '(run stop open listen))
4150 (process-query-on-exit-flag (car processes))
4152 (setq processes (cdr processes)))
4155 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
4156 ;; Query the user for other things, perhaps.
4157 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
4158 (or (null confirm-kill-emacs)
4159 (funcall confirm-kill-emacs "Really exit Emacs? "))
4162 ;; We use /: as a prefix to "quote" a file name
4163 ;; so that magic file name handlers will not apply to it.
4165 (setq file-name-handler-alist
4166 (cons '("\\`/:" . file-name-non-special)
4167 file-name-handler-alist))
4169 ;; We depend on being the last handler on the list,
4170 ;; so that anything else which does need handling
4171 ;; has been handled already.
4172 ;; So it is safe for us to inhibit *all* magic file name handlers.
4174 (defun file-name-non-special (operation &rest arguments)
4175 (let ((file-name-handler-alist nil)
4177 (if (eq operation 'insert-directory)
4178 (directory-file-name
4180 (unhandled-file-name-directory default-directory)))
4182 ;; Get a list of the indices of the args which are file names.
4184 (cdr (or (assq operation
4185 ;; The first five are special because they
4186 ;; return a file name. We want to include the /:
4187 ;; in the return value.
4188 ;; So just avoid stripping it in the first place.
4189 '((expand-file-name . nil)
4190 (file-name-directory . nil)
4191 (file-name-as-directory . nil)
4192 (directory-file-name . nil)
4193 (file-name-sans-versions . nil)
4194 ;; `identity' means just return the first arg
4195 ;; as stripped of its quoting.
4196 (substitute-in-file-name . identity)
4197 (file-name-completion 1)
4198 (file-name-all-completions 1)
4201 (make-symbolic-link 0 1)
4202 (add-name-to-file 0 1)))
4203 ;; For all other operations, treat the first argument only
4204 ;; as the file name.
4206 ;; Copy ARGUMENTS so we can replace elements in it.
4207 (arguments (copy-sequence arguments)))
4208 ;; Strip off the /: from the file names that have this handler.
4210 (while (consp file-arg-indices)
4211 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4213 (string-match "\\`/:" (car pair))
4215 (if (= (length (car pair)) 2)
4217 (substring (car pair) 2)))))
4218 (setq file-arg-indices (cdr file-arg-indices))))
4219 (if (eq file-arg-indices 'identity)
4221 (apply operation arguments))))
4223 (define-key ctl-x-map "\C-f" 'find-file)
4224 (define-key ctl-x-map "\C-r" 'find-file-read-only)
4225 (define-key ctl-x-map "\C-v" 'find-alternate-file)
4226 (define-key ctl-x-map "\C-s" 'save-buffer)
4227 (define-key ctl-x-map "s" 'save-some-buffers)
4228 (define-key ctl-x-map "\C-w" 'write-file)
4229 (define-key ctl-x-map "i" 'insert-file)
4230 (define-key esc-map "~" 'not-modified)
4231 (define-key ctl-x-map "\C-d" 'list-directory)
4232 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
4233 (define-key ctl-x-map "\C-q" 'toggle-read-only)
4235 (define-key ctl-x-4-map "f" 'find-file-other-window)
4236 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4237 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4238 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
4239 (define-key ctl-x-4-map "\C-o" 'display-buffer)
4241 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
4242 (define-key ctl-x-5-map "f" 'find-file-other-frame)
4243 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
4244 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
4246 ;;; files.el ends here