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, 2008, 2009 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 3 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
32 (defvar font-lock-keywords)
35 "Backups of edited data files."
38 (defgroup find-file nil
43 (defcustom delete-auto-save-files t
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
51 (defcustom directory-abbrev-alist
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
66 :type '(repeat (cons :format "%v"
73 (defcustom make-backup-files t
74 "Non-nil means make a backup of a file the first time it is saved.
75 This can be done by renaming the file or by copying.
77 Renaming means that Emacs renames the existing file so that it is a
78 backup file, then writes the buffer into a new file. Any other names
79 that the old file had will now refer to the backup file. The new file
80 is owned by you and its group is defaulted.
82 Copying means that Emacs copies the existing file into the backup
83 file, then writes the buffer on top of the existing file. Any other
84 names that the old file had will now refer to the new (edited) file.
85 The file's owner and group are unchanged.
87 The choice of renaming or copying is controlled by the variables
88 `backup-by-copying', `backup-by-copying-when-linked',
89 `backup-by-copying-when-mismatch' and
90 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 ;; Do this so that local variables based on the file name
95 ;; are not overridden by the major mode.
96 (defvar backup-inhibited nil
97 "Non-nil means don't make a backup, regardless of the other parameters.
98 This variable is intended for use by making it local to a buffer.
99 But it is local only if you make it local.")
100 (put 'backup-inhibited 'permanent-local t)
102 (defcustom backup-by-copying nil
103 "Non-nil means always use copying to create backup files.
104 See documentation of variable `make-backup-files'."
108 (defcustom backup-by-copying-when-linked nil
109 "Non-nil means use copying to create backups for files with multiple names.
110 This causes the alternate names to refer to the latest version as edited.
111 This variable is relevant only if `backup-by-copying' is nil."
115 (defcustom backup-by-copying-when-mismatch nil
116 "Non-nil means create backups by copying if this preserves owner or group.
117 Renaming may still be used (subject to control of other variables)
118 when it would not result in changing the owner or group of the file;
119 that is, for files which are owned by you and whose group matches
120 the default for a new file created there by you.
121 This variable is relevant only if `backup-by-copying' is nil."
125 (defcustom backup-by-copying-when-privileged-mismatch 200
126 "Non-nil means create backups by copying to preserve a privileged owner.
127 Renaming may still be used (subject to control of other variables)
128 when it would not result in changing the owner of the file or if the owner
129 has a user id greater than the value of this variable. This is useful
130 when low-numbered uid's are used for special system users (such as root)
131 that must maintain ownership of certain files.
132 This variable is relevant only if `backup-by-copying' and
133 `backup-by-copying-when-mismatch' are nil."
134 :type '(choice (const nil) integer)
137 (defvar backup-enable-predicate 'normal-backup-enable-predicate
138 "Predicate that looks at a file name and decides whether to make backups.
139 Called with an absolute file name as argument, it returns t to enable backup.")
141 (defcustom buffer-offer-save nil
142 "Non-nil in a buffer means always offer to save buffer on exit.
143 Do so even if the buffer is not visiting a file.
144 Automatically local in all buffers."
147 (make-variable-buffer-local 'buffer-offer-save)
149 (defcustom find-file-existing-other-name t
150 "Non-nil means find a file under alternative names, in existing buffers.
151 This means if any existing buffer is visiting the file you want
152 under another name, you get the existing buffer instead of a new buffer."
156 (defcustom find-file-visit-truename nil
157 "Non-nil means visit a file under its truename.
158 The truename of a file is found by chasing all links
159 both at the file level and at the levels of the containing directories."
162 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
164 (defcustom revert-without-query nil
165 "Specify which files should be reverted without query.
166 The value is a list of regular expressions.
167 If the file name matches one of these regular expressions,
168 then `revert-buffer' reverts the file without querying
169 if the file has changed on disk and you have not edited the buffer."
170 :type '(repeat regexp)
173 (defvar buffer-file-number nil
174 "The device number and file number of the file visited in the current buffer.
175 The value is a list of the form (FILENUM DEVNUM).
176 This pair of numbers uniquely identifies the file.
177 If the buffer is visiting a new file, the value is nil.")
178 (make-variable-buffer-local 'buffer-file-number)
179 (put 'buffer-file-number 'permanent-local t)
181 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
182 "Non-nil means that `buffer-file-number' uniquely identifies files.")
184 (defvar buffer-file-read-only nil
185 "Non-nil if visited file was read-only when visited.")
186 (make-variable-buffer-local 'buffer-file-read-only)
188 (defcustom temporary-file-directory
189 (file-name-as-directory
190 (cond ((memq system-type '(ms-dos windows-nt))
191 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
193 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
194 "The directory for writing temporary files."
198 (defcustom small-temporary-file-directory
199 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
200 "The directory for writing small temporary files.
201 If non-nil, this directory is used instead of `temporary-file-directory'
202 by programs that create small temporary files. This is for systems that
203 have fast storage with limited space, such as a RAM disk."
205 :type '(choice (const nil) directory))
207 ;; The system null device. (Should reference NULL_DEVICE from C.)
208 (defvar null-device "/dev/null" "The system null device.")
210 (declare-function msdos-long-file-names "msdos.c")
211 (declare-function w32-long-file-name "w32proc.c")
212 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
213 (declare-function dired-unmark "dired" (arg))
214 (declare-function dired-do-flagged-delete "dired" (&optional nomessage))
215 (declare-function dos-8+3-filename "dos-fns" (filename))
216 (declare-function view-mode-disable "view" ())
217 (declare-function dosified-file-name "dos-fns" (file-name))
219 (defvar file-name-invalid-regexp
220 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
221 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
222 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
223 "[\000-\037]\\|" ; control characters
224 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
225 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
226 ((memq system-type '(ms-dos windows-nt cygwin))
227 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
228 "[|<>\"?*\000-\037]")) ; invalid characters
230 "Regexp recognizing file names which aren't allowed by the filesystem.")
232 (defcustom file-precious-flag nil
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
253 (defcustom break-hardlink-on-save nil
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
271 (defcustom version-control nil
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
276 :type '(choice (const :tag "Never" never)
277 (const :tag "If existing" nil)
278 (other :tag "Always" t))
281 (put 'version-control 'safe-local-variable
282 '(lambda (x) (or (booleanp x) (equal x 'never))))
284 (defcustom dired-kept-versions 2
285 "When cleaning directory, number of versions to keep."
290 (defcustom delete-old-versions nil
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
293 :type '(choice (const :tag "Delete" t)
294 (const :tag "Ask" nil)
295 (other :tag "Leave" other))
298 (defcustom kept-old-versions 2
299 "Number of oldest versions to keep when a new numbered backup is made."
302 (put 'kept-old-versions 'safe-local-variable 'integerp)
304 (defcustom kept-new-versions 2
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
309 (put 'kept-new-versions 'safe-local-variable 'integerp)
311 (defcustom require-final-newline nil
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
322 :type '(choice (const :tag "When visiting" visit)
323 (const :tag "When saving" t)
324 (const :tag "When visiting or saving" visit-save)
325 (const :tag "Don't add newlines" nil)
326 (other :tag "Ask each time" ask))
327 :group 'editing-basics)
329 (defcustom mode-require-final-newline t
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
344 :type '(choice (const :tag "When visiting" visit)
345 (const :tag "When saving" t)
346 (const :tag "When visiting or saving" visit-save)
347 (const :tag "Don't add newlines" nil)
348 (other :tag "Ask each time" ask))
349 :group 'editing-basics
352 (defcustom auto-save-default t
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
357 (defcustom auto-save-file-name-transforms
358 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
361 ,(concat temporary-file-directory "\\2") t))
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
384 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
385 (boolean :tag "Uniquify")))
388 (defcustom save-abbrevs t
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
391 :type '(choice (const t) (const nil) (const silently))
394 (defcustom find-file-run-dired t
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
400 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
404 :type '(hook :options (cvs-dired-noselect dired-noselect))
407 ;;;It is not useful to make this a local variable.
408 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
409 (defvar find-file-not-found-functions nil
410 "List of functions to be called for `find-file' on nonexistent file.
411 These functions are called as soon as the error is detected.
412 Variable `buffer-file-name' is already set up.
413 The functions are called in the order given until one of them returns non-nil.")
414 (define-obsolete-variable-alias 'find-file-not-found-hooks
415 'find-file-not-found-functions "22.1")
417 ;;;It is not useful to make this a local variable.
418 ;;;(put 'find-file-hooks 'permanent-local t)
419 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
420 (defcustom find-file-hook nil
421 "List of functions to be called after a buffer is loaded from a file.
422 The buffer's local variables (if any) will have been processed before the
423 functions are called."
426 :options '(auto-insert)
429 (defvar write-file-functions nil
430 "List of functions to be called before writing out a buffer to a file.
431 If one of them returns non-nil, the file is considered already written
432 and the rest are not called.
433 These hooks are considered to pertain to the visited file.
434 So any buffer-local binding of this variable is discarded if you change
435 the visited file name with \\[set-visited-file-name], but not when you
436 change the major mode.
438 This hook is not run if any of the functions in
439 `write-contents-functions' returns non-nil. Both hooks pertain
440 to how to save a buffer to file, for instance, choosing a suitable
441 coding system and setting mode bits. (See Info
442 node `(elisp)Saving Buffers'.) To perform various checks or
443 updates before the buffer is saved, use `before-save-hook'.")
444 (put 'write-file-functions 'permanent-local t)
445 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
447 (defvar local-write-file-hooks nil)
448 (make-variable-buffer-local 'local-write-file-hooks)
449 (put 'local-write-file-hooks 'permanent-local t)
450 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
452 (defvar write-contents-functions nil
453 "List of functions to be called before writing out a buffer to a file.
454 If one of them returns non-nil, the file is considered already written
455 and the rest are not called and neither are the functions in
456 `write-file-functions'.
458 This variable is meant to be used for hooks that pertain to the
459 buffer's contents, not to the particular visited file; thus,
460 `set-visited-file-name' does not clear this variable; but changing the
461 major mode does clear it.
463 For hooks that _do_ pertain to the particular visited file, use
464 `write-file-functions'. Both this variable and
465 `write-file-functions' relate to how a buffer is saved to file.
466 To perform various checks or updates before the buffer is saved,
467 use `before-save-hook'.")
468 (make-variable-buffer-local 'write-contents-functions)
469 (define-obsolete-variable-alias 'write-contents-hooks
470 'write-contents-functions "22.1")
472 (defcustom enable-local-variables t
473 "Control use of local variables in files you visit.
474 The value can be t, nil, :safe, :all, or something else.
476 A value of t means file local variables specifications are obeyed
477 if all the specified variable values are safe; if any values are
478 not safe, Emacs queries you, once, whether to set them all.
479 \(When you say yes to certain values, they are remembered as safe.)
481 :safe means set the safe variables, and ignore the rest.
482 :all means set all variables, whether safe or not.
483 (Don't set it permanently to :all.)
484 A value of nil means always ignore the file local variables.
486 Any other value means always query you once whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe, but
488 this has no effect when `enable-local-variables' is \"something else\".)
490 This variable also controls use of major modes specified in
493 The command \\[normal-mode], when used interactively,
494 always obeys file local variable specifications and the -*- line,
495 and ignores this variable."
497 :type '(choice (const :tag "Query Unsafe" t)
498 (const :tag "Safe Only" :safe)
499 (const :tag "Do all" :all)
500 (const :tag "Ignore" nil)
501 (other :tag "Query" other))
504 (defvar local-enable-local-variables t
505 "Like `enable-local-variables' but meant for buffer-local bindings.
506 The meaningful values are nil and non-nil. The default is non-nil.
507 If a major mode sets this to nil, buffer-locally, then any local
508 variables list in the file will be ignored.
510 This variable does not affect the use of major modes
511 specified in a -*- line.")
513 (defcustom enable-local-eval 'maybe
514 "Control processing of the \"variable\" `eval' in a file's local variables.
515 The value can be t, nil or something else.
516 A value of t means obey `eval' variables.
517 A value of nil means ignore them; anything else means query."
519 :type '(choice (const :tag "Obey" t)
520 (const :tag "Ignore" nil)
521 (other :tag "Query" other))
524 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
525 (or (fboundp 'lock-buffer)
526 (defalias 'lock-buffer 'ignore))
527 (or (fboundp 'unlock-buffer)
528 (defalias 'unlock-buffer 'ignore))
529 (or (fboundp 'file-locked-p)
530 (defalias 'file-locked-p 'ignore))
532 (defcustom view-read-only nil
533 "Non-nil means buffers visiting files read-only do so in view mode.
534 In fact, this means that all read-only buffers normally have
535 View mode enabled, including buffers that are read-only because
536 you visit a file you cannot alter, and buffers you make read-only
537 using \\[toggle-read-only]."
541 (defvar file-name-history nil
542 "History list of file names entered in the minibuffer.
544 Maximum length of the history list is determined by the value
545 of `history-length', which see.")
547 (put 'ange-ftp-completion-hook-function 'safe-magic t)
548 (defun ange-ftp-completion-hook-function (op &rest args)
549 "Provides support for ange-ftp host name completion.
550 Runs the usual ange-ftp hook, but only for completion operations."
551 ;; Having this here avoids the need to load ange-ftp when it's not
553 (if (memq op '(file-name-completion file-name-all-completions))
554 (apply 'ange-ftp-hook-function op args)
555 (let ((inhibit-file-name-handlers
556 (cons 'ange-ftp-completion-hook-function
557 (and (eq inhibit-file-name-operation op)
558 inhibit-file-name-handlers)))
559 (inhibit-file-name-operation op))
562 (defun convert-standard-filename (filename)
563 "Convert a standard file's name to something suitable for the OS.
564 This means to guarantee valid names and perhaps to canonicalize
567 FILENAME should be an absolute file name since the conversion rules
568 sometimes vary depending on the position in the file name. E.g. c:/foo
569 is a valid DOS file name, but c:/bar/c:/foo is not.
571 This function's standard definition is trivial; it just returns
572 the argument. However, on Windows and DOS, replace invalid
573 characters. On DOS, make sure to obey the 8.3 limitations.
574 In the native Windows build, turn Cygwin names into native names,
575 and also turn slashes into backslashes if the shell requires it (see
576 `w32-shell-dos-semantics').
578 See Info node `(elisp)Standard File Names' for more details."
579 (if (eq system-type 'cygwin)
580 (let ((name (copy-sequence filename))
582 ;; Replace invalid filename characters with !
583 (while (string-match "[?*:<>|\"\000-\037]" name start)
584 (aset name (match-beginning 0) ?!)
585 (setq start (match-end 0)))
589 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
590 "Read directory name, prompting with PROMPT and completing in directory DIR.
591 Value is not expanded---you must call `expand-file-name' yourself.
592 Default name to DEFAULT-DIRNAME if user exits with the same
593 non-empty string that was inserted by this function.
594 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
595 or just DIR if INITIAL is nil.)
596 If the user exits with an empty minibuffer, this function returns
597 an empty string. (This can only happen if the user erased the
598 pre-inserted contents or if `insert-default-directory' is nil.)
599 Fourth arg MUSTMATCH non-nil means require existing directory's name.
600 Non-nil and non-t means also require confirmation after completion.
601 Fifth arg INITIAL specifies text to start with.
602 DIR should be an absolute directory name. It defaults to
603 the value of `default-directory'."
605 (setq dir default-directory))
606 (read-file-name prompt dir (or default-dirname
607 (if initial (expand-file-name initial dir)
614 "Show the current default directory."
616 (message "Directory %s" default-directory))
619 "Value of the CDPATH environment variable, as a list.
620 Not actually set up until the first time you use it.")
622 (defun parse-colon-path (cd-path)
623 "Explode a search path into a list of directory names.
624 Directories are separated by occurrences of `path-separator'
625 \(which is colon in GNU and GNU-like systems)."
626 ;; We could use split-string here.
628 (let (cd-list (cd-start 0) cd-colon)
629 (setq cd-path (concat cd-path path-separator))
630 (while (setq cd-colon (string-match path-separator cd-path cd-start))
633 (list (if (= cd-start cd-colon)
635 (substitute-in-file-name
636 (file-name-as-directory
637 (substring cd-path cd-start cd-colon)))))))
638 (setq cd-start (+ cd-colon 1)))
641 (defun cd-absolute (dir)
642 "Change current directory to given absolute file name DIR."
643 ;; Put the name into directory syntax now,
644 ;; because otherwise expand-file-name may give some bad results.
645 (setq dir (file-name-as-directory dir))
646 (setq dir (abbreviate-file-name (expand-file-name dir)))
647 (if (not (file-directory-p dir))
648 (if (file-exists-p dir)
649 (error "%s is not a directory" dir)
650 (error "%s: no such directory" dir))
651 (unless (file-executable-p dir)
652 (error "Cannot cd to %s: Permission denied" dir))
653 (setq default-directory dir)
654 (set (make-local-variable 'list-buffers-directory) dir)))
657 "Make DIR become the current buffer's default directory.
658 If your environment includes a `CDPATH' variable, try each one of
659 that list of directories (separated by occurrences of
660 `path-separator') when resolving a relative directory name.
661 The path separator is colon in GNU and GNU-like systems."
663 (list (read-directory-name "Change default directory: "
664 default-directory default-directory
665 (and (member cd-path '(nil ("./")))
666 (null (getenv "CDPATH"))))))
667 (if (file-name-absolute-p dir)
668 (cd-absolute (expand-file-name dir))
670 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
671 (setq cd-path (or trypath (list "./")))))
672 (if (not (catch 'found
674 (function (lambda (x)
675 (let ((f (expand-file-name (concat x dir))))
676 (if (file-directory-p f)
679 (throw 'found t))))))
682 (error "No such directory found via CDPATH environment variable"))))
684 (defun load-file (file)
685 "Load the Lisp file named FILE."
686 ;; This is a case where .elc makes a lot of sense.
687 (interactive (list (let ((completion-ignored-extensions
688 (remove ".elc" completion-ignored-extensions)))
689 (read-file-name "Load file: "))))
690 (load (expand-file-name file) nil nil t))
692 (defun locate-file (filename path &optional suffixes predicate)
693 "Search for FILENAME through PATH.
694 If found, return the absolute file name of FILENAME, with its suffixes;
695 otherwise return nil.
696 PATH should be a list of directories to look in, like the lists in
697 `exec-path' or `load-path'.
698 If SUFFIXES is non-nil, it should be a list of suffixes to append to
699 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
700 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
701 If non-nil, PREDICATE is used instead of `file-readable-p'.
702 PREDICATE can also be an integer to pass to the `access' system call,
703 in which case file-name handlers are ignored. This usage is deprecated.
705 For compatibility, PREDICATE can also be one of the symbols
706 `executable', `readable', `writable', or `exists', or a list of
707 one or more of those symbols."
708 (if (and predicate (symbolp predicate) (not (functionp predicate)))
709 (setq predicate (list predicate)))
710 (when (and (consp predicate) (not (functionp predicate)))
712 (logior (if (memq 'executable predicate) 1 0)
713 (if (memq 'writable predicate) 2 0)
714 (if (memq 'readable predicate) 4 0))))
715 (locate-file-internal filename path suffixes predicate))
717 (defun locate-file-completion-table (dirs suffixes string pred action)
718 "Do completion for file names passed to `locate-file'."
720 ((file-name-absolute-p string)
721 (let ((read-file-name-predicate pred))
722 (read-file-name-internal string nil action)))
723 ((eq (car-safe action) 'boundaries)
724 (let ((suffix (cdr action)))
726 (length (file-name-directory string))
727 (let ((x (file-name-directory suffix)))
728 (if x (1- (length x)) (length suffix))))))
731 (suffix (concat (regexp-opt suffixes t) "\\'"))
732 (string-dir (file-name-directory string))
733 (string-file (file-name-nondirectory string)))
736 (setq dir default-directory))
737 (if string-dir (setq dir (expand-file-name string-dir dir)))
738 (when (file-directory-p dir)
739 (dolist (file (file-name-all-completions
742 (when (string-match suffix file)
743 (setq file (substring file 0 (match-beginning 0)))
744 (push file names)))))
745 (completion-table-with-context
746 string-dir names string-file pred action)))))
748 (defun locate-file-completion (string path-and-suffixes action)
749 "Do completion for file names passed to `locate-file'.
750 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
751 (locate-file-completion-table (car path-and-suffixes)
752 (cdr path-and-suffixes)
754 (make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
756 (defvar locate-dominating-stop-dir-regexp
757 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
758 "Regexp of directory names which stop the search in `locate-dominating-file'.
759 Any directory whose name matches this regexp will be treated like
760 a kind of root directory by `locate-dominating-file' which will stop its search
761 when it bumps into it.
762 The default regexp prevents fruitless and time-consuming attempts to find
763 special files in directories in which filenames are interpreted as hostnames,
764 or mount points potentially requiring authentication as a different user.")
766 ;; (defun locate-dominating-files (file regexp)
767 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
768 ;; Stop at the first parent where a matching file is found and return the list
769 ;; of files that that match in this directory."
771 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
772 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
774 ;; ;; Abbreviate, so as to stop when we cross ~/.
775 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
778 ;; ;; As a heuristic, we stop looking up the hierarchy of
779 ;; ;; directories as soon as we find a directory belonging to
780 ;; ;; another user. This should save us from looking in
781 ;; ;; things like /net and /afs. This assumes that all the
782 ;; ;; files inside a project belong to the same user.
783 ;; (let ((prev-user user))
784 ;; (setq user (nth 2 (file-attributes dir)))
785 ;; (or (null prev-user) (equal user prev-user))))
786 ;; (if (setq files (condition-case nil
787 ;; (directory-files dir 'full regexp 'nosort)
789 ;; (throw 'found files)
791 ;; (setq dir (file-name-directory
792 ;; (directory-file-name dir))))
796 (defun locate-dominating-file (file name)
797 "Look up the directory hierarchy from FILE for a file named NAME.
798 Stop at the first parent directory containing a file NAME,
799 and return the directory. Return nil if not found."
800 ;; We used to use the above locate-dominating-files code, but the
801 ;; directory-files call is very costly, so we're much better off doing
802 ;; multiple calls using the code in here.
804 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
805 ;; `name' in /home or in /.
806 (setq file (abbreviate-file-name file))
809 ;; `user' is not initialized outside the loop because
810 ;; `file' may not exist, so we may have to walk up part of the
811 ;; hierarchy before we find the "initial UID".
816 ;; FIXME: Disabled this heuristic because it is sometimes
818 ;; As a heuristic, we stop looking up the hierarchy of
819 ;; directories as soon as we find a directory belonging
820 ;; to another user. This should save us from looking in
821 ;; things like /net and /afs. This assumes that all the
822 ;; files inside a project belong to the same user.
823 ;; (let ((prev-user user))
824 ;; (setq user (nth 2 (file-attributes file)))
825 ;; (and prev-user (not (equal user prev-user))))
826 (string-match locate-dominating-stop-dir-regexp file)))
827 (setq try (file-exists-p (expand-file-name name file)))
828 (cond (try (setq root file))
829 ((equal file (setq prev-file file
830 file (file-name-directory
831 (directory-file-name file))))
836 (defun executable-find (command)
837 "Search for COMMAND in `exec-path' and return the absolute file name.
838 Return nil if COMMAND is not found anywhere in `exec-path'."
839 ;; Use 1 rather than file-executable-p to better match the behavior of
841 (locate-file command exec-path exec-suffixes 1))
843 (defun load-library (library)
844 "Load the Emacs Lisp library named LIBRARY.
845 This is an interface to the function `load'. LIBRARY is searched
846 for in `load-path', both with and without `load-suffixes' (as
847 well as `load-file-rep-suffixes').
849 See Info node `(emacs)Lisp Libraries' for more details.
850 See `load-file' for a different interface to `load'."
852 (list (completing-read "Load library: "
853 (apply-partially 'locate-file-completion-table
855 (get-load-suffixes)))))
858 (defun file-remote-p (file &optional identification connected)
859 "Test whether FILE specifies a location on a remote system.
860 Returns nil or a string identifying the remote connection (ideally
861 a prefix of FILE). For example, the remote identification for filename
862 \"/user@host:/foo\" could be \"/user@host:\".
863 A file is considered \"remote\" if accessing it is likely to be slower or
864 less reliable than accessing local files.
865 Furthermore, relative file names do not work across remote connections.
867 IDENTIFICATION specifies which part of the identification shall
868 be returned as string. IDENTIFICATION can be the symbol
869 `method', `user', `host' or `localname'; any other value is
870 handled like nil and means to return the complete identification
873 If CONNECTED is non-nil, the function returns an identification only
874 if FILE is located on a remote system, and a connection is established
875 to that remote system.
877 `file-remote-p' will never open a connection on its own."
878 (let ((handler (find-file-name-handler file 'file-remote-p)))
880 (funcall handler 'file-remote-p file identification connected)
883 (defun file-local-copy (file)
884 "Copy the file FILE into a temporary file on this machine.
885 Returns the name of the local copy, or nil, if FILE is directly
887 ;; This formerly had an optional BUFFER argument that wasn't used by
889 (let ((handler (find-file-name-handler file 'file-local-copy)))
891 (funcall handler 'file-local-copy file)
894 (defun file-truename (filename &optional counter prev-dirs)
895 "Return the truename of FILENAME, which should be absolute.
896 The truename of a file name is found by chasing symbolic links
897 both at the level of the file and at the level of the directories
898 containing it, until no links are left at any level.
900 \(fn FILENAME)" ;; Don't document the optional arguments.
901 ;; COUNTER and PREV-DIRS are only used in recursive calls.
902 ;; COUNTER can be a cons cell whose car is the count of how many
903 ;; more links to chase before getting an error.
904 ;; PREV-DIRS can be a cons cell whose car is an alist
905 ;; of truenames we've just recently computed.
906 (cond ((or (string= filename "") (string= filename "~"))
907 (setq filename (expand-file-name filename))
908 (if (string= filename "")
909 (setq filename "/")))
910 ((and (string= (substring filename 0 1) "~")
911 (string-match "~[^/]*/?" filename))
913 (substring filename 0 (match-end 0)))
914 (rest (substring filename (match-end 0))))
915 (setq filename (concat (expand-file-name first-part) rest)))))
917 (or counter (setq counter (list 100)))
919 ;; For speed, remove the ange-ftp completion handler from the list.
920 ;; We know it's not needed here.
921 ;; For even more speed, do this only on the outermost call.
922 (file-name-handler-alist
923 (if prev-dirs file-name-handler-alist
924 (let ((tem (copy-sequence file-name-handler-alist)))
925 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
926 (or prev-dirs (setq prev-dirs (list nil)))
928 ;; andrewi@harlequin.co.uk - none of the following code (except for
929 ;; invoking the file-name handler) currently applies on Windows
930 ;; (ie. there are no native symlinks), but there is an issue with
931 ;; case differences being ignored by the OS, and short "8.3 DOS"
932 ;; name aliases existing for all files. (The short names are not
933 ;; reported by directory-files, but can be used to refer to files.)
934 ;; It seems appropriate for file-truename to resolve these issues in
935 ;; the most natural way, which on Windows is to call the function
936 ;; `w32-long-file-name' - this returns the exact name of a file as
937 ;; it is stored on disk (expanding short name aliases with the full
938 ;; name in the process).
939 (if (eq system-type 'windows-nt)
940 (let ((handler (find-file-name-handler filename 'file-truename)))
941 ;; For file name that has a special handler, call handler.
942 ;; This is so that ange-ftp can save time by doing a no-op.
944 (setq filename (funcall handler 'file-truename filename))
945 ;; If filename contains a wildcard, newname will be the old name.
946 (unless (string-match "[[*?]" filename)
947 ;; If filename exists, use the long name. If it doesn't exist,
948 ;; drill down until we find a directory that exists, and use
949 ;; the long name of that, with the extra non-existent path
950 ;; components concatenated.
951 (let ((longname (w32-long-file-name filename))
954 (setq filename longname)
955 ;; Include the preceding directory separator in the missing
956 ;; part so subsequent recursion on the rest works.
957 (setq missing (concat "/" (file-name-nondirectory filename)))
958 (let ((length (length missing)))
960 (if (> length (length filename))
962 (substring filename 0 (- length)))))
963 (setq filename (concat (file-truename rest) missing))))))
966 ;; If this file directly leads to a link, process that iteratively
967 ;; so that we don't use lots of stack.
969 (setcar counter (1- (car counter)))
970 (if (< (car counter) 0)
971 (error "Apparent cycle of symbolic links for %s" filename))
972 (let ((handler (find-file-name-handler filename 'file-truename)))
973 ;; For file name that has a special handler, call handler.
974 ;; This is so that ange-ftp can save time by doing a no-op.
976 (setq filename (funcall handler 'file-truename filename)
978 (let ((dir (or (file-name-directory filename) default-directory))
980 ;; Get the truename of the directory.
981 (setq dirfile (directory-file-name dir))
982 ;; If these are equal, we have the (or a) root directory.
983 (or (string= dir dirfile)
984 ;; If this is the same dir we last got the truename for,
985 ;; save time--don't recalculate.
986 (if (assoc dir (car prev-dirs))
987 (setq dir (cdr (assoc dir (car prev-dirs))))
989 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
990 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
992 (if (equal ".." (file-name-nondirectory filename))
994 (directory-file-name (file-name-directory (directory-file-name dir)))
996 (if (equal "." (file-name-nondirectory filename))
997 (setq filename (directory-file-name dir)
999 ;; Put it back on the file name.
1000 (setq filename (concat dir (file-name-nondirectory filename)))
1001 ;; Is the file name the name of a link?
1002 (setq target (file-symlink-p filename))
1004 ;; Yes => chase that link, then start all over
1005 ;; since the link may point to a directory name that uses links.
1006 ;; We can't safely use expand-file-name here
1007 ;; since target might look like foo/../bar where foo
1008 ;; is itself a link. Instead, we handle . and .. above.
1010 (if (file-name-absolute-p target)
1012 (concat dir target))
1015 (setq done t))))))))
1018 (defun file-chase-links (filename &optional limit)
1019 "Chase links in FILENAME until a name that is not a link.
1020 Unlike `file-truename', this does not check whether a parent
1021 directory name is a symbolic link.
1022 If the optional argument LIMIT is a number,
1023 it means chase no more than that many links and then stop."
1024 (let (tem (newname filename)
1026 (while (and (or (null limit) (< count limit))
1027 (setq tem (file-symlink-p newname)))
1029 (if (and (null limit) (= count 100))
1030 (error "Apparent cycle of symbolic links for %s" filename))
1031 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1032 (while (string-match "//+" tem)
1033 (setq tem (replace-match "/" nil nil tem)))
1034 ;; Handle `..' by hand, since it needs to work in the
1035 ;; target of any directory symlink.
1036 ;; This code is not quite complete; it does not handle
1037 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1038 (while (string-match "\\`\\.\\./" tem)
1039 (setq tem (substring tem 3))
1040 (setq newname (expand-file-name newname))
1041 ;; Chase links in the default dir of the symlink.
1044 (directory-file-name (file-name-directory newname))))
1045 ;; Now find the parent of that dir.
1046 (setq newname (file-name-directory newname)))
1047 (setq newname (expand-file-name tem (file-name-directory newname)))
1048 (setq count (1+ count))))
1051 (defun make-temp-file (prefix &optional dir-flag suffix)
1052 "Create a temporary file.
1053 The returned file name (created by appending some random characters at the end
1054 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1055 is guaranteed to point to a newly created empty file.
1056 You can then use `write-region' to write new data into the file.
1058 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1060 If SUFFIX is non-nil, add that at the end of the file name."
1061 (let ((umask (default-file-modes))
1065 ;; Create temp files with strict access rights. It's easy to
1066 ;; loosen them later, whereas it's impossible to close the
1067 ;; time-window of loose permissions otherwise.
1068 (set-default-file-modes ?\700)
1069 (while (condition-case ()
1073 (if (zerop (length prefix))
1074 (file-name-as-directory
1075 temporary-file-directory)
1076 (expand-file-name prefix
1077 temporary-file-directory))))
1079 (setq file (concat file suffix)))
1081 (make-directory file)
1082 (write-region "" nil file nil 'silent nil 'excl))
1084 (file-already-exists t))
1085 ;; the file was somehow created by someone else between
1086 ;; `make-temp-name' and `write-region', let's try again.
1090 (set-default-file-modes umask))))
1092 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1093 "Change the encoding of FILE's name from CODING to NEW-CODING.
1094 The value is a new name of FILE.
1095 Signals a `file-already-exists' error if a file of the new name
1096 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1097 is non-nil. A number as fourth arg means request confirmation if
1098 the new name already exists. This is what happens in interactive
1101 (let ((default-coding (or file-name-coding-system
1102 default-file-name-coding-system))
1103 (filename (read-file-name "Recode filename: " nil nil t))
1104 from-coding to-coding)
1105 (if (and default-coding
1106 ;; We provide the default coding only when it seems that
1107 ;; the filename is correctly decoded by the default
1109 (let ((charsets (find-charset-string filename)))
1110 (and (not (memq 'eight-bit-control charsets))
1111 (not (memq 'eight-bit-graphic charsets)))))
1112 (setq from-coding (read-coding-system
1113 (format "Recode filename %s from (default %s): "
1114 filename default-coding)
1116 (setq from-coding (read-coding-system
1117 (format "Recode filename %s from: " filename))))
1119 ;; We provide the default coding only when a user is going to
1120 ;; change the encoding not from the default coding.
1121 (if (eq from-coding default-coding)
1122 (setq to-coding (read-coding-system
1123 (format "Recode filename %s from %s to: "
1124 filename from-coding)))
1125 (setq to-coding (read-coding-system
1126 (format "Recode filename %s from %s to (default %s): "
1127 filename from-coding default-coding)
1129 (list filename from-coding to-coding)))
1131 (let* ((default-coding (or file-name-coding-system
1132 default-file-name-coding-system))
1133 ;; FILE should have been decoded by DEFAULT-CODING.
1134 (encoded (encode-coding-string file default-coding))
1135 (newname (decode-coding-string encoded coding))
1136 (new-encoded (encode-coding-string newname new-coding))
1137 ;; Suppress further encoding.
1138 (file-name-coding-system nil)
1139 (default-file-name-coding-system nil)
1140 (locale-coding-system nil))
1141 (rename-file encoded new-encoded ok-if-already-exists)
1144 (defcustom confirm-nonexistent-file-or-buffer 'after-completion
1145 "Whether confirmation is requested before visiting a new file or buffer.
1146 If nil, confirmation is not requested.
1147 If the value is `after-completion', confirmation is only
1148 requested if the user called `minibuffer-complete' right before
1149 `minibuffer-complete-and-exit'.
1150 Any other non-nil value means to request confirmation.
1152 This affects commands like `switch-to-buffer' and `find-file'."
1155 :type '(choice (const :tag "After completion" after-completion)
1156 (const :tag "Never" nil)
1157 (other :tag "Always" t)))
1159 (defun confirm-nonexistent-file-or-buffer ()
1160 "Whether to request confirmation before visiting a new file or buffer.
1161 The variable `confirm-nonexistent-file-or-buffer' determines the
1162 return value, which may be passed as the REQUIRE-MATCH arg to
1163 `read-buffer' or `find-file-read-args'."
1164 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1165 'confirm-after-completion)
1166 (confirm-nonexistent-file-or-buffer
1170 (defun read-buffer-to-switch (prompt)
1171 "Read the name of a buffer to switch to and return as a string.
1172 It is intended for `switch-to-buffer' family of commands since they
1173 need to omit the name of current buffer from the list of completions
1174 and default values."
1175 (let ((rbts-completion-table (internal-complete-buffer-except)))
1176 (minibuffer-with-setup-hook
1178 (setq minibuffer-completion-table rbts-completion-table)
1179 ;; Since rbts-completion-table is built dynamically, we
1180 ;; can't just add it to the default value of
1181 ;; icomplete-with-completion-tables, so we add it
1183 (if (and (boundp 'icomplete-with-completion-tables)
1184 (listp icomplete-with-completion-tables))
1185 (set (make-local-variable 'icomplete-with-completion-tables)
1186 (cons rbts-completion-table
1187 icomplete-with-completion-tables))))
1188 (read-buffer prompt (other-buffer (current-buffer))
1189 (confirm-nonexistent-file-or-buffer)))))
1191 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
1192 "Select the buffer specified by BUFFER-OR-NAME in another window.
1193 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1194 nil. Return the buffer switched to.
1196 If called interactively, prompt for the buffer name using the
1197 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1198 determines whether to request confirmation before creating a new
1201 If BUFFER-OR-NAME is a string and does not identify an existing
1202 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1203 nil, switch to the buffer returned by `other-buffer'.
1205 Optional second argument NORECORD non-nil means do not put this
1206 buffer at the front of the list of recently selected ones.
1208 This uses the function `display-buffer' as a subroutine; see its
1209 documentation for additional customization information."
1211 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1212 (let ((pop-up-windows t)
1213 same-window-buffer-names same-window-regexps)
1214 (pop-to-buffer buffer-or-name t norecord)))
1216 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
1217 "Switch to buffer BUFFER-OR-NAME in another frame.
1218 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1219 nil. Return the buffer switched to.
1221 If called interactively, prompt for the buffer name using the
1222 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1223 determines whether to request confirmation before creating a new
1226 If BUFFER-OR-NAME is a string and does not identify an existing
1227 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1228 nil, switch to the buffer returned by `other-buffer'.
1230 Optional second arg NORECORD non-nil means do not put this
1231 buffer at the front of the list of recently selected ones.
1233 This uses the function `display-buffer' as a subroutine; see its
1234 documentation for additional customization information."
1236 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1237 (let ((pop-up-frames t)
1238 same-window-buffer-names same-window-regexps)
1239 (pop-to-buffer buffer-or-name t norecord)))
1241 (defun display-buffer-other-frame (buffer)
1242 "Display buffer BUFFER in another frame.
1243 This uses the function `display-buffer' as a subroutine; see
1244 its documentation for additional customization information."
1245 (interactive "BDisplay buffer in other frame: ")
1246 (let ((pop-up-frames t)
1247 same-window-buffer-names same-window-regexps
1248 (old-window (selected-window))
1250 (setq new-window (display-buffer buffer t))
1251 ;; This may have been here in order to prevent the new frame from hiding
1252 ;; the old frame. But it does more harm than good.
1253 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1254 ;;(lower-frame (window-frame new-window))
1256 ;; This may have been here in order to make sure the old-frame gets the
1257 ;; focus. But not only can it cause an annoying flicker, with some
1258 ;; window-managers it just makes the window invisible, with no easy
1259 ;; way to recover it. --Stef
1260 ;;(make-frame-invisible (window-frame old-window))
1261 ;;(make-frame-visible (window-frame old-window))
1264 (defvar find-file-default nil
1265 "Used within `find-file-read-args'.")
1267 (defmacro minibuffer-with-setup-hook (fun &rest body)
1268 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1269 BODY should use the minibuffer at most once.
1270 Recursive uses of the minibuffer will not be affected."
1271 (declare (indent 1) (debug t))
1272 (let ((hook (make-symbol "setup-hook")))
1276 ;; Clear out this hook so it does not interfere
1277 ;; with any recursive minibuffer usage.
1278 (remove-hook 'minibuffer-setup-hook ,hook)
1282 (add-hook 'minibuffer-setup-hook ,hook)
1284 (remove-hook 'minibuffer-setup-hook ,hook)))))
1286 (defun find-file-read-args (prompt mustmatch)
1287 (list (let ((find-file-default
1288 (and buffer-file-name
1289 (abbreviate-file-name buffer-file-name))))
1290 (minibuffer-with-setup-hook
1291 (lambda () (setq minibuffer-default find-file-default))
1292 (read-file-name prompt nil default-directory mustmatch)))
1295 (defun find-file (filename &optional wildcards)
1296 "Edit file FILENAME.
1297 Switch to a buffer visiting file FILENAME,
1298 creating one if none already exists.
1299 Interactively, the default if you just type RET is the current directory,
1300 but the visited file name is available through the minibuffer history:
1301 type M-n to pull it into the minibuffer.
1303 You can visit files on remote machines by specifying something
1304 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1305 also visit local files as a different user by specifying
1306 /sudo::FILE for the file name.
1307 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1308 manual, for more about this.
1310 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1311 expand wildcards (if any) and visit multiple files. You can
1312 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1314 To visit a file without any kind of conversion and without
1315 automatically choosing a major mode, use \\[find-file-literally]."
1317 (find-file-read-args "Find file: "
1318 (confirm-nonexistent-file-or-buffer)))
1319 (let ((value (find-file-noselect filename nil nil wildcards)))
1321 (mapcar 'switch-to-buffer (nreverse value))
1322 (switch-to-buffer value))))
1324 (defun find-file-other-window (filename &optional wildcards)
1325 "Edit file FILENAME, in another window.
1327 Like \\[find-file] (which see), but creates a new window or reuses
1328 an existing one. See the function `display-buffer'.
1330 Interactively, the default if you just type RET is the current directory,
1331 but the visited file name is available through the minibuffer history:
1332 type M-n to pull it into the minibuffer.
1334 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1335 expand wildcards (if any) and visit multiple files."
1337 (find-file-read-args "Find file in other window: "
1338 (confirm-nonexistent-file-or-buffer)))
1339 (let ((value (find-file-noselect filename nil nil wildcards)))
1342 (setq value (nreverse value))
1343 (cons (switch-to-buffer-other-window (car value))
1344 (mapcar 'switch-to-buffer (cdr value))))
1345 (switch-to-buffer-other-window value))))
1347 (defun find-file-other-frame (filename &optional wildcards)
1348 "Edit file FILENAME, in another frame.
1350 Like \\[find-file] (which see), but creates a new frame or reuses
1351 an existing one. See the function `display-buffer'.
1353 Interactively, the default if you just type RET is the current directory,
1354 but the visited file name is available through the minibuffer history:
1355 type M-n to pull it into the minibuffer.
1357 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1358 expand wildcards (if any) and visit multiple files."
1360 (find-file-read-args "Find file in other frame: "
1361 (confirm-nonexistent-file-or-buffer)))
1362 (let ((value (find-file-noselect filename nil nil wildcards)))
1365 (setq value (nreverse value))
1366 (cons (switch-to-buffer-other-frame (car value))
1367 (mapcar 'switch-to-buffer (cdr value))))
1368 (switch-to-buffer-other-frame value))))
1370 (defun find-file-existing (filename)
1371 "Edit the existing file FILENAME.
1372 Like \\[find-file], but only allow a file that exists, and do not allow
1373 file names with wildcards."
1374 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1375 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1376 (error "%s does not exist" filename)
1377 (find-file filename)
1380 (defun find-file-read-only (filename &optional wildcards)
1381 "Edit file FILENAME but don't allow changes.
1382 Like \\[find-file], but marks buffer as read-only.
1383 Use \\[toggle-read-only] to permit editing."
1385 (find-file-read-args "Find file read-only: "
1386 (confirm-nonexistent-file-or-buffer)))
1387 (unless (or (and wildcards find-file-wildcards
1388 (not (string-match "\\`/:" filename))
1389 (string-match "[[*?]" filename))
1390 (file-exists-p filename))
1391 (error "%s does not exist" filename))
1392 (let ((value (find-file filename wildcards)))
1393 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1394 (if (listp value) value (list value)))
1397 (defun find-file-read-only-other-window (filename &optional wildcards)
1398 "Edit file FILENAME in another window but don't allow changes.
1399 Like \\[find-file-other-window], but marks buffer as read-only.
1400 Use \\[toggle-read-only] to permit editing."
1402 (find-file-read-args "Find file read-only other window: "
1403 (confirm-nonexistent-file-or-buffer)))
1404 (unless (or (and wildcards find-file-wildcards
1405 (not (string-match "\\`/:" filename))
1406 (string-match "[[*?]" filename))
1407 (file-exists-p filename))
1408 (error "%s does not exist" filename))
1409 (let ((value (find-file-other-window filename wildcards)))
1410 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1411 (if (listp value) value (list value)))
1414 (defun find-file-read-only-other-frame (filename &optional wildcards)
1415 "Edit file FILENAME in another frame but don't allow changes.
1416 Like \\[find-file-other-frame], but marks buffer as read-only.
1417 Use \\[toggle-read-only] to permit editing."
1419 (find-file-read-args "Find file read-only other frame: "
1420 (confirm-nonexistent-file-or-buffer)))
1421 (unless (or (and wildcards find-file-wildcards
1422 (not (string-match "\\`/:" filename))
1423 (string-match "[[*?]" filename))
1424 (file-exists-p filename))
1425 (error "%s does not exist" filename))
1426 (let ((value (find-file-other-frame filename wildcards)))
1427 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1428 (if (listp value) value (list value)))
1431 (defun find-alternate-file-other-window (filename &optional wildcards)
1432 "Find file FILENAME as a replacement for the file in the next window.
1433 This command does not select that window.
1435 See \\[find-file] for the possible forms of the FILENAME argument.
1437 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1438 expand wildcards (if any) and replace the file with multiple files."
1440 (save-selected-window
1442 (let ((file buffer-file-name)
1446 (setq file-name (file-name-nondirectory file)
1447 file-dir (file-name-directory file)))
1448 (list (read-file-name
1449 "Find alternate file: " file-dir nil
1450 (confirm-nonexistent-file-or-buffer) file-name)
1453 (find-file-other-window filename wildcards)
1454 (save-selected-window
1456 (find-alternate-file filename wildcards))))
1458 (defun find-alternate-file (filename &optional wildcards)
1459 "Find file FILENAME, select its buffer, kill previous buffer.
1460 If the current buffer now contains an empty file that you just visited
1461 \(presumably by mistake), use this command to visit the file you really want.
1463 See \\[find-file] for the possible forms of the FILENAME argument.
1465 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1466 expand wildcards (if any) and replace the file with multiple files.
1468 If the current buffer is an indirect buffer, or the base buffer
1469 for one or more indirect buffers, the other buffer(s) are not
1472 (let ((file buffer-file-name)
1476 (setq file-name (file-name-nondirectory file)
1477 file-dir (file-name-directory file)))
1478 (list (read-file-name
1479 "Find alternate file: " file-dir nil
1480 (confirm-nonexistent-file-or-buffer) file-name)
1482 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1484 (when (and (buffer-modified-p) buffer-file-name)
1485 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1488 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1489 (error "Aborted"))))
1490 (let ((obuf (current-buffer))
1491 (ofile buffer-file-name)
1492 (onum buffer-file-number)
1493 (odir dired-directory)
1494 (otrue buffer-file-truename)
1495 (oname (buffer-name)))
1496 ;; Run `kill-buffer-hook' here. It needs to happen before
1497 ;; variables like `buffer-file-name' etc are set to nil below,
1498 ;; because some of the hooks that could be invoked
1499 ;; (e.g., `save-place-to-alist') depend on those variables.
1501 ;; Note that `kill-buffer-hook' is not what queries whether to
1502 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1503 ;; asks that itself. Thus, there's no need to temporarily do
1504 ;; `(set-buffer-modified-p nil)' before running this hook.
1505 (run-hooks 'kill-buffer-hook)
1506 ;; Okay, now we can end-of-life the old buffer.
1507 (if (get-buffer " **lose**")
1508 (kill-buffer " **lose**"))
1509 (rename-buffer " **lose**")
1513 ;; This prevents us from finding the same buffer
1514 ;; if we specified the same file again.
1515 (setq buffer-file-name nil)
1516 (setq buffer-file-number nil)
1517 (setq buffer-file-truename nil)
1518 ;; Likewise for dired buffers.
1519 (setq dired-directory nil)
1520 (find-file filename wildcards))
1521 (when (eq obuf (current-buffer))
1522 ;; This executes if find-file gets an error
1523 ;; and does not really find anything.
1524 ;; We put things back as they were.
1525 ;; If find-file actually finds something, we kill obuf below.
1526 (setq buffer-file-name ofile)
1527 (setq buffer-file-number onum)
1528 (setq buffer-file-truename otrue)
1529 (setq dired-directory odir)
1531 (rename-buffer oname)))
1532 (unless (eq (current-buffer) obuf)
1533 (with-current-buffer obuf
1534 ;; We already ran these; don't run them again.
1535 (let (kill-buffer-query-functions kill-buffer-hook)
1536 (kill-buffer obuf))))))
1538 (defun create-file-buffer (filename)
1539 "Create a suitably named buffer for visiting FILENAME, and return it.
1540 FILENAME (sans directory) is used unchanged if that name is free;
1541 otherwise a string <2> or <3> or ... is appended to get an unused name.
1542 Spaces at the start of FILENAME (sans directory) are removed."
1543 (let ((lastname (file-name-nondirectory filename)))
1544 (if (string= lastname "")
1545 (setq lastname filename))
1547 (string-match "^ *\\(.*\\)" lastname)
1548 (generate-new-buffer (match-string 1 lastname)))))
1550 (defun generate-new-buffer (name)
1551 "Create and return a buffer with a name based on NAME.
1552 Choose the buffer's name using `generate-new-buffer-name'."
1553 (get-buffer-create (generate-new-buffer-name name)))
1555 (defcustom automount-dir-prefix "^/tmp_mnt/"
1556 "Regexp to match the automounter prefix in a directory name."
1560 (defvar abbreviated-home-dir nil
1561 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1563 (defun abbreviate-file-name (filename)
1564 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1565 This also substitutes \"~\" for the user's home directory (unless the
1566 home directory is a root directory) and removes automounter prefixes
1567 \(see the variable `automount-dir-prefix')."
1568 ;; Get rid of the prefixes added by the automounter.
1570 (if (and automount-dir-prefix
1571 (string-match automount-dir-prefix filename)
1572 (file-exists-p (file-name-directory
1573 (substring filename (1- (match-end 0))))))
1574 (setq filename (substring filename (1- (match-end 0)))))
1575 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1576 ;; To fix this right, we need a `file-name-case-sensitive-p'
1577 ;; function, but we don't have that yet, so just guess.
1578 (let ((case-fold-search
1579 (memq system-type '(ms-dos windows-nt darwin cygwin))))
1580 ;; If any elt of directory-abbrev-alist matches this name,
1581 ;; abbreviate accordingly.
1582 (dolist (dir-abbrev directory-abbrev-alist)
1583 (if (string-match (car dir-abbrev) filename)
1585 (concat (cdr dir-abbrev)
1586 (substring filename (match-end 0))))))
1587 ;; Compute and save the abbreviated homedir name.
1588 ;; We defer computing this until the first time it's needed, to
1589 ;; give time for directory-abbrev-alist to be set properly.
1590 ;; We include a slash at the end, to avoid spurious matches
1591 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1592 (or abbreviated-home-dir
1593 (setq abbreviated-home-dir
1594 (let ((abbreviated-home-dir "$foo"))
1595 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1598 ;; If FILENAME starts with the abbreviated homedir,
1599 ;; make it start with `~' instead.
1600 (if (and (string-match abbreviated-home-dir filename)
1601 ;; If the home dir is just /, don't change it.
1602 (not (and (= (match-end 0) 1)
1603 (= (aref filename 0) ?/)))
1604 ;; MS-DOS root directories can come with a drive letter;
1605 ;; Novell Netware allows drive letters beyond `Z:'.
1606 (not (and (or (eq system-type 'ms-dos)
1607 (eq system-type 'cygwin)
1608 (eq system-type 'windows-nt))
1610 (string-match "^[a-zA-`]:/$" filename)))))
1613 (match-string 1 filename)
1614 (substring filename (match-end 0)))))
1617 (defcustom find-file-not-true-dirname-list nil
1618 "List of logical names for which visiting shouldn't save the true dirname."
1619 :type '(repeat (string :tag "Name"))
1622 (defun find-buffer-visiting (filename &optional predicate)
1623 "Return the buffer visiting file FILENAME (a string).
1624 This is like `get-file-buffer', except that it checks for any buffer
1625 visiting the same file, possibly under a different name.
1626 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1627 and others are ignored.
1628 If there is no such live buffer, return nil."
1629 (let ((predicate (or predicate #'identity))
1630 (truename (abbreviate-file-name (file-truename filename))))
1631 (or (let ((buf (get-file-buffer filename)))
1632 (when (and buf (funcall predicate buf)) buf))
1633 (let ((list (buffer-list)) found)
1634 (while (and (not found) list)
1636 (set-buffer (car list))
1637 (if (and buffer-file-name
1638 (string= buffer-file-truename truename)
1639 (funcall predicate (current-buffer)))
1640 (setq found (car list))))
1641 (setq list (cdr list)))
1643 (let* ((attributes (file-attributes truename))
1644 (number (nthcdr 10 attributes))
1645 (list (buffer-list)) found)
1646 (and buffer-file-numbers-unique
1647 (car-safe number) ;Make sure the inode is not just nil.
1648 (while (and (not found) list)
1649 (with-current-buffer (car list)
1650 (if (and buffer-file-name
1651 (equal buffer-file-number number)
1652 ;; Verify this buffer's file number
1653 ;; still belongs to its file.
1654 (file-exists-p buffer-file-name)
1655 (equal (file-attributes buffer-file-truename)
1657 (funcall predicate (current-buffer)))
1658 (setq found (car list))))
1659 (setq list (cdr list))))
1662 (defcustom find-file-wildcards t
1663 "Non-nil means file-visiting commands should handle wildcards.
1664 For example, if you specify `*.c', that would visit all the files
1665 whose names match the pattern."
1670 (defcustom find-file-suppress-same-file-warnings nil
1671 "Non-nil means suppress warning messages for symlinked files.
1672 When nil, Emacs prints a warning when visiting a file that is already
1673 visited, but with a different name. Setting this option to t
1674 suppresses this warning."
1679 (defcustom large-file-warning-threshold 10000000
1680 "Maximum size of file above which a confirmation is requested.
1681 When nil, never request confirmation."
1685 :type '(choice integer (const :tag "Never request confirmation" nil)))
1687 (defun abort-if-file-too-large (size op-type filename)
1688 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1689 OP-TYPE specifies the file operation being performed (for message to user)."
1690 (when (and large-file-warning-threshold size
1691 (> size large-file-warning-threshold)
1693 (format "File %s is large (%dMB), really %s? "
1694 (file-name-nondirectory filename)
1695 (/ size 1048576) op-type))))
1698 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1699 "Read file FILENAME into a buffer and return the buffer.
1700 If a buffer exists visiting FILENAME, return that one, but
1701 verify that the file has not changed since visited or saved.
1702 The buffer is not selected, just returned to the caller.
1703 Optional second arg NOWARN non-nil means suppress any warning messages.
1704 Optional third arg RAWFILE non-nil means the file is read literally.
1705 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1706 and visit all the matching files. When wildcards are actually
1707 used and expanded, return a list of buffers that are visiting
1710 (abbreviate-file-name
1711 (expand-file-name filename)))
1712 (if (file-directory-p filename)
1713 (or (and find-file-run-dired
1714 (run-hook-with-args-until-success
1715 'find-directory-functions
1716 (if find-file-visit-truename
1717 (abbreviate-file-name (file-truename filename))
1719 (error "%s is a directory" filename))
1722 (not (string-match "\\`/:" filename))
1723 (string-match "[[*?]" filename))
1724 (let ((files (condition-case nil
1725 (file-expand-wildcards filename t)
1726 (error (list filename))))
1727 (find-file-wildcards nil))
1729 (find-file-noselect filename)
1730 (mapcar #'find-file-noselect files)))
1731 (let* ((buf (get-file-buffer filename))
1732 (truename (abbreviate-file-name (file-truename filename)))
1733 (attributes (file-attributes truename))
1734 (number (nthcdr 10 attributes))
1735 ;; Find any buffer for a file which has same truename.
1736 (other (and (not buf) (find-buffer-visiting filename))))
1737 ;; Let user know if there is a buffer with the same truename.
1741 find-file-suppress-same-file-warnings
1742 (string-equal filename (buffer-file-name other))
1743 (message "%s and %s are the same file"
1744 filename (buffer-file-name other)))
1745 ;; Optionally also find that buffer.
1746 (if (or find-file-existing-other-name find-file-visit-truename)
1748 ;; Check to see if the file looks uncommonly large.
1749 (when (not (or buf nowarn))
1750 (abort-if-file-too-large (nth 7 attributes) "open" filename))
1752 ;; We are using an existing buffer.
1755 (verify-visited-file-modtime buf)
1756 (cond ((not (file-exists-p filename))
1757 (setq nonexistent t)
1758 (message "File %s no longer exists!" filename))
1759 ;; Certain files should be reverted automatically
1760 ;; if they have changed on disk and not in the buffer.
1761 ((and (not (buffer-modified-p buf))
1762 (let ((tail revert-without-query)
1765 (if (string-match (car tail) filename)
1767 (setq tail (cdr tail)))
1769 (with-current-buffer buf
1770 (message "Reverting file %s..." filename)
1772 (message "Reverting file %s...done" filename)))
1774 (if (string= (file-name-nondirectory filename)
1777 (if (buffer-modified-p buf)
1778 "File %s changed on disk. Discard your edits? "
1779 "File %s changed on disk. Reread from disk? ")
1780 (file-name-nondirectory filename))
1782 (if (buffer-modified-p buf)
1783 "File %s changed on disk. Discard your edits in %s? "
1784 "File %s changed on disk. Reread from disk into %s? ")
1785 (file-name-nondirectory filename)
1786 (buffer-name buf))))
1787 (with-current-buffer buf
1788 (revert-buffer t t)))))
1789 (with-current-buffer buf
1791 ;; Check if a formerly read-only file has become
1792 ;; writable and vice versa, but if the buffer agrees
1793 ;; with the new state of the file, that is ok too.
1794 (let ((read-only (not (file-writable-p buffer-file-name))))
1795 (unless (or nonexistent
1796 (eq read-only buffer-file-read-only)
1797 (eq read-only buffer-read-only))
1800 (format "File %s is %s on disk. Change buffer mode? "
1802 (if read-only "read-only" "writable"))))
1803 (y-or-n-p question)))
1804 (setq buffer-read-only read-only)))
1805 (setq buffer-file-read-only read-only))
1807 (when (and (not (eq (not (null rawfile))
1808 (not (null find-file-literally))))
1810 ;; It is confusing to ask whether to visit
1811 ;; non-literally if they have the file in
1813 (not (eq major-mode 'hexl-mode)))
1814 (if (buffer-modified-p)
1818 "The file %s is already visited normally,
1819 and you have edited the buffer. Now you have asked to visit it literally,
1820 meaning no coding system handling, format conversion, or local variables.
1821 Emacs can only visit a file in one way at a time.
1823 Do you want to save the file, and visit it literally instead? "
1824 "The file %s is already visited literally,
1825 meaning no coding system handling, format conversion, or local variables.
1826 You have edited the buffer. Now you have asked to visit the file normally,
1827 but Emacs can only visit a file in one way at a time.
1829 Do you want to save the file, and visit it normally instead? ")
1830 (file-name-nondirectory filename)))
1833 (find-file-noselect-1 buf filename nowarn
1834 rawfile truename number))
1839 Do you want to discard your changes, and visit the file literally now? "
1841 Do you want to discard your changes, and visit the file normally now? ")))
1842 (find-file-noselect-1 buf filename nowarn
1843 rawfile truename number)
1844 (error (if rawfile "File already visited non-literally"
1845 "File already visited literally"))))
1849 "The file %s is already visited normally.
1850 You have asked to visit it literally,
1851 meaning no coding system decoding, format conversion, or local variables.
1852 But Emacs can only visit a file in one way at a time.
1854 Do you want to revisit the file literally now? "
1855 "The file %s is already visited literally,
1856 meaning no coding system decoding, format conversion, or local variables.
1857 You have asked to visit it normally,
1858 but Emacs can only visit a file in one way at a time.
1860 Do you want to revisit the file normally now? ")
1861 (file-name-nondirectory filename)))
1862 (find-file-noselect-1 buf filename nowarn
1863 rawfile truename number)
1864 (error (if rawfile "File already visited non-literally"
1865 "File already visited literally"))))))
1866 ;; Return the buffer we are using.
1868 ;; Create a new buffer.
1869 (setq buf (create-file-buffer filename))
1870 ;; find-file-noselect-1 may use a different buffer.
1871 (find-file-noselect-1 buf filename nowarn
1872 rawfile truename number))))))
1874 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1876 (with-current-buffer buf
1877 (kill-local-variable 'find-file-literally)
1878 ;; Needed in case we are re-visiting the file with a different
1879 ;; text representation.
1880 (kill-local-variable 'buffer-file-coding-system)
1881 (kill-local-variable 'cursor-type)
1882 (let ((inhibit-read-only t))
1884 (and (default-value 'enable-multibyte-characters)
1886 (set-buffer-multibyte t))
1889 (let ((inhibit-read-only t))
1890 (insert-file-contents-literally filename t))
1892 (when (and (file-exists-p filename)
1893 (not (file-readable-p filename)))
1895 (signal 'file-error (list "File is not readable"
1897 ;; Unconditionally set error
1900 (let ((inhibit-read-only t))
1901 (insert-file-contents filename t))
1903 (when (and (file-exists-p filename)
1904 (not (file-readable-p filename)))
1906 (signal 'file-error (list "File is not readable"
1908 ;; Run find-file-not-found-functions until one returns non-nil.
1909 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1910 ;; If they fail too, set error.
1912 ;; Record the file's truename, and maybe use that as visited name.
1913 (if (equal filename buffer-file-name)
1914 (setq buffer-file-truename truename)
1915 (setq buffer-file-truename
1916 (abbreviate-file-name (file-truename buffer-file-name))))
1917 (setq buffer-file-number number)
1918 (if find-file-visit-truename
1919 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1920 ;; Set buffer's default directory to that of the file.
1921 (setq default-directory (file-name-directory buffer-file-name))
1922 ;; Turn off backup files for certain file names. Since
1923 ;; this is a permanent local, the major mode won't eliminate it.
1924 (and backup-enable-predicate
1925 (not (funcall backup-enable-predicate buffer-file-name))
1927 (make-local-variable 'backup-inhibited)
1928 (setq backup-inhibited t)))
1931 (set-buffer-multibyte nil)
1932 (setq buffer-file-coding-system 'no-conversion)
1933 (set-buffer-major-mode buf)
1934 (make-local-variable 'find-file-literally)
1935 (setq find-file-literally t))
1936 (after-find-file error (not nowarn)))
1939 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1940 "Like `insert-file-contents', but only reads in the file literally.
1941 A buffer may be modified in several ways after reading into the buffer,
1942 to Emacs features such as format decoding, character code
1943 conversion, `find-file-hook', automatic uncompression, etc.
1945 This function ensures that none of these modifications will take place."
1946 (let ((format-alist nil)
1947 (after-insert-file-functions nil)
1948 (coding-system-for-read 'no-conversion)
1949 (coding-system-for-write 'no-conversion)
1950 (find-buffer-file-type-function
1951 (if (fboundp 'find-buffer-file-type)
1952 (symbol-function 'find-buffer-file-type)
1954 (inhibit-file-name-handlers
1955 (append '(jka-compr-handler image-file-handler epa-file-handler)
1956 inhibit-file-name-handlers))
1957 (inhibit-file-name-operation 'insert-file-contents))
1960 (fset 'find-buffer-file-type (lambda (filename) t))
1961 (insert-file-contents filename visit beg end replace))
1962 (if find-buffer-file-type-function
1963 (fset 'find-buffer-file-type find-buffer-file-type-function)
1964 (fmakunbound 'find-buffer-file-type)))))
1966 (defun insert-file-1 (filename insert-func)
1967 (if (file-directory-p filename)
1968 (signal 'file-error (list "Opening input file" "file is a directory"
1970 ;; Check whether the file is uncommonly large
1971 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename)
1972 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1973 #'buffer-modified-p))
1974 (tem (funcall insert-func filename)))
1975 (push-mark (+ (point) (car (cdr tem))))
1977 (message "File %s already visited and modified in buffer %s"
1978 filename (buffer-name buffer)))))
1980 (defun insert-file-literally (filename)
1981 "Insert contents of file FILENAME into buffer after point with no conversion.
1983 This function is meant for the user to run interactively.
1984 Don't call it from programs! Use `insert-file-contents-literally' instead.
1985 \(Its calling sequence is different; see its documentation)."
1986 (interactive "*fInsert file literally: ")
1987 (insert-file-1 filename #'insert-file-contents-literally))
1989 (defvar find-file-literally nil
1990 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1991 This is a permanent local.")
1992 (put 'find-file-literally 'permanent-local t)
1994 (defun find-file-literally (filename)
1995 "Visit file FILENAME with no conversion of any kind.
1996 Format conversion and character code conversion are both disabled,
1997 and multibyte characters are disabled in the resulting buffer.
1998 The major mode used is Fundamental mode regardless of the file name,
1999 and local variable specifications in the file are ignored.
2000 Automatic uncompression and adding a newline at the end of the
2001 file due to `require-final-newline' is also disabled.
2003 You cannot absolutely rely on this function to result in
2004 visiting the file literally. If Emacs already has a buffer
2005 which is visiting the file, you get the existing buffer,
2006 regardless of whether it was created literally or not.
2008 In a Lisp program, if you want to be sure of accessing a file's
2009 contents literally, you should create a temporary buffer and then read
2010 the file contents into it using `insert-file-contents-literally'."
2011 (interactive "FFind file literally: ")
2012 (switch-to-buffer (find-file-noselect filename nil t)))
2014 (defvar after-find-file-from-revert-buffer nil)
2016 (defun after-find-file (&optional error warn noauto
2017 after-find-file-from-revert-buffer
2019 "Called after finding a file and by the default revert function.
2020 Sets buffer mode, parses local variables.
2021 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2022 error in reading the file. WARN non-nil means warn if there
2023 exists an auto-save file more recent than the visited file.
2024 NOAUTO means don't mess with auto-save mode.
2025 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2026 means this call was from `revert-buffer'.
2027 Fifth arg NOMODES non-nil means don't alter the file's modes.
2028 Finishes by calling the functions in `find-file-hook'
2029 unless NOMODES is non-nil."
2030 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
2037 ((and error (file-attributes buffer-file-name))
2038 (setq buffer-read-only t)
2039 "File exists, but cannot be read")
2040 ((not buffer-read-only)
2042 ;; No need to warn if buffer is auto-saved
2043 ;; under the name of the visited file.
2044 (not (and buffer-file-name
2045 auto-save-visited-file-name))
2046 (file-newer-than-file-p (or buffer-auto-save-file-name
2047 (make-auto-save-file-name))
2049 (format "%s has auto save data; consider M-x recover-this-file"
2050 (file-name-nondirectory buffer-file-name))
2051 (setq not-serious t)
2052 (if error "(New file)" nil)))
2054 (setq not-serious t)
2055 "Note: file is write protected")
2056 ((file-attributes (directory-file-name default-directory))
2057 "File not found and directory write-protected")
2058 ((file-exists-p (file-name-directory buffer-file-name))
2059 (setq buffer-read-only nil))
2061 (setq buffer-read-only nil)
2062 "Use M-x make-directory RET RET to create the directory and its parents"))))
2065 (or not-serious (sit-for 1 t))))
2066 (when (and auto-save-default (not noauto))
2067 (auto-save-mode t)))
2068 ;; Make people do a little extra work (C-x C-q)
2069 ;; before altering a backup file.
2070 (when (backup-file-name-p buffer-file-name)
2071 (setq buffer-read-only t))
2072 ;; When a file is marked read-only,
2073 ;; make the buffer read-only even if root is looking at it.
2074 (when (and (file-modes (buffer-file-name))
2075 (zerop (logand (file-modes (buffer-file-name)) #o222)))
2076 (setq buffer-read-only t))
2078 (when (and view-read-only view-mode)
2079 (view-mode-disable))
2081 ;; If requested, add a newline at the end of the file.
2082 (and (memq require-final-newline '(visit visit-save))
2083 (> (point-max) (point-min))
2084 (/= (char-after (1- (point-max))) ?\n)
2085 (not (and (eq selective-display t)
2086 (= (char-after (1- (point-max))) ?\r)))
2088 (goto-char (point-max))
2090 (when (and buffer-read-only
2092 (not (eq (get major-mode 'mode-class) 'special)))
2094 (run-hooks 'find-file-hook)))
2096 (defmacro report-errors (format &rest body)
2097 "Eval BODY and turn any error into a FORMAT message.
2098 FORMAT can have a %s escape which will be replaced with the actual error.
2099 If `debug-on-error' is set, errors are not caught, so that you can
2101 Avoid using a large BODY since it is duplicated."
2102 (declare (debug t) (indent 1))
2107 (error (message ,format (prin1-to-string err))))))
2109 (defun normal-mode (&optional find-file)
2110 "Choose the major mode for this buffer automatically.
2111 Also sets up any specified local variables of the file.
2112 Uses the visited file name, the -*- line, and the local variables spec.
2114 This function is called automatically from `find-file'. In that case,
2115 we may set up the file-specified mode and local variables,
2116 depending on the value of `enable-local-variables'.
2117 In addition, if `local-enable-local-variables' is nil, we do
2118 not set local variables (though we do notice a mode specified with -*-.)
2120 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2121 or from Lisp without specifying the optional argument FIND-FILE;
2122 in that case, this function acts as if `enable-local-variables' were t."
2124 (funcall (or (default-value 'major-mode) 'fundamental-mode))
2125 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2126 (report-errors "File mode specification error: %s"
2128 (report-errors "File local-variables error: %s"
2129 (hack-local-variables)))
2130 ;; Turn font lock off and on, to make sure it takes account of
2131 ;; whatever file local variables are relevant to it.
2132 (when (and font-lock-mode
2133 ;; Font-lock-mode (now in font-core.el) can be ON when
2134 ;; font-lock.el still hasn't been loaded.
2135 (boundp 'font-lock-keywords)
2136 (eq (car font-lock-keywords) t))
2137 (setq font-lock-keywords (cadr font-lock-keywords))
2140 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2141 (ucs-set-table-for-input)))
2143 (defcustom auto-mode-case-fold nil
2144 "Non-nil means to try second pass through `auto-mode-alist'.
2145 This means that if the first case-sensitive search through the alist fails
2146 to find a matching major mode, a second case-insensitive search is made.
2147 On systems with case-insensitive file names, this variable is ignored,
2148 since only a single case-insensitive search through the alist is made."
2153 (defvar auto-mode-alist
2154 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2155 ;; c++-mode, java-mode and more) are added through autoload
2156 ;; directives in that file. That way is discouraged since it
2157 ;; spreads out the definition of the initial value.
2160 (cons (purecopy (car elt)) (cdr elt)))
2161 `(;; do this first, so that .html.pl is Polish html, not Perl
2162 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2163 ("\\.te?xt\\'" . text-mode)
2164 ("\\.[tT]e[xX]\\'" . tex-mode)
2165 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2166 ("\\.ltx\\'" . latex-mode)
2167 ("\\.dtx\\'" . doctex-mode)
2168 ("\\.org\\'" . org-mode)
2169 ("\\.el\\'" . emacs-lisp-mode)
2170 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2171 ("\\.l\\'" . lisp-mode)
2172 ("\\.li?sp\\'" . lisp-mode)
2173 ("\\.[fF]\\'" . fortran-mode)
2174 ("\\.for\\'" . fortran-mode)
2175 ("\\.p\\'" . pascal-mode)
2176 ("\\.pas\\'" . pascal-mode)
2177 ("\\.ad[abs]\\'" . ada-mode)
2178 ("\\.ad[bs].dg\\'" . ada-mode)
2179 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2180 ("Imakefile\\'" . makefile-imake-mode)
2181 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2182 ("\\.makepp\\'" . makefile-makepp-mode)
2183 ,@(if (memq system-type '(berkeley-unix darwin))
2184 '(("\\.mk\\'" . makefile-bsdmake-mode)
2185 ("GNUmakefile\\'" . makefile-gmake-mode)
2186 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2187 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2188 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2189 ("\\.am\\'" . makefile-automake-mode)
2190 ;; Less common extensions come here
2191 ;; so more common ones above are found faster.
2192 ("\\.texinfo\\'" . texinfo-mode)
2193 ("\\.te?xi\\'" . texinfo-mode)
2194 ("\\.[sS]\\'" . asm-mode)
2195 ("\\.asm\\'" . asm-mode)
2196 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2197 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2198 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2199 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2200 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2201 ("\\.bash\\'" . sh-mode)
2202 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2203 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2204 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2205 ("\\.m?spec\\'" . sh-mode)
2206 ("\\.m[mes]\\'" . nroff-mode)
2207 ("\\.man\\'" . nroff-mode)
2208 ("\\.sty\\'" . latex-mode)
2209 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2210 ("\\.bbl\\'" . latex-mode)
2211 ("\\.bib\\'" . bibtex-mode)
2212 ("\\.sql\\'" . sql-mode)
2213 ("\\.m[4c]\\'" . m4-mode)
2214 ("\\.mf\\'" . metafont-mode)
2215 ("\\.mp\\'" . metapost-mode)
2216 ("\\.vhdl?\\'" . vhdl-mode)
2217 ("\\.article\\'" . text-mode)
2218 ("\\.letter\\'" . text-mode)
2219 ("\\.i?tcl\\'" . tcl-mode)
2220 ("\\.exp\\'" . tcl-mode)
2221 ("\\.itk\\'" . tcl-mode)
2222 ("\\.icn\\'" . icon-mode)
2223 ("\\.sim\\'" . simula-mode)
2224 ("\\.mss\\'" . scribe-mode)
2225 ("\\.f9[05]\\'" . f90-mode)
2226 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2227 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2228 ("\\.prolog\\'" . prolog-mode)
2229 ("\\.tar\\'" . tar-mode)
2230 ;; The list of archive file extensions should be in sync with
2231 ;; `auto-coding-alist' with `no-conversion' coding system.
2233 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2234 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2235 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org
2236 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
2237 ;; Mailer puts message to be edited in
2238 ;; /tmp/Re.... or Message
2239 ("\\`/tmp/Re" . text-mode)
2240 ("/Message[0-9]*\\'" . text-mode)
2241 ("\\.zone\\'" . zone-mode)
2242 ;; some news reader is reported to use this
2243 ("\\`/tmp/fol/" . text-mode)
2244 ("\\.oak\\'" . scheme-mode)
2245 ("\\.sgml?\\'" . sgml-mode)
2246 ("\\.x[ms]l\\'" . xml-mode)
2247 ("\\.dtd\\'" . sgml-mode)
2248 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2249 ("\\.js\\'" . js-mode) ; javascript-mode would be better
2250 ("\\.[ds]?v\\'" . verilog-mode)
2251 ;; .emacs or .gnus or .viper following a directory delimiter in
2252 ;; Unix, MSDOG or VMS syntax.
2253 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2254 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2255 ;; _emacs following a directory delimiter
2257 ("[:/]_emacs\\'" . emacs-lisp-mode)
2258 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2259 ("\\.ml\\'" . lisp-mode)
2260 ;; Common Lisp ASDF package system.
2261 ("\\.asd\\'" . lisp-mode)
2262 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2263 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2264 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2265 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2266 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2267 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2268 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2269 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2270 ("BROWSE\\'" . ebrowse-tree-mode)
2271 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2272 ("#\\*mail\\*" . mail-mode)
2273 ("\\.g\\'" . antlr-mode)
2274 ("\\.ses\\'" . ses-mode)
2275 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2276 ("\\.docbook\\'" . sgml-mode)
2277 ("\\.com\\'" . dcl-mode)
2278 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2279 ;; Windows candidates may be opened case sensitively on Unix
2280 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2281 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2282 ("\\.ppd\\'" . conf-ppd-mode)
2283 ("java.+\\.conf\\'" . conf-javaprop-mode)
2284 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2285 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2286 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2287 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2288 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2289 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2290 ;; this has lower priority to avoid matching changelog.sgml etc.
2291 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2292 ;; either user's dot-files or under /etc or some such
2293 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2294 ;; alas not all ~/.*rc files are like this
2295 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2296 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2297 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2298 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2299 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2300 ;; this contains everything twice, with space and with colon :-(
2301 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2302 ;; Get rid of any trailing .n.m and try again.
2303 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2304 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2305 ;; Using mode nil rather than `ignore' would let the search continue
2306 ;; through this list (with the shortened name) rather than start over.
2307 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2308 ;; The following should come after the ChangeLog pattern
2309 ;; for the sake of ChangeLog.1, etc.
2310 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2311 ("\\.[1-9]\\'" . nroff-mode)
2312 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2313 "Alist of filename patterns vs corresponding major mode functions.
2314 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2315 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2316 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2317 mode function to use. FUNCTION will be called, unless it is nil.
2319 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2320 calling FUNCTION (if it's not nil), we delete the suffix that matched
2321 REGEXP and search the list again for another match.
2323 If the file name matches `inhibit-first-line-modes-regexps',
2324 then `auto-mode-alist' is not processed.
2326 The extensions whose FUNCTION is `archive-mode' should also
2327 appear in `auto-coding-alist' with `no-conversion' coding system.
2329 See also `interpreter-mode-alist', which detects executable script modes
2330 based on the interpreters they specify to run,
2331 and `magic-mode-alist', which determines modes based on file contents.")
2332 (put 'auto-mode-alist 'risky-local-variable t)
2334 (defun conf-mode-maybe ()
2335 "Select Conf mode or XML mode according to start of file."
2339 (goto-char (point-min))
2340 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2344 (defvar interpreter-mode-alist
2345 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2346 ;; and pike-mode) are added through autoload directives in that
2347 ;; file. That way is discouraged since it spreads out the
2348 ;; definition of the initial value.
2351 (cons (purecopy (car l)) (cdr l)))
2352 '(("perl" . perl-mode)
2353 ("perl5" . perl-mode)
2354 ("miniperl" . perl-mode)
2356 ("wishx" . tcl-mode)
2358 ("tclsh" . tcl-mode)
2359 ("scm" . scheme-mode)
2379 ("tail" . text-mode)
2380 ("more" . text-mode)
2381 ("less" . text-mode)
2383 ("make" . makefile-gmake-mode) ; Debian uses this
2384 ("guile" . scheme-mode)
2385 ("clisp" . lisp-mode)))
2386 "Alist mapping interpreter names to major modes.
2387 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2388 Each element looks like (INTERPRETER . MODE).
2389 If INTERPRETER matches the name of the interpreter specified in the first line
2390 of a script, mode MODE is enabled.
2392 See also `auto-mode-alist'.")
2394 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2395 "List of regexps; if one matches a file name, don't look for `-*-'.")
2397 (defvar inhibit-first-line-modes-suffixes nil
2398 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2399 When checking `inhibit-first-line-modes-regexps', we first discard
2400 from the end of the file name anything that matches one of these regexps.")
2402 (defvar auto-mode-interpreter-regexp
2403 "#![ \t]?\\([^ \t\n]*\
2404 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2405 "Regexp matching interpreters, for file mode determination.
2406 This regular expression is matched against the first line of a file
2407 to determine the file's mode in `set-auto-mode'. If it matches, the file
2408 is assumed to be interpreted by the interpreter matched by the second group
2409 of the regular expression. The mode is then determined as the mode
2410 associated with that interpreter in `interpreter-mode-alist'.")
2412 (defvar magic-mode-alist nil
2413 "Alist of buffer beginnings vs. corresponding major mode functions.
2414 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2415 After visiting a file, if REGEXP matches the text at the beginning of the
2416 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2417 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2420 If FUNCTION is nil, then it is not called. (That is a way of saying
2421 \"allow `auto-mode-alist' to decide for these files.\")")
2422 (put 'magic-mode-alist 'risky-local-variable t)
2424 (defvar magic-fallback-mode-alist
2425 `((image-type-auto-detected-p . image-mode)
2426 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
2427 ;; The < comes before the groups (but the first) to reduce backtracking.
2428 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2429 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2430 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2431 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2432 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2434 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2435 "[Hh][Tt][Mm][Ll]"))
2437 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2438 ;; These two must come after html, because they are more general:
2439 ("<\\?xml " . xml-mode)
2440 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2441 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2442 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2445 ("# xmcd " . conf-unix-mode))
2446 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2447 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2448 After visiting a file, if REGEXP matches the text at the beginning of the
2449 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2450 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2451 have not specified a mode for this file.
2453 If FUNCTION is nil, then it is not called.")
2454 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2456 (defvar magic-mode-regexp-match-limit 4000
2457 "Upper limit on `magic-mode-alist' regexp matches.
2458 Also applies to `magic-fallback-mode-alist'.")
2460 (defun set-auto-mode (&optional keep-mode-if-same)
2461 "Select major mode appropriate for current buffer.
2463 To find the right major mode, this function checks for a -*- mode tag,
2464 checks if it uses an interpreter listed in `interpreter-mode-alist',
2465 matches the buffer beginning against `magic-mode-alist',
2466 compares the filename against the entries in `auto-mode-alist',
2467 then matches the buffer beginning against `magic-fallback-mode-alist'.
2469 It does not check for the `mode:' local variable in the
2470 Local Variables section of the file; for that, use `hack-local-variables'.
2472 If `enable-local-variables' is nil, this function does not check for a
2475 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2476 set the major mode only if that would change it. In other words
2477 we don't actually set it to the same mode the buffer already has."
2478 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2479 (let (end done mode modes)
2480 ;; Find a -*- mode tag
2482 (goto-char (point-min))
2483 (skip-chars-forward " \t\n")
2484 (and enable-local-variables
2485 (setq end (set-auto-mode-1))
2486 (if (save-excursion (search-forward ":" end t))
2487 ;; Find all specifications for the `mode:' variable
2488 ;; and execute them left to right.
2489 (while (let ((case-fold-search t))
2490 (or (and (looking-at "mode:")
2491 (goto-char (match-end 0)))
2492 (re-search-forward "[ \t;]mode:" end t)))
2493 (skip-chars-forward " \t")
2494 (let ((beg (point)))
2495 (if (search-forward ";" end t)
2498 (skip-chars-backward " \t")
2499 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2501 ;; Simple -*-MODE-*- case.
2502 (push (intern (concat (downcase (buffer-substring (point) end))
2505 ;; If we found modes to use, invoke them now, outside the save-excursion.
2508 (dolist (mode (nreverse modes))
2509 (if (not (functionp mode))
2510 (message "Ignoring unknown mode `%s'" mode)
2512 (or (set-auto-mode-0 mode keep-mode-if-same)
2513 ;; continuing would call minor modes again, toggling them off
2514 (throw 'nop nil))))))
2515 ;; If we didn't, look for an interpreter specified in the first line.
2516 ;; As a special case, allow for things like "#!/bin/env perl", which
2517 ;; finds the interpreter anywhere in $PATH.
2519 (setq mode (save-excursion
2520 (goto-char (point-min))
2521 (if (looking-at auto-mode-interpreter-regexp)
2524 ;; Map interpreter name to a mode, signalling we're done at the
2526 done (assoc (file-name-nondirectory mode)
2527 interpreter-mode-alist))
2528 ;; If we found an interpreter mode to use, invoke it now.
2530 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2531 ;; Next try matching the buffer beginning against magic-mode-alist.
2533 (if (setq done (save-excursion
2534 (goto-char (point-min))
2536 (narrow-to-region (point-min)
2538 (+ (point-min) magic-mode-regexp-match-limit)))
2539 (assoc-default nil magic-mode-alist
2543 (looking-at re)))))))
2544 (set-auto-mode-0 done keep-mode-if-same)))
2545 ;; Next compare the filename against the entries in auto-mode-alist.
2547 (if buffer-file-name
2548 (let ((name buffer-file-name)
2549 (remote-id (file-remote-p buffer-file-name)))
2550 ;; Remove remote file name identification.
2551 (when (and (stringp remote-id)
2552 (string-match (regexp-quote remote-id) name))
2553 (setq name (substring name (match-end 0))))
2554 ;; Remove backup-suffixes from file name.
2555 (setq name (file-name-sans-versions name))
2557 ;; Find first matching alist entry.
2559 (if (memq system-type '(windows-nt cygwin))
2560 ;; System is case-insensitive.
2561 (let ((case-fold-search t))
2562 (assoc-default name auto-mode-alist
2564 ;; System is case-sensitive.
2566 ;; First match case-sensitively.
2567 (let ((case-fold-search nil))
2568 (assoc-default name auto-mode-alist
2570 ;; Fallback to case-insensitive match.
2571 (and auto-mode-case-fold
2572 (let ((case-fold-search t))
2573 (assoc-default name auto-mode-alist
2578 (setq mode (car mode)
2579 name (substring name 0 (match-beginning 0)))
2582 (set-auto-mode-0 mode keep-mode-if-same)
2584 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2586 (if (setq done (save-excursion
2587 (goto-char (point-min))
2589 (narrow-to-region (point-min)
2591 (+ (point-min) magic-mode-regexp-match-limit)))
2592 (assoc-default nil magic-fallback-mode-alist
2596 (looking-at re)))))))
2597 (set-auto-mode-0 done keep-mode-if-same)))))
2599 ;; When `keep-mode-if-same' is set, we are working on behalf of
2600 ;; set-visited-file-name. In that case, if the major mode specified is the
2601 ;; same one we already have, don't actually reset it. We don't want to lose
2602 ;; minor modes such as Font Lock.
2603 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2604 "Apply MODE and return it.
2605 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2606 any aliases and compared to current major mode. If they are the
2607 same, do nothing and return nil."
2608 (unless (and keep-mode-if-same
2609 (eq (indirect-function mode)
2610 (indirect-function major-mode)))
2615 (defun set-auto-mode-1 ()
2616 "Find the -*- spec in the buffer.
2617 Call with point at the place to start searching from.
2618 If one is found, set point to the beginning
2619 and return the position of the end.
2620 Otherwise, return nil; point may be changed."
2623 ;; Don't look for -*- if this file name matches any
2624 ;; of the regexps in inhibit-first-line-modes-regexps.
2625 (let ((temp inhibit-first-line-modes-regexps)
2626 (name (if buffer-file-name
2627 (file-name-sans-versions buffer-file-name)
2629 (while (let ((sufs inhibit-first-line-modes-suffixes))
2630 (while (and sufs (not (string-match (car sufs) name)))
2631 (setq sufs (cdr sufs)))
2633 (setq name (substring name 0 (match-beginning 0))))
2635 (not (string-match (car temp) name)))
2636 (setq temp (cdr temp)))
2639 (search-forward "-*-" (line-end-position
2640 ;; If the file begins with "#!"
2641 ;; (exec interpreter magic), look
2642 ;; for mode frobs in the first two
2643 ;; lines. You cannot necessarily
2644 ;; put them in the first line of
2645 ;; such a file without screwing up
2646 ;; the interpreter invocation.
2647 ;; The same holds for
2649 ;; in man pages (preprocessor
2650 ;; magic for the `man' program).
2651 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2653 (skip-chars-forward " \t")
2655 (search-forward "-*-" (line-end-position) t))
2658 (skip-chars-backward " \t")
2663 ;;; Handling file local variables
2665 (defvar ignored-local-variables
2666 '(ignored-local-variables safe-local-variable-values
2667 file-local-variables-alist dir-local-variables-alist)
2668 "Variables to be ignored in a file's local variable spec.")
2669 (put 'ignored-local-variables 'risky-local-variable t)
2671 (defvar hack-local-variables-hook nil
2672 "Normal hook run after processing a file's local variables specs.
2673 Major modes can use this to examine user-specified local variables
2674 in order to initialize other data structure based on them.")
2676 (defcustom safe-local-variable-values nil
2677 "List variable-value pairs that are considered safe.
2678 Each element is a cons cell (VAR . VAL), where VAR is a variable
2679 symbol and VAL is a value that is considered safe."
2684 (defcustom safe-local-eval-forms '((add-hook 'write-file-hooks 'time-stamp))
2685 "Expressions that are considered safe in an `eval:' local variable.
2686 Add expressions to this list if you want Emacs to evaluate them, when
2687 they appear in an `eval' local variable specification, without first
2688 asking you for confirmation."
2692 :type '(repeat sexp))
2694 ;; Risky local variables:
2695 (mapc (lambda (var) (put var 'risky-local-variable t))
2697 buffer-auto-save-file-name
2699 buffer-file-truename
2702 default-text-properties
2706 file-name-handler-alist
2715 minor-mode-map-alist
2716 minor-mode-overriding-map-alist
2719 overriding-local-map
2720 overriding-terminal-local-map
2724 unread-command-events))
2726 ;; Safe local variables:
2728 ;; For variables defined by major modes, the safety declarations can go into
2729 ;; the major mode's file, since that will be loaded before file variables are
2732 ;; For variables defined by minor modes, put the safety declarations in the
2733 ;; file defining the minor mode after the defcustom/defvar using an autoload
2736 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2738 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2739 ;; minor mode file may not be loaded yet.
2741 ;; For variables defined in the C source code the declaration should go here:
2743 (mapc (lambda (pair)
2744 (put (car pair) 'safe-local-variable (cdr pair)))
2745 '((buffer-read-only . booleanp) ;; C source code
2746 (default-directory . stringp) ;; C source code
2747 (fill-column . integerp) ;; C source code
2748 (indent-tabs-mode . booleanp) ;; C source code
2749 (left-margin . integerp) ;; C source code
2750 (no-update-autoloads . booleanp)
2751 (tab-width . integerp) ;; C source code
2752 (truncate-lines . booleanp))) ;; C source code
2754 (put 'c-set-style 'safe-local-eval-function t)
2756 (defvar file-local-variables-alist nil
2757 "Alist of file-local variable settings in the current buffer.
2758 Each element in this list has the form (VAR . VALUE), where VAR
2759 is a file-local variable (a symbol) and VALUE is the value
2760 specified. The actual value in the buffer may differ from VALUE,
2761 if it is changed by the major or minor modes, or by the user.")
2762 (make-variable-buffer-local 'file-local-variables-alist)
2764 (defvar dir-local-variables-alist nil
2765 "Alist of directory-local variable settings in the current buffer.
2766 Each element in this list has the form (VAR . VALUE), where VAR
2767 is a directory-local variable (a symbol) and VALUE is the value
2768 specified in .dir-locals.el. The actual value in the buffer
2769 may differ from VALUE, if it is changed by the major or minor modes,
2771 (make-variable-buffer-local 'dir-local-variables-alist)
2773 (defvar before-hack-local-variables-hook nil
2774 "Normal hook run before setting file-local variables.
2775 It is called after checking for unsafe/risky variables and
2776 setting `file-local-variables-alist', and before applying the
2777 variables stored in `file-local-variables-alist'. A hook
2778 function is allowed to change the contents of this alist.
2780 This hook is called only if there is at least one file-local
2783 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2784 "Get confirmation before setting up local variable values.
2785 ALL-VARS is the list of all variables to be set up.
2786 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2787 RISKY-VARS is the list of those that are marked as risky.
2788 DIR-NAME is a directory name if these settings come from
2789 directory-local variables, or nil otherwise."
2792 (let ((name (or dir-name
2793 (if buffer-file-name
2794 (file-name-nondirectory buffer-file-name)
2795 (concat "buffer " (buffer-name)))))
2796 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2798 (save-window-excursion
2799 (let ((buf (get-buffer-create "*Local Variables*")))
2801 (set (make-local-variable 'cursor-type) nil)
2804 (insert "The local variables list in " name
2805 "\ncontains values that may not be safe (*)"
2807 ", and variables that are risky (**)."
2810 (insert "The local variables list in " name
2811 "\ncontains variables that are risky (**).")
2812 (insert "A local variables list is specified in " name ".")))
2813 (insert "\n\nDo you want to apply it? You can type
2814 y -- to apply the local variables list.
2815 n -- to ignore the local variables list.")
2818 ! -- to apply the local variables list, and permanently mark these
2819 values (*) as safe (in the future, they will be set automatically.)\n\n")
2821 (dolist (elt all-vars)
2822 (cond ((member elt unsafe-vars)
2824 ((member elt risky-vars)
2828 (princ (car elt) buf)
2830 ;; Make strings with embedded whitespace easier to read.
2831 (let ((print-escape-newlines t))
2832 (prin1 (cdr elt) buf))
2835 (format "Please type %s%s: "
2836 (if offer-save "y, n, or !" "y or n")
2837 (if (< (line-number-at-pos) (window-body-height))
2839 ", or C-v to scroll")))
2840 (goto-char (point-min))
2841 (let ((cursor-in-echo-area t)
2842 (executing-kbd-macro executing-kbd-macro)
2844 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2847 (message "%s" prompt)
2848 (setq char (read-event))
2850 (cond ((eq char ?\C-v)
2853 (error (goto-char (point-min)))))
2854 ;; read-event returns -1 if we are in a kbd
2855 ;; macro and there are no more events in the
2856 ;; macro. In that case, attempt to get an
2857 ;; event interactively.
2858 ((and executing-kbd-macro (= char -1))
2859 (setq executing-kbd-macro nil))
2860 (t (setq done (memq (downcase char) exit-chars)))))))
2861 (setq char (downcase char))
2862 (when (and offer-save (= char ?!) unsafe-vars)
2863 (dolist (elt unsafe-vars)
2864 (add-to-list 'safe-local-variable-values elt))
2865 ;; When this is called from desktop-restore-file-buffer,
2866 ;; coding-system-for-read may be non-nil. Reset it before
2867 ;; writing to .emacs.
2868 (if (or custom-file user-init-file)
2869 (let ((coding-system-for-read nil))
2870 (customize-save-variable
2871 'safe-local-variable-values
2872 safe-local-variable-values))))
2878 (defun hack-local-variables-prop-line (&optional mode-only)
2879 "Return local variables specified in the -*- line.
2880 Ignore any specification for `mode:' and `coding:';
2881 `set-auto-mode' should already have handled `mode:',
2882 `set-auto-coding' should already have handled `coding:'.
2884 If MODE-ONLY is non-nil, all we do is check whether the major
2885 mode is specified, returning t if it is specified. Otherwise,
2886 return an alist of elements (VAR . VAL), where VAR is a variable
2887 and VAL is the specified value."
2889 (goto-char (point-min))
2890 (let ((end (set-auto-mode-1))
2891 result mode-specified)
2892 ;; Parse the -*- line into the RESULT alist.
2893 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2896 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2897 ;; Simple form: "-*- MODENAME -*-". Already handled.
2898 (setq mode-specified t)
2901 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2902 ;; (last ";" is optional).
2903 (while (< (point) end)
2904 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2905 (error "Malformed -*- line"))
2906 (goto-char (match-end 0))
2907 ;; There used to be a downcase here,
2908 ;; but the manual didn't say so,
2909 ;; and people want to set var names that aren't all lc.
2910 (let ((key (intern (match-string 1)))
2911 (val (save-restriction
2912 (narrow-to-region (point) end)
2913 (let ((read-circle nil))
2914 (read (current-buffer))))))
2915 ;; It is traditional to ignore
2916 ;; case when checking for `mode' in set-auto-mode,
2917 ;; so we must do that here as well.
2918 ;; That is inconsistent, but we're stuck with it.
2919 ;; The same can be said for `coding' in set-auto-coding.
2920 (or (and (equal (downcase (symbol-name key)) "mode")
2921 (setq mode-specified t))
2922 (equal (downcase (symbol-name key)) "coding")
2924 (push (cons (if (eq key 'eval)
2926 (indirect-variable key))
2929 (skip-chars-forward " \t;")))))
2935 (defun hack-local-variables-filter (variables dir-name)
2936 "Filter local variable settings, querying the user if necessary.
2937 VARIABLES is the alist of variable-value settings. This alist is
2938 filtered based on the values of `ignored-local-variables',
2939 `enable-local-eval', `enable-local-variables', and (if necessary)
2940 user interaction. The results are added to
2941 `file-local-variables-alist', without applying them.
2942 DIR-NAME is a directory name if these settings come from
2943 directory-local variables, or nil otherwise."
2944 ;; Find those variables that we may want to save to
2945 ;; `safe-local-variable-values'.
2946 (let (all-vars risky-vars unsafe-vars)
2947 (dolist (elt variables)
2948 (let ((var (car elt))
2950 (cond ((memq var ignored-local-variables)
2951 ;; Ignore any variable in `ignored-local-variables'.
2953 ;; Obey `enable-local-eval'.
2955 (when enable-local-eval
2957 (or (eq enable-local-eval t)
2958 (hack-one-local-variable-eval-safep (eval (quote val)))
2959 (push elt unsafe-vars))))
2960 ;; Ignore duplicates in the present list.
2961 ((assq var all-vars) nil)
2962 ;; Accept known-safe variables.
2963 ((or (memq var '(mode unibyte coding))
2964 (safe-local-variable-p var val))
2965 (push elt all-vars))
2966 ;; The variable is either risky or unsafe:
2967 ((not (eq enable-local-variables :safe))
2969 (if (risky-local-variable-p var val)
2970 (push elt risky-vars)
2971 (push elt unsafe-vars))))))
2973 ;; Query, unless all vars are safe or user wants no querying.
2974 (or (and (eq enable-local-variables t)
2977 (memq enable-local-variables '(:all :safe))
2978 (hack-local-variables-confirm all-vars unsafe-vars
2979 risky-vars dir-name))
2980 (dolist (elt all-vars)
2981 (unless (eq (car elt) 'eval)
2983 (setq dir-local-variables-alist
2984 (assq-delete-all (car elt) dir-local-variables-alist)))
2985 (setq file-local-variables-alist
2986 (assq-delete-all (car elt) file-local-variables-alist)))
2987 (push elt file-local-variables-alist)))))
2989 (defun hack-local-variables (&optional mode-only)
2990 "Parse and put into effect this buffer's local variables spec.
2991 If MODE-ONLY is non-nil, all we do is check whether the major mode
2992 is specified, returning t if it is specified."
2993 (let ((enable-local-variables
2994 (and local-enable-local-variables enable-local-variables))
2997 (setq file-local-variables-alist nil)
2998 (report-errors "Directory-local variables error: %s"
2999 (hack-dir-local-variables)))
3000 (when (or mode-only enable-local-variables)
3001 (setq result (hack-local-variables-prop-line mode-only))
3002 ;; Look for "Local variables:" line in last page.
3004 (goto-char (point-max))
3005 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3007 (when (let ((case-fold-search t))
3008 (search-forward "Local Variables:" nil t))
3009 (skip-chars-forward " \t")
3010 ;; suffix is what comes after "local variables:" in its line.
3011 ;; prefix is what comes before "local variables:" in its line.
3014 (regexp-quote (buffer-substring (point)
3015 (line-end-position)))
3018 (concat "^" (regexp-quote
3019 (buffer-substring (line-beginning-position)
3020 (match-beginning 0)))))
3024 (let ((startpos (point))
3026 (thisbuf (current-buffer)))
3028 (unless (let ((case-fold-search t))
3030 (concat prefix "[ \t]*End:[ \t]*" suffix)
3032 ;; This used to be an error, but really all it means is
3033 ;; that this may simply not be a local-variables section,
3034 ;; so just ignore it.
3035 (message "Local variables list is not properly terminated"))
3037 (setq endpos (point)))
3040 (insert-buffer-substring thisbuf startpos endpos)
3041 (goto-char (point-min))
3042 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3044 ;; Discard the prefix.
3045 (if (looking-at prefix)
3046 (delete-region (point) (match-end 0))
3047 (error "Local variables entry is missing the prefix"))
3049 ;; Discard the suffix.
3050 (if (looking-back suffix)
3051 (delete-region (match-beginning 0) (point))
3052 (error "Local variables entry is missing the suffix"))
3054 (goto-char (point-min))
3057 ;; Find the variable name; strip whitespace.
3058 (skip-chars-forward " \t")
3060 (skip-chars-forward "^:\n")
3061 (if (eolp) (error "Missing colon in local variables entry"))
3062 (skip-chars-backward " \t")
3063 (let* ((str (buffer-substring beg (point)))
3064 (var (let ((read-circle nil))
3067 ;; Read the variable value.
3068 (skip-chars-forward "^:")
3070 (let ((read-circle nil))
3071 (setq val (read (current-buffer))))
3075 (unless (eq var 'coding)
3077 (push (cons (if (eq var 'eval)
3079 (indirect-variable var))
3082 (forward-line 1))))))))
3083 ;; Now we've read all the local variables.
3084 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3085 (cond (mode-only result)
3086 ;; Otherwise, set the variables.
3087 (enable-local-variables
3088 (hack-local-variables-filter result nil)
3089 (when file-local-variables-alist
3090 ;; Any 'evals must run in the Right sequence.
3091 (setq file-local-variables-alist
3092 (nreverse file-local-variables-alist))
3093 (run-hooks 'before-hack-local-variables-hook)
3094 (dolist (elt file-local-variables-alist)
3095 (hack-one-local-variable (car elt) (cdr elt))))
3096 (run-hooks 'hack-local-variables-hook)))))
3098 (defun safe-local-variable-p (sym val)
3099 "Non-nil if SYM is safe as a file-local variable with value VAL.
3100 It is safe if any of these conditions are met:
3102 * There is a matching entry (SYM . VAL) in the
3103 `safe-local-variable-values' user option.
3105 * The `safe-local-variable' property of SYM is a function that
3106 evaluates to a non-nil value with VAL as an argument."
3107 (or (member (cons sym val) safe-local-variable-values)
3108 (let ((safep (get sym 'safe-local-variable)))
3109 (and (functionp safep) (funcall safep val)))))
3111 (defun risky-local-variable-p (sym &optional ignored)
3112 "Non-nil if SYM could be dangerous as a file-local variable.
3113 It is dangerous if either of these conditions are met:
3115 * Its `risky-local-variable' property is non-nil.
3117 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3118 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3119 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3120 \"map-alist\", or \"bindat-spec\"."
3121 ;; If this is an alias, check the base name.
3123 (setq sym (indirect-variable sym))
3125 (or (get sym 'risky-local-variable)
3126 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3127 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3128 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3129 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3131 (defun hack-one-local-variable-quotep (exp)
3132 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3134 (defun hack-one-local-variable-constantp (exp)
3135 (or (and (not (symbolp exp)) (not (consp exp)))
3138 (hack-one-local-variable-quotep exp)))
3140 (defun hack-one-local-variable-eval-safep (exp)
3141 "Return t if it is safe to eval EXP when it is found in a file."
3142 (or (not (consp exp))
3143 ;; Detect certain `put' expressions.
3144 (and (eq (car exp) 'put)
3145 (hack-one-local-variable-quotep (nth 1 exp))
3146 (hack-one-local-variable-quotep (nth 2 exp))
3147 (let ((prop (nth 1 (nth 2 exp)))
3149 (cond ((memq prop '(lisp-indent-hook
3150 lisp-indent-function
3151 scheme-indent-function))
3152 ;; Only allow safe values (not functions).
3154 (and (hack-one-local-variable-quotep val)
3155 (eq (nth 1 val) 'defun))))
3156 ((eq prop 'edebug-form-spec)
3157 ;; Only allow indirect form specs.
3158 ;; During bootstrapping, edebug-basic-spec might not be
3160 (and (fboundp 'edebug-basic-spec)
3161 (hack-one-local-variable-quotep val)
3162 (edebug-basic-spec (nth 1 val)))))))
3163 ;; Allow expressions that the user requested.
3164 (member exp safe-local-eval-forms)
3165 ;; Certain functions can be allowed with safe arguments
3166 ;; or can specify verification functions to try.
3167 (and (symbolp (car exp))
3168 (let ((prop (get (car exp) 'safe-local-eval-function)))
3171 (dolist (arg (cdr exp))
3172 (unless (hack-one-local-variable-constantp arg)
3179 (dolist (function prop)
3180 (if (funcall function exp)
3184 (defun hack-one-local-variable (var val)
3185 "Set local variable VAR with value VAL.
3186 If VAR is `mode', call `VAL-mode' as a function unless it's
3187 already the major mode."
3188 (cond ((eq var 'mode)
3189 (let ((mode (intern (concat (downcase (symbol-name val))
3191 (unless (eq (indirect-function mode)
3192 (indirect-function major-mode))
3193 (if (memq mode minor-mode-list)
3194 ;; A minor mode must be passed an argument.
3195 ;; Otherwise, if the user enables the minor mode in a
3196 ;; major mode hook, this would toggle it off.
3200 (save-excursion (eval val)))
3202 ;; Make sure the string has no text properties.
3203 ;; Some text properties can get evaluated in various ways,
3204 ;; so it is risky to put them on with a local variable list.
3206 (set-text-properties 0 (length val) nil val))
3207 (set (make-local-variable var) val))))
3209 ;;; Handling directory-local variables, aka project settings.
3211 (defvar dir-locals-class-alist '()
3212 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3214 (defvar dir-locals-directory-cache '()
3215 "List of cached directory roots for directory-local variable classes.
3216 Each element in this list has the form (DIR CLASS MTIME).
3217 DIR is the name of the directory.
3218 CLASS is the name of a variable class (a symbol).
3219 MTIME is the recorded modification time of the directory-local
3220 variables file associated with this entry. This time is a list
3221 of two integers (the same format as `file-attributes'), and is
3222 used to test whether the cache entry is still valid.
3223 Alternatively, MTIME can be nil, which means the entry is always
3226 (defsubst dir-locals-get-class-variables (class)
3227 "Return the variable list for CLASS."
3228 (cdr (assq class dir-locals-class-alist)))
3230 (defun dir-locals-collect-mode-variables (mode-variables variables)
3231 "Collect directory-local variables from MODE-VARIABLES.
3232 VARIABLES is the initial list of variables.
3233 Returns the new list."
3234 (dolist (pair mode-variables variables)
3235 (let* ((variable (car pair))
3237 (slot (assq variable variables)))
3238 ;; If variables are specified more than once, only use the last. (Why?)
3239 ;; The pseudo-variables mode and eval are different (bug#3430).
3240 (if (and slot (not (memq variable '(mode eval))))
3242 ;; Need a new cons in case we setcdr later.
3243 (push (cons variable value) variables)))))
3245 (defun dir-locals-collect-variables (class-variables root variables)
3246 "Collect entries from CLASS-VARIABLES into VARIABLES.
3247 ROOT is the root directory of the project.
3248 Return the new variables list."
3249 (let* ((file-name (buffer-file-name))
3250 (sub-file-name (if file-name
3251 (substring file-name (length root)))))
3252 (dolist (entry class-variables variables)
3253 (let ((key (car entry)))
3256 ;; Don't include this in the previous condition, because we
3257 ;; want to filter all strings before the next condition.
3258 (when (and sub-file-name
3259 (>= (length sub-file-name) (length key))
3260 (string= key (substring sub-file-name 0 (length key))))
3261 (setq variables (dir-locals-collect-variables
3262 (cdr entry) root variables))))
3264 (derived-mode-p key))
3265 (setq variables (dir-locals-collect-mode-variables
3266 (cdr entry) variables))))))))
3268 (defun dir-locals-set-directory-class (directory class &optional mtime)
3269 "Declare that the DIRECTORY root is an instance of CLASS.
3270 DIRECTORY is the name of a directory, a string.
3271 CLASS is the name of a project class, a symbol.
3272 MTIME is either the modification time of the directory-local
3273 variables file that defined this class, or nil.
3275 When a file beneath DIRECTORY is visited, the mode-specific
3276 variables from CLASS are applied to the buffer. The variables
3277 for a class are defined using `dir-locals-set-class-variables'."
3278 (setq directory (file-name-as-directory (expand-file-name directory)))
3279 (unless (assq class dir-locals-class-alist)
3280 (error "No such class `%s'" (symbol-name class)))
3281 (push (list directory class mtime) dir-locals-directory-cache))
3283 (defun dir-locals-set-class-variables (class variables)
3284 "Map the type CLASS to a list of variable settings.
3285 CLASS is the project class, a symbol. VARIABLES is a list
3286 that declares directory-local variables for the class.
3287 An element in VARIABLES is either of the form:
3288 (MAJOR-MODE . ALIST)
3292 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3293 whose elements are of the form (VARIABLE . VALUE).
3295 In the second form, DIRECTORY is a directory name (a string), and
3296 LIST is a list of the form accepted by the function.
3298 When a file is visited, the file's class is found. A directory
3299 may be assigned a class using `dir-locals-set-directory-class'.
3300 Then variables are set in the file's buffer according to the
3301 class' LIST. The list is processed in order.
3303 * If the element is of the form (MAJOR-MODE . ALIST), and the
3304 buffer's major mode is derived from MAJOR-MODE (as determined
3305 by `derived-mode-p'), then all the variables in ALIST are
3306 applied. A MAJOR-MODE of nil may be used to match any buffer.
3307 `make-local-variable' is called for each variable before it is
3310 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3311 is an initial substring of the file's directory, then LIST is
3312 applied by recursively following these rules."
3313 (let ((elt (assq class dir-locals-class-alist)))
3315 (setcdr elt variables)
3316 (push (cons class variables) dir-locals-class-alist))))
3318 (defconst dir-locals-file ".dir-locals.el"
3319 "File that contains directory-local variables.
3320 It has to be constant to enforce uniform values
3321 across different environments and users.")
3323 (defun dir-locals-find-file (file)
3324 "Find the directory-local variables for FILE.
3325 This searches upward in the directory tree from FILE.
3326 If the directory root of FILE has been registered in
3327 `dir-locals-directory-cache' and the directory-local variables
3328 file has not been modified, return the matching entry in
3329 `dir-locals-directory-cache'.
3330 Otherwise, if a directory-local variables file is found, return
3332 Otherwise, return nil."
3333 (setq file (expand-file-name file))
3334 (let* ((dir-locals-file-name
3335 (if (eq system-type 'ms-dos)
3336 (dosified-file-name dir-locals-file)
3338 (locals-file (locate-dominating-file file dir-locals-file-name))
3340 ;; `locate-dominating-file' may have abbreviated the name.
3342 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3343 ;; Find the best cached value in `dir-locals-directory-cache'.
3344 (dolist (elt dir-locals-directory-cache)
3345 (when (and (eq t (compare-strings file nil (length (car elt))
3348 '(windows-nt cygwin ms-dos))))
3349 (> (length (car elt)) (length (car dir-elt))))
3350 (setq dir-elt elt)))
3351 (let ((use-cache (and dir-elt
3352 (or (null locals-file)
3353 (<= (length (file-name-directory locals-file))
3354 (length (car dir-elt)))))))
3356 ;; Check the validity of the cache.
3357 (if (and (file-readable-p (car dir-elt))
3358 (or (null (nth 2 dir-elt))
3359 (equal (nth 2 dir-elt)
3360 (nth 5 (file-attributes (car dir-elt))))))
3361 ;; This cache entry is OK.
3363 ;; This cache entry is invalid; clear it.
3364 (setq dir-locals-directory-cache
3365 (delq dir-elt dir-locals-directory-cache))
3369 (defun dir-locals-read-from-file (file)
3370 "Load a variables FILE and register a new class and instance.
3371 FILE is the name of the file holding the variables to apply.
3372 The new class name is the same as the directory in which FILE
3373 is found. Returns the new class name."
3375 (insert-file-contents file)
3376 (let* ((dir-name (file-name-directory file))
3377 (class-name (intern dir-name))
3378 (variables (let ((read-circle nil))
3379 (read (current-buffer)))))
3380 (dir-locals-set-class-variables class-name variables)
3381 (dir-locals-set-directory-class dir-name class-name
3382 (nth 5 (file-attributes file)))
3385 (defun hack-dir-local-variables ()
3386 "Read per-directory local variables for the current buffer.
3387 Store the directory-local variables in `dir-local-variables-alist'
3388 and `file-local-variables-alist', without applying them."
3389 (when (and enable-local-variables
3391 (not (file-remote-p (buffer-file-name))))
3392 ;; Find the variables file.
3393 (let ((variables-file (dir-locals-find-file (buffer-file-name)))
3397 ((stringp variables-file)
3398 (setq dir-name (file-name-directory (buffer-file-name)))
3399 (setq class (dir-locals-read-from-file variables-file)))
3400 ((consp variables-file)
3401 (setq dir-name (nth 0 variables-file))
3402 (setq class (nth 1 variables-file))))
3405 (dir-locals-collect-variables
3406 (dir-locals-get-class-variables class) dir-name nil)))
3408 (dolist (elt variables)
3409 (unless (eq (car elt) 'eval)
3410 (setq dir-local-variables-alist
3411 (assq-delete-all (car elt) dir-local-variables-alist)))
3412 (push elt dir-local-variables-alist))
3413 (hack-local-variables-filter variables dir-name)))))))
3416 (defcustom change-major-mode-with-file-name t
3417 "Non-nil means \\[write-file] should set the major mode from the file name.
3418 However, the mode will not be changed if
3419 \(1) a local variables list or the `-*-' line specifies a major mode, or
3420 \(2) the current major mode is a \"special\" mode,
3421 \ not suitable for ordinary files, or
3422 \(3) the new file name does not particularly specify any mode."
3424 :group 'editing-basics)
3426 (defun set-visited-file-name (filename &optional no-query along-with-file)
3427 "Change name of file visited in current buffer to FILENAME.
3428 This also renames the buffer to correspond to the new file.
3429 The next time the buffer is saved it will go in the newly specified file.
3430 FILENAME nil or an empty string means mark buffer as not visiting any file.
3431 Remember to delete the initial contents of the minibuffer
3432 if you wish to pass an empty string as the argument.
3434 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3435 confirmation in the case where another buffer is already visiting FILENAME.
3437 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3438 the old visited file has been renamed to the new name FILENAME."
3439 (interactive "FSet visited file name: ")
3440 (if (buffer-base-buffer)
3441 (error "An indirect buffer cannot visit a file"))
3445 (if (string-equal filename "")
3447 (expand-file-name filename))))
3450 (setq truename (file-truename filename))
3451 (if find-file-visit-truename
3452 (setq filename truename))))
3454 (let ((new-name (file-name-nondirectory filename)))
3455 (if (string= new-name "")
3456 (error "Empty file name"))))
3457 (let ((buffer (and filename (find-buffer-visiting filename))))
3458 (and buffer (not (eq buffer (current-buffer)))
3460 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3463 (or (equal filename buffer-file-name)
3465 (and filename (lock-buffer filename))
3467 (setq buffer-file-name filename)
3468 (if filename ; make buffer name reflect filename.
3469 (let ((new-name (file-name-nondirectory buffer-file-name)))
3470 (setq default-directory (file-name-directory buffer-file-name))
3471 ;; If new-name == old-name, renaming would add a spurious <2>
3472 ;; and it's considered as a feature in rename-buffer.
3473 (or (string= new-name (buffer-name))
3474 (rename-buffer new-name t))))
3475 (setq buffer-backed-up nil)
3477 (clear-visited-file-modtime))
3478 ;; Abbreviate the file names of the buffer.
3481 (setq buffer-file-truename (abbreviate-file-name truename))
3482 (if find-file-visit-truename
3483 (setq buffer-file-name truename))))
3484 (setq buffer-file-number
3486 (nthcdr 10 (file-attributes buffer-file-name))
3488 ;; write-file-functions is normally used for things like ftp-find-file
3489 ;; that visit things that are not local files as if they were files.
3490 ;; Changing to visit an ordinary local file instead should flush the hook.
3491 (kill-local-variable 'write-file-functions)
3492 (kill-local-variable 'local-write-file-hooks)
3493 (kill-local-variable 'revert-buffer-function)
3494 (kill-local-variable 'backup-inhibited)
3495 ;; If buffer was read-only because of version control,
3496 ;; that reason is gone now, so make it writable.
3498 (setq buffer-read-only nil))
3499 (kill-local-variable 'vc-mode)
3500 ;; Turn off backup files for certain file names.
3501 ;; Since this is a permanent local, the major mode won't eliminate it.
3502 (and buffer-file-name
3503 backup-enable-predicate
3504 (not (funcall backup-enable-predicate buffer-file-name))
3506 (make-local-variable 'backup-inhibited)
3507 (setq backup-inhibited t)))
3508 (let ((oauto buffer-auto-save-file-name))
3509 ;; If auto-save was not already on, turn it on if appropriate.
3510 (if (not buffer-auto-save-file-name)
3511 (and buffer-file-name auto-save-default
3513 ;; If auto save is on, start using a new name.
3514 ;; We deliberately don't rename or delete the old auto save
3515 ;; for the old visited file name. This is because perhaps
3516 ;; the user wants to save the new state and then compare with the
3517 ;; previous state from the auto save file.
3518 (setq buffer-auto-save-file-name
3519 (make-auto-save-file-name)))
3520 ;; Rename the old auto save file if any.
3521 (and oauto buffer-auto-save-file-name
3522 (file-exists-p oauto)
3523 (rename-file oauto buffer-auto-save-file-name t)))
3524 (and buffer-file-name
3525 (not along-with-file)
3526 (set-buffer-modified-p t))
3527 ;; Update the major mode, if the file name determines it.
3529 ;; Don't change the mode if it is special.
3530 (or (not change-major-mode-with-file-name)
3531 (get major-mode 'mode-class)
3532 ;; Don't change the mode if the local variable list specifies it.
3533 (hack-local-variables t)
3537 (defun write-file (filename &optional confirm)
3538 "Write current buffer into file FILENAME.
3539 This makes the buffer visit that file, and marks it as not modified.
3541 If you specify just a directory name as FILENAME, that means to use
3542 the default file name but in that directory. You can also yank
3543 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3545 If the buffer is not already visiting a file, the default file name
3546 for the output file is the buffer name.
3548 If optional second arg CONFIRM is non-nil, this function
3549 asks for confirmation before overwriting an existing file.
3550 Interactively, confirmation is required unless you supply a prefix argument."
3551 ;; (interactive "FWrite file: ")
3553 (list (if buffer-file-name
3554 (read-file-name "Write file: "
3556 (read-file-name "Write file: " default-directory
3558 (file-name-nondirectory (buffer-name))
3561 (not current-prefix-arg)))
3562 (or (null filename) (string-equal filename "")
3564 ;; If arg is just a directory,
3565 ;; use the default file name, but in that directory.
3566 (if (file-directory-p filename)
3567 (setq filename (concat (file-name-as-directory filename)
3568 (file-name-nondirectory
3569 (or buffer-file-name (buffer-name))))))
3571 (file-exists-p filename)
3572 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3573 (error "Canceled")))
3574 (set-visited-file-name filename (not confirm))))
3575 (set-buffer-modified-p t)
3576 ;; Make buffer writable if file is writable.
3577 (and buffer-file-name
3578 (file-writable-p buffer-file-name)
3579 (setq buffer-read-only nil))
3581 ;; It's likely that the VC status at the new location is different from
3582 ;; the one at the old location.
3583 (vc-find-file-hook))
3585 (defun backup-buffer ()
3586 "Make a backup of the disk file visited by the current buffer, if appropriate.
3587 This is normally done before saving the buffer the first time.
3589 A backup may be done by renaming or by copying; see documentation of
3590 variable `make-backup-files'. If it's done by renaming, then the file is
3591 no longer accessible under its old name.
3593 The value is non-nil after a backup was made by renaming.
3594 It has the form (MODES . BACKUPNAME).
3595 MODES is the result of `file-modes' on the original
3596 file; this means that the caller, after saving the buffer, should change
3597 the modes of the new file to agree with the old modes.
3598 BACKUPNAME is the backup file name, which is the old file renamed."
3599 (if (and make-backup-files (not backup-inhibited)
3600 (not buffer-backed-up)
3601 (file-exists-p buffer-file-name)
3602 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3604 (let ((real-file-name buffer-file-name)
3605 backup-info backupname targets setmodes)
3606 ;; If specified name is a symbolic link, chase it to the target.
3607 ;; Thus we make the backups in the directory where the real file is.
3608 (setq real-file-name (file-chase-links real-file-name))
3609 (setq backup-info (find-backup-file-name real-file-name)
3610 backupname (car backup-info)
3611 targets (cdr backup-info))
3612 ;; (if (file-directory-p buffer-file-name)
3613 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3616 (let ((delete-old-versions
3617 ;; If have old versions to maybe delete,
3618 ;; ask the user to confirm now, before doing anything.
3619 ;; But don't actually delete til later.
3621 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3622 (or delete-old-versions
3623 (y-or-n-p (format "Delete excess backup versions of %s? "
3625 (modes (file-modes buffer-file-name)))
3626 ;; Actually write the back up file.
3628 (if (or file-precious-flag
3629 ; (file-symlink-p buffer-file-name)
3631 ;; Don't rename a suid or sgid file.
3632 (and modes (< 0 (logand modes #o6000)))
3633 (not (file-writable-p (file-name-directory real-file-name)))
3634 (and backup-by-copying-when-linked
3635 (> (file-nlinks real-file-name) 1))
3636 (and (or backup-by-copying-when-mismatch
3637 (integerp backup-by-copying-when-privileged-mismatch))
3638 (let ((attr (file-attributes real-file-name)))
3639 (and (or backup-by-copying-when-mismatch
3640 (and (integerp (nth 2 attr))
3641 (integerp backup-by-copying-when-privileged-mismatch)
3642 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3644 (not (file-ownership-preserved-p real-file-name)))))))
3645 (backup-buffer-copy real-file-name backupname modes)
3646 ;; rename-file should delete old backup.
3647 (rename-file real-file-name backupname t)
3648 (setq setmodes (cons modes backupname)))
3650 ;; If trouble writing the backup, write it in ~.
3651 (setq backupname (expand-file-name
3652 (convert-standard-filename
3654 (message "Cannot write backup file; backing up in %s"
3657 (backup-buffer-copy real-file-name backupname modes)))
3658 (setq buffer-backed-up t)
3659 ;; Now delete the old versions, if desired.
3660 (if delete-old-versions
3663 (delete-file (car targets))
3665 (setq targets (cdr targets))))
3667 (file-error nil))))))
3669 (defun backup-buffer-copy (from-name to-name modes)
3670 (let ((umask (default-file-modes)))
3673 ;; Create temp files with strict access rights. It's easy to
3674 ;; loosen them later, whereas it's impossible to close the
3675 ;; time-window of loose permissions otherwise.
3676 (set-default-file-modes ?\700)
3677 (when (condition-case nil
3678 ;; Try to overwrite old backup first.
3679 (copy-file from-name to-name t t t)
3681 (while (condition-case nil
3683 (when (file-exists-p to-name)
3684 (delete-file to-name))
3685 (copy-file from-name to-name nil t t)
3687 (file-already-exists t))
3688 ;; The file was somehow created by someone else between
3689 ;; `delete-file' and `copy-file', so let's try again.
3690 ;; rms says "I think there is also a possible race
3691 ;; condition for making backup files" (emacs-devel 20070821).
3694 (set-default-file-modes umask)))
3696 (set-file-modes to-name (logand modes #o1777))))
3698 (defun file-name-sans-versions (name &optional keep-backup-version)
3699 "Return file NAME sans backup versions or strings.
3700 This is a separate procedure so your site-init or startup file can
3702 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3703 we do not remove backup version numbers, only true file version numbers."
3704 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3706 (funcall handler 'file-name-sans-versions name keep-backup-version)
3708 (if keep-backup-version
3710 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3711 (string-match "~\\'" name)
3714 (defun file-ownership-preserved-p (file)
3715 "Return t if deleting FILE and rewriting it would preserve the owner."
3716 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3718 (funcall handler 'file-ownership-preserved-p file)
3719 (let ((attributes (file-attributes file)))
3720 ;; Return t if the file doesn't exist, since it's true that no
3721 ;; information would be lost by an (attempted) delete and create.
3722 (or (null attributes)
3723 (= (nth 2 attributes) (user-uid)))))))
3725 (defun file-name-sans-extension (filename)
3726 "Return FILENAME sans final \"extension\".
3727 The extension, in a file name, is the part that follows the last `.',
3728 except that a leading `.', if any, doesn't count."
3730 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3732 (if (and (string-match "\\.[^.]*\\'" file)
3733 (not (eq 0 (match-beginning 0))))
3734 (if (setq directory (file-name-directory filename))
3735 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3736 ;; we don't want to expand it.
3737 (concat directory (substring file 0 (match-beginning 0)))
3738 (substring file 0 (match-beginning 0)))
3741 (defun file-name-extension (filename &optional period)
3742 "Return FILENAME's final \"extension\".
3743 The extension, in a file name, is the part that follows the last `.',
3744 excluding version numbers and backup suffixes,
3745 except that a leading `.', if any, doesn't count.
3746 Return nil for extensionless file names such as `foo'.
3747 Return the empty string for file names such as `foo.'.
3749 If PERIOD is non-nil, then the returned value includes the period
3750 that delimits the extension, and if FILENAME has no extension,
3753 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3754 (if (and (string-match "\\.[^.]*\\'" file)
3755 (not (eq 0 (match-beginning 0))))
3756 (substring file (+ (match-beginning 0) (if period 0 1)))
3760 (defcustom make-backup-file-name-function nil
3761 "A function to use instead of the default `make-backup-file-name'.
3762 A value of nil gives the default `make-backup-file-name' behavior.
3764 This could be buffer-local to do something special for specific
3765 files. If you define it, you may need to change `backup-file-name-p'
3766 and `file-name-sans-versions' too.
3768 See also `backup-directory-alist'."
3770 :type '(choice (const :tag "Default" nil)
3771 (function :tag "Your function")))
3773 (defcustom backup-directory-alist nil
3774 "Alist of filename patterns and backup directory names.
3775 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3776 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3777 relative or absolute. If it is absolute, so that all matching files
3778 are backed up into the same directory, the file names in this
3779 directory will be the full name of the file backed up with all
3780 directory separators changed to `!' to prevent clashes. This will not
3781 work correctly if your filesystem truncates the resulting name.
3783 For the common case of all backups going into one directory, the alist
3784 should contain a single element pairing \".\" with the appropriate
3787 If this variable is nil, or it fails to match a filename, the backup
3788 is made in the original file's directory.
3790 On MS-DOS filesystems without long names this variable is always
3793 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3794 (directory :tag "Backup directory name"))))
3796 (defun normal-backup-enable-predicate (name)
3797 "Default `backup-enable-predicate' function.
3798 Checks for files in `temporary-file-directory',
3799 `small-temporary-file-directory', and /tmp."
3800 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3802 ;; Directory is under temporary-file-directory.
3803 (and (not (eq comp t))
3804 (< comp (- (length temporary-file-directory)))))
3805 (let ((comp (compare-strings "/tmp" 0 nil
3807 ;; Directory is under /tmp.
3808 (and (not (eq comp t))
3809 (< comp (- (length "/tmp")))))
3810 (if small-temporary-file-directory
3811 (let ((comp (compare-strings small-temporary-file-directory
3814 ;; Directory is under small-temporary-file-directory.
3815 (and (not (eq comp t))
3816 (< comp (- (length small-temporary-file-directory)))))))))
3818 (defun make-backup-file-name (file)
3819 "Create the non-numeric backup file name for FILE.
3820 Normally this will just be the file's name with `~' appended.
3821 Customization hooks are provided as follows.
3823 If the variable `make-backup-file-name-function' is non-nil, its value
3824 should be a function which will be called with FILE as its argument;
3825 the resulting name is used.
3827 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3828 the documentation of that variable. If the directory for the backup
3829 doesn't exist, it is created."
3830 (if make-backup-file-name-function
3831 (funcall make-backup-file-name-function file)
3832 (if (and (eq system-type 'ms-dos)
3833 (not (msdos-long-file-names)))
3834 (let ((fn (file-name-nondirectory file)))
3835 (concat (file-name-directory file)
3836 (or (and (string-match "\\`[^.]+\\'" fn)
3837 (concat (match-string 0 fn) ".~"))
3838 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3839 (concat (match-string 0 fn) "~")))))
3840 (concat (make-backup-file-name-1 file) "~"))))
3842 (defun make-backup-file-name-1 (file)
3843 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3844 (let ((alist backup-directory-alist)
3845 elt backup-directory abs-backup-directory)
3847 (setq elt (pop alist))
3848 (if (string-match (car elt) file)
3849 (setq backup-directory (cdr elt)
3851 ;; If backup-directory is relative, it should be relative to the
3852 ;; file's directory. By expanding explicitly here, we avoid
3853 ;; depending on default-directory.
3854 (if backup-directory
3855 (setq abs-backup-directory
3856 (expand-file-name backup-directory
3857 (file-name-directory file))))
3858 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3860 (make-directory abs-backup-directory 'parents)
3861 (file-error (setq backup-directory nil
3862 abs-backup-directory nil))))
3863 (if (null backup-directory)
3865 (if (file-name-absolute-p backup-directory)
3867 (when (memq system-type '(windows-nt ms-dos cygwin))
3868 ;; Normalize DOSish file names: downcase the drive
3869 ;; letter, if any, and replace the leading "x:" with
3871 (or (file-name-absolute-p file)
3872 (setq file (expand-file-name file))) ; make defaults explicit
3873 ;; Replace any invalid file-name characters (for the
3874 ;; case of backing up remote files).
3875 (setq file (expand-file-name (convert-standard-filename file)))
3876 (if (eq (aref file 1) ?:)
3877 (setq file (concat "/"
3879 (char-to-string (downcase (aref file 0)))
3880 (if (eq (aref file 2) ?/)
3883 (substring file 2)))))
3884 ;; Make the name unique by substituting directory
3885 ;; separators. It may not really be worth bothering about
3886 ;; doubling `!'s in the original name...
3888 (subst-char-in-string
3890 (replace-regexp-in-string "!" "!!" file))
3892 (expand-file-name (file-name-nondirectory file)
3893 (file-name-as-directory abs-backup-directory))))))
3895 (defun backup-file-name-p (file)
3896 "Return non-nil if FILE is a backup file name (numeric or not).
3897 This is a separate function so you can redefine it for customization.
3898 You may need to redefine `file-name-sans-versions' as well."
3899 (string-match "~\\'" file))
3901 (defvar backup-extract-version-start)
3903 ;; This is used in various files.
3904 ;; The usage of backup-extract-version-start is not very clean,
3905 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3906 (defun backup-extract-version (fn)
3907 "Given the name of a numeric backup file, FN, return the backup number.
3908 Uses the free variable `backup-extract-version-start', whose value should be
3909 the index in the name where the version number begins."
3910 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
3911 (= (match-beginning 0) backup-extract-version-start))
3912 (string-to-number (substring fn backup-extract-version-start -1))
3915 (defun find-backup-file-name (fn)
3916 "Find a file name for a backup file FN, and suggestions for deletions.
3917 Value is a list whose car is the name for the backup file
3918 and whose cdr is a list of old versions to consider deleting now.
3919 If the value is nil, don't make a backup.
3920 Uses `backup-directory-alist' in the same way as does
3921 `make-backup-file-name'."
3922 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3923 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3925 (funcall handler 'find-backup-file-name fn)
3926 (if (or (eq version-control 'never)
3927 ;; We don't support numbered backups on plain MS-DOS
3928 ;; when long file names are unavailable.
3929 (and (eq system-type 'ms-dos)
3930 (not (msdos-long-file-names))))
3931 (list (make-backup-file-name fn))
3932 (let* ((basic-name (make-backup-file-name-1 fn))
3933 (base-versions (concat (file-name-nondirectory basic-name)
3935 (backup-extract-version-start (length base-versions))
3937 (number-to-delete 0)
3938 possibilities deserve-versions-p versions)
3940 (setq possibilities (file-name-all-completions
3942 (file-name-directory basic-name))
3943 versions (sort (mapcar #'backup-extract-version
3946 high-water-mark (apply 'max 0 versions)
3947 deserve-versions-p (or version-control
3948 (> high-water-mark 0))
3949 number-to-delete (- (length versions)
3953 (file-error (setq possibilities nil)))
3954 (if (not deserve-versions-p)
3955 (list (make-backup-file-name fn))
3956 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3957 (if (and (> number-to-delete 0)
3958 ;; Delete nothing if there is overflow
3959 ;; in the number of versions to keep.
3960 (>= (+ kept-new-versions kept-old-versions -1) 0))
3962 (format "%s.~%d~" basic-name n))
3963 (let ((v (nthcdr kept-old-versions versions)))
3964 (rplacd (nthcdr (1- number-to-delete) v) ())
3967 (defun file-nlinks (filename)
3968 "Return number of names file FILENAME has."
3969 (car (cdr (file-attributes filename))))
3971 ;; (defun file-relative-name (filename &optional directory)
3972 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3973 ;; This function returns a relative file name which is equivalent to FILENAME
3974 ;; when used with that default directory as the default.
3975 ;; If this is impossible (which can happen on MSDOS and Windows
3976 ;; when the file name and directory use different drive names)
3977 ;; then it returns FILENAME."
3979 ;; (let ((fname (expand-file-name filename)))
3980 ;; (setq directory (file-name-as-directory
3981 ;; (expand-file-name (or directory default-directory))))
3982 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3983 ;; ;; drive names, they can't be relative, so return the absolute name.
3984 ;; (if (and (or (eq system-type 'ms-dos)
3985 ;; (eq system-type 'cygwin)
3986 ;; (eq system-type 'windows-nt))
3987 ;; (not (string-equal (substring fname 0 2)
3988 ;; (substring directory 0 2))))
3990 ;; (let ((ancestor ".")
3991 ;; (fname-dir (file-name-as-directory fname)))
3992 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3993 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3994 ;; (setq directory (file-name-directory (substring directory 0 -1))
3995 ;; ancestor (if (equal ancestor ".")
3997 ;; (concat "../" ancestor))))
3998 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3999 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4000 ;; ;; We matched within FNAME's directory part.
4001 ;; ;; Add the rest of FNAME onto ANCESTOR.
4002 ;; (let ((rest (substring fname (match-end 0))))
4003 ;; (if (and (equal ancestor ".")
4004 ;; (not (equal rest "")))
4005 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4007 ;; (concat (file-name-as-directory ancestor) rest)))
4008 ;; ;; We matched FNAME's directory equivalent.
4011 (defun file-relative-name (filename &optional directory)
4012 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4013 This function returns a relative file name which is equivalent to FILENAME
4014 when used with that default directory as the default.
4015 If FILENAME and DIRECTORY lie on different machines or on different drives
4016 on a DOS/Windows machine, it returns FILENAME in expanded form."
4019 (file-name-as-directory (expand-file-name (or directory
4020 default-directory))))
4021 (setq filename (expand-file-name filename))
4022 (let ((fremote (file-remote-p filename))
4023 (dremote (file-remote-p directory)))
4024 (if ;; Conditions for separate trees
4026 ;; Test for different drives on DOS/Windows
4028 ;; Should `cygwin' really be included here? --stef
4029 (memq system-type '(ms-dos cygwin windows-nt))
4030 (not (eq t (compare-strings filename 0 2 directory 0 2))))
4031 ;; Test for different remote file system identification
4032 (not (equal fremote dremote)))
4034 (let ((ancestor ".")
4035 (filename-dir (file-name-as-directory filename)))
4038 (eq t (compare-strings filename-dir nil (length directory)
4039 directory nil nil case-fold-search))
4040 (eq t (compare-strings filename nil (length directory)
4041 directory nil nil case-fold-search))))
4042 (setq directory (file-name-directory (substring directory 0 -1))
4043 ancestor (if (equal ancestor ".")
4045 (concat "../" ancestor))))
4046 ;; Now ancestor is empty, or .., or ../.., etc.
4047 (if (eq t (compare-strings filename nil (length directory)
4048 directory nil nil case-fold-search))
4049 ;; We matched within FILENAME's directory part.
4050 ;; Add the rest of FILENAME onto ANCESTOR.
4051 (let ((rest (substring filename (length directory))))
4052 (if (and (equal ancestor ".") (not (equal rest "")))
4053 ;; But don't bother with ANCESTOR if it would give us `./'.
4055 (concat (file-name-as-directory ancestor) rest)))
4056 ;; We matched FILENAME's directory equivalent.
4059 (defun save-buffer (&optional args)
4060 "Save current buffer in visited file if modified.
4061 Variations are described below.
4063 By default, makes the previous version into a backup file
4064 if previously requested or if this is the first save.
4065 Prefixed with one \\[universal-argument], marks this version
4066 to become a backup when the next save is done.
4067 Prefixed with two \\[universal-argument]'s,
4068 unconditionally makes the previous version into a backup file.
4069 Prefixed with three \\[universal-argument]'s, marks this version
4070 to become a backup when the next save is done,
4071 and unconditionally makes the previous version into a backup file.
4073 With a numeric argument of 0, never make the previous version
4076 If a file's name is FOO, the names of its numbered backup versions are
4077 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4078 Numeric backups (rather than FOO~) will be made if value of
4079 `version-control' is not the atom `never' and either there are already
4080 numeric versions of the file being backed up, or `version-control' is
4082 We don't want excessive versions piling up, so there are variables
4083 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4084 and `kept-new-versions', which tells how many newest versions to keep.
4085 Defaults are 2 old versions and 2 new.
4086 `dired-kept-versions' controls dired's clean-directory (.) command.
4087 If `delete-old-versions' is nil, system will query user
4088 before trimming versions. Otherwise it does it silently.
4090 If `vc-make-backup-files' is nil, which is the default,
4091 no backup files are made for files managed by version control.
4092 (This is because the version control system itself records previous versions.)
4094 See the subroutine `basic-save-buffer' for more information."
4096 (let ((modp (buffer-modified-p))
4097 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4098 (memq args '(16 64)))))
4099 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
4100 ;; We used to display the message below only for files > 50KB, but
4101 ;; then Rmail-mbox never displays it due to buffer swapping. If
4102 ;; the test is ever re-introduced, be sure to handle saving of
4104 (if (and modp (buffer-file-name))
4105 (message "Saving file %s..." (buffer-file-name)))
4107 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4109 (defun delete-auto-save-file-if-necessary (&optional force)
4110 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4111 Normally delete only if the file was written by this Emacs since
4112 the last real save, but optional arg FORCE non-nil means delete anyway."
4113 (and buffer-auto-save-file-name delete-auto-save-files
4114 (not (string= buffer-file-name buffer-auto-save-file-name))
4115 (or force (recent-auto-save-p))
4118 (delete-file buffer-auto-save-file-name)
4120 (set-buffer-auto-saved))))
4122 (defvar auto-save-hook nil
4123 "Normal hook run just before auto-saving.")
4125 (defcustom before-save-hook nil
4126 "Normal hook that is run before a buffer is saved to its file."
4127 :options '(copyright-update time-stamp)
4131 (defcustom after-save-hook nil
4132 "Normal hook that is run after a buffer is saved to its file."
4133 :options '(executable-make-buffer-file-executable-if-script-p)
4137 (defvar save-buffer-coding-system nil
4138 "If non-nil, use this coding system for saving the buffer.
4139 More precisely, use this coding system in place of the
4140 value of `buffer-file-coding-system', when saving the buffer.
4141 Calling `write-region' for any purpose other than saving the buffer
4142 will still use `buffer-file-coding-system'; this variable has no effect
4145 (make-variable-buffer-local 'save-buffer-coding-system)
4146 (put 'save-buffer-coding-system 'permanent-local t)
4148 (defun basic-save-buffer ()
4149 "Save the current buffer in its visited file, if it has been modified.
4150 The hooks `write-contents-functions' and `write-file-functions' get a chance
4151 to do the job of saving; if they do not, then the buffer is saved in
4152 the visited file in the usual way.
4153 Before and after saving the buffer, this function runs
4154 `before-save-hook' and `after-save-hook', respectively."
4156 (save-current-buffer
4157 ;; In an indirect buffer, save its base buffer instead.
4158 (if (buffer-base-buffer)
4159 (set-buffer (buffer-base-buffer)))
4160 (if (buffer-modified-p)
4161 (let ((recent-save (recent-auto-save-p))
4163 ;; If buffer has no file name, ask user for one.
4164 (or buffer-file-name
4167 (read-file-name "File to save in: ") nil)))
4168 (if (file-exists-p filename)
4169 (if (file-directory-p filename)
4170 ;; Signal an error if the user specified the name of an
4171 ;; existing directory.
4172 (error "%s is a directory" filename)
4173 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4175 (error "Canceled")))
4176 ;; Signal an error if the specified name refers to a
4177 ;; non-existing directory.
4178 (let ((dir (file-name-directory filename)))
4179 (unless (file-directory-p dir)
4180 (if (file-exists-p dir)
4181 (error "%s is not a directory" dir)
4182 (error "%s: no such directory" dir)))))
4183 (set-visited-file-name filename)))
4184 (or (verify-visited-file-modtime (current-buffer))
4185 (not (file-exists-p buffer-file-name))
4187 (format "%s has changed since visited or saved. Save anyway? "
4188 (file-name-nondirectory buffer-file-name)))
4189 (error "Save not confirmed"))
4193 (and (> (point-max) (point-min))
4194 (not find-file-literally)
4195 (/= (char-after (1- (point-max))) ?\n)
4196 (not (and (eq selective-display t)
4197 (= (char-after (1- (point-max))) ?\r)))
4198 (or (eq require-final-newline t)
4199 (eq require-final-newline 'visit-save)
4200 (and require-final-newline
4202 (format "Buffer %s does not end in newline. Add one? "
4205 (goto-char (point-max))
4207 ;; Support VC version backups.
4209 (run-hooks 'before-save-hook)
4210 (or (run-hook-with-args-until-success 'write-contents-functions)
4211 (run-hook-with-args-until-success 'local-write-file-hooks)
4212 (run-hook-with-args-until-success 'write-file-functions)
4213 ;; If a hook returned t, file is already "written".
4214 ;; Otherwise, write it the usual way now.
4215 (setq setmodes (basic-save-buffer-1)))
4216 ;; Now we have saved the current buffer. Let's make sure
4217 ;; that buffer-file-coding-system is fixed to what
4218 ;; actually used for saving by binding it locally.
4219 (if save-buffer-coding-system
4220 (setq save-buffer-coding-system last-coding-system-used)
4221 (setq buffer-file-coding-system last-coding-system-used))
4222 (setq buffer-file-number
4223 (nthcdr 10 (file-attributes buffer-file-name)))
4226 (set-file-modes buffer-file-name (car setmodes))
4228 ;; If the auto-save file was recent before this command,
4230 (delete-auto-save-file-if-necessary recent-save)
4231 ;; Support VC `implicit' locking.
4233 (run-hooks 'after-save-hook))
4234 (message "(No changes need to be saved)"))))
4236 ;; This does the "real job" of writing a buffer into its visited file
4237 ;; and making a backup file. This is what is normally done
4238 ;; but inhibited if one of write-file-functions returns non-nil.
4239 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4240 (defun basic-save-buffer-1 ()
4242 (if save-buffer-coding-system
4243 (let ((coding-system-for-write save-buffer-coding-system))
4244 (basic-save-buffer-2))
4245 (basic-save-buffer-2))
4246 (if buffer-file-coding-system-explicit
4247 (setcar buffer-file-coding-system-explicit last-coding-system-used)
4248 (setq buffer-file-coding-system-explicit
4249 (cons last-coding-system-used nil)))))
4251 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4252 (defun basic-save-buffer-2 ()
4253 (let (tempsetmodes setmodes)
4254 (if (not (file-writable-p buffer-file-name))
4255 (let ((dir (file-name-directory buffer-file-name)))
4256 (if (not (file-directory-p dir))
4257 (if (file-exists-p dir)
4258 (error "%s is not a directory" dir)
4259 (error "%s: no such directory" dir))
4260 (if (not (file-exists-p buffer-file-name))
4261 (error "Directory %s write-protected" dir)
4263 (format "File %s is write-protected; try to save anyway? "
4264 (file-name-nondirectory
4266 (setq tempsetmodes t)
4267 (error "Attempt to save to a file which you aren't allowed to write"))))))
4268 (or buffer-backed-up
4269 (setq setmodes (backup-buffer)))
4270 (let* ((dir (file-name-directory buffer-file-name))
4271 (dir-writable (file-writable-p dir)))
4272 (if (or (and file-precious-flag dir-writable)
4273 (and break-hardlink-on-save
4274 (> (file-nlinks buffer-file-name) 1)
4276 (error (concat (format
4277 "Directory %s write-protected; " dir)
4278 "cannot break hardlink when saving")))))
4279 ;; Write temp name, then rename it.
4280 ;; This requires write access to the containing dir,
4281 ;; which is why we don't try it if we don't have that access.
4282 (let ((realname buffer-file-name)
4284 (umask (default-file-modes))
4285 (old-modtime (visited-file-modtime)))
4286 ;; Create temp files with strict access rights. It's easy to
4287 ;; loosen them later, whereas it's impossible to close the
4288 ;; time-window of loose permissions otherwise.
4291 (clear-visited-file-modtime)
4292 (set-default-file-modes ?\700)
4293 ;; Try various temporary names.
4294 ;; This code follows the example of make-temp-file,
4295 ;; but it calls write-region in the appropriate way
4296 ;; for saving the buffer.
4297 (while (condition-case ()
4301 (expand-file-name "tmp" dir)))
4302 ;; Pass in nil&nil rather than point-min&max
4303 ;; cause we're saving the whole buffer.
4304 ;; write-region-annotate-functions may use it.
4305 (write-region nil nil
4306 tempname nil realname
4307 buffer-file-truename 'excl)
4309 (file-already-exists t))
4310 ;; The file was somehow created by someone else between
4311 ;; `make-temp-name' and `write-region', let's try again.
4315 (set-default-file-modes umask)
4316 ;; If we failed, restore the buffer's modtime.
4318 (set-visited-file-modtime old-modtime)))
4319 ;; Since we have created an entirely new file,
4320 ;; make sure it gets the right permission bits set.
4321 (setq setmodes (or setmodes
4322 (cons (or (file-modes buffer-file-name)
4323 (logand ?\666 umask))
4325 ;; We succeeded in writing the temp file,
4327 (rename-file tempname buffer-file-name t))
4328 ;; If file not writable, see if we can make it writable
4329 ;; temporarily while we write it.
4330 ;; But no need to do so if we have just backed it up
4331 ;; (setmodes is set) because that says we're superseding.
4332 (cond ((and tempsetmodes (not setmodes))
4333 ;; Change the mode back, after writing.
4334 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4335 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4339 ;; Pass in nil&nil rather than point-min&max to indicate
4340 ;; we're saving the buffer rather than just a region.
4341 ;; write-region-annotate-functions may make us of it.
4342 (write-region nil nil
4343 buffer-file-name nil t buffer-file-truename)
4345 ;; If we get an error writing the new file, and we made
4346 ;; the backup by renaming, undo the backing-up.
4347 (and setmodes (not success)
4349 (rename-file (cdr setmodes) buffer-file-name t)
4350 (setq buffer-backed-up nil)))))))
4353 (defun diff-buffer-with-file (&optional buffer)
4354 "View the differences between BUFFER and its associated file.
4355 This requires the external program `diff' to be in your `exec-path'."
4356 (interactive "bBuffer: ")
4357 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4358 (if (and buffer-file-name
4359 (file-exists-p buffer-file-name))
4360 (let ((tempfile (make-temp-file "buffer-content-")))
4363 (write-region nil nil tempfile nil 'nomessage)
4364 (diff buffer-file-name tempfile nil t)
4366 (when (file-exists-p tempfile)
4367 (delete-file tempfile))))
4368 (message "Buffer %s has no associated file on disc" (buffer-name))
4369 ;; Display that message for 1 second so that user can read it
4370 ;; in the minibuffer.
4372 ;; return always nil, so that save-buffers-kill-emacs will not move
4373 ;; over to the next unsaved buffer when calling `d'.
4376 (defvar save-some-buffers-action-alist
4379 (if (not enable-recursive-minibuffers)
4380 (progn (display-buffer buf)
4381 (setq other-window-scroll-buffer buf))
4382 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4384 ;; Return nil to ask about BUF again.
4388 (if (null (buffer-file-name buf))
4389 (message "Not applicable: no file")
4390 (save-window-excursion (diff-buffer-with-file buf))
4391 (if (not enable-recursive-minibuffers)
4392 (progn (display-buffer (get-buffer-create "*Diff*"))
4393 (setq other-window-scroll-buffer "*Diff*"))
4394 (view-buffer (get-buffer-create "*Diff*")
4395 (lambda (_) (exit-recursive-edit)))
4397 ;; Return nil to ask about BUF again.
4399 "view changes in this buffer"))
4400 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4401 (put 'save-some-buffers-action-alist 'risky-local-variable t)
4403 (defvar buffer-save-without-query nil
4404 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4405 (make-variable-buffer-local 'buffer-save-without-query)
4407 (defun save-some-buffers (&optional arg pred)
4408 "Save some modified file-visiting buffers. Asks user about each one.
4409 You can answer `y' to save, `n' not to save, `C-r' to look at the
4410 buffer in question with `view-buffer' before deciding or `d' to
4411 view the differences using `diff-buffer-with-file'.
4413 Optional argument (the prefix) non-nil means save all with no questions.
4414 Optional second argument PRED determines which buffers are considered:
4415 If PRED is nil, all the file-visiting buffers are considered.
4416 If PRED is t, then certain non-file buffers will also be considered.
4417 If PRED is a zero-argument function, it indicates for each buffer whether
4418 to consider it or not when called with that buffer current.
4420 See `save-some-buffers-action-alist' if you want to
4421 change the additional actions you can take on files."
4423 (save-window-excursion
4424 (let* (queried some-automatic
4425 files-done abbrevs-done)
4426 (dolist (buffer (buffer-list))
4427 ;; First save any buffers that we're supposed to save unconditionally.
4428 ;; That way the following code won't ask about them.
4429 (with-current-buffer buffer
4430 (when (and buffer-save-without-query (buffer-modified-p))
4431 (setq some-automatic t)
4433 ;; Ask about those buffers that merit it,
4434 ;; and record the number thus saved.
4438 ;; Note that killing some buffers may kill others via
4439 ;; hooks (e.g. Rmail and its viewing buffer).
4440 (and (buffer-live-p buffer)
4441 (buffer-modified-p buffer)
4442 (not (buffer-base-buffer buffer))
4444 (buffer-file-name buffer)
4448 (and buffer-offer-save (> (buffer-size) 0)))))
4449 (or (not (functionp pred))
4450 (with-current-buffer buffer (funcall pred)))
4454 (if (buffer-file-name buffer)
4455 (format "Save file %s? "
4456 (buffer-file-name buffer))
4457 (format "Save buffer %s? "
4458 (buffer-name buffer))))))
4460 (with-current-buffer buffer
4463 '("buffer" "buffers" "save")
4464 save-some-buffers-action-alist))
4465 ;; Maybe to save abbrevs, and record whether
4466 ;; we either saved them or asked to.
4467 (and save-abbrevs abbrevs-changed
4470 (eq save-abbrevs 'silently)
4471 (y-or-n-p (format "Save abbrevs in %s? "
4473 (write-abbrev-file nil))
4474 ;; Don't keep bothering user if he says no.
4475 (setq abbrevs-changed nil)
4476 (setq abbrevs-done t)))
4477 (or queried (> files-done 0) abbrevs-done
4478 (message (if some-automatic
4479 "(Some special files were saved without asking)"
4480 "(No files need saving)"))))))
4482 (defun not-modified (&optional arg)
4483 "Mark current buffer as unmodified, not needing to be saved.
4484 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4486 It is not a good idea to use this function in Lisp programs, because it
4487 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4489 (message (if arg "Modification-flag set"
4490 "Modification-flag cleared"))
4491 (set-buffer-modified-p arg))
4493 (defun toggle-read-only (&optional arg)
4494 "Change whether this buffer is read-only.
4495 With prefix argument ARG, make the buffer read-only if ARG is
4496 positive, otherwise make it writable. If buffer is read-only
4497 and `view-read-only' is non-nil, enter view mode."
4500 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4501 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4505 ((and buffer-read-only view-mode)
4506 (View-exit-and-edit)
4507 (make-local-variable 'view-read-only)
4508 (setq view-read-only t)) ; Must leave view mode.
4509 ((and (not buffer-read-only) view-read-only
4510 ;; If view-mode is already active, `view-mode-enter' is a nop.
4512 (not (eq (get major-mode 'mode-class) 'special)))
4514 (t (setq buffer-read-only (not buffer-read-only))
4515 (force-mode-line-update)))
4516 (if (vc-backend buffer-file-name)
4517 (message "%s" (substitute-command-keys
4518 (concat "File is under version-control; "
4519 "use \\[vc-next-action] to check in/out"))))))
4521 (defun insert-file (filename)
4522 "Insert contents of file FILENAME into buffer after point.
4523 Set mark after the inserted text.
4525 This function is meant for the user to run interactively.
4526 Don't call it from programs! Use `insert-file-contents' instead.
4527 \(Its calling sequence is different; see its documentation)."
4528 (interactive "*fInsert file: ")
4529 (insert-file-1 filename #'insert-file-contents))
4531 (defun append-to-file (start end filename)
4532 "Append the contents of the region to the end of file FILENAME.
4533 When called from a function, expects three arguments,
4534 START, END and FILENAME. START and END are normally buffer positions
4535 specifying the part of the buffer to write.
4536 If START is nil, that means to use the entire buffer contents.
4537 If START is a string, then output that string to the file
4538 instead of any buffer contents; END is ignored.
4540 This does character code conversion and applies annotations
4541 like `write-region' does."
4542 (interactive "r\nFAppend to file: ")
4543 (write-region start end filename t))
4545 (defun file-newest-backup (filename)
4546 "Return most recent backup file for FILENAME or nil if no backups exist."
4547 ;; `make-backup-file-name' will get us the right directory for
4548 ;; ordinary or numeric backups. It might create a directory for
4549 ;; backups as a side-effect, according to `backup-directory-alist'.
4550 (let* ((filename (file-name-sans-versions
4551 (make-backup-file-name (expand-file-name filename))))
4552 (file (file-name-nondirectory filename))
4553 (dir (file-name-directory filename))
4554 (comp (file-name-all-completions file dir))
4558 (setq tem (pop comp))
4559 (cond ((and (backup-file-name-p tem)
4560 (string= (file-name-sans-versions tem) file))
4561 (setq tem (concat dir tem))
4562 (if (or (null newest)
4563 (file-newer-than-file-p tem newest))
4564 (setq newest tem)))))
4567 (defun rename-uniquely ()
4568 "Rename current buffer to a similar name not already taken.
4569 This function is useful for creating multiple shell process buffers
4570 or multiple mail buffers, etc."
4573 (let ((base-name (buffer-name)))
4574 (and (string-match "<[0-9]+>\\'" base-name)
4575 (not (and buffer-file-name
4577 (file-name-nondirectory buffer-file-name))))
4578 ;; If the existing buffer name has a <NNN>,
4579 ;; which isn't part of the file name (if any),
4580 ;; then get rid of that.
4581 (setq base-name (substring base-name 0 (match-beginning 0))))
4582 (rename-buffer (generate-new-buffer-name base-name))
4583 (force-mode-line-update))))
4585 (defun make-directory (dir &optional parents)
4586 "Create the directory DIR and any nonexistent parent dirs.
4587 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4589 Interactively, the default choice of directory to create
4590 is the current default directory for file names.
4591 That is useful when you have visited a file in a nonexistent directory.
4593 Noninteractively, the second (optional) argument PARENTS says whether
4594 to create parent directories if they don't exist. Interactively,
4595 this happens by default."
4597 (list (read-file-name "Make directory: " default-directory default-directory
4600 ;; If default-directory is a remote directory,
4601 ;; make sure we find its make-directory handler.
4602 (setq dir (expand-file-name dir))
4603 (let ((handler (find-file-name-handler dir 'make-directory)))
4605 (funcall handler 'make-directory dir parents)
4607 (make-directory-internal dir)
4608 (let ((dir (directory-file-name (expand-file-name dir)))
4610 (while (and (not (file-exists-p dir))
4611 ;; If directory is its own parent, then we can't
4612 ;; keep looping forever
4614 (directory-file-name
4615 (file-name-directory dir)))))
4616 (setq create-list (cons dir create-list)
4617 dir (directory-file-name (file-name-directory dir))))
4619 (make-directory-internal (car create-list))
4620 (setq create-list (cdr create-list))))))))
4622 (put 'revert-buffer-function 'permanent-local t)
4623 (defvar revert-buffer-function nil
4624 "Function to use to revert this buffer, or nil to do the default.
4625 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4626 which are the arguments that `revert-buffer' received.")
4628 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4629 (defvar revert-buffer-insert-file-contents-function nil
4630 "Function to use to insert contents when reverting this buffer.
4631 Gets two args, first the nominal file name to use,
4632 and second, t if reading the auto-save file.
4634 The function you specify is responsible for updating (or preserving) point.")
4636 (defvar buffer-stale-function nil
4637 "Function to check whether a non-file buffer needs reverting.
4638 This should be a function with one optional argument NOCONFIRM.
4639 Auto Revert Mode passes t for NOCONFIRM. The function should return
4640 non-nil if the buffer should be reverted. A return value of
4641 `fast' means that the need for reverting was not checked, but
4642 that reverting the buffer is fast. The buffer is current when
4643 this function is called.
4645 The idea behind the NOCONFIRM argument is that it should be
4646 non-nil if the buffer is going to be reverted without asking the
4647 user. In such situations, one has to be careful with potentially
4648 time consuming operations.
4650 For more information on how this variable is used by Auto Revert mode,
4651 see Info node `(emacs)Supporting additional buffers'.")
4653 (defvar before-revert-hook nil
4654 "Normal hook for `revert-buffer' to run before reverting.
4655 If `revert-buffer-function' is used to override the normal revert
4656 mechanism, this hook is not used.")
4658 (defvar after-revert-hook nil
4659 "Normal hook for `revert-buffer' to run after reverting.
4660 Note that the hook value that it runs is the value that was in effect
4661 before reverting; that makes a difference if you have buffer-local
4664 If `revert-buffer-function' is used to override the normal revert
4665 mechanism, this hook is not used.")
4667 (defvar revert-buffer-internal-hook)
4669 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4670 "Replace current buffer text with the text of the visited file on disk.
4671 This undoes all changes since the file was visited or saved.
4672 With a prefix argument, offer to revert from latest auto-save file, if
4673 that is more recent than the visited file.
4675 This command also implements an interface for special buffers
4676 that contain text which doesn't come from a file, but reflects
4677 some other data instead (e.g. Dired buffers, `buffer-list'
4678 buffers). This is done via the variable `revert-buffer-function'.
4679 In these cases, it should reconstruct the buffer contents from the
4682 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4683 to revert from the auto-save file when this is nil. Note that the
4684 sense of this argument is the reverse of the prefix argument, for the
4685 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4688 Optional second argument NOCONFIRM means don't ask for confirmation
4689 at all. \(The variable `revert-without-query' offers another way to
4690 revert buffers without querying for confirmation.)
4692 Optional third argument PRESERVE-MODES non-nil means don't alter
4693 the files modes. Normally we reinitialize them using `normal-mode'.
4695 If the value of `revert-buffer-function' is non-nil, it is called to
4696 do all the work for this command. Otherwise, the hooks
4697 `before-revert-hook' and `after-revert-hook' are run at the beginning
4698 and the end, and if `revert-buffer-insert-file-contents-function' is
4699 non-nil, it is called instead of rereading visited file contents."
4701 ;; I admit it's odd to reverse the sense of the prefix argument, but
4702 ;; there is a lot of code out there which assumes that the first
4703 ;; argument should be t to avoid consulting the auto-save file, and
4704 ;; there's no straightforward way to encourage authors to notice a
4705 ;; reversal of the argument sense. So I'm just changing the user
4706 ;; interface, but leaving the programmatic interface the same.
4707 (interactive (list (not current-prefix-arg)))
4708 (if revert-buffer-function
4709 (funcall revert-buffer-function ignore-auto noconfirm)
4710 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4712 (let* ((auto-save-p (and (not ignore-auto)
4713 (recent-auto-save-p)
4714 buffer-auto-save-file-name
4715 (file-readable-p buffer-auto-save-file-name)
4717 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4718 (file-name (if auto-save-p
4719 buffer-auto-save-file-name
4721 (cond ((null file-name)
4722 (error "Buffer does not seem to be associated with any file"))
4724 (and (not (buffer-modified-p))
4726 (dolist (regexp revert-without-query)
4727 (when (string-match regexp file-name)
4728 (throw 'found t)))))
4729 (yes-or-no-p (format "Revert buffer from file %s? "
4731 (run-hooks 'before-revert-hook)
4732 ;; If file was backed up but has changed since,
4733 ;; we shd make another backup.
4734 (and (not auto-save-p)
4735 (not (verify-visited-file-modtime (current-buffer)))
4736 (setq buffer-backed-up nil))
4737 ;; Effectively copy the after-revert-hook status,
4738 ;; since after-find-file will clobber it.
4739 (let ((global-hook (default-value 'after-revert-hook))
4740 (local-hook (when (local-variable-p 'after-revert-hook)
4742 (inhibit-read-only t))
4744 (revert-buffer-insert-file-contents-function
4745 (unless (eq buffer-undo-list t)
4746 ;; Get rid of all undo records for this buffer.
4747 (setq buffer-undo-list nil))
4748 ;; Don't make undo records for the reversion.
4749 (let ((buffer-undo-list t))
4750 (funcall revert-buffer-insert-file-contents-function
4751 file-name auto-save-p)))
4752 ((not (file-exists-p file-name))
4753 (error (if buffer-file-number
4754 "File %s no longer exists!"
4755 "Cannot revert nonexistent file %s")
4757 ((not (file-readable-p file-name))
4758 (error (if buffer-file-number
4759 "File %s no longer readable!"
4760 "Cannot revert unreadable file %s")
4763 ;; Bind buffer-file-name to nil
4764 ;; so that we don't try to lock the file.
4765 (let ((buffer-file-name nil))
4769 (let ((coding-system-for-read
4770 ;; Auto-saved file should be read by Emacs'
4772 (if auto-save-p 'auto-save-coding
4773 (or coding-system-for-read
4775 buffer-file-coding-system-explicit
4776 (car buffer-file-coding-system-explicit))))))
4777 (if (and (not enable-multibyte-characters)
4778 coding-system-for-read
4779 (not (memq (coding-system-base
4780 coding-system-for-read)
4781 '(no-conversion raw-text))))
4782 ;; As a coding system suitable for multibyte
4783 ;; buffer is specified, make the current
4784 ;; buffer multibyte.
4785 (set-buffer-multibyte t))
4787 ;; This force after-insert-file-set-coding
4788 ;; (called from insert-file-contents) to set
4789 ;; buffer-file-coding-system to a proper value.
4790 (kill-local-variable 'buffer-file-coding-system)
4792 ;; Note that this preserves point in an intelligent way.
4794 (let ((buffer-file-format buffer-file-format))
4795 (insert-file-contents file-name (not auto-save-p)
4797 (insert-file-contents file-name (not auto-save-p)
4799 ;; Recompute the truename in case changes in symlinks
4800 ;; have changed the truename.
4801 (setq buffer-file-truename
4802 (abbreviate-file-name (file-truename buffer-file-name)))
4803 (after-find-file nil nil t t preserve-modes)
4804 ;; Run after-revert-hook as it was before we reverted.
4805 (setq-default revert-buffer-internal-hook global-hook)
4807 (set (make-local-variable 'revert-buffer-internal-hook)
4809 (kill-local-variable 'revert-buffer-internal-hook))
4810 (run-hooks 'revert-buffer-internal-hook))
4813 (defun recover-this-file ()
4814 "Recover the visited file--get contents from its last auto-save file."
4816 (recover-file buffer-file-name))
4818 (defun recover-file (file)
4819 "Visit file FILE, but get contents from its last auto-save file."
4820 ;; Actually putting the file name in the minibuffer should be used
4822 ;; Not just because users often use the default.
4823 (interactive "FRecover file: ")
4824 (setq file (expand-file-name file))
4825 (if (auto-save-file-name-p (file-name-nondirectory file))
4826 (error "%s is an auto-save file" (abbreviate-file-name file)))
4827 (let ((file-name (let ((buffer-file-name file))
4828 (make-auto-save-file-name))))
4829 (cond ((if (file-exists-p file)
4830 (not (file-newer-than-file-p file-name file))
4831 (not (file-exists-p file-name)))
4832 (error "Auto-save file %s not current"
4833 (abbreviate-file-name file-name)))
4834 ((save-window-excursion
4835 (with-output-to-temp-buffer "*Directory*"
4836 (buffer-disable-undo standard-output)
4838 (let ((switches dired-listing-switches))
4839 (if (file-symlink-p file)
4840 (setq switches (concat switches "L")))
4841 (set-buffer standard-output)
4842 ;; Use insert-directory-safely, not insert-directory,
4843 ;; because these files might not exist. In particular,
4844 ;; FILE might not exist if the auto-save file was for
4845 ;; a buffer that didn't visit a file, such as "*mail*".
4846 ;; The code in v20.x called `ls' directly, so we need
4847 ;; to emulate what `ls' did in that case.
4848 (insert-directory-safely file switches)
4849 (insert-directory-safely file-name switches))))
4850 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4851 (switch-to-buffer (find-file-noselect file t))
4852 (let ((inhibit-read-only t)
4853 ;; Keep the current buffer-file-coding-system.
4854 (coding-system buffer-file-coding-system)
4855 ;; Auto-saved file should be read with special coding.
4856 (coding-system-for-read 'auto-save-coding))
4858 (insert-file-contents file-name nil)
4859 (set-buffer-file-coding-system coding-system))
4860 (after-find-file nil nil t))
4861 (t (error "Recover-file cancelled")))))
4863 (defun recover-session ()
4864 "Recover auto save files from a previous Emacs session.
4865 This command first displays a Dired buffer showing you the
4866 previous sessions that you could recover from.
4867 To choose one, move point to the proper line and then type C-c C-c.
4868 Then you'll be asked about a number of files to recover."
4870 (if (null auto-save-list-file-prefix)
4871 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4872 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4873 (unless (file-directory-p dir)
4874 (make-directory dir t))
4875 (unless (directory-files dir nil
4876 (concat "\\`" (regexp-quote
4877 (file-name-nondirectory
4878 auto-save-list-file-prefix)))
4880 (error "No previous sessions to recover")))
4881 (let ((ls-lisp-support-shell-wildcards t))
4882 (dired (concat auto-save-list-file-prefix "*")
4883 (concat dired-listing-switches "t")))
4885 (goto-char (point-min))
4886 (or (looking-at " Move to the session you want to recover,")
4887 (let ((inhibit-read-only t))
4888 ;; Each line starts with a space
4889 ;; so that Font Lock mode won't highlight the first character.
4890 (insert " Move to the session you want to recover,\n"
4891 " then type C-c C-c to select it.\n\n"
4892 " You can also delete some of these files;\n"
4893 " type d on a line to mark that file for deletion.\n\n"))))
4894 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4895 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4897 (defun recover-session-finish ()
4898 "Choose one saved session to recover auto-save files from.
4899 This command is used in the special Dired buffer created by
4900 \\[recover-session]."
4902 ;; Get the name of the session file to recover from.
4903 (let ((file (dired-get-filename))
4905 (buffer (get-buffer-create " *recover*")))
4907 (dired-do-flagged-delete t)
4910 ;; Read in the auto-save-list file.
4913 (insert-file-contents file)
4914 ;; Loop thru the text of that file
4915 ;; and get out the names of the files to recover.
4917 (let (thisfile autofile)
4919 ;; This is a pair of lines for a non-file-visiting buffer.
4920 ;; Get the auto-save file name and manufacture
4921 ;; a "visited file name" from that.
4924 ;; If there is no auto-save file name, the
4925 ;; auto-save-list file is probably corrupted.
4928 (buffer-substring-no-properties
4930 (line-end-position)))
4934 (file-name-nondirectory autofile)
4936 (file-name-directory autofile))))
4938 ;; This pair of lines is a file-visiting
4939 ;; buffer. Use the visited file name.
4942 (buffer-substring-no-properties
4943 (point) (progn (end-of-line) (point))))
4946 (buffer-substring-no-properties
4947 (point) (progn (end-of-line) (point))))
4949 ;; Ignore a file if its auto-save file does not exist now.
4950 (if (and autofile (file-exists-p autofile))
4951 (setq files (cons thisfile files)))))
4952 (setq files (nreverse files))
4953 ;; The file contains a pair of line for each auto-saved buffer.
4954 ;; The first line of the pair contains the visited file name
4955 ;; or is empty if the buffer was not visiting a file.
4956 ;; The second line is the auto-save file name.
4958 (map-y-or-n-p "Recover %s? "
4961 (save-excursion (recover-file file))
4963 "Failed to recover `%s'" file)))
4965 '("file" "files" "recover"))
4966 (message "No files can be recovered from this session now")))
4967 (kill-buffer buffer))))
4969 (defun kill-buffer-ask (buffer)
4970 "Kill BUFFER if confirmed."
4972 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4973 (if (buffer-modified-p buffer)
4974 "HAS BEEN EDITED" "is unmodified")))
4975 (kill-buffer buffer)))
4977 (defun kill-some-buffers (&optional list)
4978 "Kill some buffers. Asks the user whether to kill each one of them.
4979 Non-interactively, if optional argument LIST is non-nil, it
4980 specifies the list of buffers to kill, asking for approval for each one."
4983 (setq list (buffer-list)))
4985 (let* ((buffer (car list))
4986 (name (buffer-name buffer)))
4987 (and name ; Can be nil for an indirect buffer
4988 ; if we killed the base buffer.
4989 (not (string-equal name ""))
4990 (/= (aref name 0) ?\s)
4991 (kill-buffer-ask buffer)))
4992 (setq list (cdr list))))
4994 (defun kill-matching-buffers (regexp &optional internal-too)
4995 "Kill buffers whose name matches the specified REGEXP.
4996 The optional second argument indicates whether to kill internal buffers too."
4997 (interactive "sKill buffers matching this regular expression: \nP")
4998 (dolist (buffer (buffer-list))
4999 (let ((name (buffer-name buffer)))
5000 (when (and name (not (string-equal name ""))
5001 (or internal-too (/= (aref name 0) ?\s))
5002 (string-match regexp name))
5003 (kill-buffer-ask buffer)))))
5006 (defun auto-save-mode (arg)
5007 "Toggle auto-saving of contents of current buffer.
5008 With prefix argument ARG, turn auto-saving on if positive, else off."
5010 (setq buffer-auto-save-file-name
5012 (or (not buffer-auto-save-file-name)
5013 ;; If auto-save is off because buffer has shrunk,
5014 ;; then toggling should turn it on.
5015 (< buffer-saved-size 0))
5016 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
5017 (if (and buffer-file-name auto-save-visited-file-name
5018 (not buffer-read-only))
5020 (make-auto-save-file-name))))
5021 ;; If -1 was stored here, to temporarily turn off saving,
5023 (and (< buffer-saved-size 0)
5024 (setq buffer-saved-size 0))
5026 (message "Auto-save %s (in this buffer)"
5027 (if buffer-auto-save-file-name "on" "off")))
5028 buffer-auto-save-file-name)
5030 (defun rename-auto-save-file ()
5031 "Adjust current buffer's auto save file name for current conditions.
5032 Also rename any existing auto save file, if it was made in this session."
5033 (let ((osave buffer-auto-save-file-name))
5034 (setq buffer-auto-save-file-name
5035 (make-auto-save-file-name))
5036 (if (and osave buffer-auto-save-file-name
5037 (not (string= buffer-auto-save-file-name buffer-file-name))
5038 (not (string= buffer-auto-save-file-name osave))
5039 (file-exists-p osave)
5040 (recent-auto-save-p))
5041 (rename-file osave buffer-auto-save-file-name t))))
5043 (defun make-auto-save-file-name ()
5044 "Return file name to use for auto-saves of current buffer.
5045 Does not consider `auto-save-visited-file-name' as that variable is checked
5046 before calling this function. You can redefine this for customization.
5047 See also `auto-save-file-name-p'."
5048 (if buffer-file-name
5049 (let ((handler (find-file-name-handler buffer-file-name
5050 'make-auto-save-file-name)))
5052 (funcall handler 'make-auto-save-file-name)
5053 (let ((list auto-save-file-name-transforms)
5054 (filename buffer-file-name)
5056 ;; Apply user-specified translations
5057 ;; to the file name.
5058 (while (and list (not result))
5059 (if (string-match (car (car list)) filename)
5060 (setq result (replace-match (cadr (car list)) t nil
5062 uniq (car (cddr (car list)))))
5063 (setq list (cdr list)))
5066 (setq filename (concat
5067 (file-name-directory result)
5068 (subst-char-in-string
5070 (replace-regexp-in-string "!" "!!"
5072 (setq filename result)))
5074 (if (and (eq system-type 'ms-dos)
5075 (not (msdos-long-file-names)))
5076 ;; We truncate the file name to DOS 8+3 limits
5077 ;; before doing anything else, because the regexp
5078 ;; passed to string-match below cannot handle
5079 ;; extensions longer than 3 characters, multiple
5080 ;; dots, and other atrocities.
5081 (let ((fn (dos-8+3-filename
5082 (file-name-nondirectory buffer-file-name))))
5084 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5086 (concat (file-name-directory buffer-file-name)
5087 "#" (match-string 1 fn)
5088 "." (match-string 3 fn) "#"))
5089 (concat (file-name-directory filename)
5091 (file-name-nondirectory filename)
5093 ;; Make sure auto-save file names don't contain characters
5094 ;; invalid for the underlying filesystem.
5095 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5096 ;; Don't modify remote (ange-ftp) filenames
5097 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5098 (convert-standard-filename result)
5101 ;; Deal with buffers that don't have any associated files. (Mail
5102 ;; mode tends to create a good number of these.)
5104 (let ((buffer-name (buffer-name))
5107 ;; Restrict the characters used in the file name to those which
5108 ;; are known to be safe on all filesystems, url-encoding the
5110 ;; We do this on all platforms, because even if we are not
5111 ;; running on DOS/Windows, the current directory may be on a
5112 ;; mounted VFAT filesystem, such as a USB memory stick.
5113 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5114 (let* ((character (aref buffer-name (match-beginning 0)))
5116 ;; For multibyte characters, this will produce more than
5117 ;; 2 hex digits, so is not true URL encoding.
5118 (format "%%%02X" character)))
5119 (setq buffer-name (replace-match replacement t t buffer-name))
5120 (setq limit (1+ (match-end 0)))))
5121 ;; Generate the file name.
5126 (format "#%s#" buffer-name)
5127 ;; Try a few alternative directories, to get one we can
5130 ((file-writable-p default-directory) default-directory)
5131 ((file-writable-p "/var/tmp/") "/var/tmp/")
5133 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5134 ;; Don't modify remote (ange-ftp) filenames
5135 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5136 ;; The call to convert-standard-filename is in case
5137 ;; buffer-name includes characters not allowed by the
5138 ;; DOS/Windows filesystems. make-temp-file writes to the
5139 ;; file it creates, so we must fix the file name _before_
5140 ;; make-temp-file is called.
5141 (convert-standard-filename fname)
5144 ;; make-temp-file creates the file,
5145 ;; but we don't want it to exist until we do an auto-save.
5147 (delete-file file-name)
5151 (defun auto-save-file-name-p (filename)
5152 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5153 FILENAME should lack slashes. You can redefine this for customization."
5154 (string-match "^#.*#$" filename))
5156 (defun wildcard-to-regexp (wildcard)
5157 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5158 The generated regexp will match a filename only if the filename
5159 matches that wildcard according to shell rules. Only wildcards known
5160 by `sh' are supported."
5161 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5162 ;; Copy the initial run of non-special characters.
5163 (result (substring wildcard 0 i))
5164 (len (length wildcard)))
5165 ;; If no special characters, we're almost done.
5168 (let ((ch (aref wildcard i))
5176 (eq (aref wildcard (1+ i)) ?\]))
5178 ((eq ch ?\[) ; [...] maps to regexp char class
5183 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5186 (if (eq (aref wildcard i) ?\])
5191 ((eq (aref wildcard i) ?^)
5192 ;; Found "[^". Insert a `\0' character
5193 ;; (which cannot happen in a filename)
5194 ;; into the character class, so that `^'
5195 ;; is not the first character after `[',
5196 ;; and thus non-special in a regexp.
5200 ((eq (aref wildcard i) ?\])
5201 ;; I don't think `]' can appear in a
5202 ;; character class in a wildcard, but
5203 ;; let's be general here.
5208 (prog1 ; copy everything upto next `]'.
5211 (setq j (string-match
5213 (setq i (if j (1- j) (1- len)))))))
5215 ((eq ch ?*) "[^\000]*")
5219 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5220 ((eq ch ??) "[^\000]")
5221 (t (char-to-string ch)))))
5223 ;; Shell wildcards should match the entire filename,
5224 ;; not its part. Make the regexp say so.
5225 (concat "\\`" result "\\'")))
5227 (defcustom list-directory-brief-switches
5229 "Switches for `list-directory' to pass to `ls' for brief listing."
5233 (defcustom list-directory-verbose-switches
5235 "Switches for `list-directory' to pass to `ls' for verbose listing."
5239 (defun file-expand-wildcards (pattern &optional full)
5240 "Expand wildcard pattern PATTERN.
5241 This returns a list of file names which match the pattern.
5243 If PATTERN is written as an absolute file name,
5244 the values are absolute also.
5246 If PATTERN is written as a relative file name, it is interpreted
5247 relative to the current default directory, `default-directory'.
5248 The file names returned are normally also relative to the current
5249 default directory. However, if FULL is non-nil, they are absolute."
5251 (let* ((nondir (file-name-nondirectory pattern))
5252 (dirpart (file-name-directory pattern))
5253 ;; A list of all dirs that DIRPART specifies.
5254 ;; This can be more than one dir
5255 ;; if DIRPART contains wildcards.
5256 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5257 (mapcar 'file-name-as-directory
5258 (file-expand-wildcards (directory-file-name dirpart)))
5262 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5263 (file-directory-p (directory-file-name (car dirs))))
5264 (let ((this-dir-contents
5265 ;; Filter out "." and ".."
5267 (mapcar #'(lambda (name)
5268 (unless (string-match "\\`\\.\\.?\\'"
5269 (file-name-nondirectory name))
5271 (directory-files (or (car dirs) ".") full
5272 (wildcard-to-regexp nondir))))))
5275 (if (and (car dirs) (not full))
5276 (mapcar (function (lambda (name) (concat (car dirs) name)))
5280 (setq dirs (cdr dirs)))
5283 (defun list-directory (dirname &optional verbose)
5284 "Display a list of files in or matching DIRNAME, a la `ls'.
5285 DIRNAME is globbed by the shell if necessary.
5286 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5287 Actions controlled by variables `list-directory-brief-switches'
5288 and `list-directory-verbose-switches'."
5289 (interactive (let ((pfx current-prefix-arg))
5290 (list (read-file-name (if pfx "List directory (verbose): "
5291 "List directory (brief): ")
5292 nil default-directory nil)
5294 (let ((switches (if verbose list-directory-verbose-switches
5295 list-directory-brief-switches))
5297 (or dirname (setq dirname default-directory))
5298 (setq dirname (expand-file-name dirname))
5299 (with-output-to-temp-buffer "*Directory*"
5300 (setq buffer standard-output)
5301 (buffer-disable-undo standard-output)
5302 (princ "Directory ")
5306 (set-buffer "*Directory*")
5307 (let ((wildcard (not (file-directory-p dirname))))
5308 (insert-directory dirname switches wildcard (not wildcard)))))
5309 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5310 (with-current-buffer buffer
5311 (setq default-directory
5312 (if (file-directory-p dirname)
5313 (file-name-as-directory dirname)
5314 (file-name-directory dirname))))))
5316 (defun shell-quote-wildcard-pattern (pattern)
5317 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5319 PATTERN is assumed to represent a file-name wildcard suitable for the
5320 underlying filesystem. For Unix and GNU/Linux, each character from the
5321 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5322 the parts of the pattern which don't include wildcard characters are
5323 quoted with double quotes.
5325 This function leaves alone existing quote characters (\\ on Unix and \"
5326 on Windows), so PATTERN can use them to quote wildcard characters that
5327 need to be passed verbatim to shell commands."
5330 ((memq system-type '(ms-dos windows-nt cygwin))
5331 ;; DOS/Windows don't allow `"' in file names. So if the
5332 ;; argument has quotes, we can safely assume it is already
5333 ;; quoted by the caller.
5334 (if (or (string-match "[\"]" pattern)
5335 ;; We quote [&()#$'] in case their shell is a port of a
5336 ;; Unixy shell. We quote [,=+] because stock DOS and
5337 ;; Windows shells require that in some cases, such as
5338 ;; passing arguments to batch files that use positional
5339 ;; arguments like %1.
5340 (not (string-match "[ \t;&()#$',=+]" pattern)))
5345 (while (string-match "[*?]+" pattern beg)
5346 (setq end (match-beginning 0)
5347 result (concat result (substring pattern beg end)
5349 (substring pattern end (match-end 0))
5352 (concat result (substring pattern beg) "\""))))
5355 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5357 (concat (substring pattern 0 (match-beginning 0))
5359 (substring pattern (match-beginning 0)))
5360 beg (1+ (match-end 0)))))
5364 (defvar insert-directory-program "ls"
5365 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5367 (defcustom directory-free-space-program "df"
5368 "Program to get the amount of free space on a file system.
5369 We assume the output has the format of `df'.
5370 The value of this variable must be just a command name or file name;
5371 if you want to specify options, use `directory-free-space-args'.
5373 A value of nil disables this feature.
5375 If the function `file-system-info' is defined, it is always used in
5376 preference to the program given by this variable."
5377 :type '(choice (string :tag "Program") (const :tag "None" nil))
5380 (defcustom directory-free-space-args
5381 (if (eq system-type 'darwin) "-k" "-Pk")
5382 "Options to use when running `directory-free-space-program'."
5386 (defun get-free-disk-space (dir)
5387 "Return the amount of free space on directory DIR's file system.
5388 The result is a string that gives the number of free 1KB blocks,
5389 or nil if the system call or the program which retrieve the information
5390 fail. It returns also nil when DIR is a remote directory.
5392 This function calls `file-system-info' if it is available, or invokes the
5393 program specified by `directory-free-space-program' if that is non-nil."
5394 (unless (file-remote-p dir)
5395 ;; Try to find the number of free blocks. Non-Posix systems don't
5396 ;; always have df, but might have an equivalent system call.
5397 (if (fboundp 'file-system-info)
5398 (let ((fsinfo (file-system-info dir)))
5400 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5401 (setq dir (expand-file-name dir))
5404 (when (and directory-free-space-program
5405 ;; Avoid failure if the default directory does
5406 ;; not exist (Bug#2631, Bug#3911).
5407 (let ((default-directory "/"))
5408 (eq (call-process directory-free-space-program
5410 directory-free-space-args
5413 ;; Usual format is a header line followed by a line of
5415 (goto-char (point-min))
5419 ;; Move to the end of the "available blocks" number.
5420 (skip-chars-forward "^ \t")
5422 ;; Copy it into AVAILABLE.
5423 (let ((end (point)))
5425 (buffer-substring (point) end))))))))))
5427 ;; The following expression replaces `dired-move-to-filename-regexp'.
5428 (defvar directory-listing-before-filename-regexp
5429 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5430 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5431 ;; In some locales, month abbreviations are as short as 2 letters,
5432 ;; and they can be followed by ".".
5433 ;; In Breton, a month name can include a quote character.
5434 (month (concat l-or-quote l-or-quote "+\\.?"))
5436 (yyyy "[0-9][0-9][0-9][0-9]")
5438 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5439 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5440 (zone "[-+][0-2][0-9][0-5][0-9]")
5441 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5442 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5443 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5444 "\\|" yyyy "-" iso-mm-dd "\\)"))
5445 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5447 "\\(" HH:MM "\\|" yyyy "\\)"))
5448 (western-comma (concat month s "+" dd "," s "+" yyyy))
5449 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5450 ;; omits the Kanji characters after month and day-of-month.
5451 ;; On Mac OS X 10.3, the date format in East Asian locales is
5452 ;; day-of-month digits followed by month digits.
5455 (concat "\\(" mm l "?" s dd l "?" s "+"
5456 "\\|" dd s mm s "+" "\\)"
5457 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5458 ;; The "[0-9]" below requires the previous column to end in a digit.
5459 ;; This avoids recognizing `1 may 1997' as a date in the line:
5460 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5462 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5463 ;; The ".*" below finds the last match if there are multiple matches.
5464 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5465 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5467 ;; vc dired listings provide the state or blanks between file
5468 ;; permissions and date. The state is always surrounded by
5470 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5471 ;; This is not supported yet.
5472 (concat ".*[0-9][BkKMGTPEZY]?" s
5473 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5475 "Regular expression to match up to the file name in a directory listing.
5476 The default value is designed to recognize dates and times
5477 regardless of the language.")
5479 (defvar insert-directory-ls-version 'unknown)
5482 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5483 ;; FULL-DIRECTORY-P is nil.
5484 ;; The single line of output must display FILE's name as it was
5485 ;; given, namely, an absolute path name.
5486 ;; - must insert exactly one line for each file if WILDCARD or
5487 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5488 ;; before the file lines, plus optional text after the file lines.
5489 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5491 ;; File lines should display the basename.
5492 ;; - must be consistent with
5493 ;; - functions dired-move-to-filename, (these two define what a file line is)
5494 ;; dired-move-to-end-of-filename,
5495 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5496 ;; dired-insert-headerline
5497 ;; dired-after-subdir-garbage (defines what a "total" line is)
5498 ;; - variable dired-subdir-regexp
5499 ;; - may be passed "--dired" as the first argument in SWITCHES.
5500 ;; Filename handlers might have to remove this switch if their
5501 ;; "ls" command does not support it.
5502 (defun insert-directory (file switches &optional wildcard full-directory-p)
5503 "Insert directory listing for FILE, formatted according to SWITCHES.
5504 Leaves point after the inserted text.
5505 SWITCHES may be a string of options, or a list of strings
5506 representing individual options.
5507 Optional third arg WILDCARD means treat FILE as shell wildcard.
5508 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5509 switches do not contain `d', so that a full listing is expected.
5511 This works by running a directory listing program
5512 whose name is in the variable `insert-directory-program'.
5513 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5515 When SWITCHES contains the long `--dired' option, this function
5516 treats it specially, for the sake of dired. However, the
5517 normally equivalent short `-D' option is just passed on to
5518 `insert-directory-program', as any other option."
5519 ;; We need the directory in order to find the right handler.
5520 (let ((handler (find-file-name-handler (expand-file-name file)
5521 'insert-directory)))
5523 (funcall handler 'insert-directory file switches
5524 wildcard full-directory-p)
5525 (let (result (beg (point)))
5527 ;; Read the actual directory using `insert-directory-program'.
5528 ;; RESULT gets the status code.
5529 (let* (;; We at first read by no-conversion, then after
5530 ;; putting text property `dired-filename, decode one
5531 ;; bunch by one to preserve that property.
5532 (coding-system-for-read 'no-conversion)
5533 ;; This is to control encoding the arguments in call-process.
5534 (coding-system-for-write
5535 (and enable-multibyte-characters
5536 (or file-name-coding-system
5537 default-file-name-coding-system))))
5540 ;; Run ls in the directory part of the file pattern
5541 ;; using the last component as argument.
5542 (let ((default-directory
5543 (if (file-name-absolute-p file)
5544 (file-name-directory file)
5545 (file-name-directory (expand-file-name file))))
5546 (pattern (file-name-nondirectory file)))
5548 shell-file-name nil t nil
5550 (concat (if (memq system-type '(ms-dos windows-nt))
5552 "\\") ; Disregard Unix shell aliases!
5553 insert-directory-program
5555 (if (stringp switches)
5557 (mapconcat 'identity switches " "))
5559 ;; Quote some characters that have
5560 ;; special meanings in shells; but
5561 ;; don't quote the wildcards--we want
5562 ;; them to be special. We also
5563 ;; currently don't quote the quoting
5564 ;; characters in case people want to
5565 ;; use them explicitly to quote
5566 ;; wildcard characters.
5567 (shell-quote-wildcard-pattern pattern))))
5568 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5569 ;; directory if FILE is a symbolic link.
5570 (apply 'call-process
5571 insert-directory-program nil t nil
5573 (if (listp switches) switches
5574 (unless (equal switches "")
5575 ;; Split the switches at any spaces so we can
5576 ;; pass separate options as separate args.
5577 (split-string switches)))
5578 ;; Avoid lossage if FILE starts with `-'.
5581 (if (string-match "\\`~" file)
5582 (setq file (expand-file-name file)))
5584 (if full-directory-p
5585 (concat (file-name-as-directory file) ".")
5588 ;; If we got "//DIRED//" in the output, it means we got a real
5589 ;; directory listing, even if `ls' returned nonzero.
5590 ;; So ignore any errors.
5591 (when (if (stringp switches)
5592 (string-match "--dired\\>" switches)
5593 (member "--dired" switches))
5596 (when (looking-at "//SUBDIRED//")
5598 (if (looking-at "//DIRED//")
5601 (when (and (not (eq 0 result))
5602 (eq insert-directory-ls-version 'unknown))
5603 ;; The first time ls returns an error,
5604 ;; find the version numbers of ls,
5605 ;; and set insert-directory-ls-version
5606 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5607 ;; is equal or if the info cannot be obtained.
5608 ;; (That can mean it isn't GNU ls.)
5611 (call-process "ls" nil t nil "--version")
5613 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5614 (let* ((version (match-string 1 version-out))
5615 (split (split-string version "[.]"))
5616 (numbers (mapcar 'string-to-number split))
5619 (while (and (not comparison) (or numbers min))
5621 (setq comparison '>))
5623 (setq comparison '<))
5624 ((> (car numbers) (car min))
5625 (setq comparison '>))
5626 ((< (car numbers) (car min))
5627 (setq comparison '<))
5629 (setq numbers (cdr numbers)
5631 (setq insert-directory-ls-version (or comparison '=)))
5632 (setq insert-directory-ls-version nil))))
5634 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5635 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5638 ;; If `insert-directory-program' failed, signal an error.
5639 (unless (eq 0 result)
5640 ;; Delete the error message it may have output.
5641 (delete-region beg (point))
5642 ;; On non-Posix systems, we cannot open a directory, so
5643 ;; don't even try, because that will always result in
5644 ;; the ubiquitous "Access denied". Instead, show the
5645 ;; command line so the user can try to guess what went wrong.
5646 (if (and (file-directory-p file)
5647 (memq system-type '(ms-dos windows-nt)))
5649 "Reading directory: \"%s %s -- %s\" exited with status %s"
5650 insert-directory-program
5651 (if (listp switches) (concat switches) switches)
5653 ;; Unix. Access the file to get a suitable error.
5654 (access-file file "Reading directory")
5655 (error "Listing directory failed but `access-file' worked")))
5657 (when (if (stringp switches)
5658 (string-match "--dired\\>" switches)
5659 (member "--dired" switches))
5660 ;; The following overshoots by one line for an empty
5661 ;; directory listed with "--dired", but without "-a"
5662 ;; switch, where the ls output contains a
5663 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5664 ;; We take care of that case later.
5666 (when (looking-at "//SUBDIRED//")
5667 (delete-region (point) (progn (forward-line 1) (point)))
5669 (if (looking-at "//DIRED//")
5670 (let ((end (line-end-position))
5673 ;; Find all the lines that are error messages,
5674 ;; and record the bounds of each one.
5676 (while (< (point) linebeg)
5677 (or (eql (following-char) ?\s)
5678 (push (list (point) (line-end-position)) error-lines))
5680 (setq error-lines (nreverse error-lines))
5681 ;; Now read the numeric positions of file names.
5685 (while (< (point) end)
5686 (let ((start (insert-directory-adj-pos
5687 (+ beg (read (current-buffer)))
5689 (end (insert-directory-adj-pos
5690 (+ beg (read (current-buffer)))
5692 (if (memq (char-after end) '(?\n ?\s))
5693 ;; End is followed by \n or by " -> ".
5694 (put-text-property start end 'dired-filename t)
5695 ;; It seems that we can't trust ls's output as to
5696 ;; byte positions of filenames.
5697 (put-text-property beg (point) 'dired-filename nil)
5701 (delete-region (point) (progn (forward-line 1) (point))))
5702 ;; Take care of the case where the ls output contains a
5703 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5704 ;; and we went one line too far back (see above).
5706 (if (looking-at "//DIRED-OPTIONS//")
5707 (delete-region (point) (progn (forward-line 1) (point)))))
5709 ;; Now decode what read if necessary.
5710 (let ((coding (or coding-system-for-read
5711 file-name-coding-system
5712 default-file-name-coding-system
5716 (when (and enable-multibyte-characters
5717 (not (memq (coding-system-base coding)
5718 '(raw-text no-conversion))))
5719 ;; If no coding system is specified or detection is
5720 ;; requested, detect the coding.
5721 (if (eq (coding-system-base coding) 'undecided)
5722 (setq coding (detect-coding-region beg (point) t)))
5723 (if (not (eq (coding-system-base coding) 'undecided))
5726 (coding-system-change-eol-conversion coding 'unix))
5727 (narrow-to-region beg (point))
5728 (goto-char (point-min))
5731 val (get-text-property (point) 'dired-filename))
5732 (goto-char (next-single-property-change
5733 (point) 'dired-filename nil (point-max)))
5734 ;; Force no eol conversion on a file name, so
5735 ;; that CR is preserved.
5736 (decode-coding-region pos (point)
5737 (if val coding-no-eol coding))
5739 (put-text-property pos (point)
5740 'dired-filename t)))))))
5742 (if full-directory-p
5743 ;; Try to insert the amount of free space.
5746 ;; First find the line to put it on.
5747 (when (re-search-forward "^ *\\(total\\)" nil t)
5748 (let ((available (get-free-disk-space ".")))
5750 ;; Replace "total" with "used", to avoid confusion.
5751 (replace-match "total used in directory" nil nil nil 1)
5753 (insert " available " available))))))))))
5755 (defun insert-directory-adj-pos (pos error-lines)
5756 "Convert `ls --dired' file name position value POS to a buffer position.
5757 File name position values returned in ls --dired output
5758 count only stdout; they don't count the error messages sent to stderr.
5759 So this function converts to them to real buffer positions.
5760 ERROR-LINES is a list of buffer positions of error message lines,
5761 of the form (START END)."
5762 (while (and error-lines (< (caar error-lines) pos))
5763 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5767 (defun insert-directory-safely (file switches
5768 &optional wildcard full-directory-p)
5769 "Insert directory listing for FILE, formatted according to SWITCHES.
5771 Like `insert-directory', but if FILE does not exist, it inserts a
5772 message to that effect instead of signaling an error."
5773 (if (file-exists-p file)
5774 (insert-directory file switches wildcard full-directory-p)
5775 ;; Simulate the message printed by `ls'.
5776 (insert (format "%s: No such file or directory\n" file))))
5778 (defvar kill-emacs-query-functions nil
5779 "Functions to call with no arguments to query about killing Emacs.
5780 If any of these functions returns nil, killing Emacs is cancelled.
5781 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5782 the low level primitive, does not. See also `kill-emacs-hook'.")
5784 (defcustom confirm-kill-emacs nil
5785 "How to ask for confirmation when leaving Emacs.
5786 If nil, the default, don't ask at all. If the value is non-nil, it should
5787 be a predicate function such as `yes-or-no-p'."
5788 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5789 (const :tag "Ask with y-or-n-p" y-or-n-p)
5790 (const :tag "Don't confirm" nil))
5794 (defun save-buffers-kill-emacs (&optional arg)
5795 "Offer to save each buffer, then kill this Emacs process.
5796 With prefix ARG, silently save all file-visiting buffers, then kill."
5798 (save-some-buffers arg t)
5799 (and (or (not (memq t (mapcar (function
5800 (lambda (buf) (and (buffer-file-name buf)
5801 (buffer-modified-p buf))))
5803 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5804 (or (not (fboundp 'process-list))
5805 ;; process-list is not defined on MSDOS.
5806 (let ((processes (process-list))
5809 (and (memq (process-status (car processes)) '(run stop open listen))
5810 (process-query-on-exit-flag (car processes))
5812 (setq processes (cdr processes)))
5815 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5816 ;; Query the user for other things, perhaps.
5817 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5818 (or (null confirm-kill-emacs)
5819 (funcall confirm-kill-emacs "Really exit Emacs? "))
5822 (defun save-buffers-kill-terminal (&optional arg)
5823 "Offer to save each buffer, then kill the current connection.
5824 If the current frame has no client, kill Emacs itself.
5826 With prefix ARG, silently save all file-visiting buffers, then kill.
5828 If emacsclient was started with a list of filenames to edit, then
5829 only these files will be asked to be saved."
5831 (if (frame-parameter (selected-frame) 'client)
5832 (server-save-buffers-kill-terminal arg)
5833 (save-buffers-kill-emacs arg)))
5835 ;; We use /: as a prefix to "quote" a file name
5836 ;; so that magic file name handlers will not apply to it.
5838 (setq file-name-handler-alist
5839 (cons '("\\`/:" . file-name-non-special)
5840 file-name-handler-alist))
5842 ;; We depend on being the last handler on the list,
5843 ;; so that anything else which does need handling
5844 ;; has been handled already.
5845 ;; So it is safe for us to inhibit *all* magic file name handlers.
5847 (defun file-name-non-special (operation &rest arguments)
5848 (let ((file-name-handler-alist nil)
5850 (if (eq operation 'insert-directory)
5851 (directory-file-name
5853 (unhandled-file-name-directory default-directory)))
5855 ;; Get a list of the indices of the args which are file names.
5857 (cdr (or (assq operation
5858 ;; The first six are special because they
5859 ;; return a file name. We want to include the /:
5860 ;; in the return value.
5861 ;; So just avoid stripping it in the first place.
5862 '((expand-file-name . nil)
5863 (file-name-directory . nil)
5864 (file-name-as-directory . nil)
5865 (directory-file-name . nil)
5866 (file-name-sans-versions . nil)
5867 (find-backup-file-name . nil)
5868 ;; `identity' means just return the first arg
5869 ;; not stripped of its quoting.
5870 (substitute-in-file-name identity)
5871 ;; `add' means add "/:" to the result.
5872 (file-truename add 0)
5873 ;; `quote' means add "/:" to buffer-file-name.
5874 (insert-file-contents quote 0)
5875 ;; `unquote-then-quote' means set buffer-file-name
5876 ;; temporarily to unquoted filename.
5877 (verify-visited-file-modtime unquote-then-quote)
5878 ;; List the arguments which are filenames.
5879 (file-name-completion 1)
5880 (file-name-all-completions 1)
5884 (make-symbolic-link 0 1)
5885 (add-name-to-file 0 1)))
5886 ;; For all other operations, treat the first argument only
5887 ;; as the file name.
5890 ;; Copy ARGUMENTS so we can replace elements in it.
5891 (arguments (copy-sequence arguments)))
5892 (if (symbolp (car file-arg-indices))
5893 (setq method (pop file-arg-indices)))
5894 ;; Strip off the /: from the file names that have it.
5896 (while (consp file-arg-indices)
5897 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5899 (string-match "\\`/:" (car pair))
5901 (if (= (length (car pair)) 2)
5903 (substring (car pair) 2)))))
5904 (setq file-arg-indices (cdr file-arg-indices))))
5905 (cond ((eq method 'identity)
5908 (concat "/:" (apply operation arguments)))
5911 (apply operation arguments)
5912 (setq buffer-file-name (concat "/:" buffer-file-name))))
5913 ((eq method 'unquote-then-quote)
5915 (setq buffer-file-name (substring buffer-file-name 2))
5916 (setq res (apply operation arguments))
5917 (setq buffer-file-name (concat "/:" buffer-file-name))
5920 (apply operation arguments)))))
5922 ;; Symbolic modes and read-file-modes.
5924 (defun file-modes-char-to-who (char)
5925 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5926 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5927 Others, or All) for whom to produce the mask.
5928 The bit-mask that is returned extracts from mode bits the access rights
5929 for the specified category of users."
5930 (cond ((= char ?u) #o4700)
5931 ((= char ?g) #o2070)
5932 ((= char ?o) #o1007)
5933 ((= char ?a) #o7777)
5934 (t (error "%c: bad `who' character" char))))
5936 (defun file-modes-char-to-right (char &optional from)
5937 "Convert CHAR to a numeric value of mode bits.
5938 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5939 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5940 (or from (setq from 0))
5941 (cond ((= char ?r) #o0444)
5942 ((= char ?w) #o0222)
5943 ((= char ?x) #o0111)
5944 ((= char ?s) #o1000)
5945 ((= char ?t) #o6000)
5946 ;; Rights relative to the previous file modes.
5947 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5948 ((= char ?u) (let ((uright (logand #o4700 from)))
5949 (+ uright (/ uright #o10) (/ uright #o100))))
5950 ((= char ?g) (let ((gright (logand #o2070 from)))
5951 (+ gright (/ gright #o10) (* gright #o10))))
5952 ((= char ?o) (let ((oright (logand #o1007 from)))
5953 (+ oright (* oright #o10) (* oright #o100))))
5954 (t (error "%c: bad right character" char))))
5956 (defun file-modes-rights-to-number (rights who-mask &optional from)
5957 "Convert a symbolic mode string specification to an equivalent number.
5958 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
5959 WHO-MASK is the bit-mask specifying the category of users to which to
5960 apply the access permissions. See `file-modes-char-to-who'.
5961 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5962 RIGHTS request to add, remove, or set permissions based on existing ones,
5964 (let* ((num-rights (or from 0))
5965 (list-rights (string-to-list rights))
5966 (op (pop list-rights)))
5967 (while (memq op '(?+ ?- ?=))
5970 (while (memq (setq char-right (pop list-rights))
5971 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5974 (file-modes-char-to-right char-right num-rights))))
5975 (setq num-right (logand who-mask num-right)
5977 (cond ((= op ?+) (logior num-rights num-right))
5978 ((= op ?-) (logand num-rights (lognot num-right)))
5979 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5983 (defun file-modes-symbolic-to-number (modes &optional from)
5984 "Convert symbolic file modes to numeric file modes.
5985 MODES is the string to convert, it should match
5986 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
5987 See (info \"(coreutils)File permissions\") for more information on this
5989 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5990 MODES request to add, remove, or set permissions based on existing ones,
5993 (let ((case-fold-search nil)
5994 (num-modes (or from 0)))
5995 (while (/= (string-to-char modes) 0)
5996 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
5997 (let ((num-who (apply 'logior 0
5998 (mapcar 'file-modes-char-to-who
5999 (match-string 1 modes)))))
6001 (setq num-who (default-file-modes)))
6003 (file-modes-rights-to-number (substring modes (match-end 1))
6005 modes (substring modes (match-end 3))))
6006 (error "Parse error in modes near `%s'" (substring modes 0))))
6009 (defun read-file-modes (&optional prompt orig-file)
6010 "Read file modes in octal or symbolic notation and return its numeric value.
6011 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6012 ORIG-FILE is the name of a file on whose mode bits to base returned
6013 permissions if what user types requests to add, remove, or set permissions
6014 based on existing mode bits, as in \"og+rX-w\"."
6015 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6016 (error "File not found")))
6017 (modestr (and (stringp orig-file)
6018 (nth 8 (file-attributes orig-file))))
6020 (and (stringp modestr)
6021 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6022 (replace-regexp-in-string
6024 (format "u=%s,g=%s,o=%s"
6025 (match-string 1 modestr)
6026 (match-string 2 modestr)
6027 (match-string 3 modestr)))))
6028 (value (read-string (or prompt "File modes (octal or symbolic): ")
6031 (if (string-match "^[0-7]+" value)
6032 (string-to-number value 8)
6033 (file-modes-symbolic-to-number value modes)))))
6036 ;; Trashcan handling.
6037 (defcustom trash-directory nil
6038 "Directory for `move-file-to-trash' to move files and directories to.
6039 This directory is only used when the function `system-move-file-to-trash'
6041 Relative paths are interpreted relative to `default-directory'.
6042 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6043 :type '(choice (const nil) directory)
6047 (defvar trash--hexify-table)
6049 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6051 (defun move-file-to-trash (filename)
6052 "Move the file (or directory) named FILENAME to the trash.
6053 When `delete-by-moving-to-trash' is non-nil, this function is
6054 called by `delete-file' and `delete-directory' instead of
6055 deleting files outright.
6057 If the function `system-move-file-to-trash' is defined, call it
6058 with FILENAME as an argument.
6059 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6061 Otherwise, trash FILENAME using the freedesktop.org conventions,
6062 like the GNOME, KDE and XFCE desktop environments. Emacs only
6063 moves files to \"home trash\", ignoring per-volume trashcans."
6064 (interactive "fMove file to trash: ")
6065 (cond (trash-directory
6066 ;; If `trash-directory' is non-nil, move the file there.
6067 (let* ((trash-dir (expand-file-name trash-directory))
6068 (fn (directory-file-name (expand-file-name filename)))
6069 (new-fn (expand-file-name (file-name-nondirectory fn)
6071 ;; We can't trash a parent directory of trash-directory.
6072 (if (string-match fn trash-dir)
6073 (error "Trash directory `%s' is a subdirectory of `%s'"
6074 trash-dir filename))
6075 (unless (file-directory-p trash-dir)
6076 (make-directory trash-dir t))
6077 ;; Ensure that the trashed file-name is unique.
6078 (if (file-exists-p new-fn)
6079 (let ((version-control t)
6080 (backup-directory-alist nil))
6081 (setq new-fn (car (find-backup-file-name new-fn)))))
6082 (let (delete-by-moving-to-trash)
6083 (rename-file fn new-fn))))
6084 ;; If `system-move-file-to-trash' is defined, use it.
6085 ((fboundp 'system-move-file-to-trash)
6086 (system-move-file-to-trash filename))
6087 ;; Otherwise, use the freedesktop.org method, as specified at
6088 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6090 (let* ((xdg-data-dir
6091 (directory-file-name
6092 (expand-file-name "Trash"
6093 (or (getenv "XDG_DATA_HOME")
6094 "~/.local/share"))))
6095 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6096 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6097 (fn (directory-file-name (expand-file-name filename))))
6099 ;; Check if we have permissions to delete.
6100 (unless (file-writable-p (directory-file-name
6101 (file-name-directory fn)))
6102 (error "Cannot move %s to trash: Permission denied" filename))
6103 ;; The trashed file cannot be the trash dir or its parent.
6104 (if (string-match fn trash-files-dir)
6105 (error "The trash directory %s is a subdirectory of %s"
6106 trash-files-dir filename))
6107 (if (string-match fn trash-info-dir)
6108 (error "The trash directory %s is a subdirectory of %s"
6109 trash-info-dir filename))
6111 ;; Ensure that the trash directory exists; otherwise, create it.
6112 (let ((saved-default-file-modes (default-file-modes)))
6113 (set-default-file-modes ?\700)
6114 (unless (file-exists-p trash-files-dir)
6115 (make-directory trash-files-dir t))
6116 (unless (file-exists-p trash-info-dir)
6117 (make-directory trash-info-dir t))
6118 (set-default-file-modes saved-default-file-modes))
6120 ;; Try to move to trash with .trashinfo undo information
6123 (set-buffer-file-coding-system 'utf-8-unix)
6124 (insert "[Trash Info]\nPath=")
6125 ;; Perform url-encoding on FN. For compatibility with
6126 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6127 ;; for path separators.
6128 (unless (boundp 'trash--hexify-table)
6129 (setq trash--hexify-table (make-vector 256 nil))
6130 (let ((unreserved-chars
6131 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6132 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6133 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6134 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6135 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6138 (aset trash--hexify-table byte
6139 (if (memq byte unreserved-chars)
6140 (char-to-string byte)
6141 (format "%%%02x" byte))))))
6142 (mapc (lambda (byte)
6143 (insert (aref trash--hexify-table byte)))
6144 (if (multibyte-string-p fn)
6145 (encode-coding-string fn 'utf-8)
6147 (insert "\nDeletionDate="
6148 (format-time-string "%Y-%m-%dT%T")
6151 ;; Attempt to make .trashinfo file, trying up to 5
6152 ;; times. The .trashinfo file is opened with O_EXCL,
6153 ;; as per trash-spec 0.7, even if that can be a problem
6154 ;; on old NFS versions...
6156 (base-fn (expand-file-name
6157 (file-name-nondirectory fn)
6162 (setq info-fn (expand-file-name
6163 (concat (file-name-nondirectory new-fn)
6166 (unless (condition-case nil
6168 (write-region nil nil info-fn nil
6169 'quiet info-fn 'excl)
6170 (setq tries 0 success t))
6171 (file-already-exists nil))
6172 (setq tries (1- tries))
6173 ;; Uniqify new-fn. (Some file managers do not
6174 ;; like Emacs-style backup file names---e.g. bug
6175 ;; 170956 in Konqueror bug tracker.)
6176 (setq new-fn (make-temp-name (concat base-fn "_")))))
6178 (error "Cannot move %s to trash: Lock failed" filename))
6180 ;; Finally, try to move the file to the trashcan.
6181 (let ((delete-by-moving-to-trash nil))
6182 (rename-file fn new-fn)))))))))
6185 (define-key ctl-x-map "\C-f" 'find-file)
6186 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6187 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6188 (define-key ctl-x-map "\C-s" 'save-buffer)
6189 (define-key ctl-x-map "s" 'save-some-buffers)
6190 (define-key ctl-x-map "\C-w" 'write-file)
6191 (define-key ctl-x-map "i" 'insert-file)
6192 (define-key esc-map "~" 'not-modified)
6193 (define-key ctl-x-map "\C-d" 'list-directory)
6194 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6195 (define-key ctl-x-map "\C-q" 'toggle-read-only)
6197 (define-key ctl-x-4-map "f" 'find-file-other-window)
6198 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6199 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6200 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6201 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6203 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6204 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6205 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6206 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6207 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6209 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6210 ;;; files.el ends here