1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
34 (defvar font-lock-keywords)
38 "Backups of edited data files."
41 (defgroup find-file nil
46 (defcustom delete-auto-save-files t
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
54 (defcustom directory-abbrev-alist
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
68 :type '(repeat (cons :format "%v"
75 ;; Turn off backup files on VMS since it has version numbers.
76 (defcustom make-backup-files (not (eq system-type 'vax-vms))
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
99 (defvar backup-inhibited nil
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
102 But it is local only if you make it local.")
103 (put 'backup-inhibited 'permanent-local t)
105 (defcustom backup-by-copying nil
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
111 (defcustom backup-by-copying-when-linked nil
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
118 (defcustom backup-by-copying-when-mismatch nil
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
128 (defcustom backup-by-copying-when-privileged-mismatch 200
129 "Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
137 :type '(choice (const nil) integer)
140 (defvar backup-enable-predicate 'normal-backup-enable-predicate
141 "Predicate that looks at a file name and decides whether to make backups.
142 Called with an absolute file name as argument, it returns t to enable backup.")
144 (defcustom buffer-offer-save nil
145 "Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
150 (make-variable-buffer-local 'buffer-offer-save)
152 (defcustom find-file-existing-other-name t
153 "Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
159 (defcustom find-file-visit-truename nil
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
165 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
167 (defcustom revert-without-query nil
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
173 :type '(repeat regexp)
176 (defvar buffer-file-number nil
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
180 If the buffer is visiting a new file, the value is nil.")
181 (make-variable-buffer-local 'buffer-file-number)
182 (put 'buffer-file-number 'permanent-local t)
184 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
185 "Non-nil means that `buffer-file-number' uniquely identifies files.")
187 (defvar buffer-file-read-only nil
188 "Non-nil if visited file was read-only when visited.")
189 (make-variable-buffer-local 'buffer-file-read-only)
191 (defcustom temporary-file-directory
192 (file-name-as-directory
193 (cond ((memq system-type '(ms-dos windows-nt))
194 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
195 ((memq system-type '(vax-vms axp-vms))
196 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
198 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
199 "The directory for writing temporary files."
203 (defcustom small-temporary-file-directory
204 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
205 "The directory for writing small temporary files.
206 If non-nil, this directory is used instead of `temporary-file-directory'
207 by programs that create small temporary files. This is for systems that
208 have fast storage with limited space, such as a RAM disk."
210 :type '(choice (const nil) directory))
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
213 (defvar null-device "/dev/null" "The system null device.")
215 (defvar file-name-invalid-regexp
216 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
217 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
218 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
219 "[\000-\031]\\|" ; control characters
220 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
221 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
222 ((memq system-type '(ms-dos windows-nt cygwin))
223 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
224 "[|<>\"?*\000-\031]")) ; invalid characters
226 "Regexp recognizing file names which aren't allowed by the filesystem.")
228 (defcustom file-precious-flag nil
229 "Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files."
243 (defcustom version-control nil
244 "Control use of version numbers for backup files.
245 When t, make numeric backup versions unconditionally.
246 When nil, make them for files that have some already.
247 The value `never' means do not make them."
248 :type '(choice (const :tag "Never" never)
249 (const :tag "If existing" nil)
250 (other :tag "Always" t))
253 (put 'version-control 'safe-local-variable
254 '(lambda (x) (or (booleanp x) (equal x 'never))))
256 (defcustom dired-kept-versions 2
257 "When cleaning directory, number of versions to keep."
262 (defcustom delete-old-versions nil
263 "If t, delete excess backup versions silently.
264 If nil, ask confirmation. Any other value prevents any trimming."
265 :type '(choice (const :tag "Delete" t)
266 (const :tag "Ask" nil)
267 (other :tag "Leave" other))
270 (defcustom kept-old-versions 2
271 "Number of oldest versions to keep when a new numbered backup is made."
274 (put 'kept-old-versions 'safe-local-variable 'integerp)
276 (defcustom kept-new-versions 2
277 "Number of newest versions to keep when a new numbered backup is made.
278 Includes the new backup. Must be > 0"
281 (put 'kept-new-versions 'safe-local-variable 'integerp)
283 (defcustom require-final-newline nil
284 "Whether to add a newline automatically at the end of the file.
286 A value of t means do this only when the file is about to be saved.
287 A value of `visit' means do this right after the file is visited.
288 A value of `visit-save' means do it at both of those times.
289 Any other non-nil value means ask user whether to add a newline, when saving.
290 A value of nil means don't add newlines.
292 Certain major modes set this locally to the value obtained
293 from `mode-require-final-newline'."
294 :type '(choice (const :tag "When visiting" visit)
295 (const :tag "When saving" t)
296 (const :tag "When visiting or saving" visit-save)
297 (const :tag "Don't add newlines" nil)
298 (other :tag "Ask each time" ask))
299 :group 'editing-basics)
301 (defcustom mode-require-final-newline t
302 "Whether to add a newline at end of file, in certain major modes.
303 Those modes set `require-final-newline' to this value when you enable them.
304 They do so because they are often used for files that are supposed
305 to end in newlines, and the question is how to arrange that.
307 A value of t means do this only when the file is about to be saved.
308 A value of `visit' means do this right after the file is visited.
309 A value of `visit-save' means do it at both of those times.
310 Any other non-nil value means ask user whether to add a newline, when saving.
312 A value of nil means do not add newlines. That is a risky choice in this
313 variable since this value is used for modes for files that ought to have
314 final newlines. So if you set this to nil, you must explicitly check and
315 add a final newline, whenever you save a file that really needs one."
316 :type '(choice (const :tag "When visiting" visit)
317 (const :tag "When saving" t)
318 (const :tag "When visiting or saving" visit-save)
319 (const :tag "Don't add newlines" nil)
320 (other :tag "Ask each time" ask))
321 :group 'editing-basics
324 (defcustom auto-save-default t
325 "Non-nil says by default do auto-saving of every file-visiting buffer."
329 (defcustom auto-save-visited-file-name nil
330 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
331 Normally auto-save files are written under other names."
335 (defcustom auto-save-file-name-transforms
336 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
337 ;; Don't put "\\2" inside expand-file-name, since it will be
338 ;; transformed to "/2" on DOS/Windows.
339 ,(concat temporary-file-directory "\\2") t))
340 "Transforms to apply to buffer file name before making auto-save file name.
341 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
342 REGEXP is a regular expression to match against the file name.
343 If it matches, `replace-match' is used to replace the
344 matching part with REPLACEMENT.
345 If the optional element UNIQUIFY is non-nil, the auto-save file name is
346 constructed by taking the directory part of the replaced file-name,
347 concatenated with the buffer file name with all directory separators
348 changed to `!' to prevent clashes. This will not work
349 correctly if your filesystem truncates the resulting name.
351 All the transforms in the list are tried, in the order they are listed.
352 When one transform applies, its result is final;
353 no further transforms are tried.
355 The default value is set up to put the auto-save file into the
356 temporary directory (see the variable `temporary-file-directory') for
357 editing a remote file.
359 On MS-DOS filesystems without long names this variable is always
362 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
363 (boolean :tag "Uniquify")))
366 (defcustom save-abbrevs t
367 "Non-nil means save word abbrevs too when files are saved.
368 If `silently', don't ask the user before saving."
369 :type '(choice (const t) (const nil) (const silently))
372 (defcustom find-file-run-dired t
373 "Non-nil means allow `find-file' to visit directories.
374 To visit the directory, `find-file' runs `find-directory-functions'."
378 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
379 "List of functions to try in sequence to visit a directory.
380 Each function is called with the directory name as the sole argument
381 and should return either a buffer or nil."
382 :type '(hook :options (cvs-dired-noselect dired-noselect))
385 ;;;It is not useful to make this a local variable.
386 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
387 (defvar find-file-not-found-functions nil
388 "List of functions to be called for `find-file' on nonexistent file.
389 These functions are called as soon as the error is detected.
390 Variable `buffer-file-name' is already set up.
391 The functions are called in the order given until one of them returns non-nil.")
392 (define-obsolete-variable-alias 'find-file-not-found-hooks
393 'find-file-not-found-functions "22.1")
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-hooks 'permanent-local t)
397 (defcustom find-file-hook nil
398 "List of functions to be called after a buffer is loaded from a file.
399 The buffer's local variables (if any) will have been processed before the
400 functions are called."
403 :options '(auto-insert)
405 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
407 (defvar write-file-functions nil
408 "List of functions to be called before writing out a buffer to a file.
409 If one of them returns non-nil, the file is considered already written
410 and the rest are not called.
411 These hooks are considered to pertain to the visited file.
412 So any buffer-local binding of this variable is discarded if you change
413 the visited file name with \\[set-visited-file-name], but not when you
414 change the major mode.
416 This hook is not run if any of the functions in
417 `write-contents-functions' returns non-nil. Both hooks pertain
418 to how to save a buffer to file, for instance, choosing a suitable
419 coding system and setting mode bits. (See Info
420 node `(elisp)Saving Buffers'.) To perform various checks or
421 updates before the buffer is saved, use `before-save-hook'.")
422 (put 'write-file-functions 'permanent-local t)
423 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
425 (defvar local-write-file-hooks nil)
426 (make-variable-buffer-local 'local-write-file-hooks)
427 (put 'local-write-file-hooks 'permanent-local t)
428 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
430 (defvar write-contents-functions nil
431 "List of functions to be called before writing out a buffer to a file.
432 If one of them returns non-nil, the file is considered already written
433 and the rest are not called and neither are the functions in
434 `write-file-functions'.
436 This variable is meant to be used for hooks that pertain to the
437 buffer's contents, not to the particular visited file; thus,
438 `set-visited-file-name' does not clear this variable; but changing the
439 major mode does clear it.
441 For hooks that _do_ pertain to the particular visited file, use
442 `write-file-functions'. Both this variable and
443 `write-file-functions' relate to how a buffer is saved to file.
444 To perform various checks or updates before the buffer is saved,
445 use `before-save-hook'.")
446 (make-variable-buffer-local 'write-contents-functions)
447 (define-obsolete-variable-alias 'write-contents-hooks
448 'write-contents-functions "22.1")
450 (defcustom enable-local-variables t
451 "Control use of local variables in files you visit.
452 The value can be t, nil, :safe, or something else.
454 A value of t means file local variables specifications are obeyed
455 if all the specified variable values are safe; if any values are
456 not safe, Emacs queries you, once, whether to set them all.
457 \(When you say yes to certain values, they are remembered as safe.)
459 :safe means set the safe variables, and ignore the rest.
460 :all means set all variables, whether safe or not.
461 (Don't set it permanently to :all.)
462 A value of nil means always ignore the file local variables.
464 Any other value means always query you once whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe, but
466 this has no effect when `enable-local-variables' is \"something else\".)
468 This variable also controls use of major modes specified in
471 The command \\[normal-mode], when used interactively,
472 always obeys file local variable specifications and the -*- line,
473 and ignores this variable."
474 :type '(choice (const :tag "Query Unsafe" t)
475 (const :tag "Safe Only" :safe)
476 (const :tag "Do all" :all)
477 (const :tag "Ignore" nil)
478 (other :tag "Query" other))
481 (defvar local-enable-local-variables t
482 "Like `enable-local-variables' but meant for buffer-local bindings.
483 The meaningful values are nil and non-nil. The default is non-nil.
484 If a major mode sets this to nil, buffer-locally, then any local
485 variables list in the file will be ignored.
487 This variable does not affect the use of major modes
488 specified in a -*- line.")
490 (defcustom enable-local-eval 'maybe
491 "Control processing of the \"variable\" `eval' in a file's local variables.
492 The value can be t, nil or something else.
493 A value of t means obey `eval' variables;
494 A value of nil means ignore them; anything else means query."
495 :type '(choice (const :tag "Obey" t)
496 (const :tag "Ignore" nil)
497 (other :tag "Query" other))
500 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
501 (or (fboundp 'lock-buffer)
502 (defalias 'lock-buffer 'ignore))
503 (or (fboundp 'unlock-buffer)
504 (defalias 'unlock-buffer 'ignore))
505 (or (fboundp 'file-locked-p)
506 (defalias 'file-locked-p 'ignore))
508 (defcustom view-read-only nil
509 "Non-nil means buffers visiting files read-only do so in view mode.
510 In fact, this means that all read-only buffers normally have
511 View mode enabled, including buffers that are read-only because
512 you visit a file you cannot alter, and buffers you make read-only
513 using \\[toggle-read-only]."
517 (defvar file-name-history nil
518 "History list of file names entered in the minibuffer.")
520 (put 'ange-ftp-completion-hook-function 'safe-magic t)
521 (defun ange-ftp-completion-hook-function (op &rest args)
522 "Provides support for ange-ftp host name completion.
523 Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
526 (if (memq op '(file-name-completion file-name-all-completions))
527 (apply 'ange-ftp-hook-function op args)
528 (let ((inhibit-file-name-handlers
529 (cons 'ange-ftp-completion-hook-function
530 (and (eq inhibit-file-name-operation op)
531 inhibit-file-name-handlers)))
532 (inhibit-file-name-operation op))
535 (defun convert-standard-filename (filename)
536 "Convert a standard file's name to something suitable for the OS.
537 This means to guarantee valid names and perhaps to canonicalize
540 FILENAME should be an absolute file name since the conversion rules
541 sometimes vary depending on the position in the file name. E.g. c:/foo
542 is a valid DOS file name, but c:/bar/c:/foo is not.
544 This function's standard definition is trivial; it just returns
545 the argument. However, on Windows and DOS, replace invalid
546 characters. On DOS, make sure to obey the 8.3 limitations.
547 In the native Windows build, turn Cygwin names into native names,
548 and also turn slashes into backslashes if the shell requires it (see
549 `w32-shell-dos-semantics').
551 See Info node `(elisp)Standard File Names' for more details."
552 (if (eq system-type 'cygwin)
553 (let ((name (copy-sequence filename))
555 ;; Replace invalid filename characters with !
556 (while (string-match "[?*:<>|\"\000-\037]" name start)
557 (aset name (match-beginning 0) ?!)
558 (setq start (match-end 0)))
562 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564 Value is not expanded---you must call `expand-file-name' yourself.
565 Default name to DEFAULT-DIRNAME if user exits with the same
566 non-empty string that was inserted by this function.
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
569 If the user exits with an empty minibuffer, this function returns
570 an empty string. (This can only happen if the user erased the
571 pre-inserted contents or if `insert-default-directory' is nil.)
572 Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574 Fifth arg INITIAL specifies text to start with.
575 DIR should be an absolute directory name. It defaults to
576 the value of `default-directory'."
578 (setq dir default-directory))
579 (read-file-name prompt dir (or default-dirname
580 (if initial (expand-file-name initial dir)
587 "Show the current default directory."
589 (message "Directory %s" default-directory))
592 "Value of the CDPATH environment variable, as a list.
593 Not actually set up until the first time you use it.")
595 (defun parse-colon-path (cd-path)
596 "Explode a search path into a list of directory names.
597 Directories are separated by occurrences of `path-separator'
598 \(which is colon in GNU and GNU-like systems)."
599 ;; We could use split-string here.
601 (let (cd-list (cd-start 0) cd-colon)
602 (setq cd-path (concat cd-path path-separator))
603 (while (setq cd-colon (string-match path-separator cd-path cd-start))
606 (list (if (= cd-start cd-colon)
608 (substitute-in-file-name
609 (file-name-as-directory
610 (substring cd-path cd-start cd-colon)))))))
611 (setq cd-start (+ cd-colon 1)))
614 (defun cd-absolute (dir)
615 "Change current directory to given absolute file name DIR."
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
618 (if (not (eq system-type 'vax-vms))
619 (setq dir (file-name-as-directory dir)))
620 (setq dir (abbreviate-file-name (expand-file-name dir)))
621 (if (not (file-directory-p dir))
622 (if (file-exists-p dir)
623 (error "%s is not a directory" dir)
624 (error "%s: no such directory" dir))
625 (if (file-executable-p dir)
626 (setq default-directory dir)
627 (error "Cannot cd to %s: Permission denied" dir))))
630 "Make DIR become the current buffer's default directory.
631 If your environment includes a `CDPATH' variable, try each one of
632 that list of directories (separated by occurrences of
633 `path-separator') when resolving a relative directory name.
634 The path separator is colon in GNU and GNU-like systems."
636 (list (read-directory-name "Change default directory: "
637 default-directory default-directory
638 (and (member cd-path '(nil ("./")))
639 (null (getenv "CDPATH"))))))
640 (if (file-name-absolute-p dir)
641 (cd-absolute (expand-file-name dir))
643 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
644 (setq cd-path (or trypath (list "./")))))
645 (if (not (catch 'found
647 (function (lambda (x)
648 (let ((f (expand-file-name (concat x dir))))
649 (if (file-directory-p f)
652 (throw 'found t))))))
655 (error "No such directory found via CDPATH environment variable"))))
657 (defun load-file (file)
658 "Load the Lisp file named FILE."
659 ;; This is a case where .elc makes a lot of sense.
660 (interactive (list (let ((completion-ignored-extensions
661 (remove ".elc" completion-ignored-extensions)))
662 (read-file-name "Load file: "))))
663 (load (expand-file-name file) nil nil t))
665 (defun locate-file (filename path &optional suffixes predicate)
666 "Search for FILENAME through PATH.
667 If found, return the absolute file name of FILENAME, with its suffixes;
668 otherwise return nil.
669 PATH should be a list of directories to look in, like the lists in
670 `exec-path' or `load-path'.
671 If SUFFIXES is non-nil, it should be a list of suffixes to append to
672 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
673 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
674 If non-nil, PREDICATE is used instead of `file-readable-p'.
675 PREDICATE can also be an integer to pass to the `access' system call,
676 in which case file-name handlers are ignored. This usage is deprecated.
678 For compatibility, PREDICATE can also be one of the symbols
679 `executable', `readable', `writable', or `exists', or a list of
680 one or more of those symbols."
681 (if (and predicate (symbolp predicate) (not (functionp predicate)))
682 (setq predicate (list predicate)))
683 (when (and (consp predicate) (not (functionp predicate)))
685 (logior (if (memq 'executable predicate) 1 0)
686 (if (memq 'writable predicate) 2 0)
687 (if (memq 'readable predicate) 4 0))))
688 (locate-file-internal filename path suffixes predicate))
690 (defun locate-file-completion (string path-and-suffixes action)
691 "Do completion for file names passed to `locate-file'.
692 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
693 (if (file-name-absolute-p string)
694 (read-file-name-internal string nil action)
696 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
697 (string-dir (file-name-directory string)))
698 (dolist (dir (car path-and-suffixes))
700 (setq dir default-directory))
701 (if string-dir (setq dir (expand-file-name string-dir dir)))
702 (when (file-directory-p dir)
703 (dolist (file (file-name-all-completions
704 (file-name-nondirectory string) dir))
705 (add-to-list 'names (if string-dir (concat string-dir file) file))
706 (when (string-match suffix file)
707 (setq file (substring file 0 (match-beginning 0)))
708 (push (if string-dir (concat string-dir file) file) names)))))
710 ((eq action t) (all-completions string names))
711 ((null action) (try-completion string names))
712 (t (test-completion string names))))))
714 (defun locate-dominating-file (file regexp)
715 "Look up the directory hierarchy from FILE for a file matching REGEXP."
716 (while (and file (not (file-directory-p file)))
717 (setq file (file-name-directory (directory-file-name file))))
719 (let ((user (nth 2 (file-attributes file)))
720 ;; Abbreviate, so as to stop when we cross ~/.
721 (dir (abbreviate-file-name (file-name-as-directory file)))
723 ;; As a heuristic, we stop looking up the hierarchy of directories as
724 ;; soon as we find a directory belonging to another user. This should
725 ;; save us from looking in things like /net and /afs. This assumes
726 ;; that all the files inside a project belong to the same user.
727 (while (and dir (equal user (nth 2 (file-attributes dir))))
728 (if (setq files (directory-files dir 'full regexp))
729 (throw 'found (car files))
731 (setq dir (file-name-directory
732 (directory-file-name dir))))
736 (defun executable-find (command)
737 "Search for COMMAND in `exec-path' and return the absolute file name.
738 Return nil if COMMAND is not found anywhere in `exec-path'."
739 ;; Use 1 rather than file-executable-p to better match the behavior of
741 (locate-file command exec-path exec-suffixes 1))
743 (defun load-library (library)
744 "Load the library named LIBRARY.
745 This is an interface to the function `load'."
747 (list (completing-read "Load library: "
748 'locate-file-completion
749 (cons load-path (get-load-suffixes)))))
752 (defun file-remote-p (file &optional identification connected)
753 "Test whether FILE specifies a location on a remote system.
754 Return an identification of the system if the location is indeed
755 remote. The identification of the system may comprise a method
756 to access the system and its hostname, amongst other things.
758 For example, the filename \"/user@host:/foo\" specifies a location
759 on the system \"/user@host:\".
761 IDENTIFICATION specifies which part of the identification shall
762 be returned as string. IDENTIFICATION can be the symbol
763 `method', `user' or `host'; any other value is handled like nil
764 and means to return the complete identification string.
766 If CONNECTED is non-nil, the function returns an identification only
767 if FILE is located on a remote system, and a connection is established
768 to that remote system.
770 `file-remote-p' will never open a connection on its own."
771 (let ((handler (find-file-name-handler file 'file-remote-p)))
773 (funcall handler 'file-remote-p file identification connected)
776 (defun file-local-copy (file)
777 "Copy the file FILE into a temporary file on this machine.
778 Returns the name of the local copy, or nil, if FILE is directly
780 ;; This formerly had an optional BUFFER argument that wasn't used by
782 (let ((handler (find-file-name-handler file 'file-local-copy)))
784 (funcall handler 'file-local-copy file)
787 (defun file-truename (filename &optional counter prev-dirs)
788 "Return the truename of FILENAME, which should be absolute.
789 The truename of a file name is found by chasing symbolic links
790 both at the level of the file and at the level of the directories
791 containing it, until no links are left at any level.
793 \(fn FILENAME)" ;; Don't document the optional arguments.
794 ;; COUNTER and PREV-DIRS are only used in recursive calls.
795 ;; COUNTER can be a cons cell whose car is the count of how many
796 ;; more links to chase before getting an error.
797 ;; PREV-DIRS can be a cons cell whose car is an alist
798 ;; of truenames we've just recently computed.
799 (cond ((or (string= filename "") (string= filename "~"))
800 (setq filename (expand-file-name filename))
801 (if (string= filename "")
802 (setq filename "/")))
803 ((and (string= (substring filename 0 1) "~")
804 (string-match "~[^/]*/?" filename))
806 (substring filename 0 (match-end 0)))
807 (rest (substring filename (match-end 0))))
808 (setq filename (concat (expand-file-name first-part) rest)))))
810 (or counter (setq counter (list 100)))
812 ;; For speed, remove the ange-ftp completion handler from the list.
813 ;; We know it's not needed here.
814 ;; For even more speed, do this only on the outermost call.
815 (file-name-handler-alist
816 (if prev-dirs file-name-handler-alist
817 (let ((tem (copy-sequence file-name-handler-alist)))
818 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
819 (or prev-dirs (setq prev-dirs (list nil)))
821 ;; andrewi@harlequin.co.uk - none of the following code (except for
822 ;; invoking the file-name handler) currently applies on Windows
823 ;; (ie. there are no native symlinks), but there is an issue with
824 ;; case differences being ignored by the OS, and short "8.3 DOS"
825 ;; name aliases existing for all files. (The short names are not
826 ;; reported by directory-files, but can be used to refer to files.)
827 ;; It seems appropriate for file-truename to resolve these issues in
828 ;; the most natural way, which on Windows is to call the function
829 ;; `w32-long-file-name' - this returns the exact name of a file as
830 ;; it is stored on disk (expanding short name aliases with the full
831 ;; name in the process).
832 (if (eq system-type 'windows-nt)
833 (let ((handler (find-file-name-handler filename 'file-truename)))
834 ;; For file name that has a special handler, call handler.
835 ;; This is so that ange-ftp can save time by doing a no-op.
837 (setq filename (funcall handler 'file-truename filename))
838 ;; If filename contains a wildcard, newname will be the old name.
839 (unless (string-match "[[*?]" filename)
840 ;; If filename exists, use the long name
841 (setq filename (or (w32-long-file-name filename) filename))))
844 ;; If this file directly leads to a link, process that iteratively
845 ;; so that we don't use lots of stack.
847 (setcar counter (1- (car counter)))
848 (if (< (car counter) 0)
849 (error "Apparent cycle of symbolic links for %s" filename))
850 (let ((handler (find-file-name-handler filename 'file-truename)))
851 ;; For file name that has a special handler, call handler.
852 ;; This is so that ange-ftp can save time by doing a no-op.
854 (setq filename (funcall handler 'file-truename filename)
856 (let ((dir (or (file-name-directory filename) default-directory))
858 ;; Get the truename of the directory.
859 (setq dirfile (directory-file-name dir))
860 ;; If these are equal, we have the (or a) root directory.
861 (or (string= dir dirfile)
862 ;; If this is the same dir we last got the truename for,
863 ;; save time--don't recalculate.
864 (if (assoc dir (car prev-dirs))
865 (setq dir (cdr (assoc dir (car prev-dirs))))
867 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
868 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
870 (if (equal ".." (file-name-nondirectory filename))
872 (directory-file-name (file-name-directory (directory-file-name dir)))
874 (if (equal "." (file-name-nondirectory filename))
875 (setq filename (directory-file-name dir)
877 ;; Put it back on the file name.
878 (setq filename (concat dir (file-name-nondirectory filename)))
879 ;; Is the file name the name of a link?
880 (setq target (file-symlink-p filename))
882 ;; Yes => chase that link, then start all over
883 ;; since the link may point to a directory name that uses links.
884 ;; We can't safely use expand-file-name here
885 ;; since target might look like foo/../bar where foo
886 ;; is itself a link. Instead, we handle . and .. above.
888 (if (file-name-absolute-p target)
896 (defun file-chase-links (filename &optional limit)
897 "Chase links in FILENAME until a name that is not a link.
898 Unlike `file-truename', this does not check whether a parent
899 directory name is a symbolic link.
900 If the optional argument LIMIT is a number,
901 it means chase no more than that many links and then stop."
902 (let (tem (newname filename)
904 (while (and (or (null limit) (< count limit))
905 (setq tem (file-symlink-p newname)))
907 (if (and (null limit) (= count 100))
908 (error "Apparent cycle of symbolic links for %s" filename))
909 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
910 (while (string-match "//+" tem)
911 (setq tem (replace-match "/" nil nil tem)))
912 ;; Handle `..' by hand, since it needs to work in the
913 ;; target of any directory symlink.
914 ;; This code is not quite complete; it does not handle
915 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
916 (while (string-match "\\`\\.\\./" tem)
917 (setq tem (substring tem 3))
918 (setq newname (expand-file-name newname))
919 ;; Chase links in the default dir of the symlink.
922 (directory-file-name (file-name-directory newname))))
923 ;; Now find the parent of that dir.
924 (setq newname (file-name-directory newname)))
925 (setq newname (expand-file-name tem (file-name-directory newname)))
926 (setq count (1+ count))))
929 (defun make-temp-file (prefix &optional dir-flag suffix)
930 "Create a temporary file.
931 The returned file name (created by appending some random characters at the end
932 of PREFIX, and expanding against `temporary-file-directory' if necessary),
933 is guaranteed to point to a newly created empty file.
934 You can then use `write-region' to write new data into the file.
936 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
938 If SUFFIX is non-nil, add that at the end of the file name."
939 (let ((umask (default-file-modes))
943 ;; Create temp files with strict access rights. It's easy to
944 ;; loosen them later, whereas it's impossible to close the
945 ;; time-window of loose permissions otherwise.
946 (set-default-file-modes ?\700)
947 (while (condition-case ()
951 (expand-file-name prefix temporary-file-directory)))
953 (setq file (concat file suffix)))
955 (make-directory file)
956 (write-region "" nil file nil 'silent nil 'excl))
958 (file-already-exists t))
959 ;; the file was somehow created by someone else between
960 ;; `make-temp-name' and `write-region', let's try again.
964 (set-default-file-modes umask))))
966 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
967 "Change the encoding of FILE's name from CODING to NEW-CODING.
968 The value is a new name of FILE.
969 Signals a `file-already-exists' error if a file of the new name
970 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
971 is non-nil. A number as fourth arg means request confirmation if
972 the new name already exists. This is what happens in interactive
975 (let ((default-coding (or file-name-coding-system
976 default-file-name-coding-system))
977 (filename (read-file-name "Recode filename: " nil nil t))
978 from-coding to-coding)
979 (if (and default-coding
980 ;; We provide the default coding only when it seems that
981 ;; the filename is correctly decoded by the default
983 (let ((charsets (find-charset-string filename)))
984 (and (not (memq 'eight-bit-control charsets))
985 (not (memq 'eight-bit-graphic charsets)))))
986 (setq from-coding (read-coding-system
987 (format "Recode filename %s from (default %s): "
988 filename default-coding)
990 (setq from-coding (read-coding-system
991 (format "Recode filename %s from: " filename))))
993 ;; We provide the default coding only when a user is going to
994 ;; change the encoding not from the default coding.
995 (if (eq from-coding default-coding)
996 (setq to-coding (read-coding-system
997 (format "Recode filename %s from %s to: "
998 filename from-coding)))
999 (setq to-coding (read-coding-system
1000 (format "Recode filename %s from %s to (default %s): "
1001 filename from-coding default-coding)
1003 (list filename from-coding to-coding)))
1005 (let* ((default-coding (or file-name-coding-system
1006 default-file-name-coding-system))
1007 ;; FILE should have been decoded by DEFAULT-CODING.
1008 (encoded (encode-coding-string file default-coding))
1009 (newname (decode-coding-string encoded coding))
1010 (new-encoded (encode-coding-string newname new-coding))
1011 ;; Suppress further encoding.
1012 (file-name-coding-system nil)
1013 (default-file-name-coding-system nil)
1014 (locale-coding-system nil))
1015 (rename-file encoded new-encoded ok-if-already-exists)
1018 (defun switch-to-buffer-other-window (buffer &optional norecord)
1019 "Select buffer BUFFER in another window.
1020 If BUFFER does not identify an existing buffer, then this function
1021 creates a buffer with that name.
1023 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1024 or nil. If BUFFER is nil, then this function chooses a buffer
1025 using `other-buffer'.
1026 Optional second arg NORECORD non-nil means
1027 do not put this buffer at the front of the list of recently selected ones.
1028 This function returns the buffer it switched to.
1030 This uses the function `display-buffer' as a subroutine; see its
1031 documentation for additional customization information."
1032 (interactive "BSwitch to buffer in other window: ")
1033 (let ((pop-up-windows t)
1034 ;; Don't let these interfere.
1035 same-window-buffer-names same-window-regexps)
1036 (pop-to-buffer buffer t norecord)))
1038 (defun switch-to-buffer-other-frame (buffer &optional norecord)
1039 "Switch to buffer BUFFER in another frame.
1040 Optional second arg NORECORD non-nil means
1041 do not put this buffer at the front of the list of recently selected ones.
1043 This uses the function `display-buffer' as a subroutine; see its
1044 documentation for additional customization information."
1045 (interactive "BSwitch to buffer in other frame: ")
1046 (let ((pop-up-frames t)
1047 same-window-buffer-names same-window-regexps)
1048 (pop-to-buffer buffer t norecord)
1049 (raise-frame (window-frame (selected-window)))))
1051 (defun display-buffer-other-frame (buffer)
1052 "Switch to buffer BUFFER in another frame.
1053 This uses the function `display-buffer' as a subroutine; see its
1054 documentation for additional customization information."
1055 (interactive "BDisplay buffer in other frame: ")
1056 (let ((pop-up-frames t)
1057 same-window-buffer-names same-window-regexps
1058 (old-window (selected-window))
1060 (setq new-window (display-buffer buffer t))
1061 (lower-frame (window-frame new-window))
1062 (make-frame-invisible (window-frame old-window))
1063 (make-frame-visible (window-frame old-window))))
1065 (defvar find-file-default nil
1066 "Used within `find-file-read-args'.")
1068 (defmacro minibuffer-with-setup-hook (fun &rest body)
1069 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1070 BODY should use the minibuffer at most once.
1071 Recursive uses of the minibuffer will not be affected."
1072 (declare (indent 1) (debug t))
1073 (let ((hook (make-symbol "setup-hook")))
1077 ;; Clear out this hook so it does not interfere
1078 ;; with any recursive minibuffer usage.
1079 (remove-hook 'minibuffer-setup-hook ,hook)
1083 (add-hook 'minibuffer-setup-hook ,hook)
1085 (remove-hook 'minibuffer-setup-hook ,hook)))))
1087 (defcustom find-file-confirm-nonexistent-file nil
1088 "If non-nil, `find-file' requires confirmation before visiting a new file."
1093 (defun find-file-read-args (prompt mustmatch)
1094 (list (let ((find-file-default
1095 (and buffer-file-name
1096 (abbreviate-file-name buffer-file-name))))
1097 (minibuffer-with-setup-hook
1098 (lambda () (setq minibuffer-default find-file-default))
1099 (read-file-name prompt nil default-directory mustmatch)))
1102 (defun find-file (filename &optional wildcards)
1103 "Edit file FILENAME.
1104 Switch to a buffer visiting file FILENAME,
1105 creating one if none already exists.
1106 Interactively, the default if you just type RET is the current directory,
1107 but the visited file name is available through the minibuffer history:
1108 type M-n to pull it into the minibuffer.
1110 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1111 expand wildcards (if any) and visit multiple files. You can
1112 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1114 To visit a file without any kind of conversion and without
1115 automatically choosing a major mode, use \\[find-file-literally]."
1117 (find-file-read-args "Find file: "
1118 (if find-file-confirm-nonexistent-file 'confirm-only)))
1119 (let ((value (find-file-noselect filename nil nil wildcards)))
1121 (mapcar 'switch-to-buffer (nreverse value))
1122 (switch-to-buffer value))))
1124 (defun find-file-other-window (filename &optional wildcards)
1125 "Edit file FILENAME, in another window.
1126 May create a new window, or reuse an existing one.
1127 See the function `display-buffer'.
1129 Interactively, the default if you just type RET is the current directory,
1130 but the visited file name is available through the minibuffer history:
1131 type M-n to pull it into the minibuffer.
1133 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1134 expand wildcards (if any) and visit multiple files."
1136 (find-file-read-args "Find file in other window: "
1137 (if find-file-confirm-nonexistent-file 'confirm-only)))
1138 (let ((value (find-file-noselect filename nil nil wildcards)))
1141 (setq value (nreverse value))
1142 (cons (switch-to-buffer-other-window (car value))
1143 (mapcar 'switch-to-buffer (cdr value))))
1144 (switch-to-buffer-other-window value))))
1146 (defun find-file-other-frame (filename &optional wildcards)
1147 "Edit file FILENAME, in another frame.
1148 May create a new frame, or reuse an existing one.
1149 See the function `display-buffer'.
1151 Interactively, the default if you just type RET is the current directory,
1152 but the visited file name is available through the minibuffer history:
1153 type M-n to pull it into the minibuffer.
1155 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1156 expand wildcards (if any) and visit multiple files."
1158 (find-file-read-args "Find file in other frame: "
1159 (if find-file-confirm-nonexistent-file 'confirm-only)))
1160 (let ((value (find-file-noselect filename nil nil wildcards)))
1163 (setq value (nreverse value))
1164 (cons (switch-to-buffer-other-frame (car value))
1165 (mapcar 'switch-to-buffer (cdr value))))
1166 (switch-to-buffer-other-frame value))))
1168 (defun find-file-existing (filename)
1169 "Edit the existing file FILENAME.
1170 Like \\[find-file] but only allow a file that exists, and do not allow
1171 file names with wildcards."
1172 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1173 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1174 (error "%s does not exist" filename)
1175 (find-file filename)
1178 (defun find-file-read-only (filename &optional wildcards)
1179 "Edit file FILENAME but don't allow changes.
1180 Like \\[find-file] but marks buffer as read-only.
1181 Use \\[toggle-read-only] to permit editing."
1183 (find-file-read-args "Find file read-only: "
1184 (if find-file-confirm-nonexistent-file 'confirm-only)))
1185 (unless (or (and wildcards find-file-wildcards
1186 (not (string-match "\\`/:" filename))
1187 (string-match "[[*?]" filename))
1188 (file-exists-p filename))
1189 (error "%s does not exist" filename))
1190 (let ((value (find-file filename wildcards)))
1191 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1192 (if (listp value) value (list value)))
1195 (defun find-file-read-only-other-window (filename &optional wildcards)
1196 "Edit file FILENAME in another window but don't allow changes.
1197 Like \\[find-file-other-window] but marks buffer as read-only.
1198 Use \\[toggle-read-only] to permit editing."
1200 (find-file-read-args "Find file read-only other window: "
1201 (if find-file-confirm-nonexistent-file 'confirm-only)))
1202 (unless (or (and wildcards find-file-wildcards
1203 (not (string-match "\\`/:" filename))
1204 (string-match "[[*?]" filename))
1205 (file-exists-p filename))
1206 (error "%s does not exist" filename))
1207 (let ((value (find-file-other-window filename wildcards)))
1208 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1209 (if (listp value) value (list value)))
1212 (defun find-file-read-only-other-frame (filename &optional wildcards)
1213 "Edit file FILENAME in another frame but don't allow changes.
1214 Like \\[find-file-other-frame] but marks buffer as read-only.
1215 Use \\[toggle-read-only] to permit editing."
1217 (find-file-read-args "Find file read-only other frame: "
1218 (if find-file-confirm-nonexistent-file 'confirm-only)))
1219 (unless (or (and wildcards find-file-wildcards
1220 (not (string-match "\\`/:" filename))
1221 (string-match "[[*?]" filename))
1222 (file-exists-p filename))
1223 (error "%s does not exist" filename))
1224 (let ((value (find-file-other-frame filename wildcards)))
1225 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1226 (if (listp value) value (list value)))
1229 (defun find-alternate-file-other-window (filename &optional wildcards)
1230 "Find file FILENAME as a replacement for the file in the next window.
1231 This command does not select that window.
1233 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1234 expand wildcards (if any) and replace the file with multiple files."
1236 (save-selected-window
1238 (let ((file buffer-file-name)
1242 (setq file-name (file-name-nondirectory file)
1243 file-dir (file-name-directory file)))
1244 (list (read-file-name
1245 "Find alternate file: " file-dir nil nil file-name)
1248 (find-file-other-window filename wildcards)
1249 (save-selected-window
1251 (find-alternate-file filename wildcards))))
1253 (defun find-alternate-file (filename &optional wildcards)
1254 "Find file FILENAME, select its buffer, kill previous buffer.
1255 If the current buffer now contains an empty file that you just visited
1256 \(presumably by mistake), use this command to visit the file you really want.
1258 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1259 expand wildcards (if any) and replace the file with multiple files.
1261 If the current buffer is an indirect buffer, or the base buffer
1262 for one or more indirect buffers, the other buffer(s) are not
1265 (let ((file buffer-file-name)
1269 (setq file-name (file-name-nondirectory file)
1270 file-dir (file-name-directory file)))
1271 (list (read-file-name
1272 "Find alternate file: " file-dir nil nil file-name)
1274 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1276 (when (and (buffer-modified-p) (buffer-file-name))
1277 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1279 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1282 (let ((obuf (current-buffer))
1283 (ofile buffer-file-name)
1284 (onum buffer-file-number)
1285 (odir dired-directory)
1286 (otrue buffer-file-truename)
1287 (oname (buffer-name)))
1288 (if (get-buffer " **lose**")
1289 (kill-buffer " **lose**"))
1290 (rename-buffer " **lose**")
1294 ;; This prevents us from finding the same buffer
1295 ;; if we specified the same file again.
1296 (setq buffer-file-name nil)
1297 (setq buffer-file-number nil)
1298 (setq buffer-file-truename nil)
1299 ;; Likewise for dired buffers.
1300 (setq dired-directory nil)
1301 (find-file filename wildcards))
1302 (when (eq obuf (current-buffer))
1303 ;; This executes if find-file gets an error
1304 ;; and does not really find anything.
1305 ;; We put things back as they were.
1306 ;; If find-file actually finds something, we kill obuf below.
1307 (setq buffer-file-name ofile)
1308 (setq buffer-file-number onum)
1309 (setq buffer-file-truename otrue)
1310 (setq dired-directory odir)
1312 (rename-buffer oname)))
1313 (unless (eq (current-buffer) obuf)
1314 (with-current-buffer obuf
1315 ;; We already asked; don't ask again.
1316 (let ((kill-buffer-query-functions))
1317 (kill-buffer obuf))))))
1319 (defun create-file-buffer (filename)
1320 "Create a suitably named buffer for visiting FILENAME, and return it.
1321 FILENAME (sans directory) is used unchanged if that name is free;
1322 otherwise a string <2> or <3> or ... is appended to get an unused name."
1323 (let ((lastname (file-name-nondirectory filename)))
1324 (if (string= lastname "")
1325 (setq lastname filename))
1326 (generate-new-buffer lastname)))
1328 (defun generate-new-buffer (name)
1329 "Create and return a buffer with a name based on NAME.
1330 Choose the buffer's name using `generate-new-buffer-name'."
1331 (get-buffer-create (generate-new-buffer-name name)))
1333 (defcustom automount-dir-prefix "^/tmp_mnt/"
1334 "Regexp to match the automounter prefix in a directory name."
1338 (defvar abbreviated-home-dir nil
1339 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1341 (defun abbreviate-file-name (filename)
1342 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1343 This also substitutes \"~\" for the user's home directory (unless the
1344 home directory is a root directory) and removes automounter prefixes
1345 \(see the variable `automount-dir-prefix')."
1346 ;; Get rid of the prefixes added by the automounter.
1348 (if (and automount-dir-prefix
1349 (string-match automount-dir-prefix filename)
1350 (file-exists-p (file-name-directory
1351 (substring filename (1- (match-end 0))))))
1352 (setq filename (substring filename (1- (match-end 0)))))
1353 (let ((tail directory-abbrev-alist))
1354 ;; If any elt of directory-abbrev-alist matches this name,
1355 ;; abbreviate accordingly.
1357 (if (string-match (car (car tail)) filename)
1359 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1360 (setq tail (cdr tail)))
1361 ;; Compute and save the abbreviated homedir name.
1362 ;; We defer computing this until the first time it's needed, to
1363 ;; give time for directory-abbrev-alist to be set properly.
1364 ;; We include a slash at the end, to avoid spurious matches
1365 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1366 (or abbreviated-home-dir
1367 (setq abbreviated-home-dir
1368 (let ((abbreviated-home-dir "$foo"))
1369 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1372 ;; If FILENAME starts with the abbreviated homedir,
1373 ;; make it start with `~' instead.
1374 (if (and (string-match abbreviated-home-dir filename)
1375 ;; If the home dir is just /, don't change it.
1376 (not (and (= (match-end 0) 1)
1377 (= (aref filename 0) ?/)))
1378 ;; MS-DOS root directories can come with a drive letter;
1379 ;; Novell Netware allows drive letters beyond `Z:'.
1380 (not (and (or (eq system-type 'ms-dos)
1381 (eq system-type 'cygwin)
1382 (eq system-type 'windows-nt))
1384 (string-match "^[a-zA-`]:/$" filename)))))
1387 (match-string 1 filename)
1388 (substring filename (match-end 0)))))
1391 (defcustom find-file-not-true-dirname-list nil
1392 "List of logical names for which visiting shouldn't save the true dirname.
1393 On VMS, when you visit a file using a logical name that searches a path,
1394 you may or may not want the visited file name to record the specific
1395 directory where the file was found. If you *do not* want that, add the logical
1396 name to this list as a string."
1397 :type '(repeat (string :tag "Name"))
1400 (defun find-buffer-visiting (filename &optional predicate)
1401 "Return the buffer visiting file FILENAME (a string).
1402 This is like `get-file-buffer', except that it checks for any buffer
1403 visiting the same file, possibly under a different name.
1404 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1405 and others are ignored.
1406 If there is no such live buffer, return nil."
1407 (let ((predicate (or predicate #'identity))
1408 (truename (abbreviate-file-name (file-truename filename))))
1409 (or (let ((buf (get-file-buffer filename)))
1410 (when (and buf (funcall predicate buf)) buf))
1411 (let ((list (buffer-list)) found)
1412 (while (and (not found) list)
1414 (set-buffer (car list))
1415 (if (and buffer-file-name
1416 (string= buffer-file-truename truename)
1417 (funcall predicate (current-buffer)))
1418 (setq found (car list))))
1419 (setq list (cdr list)))
1421 (let* ((attributes (file-attributes truename))
1422 (number (nthcdr 10 attributes))
1423 (list (buffer-list)) found)
1424 (and buffer-file-numbers-unique
1425 (car-safe number) ;Make sure the inode is not just nil.
1426 (while (and (not found) list)
1427 (with-current-buffer (car list)
1428 (if (and buffer-file-name
1429 (equal buffer-file-number number)
1430 ;; Verify this buffer's file number
1431 ;; still belongs to its file.
1432 (file-exists-p buffer-file-name)
1433 (equal (file-attributes buffer-file-truename)
1435 (funcall predicate (current-buffer)))
1436 (setq found (car list))))
1437 (setq list (cdr list))))
1440 (defcustom find-file-wildcards t
1441 "Non-nil means file-visiting commands should handle wildcards.
1442 For example, if you specify `*.c', that would visit all the files
1443 whose names match the pattern."
1448 (defcustom find-file-suppress-same-file-warnings nil
1449 "Non-nil means suppress warning messages for symlinked files.
1450 When nil, Emacs prints a warning when visiting a file that is already
1451 visited, but with a different name. Setting this option to t
1452 suppresses this warning."
1457 (defcustom large-file-warning-threshold 10000000
1458 "Maximum size of file above which a confirmation is requested.
1459 When nil, never request confirmation."
1463 :type '(choice integer (const :tag "Never request confirmation" nil)))
1465 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1466 "Read file FILENAME into a buffer and return the buffer.
1467 If a buffer exists visiting FILENAME, return that one, but
1468 verify that the file has not changed since visited or saved.
1469 The buffer is not selected, just returned to the caller.
1470 Optional second arg NOWARN non-nil means suppress any warning messages.
1471 Optional third arg RAWFILE non-nil means the file is read literally.
1472 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1473 and visit all the matching files. When wildcards are actually
1474 used and expanded, return a list of buffers that are visiting
1477 (abbreviate-file-name
1478 (expand-file-name filename)))
1479 (if (file-directory-p filename)
1480 (or (and find-file-run-dired
1481 (run-hook-with-args-until-success
1482 'find-directory-functions
1483 (if find-file-visit-truename
1484 (abbreviate-file-name (file-truename filename))
1486 (error "%s is a directory" filename))
1489 (not (string-match "\\`/:" filename))
1490 (string-match "[[*?]" filename))
1491 (let ((files (condition-case nil
1492 (file-expand-wildcards filename t)
1493 (error (list filename))))
1494 (find-file-wildcards nil))
1496 (find-file-noselect filename)
1497 (mapcar #'find-file-noselect files)))
1498 (let* ((buf (get-file-buffer filename))
1499 (truename (abbreviate-file-name (file-truename filename)))
1500 (attributes (file-attributes truename))
1501 (number (nthcdr 10 attributes))
1502 ;; Find any buffer for a file which has same truename.
1503 (other (and (not buf) (find-buffer-visiting filename))))
1504 ;; Let user know if there is a buffer with the same truename.
1508 find-file-suppress-same-file-warnings
1509 (string-equal filename (buffer-file-name other))
1510 (message "%s and %s are the same file"
1511 filename (buffer-file-name other)))
1512 ;; Optionally also find that buffer.
1513 (if (or find-file-existing-other-name find-file-visit-truename)
1515 ;; Check to see if the file looks uncommonly large.
1516 (when (and large-file-warning-threshold (nth 7 attributes)
1517 ;; Don't ask again if we already have the file or
1518 ;; if we're asked to be quiet.
1519 (not (or buf nowarn))
1520 (> (nth 7 attributes) large-file-warning-threshold)
1522 (format "File %s is large (%dMB), really open? "
1523 (file-name-nondirectory filename)
1524 (/ (nth 7 attributes) 1048576)))))
1527 ;; We are using an existing buffer.
1530 (verify-visited-file-modtime buf)
1531 (cond ((not (file-exists-p filename))
1532 (setq nonexistent t)
1533 (message "File %s no longer exists!" filename))
1534 ;; Certain files should be reverted automatically
1535 ;; if they have changed on disk and not in the buffer.
1536 ((and (not (buffer-modified-p buf))
1537 (let ((tail revert-without-query)
1540 (if (string-match (car tail) filename)
1542 (setq tail (cdr tail)))
1544 (with-current-buffer buf
1545 (message "Reverting file %s..." filename)
1547 (message "Reverting file %s...done" filename)))
1549 (if (string= (file-name-nondirectory filename)
1552 (if (buffer-modified-p buf)
1553 "File %s changed on disk. Discard your edits? "
1554 "File %s changed on disk. Reread from disk? ")
1555 (file-name-nondirectory filename))
1557 (if (buffer-modified-p buf)
1558 "File %s changed on disk. Discard your edits in %s? "
1559 "File %s changed on disk. Reread from disk into %s? ")
1560 (file-name-nondirectory filename)
1561 (buffer-name buf))))
1562 (with-current-buffer buf
1563 (revert-buffer t t)))))
1564 (with-current-buffer buf
1566 ;; Check if a formerly read-only file has become
1567 ;; writable and vice versa, but if the buffer agrees
1568 ;; with the new state of the file, that is ok too.
1569 (let ((read-only (not (file-writable-p buffer-file-name))))
1570 (unless (or nonexistent
1571 (eq read-only buffer-file-read-only)
1572 (eq read-only buffer-read-only))
1575 (format "File %s is %s on disk. Change buffer mode? "
1577 (if read-only "read-only" "writable"))))
1578 (y-or-n-p question)))
1579 (setq buffer-read-only read-only)))
1580 (setq buffer-file-read-only read-only))
1582 (when (and (not (eq (not (null rawfile))
1583 (not (null find-file-literally))))
1585 ;; It is confusing to ask whether to visit
1586 ;; non-literally if they have the file in
1588 (not (eq major-mode 'hexl-mode)))
1589 (if (buffer-modified-p)
1593 "The file %s is already visited normally,
1594 and you have edited the buffer. Now you have asked to visit it literally,
1595 meaning no coding system handling, format conversion, or local variables.
1596 Emacs can only visit a file in one way at a time.
1598 Do you want to save the file, and visit it literally instead? "
1599 "The file %s is already visited literally,
1600 meaning no coding system handling, format conversion, or local variables.
1601 You have edited the buffer. Now you have asked to visit the file normally,
1602 but Emacs can only visit a file in one way at a time.
1604 Do you want to save the file, and visit it normally instead? ")
1605 (file-name-nondirectory filename)))
1608 (find-file-noselect-1 buf filename nowarn
1609 rawfile truename number))
1614 Do you want to discard your changes, and visit the file literally now? "
1616 Do you want to discard your changes, and visit the file normally now? ")))
1617 (find-file-noselect-1 buf filename nowarn
1618 rawfile truename number)
1619 (error (if rawfile "File already visited non-literally"
1620 "File already visited literally"))))
1624 "The file %s is already visited normally.
1625 You have asked to visit it literally,
1626 meaning no coding system decoding, format conversion, or local variables.
1627 But Emacs can only visit a file in one way at a time.
1629 Do you want to revisit the file literally now? "
1630 "The file %s is already visited literally,
1631 meaning no coding system decoding, format conversion, or local variables.
1632 You have asked to visit it normally,
1633 but Emacs can only visit a file in one way at a time.
1635 Do you want to revisit the file normally now? ")
1636 (file-name-nondirectory filename)))
1637 (find-file-noselect-1 buf filename nowarn
1638 rawfile truename number)
1639 (error (if rawfile "File already visited non-literally"
1640 "File already visited literally"))))))
1641 ;; Return the buffer we are using.
1643 ;; Create a new buffer.
1644 (setq buf (create-file-buffer filename))
1645 ;; find-file-noselect-1 may use a different buffer.
1646 (find-file-noselect-1 buf filename nowarn
1647 rawfile truename number))))))
1649 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1651 (with-current-buffer buf
1652 (kill-local-variable 'find-file-literally)
1653 ;; Needed in case we are re-visiting the file with a different
1654 ;; text representation.
1655 (kill-local-variable 'buffer-file-coding-system)
1656 (kill-local-variable 'cursor-type)
1657 (let ((inhibit-read-only t))
1659 (and (default-value 'enable-multibyte-characters)
1661 (set-buffer-multibyte t))
1664 (let ((inhibit-read-only t))
1665 (insert-file-contents-literally filename t))
1667 (when (and (file-exists-p filename)
1668 (not (file-readable-p filename)))
1670 (signal 'file-error (list "File is not readable"
1672 ;; Unconditionally set error
1675 (let ((inhibit-read-only t))
1676 (insert-file-contents filename t))
1678 (when (and (file-exists-p filename)
1679 (not (file-readable-p filename)))
1681 (signal 'file-error (list "File is not readable"
1683 ;; Run find-file-not-found-functions until one returns non-nil.
1684 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1685 ;; If they fail too, set error.
1687 ;; Record the file's truename, and maybe use that as visited name.
1688 (if (equal filename buffer-file-name)
1689 (setq buffer-file-truename truename)
1690 (setq buffer-file-truename
1691 (abbreviate-file-name (file-truename buffer-file-name))))
1692 (setq buffer-file-number number)
1693 ;; On VMS, we may want to remember which directory in a search list
1694 ;; the file was found in.
1695 (and (eq system-type 'vax-vms)
1697 (if (string-match ":" (file-name-directory filename))
1698 (setq logical (substring (file-name-directory filename)
1699 0 (match-beginning 0))))
1700 (not (member logical find-file-not-true-dirname-list)))
1701 (setq buffer-file-name buffer-file-truename))
1702 (if find-file-visit-truename
1703 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1704 ;; Set buffer's default directory to that of the file.
1705 (setq default-directory (file-name-directory buffer-file-name))
1706 ;; Turn off backup files for certain file names. Since
1707 ;; this is a permanent local, the major mode won't eliminate it.
1708 (and backup-enable-predicate
1709 (not (funcall backup-enable-predicate buffer-file-name))
1711 (make-local-variable 'backup-inhibited)
1712 (setq backup-inhibited t)))
1715 (set-buffer-multibyte nil)
1716 (setq buffer-file-coding-system 'no-conversion)
1717 (set-buffer-major-mode buf)
1718 (make-local-variable 'find-file-literally)
1719 (setq find-file-literally t))
1720 (after-find-file error (not nowarn)))
1723 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1724 "Like `insert-file-contents', but only reads in the file literally.
1725 A buffer may be modified in several ways after reading into the buffer,
1726 to Emacs features such as format decoding, character code
1727 conversion, `find-file-hook', automatic uncompression, etc.
1729 This function ensures that none of these modifications will take place."
1730 (let ((format-alist nil)
1731 (after-insert-file-functions nil)
1732 (coding-system-for-read 'no-conversion)
1733 (coding-system-for-write 'no-conversion)
1734 (find-buffer-file-type-function
1735 (if (fboundp 'find-buffer-file-type)
1736 (symbol-function 'find-buffer-file-type)
1738 (inhibit-file-name-handlers
1739 (append '(jka-compr-handler image-file-handler)
1740 inhibit-file-name-handlers))
1741 (inhibit-file-name-operation 'insert-file-contents))
1744 (fset 'find-buffer-file-type (lambda (filename) t))
1745 (insert-file-contents filename visit beg end replace))
1746 (if find-buffer-file-type-function
1747 (fset 'find-buffer-file-type find-buffer-file-type-function)
1748 (fmakunbound 'find-buffer-file-type)))))
1750 (defun insert-file-1 (filename insert-func)
1751 (if (file-directory-p filename)
1752 (signal 'file-error (list "Opening input file" "file is a directory"
1754 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1755 #'buffer-modified-p))
1756 (tem (funcall insert-func filename)))
1757 (push-mark (+ (point) (car (cdr tem))))
1759 (message "File %s already visited and modified in buffer %s"
1760 filename (buffer-name buffer)))))
1762 (defun insert-file-literally (filename)
1763 "Insert contents of file FILENAME into buffer after point with no conversion.
1765 This function is meant for the user to run interactively.
1766 Don't call it from programs! Use `insert-file-contents-literally' instead.
1767 \(Its calling sequence is different; see its documentation)."
1768 (interactive "*fInsert file literally: ")
1769 (insert-file-1 filename #'insert-file-contents-literally))
1771 (defvar find-file-literally nil
1772 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1773 This is a permanent local.")
1774 (put 'find-file-literally 'permanent-local t)
1776 (defun find-file-literally (filename)
1777 "Visit file FILENAME with no conversion of any kind.
1778 Format conversion and character code conversion are both disabled,
1779 and multibyte characters are disabled in the resulting buffer.
1780 The major mode used is Fundamental mode regardless of the file name,
1781 and local variable specifications in the file are ignored.
1782 Automatic uncompression and adding a newline at the end of the
1783 file due to `require-final-newline' is also disabled.
1785 You cannot absolutely rely on this function to result in
1786 visiting the file literally. If Emacs already has a buffer
1787 which is visiting the file, you get the existing buffer,
1788 regardless of whether it was created literally or not.
1790 In a Lisp program, if you want to be sure of accessing a file's
1791 contents literally, you should create a temporary buffer and then read
1792 the file contents into it using `insert-file-contents-literally'."
1793 (interactive "FFind file literally: ")
1794 (switch-to-buffer (find-file-noselect filename nil t)))
1796 (defvar after-find-file-from-revert-buffer nil)
1798 (defun after-find-file (&optional error warn noauto
1799 after-find-file-from-revert-buffer
1801 "Called after finding a file and by the default revert function.
1802 Sets buffer mode, parses local variables.
1803 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1804 error in reading the file. WARN non-nil means warn if there
1805 exists an auto-save file more recent than the visited file.
1806 NOAUTO means don't mess with auto-save mode.
1807 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1808 means this call was from `revert-buffer'.
1809 Fifth arg NOMODES non-nil means don't alter the file's modes.
1810 Finishes by calling the functions in `find-file-hook'
1811 unless NOMODES is non-nil."
1812 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1819 ((and error (file-attributes buffer-file-name))
1820 (setq buffer-read-only t)
1821 "File exists, but cannot be read")
1822 ((not buffer-read-only)
1824 ;; No need to warn if buffer is auto-saved
1825 ;; under the name of the visited file.
1826 (not (and buffer-file-name
1827 auto-save-visited-file-name))
1828 (file-newer-than-file-p (or buffer-auto-save-file-name
1829 (make-auto-save-file-name))
1831 (format "%s has auto save data; consider M-x recover-this-file"
1832 (file-name-nondirectory buffer-file-name))
1833 (setq not-serious t)
1834 (if error "(New file)" nil)))
1836 (setq not-serious t)
1837 "Note: file is write protected")
1838 ((file-attributes (directory-file-name default-directory))
1839 "File not found and directory write-protected")
1840 ((file-exists-p (file-name-directory buffer-file-name))
1841 (setq buffer-read-only nil))
1843 (setq buffer-read-only nil)
1844 "Use M-x make-directory RET RET to create the directory and its parents"))))
1847 (or not-serious (sit-for 1 t))))
1848 (when (and auto-save-default (not noauto))
1849 (auto-save-mode t)))
1850 ;; Make people do a little extra work (C-x C-q)
1851 ;; before altering a backup file.
1852 (when (backup-file-name-p buffer-file-name)
1853 (setq buffer-read-only t))
1854 ;; When a file is marked read-only,
1855 ;; make the buffer read-only even if root is looking at it.
1856 (when (and (file-modes (buffer-file-name))
1857 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1858 (setq buffer-read-only t))
1860 (when (and view-read-only view-mode)
1861 (view-mode-disable))
1863 ;; If requested, add a newline at the end of the file.
1864 (and (memq require-final-newline '(visit visit-save))
1865 (> (point-max) (point-min))
1866 (/= (char-after (1- (point-max))) ?\n)
1867 (not (and (eq selective-display t)
1868 (= (char-after (1- (point-max))) ?\r)))
1870 (goto-char (point-max))
1872 (when (and buffer-read-only
1874 (not (eq (get major-mode 'mode-class) 'special)))
1876 (run-hooks 'find-file-hook)))
1878 (defmacro report-errors (format &rest body)
1879 "Eval BODY and turn any error into a FORMAT message.
1880 FORMAT can have a %s escape which will be replaced with the actual error.
1881 If `debug-on-error' is set, errors are not caught, so that you can
1883 Avoid using a large BODY since it is duplicated."
1884 (declare (debug t) (indent 1))
1889 (error (message ,format (prin1-to-string err))))))
1891 (defun normal-mode (&optional find-file)
1892 "Choose the major mode for this buffer automatically.
1893 Also sets up any specified local variables of the file.
1894 Uses the visited file name, the -*- line, and the local variables spec.
1896 This function is called automatically from `find-file'. In that case,
1897 we may set up the file-specified mode and local variables,
1898 depending on the value of `enable-local-variables'.
1899 In addition, if `local-enable-local-variables' is nil, we do
1900 not set local variables (though we do notice a mode specified with -*-.)
1902 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1903 or from Lisp without specifying the optional argument FIND-FILE;
1904 in that case, this function acts as if `enable-local-variables' were t."
1906 (funcall (or default-major-mode 'fundamental-mode))
1907 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1908 (report-errors "File mode specification error: %s"
1910 (report-errors "File local-variables error: %s"
1911 (hack-local-variables)))
1912 ;; Turn font lock off and on, to make sure it takes account of
1913 ;; whatever file local variables are relevant to it.
1914 (when (and font-lock-mode
1915 ;; Font-lock-mode (now in font-core.el) can be ON when
1916 ;; font-lock.el still hasn't been loaded.
1917 (boundp 'font-lock-keywords)
1918 (eq (car font-lock-keywords) t))
1919 (setq font-lock-keywords (cadr font-lock-keywords))
1922 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1923 (ucs-set-table-for-input)))
1925 (defcustom auto-mode-case-fold nil
1926 "Non-nil means to try second pass through `auto-mode-alist'.
1927 This means that if the first case-sensitive search through the alist fails
1928 to find a matching major mode, a second case-insensitive search is made.
1929 On systems with case-insensitive file names, this variable is ignored,
1930 since only a single case-insensitive search through the alist is made."
1935 (defvar auto-mode-alist
1936 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1937 ;; c++-mode, java-mode and more) are added through autoload
1938 ;; directives in that file. That way is discouraged since it
1939 ;; spreads out the definition of the initial value.
1942 (cons (purecopy (car elt)) (cdr elt)))
1943 `(;; do this first, so that .html.pl is Polish html, not Perl
1944 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1945 ("\\.te?xt\\'" . text-mode)
1946 ("\\.[tT]e[xX]\\'" . tex-mode)
1947 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1948 ("\\.ltx\\'" . latex-mode)
1949 ("\\.dtx\\'" . doctex-mode)
1950 ("\\.el\\'" . emacs-lisp-mode)
1951 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
1952 ("\\.l\\'" . lisp-mode)
1953 ("\\.li?sp\\'" . lisp-mode)
1954 ("\\.[fF]\\'" . fortran-mode)
1955 ("\\.for\\'" . fortran-mode)
1956 ("\\.p\\'" . pascal-mode)
1957 ("\\.pas\\'" . pascal-mode)
1958 ("\\.ad[abs]\\'" . ada-mode)
1959 ("\\.ad[bs].dg\\'" . ada-mode)
1960 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
1961 ("Imakefile\\'" . makefile-imake-mode)
1962 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
1963 ("\\.makepp\\'" . makefile-makepp-mode)
1964 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
1965 '(("\\.mk\\'" . makefile-bsdmake-mode)
1966 ("GNUmakefile\\'" . makefile-gmake-mode)
1967 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
1968 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
1969 ("[Mm]akefile\\'" . makefile-gmake-mode)))
1970 ("\\.am\\'" . makefile-automake-mode)
1971 ;; Less common extensions come here
1972 ;; so more common ones above are found faster.
1973 ("\\.texinfo\\'" . texinfo-mode)
1974 ("\\.te?xi\\'" . texinfo-mode)
1975 ("\\.[sS]\\'" . asm-mode)
1976 ("\\.asm\\'" . asm-mode)
1977 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
1978 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
1979 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1980 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1981 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1982 ("\\.bash\\'" . sh-mode)
1983 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1984 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1985 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1986 ("\\.m?spec\\'" . sh-mode)
1987 ("\\.m[mes]\\'" . nroff-mode)
1988 ("\\.man\\'" . nroff-mode)
1989 ("\\.sty\\'" . latex-mode)
1990 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
1991 ("\\.bbl\\'" . latex-mode)
1992 ("\\.bib\\'" . bibtex-mode)
1993 ("\\.sql\\'" . sql-mode)
1994 ("\\.m[4c]\\'" . m4-mode)
1995 ("\\.mf\\'" . metafont-mode)
1996 ("\\.mp\\'" . metapost-mode)
1997 ("\\.vhdl?\\'" . vhdl-mode)
1998 ("\\.article\\'" . text-mode)
1999 ("\\.letter\\'" . text-mode)
2000 ("\\.i?tcl\\'" . tcl-mode)
2001 ("\\.exp\\'" . tcl-mode)
2002 ("\\.itk\\'" . tcl-mode)
2003 ("\\.icn\\'" . icon-mode)
2004 ("\\.sim\\'" . simula-mode)
2005 ("\\.mss\\'" . scribe-mode)
2006 ("\\.f9[05]\\'" . f90-mode)
2007 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2008 ("\\.pro\\'" . idlwave-mode)
2009 ("\\.prolog\\'" . prolog-mode)
2010 ("\\.tar\\'" . tar-mode)
2011 ;; The list of archive file extensions should be in sync with
2012 ;; `auto-coding-alist' with `no-conversion' coding system.
2013 ("\\.\\(arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\)\\'" . archive-mode)
2014 ("\\.\\(ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\)\\'" . archive-mode)
2015 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
2016 ;; Mailer puts message to be edited in
2017 ;; /tmp/Re.... or Message
2018 ("\\`/tmp/Re" . text-mode)
2019 ("/Message[0-9]*\\'" . text-mode)
2020 ("\\.zone\\'" . zone-mode)
2021 ;; some news reader is reported to use this
2022 ("\\`/tmp/fol/" . text-mode)
2023 ("\\.oak\\'" . scheme-mode)
2024 ("\\.sgml?\\'" . sgml-mode)
2025 ("\\.x[ms]l\\'" . xml-mode)
2026 ("\\.dtd\\'" . sgml-mode)
2027 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2028 ("\\.js\\'" . java-mode) ; javascript-mode would be better
2029 ("\\.x[bp]m\\'" . c-mode)
2030 ;; .emacs or .gnus or .viper following a directory delimiter in
2031 ;; Unix, MSDOG or VMS syntax.
2032 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2033 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2034 ;; _emacs following a directory delimiter
2036 ("[:/]_emacs\\'" . emacs-lisp-mode)
2037 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2038 ("\\.ml\\'" . lisp-mode)
2039 ;; Common Lisp ASDF package system.
2040 ("\\.asd\\'" . lisp-mode)
2041 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2042 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2043 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2044 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2045 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2046 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2047 ("BROWSE\\'" . ebrowse-tree-mode)
2048 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2049 ("#\\*mail\\*" . mail-mode)
2050 ("\\.g\\'" . antlr-mode)
2051 ("\\.ses\\'" . ses-mode)
2052 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2053 ("\\.docbook\\'" . sgml-mode)
2054 ("\\.com\\'" . dcl-mode)
2055 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2056 ;; Windows candidates may be opened case sensitively on Unix
2057 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2058 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2059 ("\\.ppd\\'" . conf-ppd-mode)
2060 ("java.+\\.conf\\'" . conf-javaprop-mode)
2061 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2062 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2063 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
2064 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2065 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2066 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2067 ;; this has lower priority to avoid matching changelog.sgml etc.
2068 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2069 ;; either user's dot-files or under /etc or some such
2070 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2071 ;; alas not all ~/.*rc files are like this
2072 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2073 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2074 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2075 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2076 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2077 ;; this contains everything twice, with space and with colon :-(
2078 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2079 ;; Get rid of any trailing .n.m and try again.
2080 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2081 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2082 ;; Using mode nil rather than `ignore' would let the search continue
2083 ;; through this list (with the shortened name) rather than start over.
2084 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2085 ;; The following should come after the ChangeLog pattern
2086 ;; for the sake of ChangeLog.1, etc.
2087 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2088 ("\\.[1-9]\\'" . nroff-mode)
2089 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2090 "Alist of filename patterns vs corresponding major mode functions.
2091 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2092 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2093 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2094 mode function to use. FUNCTION will be called, unless it is nil.
2096 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2097 calling FUNCTION (if it's not nil), we delete the suffix that matched
2098 REGEXP and search the list again for another match.
2100 If the file name matches `inhibit-first-line-modes-regexps',
2101 then `auto-mode-alist' is not processed.
2103 The extensions whose FUNCTION is `archive-mode' should also
2104 appear in `auto-coding-alist' with `no-conversion' coding system.
2106 See also `interpreter-mode-alist', which detects executable script modes
2107 based on the interpreters they specify to run,
2108 and `magic-mode-alist', which determines modes based on file contents.")
2110 (defvar interpreter-mode-alist
2111 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2112 ;; and pike-mode) are added through autoload directives in that
2113 ;; file. That way is discouraged since it spreads out the
2114 ;; definition of the initial value.
2117 (cons (purecopy (car l)) (cdr l)))
2118 '(("perl" . perl-mode)
2119 ("perl5" . perl-mode)
2120 ("miniperl" . perl-mode)
2122 ("wishx" . tcl-mode)
2124 ("tclsh" . tcl-mode)
2125 ("scm" . scheme-mode)
2145 ("tail" . text-mode)
2146 ("more" . text-mode)
2147 ("less" . text-mode)
2149 ("make" . makefile-gmake-mode) ; Debian uses this
2150 ("guile" . scheme-mode)
2151 ("clisp" . lisp-mode)))
2152 "Alist mapping interpreter names to major modes.
2153 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2154 Each element looks like (INTERPRETER . MODE).
2155 If INTERPRETER matches the name of the interpreter specified in the first line
2156 of a script, mode MODE is enabled.
2158 See also `auto-mode-alist'.")
2160 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2161 "List of regexps; if one matches a file name, don't look for `-*-'.")
2163 (defvar inhibit-first-line-modes-suffixes nil
2164 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2165 When checking `inhibit-first-line-modes-regexps', we first discard
2166 from the end of the file name anything that matches one of these regexps.")
2168 (defvar auto-mode-interpreter-regexp
2169 "#![ \t]?\\([^ \t\n]*\
2170 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2171 "Regexp matching interpreters, for file mode determination.
2172 This regular expression is matched against the first line of a file
2173 to determine the file's mode in `set-auto-mode'. If it matches, the file
2174 is assumed to be interpreted by the interpreter matched by the second group
2175 of the regular expression. The mode is then determined as the mode
2176 associated with that interpreter in `interpreter-mode-alist'.")
2178 (defvar magic-mode-alist nil
2179 "Alist of buffer beginnings vs. corresponding major mode functions.
2180 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2181 After visiting a file, if REGEXP matches the text at the beginning of the
2182 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2183 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2186 If FUNCTION is nil, then it is not called. (That is a way of saying
2187 \"allow `auto-mode-alist' to decide for these files.\")")
2188 (put 'magic-mode-alist 'risky-local-variable t)
2190 (defvar magic-fallback-mode-alist
2191 `((image-type-auto-detected-p . image-mode)
2192 ;; The < comes before the groups (but the first) to reduce backtracking.
2193 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2194 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2195 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2196 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2197 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2199 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2200 "[Hh][Tt][Mm][Ll]"))
2202 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2203 ;; These two must come after html, because they are more general:
2204 ("<\\?xml " . xml-mode)
2205 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2206 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2207 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2210 ("# xmcd " . conf-unix-mode))
2211 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2212 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2213 After visiting a file, if REGEXP matches the text at the beginning of the
2214 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2215 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2216 have not specified a mode for this file.
2218 If FUNCTION is nil, then it is not called.")
2219 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2221 (defvar magic-mode-regexp-match-limit 4000
2222 "Upper limit on `magic-mode-alist' regexp matches.
2223 Also applies to `magic-fallback-mode-alist'.")
2225 (defun set-auto-mode (&optional keep-mode-if-same)
2226 "Select major mode appropriate for current buffer.
2228 To find the right major mode, this function checks for a -*- mode tag,
2229 checks if it uses an interpreter listed in `interpreter-mode-alist',
2230 matches the buffer beginning against `magic-mode-alist',
2231 compares the filename against the entries in `auto-mode-alist',
2232 then matches the buffer beginning against `magic-fallback-mode-alist'.
2234 It does not check for the `mode:' local variable in the
2235 Local Variables section of the file; for that, use `hack-local-variables'.
2237 If `enable-local-variables' is nil, this function does not check for a
2240 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2241 set the major mode only if that would change it. In other words
2242 we don't actually set it to the same mode the buffer already has."
2243 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2244 (let (end done mode modes)
2245 ;; Find a -*- mode tag
2247 (goto-char (point-min))
2248 (skip-chars-forward " \t\n")
2249 (and enable-local-variables
2250 (setq end (set-auto-mode-1))
2251 (if (save-excursion (search-forward ":" end t))
2252 ;; Find all specifications for the `mode:' variable
2253 ;; and execute them left to right.
2254 (while (let ((case-fold-search t))
2255 (or (and (looking-at "mode:")
2256 (goto-char (match-end 0)))
2257 (re-search-forward "[ \t;]mode:" end t)))
2258 (skip-chars-forward " \t")
2259 (let ((beg (point)))
2260 (if (search-forward ";" end t)
2263 (skip-chars-backward " \t")
2264 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2266 ;; Simple -*-MODE-*- case.
2267 (push (intern (concat (downcase (buffer-substring (point) end))
2270 ;; If we found modes to use, invoke them now, outside the save-excursion.
2273 (dolist (mode (nreverse modes))
2274 (if (not (functionp mode))
2275 (message "Ignoring unknown mode `%s'" mode)
2277 (or (set-auto-mode-0 mode keep-mode-if-same)
2278 ;; continuing would call minor modes again, toggling them off
2279 (throw 'nop nil))))))
2280 ;; If we didn't, look for an interpreter specified in the first line.
2281 ;; As a special case, allow for things like "#!/bin/env perl", which
2282 ;; finds the interpreter anywhere in $PATH.
2284 (setq mode (save-excursion
2285 (goto-char (point-min))
2286 (if (looking-at auto-mode-interpreter-regexp)
2289 ;; Map interpreter name to a mode, signalling we're done at the
2291 done (assoc (file-name-nondirectory mode)
2292 interpreter-mode-alist))
2293 ;; If we found an interpreter mode to use, invoke it now.
2295 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2296 ;; Next try matching the buffer beginning against magic-mode-alist.
2298 (if (setq done (save-excursion
2299 (goto-char (point-min))
2301 (narrow-to-region (point-min)
2303 (+ (point-min) magic-mode-regexp-match-limit)))
2304 (assoc-default nil magic-mode-alist
2308 (looking-at re)))))))
2309 (set-auto-mode-0 done keep-mode-if-same)))
2310 ;; Next compare the filename against the entries in auto-mode-alist.
2312 (if buffer-file-name
2313 (let ((name buffer-file-name))
2314 ;; Remove backup-suffixes from file name.
2315 (setq name (file-name-sans-versions name))
2317 ;; Find first matching alist entry.
2319 (if (memq system-type '(vax-vms windows-nt cygwin))
2320 ;; System is case-insensitive.
2321 (let ((case-fold-search t))
2322 (assoc-default name auto-mode-alist
2324 ;; System is case-sensitive.
2326 ;; First match case-sensitively.
2327 (let ((case-fold-search nil))
2328 (assoc-default name auto-mode-alist
2330 ;; Fallback to case-insensitive match.
2331 (and auto-mode-case-fold
2332 (let ((case-fold-search t))
2333 (assoc-default name auto-mode-alist
2338 (setq mode (car mode)
2339 name (substring name 0 (match-beginning 0)))
2342 (set-auto-mode-0 mode keep-mode-if-same)
2344 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2346 (if (setq done (save-excursion
2347 (goto-char (point-min))
2349 (narrow-to-region (point-min)
2351 (+ (point-min) magic-mode-regexp-match-limit)))
2352 (assoc-default nil magic-fallback-mode-alist
2356 (looking-at re)))))))
2357 (set-auto-mode-0 done keep-mode-if-same)))))
2359 ;; When `keep-mode-if-same' is set, we are working on behalf of
2360 ;; set-visited-file-name. In that case, if the major mode specified is the
2361 ;; same one we already have, don't actually reset it. We don't want to lose
2362 ;; minor modes such as Font Lock.
2363 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2364 "Apply MODE and return it.
2365 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2366 any aliases and compared to current major mode. If they are the
2367 same, do nothing and return nil."
2368 (unless (and keep-mode-if-same
2369 (eq (indirect-function mode)
2370 (indirect-function major-mode)))
2375 (defun set-auto-mode-1 ()
2376 "Find the -*- spec in the buffer.
2377 Call with point at the place to start searching from.
2378 If one is found, set point to the beginning
2379 and return the position of the end.
2380 Otherwise, return nil; point may be changed."
2383 ;; Don't look for -*- if this file name matches any
2384 ;; of the regexps in inhibit-first-line-modes-regexps.
2385 (let ((temp inhibit-first-line-modes-regexps)
2386 (name (if buffer-file-name
2387 (file-name-sans-versions buffer-file-name)
2389 (while (let ((sufs inhibit-first-line-modes-suffixes))
2390 (while (and sufs (not (string-match (car sufs) name)))
2391 (setq sufs (cdr sufs)))
2393 (setq name (substring name 0 (match-beginning 0))))
2395 (not (string-match (car temp) name)))
2396 (setq temp (cdr temp)))
2399 (search-forward "-*-" (line-end-position
2400 ;; If the file begins with "#!"
2401 ;; (exec interpreter magic), look
2402 ;; for mode frobs in the first two
2403 ;; lines. You cannot necessarily
2404 ;; put them in the first line of
2405 ;; such a file without screwing up
2406 ;; the interpreter invocation.
2407 (and (looking-at "^#!") 2)) t)
2409 (skip-chars-forward " \t")
2411 (search-forward "-*-" (line-end-position) t))
2414 (skip-chars-backward " \t")
2419 ;;; Handling file local variables
2421 (defvar ignored-local-variables
2422 '(ignored-local-variables safe-local-variable-values)
2423 "Variables to be ignored in a file's local variable spec.")
2425 (defvar hack-local-variables-hook nil
2426 "Normal hook run after processing a file's local variables specs.
2427 Major modes can use this to examine user-specified local variables
2428 in order to initialize other data structure based on them.")
2430 (defcustom safe-local-variable-values nil
2431 "List variable-value pairs that are considered safe.
2432 Each element is a cons cell (VAR . VAL), where VAR is a variable
2433 symbol and VAL is a value that is considered safe."
2437 (defcustom safe-local-eval-forms nil
2438 "Expressions that are considered safe in an `eval:' local variable.
2439 Add expressions to this list if you want Emacs to evaluate them, when
2440 they appear in an `eval' local variable specification, without first
2441 asking you for confirmation."
2444 :type '(repeat sexp))
2446 ;; Risky local variables:
2447 (mapc (lambda (var) (put var 'risky-local-variable t))
2450 buffer-auto-save-file-name
2452 buffer-file-truename
2454 dabbrev-case-fold-search
2455 dabbrev-case-replace
2457 default-text-properties
2460 enable-local-variables
2464 file-name-handler-alist
2471 ignored-local-variables
2473 imenu-generic-expression
2480 minor-mode-map-alist
2481 minor-mode-overriding-map-alist
2482 mode-line-buffer-identification
2492 overriding-local-map
2493 overriding-terminal-local-map
2496 rmail-output-file-alist
2497 safe-local-variable-values
2498 safe-local-eval-forms
2499 save-some-buffers-action-alist
2500 special-display-buffer-names
2503 unread-command-events
2506 ;; Safe local variables:
2508 ;; For variables defined by major modes, the safety declarations can go into
2509 ;; the major mode's file, since that will be loaded before file variables are
2512 ;; For variables defined by minor modes, put the safety declarations in the
2513 ;; file defining the minor mode after the defcustom/defvar using an autoload
2516 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2518 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2519 ;; minor mode file may not be loaded yet.
2521 ;; For variables defined in the C source code the declaration should go here:
2523 (mapc (lambda (pair)
2524 (put (car pair) 'safe-local-variable (cdr pair)))
2525 '((buffer-read-only . booleanp) ;; C source code
2526 (default-directory . stringp) ;; C source code
2527 (fill-column . integerp) ;; C source code
2528 (indent-tabs-mode . booleanp) ;; C source code
2529 (left-margin . integerp) ;; C source code
2530 (no-update-autoloads . booleanp)
2531 (tab-width . integerp) ;; C source code
2532 (truncate-lines . booleanp))) ;; C source code
2534 (put 'c-set-style 'safe-local-eval-function t)
2536 (defun hack-local-variables-confirm (vars unsafe-vars risky-vars)
2539 (let ((name (if buffer-file-name
2540 (file-name-nondirectory buffer-file-name)
2541 (concat "buffer " (buffer-name))))
2542 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2544 (save-window-excursion
2545 (let ((buf (get-buffer-create "*Local Variables*")))
2547 (set (make-local-variable 'cursor-type) nil)
2550 (insert "The local variables list in " name
2551 "\ncontains values that may not be safe (*)"
2553 ", and variables that are risky (**)."
2556 (insert "The local variables list in " name
2557 "\ncontains variables that are risky (**).")
2558 (insert "A local variables list is specified in " name ".")))
2559 (insert "\n\nDo you want to apply it? You can type
2560 y -- to apply the local variables list.
2561 n -- to ignore the local variables list.")
2564 ! -- to apply the local variables list, and permanently mark these
2565 values (*) as safe (in the future, they will be set automatically.)\n\n")
2568 (cond ((member elt unsafe-vars)
2570 ((member elt risky-vars)
2574 (princ (car elt) buf)
2576 ;; Make strings with embedded whitespace easier to read.
2577 (let ((print-escape-newlines t))
2578 (prin1 (cdr elt) buf))
2581 (format "Please type %s%s: "
2582 (if offer-save "y, n, or !" "y or n")
2583 (if (< (line-number-at-pos) (window-body-height))
2585 ", or C-v to scroll")))
2586 (goto-char (point-min))
2587 (let ((cursor-in-echo-area t)
2588 (executing-kbd-macro executing-kbd-macro)
2590 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2594 (setq char (read-event))
2596 (cond ((eq char ?\C-v)
2599 (error (goto-char (point-min)))))
2600 ;; read-event returns -1 if we are in a kbd
2601 ;; macro and there are no more events in the
2602 ;; macro. In that case, attempt to get an
2603 ;; event interactively.
2604 ((and executing-kbd-macro (= char -1))
2605 (setq executing-kbd-macro nil))
2606 (t (setq done (memq (downcase char) exit-chars)))))))
2607 (setq char (downcase char))
2608 (when (and offer-save (= char ?!) unsafe-vars)
2609 (dolist (elt unsafe-vars)
2610 (add-to-list 'safe-local-variable-values elt))
2611 ;; When this is called from desktop-restore-file-buffer,
2612 ;; coding-system-for-read may be non-nil. Reset it before
2613 ;; writing to .emacs.
2614 (if (or custom-file user-init-file)
2615 (let ((coding-system-for-read nil))
2616 (customize-save-variable
2617 'safe-local-variable-values
2618 safe-local-variable-values))))
2624 (defun hack-local-variables-prop-line (&optional mode-only)
2625 "Return local variables specified in the -*- line.
2626 Ignore any specification for `mode:' and `coding:';
2627 `set-auto-mode' should already have handled `mode:',
2628 `set-auto-coding' should already have handled `coding:'.
2630 If MODE-ONLY is non-nil, all we do is check whether the major
2631 mode is specified, returning t if it is specified. Otherwise,
2632 return an alist of elements (VAR . VAL), where VAR is a variable
2633 and VAL is the specified value."
2635 (goto-char (point-min))
2636 (let ((end (set-auto-mode-1))
2637 result mode-specified)
2638 ;; Parse the -*- line into the RESULT alist.
2639 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2642 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2643 ;; Simple form: "-*- MODENAME -*-". Already handled.
2644 (setq mode-specified t)
2647 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2648 ;; (last ";" is optional).
2649 (while (< (point) end)
2650 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2651 (error "Malformed -*- line"))
2652 (goto-char (match-end 0))
2653 ;; There used to be a downcase here,
2654 ;; but the manual didn't say so,
2655 ;; and people want to set var names that aren't all lc.
2656 (let ((key (intern (match-string 1)))
2657 (val (save-restriction
2658 (narrow-to-region (point) end)
2659 (read (current-buffer)))))
2660 ;; It is traditional to ignore
2661 ;; case when checking for `mode' in set-auto-mode,
2662 ;; so we must do that here as well.
2663 ;; That is inconsistent, but we're stuck with it.
2664 ;; The same can be said for `coding' in set-auto-coding.
2665 (or (and (equal (downcase (symbol-name key)) "mode")
2666 (setq mode-specified t))
2667 (equal (downcase (symbol-name key)) "coding")
2669 (push (cons (if (eq key 'eval)
2671 (indirect-variable key))
2674 (skip-chars-forward " \t;")))))
2680 (defun hack-local-variables (&optional mode-only)
2681 "Parse and put into effect this buffer's local variables spec.
2682 If MODE-ONLY is non-nil, all we do is check whether the major mode
2683 is specified, returning t if it is specified."
2684 (let ((enable-local-variables
2685 (and local-enable-local-variables enable-local-variables))
2687 (when (or mode-only enable-local-variables)
2688 (setq result (hack-local-variables-prop-line mode-only))
2689 ;; Look for "Local variables:" line in last page.
2691 (goto-char (point-max))
2692 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2694 (when (let ((case-fold-search t))
2695 (search-forward "Local Variables:" nil t))
2696 (skip-chars-forward " \t")
2697 ;; suffix is what comes after "local variables:" in its line.
2698 ;; prefix is what comes before "local variables:" in its line.
2701 (regexp-quote (buffer-substring (point)
2702 (line-end-position)))
2705 (concat "^" (regexp-quote
2706 (buffer-substring (line-beginning-position)
2707 (match-beginning 0)))))
2711 (let ((startpos (point))
2713 (thisbuf (current-buffer)))
2715 (unless (let ((case-fold-search t))
2717 (concat prefix "[ \t]*End:[ \t]*" suffix)
2719 (error "Local variables list is not properly terminated"))
2721 (setq endpos (point)))
2724 (insert-buffer-substring thisbuf startpos endpos)
2725 (goto-char (point-min))
2726 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2728 ;; Discard the prefix.
2729 (if (looking-at prefix)
2730 (delete-region (point) (match-end 0))
2731 (error "Local variables entry is missing the prefix"))
2733 ;; Discard the suffix.
2734 (if (looking-back suffix)
2735 (delete-region (match-beginning 0) (point))
2736 (error "Local variables entry is missing the suffix"))
2738 (goto-char (point-min))
2741 ;; Find the variable name; strip whitespace.
2742 (skip-chars-forward " \t")
2744 (skip-chars-forward "^:\n")
2745 (if (eolp) (error "Missing colon in local variables entry"))
2746 (skip-chars-backward " \t")
2747 (let* ((str (buffer-substring beg (point)))
2750 ;; Read the variable value.
2751 (skip-chars-forward "^:")
2753 (setq val (read (current-buffer)))
2757 (unless (eq var 'coding)
2759 (push (cons (if (eq var 'eval)
2761 (indirect-variable var))
2764 (forward-line 1)))))))
2766 ;; We've read all the local variables. Now, return whether the
2767 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2768 ;; variables (if MODE-ONLY is nil.)
2771 (dolist (ignored ignored-local-variables)
2772 (setq result (assq-delete-all ignored result)))
2773 (if (null enable-local-eval)
2774 (setq result (assq-delete-all 'eval result)))
2776 (setq result (nreverse result))
2777 ;; Find those variables that we may want to save to
2778 ;; `safe-local-variable-values'.
2779 (let (risky-vars unsafe-vars)
2780 (dolist (elt result)
2781 (let ((var (car elt))
2785 (or (eq enable-local-eval t)
2786 (hack-one-local-variable-eval-safep
2787 (eval (quote val)))))
2788 (safe-local-variable-p var val)
2789 (and (risky-local-variable-p var val)
2790 (push elt risky-vars))
2791 (push elt unsafe-vars))))
2792 (if (eq enable-local-variables :safe)
2793 ;; If caller wants only the safe variables,
2794 ;; install only them.
2795 (dolist (elt result)
2796 (unless (or (memq (car elt) unsafe-vars)
2797 (memq (car elt) risky-vars))
2798 (hack-one-local-variable (car elt) (cdr elt))))
2799 ;; Query, except in the case where all are known safe
2800 ;; if the user wants no quuery in that case.
2801 (if (or (and (eq enable-local-variables t)
2804 (eq enable-local-variables :all)
2805 (hack-local-variables-confirm
2806 result unsafe-vars risky-vars))
2807 (dolist (elt result)
2808 (hack-one-local-variable (car elt) (cdr elt)))))))
2809 (run-hooks 'hack-local-variables-hook)))))
2811 (defun safe-local-variable-p (sym val)
2812 "Non-nil if SYM is safe as a file-local variable with value VAL.
2813 It is safe if any of these conditions are met:
2815 * There is a matching entry (SYM . VAL) in the
2816 `safe-local-variable-values' user option.
2818 * The `safe-local-variable' property of SYM is a function that
2819 evaluates to a non-nil value with VAL as an argument."
2820 (or (member (cons sym val) safe-local-variable-values)
2821 (let ((safep (get sym 'safe-local-variable)))
2822 (and (functionp safep) (funcall safep val)))))
2824 (defun risky-local-variable-p (sym &optional ignored)
2825 "Non-nil if SYM could be dangerous as a file-local variable.
2826 It is dangerous if either of these conditions are met:
2828 * Its `risky-local-variable' property is non-nil.
2830 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2831 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
2832 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2833 \"map-alist\", or \"bindat-spec\"."
2834 ;; If this is an alias, check the base name.
2836 (setq sym (indirect-variable sym))
2838 (or (get sym 'risky-local-variable)
2839 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2840 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2841 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
2842 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
2844 (defun hack-one-local-variable-quotep (exp)
2845 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2847 (defun hack-one-local-variable-constantp (exp)
2848 (or (and (not (symbolp exp)) (not (consp exp)))
2851 (hack-one-local-variable-quotep exp)))
2853 (defun hack-one-local-variable-eval-safep (exp)
2854 "Return t if it is safe to eval EXP when it is found in a file."
2855 (or (not (consp exp))
2856 ;; Detect certain `put' expressions.
2857 (and (eq (car exp) 'put)
2858 (hack-one-local-variable-quotep (nth 1 exp))
2859 (hack-one-local-variable-quotep (nth 2 exp))
2860 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2861 (cond ((eq prop 'lisp-indent-hook)
2862 ;; Only allow safe values of lisp-indent-hook;
2864 (or (numberp val) (equal val ''defun)))
2865 ((eq prop 'edebug-form-spec)
2866 ;; Only allow indirect form specs.
2867 ;; During bootstrapping, edebug-basic-spec might not be
2869 (and (fboundp 'edebug-basic-spec)
2870 (hack-one-local-variable-quotep val)
2871 (edebug-basic-spec (nth 1 val)))))))
2872 ;; Allow expressions that the user requested.
2873 (member exp safe-local-eval-forms)
2874 ;; Certain functions can be allowed with safe arguments
2875 ;; or can specify verification functions to try.
2876 (and (symbolp (car exp))
2877 (let ((prop (get (car exp) 'safe-local-eval-function)))
2880 (dolist (arg (cdr exp))
2881 (unless (hack-one-local-variable-constantp arg)
2888 (dolist (function prop)
2889 (if (funcall function exp)
2893 (defun hack-one-local-variable (var val)
2894 "Set local variable VAR with value VAL.
2895 If VAR is `mode', call `VAL-mode' as a function unless it's
2896 already the major mode."
2897 (cond ((eq var 'mode)
2898 (let ((mode (intern (concat (downcase (symbol-name val))
2900 (unless (eq (indirect-function mode)
2901 (indirect-function major-mode))
2904 (save-excursion (eval val)))
2906 ;; Make sure the string has no text properties.
2907 ;; Some text properties can get evaluated in various ways,
2908 ;; so it is risky to put them on with a local variable list.
2910 (set-text-properties 0 (length val) nil val))
2911 (set (make-local-variable var) val))))
2914 (defcustom change-major-mode-with-file-name t
2915 "Non-nil means \\[write-file] should set the major mode from the file name.
2916 However, the mode will not be changed if
2917 \(1) a local variables list or the `-*-' line specifies a major mode, or
2918 \(2) the current major mode is a \"special\" mode,
2919 \ not suitable for ordinary files, or
2920 \(3) the new file name does not particularly specify any mode."
2922 :group 'editing-basics)
2924 (defun set-visited-file-name (filename &optional no-query along-with-file)
2925 "Change name of file visited in current buffer to FILENAME.
2926 This also renames the buffer to correspond to the new file.
2927 The next time the buffer is saved it will go in the newly specified file.
2928 FILENAME nil or an empty string means mark buffer as not visiting any file.
2929 Remember to delete the initial contents of the minibuffer
2930 if you wish to pass an empty string as the argument.
2932 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2933 confirmation in the case where another buffer is already visiting FILENAME.
2935 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2936 the old visited file has been renamed to the new name FILENAME."
2937 (interactive "FSet visited file name: ")
2938 (if (buffer-base-buffer)
2939 (error "An indirect buffer cannot visit a file"))
2943 (if (string-equal filename "")
2945 (expand-file-name filename))))
2948 (setq truename (file-truename filename))
2949 (if find-file-visit-truename
2950 (setq filename truename))))
2952 (let ((new-name (file-name-nondirectory filename)))
2953 (if (string= new-name "")
2954 (error "Empty file name"))))
2955 (let ((buffer (and filename (find-buffer-visiting filename))))
2956 (and buffer (not (eq buffer (current-buffer)))
2958 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
2961 (or (equal filename buffer-file-name)
2963 (and filename (lock-buffer filename))
2965 (setq buffer-file-name filename)
2966 (if filename ; make buffer name reflect filename.
2967 (let ((new-name (file-name-nondirectory buffer-file-name)))
2968 (if (eq system-type 'vax-vms)
2969 (setq new-name (downcase new-name)))
2970 (setq default-directory (file-name-directory buffer-file-name))
2971 ;; If new-name == old-name, renaming would add a spurious <2>
2972 ;; and it's considered as a feature in rename-buffer.
2973 (or (string= new-name (buffer-name))
2974 (rename-buffer new-name t))))
2975 (setq buffer-backed-up nil)
2977 (clear-visited-file-modtime))
2978 ;; Abbreviate the file names of the buffer.
2981 (setq buffer-file-truename (abbreviate-file-name truename))
2982 (if find-file-visit-truename
2983 (setq buffer-file-name truename))))
2984 (setq buffer-file-number
2986 (nthcdr 10 (file-attributes buffer-file-name))
2988 ;; write-file-functions is normally used for things like ftp-find-file
2989 ;; that visit things that are not local files as if they were files.
2990 ;; Changing to visit an ordinary local file instead should flush the hook.
2991 (kill-local-variable 'write-file-functions)
2992 (kill-local-variable 'local-write-file-hooks)
2993 (kill-local-variable 'revert-buffer-function)
2994 (kill-local-variable 'backup-inhibited)
2995 ;; If buffer was read-only because of version control,
2996 ;; that reason is gone now, so make it writable.
2998 (setq buffer-read-only nil))
2999 (kill-local-variable 'vc-mode)
3000 ;; Turn off backup files for certain file names.
3001 ;; Since this is a permanent local, the major mode won't eliminate it.
3002 (and buffer-file-name
3003 backup-enable-predicate
3004 (not (funcall backup-enable-predicate buffer-file-name))
3006 (make-local-variable 'backup-inhibited)
3007 (setq backup-inhibited t)))
3008 (let ((oauto buffer-auto-save-file-name))
3009 ;; If auto-save was not already on, turn it on if appropriate.
3010 (if (not buffer-auto-save-file-name)
3011 (and buffer-file-name auto-save-default
3013 ;; If auto save is on, start using a new name.
3014 ;; We deliberately don't rename or delete the old auto save
3015 ;; for the old visited file name. This is because perhaps
3016 ;; the user wants to save the new state and then compare with the
3017 ;; previous state from the auto save file.
3018 (setq buffer-auto-save-file-name
3019 (make-auto-save-file-name)))
3020 ;; Rename the old auto save file if any.
3021 (and oauto buffer-auto-save-file-name
3022 (file-exists-p oauto)
3023 (rename-file oauto buffer-auto-save-file-name t)))
3024 (and buffer-file-name
3025 (not along-with-file)
3026 (set-buffer-modified-p t))
3027 ;; Update the major mode, if the file name determines it.
3029 ;; Don't change the mode if it is special.
3030 (or (not change-major-mode-with-file-name)
3031 (get major-mode 'mode-class)
3032 ;; Don't change the mode if the local variable list specifies it.
3033 (hack-local-variables t)
3037 (defun write-file (filename &optional confirm)
3038 "Write current buffer into file FILENAME.
3039 This makes the buffer visit that file, and marks it as not modified.
3041 If you specify just a directory name as FILENAME, that means to use
3042 the default file name but in that directory. You can also yank
3043 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3045 If the buffer is not already visiting a file, the default file name
3046 for the output file is the buffer name.
3048 If optional second arg CONFIRM is non-nil, this function
3049 asks for confirmation before overwriting an existing file.
3050 Interactively, confirmation is required unless you supply a prefix argument."
3051 ;; (interactive "FWrite file: ")
3053 (list (if buffer-file-name
3054 (read-file-name "Write file: "
3056 (read-file-name "Write file: " default-directory
3058 (file-name-nondirectory (buffer-name))
3061 (not current-prefix-arg)))
3062 (or (null filename) (string-equal filename "")
3064 ;; If arg is just a directory,
3065 ;; use the default file name, but in that directory.
3066 (if (file-directory-p filename)
3067 (setq filename (concat (file-name-as-directory filename)
3068 (file-name-nondirectory
3069 (or buffer-file-name (buffer-name))))))
3071 (file-exists-p filename)
3072 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3073 (error "Canceled")))
3074 (set-visited-file-name filename (not confirm))))
3075 (set-buffer-modified-p t)
3076 ;; Make buffer writable if file is writable.
3077 (and buffer-file-name
3078 (file-writable-p buffer-file-name)
3079 (setq buffer-read-only nil))
3081 ;; It's likely that the VC status at the new location is different from
3082 ;; the one at the old location.
3083 (vc-find-file-hook))
3085 (defun backup-buffer ()
3086 "Make a backup of the disk file visited by the current buffer, if appropriate.
3087 This is normally done before saving the buffer the first time.
3089 A backup may be done by renaming or by copying; see documentation of
3090 variable `make-backup-files'. If it's done by renaming, then the file is
3091 no longer accessible under its old name.
3093 The value is non-nil after a backup was made by renaming.
3094 It has the form (MODES . BACKUPNAME).
3095 MODES is the result of `file-modes' on the original
3096 file; this means that the caller, after saving the buffer, should change
3097 the modes of the new file to agree with the old modes.
3098 BACKUPNAME is the backup file name, which is the old file renamed."
3099 (if (and make-backup-files (not backup-inhibited)
3100 (not buffer-backed-up)
3101 (file-exists-p buffer-file-name)
3102 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3104 (let ((real-file-name buffer-file-name)
3105 backup-info backupname targets setmodes)
3106 ;; If specified name is a symbolic link, chase it to the target.
3107 ;; Thus we make the backups in the directory where the real file is.
3108 (setq real-file-name (file-chase-links real-file-name))
3109 (setq backup-info (find-backup-file-name real-file-name)
3110 backupname (car backup-info)
3111 targets (cdr backup-info))
3112 ;; (if (file-directory-p buffer-file-name)
3113 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3116 (let ((delete-old-versions
3117 ;; If have old versions to maybe delete,
3118 ;; ask the user to confirm now, before doing anything.
3119 ;; But don't actually delete til later.
3121 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3122 (or delete-old-versions
3123 (y-or-n-p (format "Delete excess backup versions of %s? "
3125 (modes (file-modes buffer-file-name)))
3126 ;; Actually write the back up file.
3128 (if (or file-precious-flag
3129 ; (file-symlink-p buffer-file-name)
3131 ;; Don't rename a suid or sgid file.
3132 (and modes (< 0 (logand modes #o6000)))
3133 (not (file-writable-p (file-name-directory real-file-name)))
3134 (and backup-by-copying-when-linked
3135 (> (file-nlinks real-file-name) 1))
3136 (and (or backup-by-copying-when-mismatch
3137 (integerp backup-by-copying-when-privileged-mismatch))
3138 (let ((attr (file-attributes real-file-name)))
3139 (and (or backup-by-copying-when-mismatch
3140 (and (integerp (nth 2 attr))
3141 (integerp backup-by-copying-when-privileged-mismatch)
3142 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3144 (not (file-ownership-preserved-p real-file-name)))))))
3145 (backup-buffer-copy real-file-name backupname modes)
3146 ;; rename-file should delete old backup.
3147 (rename-file real-file-name backupname t)
3148 (setq setmodes (cons modes backupname)))
3150 ;; If trouble writing the backup, write it in ~.
3151 (setq backupname (expand-file-name
3152 (convert-standard-filename
3154 (message "Cannot write backup file; backing up in %s"
3157 (backup-buffer-copy real-file-name backupname modes)))
3158 (setq buffer-backed-up t)
3159 ;; Now delete the old versions, if desired.
3160 (if delete-old-versions
3163 (delete-file (car targets))
3165 (setq targets (cdr targets))))
3167 (file-error nil))))))
3169 (defun backup-buffer-copy (from-name to-name modes)
3170 (let ((umask (default-file-modes)))
3173 ;; Create temp files with strict access rights. It's easy to
3174 ;; loosen them later, whereas it's impossible to close the
3175 ;; time-window of loose permissions otherwise.
3176 (set-default-file-modes ?\700)
3177 (while (condition-case ()
3180 (delete-file to-name)
3182 (copy-file from-name to-name nil t)
3184 (file-already-exists t))
3185 ;; The file was somehow created by someone else between
3186 ;; `delete-file' and `copy-file', so let's try again.
3189 (set-default-file-modes umask)))
3191 (set-file-modes to-name (logand modes #o1777))))
3193 (defun file-name-sans-versions (name &optional keep-backup-version)
3194 "Return file NAME sans backup versions or strings.
3195 This is a separate procedure so your site-init or startup file can
3197 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3198 we do not remove backup version numbers, only true file version numbers."
3199 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3201 (funcall handler 'file-name-sans-versions name keep-backup-version)
3203 (if (eq system-type 'vax-vms)
3204 ;; VMS version number is (a) semicolon, optional
3205 ;; sign, zero or more digits or (b) period, option
3206 ;; sign, zero or more digits, provided this is the
3207 ;; second period encountered outside of the
3208 ;; device/directory part of the file name.
3209 (or (string-match ";[-+]?[0-9]*\\'" name)
3210 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
3212 (match-beginning 1))
3214 (if keep-backup-version
3216 (or (string-match "\\.~[0-9.]+~\\'" name)
3217 (string-match "~\\'" name)
3218 (length name))))))))
3220 (defun file-ownership-preserved-p (file)
3221 "Return t if deleting FILE and rewriting it would preserve the owner."
3222 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3224 (funcall handler 'file-ownership-preserved-p file)
3225 (let ((attributes (file-attributes file)))
3226 ;; Return t if the file doesn't exist, since it's true that no
3227 ;; information would be lost by an (attempted) delete and create.
3228 (or (null attributes)
3229 (= (nth 2 attributes) (user-uid)))))))
3231 (defun file-name-sans-extension (filename)
3232 "Return FILENAME sans final \"extension\".
3233 The extension, in a file name, is the part that follows the last `.',
3234 except that a leading `.', if any, doesn't count."
3236 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3238 (if (and (string-match "\\.[^.]*\\'" file)
3239 (not (eq 0 (match-beginning 0))))
3240 (if (setq directory (file-name-directory filename))
3241 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3242 ;; we don't want to expand it.
3243 (concat directory (substring file 0 (match-beginning 0)))
3244 (substring file 0 (match-beginning 0)))
3247 (defun file-name-extension (filename &optional period)
3248 "Return FILENAME's final \"extension\".
3249 The extension, in a file name, is the part that follows the last `.',
3250 excluding version numbers and backup suffixes,
3251 except that a leading `.', if any, doesn't count.
3252 Return nil for extensionless file names such as `foo'.
3253 Return the empty string for file names such as `foo.'.
3255 If PERIOD is non-nil, then the returned value includes the period
3256 that delimits the extension, and if FILENAME has no extension,
3259 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3260 (if (and (string-match "\\.[^.]*\\'" file)
3261 (not (eq 0 (match-beginning 0))))
3262 (substring file (+ (match-beginning 0) (if period 0 1)))
3266 (defcustom make-backup-file-name-function nil
3267 "A function to use instead of the default `make-backup-file-name'.
3268 A value of nil gives the default `make-backup-file-name' behavior.
3270 This could be buffer-local to do something special for specific
3271 files. If you define it, you may need to change `backup-file-name-p'
3272 and `file-name-sans-versions' too.
3274 See also `backup-directory-alist'."
3276 :type '(choice (const :tag "Default" nil)
3277 (function :tag "Your function")))
3279 (defcustom backup-directory-alist nil
3280 "Alist of filename patterns and backup directory names.
3281 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3282 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3283 relative or absolute. If it is absolute, so that all matching files
3284 are backed up into the same directory, the file names in this
3285 directory will be the full name of the file backed up with all
3286 directory separators changed to `!' to prevent clashes. This will not
3287 work correctly if your filesystem truncates the resulting name.
3289 For the common case of all backups going into one directory, the alist
3290 should contain a single element pairing \".\" with the appropriate
3293 If this variable is nil, or it fails to match a filename, the backup
3294 is made in the original file's directory.
3296 On MS-DOS filesystems without long names this variable is always
3299 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3300 (directory :tag "Backup directory name"))))
3302 (defun normal-backup-enable-predicate (name)
3303 "Default `backup-enable-predicate' function.
3304 Checks for files in `temporary-file-directory',
3305 `small-temporary-file-directory', and /tmp."
3306 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3308 ;; Directory is under temporary-file-directory.
3309 (and (not (eq comp t))
3310 (< comp (- (length temporary-file-directory)))))
3311 (let ((comp (compare-strings "/tmp" 0 nil
3313 ;; Directory is under /tmp.
3314 (and (not (eq comp t))
3315 (< comp (- (length "/tmp")))))
3316 (if small-temporary-file-directory
3317 (let ((comp (compare-strings small-temporary-file-directory
3320 ;; Directory is under small-temporary-file-directory.
3321 (and (not (eq comp t))
3322 (< comp (- (length small-temporary-file-directory)))))))))
3324 (defun make-backup-file-name (file)
3325 "Create the non-numeric backup file name for FILE.
3326 Normally this will just be the file's name with `~' appended.
3327 Customization hooks are provided as follows.
3329 If the variable `make-backup-file-name-function' is non-nil, its value
3330 should be a function which will be called with FILE as its argument;
3331 the resulting name is used.
3333 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3334 the documentation of that variable. If the directory for the backup
3335 doesn't exist, it is created."
3336 (if make-backup-file-name-function
3337 (funcall make-backup-file-name-function file)
3338 (if (and (eq system-type 'ms-dos)
3339 (not (msdos-long-file-names)))
3340 (let ((fn (file-name-nondirectory file)))
3341 (concat (file-name-directory file)
3342 (or (and (string-match "\\`[^.]+\\'" fn)
3343 (concat (match-string 0 fn) ".~"))
3344 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3345 (concat (match-string 0 fn) "~")))))
3346 (concat (make-backup-file-name-1 file) "~"))))
3348 (defun make-backup-file-name-1 (file)
3349 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3350 (let ((alist backup-directory-alist)
3351 elt backup-directory abs-backup-directory)
3353 (setq elt (pop alist))
3354 (if (string-match (car elt) file)
3355 (setq backup-directory (cdr elt)
3357 ;; If backup-directory is relative, it should be relative to the
3358 ;; file's directory. By expanding explicitly here, we avoid
3359 ;; depending on default-directory.
3360 (if backup-directory
3361 (setq abs-backup-directory
3362 (expand-file-name backup-directory
3363 (file-name-directory file))))
3364 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3366 (make-directory abs-backup-directory 'parents)
3367 (file-error (setq backup-directory nil
3368 abs-backup-directory nil))))
3369 (if (null backup-directory)
3371 (if (file-name-absolute-p backup-directory)
3373 (when (memq system-type '(windows-nt ms-dos cygwin))
3374 ;; Normalize DOSish file names: downcase the drive
3375 ;; letter, if any, and replace the leading "x:" with
3377 (or (file-name-absolute-p file)
3378 (setq file (expand-file-name file))) ; make defaults explicit
3379 ;; Replace any invalid file-name characters (for the
3380 ;; case of backing up remote files).
3381 (setq file (expand-file-name (convert-standard-filename file)))
3382 (if (eq (aref file 1) ?:)
3383 (setq file (concat "/"
3385 (char-to-string (downcase (aref file 0)))
3386 (if (eq (aref file 2) ?/)
3389 (substring file 2)))))
3390 ;; Make the name unique by substituting directory
3391 ;; separators. It may not really be worth bothering about
3392 ;; doubling `!'s in the original name...
3394 (subst-char-in-string
3396 (replace-regexp-in-string "!" "!!" file))
3398 (expand-file-name (file-name-nondirectory file)
3399 (file-name-as-directory abs-backup-directory))))))
3401 (defun backup-file-name-p (file)
3402 "Return non-nil if FILE is a backup file name (numeric or not).
3403 This is a separate function so you can redefine it for customization.
3404 You may need to redefine `file-name-sans-versions' as well."
3405 (string-match "~\\'" file))
3407 (defvar backup-extract-version-start)
3409 ;; This is used in various files.
3410 ;; The usage of backup-extract-version-start is not very clean,
3411 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3412 (defun backup-extract-version (fn)
3413 "Given the name of a numeric backup file, FN, return the backup number.
3414 Uses the free variable `backup-extract-version-start', whose value should be
3415 the index in the name where the version number begins."
3416 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3417 (= (match-beginning 0) backup-extract-version-start))
3418 (string-to-number (substring fn backup-extract-version-start -1))
3421 ;; I believe there is no need to alter this behavior for VMS;
3422 ;; since backup files are not made on VMS, it should not get called.
3423 (defun find-backup-file-name (fn)
3424 "Find a file name for a backup file FN, and suggestions for deletions.
3425 Value is a list whose car is the name for the backup file
3426 and whose cdr is a list of old versions to consider deleting now.
3427 If the value is nil, don't make a backup.
3428 Uses `backup-directory-alist' in the same way as does
3429 `make-backup-file-name'."
3430 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3431 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3433 (funcall handler 'find-backup-file-name fn)
3434 (if (or (eq version-control 'never)
3435 ;; We don't support numbered backups on plain MS-DOS
3436 ;; when long file names are unavailable.
3437 (and (eq system-type 'ms-dos)
3438 (not (msdos-long-file-names))))
3439 (list (make-backup-file-name fn))
3440 (let* ((basic-name (make-backup-file-name-1 fn))
3441 (base-versions (concat (file-name-nondirectory basic-name)
3443 (backup-extract-version-start (length base-versions))
3445 (number-to-delete 0)
3446 possibilities deserve-versions-p versions)
3448 (setq possibilities (file-name-all-completions
3450 (file-name-directory basic-name))
3451 versions (sort (mapcar #'backup-extract-version
3454 high-water-mark (apply 'max 0 versions)
3455 deserve-versions-p (or version-control
3456 (> high-water-mark 0))
3457 number-to-delete (- (length versions)
3461 (file-error (setq possibilities nil)))
3462 (if (not deserve-versions-p)
3463 (list (make-backup-file-name fn))
3464 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3465 (if (and (> number-to-delete 0)
3466 ;; Delete nothing if there is overflow
3467 ;; in the number of versions to keep.
3468 (>= (+ kept-new-versions kept-old-versions -1) 0))
3470 (format "%s.~%d~" basic-name n))
3471 (let ((v (nthcdr kept-old-versions versions)))
3472 (rplacd (nthcdr (1- number-to-delete) v) ())
3475 (defun file-nlinks (filename)
3476 "Return number of names file FILENAME has."
3477 (car (cdr (file-attributes filename))))
3479 ;; (defun file-relative-name (filename &optional directory)
3480 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3481 ;; This function returns a relative file name which is equivalent to FILENAME
3482 ;; when used with that default directory as the default.
3483 ;; If this is impossible (which can happen on MSDOS and Windows
3484 ;; when the file name and directory use different drive names)
3485 ;; then it returns FILENAME."
3487 ;; (let ((fname (expand-file-name filename)))
3488 ;; (setq directory (file-name-as-directory
3489 ;; (expand-file-name (or directory default-directory))))
3490 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3491 ;; ;; drive names, they can't be relative, so return the absolute name.
3492 ;; (if (and (or (eq system-type 'ms-dos)
3493 ;; (eq system-type 'cygwin)
3494 ;; (eq system-type 'windows-nt))
3495 ;; (not (string-equal (substring fname 0 2)
3496 ;; (substring directory 0 2))))
3498 ;; (let ((ancestor ".")
3499 ;; (fname-dir (file-name-as-directory fname)))
3500 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3501 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3502 ;; (setq directory (file-name-directory (substring directory 0 -1))
3503 ;; ancestor (if (equal ancestor ".")
3505 ;; (concat "../" ancestor))))
3506 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3507 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3508 ;; ;; We matched within FNAME's directory part.
3509 ;; ;; Add the rest of FNAME onto ANCESTOR.
3510 ;; (let ((rest (substring fname (match-end 0))))
3511 ;; (if (and (equal ancestor ".")
3512 ;; (not (equal rest "")))
3513 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3515 ;; (concat (file-name-as-directory ancestor) rest)))
3516 ;; ;; We matched FNAME's directory equivalent.
3519 (defun file-relative-name (filename &optional directory)
3520 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3521 This function returns a relative file name which is equivalent to FILENAME
3522 when used with that default directory as the default.
3523 If FILENAME and DIRECTORY lie on different machines or on different drives
3524 on a DOS/Windows machine, it returns FILENAME in expanded form."
3527 (file-name-as-directory (expand-file-name (or directory
3528 default-directory))))
3529 (setq filename (expand-file-name filename))
3530 (let ((fremote (file-remote-p filename))
3531 (dremote (file-remote-p directory)))
3532 (if ;; Conditions for separate trees
3534 ;; Test for different drives on DOS/Windows
3536 ;; Should `cygwin' really be included here? --stef
3537 (memq system-type '(ms-dos cygwin windows-nt))
3538 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3539 ;; Test for different remote file system identification
3540 (not (equal fremote dremote)))
3542 (let ((ancestor ".")
3543 (filename-dir (file-name-as-directory filename)))
3546 (eq t (compare-strings filename-dir nil (length directory)
3547 directory nil nil case-fold-search))
3548 (eq t (compare-strings filename nil (length directory)
3549 directory nil nil case-fold-search))))
3550 (setq directory (file-name-directory (substring directory 0 -1))
3551 ancestor (if (equal ancestor ".")
3553 (concat "../" ancestor))))
3554 ;; Now ancestor is empty, or .., or ../.., etc.
3555 (if (eq t (compare-strings filename nil (length directory)
3556 directory nil nil case-fold-search))
3557 ;; We matched within FILENAME's directory part.
3558 ;; Add the rest of FILENAME onto ANCESTOR.
3559 (let ((rest (substring filename (length directory))))
3560 (if (and (equal ancestor ".") (not (equal rest "")))
3561 ;; But don't bother with ANCESTOR if it would give us `./'.
3563 (concat (file-name-as-directory ancestor) rest)))
3564 ;; We matched FILENAME's directory equivalent.
3567 (defun save-buffer (&optional args)
3568 "Save current buffer in visited file if modified.
3569 Variations are described below.
3571 By default, makes the previous version into a backup file
3572 if previously requested or if this is the first save.
3573 Prefixed with one \\[universal-argument], marks this version
3574 to become a backup when the next save is done.
3575 Prefixed with two \\[universal-argument]'s,
3576 unconditionally makes the previous version into a backup file.
3577 Prefixed with three \\[universal-argument]'s, marks this version
3578 to become a backup when the next save is done,
3579 and unconditionally makes the previous version into a backup file.
3581 With a numeric argument of 0, never make the previous version
3584 If a file's name is FOO, the names of its numbered backup versions are
3585 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3586 Numeric backups (rather than FOO~) will be made if value of
3587 `version-control' is not the atom `never' and either there are already
3588 numeric versions of the file being backed up, or `version-control' is
3590 We don't want excessive versions piling up, so there are variables
3591 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3592 and `kept-new-versions', which tells how many newest versions to keep.
3593 Defaults are 2 old versions and 2 new.
3594 `dired-kept-versions' controls dired's clean-directory (.) command.
3595 If `delete-old-versions' is nil, system will query user
3596 before trimming versions. Otherwise it does it silently.
3598 If `vc-make-backup-files' is nil, which is the default,
3599 no backup files are made for files managed by version control.
3600 (This is because the version control system itself records previous versions.)
3602 See the subroutine `basic-save-buffer' for more information."
3604 (let ((modp (buffer-modified-p))
3605 (large (> (buffer-size) 50000))
3606 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3607 (memq args '(16 64)))))
3608 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3609 (if (and modp large (buffer-file-name))
3610 (message "Saving file %s..." (buffer-file-name)))
3612 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3614 (defun delete-auto-save-file-if-necessary (&optional force)
3615 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3616 Normally delete only if the file was written by this Emacs since
3617 the last real save, but optional arg FORCE non-nil means delete anyway."
3618 (and buffer-auto-save-file-name delete-auto-save-files
3619 (not (string= buffer-file-name buffer-auto-save-file-name))
3620 (or force (recent-auto-save-p))
3623 (delete-file buffer-auto-save-file-name)
3625 (set-buffer-auto-saved))))
3627 (defvar auto-save-hook nil
3628 "Normal hook run just before auto-saving.")
3630 (defcustom before-save-hook nil
3631 "Normal hook that is run before a buffer is saved to its file."
3632 :options '(copyright-update time-stamp)
3636 (defcustom after-save-hook nil
3637 "Normal hook that is run after a buffer is saved to its file."
3638 :options '(executable-make-buffer-file-executable-if-script-p)
3642 (defvar save-buffer-coding-system nil
3643 "If non-nil, use this coding system for saving the buffer.
3644 More precisely, use this coding system in place of the
3645 value of `buffer-file-coding-system', when saving the buffer.
3646 Calling `write-region' for any purpose other than saving the buffer
3647 will still use `buffer-file-coding-system'; this variable has no effect
3650 (make-variable-buffer-local 'save-buffer-coding-system)
3651 (put 'save-buffer-coding-system 'permanent-local t)
3653 (defun basic-save-buffer ()
3654 "Save the current buffer in its visited file, if it has been modified.
3655 The hooks `write-contents-functions' and `write-file-functions' get a chance
3656 to do the job of saving; if they do not, then the buffer is saved in
3657 the visited file in the usual way.
3658 Before and after saving the buffer, this function runs
3659 `before-save-hook' and `after-save-hook', respectively."
3661 (save-current-buffer
3662 ;; In an indirect buffer, save its base buffer instead.
3663 (if (buffer-base-buffer)
3664 (set-buffer (buffer-base-buffer)))
3665 (if (buffer-modified-p)
3666 (let ((recent-save (recent-auto-save-p))
3668 ;; On VMS, rename file and buffer to get rid of version number.
3669 (if (and (eq system-type 'vax-vms)
3670 (not (string= buffer-file-name
3671 (file-name-sans-versions buffer-file-name))))
3672 (let (buffer-new-name)
3673 ;; Strip VMS version number before save.
3674 (setq buffer-file-name
3675 (file-name-sans-versions buffer-file-name))
3676 ;; Construct a (unique) buffer name to correspond.
3677 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3678 (setq buffer-new-name (buffer-name buf))
3680 (rename-buffer buffer-new-name)))
3681 ;; If buffer has no file name, ask user for one.
3682 (or buffer-file-name
3685 (read-file-name "File to save in: ") nil)))
3686 (if (file-exists-p filename)
3687 (if (file-directory-p filename)
3688 ;; Signal an error if the user specified the name of an
3689 ;; existing directory.
3690 (error "%s is a directory" filename)
3691 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3693 (error "Canceled")))
3694 ;; Signal an error if the specified name refers to a
3695 ;; non-existing directory.
3696 (let ((dir (file-name-directory filename)))
3697 (unless (file-directory-p dir)
3698 (if (file-exists-p dir)
3699 (error "%s is not a directory" dir)
3700 (error "%s: no such directory" dir)))))
3701 (set-visited-file-name filename)))
3702 (or (verify-visited-file-modtime (current-buffer))
3703 (not (file-exists-p buffer-file-name))
3705 (format "%s has changed since visited or saved. Save anyway? "
3706 (file-name-nondirectory buffer-file-name)))
3707 (error "Save not confirmed"))
3711 (and (> (point-max) (point-min))
3712 (not find-file-literally)
3713 (/= (char-after (1- (point-max))) ?\n)
3714 (not (and (eq selective-display t)
3715 (= (char-after (1- (point-max))) ?\r)))
3716 (or (eq require-final-newline t)
3717 (eq require-final-newline 'visit-save)
3718 (and require-final-newline
3720 (format "Buffer %s does not end in newline. Add one? "
3723 (goto-char (point-max))
3725 ;; Support VC version backups.
3727 (run-hooks 'before-save-hook)
3728 (or (run-hook-with-args-until-success 'write-contents-functions)
3729 (run-hook-with-args-until-success 'local-write-file-hooks)
3730 (run-hook-with-args-until-success 'write-file-functions)
3731 ;; If a hook returned t, file is already "written".
3732 ;; Otherwise, write it the usual way now.
3733 (setq setmodes (basic-save-buffer-1)))
3734 ;; Now we have saved the current buffer. Let's make sure
3735 ;; that buffer-file-coding-system is fixed to what
3736 ;; actually used for saving by binding it locally.
3737 (if save-buffer-coding-system
3738 (setq save-buffer-coding-system last-coding-system-used)
3739 (setq buffer-file-coding-system last-coding-system-used))
3740 (setq buffer-file-number
3741 (nthcdr 10 (file-attributes buffer-file-name)))
3744 (set-file-modes buffer-file-name (car setmodes))
3746 ;; If the auto-save file was recent before this command,
3748 (delete-auto-save-file-if-necessary recent-save)
3749 ;; Support VC `implicit' locking.
3751 (run-hooks 'after-save-hook))
3752 (message "(No changes need to be saved)"))))
3754 ;; This does the "real job" of writing a buffer into its visited file
3755 ;; and making a backup file. This is what is normally done
3756 ;; but inhibited if one of write-file-functions returns non-nil.
3757 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3758 (defun basic-save-buffer-1 ()
3760 (if save-buffer-coding-system
3761 (let ((coding-system-for-write save-buffer-coding-system))
3762 (basic-save-buffer-2))
3763 (basic-save-buffer-2))
3764 (setq buffer-file-coding-system-explicit last-coding-system-used)))
3766 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3767 (defun basic-save-buffer-2 ()
3768 (let (tempsetmodes setmodes)
3769 (if (not (file-writable-p buffer-file-name))
3770 (let ((dir (file-name-directory buffer-file-name)))
3771 (if (not (file-directory-p dir))
3772 (if (file-exists-p dir)
3773 (error "%s is not a directory" dir)
3774 (error "%s: no such directory" dir))
3775 (if (not (file-exists-p buffer-file-name))
3776 (error "Directory %s write-protected" dir)
3778 (format "File %s is write-protected; try to save anyway? "
3779 (file-name-nondirectory
3781 (setq tempsetmodes t)
3782 (error "Attempt to save to a file which you aren't allowed to write"))))))
3783 (or buffer-backed-up
3784 (setq setmodes (backup-buffer)))
3785 (let ((dir (file-name-directory buffer-file-name)))
3786 (if (and file-precious-flag
3787 (file-writable-p dir))
3788 ;; If file is precious, write temp name, then rename it.
3789 ;; This requires write access to the containing dir,
3790 ;; which is why we don't try it if we don't have that access.
3791 (let ((realname buffer-file-name)
3793 (umask (default-file-modes))
3794 (old-modtime (visited-file-modtime)))
3795 ;; Create temp files with strict access rights. It's easy to
3796 ;; loosen them later, whereas it's impossible to close the
3797 ;; time-window of loose permissions otherwise.
3800 (clear-visited-file-modtime)
3801 (set-default-file-modes ?\700)
3802 ;; Try various temporary names.
3803 ;; This code follows the example of make-temp-file,
3804 ;; but it calls write-region in the appropriate way
3805 ;; for saving the buffer.
3806 (while (condition-case ()
3810 (expand-file-name "tmp" dir)))
3811 (write-region (point-min) (point-max)
3812 tempname nil realname
3813 buffer-file-truename 'excl)
3815 (file-already-exists t))
3816 ;; The file was somehow created by someone else between
3817 ;; `make-temp-name' and `write-region', let's try again.
3821 (set-default-file-modes umask)
3822 ;; If we failed, restore the buffer's modtime.
3824 (set-visited-file-modtime old-modtime)))
3825 ;; Since we have created an entirely new file,
3826 ;; make sure it gets the right permission bits set.
3827 (setq setmodes (or setmodes
3828 (cons (or (file-modes buffer-file-name)
3829 (logand ?\666 umask))
3831 ;; We succeeded in writing the temp file,
3833 (rename-file tempname buffer-file-name t))
3834 ;; If file not writable, see if we can make it writable
3835 ;; temporarily while we write it.
3836 ;; But no need to do so if we have just backed it up
3837 ;; (setmodes is set) because that says we're superseding.
3838 (cond ((and tempsetmodes (not setmodes))
3839 ;; Change the mode back, after writing.
3840 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3841 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3845 (write-region (point-min) (point-max)
3846 buffer-file-name nil t buffer-file-truename)
3848 ;; If we get an error writing the new file, and we made
3849 ;; the backup by renaming, undo the backing-up.
3850 (and setmodes (not success)
3852 (rename-file (cdr setmodes) buffer-file-name t)
3853 (setq buffer-backed-up nil)))))))
3856 (defun diff-buffer-with-file (&optional buffer)
3857 "View the differences between BUFFER and its associated file.
3858 This requires the external program `diff' to be in your `exec-path'."
3859 (interactive "bBuffer: ")
3860 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3861 (if (and buffer-file-name
3862 (file-exists-p buffer-file-name))
3863 (let ((tempfile (make-temp-file "buffer-content-")))
3867 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3868 (diff buffer-file-name tempfile nil t)
3870 (when (file-exists-p tempfile)
3871 (delete-file tempfile))))
3872 (message "Buffer %s has no associated file on disc" (buffer-name))
3873 ;; Display that message for 1 second so that user can read it
3874 ;; in the minibuffer.
3876 ;; return always nil, so that save-buffers-kill-emacs will not move
3877 ;; over to the next unsaved buffer when calling `d'.
3880 (defvar save-some-buffers-action-alist
3885 (exit-recursive-edit)))
3887 ;; Return nil to ask about BUF again.
3891 (save-window-excursion
3892 (diff-buffer-with-file buf))
3893 (view-buffer (get-buffer-create "*Diff*")
3894 (lambda (ignore) (exit-recursive-edit)))
3897 "view changes in this buffer"))
3898 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3900 (defvar buffer-save-without-query nil
3901 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3902 (make-variable-buffer-local 'buffer-save-without-query)
3904 (defun save-some-buffers (&optional arg pred)
3905 "Save some modified file-visiting buffers. Asks user about each one.
3906 You can answer `y' to save, `n' not to save, `C-r' to look at the
3907 buffer in question with `view-buffer' before deciding or `d' to
3908 view the differences using `diff-buffer-with-file'.
3910 Optional argument (the prefix) non-nil means save all with no questions.
3911 Optional second argument PRED determines which buffers are considered:
3912 If PRED is nil, all the file-visiting buffers are considered.
3913 If PRED is t, then certain non-file buffers will also be considered.
3914 If PRED is a zero-argument function, it indicates for each buffer whether
3915 to consider it or not when called with that buffer current.
3917 See `save-some-buffers-action-alist' if you want to
3918 change the additional actions you can take on files."
3920 (save-window-excursion
3921 (let* (queried some-automatic
3922 files-done abbrevs-done)
3923 (dolist (buffer (buffer-list))
3924 ;; First save any buffers that we're supposed to save unconditionally.
3925 ;; That way the following code won't ask about them.
3926 (with-current-buffer buffer
3927 (when (and buffer-save-without-query (buffer-modified-p))
3928 (setq some-automatic t)
3930 ;; Ask about those buffers that merit it,
3931 ;; and record the number thus saved.
3936 (and (buffer-modified-p buffer)
3937 (not (buffer-base-buffer buffer))
3939 (buffer-file-name buffer)
3943 (and buffer-offer-save (> (buffer-size) 0)))))
3944 (or (not (functionp pred))
3945 (with-current-buffer buffer (funcall pred)))
3949 (if (buffer-file-name buffer)
3950 (format "Save file %s? "
3951 (buffer-file-name buffer))
3952 (format "Save buffer %s? "
3953 (buffer-name buffer)))))))
3959 '("buffer" "buffers" "save")
3960 save-some-buffers-action-alist))
3961 ;; Maybe to save abbrevs, and record whether
3962 ;; we either saved them or asked to.
3963 (and save-abbrevs abbrevs-changed
3966 (eq save-abbrevs 'silently)
3967 (y-or-n-p (format "Save abbrevs in %s? "
3969 (write-abbrev-file nil))
3970 ;; Don't keep bothering user if he says no.
3971 (setq abbrevs-changed nil)
3972 (setq abbrevs-done t)))
3973 (or queried (> files-done 0) abbrevs-done
3974 (message (if some-automatic
3975 "(Some special files were saved without asking)"
3976 "(No files need saving)"))))))
3978 (defun not-modified (&optional arg)
3979 "Mark current buffer as unmodified, not needing to be saved.
3980 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3982 It is not a good idea to use this function in Lisp programs, because it
3983 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3985 (message (if arg "Modification-flag set"
3986 "Modification-flag cleared"))
3987 (set-buffer-modified-p arg))
3989 (defun toggle-read-only (&optional arg)
3990 "Change whether this buffer is visiting its file read-only.
3991 With arg, set read-only iff arg is positive.
3992 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3995 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3996 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4000 ((and buffer-read-only view-mode)
4001 (View-exit-and-edit)
4002 (make-local-variable 'view-read-only)
4003 (setq view-read-only t)) ; Must leave view mode.
4004 ((and (not buffer-read-only) view-read-only
4005 ;; If view-mode is already active, `view-mode-enter' is a nop.
4007 (not (eq (get major-mode 'mode-class) 'special)))
4009 (t (setq buffer-read-only (not buffer-read-only))
4010 (force-mode-line-update)))
4011 (if (vc-backend buffer-file-name)
4012 (message "%s" (substitute-command-keys
4013 (concat "File is under version-control; "
4014 "use \\[vc-next-action] to check in/out"))))))
4016 (defun insert-file (filename)
4017 "Insert contents of file FILENAME into buffer after point.
4018 Set mark after the inserted text.
4020 This function is meant for the user to run interactively.
4021 Don't call it from programs! Use `insert-file-contents' instead.
4022 \(Its calling sequence is different; see its documentation)."
4023 (interactive "*fInsert file: ")
4024 (insert-file-1 filename #'insert-file-contents))
4026 (defun append-to-file (start end filename)
4027 "Append the contents of the region to the end of file FILENAME.
4028 When called from a function, expects three arguments,
4029 START, END and FILENAME. START and END are buffer positions
4030 saying what text to write."
4031 (interactive "r\nFAppend to file: ")
4032 (write-region start end filename t))
4034 (defun file-newest-backup (filename)
4035 "Return most recent backup file for FILENAME or nil if no backups exist."
4036 ;; `make-backup-file-name' will get us the right directory for
4037 ;; ordinary or numeric backups. It might create a directory for
4038 ;; backups as a side-effect, according to `backup-directory-alist'.
4039 (let* ((filename (file-name-sans-versions
4040 (make-backup-file-name (expand-file-name filename))))
4041 (file (file-name-nondirectory filename))
4042 (dir (file-name-directory filename))
4043 (comp (file-name-all-completions file dir))
4047 (setq tem (pop comp))
4048 (cond ((and (backup-file-name-p tem)
4049 (string= (file-name-sans-versions tem) file))
4050 (setq tem (concat dir tem))
4051 (if (or (null newest)
4052 (file-newer-than-file-p tem newest))
4053 (setq newest tem)))))
4056 (defun rename-uniquely ()
4057 "Rename current buffer to a similar name not already taken.
4058 This function is useful for creating multiple shell process buffers
4059 or multiple mail buffers, etc."
4062 (let ((base-name (buffer-name)))
4063 (and (string-match "<[0-9]+>\\'" base-name)
4064 (not (and buffer-file-name
4066 (file-name-nondirectory buffer-file-name))))
4067 ;; If the existing buffer name has a <NNN>,
4068 ;; which isn't part of the file name (if any),
4069 ;; then get rid of that.
4070 (setq base-name (substring base-name 0 (match-beginning 0))))
4071 (rename-buffer (generate-new-buffer-name base-name))
4072 (force-mode-line-update))))
4074 (defun make-directory (dir &optional parents)
4075 "Create the directory DIR and any nonexistent parent dirs.
4076 If DIR already exists as a directory, do nothing.
4078 Interactively, the default choice of directory to create
4079 is the current default directory for file names.
4080 That is useful when you have visited a file in a nonexistent directory.
4082 Noninteractively, the second (optional) argument PARENTS says whether
4083 to create parent directories if they don't exist. Interactively,
4084 this happens by default."
4086 (list (read-file-name "Make directory: " default-directory default-directory
4089 ;; If default-directory is a remote directory,
4090 ;; make sure we find its make-directory handler.
4091 (setq dir (expand-file-name dir))
4092 (let ((handler (find-file-name-handler dir 'make-directory)))
4094 (funcall handler 'make-directory dir parents)
4096 (make-directory-internal dir)
4097 (let ((dir (directory-file-name (expand-file-name dir)))
4099 (while (not (file-exists-p dir))
4100 (setq create-list (cons dir create-list)
4101 dir (directory-file-name (file-name-directory dir))))
4103 (make-directory-internal (car create-list))
4104 (setq create-list (cdr create-list))))))))
4106 (put 'revert-buffer-function 'permanent-local t)
4107 (defvar revert-buffer-function nil
4108 "Function to use to revert this buffer, or nil to do the default.
4109 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4110 which are the arguments that `revert-buffer' received.")
4112 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4113 (defvar revert-buffer-insert-file-contents-function nil
4114 "Function to use to insert contents when reverting this buffer.
4115 Gets two args, first the nominal file name to use,
4116 and second, t if reading the auto-save file.
4118 The function you specify is responsible for updating (or preserving) point.")
4120 (defvar buffer-stale-function nil
4121 "Function to check whether a non-file buffer needs reverting.
4122 This should be a function with one optional argument NOCONFIRM.
4123 Auto Revert Mode passes t for NOCONFIRM. The function should return
4124 non-nil if the buffer should be reverted. A return value of
4125 `fast' means that the need for reverting was not checked, but
4126 that reverting the buffer is fast. The buffer is current when
4127 this function is called.
4129 The idea behind the NOCONFIRM argument is that it should be
4130 non-nil if the buffer is going to be reverted without asking the
4131 user. In such situations, one has to be careful with potentially
4132 time consuming operations.
4134 For more information on how this variable is used by Auto Revert mode,
4135 see Info node `(emacs)Supporting additional buffers'.")
4137 (defvar before-revert-hook nil
4138 "Normal hook for `revert-buffer' to run before reverting.
4139 If `revert-buffer-function' is used to override the normal revert
4140 mechanism, this hook is not used.")
4142 (defvar after-revert-hook nil
4143 "Normal hook for `revert-buffer' to run after reverting.
4144 Note that the hook value that it runs is the value that was in effect
4145 before reverting; that makes a difference if you have buffer-local
4148 If `revert-buffer-function' is used to override the normal revert
4149 mechanism, this hook is not used.")
4151 (defvar revert-buffer-internal-hook)
4153 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4154 "Replace current buffer text with the text of the visited file on disk.
4155 This undoes all changes since the file was visited or saved.
4156 With a prefix argument, offer to revert from latest auto-save file, if
4157 that is more recent than the visited file.
4159 This command also works for special buffers that contain text which
4160 doesn't come from a file, but reflects some other data base instead:
4161 for example, Dired buffers and `buffer-list' buffers. In these cases,
4162 it reconstructs the buffer contents from the appropriate data base.
4164 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4165 to revert from the auto-save file when this is nil. Note that the
4166 sense of this argument is the reverse of the prefix argument, for the
4167 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4170 Optional second argument NOCONFIRM means don't ask for confirmation at
4171 all. \(The variable `revert-without-query' offers another way to
4172 revert buffers without querying for confirmation.)
4174 Optional third argument PRESERVE-MODES non-nil means don't alter
4175 the files modes. Normally we reinitialize them using `normal-mode'.
4177 If the value of `revert-buffer-function' is non-nil, it is called to
4178 do all the work for this command. Otherwise, the hooks
4179 `before-revert-hook' and `after-revert-hook' are run at the beginning
4180 and the end, and if `revert-buffer-insert-file-contents-function' is
4181 non-nil, it is called instead of rereading visited file contents."
4183 ;; I admit it's odd to reverse the sense of the prefix argument, but
4184 ;; there is a lot of code out there which assumes that the first
4185 ;; argument should be t to avoid consulting the auto-save file, and
4186 ;; there's no straightforward way to encourage authors to notice a
4187 ;; reversal of the argument sense. So I'm just changing the user
4188 ;; interface, but leaving the programmatic interface the same.
4189 (interactive (list (not current-prefix-arg)))
4190 (if revert-buffer-function
4191 (funcall revert-buffer-function ignore-auto noconfirm)
4192 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4194 (let* ((auto-save-p (and (not ignore-auto)
4195 (recent-auto-save-p)
4196 buffer-auto-save-file-name
4197 (file-readable-p buffer-auto-save-file-name)
4199 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4200 (file-name (if auto-save-p
4201 buffer-auto-save-file-name
4203 (cond ((null file-name)
4204 (error "Buffer does not seem to be associated with any file"))
4206 (and (not (buffer-modified-p))
4208 (dolist (regexp revert-without-query)
4209 (when (string-match regexp file-name)
4210 (throw 'found t)))))
4211 (yes-or-no-p (format "Revert buffer from file %s? "
4213 (run-hooks 'before-revert-hook)
4214 ;; If file was backed up but has changed since,
4215 ;; we shd make another backup.
4216 (and (not auto-save-p)
4217 (not (verify-visited-file-modtime (current-buffer)))
4218 (setq buffer-backed-up nil))
4219 ;; Effectively copy the after-revert-hook status,
4220 ;; since after-find-file will clobber it.
4221 (let ((global-hook (default-value 'after-revert-hook))
4222 (local-hook (when (local-variable-p 'after-revert-hook)
4224 (inhibit-read-only t))
4226 (revert-buffer-insert-file-contents-function
4227 (unless (eq buffer-undo-list t)
4228 ;; Get rid of all undo records for this buffer.
4229 (setq buffer-undo-list nil))
4230 ;; Don't make undo records for the reversion.
4231 (let ((buffer-undo-list t))
4232 (funcall revert-buffer-insert-file-contents-function
4233 file-name auto-save-p)))
4234 ((not (file-exists-p file-name))
4235 (error (if buffer-file-number
4236 "File %s no longer exists!"
4237 "Cannot revert nonexistent file %s")
4239 ((not (file-readable-p file-name))
4240 (error (if buffer-file-number
4241 "File %s no longer readable!"
4242 "Cannot revert unreadable file %s")
4245 ;; Bind buffer-file-name to nil
4246 ;; so that we don't try to lock the file.
4247 (let ((buffer-file-name nil))
4251 (let ((coding-system-for-read
4252 ;; Auto-saved file should be read by Emacs'
4254 (if auto-save-p 'auto-save-coding
4255 (or coding-system-for-read
4256 buffer-file-coding-system-explicit))))
4257 (if (and (not enable-multibyte-characters)
4258 coding-system-for-read
4259 (not (memq (coding-system-base
4260 coding-system-for-read)
4261 '(no-conversion raw-text))))
4262 ;; As a coding system suitable for multibyte
4263 ;; buffer is specified, make the current
4264 ;; buffer multibyte.
4265 (set-buffer-multibyte t))
4267 ;; This force after-insert-file-set-coding
4268 ;; (called from insert-file-contents) to set
4269 ;; buffer-file-coding-system to a proper value.
4270 (kill-local-variable 'buffer-file-coding-system)
4272 ;; Note that this preserves point in an intelligent way.
4274 (let ((buffer-file-format buffer-file-format))
4275 (insert-file-contents file-name (not auto-save-p)
4277 (insert-file-contents file-name (not auto-save-p)
4279 ;; Recompute the truename in case changes in symlinks
4280 ;; have changed the truename.
4281 (setq buffer-file-truename
4282 (abbreviate-file-name (file-truename buffer-file-name)))
4283 (after-find-file nil nil t t preserve-modes)
4284 ;; Run after-revert-hook as it was before we reverted.
4285 (setq-default revert-buffer-internal-hook global-hook)
4287 (set (make-local-variable 'revert-buffer-internal-hook)
4289 (kill-local-variable 'revert-buffer-internal-hook))
4290 (run-hooks 'revert-buffer-internal-hook))
4293 (defun recover-this-file ()
4294 "Recover the visited file--get contents from its last auto-save file."
4296 (recover-file buffer-file-name))
4298 (defun recover-file (file)
4299 "Visit file FILE, but get contents from its last auto-save file."
4300 ;; Actually putting the file name in the minibuffer should be used
4302 ;; Not just because users often use the default.
4303 (interactive "FRecover file: ")
4304 (setq file (expand-file-name file))
4305 (if (auto-save-file-name-p (file-name-nondirectory file))
4306 (error "%s is an auto-save file" (abbreviate-file-name file)))
4307 (let ((file-name (let ((buffer-file-name file))
4308 (make-auto-save-file-name))))
4309 (cond ((if (file-exists-p file)
4310 (not (file-newer-than-file-p file-name file))
4311 (not (file-exists-p file-name)))
4312 (error "Auto-save file %s not current"
4313 (abbreviate-file-name file-name)))
4314 ((save-window-excursion
4315 (with-output-to-temp-buffer "*Directory*"
4316 (buffer-disable-undo standard-output)
4318 (let ((switches dired-listing-switches))
4319 (if (file-symlink-p file)
4320 (setq switches (concat switches "L")))
4321 (set-buffer standard-output)
4322 ;; Use insert-directory-safely, not insert-directory,
4323 ;; because these files might not exist. In particular,
4324 ;; FILE might not exist if the auto-save file was for
4325 ;; a buffer that didn't visit a file, such as "*mail*".
4326 ;; The code in v20.x called `ls' directly, so we need
4327 ;; to emulate what `ls' did in that case.
4328 (insert-directory-safely file switches)
4329 (insert-directory-safely file-name switches))))
4330 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4331 (switch-to-buffer (find-file-noselect file t))
4332 (let ((inhibit-read-only t)
4333 ;; Keep the current buffer-file-coding-system.
4334 (coding-system buffer-file-coding-system)
4335 ;; Auto-saved file should be read with special coding.
4336 (coding-system-for-read 'auto-save-coding))
4338 (insert-file-contents file-name nil)
4339 (set-buffer-file-coding-system coding-system))
4340 (after-find-file nil nil t))
4341 (t (error "Recover-file cancelled")))))
4343 (defun recover-session ()
4344 "Recover auto save files from a previous Emacs session.
4345 This command first displays a Dired buffer showing you the
4346 previous sessions that you could recover from.
4347 To choose one, move point to the proper line and then type C-c C-c.
4348 Then you'll be asked about a number of files to recover."
4350 (if (null auto-save-list-file-prefix)
4351 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4352 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4353 (unless (file-directory-p dir)
4354 (make-directory dir t))
4355 (unless (directory-files dir nil
4356 (concat "\\`" (regexp-quote
4357 (file-name-nondirectory
4358 auto-save-list-file-prefix)))
4360 (error "No previous sessions to recover")))
4361 (let ((ls-lisp-support-shell-wildcards t))
4362 (dired (concat auto-save-list-file-prefix "*")
4363 (concat dired-listing-switches "t")))
4365 (goto-char (point-min))
4366 (or (looking-at " Move to the session you want to recover,")
4367 (let ((inhibit-read-only t))
4368 ;; Each line starts with a space
4369 ;; so that Font Lock mode won't highlight the first character.
4370 (insert " Move to the session you want to recover,\n"
4371 " then type C-c C-c to select it.\n\n"
4372 " You can also delete some of these files;\n"
4373 " type d on a line to mark that file for deletion.\n\n"))))
4374 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4375 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4377 (defun recover-session-finish ()
4378 "Choose one saved session to recover auto-save files from.
4379 This command is used in the special Dired buffer created by
4380 \\[recover-session]."
4382 ;; Get the name of the session file to recover from.
4383 (let ((file (dired-get-filename))
4385 (buffer (get-buffer-create " *recover*")))
4387 (dired-do-flagged-delete t)
4390 ;; Read in the auto-save-list file.
4393 (insert-file-contents file)
4394 ;; Loop thru the text of that file
4395 ;; and get out the names of the files to recover.
4397 (let (thisfile autofile)
4399 ;; This is a pair of lines for a non-file-visiting buffer.
4400 ;; Get the auto-save file name and manufacture
4401 ;; a "visited file name" from that.
4404 ;; If there is no auto-save file name, the
4405 ;; auto-save-list file is probably corrupted.
4408 (buffer-substring-no-properties
4410 (line-end-position)))
4414 (file-name-nondirectory autofile)
4416 (file-name-directory autofile))))
4418 ;; This pair of lines is a file-visiting
4419 ;; buffer. Use the visited file name.
4422 (buffer-substring-no-properties
4423 (point) (progn (end-of-line) (point))))
4426 (buffer-substring-no-properties
4427 (point) (progn (end-of-line) (point))))
4429 ;; Ignore a file if its auto-save file does not exist now.
4430 (if (and autofile (file-exists-p autofile))
4431 (setq files (cons thisfile files)))))
4432 (setq files (nreverse files))
4433 ;; The file contains a pair of line for each auto-saved buffer.
4434 ;; The first line of the pair contains the visited file name
4435 ;; or is empty if the buffer was not visiting a file.
4436 ;; The second line is the auto-save file name.
4438 (map-y-or-n-p "Recover %s? "
4441 (save-excursion (recover-file file))
4443 "Failed to recover `%s'" file)))
4445 '("file" "files" "recover"))
4446 (message "No files can be recovered from this session now")))
4447 (kill-buffer buffer))))
4449 (defun kill-buffer-ask (buffer)
4450 "Kill buffer if confirmed."
4452 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4453 (if (buffer-modified-p buffer)
4454 "HAS BEEN EDITED" "is unmodified")))
4455 (kill-buffer buffer)))
4457 (defun kill-some-buffers (&optional list)
4458 "Kill some buffers. Asks the user whether to kill each one of them.
4459 Non-interactively, if optional argument LIST is non-nil, it
4460 specifies the list of buffers to kill, asking for approval for each one."
4463 (setq list (buffer-list)))
4465 (let* ((buffer (car list))
4466 (name (buffer-name buffer)))
4467 (and name ; Can be nil for an indirect buffer
4468 ; if we killed the base buffer.
4469 (not (string-equal name ""))
4470 (/= (aref name 0) ?\s)
4471 (kill-buffer-ask buffer)))
4472 (setq list (cdr list))))
4474 (defun kill-matching-buffers (regexp &optional internal-too)
4475 "Kill buffers whose name matches the specified regexp.
4476 The optional second argument indicates whether to kill internal buffers too."
4477 (interactive "sKill buffers matching this regular expression: \nP")
4478 (dolist (buffer (buffer-list))
4479 (let ((name (buffer-name buffer)))
4480 (when (and name (not (string-equal name ""))
4481 (or internal-too (/= (aref name 0) ?\s))
4482 (string-match regexp name))
4483 (kill-buffer-ask buffer)))))
4486 (defun auto-save-mode (arg)
4487 "Toggle auto-saving of contents of current buffer.
4488 With prefix argument ARG, turn auto-saving on if positive, else off."
4490 (setq buffer-auto-save-file-name
4492 (or (not buffer-auto-save-file-name)
4493 ;; If auto-save is off because buffer has shrunk,
4494 ;; then toggling should turn it on.
4495 (< buffer-saved-size 0))
4496 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4497 (if (and buffer-file-name auto-save-visited-file-name
4498 (not buffer-read-only))
4500 (make-auto-save-file-name))))
4501 ;; If -1 was stored here, to temporarily turn off saving,
4503 (and (< buffer-saved-size 0)
4504 (setq buffer-saved-size 0))
4506 (message "Auto-save %s (in this buffer)"
4507 (if buffer-auto-save-file-name "on" "off")))
4508 buffer-auto-save-file-name)
4510 (defun rename-auto-save-file ()
4511 "Adjust current buffer's auto save file name for current conditions.
4512 Also rename any existing auto save file, if it was made in this session."
4513 (let ((osave buffer-auto-save-file-name))
4514 (setq buffer-auto-save-file-name
4515 (make-auto-save-file-name))
4516 (if (and osave buffer-auto-save-file-name
4517 (not (string= buffer-auto-save-file-name buffer-file-name))
4518 (not (string= buffer-auto-save-file-name osave))
4519 (file-exists-p osave)
4520 (recent-auto-save-p))
4521 (rename-file osave buffer-auto-save-file-name t))))
4523 (defun make-auto-save-file-name ()
4524 "Return file name to use for auto-saves of current buffer.
4525 Does not consider `auto-save-visited-file-name' as that variable is checked
4526 before calling this function. You can redefine this for customization.
4527 See also `auto-save-file-name-p'."
4528 (if buffer-file-name
4529 (let ((handler (find-file-name-handler buffer-file-name
4530 'make-auto-save-file-name)))
4532 (funcall handler 'make-auto-save-file-name)
4533 (let ((list auto-save-file-name-transforms)
4534 (filename buffer-file-name)
4536 ;; Apply user-specified translations
4537 ;; to the file name.
4538 (while (and list (not result))
4539 (if (string-match (car (car list)) filename)
4540 (setq result (replace-match (cadr (car list)) t nil
4542 uniq (car (cddr (car list)))))
4543 (setq list (cdr list)))
4546 (setq filename (concat
4547 (file-name-directory result)
4548 (subst-char-in-string
4550 (replace-regexp-in-string "!" "!!"
4552 (setq filename result)))
4554 (if (and (eq system-type 'ms-dos)
4555 (not (msdos-long-file-names)))
4556 ;; We truncate the file name to DOS 8+3 limits
4557 ;; before doing anything else, because the regexp
4558 ;; passed to string-match below cannot handle
4559 ;; extensions longer than 3 characters, multiple
4560 ;; dots, and other atrocities.
4561 (let ((fn (dos-8+3-filename
4562 (file-name-nondirectory buffer-file-name))))
4564 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4566 (concat (file-name-directory buffer-file-name)
4567 "#" (match-string 1 fn)
4568 "." (match-string 3 fn) "#"))
4569 (concat (file-name-directory filename)
4571 (file-name-nondirectory filename)
4573 ;; Make sure auto-save file names don't contain characters
4574 ;; invalid for the underlying filesystem.
4575 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4576 ;; Don't modify remote (ange-ftp) filenames
4577 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4578 (convert-standard-filename result)
4581 ;; Deal with buffers that don't have any associated files. (Mail
4582 ;; mode tends to create a good number of these.)
4584 (let ((buffer-name (buffer-name))
4587 ;; Eliminate all slashes and backslashes by
4588 ;; replacing them with sequences that start with %.
4589 ;; Quote % also, to keep distinct names distinct.
4590 (while (string-match "[/\\%]" buffer-name limit)
4591 (let* ((character (aref buffer-name (match-beginning 0)))
4593 (cond ((eq character ?%) "%%")
4594 ((eq character ?/) "%+")
4595 ((eq character ?\\) "%-"))))
4596 (setq buffer-name (replace-match replacement t t buffer-name))
4597 (setq limit (1+ (match-end 0)))))
4598 ;; Generate the file name.
4603 (format "#%s#" buffer-name)
4604 ;; Try a few alternative directories, to get one we can
4607 ((file-writable-p default-directory) default-directory)
4608 ((file-writable-p "/var/tmp/") "/var/tmp/")
4610 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4611 ;; Don't modify remote (ange-ftp) filenames
4612 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4613 ;; The call to convert-standard-filename is in case
4614 ;; buffer-name includes characters not allowed by the
4615 ;; DOS/Windows filesystems. make-temp-file writes to the
4616 ;; file it creates, so we must fix the file name _before_
4617 ;; make-temp-file is called.
4618 (convert-standard-filename fname)
4621 ;; make-temp-file creates the file,
4622 ;; but we don't want it to exist until we do an auto-save.
4624 (delete-file file-name)
4628 (defun auto-save-file-name-p (filename)
4629 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4630 FILENAME should lack slashes. You can redefine this for customization."
4631 (string-match "^#.*#$" filename))
4633 (defun wildcard-to-regexp (wildcard)
4634 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4635 The generated regexp will match a filename iff the filename
4636 matches that wildcard according to shell rules. Only wildcards known
4637 by `sh' are supported."
4638 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4639 ;; Copy the initial run of non-special characters.
4640 (result (substring wildcard 0 i))
4641 (len (length wildcard)))
4642 ;; If no special characters, we're almost done.
4645 (let ((ch (aref wildcard i))
4653 (eq (aref wildcard (1+ i)) ?\]))
4655 ((eq ch ?\[) ; [...] maps to regexp char class
4660 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4663 (if (eq (aref wildcard i) ?\])
4668 ((eq (aref wildcard i) ?^)
4669 ;; Found "[^". Insert a `\0' character
4670 ;; (which cannot happen in a filename)
4671 ;; into the character class, so that `^'
4672 ;; is not the first character after `[',
4673 ;; and thus non-special in a regexp.
4677 ((eq (aref wildcard i) ?\])
4678 ;; I don't think `]' can appear in a
4679 ;; character class in a wildcard, but
4680 ;; let's be general here.
4685 (prog1 ; copy everything upto next `]'.
4688 (setq j (string-match
4690 (setq i (if j (1- j) (1- len)))))))
4692 ((eq ch ?*) "[^\000]*")
4696 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4697 ((eq ch ??) "[^\000]")
4698 (t (char-to-string ch)))))
4700 ;; Shell wildcards should match the entire filename,
4701 ;; not its part. Make the regexp say so.
4702 (concat "\\`" result "\\'")))
4704 (defcustom list-directory-brief-switches
4705 (if (eq system-type 'vax-vms) "" "-CF")
4706 "Switches for `list-directory' to pass to `ls' for brief listing."
4710 (defcustom list-directory-verbose-switches
4711 (if (eq system-type 'vax-vms)
4712 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4714 "Switches for `list-directory' to pass to `ls' for verbose listing."
4718 (defun file-expand-wildcards (pattern &optional full)
4719 "Expand wildcard pattern PATTERN.
4720 This returns a list of file names which match the pattern.
4722 If PATTERN is written as an absolute file name,
4723 the values are absolute also.
4725 If PATTERN is written as a relative file name, it is interpreted
4726 relative to the current default directory, `default-directory'.
4727 The file names returned are normally also relative to the current
4728 default directory. However, if FULL is non-nil, they are absolute."
4730 (let* ((nondir (file-name-nondirectory pattern))
4731 (dirpart (file-name-directory pattern))
4732 ;; A list of all dirs that DIRPART specifies.
4733 ;; This can be more than one dir
4734 ;; if DIRPART contains wildcards.
4735 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4736 (mapcar 'file-name-as-directory
4737 (file-expand-wildcards (directory-file-name dirpart)))
4741 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4742 (file-directory-p (directory-file-name (car dirs))))
4743 (let ((this-dir-contents
4744 ;; Filter out "." and ".."
4746 (mapcar #'(lambda (name)
4747 (unless (string-match "\\`\\.\\.?\\'"
4748 (file-name-nondirectory name))
4750 (directory-files (or (car dirs) ".") full
4751 (wildcard-to-regexp nondir))))))
4754 (if (and (car dirs) (not full))
4755 (mapcar (function (lambda (name) (concat (car dirs) name)))
4759 (setq dirs (cdr dirs)))
4762 (defun list-directory (dirname &optional verbose)
4763 "Display a list of files in or matching DIRNAME, a la `ls'.
4764 DIRNAME is globbed by the shell if necessary.
4765 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4766 Actions controlled by variables `list-directory-brief-switches'
4767 and `list-directory-verbose-switches'."
4768 (interactive (let ((pfx current-prefix-arg))
4769 (list (read-file-name (if pfx "List directory (verbose): "
4770 "List directory (brief): ")
4771 nil default-directory nil)
4773 (let ((switches (if verbose list-directory-verbose-switches
4774 list-directory-brief-switches))
4776 (or dirname (setq dirname default-directory))
4777 (setq dirname (expand-file-name dirname))
4778 (with-output-to-temp-buffer "*Directory*"
4779 (setq buffer standard-output)
4780 (buffer-disable-undo standard-output)
4781 (princ "Directory ")
4785 (set-buffer "*Directory*")
4786 (let ((wildcard (not (file-directory-p dirname))))
4787 (insert-directory dirname switches wildcard (not wildcard)))))
4788 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4789 (with-current-buffer buffer
4790 (setq default-directory
4791 (if (file-directory-p dirname)
4792 (file-name-as-directory dirname)
4793 (file-name-directory dirname))))))
4795 (defun shell-quote-wildcard-pattern (pattern)
4796 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4798 PATTERN is assumed to represent a file-name wildcard suitable for the
4799 underlying filesystem. For Unix and GNU/Linux, the characters from the
4800 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4801 the parts of the pattern which don't include wildcard characters are
4802 quoted with double quotes.
4803 Existing quote characters in PATTERN are left alone, so you can pass
4804 PATTERN that already quotes some of the special characters."
4807 ((memq system-type '(ms-dos windows-nt cygwin))
4808 ;; DOS/Windows don't allow `"' in file names. So if the
4809 ;; argument has quotes, we can safely assume it is already
4810 ;; quoted by the caller.
4811 (if (or (string-match "[\"]" pattern)
4812 ;; We quote [&()#$'] in case their shell is a port of a
4813 ;; Unixy shell. We quote [,=+] because stock DOS and
4814 ;; Windows shells require that in some cases, such as
4815 ;; passing arguments to batch files that use positional
4816 ;; arguments like %1.
4817 (not (string-match "[ \t;&()#$',=+]" pattern)))
4822 (while (string-match "[*?]+" pattern beg)
4823 (setq end (match-beginning 0)
4824 result (concat result (substring pattern beg end)
4826 (substring pattern end (match-end 0))
4829 (concat result (substring pattern beg) "\""))))
4832 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4834 (concat (substring pattern 0 (match-beginning 0))
4836 (substring pattern (match-beginning 0)))
4837 beg (1+ (match-end 0)))))
4841 (defvar insert-directory-program "ls"
4842 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4844 (defcustom directory-free-space-program "df"
4845 "Program to get the amount of free space on a file system.
4846 We assume the output has the format of `df'.
4847 The value of this variable must be just a command name or file name;
4848 if you want to specify options, use `directory-free-space-args'.
4850 A value of nil disables this feature.
4852 If the function `file-system-info' is defined, it is always used in
4853 preference to the program given by this variable."
4854 :type '(choice (string :tag "Program") (const :tag "None" nil))
4857 (defcustom directory-free-space-args
4858 (if (eq system-type 'darwin) "-k" "-Pk")
4859 "Options to use when running `directory-free-space-program'."
4863 (defun get-free-disk-space (dir)
4864 "Return the amount of free space on directory DIR's file system.
4865 The result is a string that gives the number of free 1KB blocks,
4866 or nil if the system call or the program which retrieve the information
4867 fail. It returns also nil when DIR is a remote directory.
4869 This function calls `file-system-info' if it is available, or invokes the
4870 program specified by `directory-free-space-program' if that is non-nil."
4871 (when (not (file-remote-p dir))
4872 ;; Try to find the number of free blocks. Non-Posix systems don't
4873 ;; always have df, but might have an equivalent system call.
4874 (if (fboundp 'file-system-info)
4875 (let ((fsinfo (file-system-info dir)))
4877 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4880 (when (and directory-free-space-program
4881 (eq 0 (call-process directory-free-space-program
4883 directory-free-space-args
4885 ;; Usual format is a header line followed by a line of
4887 (goto-char (point-min))
4891 ;; Move to the end of the "available blocks" number.
4892 (skip-chars-forward "^ \t")
4894 ;; Copy it into AVAILABLE.
4895 (let ((end (point)))
4897 (buffer-substring (point) end))))))))))
4899 ;; The following expression replaces `dired-move-to-filename-regexp'.
4900 (defvar directory-listing-before-filename-regexp
4901 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
4902 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
4903 ;; In some locales, month abbreviations are as short as 2 letters,
4904 ;; and they can be followed by ".".
4905 ;; In Breton, a month name can include a quote character.
4906 (month (concat l-or-quote l-or-quote "+\\.?"))
4908 (yyyy "[0-9][0-9][0-9][0-9]")
4910 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
4911 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
4912 (zone "[-+][0-2][0-9][0-5][0-9]")
4913 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
4914 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
4915 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
4916 "\\|" yyyy "-" iso-mm-dd "\\)"))
4917 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
4919 "\\(" HH:MM "\\|" yyyy "\\)"))
4920 (western-comma (concat month s "+" dd "," s "+" yyyy))
4921 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4922 ;; omits the Kanji characters after month and day-of-month.
4923 ;; On Mac OS X 10.3, the date format in East Asian locales is
4924 ;; day-of-month digits followed by month digits.
4927 (concat "\\(" mm l "?" s dd l "?" s "+"
4928 "\\|" dd s mm s "+" "\\)"
4929 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
4930 ;; The "[0-9]" below requires the previous column to end in a digit.
4931 ;; This avoids recognizing `1 may 1997' as a date in the line:
4932 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4934 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4935 ;; The ".*" below finds the last match if there are multiple matches.
4936 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4937 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4939 ;; vc dired listings provide the state or blanks between file
4940 ;; permissions and date. The state is always surrounded by
4942 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4943 ;; This is not supported yet.
4944 (concat ".*[0-9][BkKMGTPEZY]?" s
4945 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
4947 "Regular expression to match up to the file name in a directory listing.
4948 The default value is designed to recognize dates and times
4949 regardless of the language.")
4951 (defvar insert-directory-ls-version 'unknown)
4954 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4955 ;; FULL-DIRECTORY-P is nil.
4956 ;; The single line of output must display FILE's name as it was
4957 ;; given, namely, an absolute path name.
4958 ;; - must insert exactly one line for each file if WILDCARD or
4959 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4960 ;; before the file lines, plus optional text after the file lines.
4961 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4963 ;; File lines should display the basename.
4964 ;; - must be consistent with
4965 ;; - functions dired-move-to-filename, (these two define what a file line is)
4966 ;; dired-move-to-end-of-filename,
4967 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4968 ;; dired-insert-headerline
4969 ;; dired-after-subdir-garbage (defines what a "total" line is)
4970 ;; - variable dired-subdir-regexp
4971 ;; - may be passed "--dired" as the first argument in SWITCHES.
4972 ;; Filename handlers might have to remove this switch if their
4973 ;; "ls" command does not support it.
4974 (defun insert-directory (file switches &optional wildcard full-directory-p)
4975 "Insert directory listing for FILE, formatted according to SWITCHES.
4976 Leaves point after the inserted text.
4977 SWITCHES may be a string of options, or a list of strings
4978 representing individual options.
4979 Optional third arg WILDCARD means treat FILE as shell wildcard.
4980 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4981 switches do not contain `d', so that a full listing is expected.
4983 This works by running a directory listing program
4984 whose name is in the variable `insert-directory-program'.
4985 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4987 When SWITCHES contains the long `--dired' option, this function
4988 treats it specially, for the sake of dired. However, the
4989 normally equivalent short `-D' option is just passed on to
4990 `insert-directory-program', as any other option."
4991 ;; We need the directory in order to find the right handler.
4992 (let ((handler (find-file-name-handler (expand-file-name file)
4993 'insert-directory)))
4995 (funcall handler 'insert-directory file switches
4996 wildcard full-directory-p)
4997 (if (eq system-type 'vax-vms)
4998 (vms-read-directory file switches (current-buffer))
4999 (let (result (beg (point)))
5001 ;; Read the actual directory using `insert-directory-program'.
5002 ;; RESULT gets the status code.
5003 (let* (;; We at first read by no-conversion, then after
5004 ;; putting text property `dired-filename, decode one
5005 ;; bunch by one to preserve that property.
5006 (coding-system-for-read 'no-conversion)
5007 ;; This is to control encoding the arguments in call-process.
5008 (coding-system-for-write
5009 (and enable-multibyte-characters
5010 (or file-name-coding-system
5011 default-file-name-coding-system))))
5014 ;; Run ls in the directory part of the file pattern
5015 ;; using the last component as argument.
5016 (let ((default-directory
5017 (if (file-name-absolute-p file)
5018 (file-name-directory file)
5019 (file-name-directory (expand-file-name file))))
5020 (pattern (file-name-nondirectory file)))
5022 shell-file-name nil t nil
5024 (concat (if (memq system-type '(ms-dos windows-nt))
5026 "\\") ; Disregard Unix shell aliases!
5027 insert-directory-program
5029 (if (stringp switches)
5031 (mapconcat 'identity switches " "))
5033 ;; Quote some characters that have
5034 ;; special meanings in shells; but
5035 ;; don't quote the wildcards--we want
5036 ;; them to be special. We also
5037 ;; currently don't quote the quoting
5038 ;; characters in case people want to
5039 ;; use them explicitly to quote
5040 ;; wildcard characters.
5041 (shell-quote-wildcard-pattern pattern))))
5042 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5043 ;; directory if FILE is a symbolic link.
5044 (apply 'call-process
5045 insert-directory-program nil t nil
5047 (if (listp switches) switches
5048 (unless (equal switches "")
5049 ;; Split the switches at any spaces so we can
5050 ;; pass separate options as separate args.
5051 (split-string switches)))
5052 ;; Avoid lossage if FILE starts with `-'.
5055 (if (string-match "\\`~" file)
5056 (setq file (expand-file-name file)))
5058 (if full-directory-p
5059 (concat (file-name-as-directory file) ".")
5062 ;; If we got "//DIRED//" in the output, it means we got a real
5063 ;; directory listing, even if `ls' returned nonzero.
5064 ;; So ignore any errors.
5065 (when (if (stringp switches)
5066 (string-match "--dired\\>" switches)
5067 (member "--dired" switches))
5070 (when (looking-at "//SUBDIRED//")
5072 (if (looking-at "//DIRED//")
5075 (when (and (not (eq 0 result))
5076 (eq insert-directory-ls-version 'unknown))
5077 ;; The first time ls returns an error,
5078 ;; find the version numbers of ls,
5079 ;; and set insert-directory-ls-version
5080 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5081 ;; is equal or if the info cannot be obtained.
5082 ;; (That can mean it isn't GNU ls.)
5085 (call-process "ls" nil t nil "--version")
5087 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5088 (let* ((version (match-string 1 version-out))
5089 (split (split-string version "[.]"))
5090 (numbers (mapcar 'string-to-number split))
5093 (while (and (not comparison) (or numbers min))
5095 (setq comparison '>))
5097 (setq comparison '<))
5098 ((> (car numbers) (car min))
5099 (setq comparison '>))
5100 ((< (car numbers) (car min))
5101 (setq comparison '<))
5103 (setq numbers (cdr numbers)
5105 (setq insert-directory-ls-version (or comparison '=)))
5106 (setq insert-directory-ls-version nil))))
5108 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5109 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5112 ;; If `insert-directory-program' failed, signal an error.
5113 (unless (eq 0 result)
5114 ;; Delete the error message it may have output.
5115 (delete-region beg (point))
5116 ;; On non-Posix systems, we cannot open a directory, so
5117 ;; don't even try, because that will always result in
5118 ;; the ubiquitous "Access denied". Instead, show the
5119 ;; command line so the user can try to guess what went wrong.
5120 (if (and (file-directory-p file)
5121 (memq system-type '(ms-dos windows-nt)))
5123 "Reading directory: \"%s %s -- %s\" exited with status %s"
5124 insert-directory-program
5125 (if (listp switches) (concat switches) switches)
5127 ;; Unix. Access the file to get a suitable error.
5128 (access-file file "Reading directory")
5129 (error "Listing directory failed but `access-file' worked")))
5131 (when (if (stringp switches)
5132 (string-match "--dired\\>" switches)
5133 (member "--dired" switches))
5134 ;; The following overshoots by one line for an empty
5135 ;; directory listed with "--dired", but without "-a"
5136 ;; switch, where the ls output contains a
5137 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5138 ;; We take care of that case later.
5140 (when (looking-at "//SUBDIRED//")
5141 (delete-region (point) (progn (forward-line 1) (point)))
5143 (if (looking-at "//DIRED//")
5144 (let ((end (line-end-position))
5147 ;; Find all the lines that are error messages,
5148 ;; and record the bounds of each one.
5150 (while (< (point) linebeg)
5151 (or (eql (following-char) ?\s)
5152 (push (list (point) (line-end-position)) error-lines))
5154 (setq error-lines (nreverse error-lines))
5155 ;; Now read the numeric positions of file names.
5159 (while (< (point) end)
5160 (let ((start (insert-directory-adj-pos
5161 (+ beg (read (current-buffer)))
5163 (end (insert-directory-adj-pos
5164 (+ beg (read (current-buffer)))
5166 (if (memq (char-after end) '(?\n ?\s))
5167 ;; End is followed by \n or by " -> ".
5168 (put-text-property start end 'dired-filename t)
5169 ;; It seems that we can't trust ls's output as to
5170 ;; byte positions of filenames.
5171 (put-text-property beg (point) 'dired-filename nil)
5175 (delete-region (point) (progn (forward-line 1) (point))))
5176 ;; Take care of the case where the ls output contains a
5177 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5178 ;; and we went one line too far back (see above).
5180 (if (looking-at "//DIRED-OPTIONS//")
5181 (delete-region (point) (progn (forward-line 1) (point)))))
5183 ;; Now decode what read if necessary.
5184 (let ((coding (or coding-system-for-read
5185 file-name-coding-system
5186 default-file-name-coding-system
5190 (when (and enable-multibyte-characters
5191 (not (memq (coding-system-base coding)
5192 '(raw-text no-conversion))))
5193 ;; If no coding system is specified or detection is
5194 ;; requested, detect the coding.
5195 (if (eq (coding-system-base coding) 'undecided)
5196 (setq coding (detect-coding-region beg (point) t)))
5197 (if (not (eq (coding-system-base coding) 'undecided))
5200 (coding-system-change-eol-conversion coding 'unix))
5201 (narrow-to-region beg (point))
5202 (goto-char (point-min))
5205 val (get-text-property (point) 'dired-filename))
5206 (goto-char (next-single-property-change
5207 (point) 'dired-filename nil (point-max)))
5208 ;; Force no eol conversion on a file name, so
5209 ;; that CR is preserved.
5210 (decode-coding-region pos (point)
5211 (if val coding-no-eol coding))
5213 (put-text-property pos (point)
5214 'dired-filename t)))))))
5216 (if full-directory-p
5217 ;; Try to insert the amount of free space.
5220 ;; First find the line to put it on.
5221 (when (re-search-forward "^ *\\(total\\)" nil t)
5222 (let ((available (get-free-disk-space ".")))
5224 ;; Replace "total" with "used", to avoid confusion.
5225 (replace-match "total used in directory" nil nil nil 1)
5227 (insert " available " available)))))))))))
5229 (defun insert-directory-adj-pos (pos error-lines)
5230 "Convert `ls --dired' file name position value POS to a buffer position.
5231 File name position values returned in ls --dired output
5232 count only stdout; they don't count the error messages sent to stderr.
5233 So this function converts to them to real buffer positions.
5234 ERROR-LINES is a list of buffer positions of error message lines,
5235 of the form (START END)."
5236 (while (and error-lines (< (caar error-lines) pos))
5237 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5241 (defun insert-directory-safely (file switches
5242 &optional wildcard full-directory-p)
5243 "Insert directory listing for FILE, formatted according to SWITCHES.
5245 Like `insert-directory', but if FILE does not exist, it inserts a
5246 message to that effect instead of signaling an error."
5247 (if (file-exists-p file)
5248 (insert-directory file switches wildcard full-directory-p)
5249 ;; Simulate the message printed by `ls'.
5250 (insert (format "%s: No such file or directory\n" file))))
5252 (defvar kill-emacs-query-functions nil
5253 "Functions to call with no arguments to query about killing Emacs.
5254 If any of these functions returns nil, killing Emacs is cancelled.
5255 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
5256 but `kill-emacs', the low level primitive, does not.
5257 See also `kill-emacs-hook'.")
5259 (defcustom confirm-kill-emacs nil
5260 "How to ask for confirmation when leaving Emacs.
5261 If nil, the default, don't ask at all. If the value is non-nil, it should
5262 be a predicate function such as `yes-or-no-p'."
5263 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5264 (const :tag "Ask with y-or-n-p" y-or-n-p)
5265 (const :tag "Don't confirm" nil))
5269 (defun save-buffers-kill-emacs (&optional arg)
5270 "Offer to save each buffer, then kill this Emacs process.
5271 With prefix arg, silently save all file-visiting buffers, then kill."
5273 (save-some-buffers arg t)
5274 (and (or (not (memq t (mapcar (function
5275 (lambda (buf) (and (buffer-file-name buf)
5276 (buffer-modified-p buf))))
5278 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5279 (or (not (fboundp 'process-list))
5280 ;; process-list is not defined on VMS.
5281 (let ((processes (process-list))
5284 (and (memq (process-status (car processes)) '(run stop open listen))
5285 (process-query-on-exit-flag (car processes))
5287 (setq processes (cdr processes)))
5290 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5291 ;; Query the user for other things, perhaps.
5292 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5293 (or (null confirm-kill-emacs)
5294 (funcall confirm-kill-emacs "Really exit Emacs? "))
5297 ;; We use /: as a prefix to "quote" a file name
5298 ;; so that magic file name handlers will not apply to it.
5300 (setq file-name-handler-alist
5301 (cons '("\\`/:" . file-name-non-special)
5302 file-name-handler-alist))
5304 ;; We depend on being the last handler on the list,
5305 ;; so that anything else which does need handling
5306 ;; has been handled already.
5307 ;; So it is safe for us to inhibit *all* magic file name handlers.
5309 (defun file-name-non-special (operation &rest arguments)
5310 (let ((file-name-handler-alist nil)
5312 (if (eq operation 'insert-directory)
5313 (directory-file-name
5315 (unhandled-file-name-directory default-directory)))
5317 ;; Get a list of the indices of the args which are file names.
5319 (cdr (or (assq operation
5320 ;; The first six are special because they
5321 ;; return a file name. We want to include the /:
5322 ;; in the return value.
5323 ;; So just avoid stripping it in the first place.
5324 '((expand-file-name . nil)
5325 (file-name-directory . nil)
5326 (file-name-as-directory . nil)
5327 (directory-file-name . nil)
5328 (file-name-sans-versions . nil)
5329 (find-backup-file-name . nil)
5330 ;; `identity' means just return the first arg
5331 ;; not stripped of its quoting.
5332 (substitute-in-file-name identity)
5333 ;; `add' means add "/:" to the result.
5334 (file-truename add 0)
5335 ;; `quote' means add "/:" to buffer-file-name.
5336 (insert-file-contents quote 0)
5337 ;; `unquote-then-quote' means set buffer-file-name
5338 ;; temporarily to unquoted filename.
5339 (verify-visited-file-modtime unquote-then-quote)
5340 ;; List the arguments which are filenames.
5341 (file-name-completion 1)
5342 (file-name-all-completions 1)
5346 (make-symbolic-link 0 1)
5347 (add-name-to-file 0 1)))
5348 ;; For all other operations, treat the first argument only
5349 ;; as the file name.
5352 ;; Copy ARGUMENTS so we can replace elements in it.
5353 (arguments (copy-sequence arguments)))
5354 (if (symbolp (car file-arg-indices))
5355 (setq method (pop file-arg-indices)))
5356 ;; Strip off the /: from the file names that have it.
5358 (while (consp file-arg-indices)
5359 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5361 (string-match "\\`/:" (car pair))
5363 (if (= (length (car pair)) 2)
5365 (substring (car pair) 2)))))
5366 (setq file-arg-indices (cdr file-arg-indices))))
5367 (cond ((eq method 'identity)
5370 (concat "/:" (apply operation arguments)))
5373 (apply operation arguments)
5374 (setq buffer-file-name (concat "/:" buffer-file-name))))
5375 ((eq method 'unquote-then-quote)
5377 (setq buffer-file-name (substring buffer-file-name 2))
5378 (setq res (apply operation arguments))
5379 (setq buffer-file-name (concat "/:" buffer-file-name))
5382 (apply operation arguments)))))
5384 (define-key ctl-x-map "\C-f" 'find-file)
5385 (define-key ctl-x-map "\C-r" 'find-file-read-only)
5386 (define-key ctl-x-map "\C-v" 'find-alternate-file)
5387 (define-key ctl-x-map "\C-s" 'save-buffer)
5388 (define-key ctl-x-map "s" 'save-some-buffers)
5389 (define-key ctl-x-map "\C-w" 'write-file)
5390 (define-key ctl-x-map "i" 'insert-file)
5391 (define-key esc-map "~" 'not-modified)
5392 (define-key ctl-x-map "\C-d" 'list-directory)
5393 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
5394 (define-key ctl-x-map "\C-q" 'toggle-read-only)
5396 (define-key ctl-x-4-map "f" 'find-file-other-window)
5397 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5398 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5399 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
5400 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5402 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5403 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5404 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5405 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5406 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
5408 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5409 ;;; files.el ends here