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 (eval-when-compile (require 'cl))
34 (defvar font-lock-keywords)
37 "Backups of edited data files."
40 (defgroup find-file nil
45 (defcustom delete-auto-save-files t
46 "Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
53 (defcustom directory-abbrev-alist
55 "Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
59 *Every* FROM string should start with `^'.
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
68 :type '(repeat (cons :format "%v"
75 (defcustom make-backup-files t
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
98 (defvar backup-inhibited nil
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
101 But it is local only if you make it local.")
102 (put 'backup-inhibited 'permanent-local t)
104 (defcustom backup-by-copying nil
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
110 (defcustom backup-by-copying-when-linked nil
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
117 (defcustom backup-by-copying-when-mismatch nil
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
127 (defcustom backup-by-copying-when-privileged-mismatch 200
128 "Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
136 :type '(choice (const nil) integer)
139 (defvar backup-enable-predicate 'normal-backup-enable-predicate
140 "Predicate that looks at a file name and decides whether to make backups.
141 Called with an absolute file name as argument, it returns t to enable backup.")
143 (defcustom buffer-offer-save nil
144 "Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
149 (make-variable-buffer-local 'buffer-offer-save)
151 (defcustom find-file-existing-other-name t
152 "Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
158 (defcustom find-file-visit-truename nil
159 "Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
164 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
166 (defcustom revert-without-query nil
167 "Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
172 :type '(repeat regexp)
175 (defvar buffer-file-number nil
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
179 If the buffer is visiting a new file, the value is nil.")
180 (make-variable-buffer-local 'buffer-file-number)
181 (put 'buffer-file-number 'permanent-local t)
183 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
184 "Non-nil means that `buffer-file-number' uniquely identifies files.")
186 (defvar buffer-file-read-only nil
187 "Non-nil if visited file was read-only when visited.")
188 (make-variable-buffer-local 'buffer-file-read-only)
190 (defcustom temporary-file-directory
191 (file-name-as-directory
192 (cond ((memq system-type '(ms-dos windows-nt))
193 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
195 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
196 "The directory for writing temporary files."
200 (defcustom small-temporary-file-directory
201 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
202 "The directory for writing small temporary files.
203 If non-nil, this directory is used instead of `temporary-file-directory'
204 by programs that create small temporary files. This is for systems that
205 have fast storage with limited space, such as a RAM disk."
207 :type '(choice (const nil) directory))
209 ;; The system null device. (Should reference NULL_DEVICE from C.)
210 (defvar null-device "/dev/null" "The system null device.")
212 (declare-function msdos-long-file-names "msdos.c")
213 (declare-function w32-long-file-name "w32proc.c")
214 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
215 (declare-function dired-unmark "dired" (arg))
216 (declare-function dired-do-flagged-delete "dired" (&optional nomessage))
217 (declare-function dos-8+3-filename "dos-fns" (filename))
218 (declare-function view-mode-disable "view" ())
219 (declare-function dosified-file-name "dos-fns" (file-name))
221 (defvar file-name-invalid-regexp
222 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
223 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
224 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
225 "[\000-\037]\\|" ; control characters
226 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
227 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
228 ((memq system-type '(ms-dos windows-nt cygwin))
229 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
230 "[|<>\"?*\000-\037]")) ; invalid characters
232 "Regexp recognizing file names which aren't allowed by the filesystem.")
234 (defcustom file-precious-flag nil
235 "Non-nil means protect against I/O errors while saving files.
236 Some modes set this non-nil in particular buffers.
238 This feature works by writing the new contents into a temporary file
239 and then renaming the temporary file to replace the original.
240 In this way, any I/O error in writing leaves the original untouched,
241 and there is never any instant where the file is nonexistent.
243 Note that this feature forces backups to be made by copying.
244 Yet, at the same time, saving a precious file
245 breaks any hard links between it and other files.
247 This feature is advisory: for example, if the directory in which the
248 file is being saved is not writable, Emacs may ignore a non-nil value
249 of `file-precious-flag' and write directly into the file.
251 See also: `break-hardlink-on-save'."
255 (defcustom break-hardlink-on-save nil
256 "Non-nil means when saving a file that exists under several names
257 \(i.e., has multiple hardlinks), break the hardlink associated with
258 `buffer-file-name' and write to a new file, so that the other
259 instances of the file are not affected by the save.
261 If `buffer-file-name' refers to a symlink, do not break the symlink.
263 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
264 For example, if the directory in which a file is being saved is not
265 itself writable, then error instead of saving in some
266 hardlink-nonbreaking way.
268 See also `backup-by-copying' and `backup-by-copying-when-linked'."
273 (defcustom version-control nil
274 "Control use of version numbers for backup files.
275 When t, make numeric backup versions unconditionally.
276 When nil, make them for files that have some already.
277 The value `never' means do not make them."
278 :type '(choice (const :tag "Never" never)
279 (const :tag "If existing" nil)
280 (other :tag "Always" t))
283 (put 'version-control 'safe-local-variable
284 '(lambda (x) (or (booleanp x) (equal x 'never))))
286 (defcustom dired-kept-versions 2
287 "When cleaning directory, number of versions to keep."
292 (defcustom delete-old-versions nil
293 "If t, delete excess backup versions silently.
294 If nil, ask confirmation. Any other value prevents any trimming."
295 :type '(choice (const :tag "Delete" t)
296 (const :tag "Ask" nil)
297 (other :tag "Leave" other))
300 (defcustom kept-old-versions 2
301 "Number of oldest versions to keep when a new numbered backup is made."
304 (put 'kept-old-versions 'safe-local-variable 'integerp)
306 (defcustom kept-new-versions 2
307 "Number of newest versions to keep when a new numbered backup is made.
308 Includes the new backup. Must be > 0"
311 (put 'kept-new-versions 'safe-local-variable 'integerp)
313 (defcustom require-final-newline nil
314 "Whether to add a newline automatically at the end of the file.
316 A value of t means do this only when the file is about to be saved.
317 A value of `visit' means do this right after the file is visited.
318 A value of `visit-save' means do it at both of those times.
319 Any other non-nil value means ask user whether to add a newline, when saving.
320 A value of nil means don't add newlines.
322 Certain major modes set this locally to the value obtained
323 from `mode-require-final-newline'."
324 :type '(choice (const :tag "When visiting" visit)
325 (const :tag "When saving" t)
326 (const :tag "When visiting or saving" visit-save)
327 (const :tag "Don't add newlines" nil)
328 (other :tag "Ask each time" ask))
329 :group 'editing-basics)
331 (defcustom mode-require-final-newline t
332 "Whether to add a newline at end of file, in certain major modes.
333 Those modes set `require-final-newline' to this value when you enable them.
334 They do so because they are often used for files that are supposed
335 to end in newlines, and the question is how to arrange that.
337 A value of t means do this only when the file is about to be saved.
338 A value of `visit' means do this right after the file is visited.
339 A value of `visit-save' means do it at both of those times.
340 Any other non-nil value means ask user whether to add a newline, when saving.
342 A value of nil means do not add newlines. That is a risky choice in this
343 variable since this value is used for modes for files that ought to have
344 final newlines. So if you set this to nil, you must explicitly check and
345 add a final newline, whenever you save a file that really needs one."
346 :type '(choice (const :tag "When visiting" visit)
347 (const :tag "When saving" t)
348 (const :tag "When visiting or saving" visit-save)
349 (const :tag "Don't add newlines" nil)
350 (other :tag "Ask each time" ask))
351 :group 'editing-basics
354 (defcustom auto-save-default t
355 "Non-nil says by default do auto-saving of every file-visiting buffer."
359 (defcustom auto-save-file-name-transforms
360 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
361 ;; Don't put "\\2" inside expand-file-name, since it will be
362 ;; transformed to "/2" on DOS/Windows.
363 ,(concat temporary-file-directory "\\2") t))
364 "Transforms to apply to buffer file name before making auto-save file name.
365 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
366 REGEXP is a regular expression to match against the file name.
367 If it matches, `replace-match' is used to replace the
368 matching part with REPLACEMENT.
369 If the optional element UNIQUIFY is non-nil, the auto-save file name is
370 constructed by taking the directory part of the replaced file-name,
371 concatenated with the buffer file name with all directory separators
372 changed to `!' to prevent clashes. This will not work
373 correctly if your filesystem truncates the resulting name.
375 All the transforms in the list are tried, in the order they are listed.
376 When one transform applies, its result is final;
377 no further transforms are tried.
379 The default value is set up to put the auto-save file into the
380 temporary directory (see the variable `temporary-file-directory') for
381 editing a remote file.
383 On MS-DOS filesystems without long names this variable is always
386 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
387 (boolean :tag "Uniquify")))
390 (defcustom save-abbrevs t
391 "Non-nil means save word abbrevs too when files are saved.
392 If `silently', don't ask the user before saving."
393 :type '(choice (const t) (const nil) (const silently))
396 (defcustom find-file-run-dired t
397 "Non-nil means allow `find-file' to visit directories.
398 To visit the directory, `find-file' runs `find-directory-functions'."
402 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
403 "List of functions to try in sequence to visit a directory.
404 Each function is called with the directory name as the sole argument
405 and should return either a buffer or nil."
406 :type '(hook :options (cvs-dired-noselect dired-noselect))
409 ;;;It is not useful to make this a local variable.
410 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
411 (defvar find-file-not-found-functions nil
412 "List of functions to be called for `find-file' on nonexistent file.
413 These functions are called as soon as the error is detected.
414 Variable `buffer-file-name' is already set up.
415 The functions are called in the order given until one of them returns non-nil.")
416 (define-obsolete-variable-alias 'find-file-not-found-hooks
417 'find-file-not-found-functions "22.1")
419 ;;;It is not useful to make this a local variable.
420 ;;;(put 'find-file-hooks 'permanent-local t)
421 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
422 (defcustom find-file-hook nil
423 "List of functions to be called after a buffer is loaded from a file.
424 The buffer's local variables (if any) will have been processed before the
425 functions are called."
428 :options '(auto-insert)
431 (defvar write-file-functions nil
432 "List of functions to be called before writing out a buffer to a file.
433 If one of them returns non-nil, the file is considered already written
434 and the rest are not called.
435 These hooks are considered to pertain to the visited file.
436 So any buffer-local binding of this variable is discarded if you change
437 the visited file name with \\[set-visited-file-name], but not when you
438 change the major mode.
440 This hook is not run if any of the functions in
441 `write-contents-functions' returns non-nil. Both hooks pertain
442 to how to save a buffer to file, for instance, choosing a suitable
443 coding system and setting mode bits. (See Info
444 node `(elisp)Saving Buffers'.) To perform various checks or
445 updates before the buffer is saved, use `before-save-hook'.")
446 (put 'write-file-functions 'permanent-local t)
447 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
449 (defvar local-write-file-hooks nil)
450 (make-variable-buffer-local 'local-write-file-hooks)
451 (put 'local-write-file-hooks 'permanent-local t)
452 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
454 (defvar write-contents-functions nil
455 "List of functions to be called before writing out a buffer to a file.
456 If one of them returns non-nil, the file is considered already written
457 and the rest are not called and neither are the functions in
458 `write-file-functions'.
460 This variable is meant to be used for hooks that pertain to the
461 buffer's contents, not to the particular visited file; thus,
462 `set-visited-file-name' does not clear this variable; but changing the
463 major mode does clear it.
465 For hooks that _do_ pertain to the particular visited file, use
466 `write-file-functions'. Both this variable and
467 `write-file-functions' relate to how a buffer is saved to file.
468 To perform various checks or updates before the buffer is saved,
469 use `before-save-hook'.")
470 (make-variable-buffer-local 'write-contents-functions)
471 (define-obsolete-variable-alias 'write-contents-hooks
472 'write-contents-functions "22.1")
474 (defcustom enable-local-variables t
475 "Control use of local variables in files you visit.
476 The value can be t, nil, :safe, :all, or something else.
478 A value of t means file local variables specifications are obeyed
479 if all the specified variable values are safe; if any values are
480 not safe, Emacs queries you, once, whether to set them all.
481 \(When you say yes to certain values, they are remembered as safe.)
483 :safe means set the safe variables, and ignore the rest.
484 :all means set all variables, whether safe or not.
485 (Don't set it permanently to :all.)
486 A value of nil means always ignore the file local variables.
488 Any other value means always query you once whether to set them all.
489 \(When you say yes to certain values, they are remembered as safe, but
490 this has no effect when `enable-local-variables' is \"something else\".)
492 This variable also controls use of major modes specified in
495 The command \\[normal-mode], when used interactively,
496 always obeys file local variable specifications and the -*- line,
497 and ignores this variable."
499 :type '(choice (const :tag "Query Unsafe" t)
500 (const :tag "Safe Only" :safe)
501 (const :tag "Do all" :all)
502 (const :tag "Ignore" nil)
503 (other :tag "Query" other))
506 (defvar local-enable-local-variables t
507 "Like `enable-local-variables' but meant for buffer-local bindings.
508 The meaningful values are nil and non-nil. The default is non-nil.
509 If a major mode sets this to nil, buffer-locally, then any local
510 variables list in the file will be ignored.
512 This variable does not affect the use of major modes
513 specified in a -*- line.")
515 (defcustom enable-local-eval 'maybe
516 "Control processing of the \"variable\" `eval' in a file's local variables.
517 The value can be t, nil or something else.
518 A value of t means obey `eval' variables.
519 A value of nil means ignore them; anything else means query."
521 :type '(choice (const :tag "Obey" t)
522 (const :tag "Ignore" nil)
523 (other :tag "Query" other))
526 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
527 (or (fboundp 'lock-buffer)
528 (defalias 'lock-buffer 'ignore))
529 (or (fboundp 'unlock-buffer)
530 (defalias 'unlock-buffer 'ignore))
531 (or (fboundp 'file-locked-p)
532 (defalias 'file-locked-p 'ignore))
534 (defcustom view-read-only nil
535 "Non-nil means buffers visiting files read-only do so in view mode.
536 In fact, this means that all read-only buffers normally have
537 View mode enabled, including buffers that are read-only because
538 you visit a file you cannot alter, and buffers you make read-only
539 using \\[toggle-read-only]."
543 (defvar file-name-history nil
544 "History list of file names entered in the minibuffer.
546 Maximum length of the history list is determined by the value
547 of `history-length', which see.")
549 (put 'ange-ftp-completion-hook-function 'safe-magic t)
550 (defun ange-ftp-completion-hook-function (op &rest args)
551 "Provides support for ange-ftp host name completion.
552 Runs the usual ange-ftp hook, but only for completion operations."
553 ;; Having this here avoids the need to load ange-ftp when it's not
555 (if (memq op '(file-name-completion file-name-all-completions))
556 (apply 'ange-ftp-hook-function op args)
557 (let ((inhibit-file-name-handlers
558 (cons 'ange-ftp-completion-hook-function
559 (and (eq inhibit-file-name-operation op)
560 inhibit-file-name-handlers)))
561 (inhibit-file-name-operation op))
564 (defun convert-standard-filename (filename)
565 "Convert a standard file's name to something suitable for the OS.
566 This means to guarantee valid names and perhaps to canonicalize
569 FILENAME should be an absolute file name since the conversion rules
570 sometimes vary depending on the position in the file name. E.g. c:/foo
571 is a valid DOS file name, but c:/bar/c:/foo is not.
573 This function's standard definition is trivial; it just returns
574 the argument. However, on Windows and DOS, replace invalid
575 characters. On DOS, make sure to obey the 8.3 limitations.
576 In the native Windows build, turn Cygwin names into native names,
577 and also turn slashes into backslashes if the shell requires it (see
578 `w32-shell-dos-semantics').
580 See Info node `(elisp)Standard File Names' for more details."
581 (if (eq system-type 'cygwin)
582 (let ((name (copy-sequence filename))
584 ;; Replace invalid filename characters with !
585 (while (string-match "[?*:<>|\"\000-\037]" name start)
586 (aset name (match-beginning 0) ?!)
587 (setq start (match-end 0)))
591 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
592 "Read directory name, prompting with PROMPT and completing in directory DIR.
593 Value is not expanded---you must call `expand-file-name' yourself.
594 Default name to DEFAULT-DIRNAME if user exits with the same
595 non-empty string that was inserted by this function.
596 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
597 or just DIR if INITIAL is nil.)
598 If the user exits with an empty minibuffer, this function returns
599 an empty string. (This can only happen if the user erased the
600 pre-inserted contents or if `insert-default-directory' is nil.)
601 Fourth arg MUSTMATCH non-nil means require existing directory's name.
602 Non-nil and non-t means also require confirmation after completion.
603 Fifth arg INITIAL specifies text to start with.
604 DIR should be an absolute directory name. It defaults to
605 the value of `default-directory'."
607 (setq dir default-directory))
608 (read-file-name prompt dir (or default-dirname
609 (if initial (expand-file-name initial dir)
616 "Show the current default directory."
618 (message "Directory %s" default-directory))
621 "Value of the CDPATH environment variable, as a list.
622 Not actually set up until the first time you use it.")
624 (defun parse-colon-path (cd-path)
625 "Explode a search path into a list of directory names.
626 Directories are separated by occurrences of `path-separator'
627 \(which is colon in GNU and GNU-like systems)."
628 ;; We could use split-string here.
630 (let (cd-list (cd-start 0) cd-colon)
631 (setq cd-path (concat cd-path path-separator))
632 (while (setq cd-colon (string-match path-separator cd-path cd-start))
635 (list (if (= cd-start cd-colon)
637 (substitute-in-file-name
638 (file-name-as-directory
639 (substring cd-path cd-start cd-colon)))))))
640 (setq cd-start (+ cd-colon 1)))
643 (defun cd-absolute (dir)
644 "Change current directory to given absolute file name DIR."
645 ;; Put the name into directory syntax now,
646 ;; because otherwise expand-file-name may give some bad results.
647 (setq dir (file-name-as-directory dir))
648 (setq dir (abbreviate-file-name (expand-file-name dir)))
649 (if (not (file-directory-p dir))
650 (if (file-exists-p dir)
651 (error "%s is not a directory" dir)
652 (error "%s: no such directory" dir))
653 (unless (file-executable-p dir)
654 (error "Cannot cd to %s: Permission denied" dir))
655 (setq default-directory dir)
656 (set (make-local-variable 'list-buffers-directory) dir)))
659 "Make DIR become the current buffer's default directory.
660 If your environment includes a `CDPATH' variable, try each one of
661 that list of directories (separated by occurrences of
662 `path-separator') when resolving a relative directory name.
663 The path separator is colon in GNU and GNU-like systems."
665 (list (read-directory-name "Change default directory: "
666 default-directory default-directory
667 (and (member cd-path '(nil ("./")))
668 (null (getenv "CDPATH"))))))
669 (if (file-name-absolute-p dir)
670 (cd-absolute (expand-file-name dir))
672 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
673 (setq cd-path (or trypath (list "./")))))
674 (if (not (catch 'found
676 (function (lambda (x)
677 (let ((f (expand-file-name (concat x dir))))
678 (if (file-directory-p f)
681 (throw 'found t))))))
684 (error "No such directory found via CDPATH environment variable"))))
686 (defun load-file (file)
687 "Load the Lisp file named FILE."
688 ;; This is a case where .elc makes a lot of sense.
689 (interactive (list (let ((completion-ignored-extensions
690 (remove ".elc" completion-ignored-extensions)))
691 (read-file-name "Load file: "))))
692 (load (expand-file-name file) nil nil t))
694 (defun locate-file (filename path &optional suffixes predicate)
695 "Search for FILENAME through PATH.
696 If found, return the absolute file name of FILENAME, with its suffixes;
697 otherwise return nil.
698 PATH should be a list of directories to look in, like the lists in
699 `exec-path' or `load-path'.
700 If SUFFIXES is non-nil, it should be a list of suffixes to append to
701 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
702 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
703 If non-nil, PREDICATE is used instead of `file-readable-p'.
704 PREDICATE can also be an integer to pass to the `access' system call,
705 in which case file-name handlers are ignored. This usage is deprecated.
707 For compatibility, PREDICATE can also be one of the symbols
708 `executable', `readable', `writable', or `exists', or a list of
709 one or more of those symbols."
710 (if (and predicate (symbolp predicate) (not (functionp predicate)))
711 (setq predicate (list predicate)))
712 (when (and (consp predicate) (not (functionp predicate)))
714 (logior (if (memq 'executable predicate) 1 0)
715 (if (memq 'writable predicate) 2 0)
716 (if (memq 'readable predicate) 4 0))))
717 (locate-file-internal filename path suffixes predicate))
719 (defun locate-file-completion-table (dirs suffixes string pred action)
720 "Do completion for file names passed to `locate-file'."
722 ((file-name-absolute-p string)
723 (let ((read-file-name-predicate pred))
724 (read-file-name-internal string nil action)))
725 ((eq (car-safe action) 'boundaries)
726 (let ((suffix (cdr action)))
728 (length (file-name-directory string))
729 (let ((x (file-name-directory suffix)))
730 (if x (1- (length x)) (length suffix))))))
733 (suffix (concat (regexp-opt suffixes t) "\\'"))
734 (string-dir (file-name-directory string))
735 (string-file (file-name-nondirectory string)))
738 (setq dir default-directory))
739 (if string-dir (setq dir (expand-file-name string-dir dir)))
740 (when (file-directory-p dir)
741 (dolist (file (file-name-all-completions
744 (when (string-match suffix file)
745 (setq file (substring file 0 (match-beginning 0)))
746 (push file names)))))
747 (completion-table-with-context
748 string-dir names string-file pred action)))))
750 (defun locate-file-completion (string path-and-suffixes action)
751 "Do completion for file names passed to `locate-file'.
752 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
753 (locate-file-completion-table (car path-and-suffixes)
754 (cdr path-and-suffixes)
756 (make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
758 (defvar locate-dominating-stop-dir-regexp
759 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
760 "Regexp of directory names which stop the search in `locate-dominating-file'.
761 Any directory whose name matches this regexp will be treated like
762 a kind of root directory by `locate-dominating-file' which will stop its search
763 when it bumps into it.
764 The default regexp prevents fruitless and time-consuming attempts to find
765 special files in directories in which filenames are interpreted as hostnames,
766 or mount points potentially requiring authentication as a different user.")
768 ;; (defun locate-dominating-files (file regexp)
769 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
770 ;; Stop at the first parent where a matching file is found and return the list
771 ;; of files that that match in this directory."
773 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
774 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
776 ;; ;; Abbreviate, so as to stop when we cross ~/.
777 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
780 ;; ;; As a heuristic, we stop looking up the hierarchy of
781 ;; ;; directories as soon as we find a directory belonging to
782 ;; ;; another user. This should save us from looking in
783 ;; ;; things like /net and /afs. This assumes that all the
784 ;; ;; files inside a project belong to the same user.
785 ;; (let ((prev-user user))
786 ;; (setq user (nth 2 (file-attributes dir)))
787 ;; (or (null prev-user) (equal user prev-user))))
788 ;; (if (setq files (condition-case nil
789 ;; (directory-files dir 'full regexp 'nosort)
791 ;; (throw 'found files)
793 ;; (setq dir (file-name-directory
794 ;; (directory-file-name dir))))
798 (defun locate-dominating-file (file name)
799 "Look up the directory hierarchy from FILE for a file named NAME.
800 Stop at the first parent directory containing a file NAME,
801 and return the directory. Return nil if not found."
802 ;; We used to use the above locate-dominating-files code, but the
803 ;; directory-files call is very costly, so we're much better off doing
804 ;; multiple calls using the code in here.
806 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
807 ;; `name' in /home or in /.
808 (setq file (abbreviate-file-name file))
811 ;; `user' is not initialized outside the loop because
812 ;; `file' may not exist, so we may have to walk up part of the
813 ;; hierarchy before we find the "initial UID".
818 ;; FIXME: Disabled this heuristic because it is sometimes
820 ;; As a heuristic, we stop looking up the hierarchy of
821 ;; directories as soon as we find a directory belonging
822 ;; to another user. This should save us from looking in
823 ;; things like /net and /afs. This assumes that all the
824 ;; files inside a project belong to the same user.
825 ;; (let ((prev-user user))
826 ;; (setq user (nth 2 (file-attributes file)))
827 ;; (and prev-user (not (equal user prev-user))))
828 (string-match locate-dominating-stop-dir-regexp file)))
829 (setq try (file-exists-p (expand-file-name name file)))
830 (cond (try (setq root file))
831 ((equal file (setq prev-file file
832 file (file-name-directory
833 (directory-file-name file))))
838 (defun executable-find (command)
839 "Search for COMMAND in `exec-path' and return the absolute file name.
840 Return nil if COMMAND is not found anywhere in `exec-path'."
841 ;; Use 1 rather than file-executable-p to better match the behavior of
843 (locate-file command exec-path exec-suffixes 1))
845 (defun load-library (library)
846 "Load the Emacs Lisp library named LIBRARY.
847 This is an interface to the function `load'. LIBRARY is searched
848 for in `load-path', both with and without `load-suffixes' (as
849 well as `load-file-rep-suffixes').
851 See Info node `(emacs)Lisp Libraries' for more details.
852 See `load-file' for a different interface to `load'."
854 (list (completing-read "Load library: "
855 (apply-partially 'locate-file-completion-table
857 (get-load-suffixes)))))
860 (defun file-remote-p (file &optional identification connected)
861 "Test whether FILE specifies a location on a remote system.
862 Returns nil or a string identifying the remote connection (ideally
863 a prefix of FILE). For example, the remote identification for filename
864 \"/user@host:/foo\" could be \"/user@host:\".
865 A file is considered \"remote\" if accessing it is likely to be slower or
866 less reliable than accessing local files.
867 Furthermore, relative file names do not work across remote connections.
869 IDENTIFICATION specifies which part of the identification shall
870 be returned as string. IDENTIFICATION can be the symbol
871 `method', `user', `host' or `localname'; any other value is
872 handled like nil and means to return the complete identification
875 If CONNECTED is non-nil, the function returns an identification only
876 if FILE is located on a remote system, and a connection is established
877 to that remote system.
879 `file-remote-p' will never open a connection on its own."
880 (let ((handler (find-file-name-handler file 'file-remote-p)))
882 (funcall handler 'file-remote-p file identification connected)
885 (defun file-local-copy (file)
886 "Copy the file FILE into a temporary file on this machine.
887 Returns the name of the local copy, or nil, if FILE is directly
889 ;; This formerly had an optional BUFFER argument that wasn't used by
891 (let ((handler (find-file-name-handler file 'file-local-copy)))
893 (funcall handler 'file-local-copy file)
896 (defun file-truename (filename &optional counter prev-dirs)
897 "Return the truename of FILENAME, which should be absolute.
898 The truename of a file name is found by chasing symbolic links
899 both at the level of the file and at the level of the directories
900 containing it, until no links are left at any level.
902 \(fn FILENAME)" ;; Don't document the optional arguments.
903 ;; COUNTER and PREV-DIRS are only used in recursive calls.
904 ;; COUNTER can be a cons cell whose car is the count of how many
905 ;; more links to chase before getting an error.
906 ;; PREV-DIRS can be a cons cell whose car is an alist
907 ;; of truenames we've just recently computed.
908 (cond ((or (string= filename "") (string= filename "~"))
909 (setq filename (expand-file-name filename))
910 (if (string= filename "")
911 (setq filename "/")))
912 ((and (string= (substring filename 0 1) "~")
913 (string-match "~[^/]*/?" filename))
915 (substring filename 0 (match-end 0)))
916 (rest (substring filename (match-end 0))))
917 (setq filename (concat (expand-file-name first-part) rest)))))
919 (or counter (setq counter (list 100)))
921 ;; For speed, remove the ange-ftp completion handler from the list.
922 ;; We know it's not needed here.
923 ;; For even more speed, do this only on the outermost call.
924 (file-name-handler-alist
925 (if prev-dirs file-name-handler-alist
926 (let ((tem (copy-sequence file-name-handler-alist)))
927 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
928 (or prev-dirs (setq prev-dirs (list nil)))
930 ;; andrewi@harlequin.co.uk - none of the following code (except for
931 ;; invoking the file-name handler) currently applies on Windows
932 ;; (ie. there are no native symlinks), but there is an issue with
933 ;; case differences being ignored by the OS, and short "8.3 DOS"
934 ;; name aliases existing for all files. (The short names are not
935 ;; reported by directory-files, but can be used to refer to files.)
936 ;; It seems appropriate for file-truename to resolve these issues in
937 ;; the most natural way, which on Windows is to call the function
938 ;; `w32-long-file-name' - this returns the exact name of a file as
939 ;; it is stored on disk (expanding short name aliases with the full
940 ;; name in the process).
941 (if (eq system-type 'windows-nt)
942 (let ((handler (find-file-name-handler filename 'file-truename)))
943 ;; For file name that has a special handler, call handler.
944 ;; This is so that ange-ftp can save time by doing a no-op.
946 (setq filename (funcall handler 'file-truename filename))
947 ;; If filename contains a wildcard, newname will be the old name.
948 (unless (string-match "[[*?]" filename)
949 ;; If filename exists, use the long name. If it doesn't exist,
950 ;; drill down until we find a directory that exists, and use
951 ;; the long name of that, with the extra non-existent path
952 ;; components concatenated.
953 (let ((longname (w32-long-file-name filename))
956 (setq filename longname)
957 ;; Include the preceding directory separator in the missing
958 ;; part so subsequent recursion on the rest works.
959 (setq missing (concat "/" (file-name-nondirectory filename)))
960 (let ((length (length missing)))
962 (if (> length (length filename))
964 (substring filename 0 (- length)))))
965 (setq filename (concat (file-truename rest) missing))))))
968 ;; If this file directly leads to a link, process that iteratively
969 ;; so that we don't use lots of stack.
971 (setcar counter (1- (car counter)))
972 (if (< (car counter) 0)
973 (error "Apparent cycle of symbolic links for %s" filename))
974 (let ((handler (find-file-name-handler filename 'file-truename)))
975 ;; For file name that has a special handler, call handler.
976 ;; This is so that ange-ftp can save time by doing a no-op.
978 (setq filename (funcall handler 'file-truename filename)
980 (let ((dir (or (file-name-directory filename) default-directory))
982 ;; Get the truename of the directory.
983 (setq dirfile (directory-file-name dir))
984 ;; If these are equal, we have the (or a) root directory.
985 (or (string= dir dirfile)
986 ;; If this is the same dir we last got the truename for,
987 ;; save time--don't recalculate.
988 (if (assoc dir (car prev-dirs))
989 (setq dir (cdr (assoc dir (car prev-dirs))))
991 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
992 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
994 (if (equal ".." (file-name-nondirectory filename))
996 (directory-file-name (file-name-directory (directory-file-name dir)))
998 (if (equal "." (file-name-nondirectory filename))
999 (setq filename (directory-file-name dir)
1001 ;; Put it back on the file name.
1002 (setq filename (concat dir (file-name-nondirectory filename)))
1003 ;; Is the file name the name of a link?
1004 (setq target (file-symlink-p filename))
1006 ;; Yes => chase that link, then start all over
1007 ;; since the link may point to a directory name that uses links.
1008 ;; We can't safely use expand-file-name here
1009 ;; since target might look like foo/../bar where foo
1010 ;; is itself a link. Instead, we handle . and .. above.
1012 (if (file-name-absolute-p target)
1014 (concat dir target))
1017 (setq done t))))))))
1020 (defun file-chase-links (filename &optional limit)
1021 "Chase links in FILENAME until a name that is not a link.
1022 Unlike `file-truename', this does not check whether a parent
1023 directory name is a symbolic link.
1024 If the optional argument LIMIT is a number,
1025 it means chase no more than that many links and then stop."
1026 (let (tem (newname filename)
1028 (while (and (or (null limit) (< count limit))
1029 (setq tem (file-symlink-p newname)))
1031 (if (and (null limit) (= count 100))
1032 (error "Apparent cycle of symbolic links for %s" filename))
1033 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1034 (while (string-match "//+" tem)
1035 (setq tem (replace-match "/" nil nil tem)))
1036 ;; Handle `..' by hand, since it needs to work in the
1037 ;; target of any directory symlink.
1038 ;; This code is not quite complete; it does not handle
1039 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1040 (while (string-match "\\`\\.\\./" tem)
1041 (setq tem (substring tem 3))
1042 (setq newname (expand-file-name newname))
1043 ;; Chase links in the default dir of the symlink.
1046 (directory-file-name (file-name-directory newname))))
1047 ;; Now find the parent of that dir.
1048 (setq newname (file-name-directory newname)))
1049 (setq newname (expand-file-name tem (file-name-directory newname)))
1050 (setq count (1+ count))))
1053 (defun make-temp-file (prefix &optional dir-flag suffix)
1054 "Create a temporary file.
1055 The returned file name (created by appending some random characters at the end
1056 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1057 is guaranteed to point to a newly created empty file.
1058 You can then use `write-region' to write new data into the file.
1060 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1062 If SUFFIX is non-nil, add that at the end of the file name."
1063 (let ((umask (default-file-modes))
1067 ;; Create temp files with strict access rights. It's easy to
1068 ;; loosen them later, whereas it's impossible to close the
1069 ;; time-window of loose permissions otherwise.
1070 (set-default-file-modes ?\700)
1071 (while (condition-case ()
1075 (if (zerop (length prefix))
1076 (file-name-as-directory
1077 temporary-file-directory)
1078 (expand-file-name prefix
1079 temporary-file-directory))))
1081 (setq file (concat file suffix)))
1083 (make-directory file)
1084 (write-region "" nil file nil 'silent nil 'excl))
1086 (file-already-exists t))
1087 ;; the file was somehow created by someone else between
1088 ;; `make-temp-name' and `write-region', let's try again.
1092 (set-default-file-modes umask))))
1094 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1095 "Change the encoding of FILE's name from CODING to NEW-CODING.
1096 The value is a new name of FILE.
1097 Signals a `file-already-exists' error if a file of the new name
1098 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1099 is non-nil. A number as fourth arg means request confirmation if
1100 the new name already exists. This is what happens in interactive
1103 (let ((default-coding (or file-name-coding-system
1104 default-file-name-coding-system))
1105 (filename (read-file-name "Recode filename: " nil nil t))
1106 from-coding to-coding)
1107 (if (and default-coding
1108 ;; We provide the default coding only when it seems that
1109 ;; the filename is correctly decoded by the default
1111 (let ((charsets (find-charset-string filename)))
1112 (and (not (memq 'eight-bit-control charsets))
1113 (not (memq 'eight-bit-graphic charsets)))))
1114 (setq from-coding (read-coding-system
1115 (format "Recode filename %s from (default %s): "
1116 filename default-coding)
1118 (setq from-coding (read-coding-system
1119 (format "Recode filename %s from: " filename))))
1121 ;; We provide the default coding only when a user is going to
1122 ;; change the encoding not from the default coding.
1123 (if (eq from-coding default-coding)
1124 (setq to-coding (read-coding-system
1125 (format "Recode filename %s from %s to: "
1126 filename from-coding)))
1127 (setq to-coding (read-coding-system
1128 (format "Recode filename %s from %s to (default %s): "
1129 filename from-coding default-coding)
1131 (list filename from-coding to-coding)))
1133 (let* ((default-coding (or file-name-coding-system
1134 default-file-name-coding-system))
1135 ;; FILE should have been decoded by DEFAULT-CODING.
1136 (encoded (encode-coding-string file default-coding))
1137 (newname (decode-coding-string encoded coding))
1138 (new-encoded (encode-coding-string newname new-coding))
1139 ;; Suppress further encoding.
1140 (file-name-coding-system nil)
1141 (default-file-name-coding-system nil)
1142 (locale-coding-system nil))
1143 (rename-file encoded new-encoded ok-if-already-exists)
1146 (defcustom confirm-nonexistent-file-or-buffer 'after-completion
1147 "Whether confirmation is requested before visiting a new file or buffer.
1148 If nil, confirmation is not requested.
1149 If the value is `after-completion', confirmation is only
1150 requested if the user called `minibuffer-complete' right before
1151 `minibuffer-complete-and-exit'.
1152 Any other non-nil value means to request confirmation.
1154 This affects commands like `switch-to-buffer' and `find-file'."
1157 :type '(choice (const :tag "After completion" after-completion)
1158 (const :tag "Never" nil)
1159 (other :tag "Always" t)))
1161 (defun confirm-nonexistent-file-or-buffer ()
1162 "Whether to request confirmation before visiting a new file or buffer.
1163 The variable `confirm-nonexistent-file-or-buffer' determines the
1164 return value, which may be passed as the REQUIRE-MATCH arg to
1165 `read-buffer' or `find-file-read-args'."
1166 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1167 'confirm-after-completion)
1168 (confirm-nonexistent-file-or-buffer
1172 (defun read-buffer-to-switch (prompt)
1173 "Read the name of a buffer to switch to and return as a string.
1174 It is intended for `switch-to-buffer' family of commands since they
1175 need to omit the name of current buffer from the list of completions
1176 and default values."
1177 (let ((rbts-completion-table (internal-complete-buffer-except)))
1178 (minibuffer-with-setup-hook
1180 (setq minibuffer-completion-table rbts-completion-table)
1181 ;; Since rbts-completion-table is built dynamically, we
1182 ;; can't just add it to the default value of
1183 ;; icomplete-with-completion-tables, so we add it
1185 (if (and (boundp 'icomplete-with-completion-tables)
1186 (listp icomplete-with-completion-tables))
1187 (set (make-local-variable 'icomplete-with-completion-tables)
1188 (cons rbts-completion-table
1189 icomplete-with-completion-tables))))
1190 (read-buffer prompt (other-buffer (current-buffer))
1191 (confirm-nonexistent-file-or-buffer)))))
1193 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
1194 "Select the buffer specified by BUFFER-OR-NAME in another window.
1195 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1196 nil. Return the buffer switched to.
1198 If called interactively, prompt for the buffer name using the
1199 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1200 determines whether to request confirmation before creating a new
1203 If BUFFER-OR-NAME is a string and does not identify an existing
1204 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1205 nil, switch to the buffer returned by `other-buffer'.
1207 Optional second argument NORECORD non-nil means do not put this
1208 buffer at the front of the list of recently selected ones.
1210 This uses the function `display-buffer' as a subroutine; see its
1211 documentation for additional customization information."
1213 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1214 (let ((pop-up-windows t)
1215 same-window-buffer-names same-window-regexps)
1216 (pop-to-buffer buffer-or-name t norecord)))
1218 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
1219 "Switch to buffer BUFFER-OR-NAME in another frame.
1220 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1221 nil. Return the buffer switched to.
1223 If called interactively, prompt for the buffer name using the
1224 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1225 determines whether to request confirmation before creating a new
1228 If BUFFER-OR-NAME is a string and does not identify an existing
1229 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1230 nil, switch to the buffer returned by `other-buffer'.
1232 Optional second arg NORECORD non-nil means do not put this
1233 buffer at the front of the list of recently selected ones.
1235 This uses the function `display-buffer' as a subroutine; see its
1236 documentation for additional customization information."
1238 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1239 (let ((pop-up-frames t)
1240 same-window-buffer-names same-window-regexps)
1241 (pop-to-buffer buffer-or-name t norecord)))
1243 (defun display-buffer-other-frame (buffer)
1244 "Display buffer BUFFER in another frame.
1245 This uses the function `display-buffer' as a subroutine; see
1246 its documentation for additional customization information."
1247 (interactive "BDisplay buffer in other frame: ")
1248 (let ((pop-up-frames t)
1249 same-window-buffer-names same-window-regexps
1250 (old-window (selected-window))
1252 (setq new-window (display-buffer buffer t))
1253 ;; This may have been here in order to prevent the new frame from hiding
1254 ;; the old frame. But it does more harm than good.
1255 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1256 ;;(lower-frame (window-frame new-window))
1258 ;; This may have been here in order to make sure the old-frame gets the
1259 ;; focus. But not only can it cause an annoying flicker, with some
1260 ;; window-managers it just makes the window invisible, with no easy
1261 ;; way to recover it. --Stef
1262 ;;(make-frame-invisible (window-frame old-window))
1263 ;;(make-frame-visible (window-frame old-window))
1266 (defvar find-file-default nil
1267 "Used within `find-file-read-args'.")
1269 (defmacro minibuffer-with-setup-hook (fun &rest body)
1270 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1271 BODY should use the minibuffer at most once.
1272 Recursive uses of the minibuffer will not be affected."
1273 (declare (indent 1) (debug t))
1274 (let ((hook (make-symbol "setup-hook")))
1278 ;; Clear out this hook so it does not interfere
1279 ;; with any recursive minibuffer usage.
1280 (remove-hook 'minibuffer-setup-hook ,hook)
1284 (add-hook 'minibuffer-setup-hook ,hook)
1286 (remove-hook 'minibuffer-setup-hook ,hook)))))
1288 (defun find-file-read-args (prompt mustmatch)
1289 (list (let ((find-file-default
1290 (and buffer-file-name
1291 (abbreviate-file-name buffer-file-name))))
1292 (minibuffer-with-setup-hook
1293 (lambda () (setq minibuffer-default find-file-default))
1294 (read-file-name prompt nil default-directory mustmatch)))
1297 (defun find-file (filename &optional wildcards)
1298 "Edit file FILENAME.
1299 Switch to a buffer visiting file FILENAME,
1300 creating one if none already exists.
1301 Interactively, the default if you just type RET is the current directory,
1302 but the visited file name is available through the minibuffer history:
1303 type M-n to pull it into the minibuffer.
1305 You can visit files on remote machines by specifying something
1306 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1307 also visit local files as a different user by specifying
1308 /sudo::FILE for the file name.
1309 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1310 manual, for more about this.
1312 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1313 expand wildcards (if any) and visit multiple files. You can
1314 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1316 To visit a file without any kind of conversion and without
1317 automatically choosing a major mode, use \\[find-file-literally]."
1319 (find-file-read-args "Find file: "
1320 (confirm-nonexistent-file-or-buffer)))
1321 (let ((value (find-file-noselect filename nil nil wildcards)))
1323 (mapcar 'switch-to-buffer (nreverse value))
1324 (switch-to-buffer value))))
1326 (defun find-file-other-window (filename &optional wildcards)
1327 "Edit file FILENAME, in another window.
1329 Like \\[find-file] (which see), but creates a new window or reuses
1330 an existing one. See the function `display-buffer'.
1332 Interactively, the default if you just type RET is the current directory,
1333 but the visited file name is available through the minibuffer history:
1334 type M-n to pull it into the minibuffer.
1336 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1337 expand wildcards (if any) and visit multiple files."
1339 (find-file-read-args "Find file in other window: "
1340 (confirm-nonexistent-file-or-buffer)))
1341 (let ((value (find-file-noselect filename nil nil wildcards)))
1344 (setq value (nreverse value))
1345 (cons (switch-to-buffer-other-window (car value))
1346 (mapcar 'switch-to-buffer (cdr value))))
1347 (switch-to-buffer-other-window value))))
1349 (defun find-file-other-frame (filename &optional wildcards)
1350 "Edit file FILENAME, in another frame.
1352 Like \\[find-file] (which see), but creates a new frame or reuses
1353 an existing one. See the function `display-buffer'.
1355 Interactively, the default if you just type RET is the current directory,
1356 but the visited file name is available through the minibuffer history:
1357 type M-n to pull it into the minibuffer.
1359 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1360 expand wildcards (if any) and visit multiple files."
1362 (find-file-read-args "Find file in other frame: "
1363 (confirm-nonexistent-file-or-buffer)))
1364 (let ((value (find-file-noselect filename nil nil wildcards)))
1367 (setq value (nreverse value))
1368 (cons (switch-to-buffer-other-frame (car value))
1369 (mapcar 'switch-to-buffer (cdr value))))
1370 (switch-to-buffer-other-frame value))))
1372 (defun find-file-existing (filename)
1373 "Edit the existing file FILENAME.
1374 Like \\[find-file], but only allow a file that exists, and do not allow
1375 file names with wildcards."
1376 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1377 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1378 (error "%s does not exist" filename)
1379 (find-file filename)
1382 (defun find-file-read-only (filename &optional wildcards)
1383 "Edit file FILENAME but don't allow changes.
1384 Like \\[find-file], but marks buffer as read-only.
1385 Use \\[toggle-read-only] to permit editing."
1387 (find-file-read-args "Find file read-only: "
1388 (confirm-nonexistent-file-or-buffer)))
1389 (unless (or (and wildcards find-file-wildcards
1390 (not (string-match "\\`/:" filename))
1391 (string-match "[[*?]" filename))
1392 (file-exists-p filename))
1393 (error "%s does not exist" filename))
1394 (let ((value (find-file filename wildcards)))
1395 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1396 (if (listp value) value (list value)))
1399 (defun find-file-read-only-other-window (filename &optional wildcards)
1400 "Edit file FILENAME in another window but don't allow changes.
1401 Like \\[find-file-other-window], but marks buffer as read-only.
1402 Use \\[toggle-read-only] to permit editing."
1404 (find-file-read-args "Find file read-only other window: "
1405 (confirm-nonexistent-file-or-buffer)))
1406 (unless (or (and wildcards find-file-wildcards
1407 (not (string-match "\\`/:" filename))
1408 (string-match "[[*?]" filename))
1409 (file-exists-p filename))
1410 (error "%s does not exist" filename))
1411 (let ((value (find-file-other-window filename wildcards)))
1412 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1413 (if (listp value) value (list value)))
1416 (defun find-file-read-only-other-frame (filename &optional wildcards)
1417 "Edit file FILENAME in another frame but don't allow changes.
1418 Like \\[find-file-other-frame], but marks buffer as read-only.
1419 Use \\[toggle-read-only] to permit editing."
1421 (find-file-read-args "Find file read-only other frame: "
1422 (confirm-nonexistent-file-or-buffer)))
1423 (unless (or (and wildcards find-file-wildcards
1424 (not (string-match "\\`/:" filename))
1425 (string-match "[[*?]" filename))
1426 (file-exists-p filename))
1427 (error "%s does not exist" filename))
1428 (let ((value (find-file-other-frame filename wildcards)))
1429 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1430 (if (listp value) value (list value)))
1433 (defun find-alternate-file-other-window (filename &optional wildcards)
1434 "Find file FILENAME as a replacement for the file in the next window.
1435 This command does not select that window.
1437 See \\[find-file] for the possible forms of the FILENAME argument.
1439 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1440 expand wildcards (if any) and replace the file with multiple files."
1442 (save-selected-window
1444 (let ((file buffer-file-name)
1448 (setq file-name (file-name-nondirectory file)
1449 file-dir (file-name-directory file)))
1450 (list (read-file-name
1451 "Find alternate file: " file-dir nil
1452 (confirm-nonexistent-file-or-buffer) file-name)
1455 (find-file-other-window filename wildcards)
1456 (save-selected-window
1458 (find-alternate-file filename wildcards))))
1460 (defun find-alternate-file (filename &optional wildcards)
1461 "Find file FILENAME, select its buffer, kill previous buffer.
1462 If the current buffer now contains an empty file that you just visited
1463 \(presumably by mistake), use this command to visit the file you really want.
1465 See \\[find-file] for the possible forms of the FILENAME argument.
1467 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1468 expand wildcards (if any) and replace the file with multiple files.
1470 If the current buffer is an indirect buffer, or the base buffer
1471 for one or more indirect buffers, the other buffer(s) are not
1474 (let ((file buffer-file-name)
1478 (setq file-name (file-name-nondirectory file)
1479 file-dir (file-name-directory file)))
1480 (list (read-file-name
1481 "Find alternate file: " file-dir nil
1482 (confirm-nonexistent-file-or-buffer) file-name)
1484 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1486 (when (and (buffer-modified-p) buffer-file-name)
1487 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1490 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1491 (error "Aborted"))))
1492 (let ((obuf (current-buffer))
1493 (ofile buffer-file-name)
1494 (onum buffer-file-number)
1495 (odir dired-directory)
1496 (otrue buffer-file-truename)
1497 (oname (buffer-name)))
1498 ;; Run `kill-buffer-hook' here. It needs to happen before
1499 ;; variables like `buffer-file-name' etc are set to nil below,
1500 ;; because some of the hooks that could be invoked
1501 ;; (e.g., `save-place-to-alist') depend on those variables.
1503 ;; Note that `kill-buffer-hook' is not what queries whether to
1504 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1505 ;; asks that itself. Thus, there's no need to temporarily do
1506 ;; `(set-buffer-modified-p nil)' before running this hook.
1507 (run-hooks 'kill-buffer-hook)
1508 ;; Okay, now we can end-of-life the old buffer.
1509 (if (get-buffer " **lose**")
1510 (kill-buffer " **lose**"))
1511 (rename-buffer " **lose**")
1515 ;; This prevents us from finding the same buffer
1516 ;; if we specified the same file again.
1517 (setq buffer-file-name nil)
1518 (setq buffer-file-number nil)
1519 (setq buffer-file-truename nil)
1520 ;; Likewise for dired buffers.
1521 (setq dired-directory nil)
1522 (find-file filename wildcards))
1523 (when (eq obuf (current-buffer))
1524 ;; This executes if find-file gets an error
1525 ;; and does not really find anything.
1526 ;; We put things back as they were.
1527 ;; If find-file actually finds something, we kill obuf below.
1528 (setq buffer-file-name ofile)
1529 (setq buffer-file-number onum)
1530 (setq buffer-file-truename otrue)
1531 (setq dired-directory odir)
1533 (rename-buffer oname)))
1534 (unless (eq (current-buffer) obuf)
1535 (with-current-buffer obuf
1536 ;; We already ran these; don't run them again.
1537 (let (kill-buffer-query-functions kill-buffer-hook)
1538 (kill-buffer obuf))))))
1540 (defun create-file-buffer (filename)
1541 "Create a suitably named buffer for visiting FILENAME, and return it.
1542 FILENAME (sans directory) is used unchanged if that name is free;
1543 otherwise a string <2> or <3> or ... is appended to get an unused name.
1544 Spaces at the start of FILENAME (sans directory) are removed."
1545 (let ((lastname (file-name-nondirectory filename)))
1546 (if (string= lastname "")
1547 (setq lastname filename))
1549 (string-match "^ *\\(.*\\)" lastname)
1550 (generate-new-buffer (match-string 1 lastname)))))
1552 (defun generate-new-buffer (name)
1553 "Create and return a buffer with a name based on NAME.
1554 Choose the buffer's name using `generate-new-buffer-name'."
1555 (get-buffer-create (generate-new-buffer-name name)))
1557 (defcustom automount-dir-prefix "^/tmp_mnt/"
1558 "Regexp to match the automounter prefix in a directory name."
1562 (defvar abbreviated-home-dir nil
1563 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1565 (defun abbreviate-file-name (filename)
1566 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1567 This also substitutes \"~\" for the user's home directory (unless the
1568 home directory is a root directory) and removes automounter prefixes
1569 \(see the variable `automount-dir-prefix')."
1570 ;; Get rid of the prefixes added by the automounter.
1572 (if (and automount-dir-prefix
1573 (string-match automount-dir-prefix filename)
1574 (file-exists-p (file-name-directory
1575 (substring filename (1- (match-end 0))))))
1576 (setq filename (substring filename (1- (match-end 0)))))
1577 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1578 ;; To fix this right, we need a `file-name-case-sensitive-p'
1579 ;; function, but we don't have that yet, so just guess.
1580 (let ((case-fold-search
1581 (memq system-type '(ms-dos windows-nt darwin cygwin))))
1582 ;; If any elt of directory-abbrev-alist matches this name,
1583 ;; abbreviate accordingly.
1584 (dolist (dir-abbrev directory-abbrev-alist)
1585 (if (string-match (car dir-abbrev) filename)
1587 (concat (cdr dir-abbrev)
1588 (substring filename (match-end 0))))))
1589 ;; Compute and save the abbreviated homedir name.
1590 ;; We defer computing this until the first time it's needed, to
1591 ;; give time for directory-abbrev-alist to be set properly.
1592 ;; We include a slash at the end, to avoid spurious matches
1593 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1594 (or abbreviated-home-dir
1595 (setq abbreviated-home-dir
1596 (let ((abbreviated-home-dir "$foo"))
1597 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1600 ;; If FILENAME starts with the abbreviated homedir,
1601 ;; make it start with `~' instead.
1602 (if (and (string-match abbreviated-home-dir filename)
1603 ;; If the home dir is just /, don't change it.
1604 (not (and (= (match-end 0) 1)
1605 (= (aref filename 0) ?/)))
1606 ;; MS-DOS root directories can come with a drive letter;
1607 ;; Novell Netware allows drive letters beyond `Z:'.
1608 (not (and (or (eq system-type 'ms-dos)
1609 (eq system-type 'cygwin)
1610 (eq system-type 'windows-nt))
1612 (string-match "^[a-zA-`]:/$" filename)))))
1615 (match-string 1 filename)
1616 (substring filename (match-end 0)))))
1619 (defcustom find-file-not-true-dirname-list nil
1620 "List of logical names for which visiting shouldn't save the true dirname."
1621 :type '(repeat (string :tag "Name"))
1624 (defun find-buffer-visiting (filename &optional predicate)
1625 "Return the buffer visiting file FILENAME (a string).
1626 This is like `get-file-buffer', except that it checks for any buffer
1627 visiting the same file, possibly under a different name.
1628 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1629 and others are ignored.
1630 If there is no such live buffer, return nil."
1631 (let ((predicate (or predicate #'identity))
1632 (truename (abbreviate-file-name (file-truename filename))))
1633 (or (let ((buf (get-file-buffer filename)))
1634 (when (and buf (funcall predicate buf)) buf))
1635 (let ((list (buffer-list)) found)
1636 (while (and (not found) list)
1638 (set-buffer (car list))
1639 (if (and buffer-file-name
1640 (string= buffer-file-truename truename)
1641 (funcall predicate (current-buffer)))
1642 (setq found (car list))))
1643 (setq list (cdr list)))
1645 (let* ((attributes (file-attributes truename))
1646 (number (nthcdr 10 attributes))
1647 (list (buffer-list)) found)
1648 (and buffer-file-numbers-unique
1649 (car-safe number) ;Make sure the inode is not just nil.
1650 (while (and (not found) list)
1651 (with-current-buffer (car list)
1652 (if (and buffer-file-name
1653 (equal buffer-file-number number)
1654 ;; Verify this buffer's file number
1655 ;; still belongs to its file.
1656 (file-exists-p buffer-file-name)
1657 (equal (file-attributes buffer-file-truename)
1659 (funcall predicate (current-buffer)))
1660 (setq found (car list))))
1661 (setq list (cdr list))))
1664 (defcustom find-file-wildcards t
1665 "Non-nil means file-visiting commands should handle wildcards.
1666 For example, if you specify `*.c', that would visit all the files
1667 whose names match the pattern."
1672 (defcustom find-file-suppress-same-file-warnings nil
1673 "Non-nil means suppress warning messages for symlinked files.
1674 When nil, Emacs prints a warning when visiting a file that is already
1675 visited, but with a different name. Setting this option to t
1676 suppresses this warning."
1681 (defcustom large-file-warning-threshold 10000000
1682 "Maximum size of file above which a confirmation is requested.
1683 When nil, never request confirmation."
1687 :type '(choice integer (const :tag "Never request confirmation" nil)))
1689 (defun abort-if-file-too-large (size op-type filename)
1690 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1691 OP-TYPE specifies the file operation being performed (for message to user)."
1692 (when (and large-file-warning-threshold size
1693 (> size large-file-warning-threshold)
1695 (format "File %s is large (%dMB), really %s? "
1696 (file-name-nondirectory filename)
1697 (/ size 1048576) op-type))))
1700 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1701 "Read file FILENAME into a buffer and return the buffer.
1702 If a buffer exists visiting FILENAME, return that one, but
1703 verify that the file has not changed since visited or saved.
1704 The buffer is not selected, just returned to the caller.
1705 Optional second arg NOWARN non-nil means suppress any warning messages.
1706 Optional third arg RAWFILE non-nil means the file is read literally.
1707 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1708 and visit all the matching files. When wildcards are actually
1709 used and expanded, return a list of buffers that are visiting
1712 (abbreviate-file-name
1713 (expand-file-name filename)))
1714 (if (file-directory-p filename)
1715 (or (and find-file-run-dired
1716 (run-hook-with-args-until-success
1717 'find-directory-functions
1718 (if find-file-visit-truename
1719 (abbreviate-file-name (file-truename filename))
1721 (error "%s is a directory" filename))
1724 (not (string-match "\\`/:" filename))
1725 (string-match "[[*?]" filename))
1726 (let ((files (condition-case nil
1727 (file-expand-wildcards filename t)
1728 (error (list filename))))
1729 (find-file-wildcards nil))
1731 (find-file-noselect filename)
1732 (mapcar #'find-file-noselect files)))
1733 (let* ((buf (get-file-buffer filename))
1734 (truename (abbreviate-file-name (file-truename filename)))
1735 (attributes (file-attributes truename))
1736 (number (nthcdr 10 attributes))
1737 ;; Find any buffer for a file which has same truename.
1738 (other (and (not buf) (find-buffer-visiting filename))))
1739 ;; Let user know if there is a buffer with the same truename.
1743 find-file-suppress-same-file-warnings
1744 (string-equal filename (buffer-file-name other))
1745 (message "%s and %s are the same file"
1746 filename (buffer-file-name other)))
1747 ;; Optionally also find that buffer.
1748 (if (or find-file-existing-other-name find-file-visit-truename)
1750 ;; Check to see if the file looks uncommonly large.
1751 (when (not (or buf nowarn))
1752 (abort-if-file-too-large (nth 7 attributes) "open" filename))
1754 ;; We are using an existing buffer.
1757 (verify-visited-file-modtime buf)
1758 (cond ((not (file-exists-p filename))
1759 (setq nonexistent t)
1760 (message "File %s no longer exists!" filename))
1761 ;; Certain files should be reverted automatically
1762 ;; if they have changed on disk and not in the buffer.
1763 ((and (not (buffer-modified-p buf))
1764 (let ((tail revert-without-query)
1767 (if (string-match (car tail) filename)
1769 (setq tail (cdr tail)))
1771 (with-current-buffer buf
1772 (message "Reverting file %s..." filename)
1774 (message "Reverting file %s...done" filename)))
1776 (if (string= (file-name-nondirectory filename)
1779 (if (buffer-modified-p buf)
1780 "File %s changed on disk. Discard your edits? "
1781 "File %s changed on disk. Reread from disk? ")
1782 (file-name-nondirectory filename))
1784 (if (buffer-modified-p buf)
1785 "File %s changed on disk. Discard your edits in %s? "
1786 "File %s changed on disk. Reread from disk into %s? ")
1787 (file-name-nondirectory filename)
1788 (buffer-name buf))))
1789 (with-current-buffer buf
1790 (revert-buffer t t)))))
1791 (with-current-buffer buf
1793 ;; Check if a formerly read-only file has become
1794 ;; writable and vice versa, but if the buffer agrees
1795 ;; with the new state of the file, that is ok too.
1796 (let ((read-only (not (file-writable-p buffer-file-name))))
1797 (unless (or nonexistent
1798 (eq read-only buffer-file-read-only)
1799 (eq read-only buffer-read-only))
1802 (format "File %s is %s on disk. Change buffer mode? "
1804 (if read-only "read-only" "writable"))))
1805 (y-or-n-p question)))
1806 (setq buffer-read-only read-only)))
1807 (setq buffer-file-read-only read-only))
1809 (when (and (not (eq (not (null rawfile))
1810 (not (null find-file-literally))))
1812 ;; It is confusing to ask whether to visit
1813 ;; non-literally if they have the file in
1815 (not (eq major-mode 'hexl-mode)))
1816 (if (buffer-modified-p)
1820 "The file %s is already visited normally,
1821 and you have edited the buffer. Now you have asked to visit it literally,
1822 meaning no coding system handling, format conversion, or local variables.
1823 Emacs can only visit a file in one way at a time.
1825 Do you want to save the file, and visit it literally instead? "
1826 "The file %s is already visited literally,
1827 meaning no coding system handling, format conversion, or local variables.
1828 You have edited the buffer. Now you have asked to visit the file normally,
1829 but Emacs can only visit a file in one way at a time.
1831 Do you want to save the file, and visit it normally instead? ")
1832 (file-name-nondirectory filename)))
1835 (find-file-noselect-1 buf filename nowarn
1836 rawfile truename number))
1841 Do you want to discard your changes, and visit the file literally now? "
1843 Do you want to discard your changes, and visit the file normally now? ")))
1844 (find-file-noselect-1 buf filename nowarn
1845 rawfile truename number)
1846 (error (if rawfile "File already visited non-literally"
1847 "File already visited literally"))))
1851 "The file %s is already visited normally.
1852 You have asked to visit it literally,
1853 meaning no coding system decoding, format conversion, or local variables.
1854 But Emacs can only visit a file in one way at a time.
1856 Do you want to revisit the file literally now? "
1857 "The file %s is already visited literally,
1858 meaning no coding system decoding, format conversion, or local variables.
1859 You have asked to visit it normally,
1860 but Emacs can only visit a file in one way at a time.
1862 Do you want to revisit the file normally now? ")
1863 (file-name-nondirectory filename)))
1864 (find-file-noselect-1 buf filename nowarn
1865 rawfile truename number)
1866 (error (if rawfile "File already visited non-literally"
1867 "File already visited literally"))))))
1868 ;; Return the buffer we are using.
1870 ;; Create a new buffer.
1871 (setq buf (create-file-buffer filename))
1872 ;; find-file-noselect-1 may use a different buffer.
1873 (find-file-noselect-1 buf filename nowarn
1874 rawfile truename number))))))
1876 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1878 (with-current-buffer buf
1879 (kill-local-variable 'find-file-literally)
1880 ;; Needed in case we are re-visiting the file with a different
1881 ;; text representation.
1882 (kill-local-variable 'buffer-file-coding-system)
1883 (kill-local-variable 'cursor-type)
1884 (let ((inhibit-read-only t))
1886 (and (default-value 'enable-multibyte-characters)
1888 (set-buffer-multibyte t))
1891 (let ((inhibit-read-only t))
1892 (insert-file-contents-literally filename t))
1894 (when (and (file-exists-p filename)
1895 (not (file-readable-p filename)))
1897 (signal 'file-error (list "File is not readable"
1899 ;; Unconditionally set error
1902 (let ((inhibit-read-only t))
1903 (insert-file-contents filename t))
1905 (when (and (file-exists-p filename)
1906 (not (file-readable-p filename)))
1908 (signal 'file-error (list "File is not readable"
1910 ;; Run find-file-not-found-functions until one returns non-nil.
1911 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1912 ;; If they fail too, set error.
1914 ;; Record the file's truename, and maybe use that as visited name.
1915 (if (equal filename buffer-file-name)
1916 (setq buffer-file-truename truename)
1917 (setq buffer-file-truename
1918 (abbreviate-file-name (file-truename buffer-file-name))))
1919 (setq buffer-file-number number)
1920 (if find-file-visit-truename
1921 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1922 ;; Set buffer's default directory to that of the file.
1923 (setq default-directory (file-name-directory buffer-file-name))
1924 ;; Turn off backup files for certain file names. Since
1925 ;; this is a permanent local, the major mode won't eliminate it.
1926 (and backup-enable-predicate
1927 (not (funcall backup-enable-predicate buffer-file-name))
1929 (make-local-variable 'backup-inhibited)
1930 (setq backup-inhibited t)))
1933 (set-buffer-multibyte nil)
1934 (setq buffer-file-coding-system 'no-conversion)
1935 (set-buffer-major-mode buf)
1936 (make-local-variable 'find-file-literally)
1937 (setq find-file-literally t))
1938 (after-find-file error (not nowarn)))
1941 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1942 "Like `insert-file-contents', but only reads in the file literally.
1943 A buffer may be modified in several ways after reading into the buffer,
1944 to Emacs features such as format decoding, character code
1945 conversion, `find-file-hook', automatic uncompression, etc.
1947 This function ensures that none of these modifications will take place."
1948 (let ((format-alist nil)
1949 (after-insert-file-functions nil)
1950 (coding-system-for-read 'no-conversion)
1951 (coding-system-for-write 'no-conversion)
1952 (find-buffer-file-type-function
1953 (if (fboundp 'find-buffer-file-type)
1954 (symbol-function 'find-buffer-file-type)
1956 (inhibit-file-name-handlers
1957 (append '(jka-compr-handler image-file-handler epa-file-handler)
1958 inhibit-file-name-handlers))
1959 (inhibit-file-name-operation 'insert-file-contents))
1962 (fset 'find-buffer-file-type (lambda (filename) t))
1963 (insert-file-contents filename visit beg end replace))
1964 (if find-buffer-file-type-function
1965 (fset 'find-buffer-file-type find-buffer-file-type-function)
1966 (fmakunbound 'find-buffer-file-type)))))
1968 (defun insert-file-1 (filename insert-func)
1969 (if (file-directory-p filename)
1970 (signal 'file-error (list "Opening input file" "file is a directory"
1972 ;; Check whether the file is uncommonly large
1973 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename)
1974 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1975 #'buffer-modified-p))
1976 (tem (funcall insert-func filename)))
1977 (push-mark (+ (point) (car (cdr tem))))
1979 (message "File %s already visited and modified in buffer %s"
1980 filename (buffer-name buffer)))))
1982 (defun insert-file-literally (filename)
1983 "Insert contents of file FILENAME into buffer after point with no conversion.
1985 This function is meant for the user to run interactively.
1986 Don't call it from programs! Use `insert-file-contents-literally' instead.
1987 \(Its calling sequence is different; see its documentation)."
1988 (interactive "*fInsert file literally: ")
1989 (insert-file-1 filename #'insert-file-contents-literally))
1991 (defvar find-file-literally nil
1992 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1993 This is a permanent local.")
1994 (put 'find-file-literally 'permanent-local t)
1996 (defun find-file-literally (filename)
1997 "Visit file FILENAME with no conversion of any kind.
1998 Format conversion and character code conversion are both disabled,
1999 and multibyte characters are disabled in the resulting buffer.
2000 The major mode used is Fundamental mode regardless of the file name,
2001 and local variable specifications in the file are ignored.
2002 Automatic uncompression and adding a newline at the end of the
2003 file due to `require-final-newline' is also disabled.
2005 You cannot absolutely rely on this function to result in
2006 visiting the file literally. If Emacs already has a buffer
2007 which is visiting the file, you get the existing buffer,
2008 regardless of whether it was created literally or not.
2010 In a Lisp program, if you want to be sure of accessing a file's
2011 contents literally, you should create a temporary buffer and then read
2012 the file contents into it using `insert-file-contents-literally'."
2013 (interactive "FFind file literally: ")
2014 (switch-to-buffer (find-file-noselect filename nil t)))
2016 (defvar after-find-file-from-revert-buffer nil)
2018 (defun after-find-file (&optional error warn noauto
2019 after-find-file-from-revert-buffer
2021 "Called after finding a file and by the default revert function.
2022 Sets buffer mode, parses local variables.
2023 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2024 error in reading the file. WARN non-nil means warn if there
2025 exists an auto-save file more recent than the visited file.
2026 NOAUTO means don't mess with auto-save mode.
2027 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2028 means this call was from `revert-buffer'.
2029 Fifth arg NOMODES non-nil means don't alter the file's modes.
2030 Finishes by calling the functions in `find-file-hook'
2031 unless NOMODES is non-nil."
2032 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
2039 ((and error (file-attributes buffer-file-name))
2040 (setq buffer-read-only t)
2041 "File exists, but cannot be read")
2042 ((not buffer-read-only)
2044 ;; No need to warn if buffer is auto-saved
2045 ;; under the name of the visited file.
2046 (not (and buffer-file-name
2047 auto-save-visited-file-name))
2048 (file-newer-than-file-p (or buffer-auto-save-file-name
2049 (make-auto-save-file-name))
2051 (format "%s has auto save data; consider M-x recover-this-file"
2052 (file-name-nondirectory buffer-file-name))
2053 (setq not-serious t)
2054 (if error "(New file)" nil)))
2056 (setq not-serious t)
2057 "Note: file is write protected")
2058 ((file-attributes (directory-file-name default-directory))
2059 "File not found and directory write-protected")
2060 ((file-exists-p (file-name-directory buffer-file-name))
2061 (setq buffer-read-only nil))
2063 (setq buffer-read-only nil)
2064 "Use M-x make-directory RET RET to create the directory and its parents"))))
2067 (or not-serious (sit-for 1 t))))
2068 (when (and auto-save-default (not noauto))
2069 (auto-save-mode t)))
2070 ;; Make people do a little extra work (C-x C-q)
2071 ;; before altering a backup file.
2072 (when (backup-file-name-p buffer-file-name)
2073 (setq buffer-read-only t))
2074 ;; When a file is marked read-only,
2075 ;; make the buffer read-only even if root is looking at it.
2076 (when (and (file-modes (buffer-file-name))
2077 (zerop (logand (file-modes (buffer-file-name)) #o222)))
2078 (setq buffer-read-only t))
2080 (when (and view-read-only view-mode)
2081 (view-mode-disable))
2083 ;; If requested, add a newline at the end of the file.
2084 (and (memq require-final-newline '(visit visit-save))
2085 (> (point-max) (point-min))
2086 (/= (char-after (1- (point-max))) ?\n)
2087 (not (and (eq selective-display t)
2088 (= (char-after (1- (point-max))) ?\r)))
2090 (goto-char (point-max))
2092 (when (and buffer-read-only
2094 (not (eq (get major-mode 'mode-class) 'special)))
2096 (run-hooks 'find-file-hook)))
2098 (defmacro report-errors (format &rest body)
2099 "Eval BODY and turn any error into a FORMAT message.
2100 FORMAT can have a %s escape which will be replaced with the actual error.
2101 If `debug-on-error' is set, errors are not caught, so that you can
2103 Avoid using a large BODY since it is duplicated."
2104 (declare (debug t) (indent 1))
2109 (error (message ,format (prin1-to-string err))))))
2111 (defun normal-mode (&optional find-file)
2112 "Choose the major mode for this buffer automatically.
2113 Also sets up any specified local variables of the file.
2114 Uses the visited file name, the -*- line, and the local variables spec.
2116 This function is called automatically from `find-file'. In that case,
2117 we may set up the file-specified mode and local variables,
2118 depending on the value of `enable-local-variables'.
2119 In addition, if `local-enable-local-variables' is nil, we do
2120 not set local variables (though we do notice a mode specified with -*-.)
2122 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2123 or from Lisp without specifying the optional argument FIND-FILE;
2124 in that case, this function acts as if `enable-local-variables' were t."
2126 (funcall (or (default-value 'major-mode) 'fundamental-mode))
2127 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2128 (report-errors "File mode specification error: %s"
2130 (report-errors "File local-variables error: %s"
2131 (hack-local-variables)))
2132 ;; Turn font lock off and on, to make sure it takes account of
2133 ;; whatever file local variables are relevant to it.
2134 (when (and font-lock-mode
2135 ;; Font-lock-mode (now in font-core.el) can be ON when
2136 ;; font-lock.el still hasn't been loaded.
2137 (boundp 'font-lock-keywords)
2138 (eq (car font-lock-keywords) t))
2139 (setq font-lock-keywords (cadr font-lock-keywords))
2142 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2143 (ucs-set-table-for-input)))
2145 (defcustom auto-mode-case-fold nil
2146 "Non-nil means to try second pass through `auto-mode-alist'.
2147 This means that if the first case-sensitive search through the alist fails
2148 to find a matching major mode, a second case-insensitive search is made.
2149 On systems with case-insensitive file names, this variable is ignored,
2150 since only a single case-insensitive search through the alist is made."
2155 (defvar auto-mode-alist
2156 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2157 ;; c++-mode, java-mode and more) are added through autoload
2158 ;; directives in that file. That way is discouraged since it
2159 ;; spreads out the definition of the initial value.
2162 (cons (purecopy (car elt)) (cdr elt)))
2163 `(;; do this first, so that .html.pl is Polish html, not Perl
2164 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2165 ("\\.te?xt\\'" . text-mode)
2166 ("\\.[tT]e[xX]\\'" . tex-mode)
2167 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2168 ("\\.ltx\\'" . latex-mode)
2169 ("\\.dtx\\'" . doctex-mode)
2170 ("\\.org\\'" . org-mode)
2171 ("\\.el\\'" . emacs-lisp-mode)
2172 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2173 ("\\.l\\'" . lisp-mode)
2174 ("\\.li?sp\\'" . lisp-mode)
2175 ("\\.[fF]\\'" . fortran-mode)
2176 ("\\.for\\'" . fortran-mode)
2177 ("\\.p\\'" . pascal-mode)
2178 ("\\.pas\\'" . pascal-mode)
2179 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode)
2180 ("\\.ad[abs]\\'" . ada-mode)
2181 ("\\.ad[bs].dg\\'" . ada-mode)
2182 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2183 ("Imakefile\\'" . makefile-imake-mode)
2184 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2185 ("\\.makepp\\'" . makefile-makepp-mode)
2186 ,@(if (memq system-type '(berkeley-unix darwin))
2187 '(("\\.mk\\'" . makefile-bsdmake-mode)
2188 ("GNUmakefile\\'" . makefile-gmake-mode)
2189 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2190 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2191 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2192 ("\\.am\\'" . makefile-automake-mode)
2193 ;; Less common extensions come here
2194 ;; so more common ones above are found faster.
2195 ("\\.texinfo\\'" . texinfo-mode)
2196 ("\\.te?xi\\'" . texinfo-mode)
2197 ("\\.[sS]\\'" . asm-mode)
2198 ("\\.asm\\'" . asm-mode)
2199 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2200 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2201 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2202 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2203 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2204 ("\\.bash\\'" . sh-mode)
2205 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2206 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2207 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2208 ("\\.m?spec\\'" . sh-mode)
2209 ("\\.m[mes]\\'" . nroff-mode)
2210 ("\\.man\\'" . nroff-mode)
2211 ("\\.sty\\'" . latex-mode)
2212 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2213 ("\\.bbl\\'" . latex-mode)
2214 ("\\.bib\\'" . bibtex-mode)
2215 ("\\.sql\\'" . sql-mode)
2216 ("\\.m[4c]\\'" . m4-mode)
2217 ("\\.mf\\'" . metafont-mode)
2218 ("\\.mp\\'" . metapost-mode)
2219 ("\\.vhdl?\\'" . vhdl-mode)
2220 ("\\.article\\'" . text-mode)
2221 ("\\.letter\\'" . text-mode)
2222 ("\\.i?tcl\\'" . tcl-mode)
2223 ("\\.exp\\'" . tcl-mode)
2224 ("\\.itk\\'" . tcl-mode)
2225 ("\\.icn\\'" . icon-mode)
2226 ("\\.sim\\'" . simula-mode)
2227 ("\\.mss\\'" . scribe-mode)
2228 ("\\.f9[05]\\'" . f90-mode)
2229 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2230 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2231 ("\\.prolog\\'" . prolog-mode)
2232 ("\\.tar\\'" . tar-mode)
2233 ;; The list of archive file extensions should be in sync with
2234 ;; `auto-coding-alist' with `no-conversion' coding system.
2236 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2237 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2238 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org
2239 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
2240 ;; Mailer puts message to be edited in
2241 ;; /tmp/Re.... or Message
2242 ("\\`/tmp/Re" . text-mode)
2243 ("/Message[0-9]*\\'" . text-mode)
2244 ("\\.zone\\'" . zone-mode)
2245 ;; some news reader is reported to use this
2246 ("\\`/tmp/fol/" . text-mode)
2247 ("\\.oak\\'" . scheme-mode)
2248 ("\\.sgml?\\'" . sgml-mode)
2249 ("\\.x[ms]l\\'" . xml-mode)
2250 ("\\.dtd\\'" . sgml-mode)
2251 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2252 ("\\.js\\'" . js-mode) ; javascript-mode would be better
2253 ("\\.[ds]?v\\'" . verilog-mode)
2254 ;; .emacs or .gnus or .viper following a directory delimiter in
2255 ;; Unix, MSDOG or VMS syntax.
2256 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2257 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2258 ;; _emacs following a directory delimiter
2260 ("[:/]_emacs\\'" . emacs-lisp-mode)
2261 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2262 ("\\.ml\\'" . lisp-mode)
2263 ;; Common Lisp ASDF package system.
2264 ("\\.asd\\'" . lisp-mode)
2265 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2266 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2267 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2268 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2269 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2270 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2271 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2272 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2273 ("BROWSE\\'" . ebrowse-tree-mode)
2274 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2275 ("#\\*mail\\*" . mail-mode)
2276 ("\\.g\\'" . antlr-mode)
2277 ("\\.ses\\'" . ses-mode)
2278 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2279 ("\\.docbook\\'" . sgml-mode)
2280 ("\\.com\\'" . dcl-mode)
2281 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2282 ;; Windows candidates may be opened case sensitively on Unix
2283 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2284 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2285 ("\\.ppd\\'" . conf-ppd-mode)
2286 ("java.+\\.conf\\'" . conf-javaprop-mode)
2287 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2288 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2289 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2290 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2291 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2292 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2293 ;; this has lower priority to avoid matching changelog.sgml etc.
2294 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2295 ;; either user's dot-files or under /etc or some such
2296 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2297 ;; alas not all ~/.*rc files are like this
2298 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2299 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2300 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2301 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2302 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2303 ;; this contains everything twice, with space and with colon :-(
2304 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2305 ;; Get rid of any trailing .n.m and try again.
2306 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2307 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2308 ;; Using mode nil rather than `ignore' would let the search continue
2309 ;; through this list (with the shortened name) rather than start over.
2310 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2311 ;; The following should come after the ChangeLog pattern
2312 ;; for the sake of ChangeLog.1, etc.
2313 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2314 ("\\.[1-9]\\'" . nroff-mode)
2315 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2316 "Alist of filename patterns vs corresponding major mode functions.
2317 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2318 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2319 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2320 mode function to use. FUNCTION will be called, unless it is nil.
2322 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2323 calling FUNCTION (if it's not nil), we delete the suffix that matched
2324 REGEXP and search the list again for another match.
2326 If the file name matches `inhibit-first-line-modes-regexps',
2327 then `auto-mode-alist' is not processed.
2329 The extensions whose FUNCTION is `archive-mode' should also
2330 appear in `auto-coding-alist' with `no-conversion' coding system.
2332 See also `interpreter-mode-alist', which detects executable script modes
2333 based on the interpreters they specify to run,
2334 and `magic-mode-alist', which determines modes based on file contents.")
2335 (put 'auto-mode-alist 'risky-local-variable t)
2337 (defun conf-mode-maybe ()
2338 "Select Conf mode or XML mode according to start of file."
2342 (goto-char (point-min))
2343 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2347 (defvar interpreter-mode-alist
2348 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2349 ;; and pike-mode) are added through autoload directives in that
2350 ;; file. That way is discouraged since it spreads out the
2351 ;; definition of the initial value.
2354 (cons (purecopy (car l)) (cdr l)))
2355 '(("perl" . perl-mode)
2356 ("perl5" . perl-mode)
2357 ("miniperl" . perl-mode)
2359 ("wishx" . tcl-mode)
2361 ("tclsh" . tcl-mode)
2362 ("scm" . scheme-mode)
2382 ("tail" . text-mode)
2383 ("more" . text-mode)
2384 ("less" . text-mode)
2386 ("make" . makefile-gmake-mode) ; Debian uses this
2387 ("guile" . scheme-mode)
2388 ("clisp" . lisp-mode)))
2389 "Alist mapping interpreter names to major modes.
2390 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2391 Each element looks like (INTERPRETER . MODE).
2392 If INTERPRETER matches the name of the interpreter specified in the first line
2393 of a script, mode MODE is enabled.
2395 See also `auto-mode-alist'.")
2397 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2398 "List of regexps; if one matches a file name, don't look for `-*-'.")
2400 (defvar inhibit-first-line-modes-suffixes nil
2401 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2402 When checking `inhibit-first-line-modes-regexps', we first discard
2403 from the end of the file name anything that matches one of these regexps.")
2405 (defvar auto-mode-interpreter-regexp
2406 "#![ \t]?\\([^ \t\n]*\
2407 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2408 "Regexp matching interpreters, for file mode determination.
2409 This regular expression is matched against the first line of a file
2410 to determine the file's mode in `set-auto-mode'. If it matches, the file
2411 is assumed to be interpreted by the interpreter matched by the second group
2412 of the regular expression. The mode is then determined as the mode
2413 associated with that interpreter in `interpreter-mode-alist'.")
2415 (defvar magic-mode-alist nil
2416 "Alist of buffer beginnings vs. corresponding major mode functions.
2417 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2418 After visiting a file, if REGEXP matches the text at the beginning of the
2419 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2420 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2423 If FUNCTION is nil, then it is not called. (That is a way of saying
2424 \"allow `auto-mode-alist' to decide for these files.\")")
2425 (put 'magic-mode-alist 'risky-local-variable t)
2427 (defvar magic-fallback-mode-alist
2428 `((image-type-auto-detected-p . image-mode)
2429 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
2430 ;; The < comes before the groups (but the first) to reduce backtracking.
2431 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2432 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2433 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2434 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2435 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2437 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2438 "[Hh][Tt][Mm][Ll]"))
2440 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2441 ;; These two must come after html, because they are more general:
2442 ("<\\?xml " . xml-mode)
2443 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2444 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2445 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2448 ("# xmcd " . conf-unix-mode))
2449 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2450 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2451 After visiting a file, if REGEXP matches the text at the beginning of the
2452 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2453 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2454 have not specified a mode for this file.
2456 If FUNCTION is nil, then it is not called.")
2457 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2459 (defvar magic-mode-regexp-match-limit 4000
2460 "Upper limit on `magic-mode-alist' regexp matches.
2461 Also applies to `magic-fallback-mode-alist'.")
2463 (defun set-auto-mode (&optional keep-mode-if-same)
2464 "Select major mode appropriate for current buffer.
2466 To find the right major mode, this function checks for a -*- mode tag,
2467 checks if it uses an interpreter listed in `interpreter-mode-alist',
2468 matches the buffer beginning against `magic-mode-alist',
2469 compares the filename against the entries in `auto-mode-alist',
2470 then matches the buffer beginning against `magic-fallback-mode-alist'.
2472 It does not check for the `mode:' local variable in the
2473 Local Variables section of the file; for that, use `hack-local-variables'.
2475 If `enable-local-variables' is nil, this function does not check for a
2478 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2479 set the major mode only if that would change it. In other words
2480 we don't actually set it to the same mode the buffer already has."
2481 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2482 (let (end done mode modes)
2483 ;; Find a -*- mode tag
2485 (goto-char (point-min))
2486 (skip-chars-forward " \t\n")
2487 (and enable-local-variables
2488 (setq end (set-auto-mode-1))
2489 (if (save-excursion (search-forward ":" end t))
2490 ;; Find all specifications for the `mode:' variable
2491 ;; and execute them left to right.
2492 (while (let ((case-fold-search t))
2493 (or (and (looking-at "mode:")
2494 (goto-char (match-end 0)))
2495 (re-search-forward "[ \t;]mode:" end t)))
2496 (skip-chars-forward " \t")
2497 (let ((beg (point)))
2498 (if (search-forward ";" end t)
2501 (skip-chars-backward " \t")
2502 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2504 ;; Simple -*-MODE-*- case.
2505 (push (intern (concat (downcase (buffer-substring (point) end))
2508 ;; If we found modes to use, invoke them now, outside the save-excursion.
2511 (dolist (mode (nreverse modes))
2512 (if (not (functionp mode))
2513 (message "Ignoring unknown mode `%s'" mode)
2515 (or (set-auto-mode-0 mode keep-mode-if-same)
2516 ;; continuing would call minor modes again, toggling them off
2517 (throw 'nop nil))))))
2518 ;; If we didn't, look for an interpreter specified in the first line.
2519 ;; As a special case, allow for things like "#!/bin/env perl", which
2520 ;; finds the interpreter anywhere in $PATH.
2522 (setq mode (save-excursion
2523 (goto-char (point-min))
2524 (if (looking-at auto-mode-interpreter-regexp)
2527 ;; Map interpreter name to a mode, signalling we're done at the
2529 done (assoc (file-name-nondirectory mode)
2530 interpreter-mode-alist))
2531 ;; If we found an interpreter mode to use, invoke it now.
2533 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2534 ;; Next try matching the buffer beginning against magic-mode-alist.
2536 (if (setq done (save-excursion
2537 (goto-char (point-min))
2539 (narrow-to-region (point-min)
2541 (+ (point-min) magic-mode-regexp-match-limit)))
2542 (assoc-default nil magic-mode-alist
2546 (looking-at re)))))))
2547 (set-auto-mode-0 done keep-mode-if-same)))
2548 ;; Next compare the filename against the entries in auto-mode-alist.
2550 (if buffer-file-name
2551 (let ((name buffer-file-name)
2552 (remote-id (file-remote-p buffer-file-name)))
2553 ;; Remove remote file name identification.
2554 (when (and (stringp remote-id)
2555 (string-match (regexp-quote remote-id) name))
2556 (setq name (substring name (match-end 0))))
2557 ;; Remove backup-suffixes from file name.
2558 (setq name (file-name-sans-versions name))
2560 ;; Find first matching alist entry.
2562 (if (memq system-type '(windows-nt cygwin))
2563 ;; System is case-insensitive.
2564 (let ((case-fold-search t))
2565 (assoc-default name auto-mode-alist
2567 ;; System is case-sensitive.
2569 ;; First match case-sensitively.
2570 (let ((case-fold-search nil))
2571 (assoc-default name auto-mode-alist
2573 ;; Fallback to case-insensitive match.
2574 (and auto-mode-case-fold
2575 (let ((case-fold-search t))
2576 (assoc-default name auto-mode-alist
2581 (setq mode (car mode)
2582 name (substring name 0 (match-beginning 0)))
2585 (set-auto-mode-0 mode keep-mode-if-same)
2587 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2589 (if (setq done (save-excursion
2590 (goto-char (point-min))
2592 (narrow-to-region (point-min)
2594 (+ (point-min) magic-mode-regexp-match-limit)))
2595 (assoc-default nil magic-fallback-mode-alist
2599 (looking-at re)))))))
2600 (set-auto-mode-0 done keep-mode-if-same)))))
2602 ;; When `keep-mode-if-same' is set, we are working on behalf of
2603 ;; set-visited-file-name. In that case, if the major mode specified is the
2604 ;; same one we already have, don't actually reset it. We don't want to lose
2605 ;; minor modes such as Font Lock.
2606 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2607 "Apply MODE and return it.
2608 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2609 any aliases and compared to current major mode. If they are the
2610 same, do nothing and return nil."
2611 (unless (and keep-mode-if-same
2612 (eq (indirect-function mode)
2613 (indirect-function major-mode)))
2618 (defun set-auto-mode-1 ()
2619 "Find the -*- spec in the buffer.
2620 Call with point at the place to start searching from.
2621 If one is found, set point to the beginning
2622 and return the position of the end.
2623 Otherwise, return nil; point may be changed."
2626 ;; Don't look for -*- if this file name matches any
2627 ;; of the regexps in inhibit-first-line-modes-regexps.
2628 (let ((temp inhibit-first-line-modes-regexps)
2629 (name (if buffer-file-name
2630 (file-name-sans-versions buffer-file-name)
2632 (while (let ((sufs inhibit-first-line-modes-suffixes))
2633 (while (and sufs (not (string-match (car sufs) name)))
2634 (setq sufs (cdr sufs)))
2636 (setq name (substring name 0 (match-beginning 0))))
2638 (not (string-match (car temp) name)))
2639 (setq temp (cdr temp)))
2642 (search-forward "-*-" (line-end-position
2643 ;; If the file begins with "#!"
2644 ;; (exec interpreter magic), look
2645 ;; for mode frobs in the first two
2646 ;; lines. You cannot necessarily
2647 ;; put them in the first line of
2648 ;; such a file without screwing up
2649 ;; the interpreter invocation.
2650 ;; The same holds for
2652 ;; in man pages (preprocessor
2653 ;; magic for the `man' program).
2654 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2656 (skip-chars-forward " \t")
2658 (search-forward "-*-" (line-end-position) t))
2661 (skip-chars-backward " \t")
2666 ;;; Handling file local variables
2668 (defvar ignored-local-variables
2669 '(ignored-local-variables safe-local-variable-values
2670 file-local-variables-alist dir-local-variables-alist)
2671 "Variables to be ignored in a file's local variable spec.")
2672 (put 'ignored-local-variables 'risky-local-variable t)
2674 (defvar hack-local-variables-hook nil
2675 "Normal hook run after processing a file's local variables specs.
2676 Major modes can use this to examine user-specified local variables
2677 in order to initialize other data structure based on them.")
2679 (defcustom safe-local-variable-values nil
2680 "List variable-value pairs that are considered safe.
2681 Each element is a cons cell (VAR . VAL), where VAR is a variable
2682 symbol and VAL is a value that is considered safe."
2687 (defcustom safe-local-eval-forms '((add-hook 'write-file-hooks 'time-stamp))
2688 "Expressions that are considered safe in an `eval:' local variable.
2689 Add expressions to this list if you want Emacs to evaluate them, when
2690 they appear in an `eval' local variable specification, without first
2691 asking you for confirmation."
2695 :type '(repeat sexp))
2697 ;; Risky local variables:
2698 (mapc (lambda (var) (put var 'risky-local-variable t))
2700 buffer-auto-save-file-name
2702 buffer-file-truename
2705 default-text-properties
2709 file-name-handler-alist
2718 minor-mode-map-alist
2719 minor-mode-overriding-map-alist
2722 overriding-local-map
2723 overriding-terminal-local-map
2727 unread-command-events))
2729 ;; Safe local variables:
2731 ;; For variables defined by major modes, the safety declarations can go into
2732 ;; the major mode's file, since that will be loaded before file variables are
2735 ;; For variables defined by minor modes, put the safety declarations in the
2736 ;; file defining the minor mode after the defcustom/defvar using an autoload
2739 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2741 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2742 ;; minor mode file may not be loaded yet.
2744 ;; For variables defined in the C source code the declaration should go here:
2746 (mapc (lambda (pair)
2747 (put (car pair) 'safe-local-variable (cdr pair)))
2748 '((buffer-read-only . booleanp) ;; C source code
2749 (default-directory . stringp) ;; C source code
2750 (fill-column . integerp) ;; C source code
2751 (indent-tabs-mode . booleanp) ;; C source code
2752 (left-margin . integerp) ;; C source code
2753 (no-update-autoloads . booleanp)
2754 (tab-width . integerp) ;; C source code
2755 (truncate-lines . booleanp))) ;; C source code
2757 (put 'c-set-style 'safe-local-eval-function t)
2759 (defvar file-local-variables-alist nil
2760 "Alist of file-local variable settings in the current buffer.
2761 Each element in this list has the form (VAR . VALUE), where VAR
2762 is a file-local variable (a symbol) and VALUE is the value
2763 specified. The actual value in the buffer may differ from VALUE,
2764 if it is changed by the major or minor modes, or by the user.")
2765 (make-variable-buffer-local 'file-local-variables-alist)
2767 (defvar dir-local-variables-alist nil
2768 "Alist of directory-local variable settings in the current buffer.
2769 Each element in this list has the form (VAR . VALUE), where VAR
2770 is a directory-local variable (a symbol) and VALUE is the value
2771 specified in .dir-locals.el. The actual value in the buffer
2772 may differ from VALUE, if it is changed by the major or minor modes,
2774 (make-variable-buffer-local 'dir-local-variables-alist)
2776 (defvar before-hack-local-variables-hook nil
2777 "Normal hook run before setting file-local variables.
2778 It is called after checking for unsafe/risky variables and
2779 setting `file-local-variables-alist', and before applying the
2780 variables stored in `file-local-variables-alist'. A hook
2781 function is allowed to change the contents of this alist.
2783 This hook is called only if there is at least one file-local
2786 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2787 "Get confirmation before setting up local variable values.
2788 ALL-VARS is the list of all variables to be set up.
2789 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2790 RISKY-VARS is the list of those that are marked as risky.
2791 DIR-NAME is a directory name if these settings come from
2792 directory-local variables, or nil otherwise."
2795 (let ((name (or dir-name
2796 (if buffer-file-name
2797 (file-name-nondirectory buffer-file-name)
2798 (concat "buffer " (buffer-name)))))
2799 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2801 (save-window-excursion
2802 (let ((buf (get-buffer-create "*Local Variables*")))
2804 (set (make-local-variable 'cursor-type) nil)
2807 (insert "The local variables list in " name
2808 "\ncontains values that may not be safe (*)"
2810 ", and variables that are risky (**)."
2813 (insert "The local variables list in " name
2814 "\ncontains variables that are risky (**).")
2815 (insert "A local variables list is specified in " name ".")))
2816 (insert "\n\nDo you want to apply it? You can type
2817 y -- to apply the local variables list.
2818 n -- to ignore the local variables list.")
2821 ! -- to apply the local variables list, and permanently mark these
2822 values (*) as safe (in the future, they will be set automatically.)\n\n")
2824 (dolist (elt all-vars)
2825 (cond ((member elt unsafe-vars)
2827 ((member elt risky-vars)
2831 (princ (car elt) buf)
2833 ;; Make strings with embedded whitespace easier to read.
2834 (let ((print-escape-newlines t))
2835 (prin1 (cdr elt) buf))
2838 (format "Please type %s%s: "
2839 (if offer-save "y, n, or !" "y or n")
2840 (if (< (line-number-at-pos) (window-body-height))
2842 ", or C-v to scroll")))
2843 (goto-char (point-min))
2844 (let ((cursor-in-echo-area t)
2845 (executing-kbd-macro executing-kbd-macro)
2847 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2850 (message "%s" prompt)
2851 (setq char (read-event))
2853 (cond ((eq char ?\C-v)
2856 (error (goto-char (point-min)))))
2857 ;; read-event returns -1 if we are in a kbd
2858 ;; macro and there are no more events in the
2859 ;; macro. In that case, attempt to get an
2860 ;; event interactively.
2861 ((and executing-kbd-macro (= char -1))
2862 (setq executing-kbd-macro nil))
2863 (t (setq done (memq (downcase char) exit-chars)))))))
2864 (setq char (downcase char))
2865 (when (and offer-save (= char ?!) unsafe-vars)
2866 (dolist (elt unsafe-vars)
2867 (add-to-list 'safe-local-variable-values elt))
2868 ;; When this is called from desktop-restore-file-buffer,
2869 ;; coding-system-for-read may be non-nil. Reset it before
2870 ;; writing to .emacs.
2871 (if (or custom-file user-init-file)
2872 (let ((coding-system-for-read nil))
2873 (customize-save-variable
2874 'safe-local-variable-values
2875 safe-local-variable-values))))
2881 (defun hack-local-variables-prop-line (&optional mode-only)
2882 "Return local variables specified in the -*- line.
2883 Ignore any specification for `mode:' and `coding:';
2884 `set-auto-mode' should already have handled `mode:',
2885 `set-auto-coding' should already have handled `coding:'.
2887 If MODE-ONLY is non-nil, all we do is check whether the major
2888 mode is specified, returning t if it is specified. Otherwise,
2889 return an alist of elements (VAR . VAL), where VAR is a variable
2890 and VAL is the specified value."
2892 (goto-char (point-min))
2893 (let ((end (set-auto-mode-1))
2894 result mode-specified)
2895 ;; Parse the -*- line into the RESULT alist.
2896 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2899 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2900 ;; Simple form: "-*- MODENAME -*-". Already handled.
2901 (setq mode-specified t)
2904 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2905 ;; (last ";" is optional).
2906 (while (< (point) end)
2907 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2908 (error "Malformed -*- line"))
2909 (goto-char (match-end 0))
2910 ;; There used to be a downcase here,
2911 ;; but the manual didn't say so,
2912 ;; and people want to set var names that aren't all lc.
2913 (let ((key (intern (match-string 1)))
2914 (val (save-restriction
2915 (narrow-to-region (point) end)
2916 (let ((read-circle nil))
2917 (read (current-buffer))))))
2918 ;; It is traditional to ignore
2919 ;; case when checking for `mode' in set-auto-mode,
2920 ;; so we must do that here as well.
2921 ;; That is inconsistent, but we're stuck with it.
2922 ;; The same can be said for `coding' in set-auto-coding.
2923 (or (and (equal (downcase (symbol-name key)) "mode")
2924 (setq mode-specified t))
2925 (equal (downcase (symbol-name key)) "coding")
2927 (push (cons (if (eq key 'eval)
2929 (indirect-variable key))
2932 (skip-chars-forward " \t;")))))
2938 (defun hack-local-variables-filter (variables dir-name)
2939 "Filter local variable settings, querying the user if necessary.
2940 VARIABLES is the alist of variable-value settings. This alist is
2941 filtered based on the values of `ignored-local-variables',
2942 `enable-local-eval', `enable-local-variables', and (if necessary)
2943 user interaction. The results are added to
2944 `file-local-variables-alist', without applying them.
2945 DIR-NAME is a directory name if these settings come from
2946 directory-local variables, or nil otherwise."
2947 ;; Find those variables that we may want to save to
2948 ;; `safe-local-variable-values'.
2949 (let (all-vars risky-vars unsafe-vars)
2950 (dolist (elt variables)
2951 (let ((var (car elt))
2953 (cond ((memq var ignored-local-variables)
2954 ;; Ignore any variable in `ignored-local-variables'.
2956 ;; Obey `enable-local-eval'.
2958 (when enable-local-eval
2960 (or (eq enable-local-eval t)
2961 (hack-one-local-variable-eval-safep (eval (quote val)))
2962 (push elt unsafe-vars))))
2963 ;; Ignore duplicates in the present list.
2964 ((assq var all-vars) nil)
2965 ;; Accept known-safe variables.
2966 ((or (memq var '(mode unibyte coding))
2967 (safe-local-variable-p var val))
2968 (push elt all-vars))
2969 ;; The variable is either risky or unsafe:
2970 ((not (eq enable-local-variables :safe))
2972 (if (risky-local-variable-p var val)
2973 (push elt risky-vars)
2974 (push elt unsafe-vars))))))
2976 ;; Query, unless all vars are safe or user wants no querying.
2977 (or (and (eq enable-local-variables t)
2980 (memq enable-local-variables '(:all :safe))
2981 (hack-local-variables-confirm all-vars unsafe-vars
2982 risky-vars dir-name))
2983 (dolist (elt all-vars)
2984 (unless (eq (car elt) 'eval)
2986 (setq dir-local-variables-alist
2987 (assq-delete-all (car elt) dir-local-variables-alist)))
2988 (setq file-local-variables-alist
2989 (assq-delete-all (car elt) file-local-variables-alist)))
2990 (push elt file-local-variables-alist)))))
2992 (defun hack-local-variables (&optional mode-only)
2993 "Parse and put into effect this buffer's local variables spec.
2994 If MODE-ONLY is non-nil, all we do is check whether the major mode
2995 is specified, returning t if it is specified."
2996 (let ((enable-local-variables
2997 (and local-enable-local-variables enable-local-variables))
3000 (setq file-local-variables-alist nil)
3001 (report-errors "Directory-local variables error: %s"
3002 (hack-dir-local-variables)))
3003 (when (or mode-only enable-local-variables)
3004 (setq result (hack-local-variables-prop-line mode-only))
3005 ;; Look for "Local variables:" line in last page.
3007 (goto-char (point-max))
3008 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3010 (when (let ((case-fold-search t))
3011 (search-forward "Local Variables:" nil t))
3012 (skip-chars-forward " \t")
3013 ;; suffix is what comes after "local variables:" in its line.
3014 ;; prefix is what comes before "local variables:" in its line.
3017 (regexp-quote (buffer-substring (point)
3018 (line-end-position)))
3021 (concat "^" (regexp-quote
3022 (buffer-substring (line-beginning-position)
3023 (match-beginning 0)))))
3027 (let ((startpos (point))
3029 (thisbuf (current-buffer)))
3031 (unless (let ((case-fold-search t))
3033 (concat prefix "[ \t]*End:[ \t]*" suffix)
3035 ;; This used to be an error, but really all it means is
3036 ;; that this may simply not be a local-variables section,
3037 ;; so just ignore it.
3038 (message "Local variables list is not properly terminated"))
3040 (setq endpos (point)))
3043 (insert-buffer-substring thisbuf startpos endpos)
3044 (goto-char (point-min))
3045 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3047 ;; Discard the prefix.
3048 (if (looking-at prefix)
3049 (delete-region (point) (match-end 0))
3050 (error "Local variables entry is missing the prefix"))
3052 ;; Discard the suffix.
3053 (if (looking-back suffix)
3054 (delete-region (match-beginning 0) (point))
3055 (error "Local variables entry is missing the suffix"))
3057 (goto-char (point-min))
3060 ;; Find the variable name; strip whitespace.
3061 (skip-chars-forward " \t")
3063 (skip-chars-forward "^:\n")
3064 (if (eolp) (error "Missing colon in local variables entry"))
3065 (skip-chars-backward " \t")
3066 (let* ((str (buffer-substring beg (point)))
3067 (var (let ((read-circle nil))
3070 ;; Read the variable value.
3071 (skip-chars-forward "^:")
3073 (let ((read-circle nil))
3074 (setq val (read (current-buffer))))
3078 (unless (eq var 'coding)
3080 (push (cons (if (eq var 'eval)
3082 (indirect-variable var))
3085 (forward-line 1))))))))
3086 ;; Now we've read all the local variables.
3087 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3088 (cond (mode-only result)
3089 ;; Otherwise, set the variables.
3090 (enable-local-variables
3091 (hack-local-variables-filter result nil)
3092 (when file-local-variables-alist
3093 ;; Any 'evals must run in the Right sequence.
3094 (setq file-local-variables-alist
3095 (nreverse file-local-variables-alist))
3096 (run-hooks 'before-hack-local-variables-hook)
3097 (dolist (elt file-local-variables-alist)
3098 (hack-one-local-variable (car elt) (cdr elt))))
3099 (run-hooks 'hack-local-variables-hook)))))
3101 (defun safe-local-variable-p (sym val)
3102 "Non-nil if SYM is safe as a file-local variable with value VAL.
3103 It is safe if any of these conditions are met:
3105 * There is a matching entry (SYM . VAL) in the
3106 `safe-local-variable-values' user option.
3108 * The `safe-local-variable' property of SYM is a function that
3109 evaluates to a non-nil value with VAL as an argument."
3110 (or (member (cons sym val) safe-local-variable-values)
3111 (let ((safep (get sym 'safe-local-variable)))
3112 (and (functionp safep) (funcall safep val)))))
3114 (defun risky-local-variable-p (sym &optional ignored)
3115 "Non-nil if SYM could be dangerous as a file-local variable.
3116 It is dangerous if either of these conditions are met:
3118 * Its `risky-local-variable' property is non-nil.
3120 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3121 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3122 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3123 \"map-alist\", or \"bindat-spec\"."
3124 ;; If this is an alias, check the base name.
3126 (setq sym (indirect-variable sym))
3128 (or (get sym 'risky-local-variable)
3129 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3130 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3131 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3132 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3134 (defun hack-one-local-variable-quotep (exp)
3135 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3137 (defun hack-one-local-variable-constantp (exp)
3138 (or (and (not (symbolp exp)) (not (consp exp)))
3141 (hack-one-local-variable-quotep exp)))
3143 (defun hack-one-local-variable-eval-safep (exp)
3144 "Return t if it is safe to eval EXP when it is found in a file."
3145 (or (not (consp exp))
3146 ;; Detect certain `put' expressions.
3147 (and (eq (car exp) 'put)
3148 (hack-one-local-variable-quotep (nth 1 exp))
3149 (hack-one-local-variable-quotep (nth 2 exp))
3150 (let ((prop (nth 1 (nth 2 exp)))
3152 (cond ((memq prop '(lisp-indent-hook
3153 lisp-indent-function
3154 scheme-indent-function))
3155 ;; Only allow safe values (not functions).
3157 (and (hack-one-local-variable-quotep val)
3158 (eq (nth 1 val) 'defun))))
3159 ((eq prop 'edebug-form-spec)
3160 ;; Only allow indirect form specs.
3161 ;; During bootstrapping, edebug-basic-spec might not be
3163 (and (fboundp 'edebug-basic-spec)
3164 (hack-one-local-variable-quotep val)
3165 (edebug-basic-spec (nth 1 val)))))))
3166 ;; Allow expressions that the user requested.
3167 (member exp safe-local-eval-forms)
3168 ;; Certain functions can be allowed with safe arguments
3169 ;; or can specify verification functions to try.
3170 (and (symbolp (car exp))
3171 (let ((prop (get (car exp) 'safe-local-eval-function)))
3174 (dolist (arg (cdr exp))
3175 (unless (hack-one-local-variable-constantp arg)
3182 (dolist (function prop)
3183 (if (funcall function exp)
3187 (defun hack-one-local-variable (var val)
3188 "Set local variable VAR with value VAL.
3189 If VAR is `mode', call `VAL-mode' as a function unless it's
3190 already the major mode."
3191 (cond ((eq var 'mode)
3192 (let ((mode (intern (concat (downcase (symbol-name val))
3194 (unless (eq (indirect-function mode)
3195 (indirect-function major-mode))
3196 (if (memq mode minor-mode-list)
3197 ;; A minor mode must be passed an argument.
3198 ;; Otherwise, if the user enables the minor mode in a
3199 ;; major mode hook, this would toggle it off.
3203 (save-excursion (eval val)))
3205 ;; Make sure the string has no text properties.
3206 ;; Some text properties can get evaluated in various ways,
3207 ;; so it is risky to put them on with a local variable list.
3209 (set-text-properties 0 (length val) nil val))
3210 (set (make-local-variable var) val))))
3212 ;;; Handling directory-local variables, aka project settings.
3214 (defvar dir-locals-class-alist '()
3215 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3217 (defvar dir-locals-directory-cache '()
3218 "List of cached directory roots for directory-local variable classes.
3219 Each element in this list has the form (DIR CLASS MTIME).
3220 DIR is the name of the directory.
3221 CLASS is the name of a variable class (a symbol).
3222 MTIME is the recorded modification time of the directory-local
3223 variables file associated with this entry. This time is a list
3224 of two integers (the same format as `file-attributes'), and is
3225 used to test whether the cache entry is still valid.
3226 Alternatively, MTIME can be nil, which means the entry is always
3229 (defsubst dir-locals-get-class-variables (class)
3230 "Return the variable list for CLASS."
3231 (cdr (assq class dir-locals-class-alist)))
3233 (defun dir-locals-collect-mode-variables (mode-variables variables)
3234 "Collect directory-local variables from MODE-VARIABLES.
3235 VARIABLES is the initial list of variables.
3236 Returns the new list."
3237 (dolist (pair mode-variables variables)
3238 (let* ((variable (car pair))
3240 (slot (assq variable variables)))
3241 ;; If variables are specified more than once, only use the last. (Why?)
3242 ;; The pseudo-variables mode and eval are different (bug#3430).
3243 (if (and slot (not (memq variable '(mode eval))))
3245 ;; Need a new cons in case we setcdr later.
3246 (push (cons variable value) variables)))))
3248 (defun dir-locals-collect-variables (class-variables root variables)
3249 "Collect entries from CLASS-VARIABLES into VARIABLES.
3250 ROOT is the root directory of the project.
3251 Return the new variables list."
3252 (let* ((file-name (buffer-file-name))
3253 (sub-file-name (if file-name
3254 (substring file-name (length root)))))
3255 (dolist (entry class-variables variables)
3256 (let ((key (car entry)))
3259 ;; Don't include this in the previous condition, because we
3260 ;; want to filter all strings before the next condition.
3261 (when (and sub-file-name
3262 (>= (length sub-file-name) (length key))
3263 (string= key (substring sub-file-name 0 (length key))))
3264 (setq variables (dir-locals-collect-variables
3265 (cdr entry) root variables))))
3267 (derived-mode-p key))
3268 (setq variables (dir-locals-collect-mode-variables
3269 (cdr entry) variables))))))))
3271 (defun dir-locals-set-directory-class (directory class &optional mtime)
3272 "Declare that the DIRECTORY root is an instance of CLASS.
3273 DIRECTORY is the name of a directory, a string.
3274 CLASS is the name of a project class, a symbol.
3275 MTIME is either the modification time of the directory-local
3276 variables file that defined this class, or nil.
3278 When a file beneath DIRECTORY is visited, the mode-specific
3279 variables from CLASS are applied to the buffer. The variables
3280 for a class are defined using `dir-locals-set-class-variables'."
3281 (setq directory (file-name-as-directory (expand-file-name directory)))
3282 (unless (assq class dir-locals-class-alist)
3283 (error "No such class `%s'" (symbol-name class)))
3284 (push (list directory class mtime) dir-locals-directory-cache))
3286 (defun dir-locals-set-class-variables (class variables)
3287 "Map the type CLASS to a list of variable settings.
3288 CLASS is the project class, a symbol. VARIABLES is a list
3289 that declares directory-local variables for the class.
3290 An element in VARIABLES is either of the form:
3291 (MAJOR-MODE . ALIST)
3295 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3296 whose elements are of the form (VARIABLE . VALUE).
3298 In the second form, DIRECTORY is a directory name (a string), and
3299 LIST is a list of the form accepted by the function.
3301 When a file is visited, the file's class is found. A directory
3302 may be assigned a class using `dir-locals-set-directory-class'.
3303 Then variables are set in the file's buffer according to the
3304 class' LIST. The list is processed in order.
3306 * If the element is of the form (MAJOR-MODE . ALIST), and the
3307 buffer's major mode is derived from MAJOR-MODE (as determined
3308 by `derived-mode-p'), then all the variables in ALIST are
3309 applied. A MAJOR-MODE of nil may be used to match any buffer.
3310 `make-local-variable' is called for each variable before it is
3313 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3314 is an initial substring of the file's directory, then LIST is
3315 applied by recursively following these rules."
3316 (let ((elt (assq class dir-locals-class-alist)))
3318 (setcdr elt variables)
3319 (push (cons class variables) dir-locals-class-alist))))
3321 (defconst dir-locals-file ".dir-locals.el"
3322 "File that contains directory-local variables.
3323 It has to be constant to enforce uniform values
3324 across different environments and users.")
3326 (defun dir-locals-find-file (file)
3327 "Find the directory-local variables for FILE.
3328 This searches upward in the directory tree from FILE.
3329 If the directory root of FILE has been registered in
3330 `dir-locals-directory-cache' and the directory-local variables
3331 file has not been modified, return the matching entry in
3332 `dir-locals-directory-cache'.
3333 Otherwise, if a directory-local variables file is found, return
3335 Otherwise, return nil."
3336 (setq file (expand-file-name file))
3337 (let* ((dir-locals-file-name
3338 (if (eq system-type 'ms-dos)
3339 (dosified-file-name dir-locals-file)
3341 (locals-file (locate-dominating-file file dir-locals-file-name))
3343 ;; `locate-dominating-file' may have abbreviated the name.
3345 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3346 ;; Find the best cached value in `dir-locals-directory-cache'.
3347 (dolist (elt dir-locals-directory-cache)
3348 (when (and (eq t (compare-strings file nil (length (car elt))
3351 '(windows-nt cygwin ms-dos))))
3352 (> (length (car elt)) (length (car dir-elt))))
3353 (setq dir-elt elt)))
3354 (let ((use-cache (and dir-elt
3355 (or (null locals-file)
3356 (<= (length (file-name-directory locals-file))
3357 (length (car dir-elt)))))))
3359 ;; Check the validity of the cache.
3360 (if (and (file-readable-p (car dir-elt))
3361 (or (null (nth 2 dir-elt))
3362 (equal (nth 2 dir-elt)
3363 (nth 5 (file-attributes (car dir-elt))))))
3364 ;; This cache entry is OK.
3366 ;; This cache entry is invalid; clear it.
3367 (setq dir-locals-directory-cache
3368 (delq dir-elt dir-locals-directory-cache))
3372 (defun dir-locals-read-from-file (file)
3373 "Load a variables FILE and register a new class and instance.
3374 FILE is the name of the file holding the variables to apply.
3375 The new class name is the same as the directory in which FILE
3376 is found. Returns the new class name."
3378 (insert-file-contents file)
3379 (let* ((dir-name (file-name-directory file))
3380 (class-name (intern dir-name))
3381 (variables (let ((read-circle nil))
3382 (read (current-buffer)))))
3383 (dir-locals-set-class-variables class-name variables)
3384 (dir-locals-set-directory-class dir-name class-name
3385 (nth 5 (file-attributes file)))
3388 (defun hack-dir-local-variables ()
3389 "Read per-directory local variables for the current buffer.
3390 Store the directory-local variables in `dir-local-variables-alist'
3391 and `file-local-variables-alist', without applying them."
3392 (when (and enable-local-variables
3394 (not (file-remote-p (buffer-file-name))))
3395 ;; Find the variables file.
3396 (let ((variables-file (dir-locals-find-file (buffer-file-name)))
3400 ((stringp variables-file)
3401 (setq dir-name (file-name-directory (buffer-file-name)))
3402 (setq class (dir-locals-read-from-file variables-file)))
3403 ((consp variables-file)
3404 (setq dir-name (nth 0 variables-file))
3405 (setq class (nth 1 variables-file))))
3408 (dir-locals-collect-variables
3409 (dir-locals-get-class-variables class) dir-name nil)))
3411 (dolist (elt variables)
3412 (unless (eq (car elt) 'eval)
3413 (setq dir-local-variables-alist
3414 (assq-delete-all (car elt) dir-local-variables-alist)))
3415 (push elt dir-local-variables-alist))
3416 (hack-local-variables-filter variables dir-name)))))))
3419 (defcustom change-major-mode-with-file-name t
3420 "Non-nil means \\[write-file] should set the major mode from the file name.
3421 However, the mode will not be changed if
3422 \(1) a local variables list or the `-*-' line specifies a major mode, or
3423 \(2) the current major mode is a \"special\" mode,
3424 \ not suitable for ordinary files, or
3425 \(3) the new file name does not particularly specify any mode."
3427 :group 'editing-basics)
3429 (defun set-visited-file-name (filename &optional no-query along-with-file)
3430 "Change name of file visited in current buffer to FILENAME.
3431 This also renames the buffer to correspond to the new file.
3432 The next time the buffer is saved it will go in the newly specified file.
3433 FILENAME nil or an empty string means mark buffer as not visiting any file.
3434 Remember to delete the initial contents of the minibuffer
3435 if you wish to pass an empty string as the argument.
3437 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3438 confirmation in the case where another buffer is already visiting FILENAME.
3440 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3441 the old visited file has been renamed to the new name FILENAME."
3442 (interactive "FSet visited file name: ")
3443 (if (buffer-base-buffer)
3444 (error "An indirect buffer cannot visit a file"))
3448 (if (string-equal filename "")
3450 (expand-file-name filename))))
3453 (setq truename (file-truename filename))
3454 (if find-file-visit-truename
3455 (setq filename truename))))
3457 (let ((new-name (file-name-nondirectory filename)))
3458 (if (string= new-name "")
3459 (error "Empty file name"))))
3460 (let ((buffer (and filename (find-buffer-visiting filename))))
3461 (and buffer (not (eq buffer (current-buffer)))
3463 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3466 (or (equal filename buffer-file-name)
3468 (and filename (lock-buffer filename))
3470 (setq buffer-file-name filename)
3471 (if filename ; make buffer name reflect filename.
3472 (let ((new-name (file-name-nondirectory buffer-file-name)))
3473 (setq default-directory (file-name-directory buffer-file-name))
3474 ;; If new-name == old-name, renaming would add a spurious <2>
3475 ;; and it's considered as a feature in rename-buffer.
3476 (or (string= new-name (buffer-name))
3477 (rename-buffer new-name t))))
3478 (setq buffer-backed-up nil)
3480 (clear-visited-file-modtime))
3481 ;; Abbreviate the file names of the buffer.
3484 (setq buffer-file-truename (abbreviate-file-name truename))
3485 (if find-file-visit-truename
3486 (setq buffer-file-name truename))))
3487 (setq buffer-file-number
3489 (nthcdr 10 (file-attributes buffer-file-name))
3491 ;; write-file-functions is normally used for things like ftp-find-file
3492 ;; that visit things that are not local files as if they were files.
3493 ;; Changing to visit an ordinary local file instead should flush the hook.
3494 (kill-local-variable 'write-file-functions)
3495 (kill-local-variable 'local-write-file-hooks)
3496 (kill-local-variable 'revert-buffer-function)
3497 (kill-local-variable 'backup-inhibited)
3498 ;; If buffer was read-only because of version control,
3499 ;; that reason is gone now, so make it writable.
3501 (setq buffer-read-only nil))
3502 (kill-local-variable 'vc-mode)
3503 ;; Turn off backup files for certain file names.
3504 ;; Since this is a permanent local, the major mode won't eliminate it.
3505 (and buffer-file-name
3506 backup-enable-predicate
3507 (not (funcall backup-enable-predicate buffer-file-name))
3509 (make-local-variable 'backup-inhibited)
3510 (setq backup-inhibited t)))
3511 (let ((oauto buffer-auto-save-file-name))
3512 ;; If auto-save was not already on, turn it on if appropriate.
3513 (if (not buffer-auto-save-file-name)
3514 (and buffer-file-name auto-save-default
3516 ;; If auto save is on, start using a new name.
3517 ;; We deliberately don't rename or delete the old auto save
3518 ;; for the old visited file name. This is because perhaps
3519 ;; the user wants to save the new state and then compare with the
3520 ;; previous state from the auto save file.
3521 (setq buffer-auto-save-file-name
3522 (make-auto-save-file-name)))
3523 ;; Rename the old auto save file if any.
3524 (and oauto buffer-auto-save-file-name
3525 (file-exists-p oauto)
3526 (rename-file oauto buffer-auto-save-file-name t)))
3527 (and buffer-file-name
3528 (not along-with-file)
3529 (set-buffer-modified-p t))
3530 ;; Update the major mode, if the file name determines it.
3532 ;; Don't change the mode if it is special.
3533 (or (not change-major-mode-with-file-name)
3534 (get major-mode 'mode-class)
3535 ;; Don't change the mode if the local variable list specifies it.
3536 (hack-local-variables t)
3540 (defun write-file (filename &optional confirm)
3541 "Write current buffer into file FILENAME.
3542 This makes the buffer visit that file, and marks it as not modified.
3544 If you specify just a directory name as FILENAME, that means to use
3545 the default file name but in that directory. You can also yank
3546 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3548 If the buffer is not already visiting a file, the default file name
3549 for the output file is the buffer name.
3551 If optional second arg CONFIRM is non-nil, this function
3552 asks for confirmation before overwriting an existing file.
3553 Interactively, confirmation is required unless you supply a prefix argument."
3554 ;; (interactive "FWrite file: ")
3556 (list (if buffer-file-name
3557 (read-file-name "Write file: "
3559 (read-file-name "Write file: " default-directory
3561 (file-name-nondirectory (buffer-name))
3564 (not current-prefix-arg)))
3565 (or (null filename) (string-equal filename "")
3567 ;; If arg is just a directory,
3568 ;; use the default file name, but in that directory.
3569 (if (file-directory-p filename)
3570 (setq filename (concat (file-name-as-directory filename)
3571 (file-name-nondirectory
3572 (or buffer-file-name (buffer-name))))))
3574 (file-exists-p filename)
3575 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3576 (error "Canceled")))
3577 (set-visited-file-name filename (not confirm))))
3578 (set-buffer-modified-p t)
3579 ;; Make buffer writable if file is writable.
3580 (and buffer-file-name
3581 (file-writable-p buffer-file-name)
3582 (setq buffer-read-only nil))
3584 ;; It's likely that the VC status at the new location is different from
3585 ;; the one at the old location.
3586 (vc-find-file-hook))
3588 (defun backup-buffer ()
3589 "Make a backup of the disk file visited by the current buffer, if appropriate.
3590 This is normally done before saving the buffer the first time.
3592 A backup may be done by renaming or by copying; see documentation of
3593 variable `make-backup-files'. If it's done by renaming, then the file is
3594 no longer accessible under its old name.
3596 The value is non-nil after a backup was made by renaming.
3597 It has the form (MODES . BACKUPNAME).
3598 MODES is the result of `file-modes' on the original
3599 file; this means that the caller, after saving the buffer, should change
3600 the modes of the new file to agree with the old modes.
3601 BACKUPNAME is the backup file name, which is the old file renamed."
3602 (if (and make-backup-files (not backup-inhibited)
3603 (not buffer-backed-up)
3604 (file-exists-p buffer-file-name)
3605 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3607 (let ((real-file-name buffer-file-name)
3608 backup-info backupname targets setmodes)
3609 ;; If specified name is a symbolic link, chase it to the target.
3610 ;; Thus we make the backups in the directory where the real file is.
3611 (setq real-file-name (file-chase-links real-file-name))
3612 (setq backup-info (find-backup-file-name real-file-name)
3613 backupname (car backup-info)
3614 targets (cdr backup-info))
3615 ;; (if (file-directory-p buffer-file-name)
3616 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3619 (let ((delete-old-versions
3620 ;; If have old versions to maybe delete,
3621 ;; ask the user to confirm now, before doing anything.
3622 ;; But don't actually delete til later.
3624 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3625 (or delete-old-versions
3626 (y-or-n-p (format "Delete excess backup versions of %s? "
3628 (modes (file-modes buffer-file-name)))
3629 ;; Actually write the back up file.
3631 (if (or file-precious-flag
3632 ; (file-symlink-p buffer-file-name)
3634 ;; Don't rename a suid or sgid file.
3635 (and modes (< 0 (logand modes #o6000)))
3636 (not (file-writable-p (file-name-directory real-file-name)))
3637 (and backup-by-copying-when-linked
3638 (> (file-nlinks real-file-name) 1))
3639 (and (or backup-by-copying-when-mismatch
3640 (integerp backup-by-copying-when-privileged-mismatch))
3641 (let ((attr (file-attributes real-file-name)))
3642 (and (or backup-by-copying-when-mismatch
3643 (and (integerp (nth 2 attr))
3644 (integerp backup-by-copying-when-privileged-mismatch)
3645 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3647 (not (file-ownership-preserved-p real-file-name)))))))
3648 (backup-buffer-copy real-file-name backupname modes)
3649 ;; rename-file should delete old backup.
3650 (rename-file real-file-name backupname t)
3651 (setq setmodes (cons modes backupname)))
3653 ;; If trouble writing the backup, write it in ~.
3654 (setq backupname (expand-file-name
3655 (convert-standard-filename
3657 (message "Cannot write backup file; backing up in %s"
3660 (backup-buffer-copy real-file-name backupname modes)))
3661 (setq buffer-backed-up t)
3662 ;; Now delete the old versions, if desired.
3663 (if delete-old-versions
3666 (delete-file (car targets))
3668 (setq targets (cdr targets))))
3670 (file-error nil))))))
3672 (defun backup-buffer-copy (from-name to-name modes)
3673 (let ((umask (default-file-modes)))
3676 ;; Create temp files with strict access rights. It's easy to
3677 ;; loosen them later, whereas it's impossible to close the
3678 ;; time-window of loose permissions otherwise.
3679 (set-default-file-modes ?\700)
3680 (when (condition-case nil
3681 ;; Try to overwrite old backup first.
3682 (copy-file from-name to-name t t t)
3684 (while (condition-case nil
3686 (when (file-exists-p to-name)
3687 (delete-file to-name))
3688 (copy-file from-name to-name nil t t)
3690 (file-already-exists t))
3691 ;; The file was somehow created by someone else between
3692 ;; `delete-file' and `copy-file', so let's try again.
3693 ;; rms says "I think there is also a possible race
3694 ;; condition for making backup files" (emacs-devel 20070821).
3697 (set-default-file-modes umask)))
3699 (set-file-modes to-name (logand modes #o1777))))
3701 (defun file-name-sans-versions (name &optional keep-backup-version)
3702 "Return file NAME sans backup versions or strings.
3703 This is a separate procedure so your site-init or startup file can
3705 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3706 we do not remove backup version numbers, only true file version numbers."
3707 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3709 (funcall handler 'file-name-sans-versions name keep-backup-version)
3711 (if keep-backup-version
3713 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3714 (string-match "~\\'" name)
3717 (defun file-ownership-preserved-p (file)
3718 "Return t if deleting FILE and rewriting it would preserve the owner."
3719 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3721 (funcall handler 'file-ownership-preserved-p file)
3722 (let ((attributes (file-attributes file)))
3723 ;; Return t if the file doesn't exist, since it's true that no
3724 ;; information would be lost by an (attempted) delete and create.
3725 (or (null attributes)
3726 (= (nth 2 attributes) (user-uid)))))))
3728 (defun file-name-sans-extension (filename)
3729 "Return FILENAME sans final \"extension\".
3730 The extension, in a file name, is the part that follows the last `.',
3731 except that a leading `.', if any, doesn't count."
3733 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3735 (if (and (string-match "\\.[^.]*\\'" file)
3736 (not (eq 0 (match-beginning 0))))
3737 (if (setq directory (file-name-directory filename))
3738 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3739 ;; we don't want to expand it.
3740 (concat directory (substring file 0 (match-beginning 0)))
3741 (substring file 0 (match-beginning 0)))
3744 (defun file-name-extension (filename &optional period)
3745 "Return FILENAME's final \"extension\".
3746 The extension, in a file name, is the part that follows the last `.',
3747 excluding version numbers and backup suffixes,
3748 except that a leading `.', if any, doesn't count.
3749 Return nil for extensionless file names such as `foo'.
3750 Return the empty string for file names such as `foo.'.
3752 If PERIOD is non-nil, then the returned value includes the period
3753 that delimits the extension, and if FILENAME has no extension,
3756 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3757 (if (and (string-match "\\.[^.]*\\'" file)
3758 (not (eq 0 (match-beginning 0))))
3759 (substring file (+ (match-beginning 0) (if period 0 1)))
3763 (defcustom make-backup-file-name-function nil
3764 "A function to use instead of the default `make-backup-file-name'.
3765 A value of nil gives the default `make-backup-file-name' behavior.
3767 This could be buffer-local to do something special for specific
3768 files. If you define it, you may need to change `backup-file-name-p'
3769 and `file-name-sans-versions' too.
3771 See also `backup-directory-alist'."
3773 :type '(choice (const :tag "Default" nil)
3774 (function :tag "Your function")))
3776 (defcustom backup-directory-alist nil
3777 "Alist of filename patterns and backup directory names.
3778 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3779 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3780 relative or absolute. If it is absolute, so that all matching files
3781 are backed up into the same directory, the file names in this
3782 directory will be the full name of the file backed up with all
3783 directory separators changed to `!' to prevent clashes. This will not
3784 work correctly if your filesystem truncates the resulting name.
3786 For the common case of all backups going into one directory, the alist
3787 should contain a single element pairing \".\" with the appropriate
3790 If this variable is nil, or it fails to match a filename, the backup
3791 is made in the original file's directory.
3793 On MS-DOS filesystems without long names this variable is always
3796 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3797 (directory :tag "Backup directory name"))))
3799 (defun normal-backup-enable-predicate (name)
3800 "Default `backup-enable-predicate' function.
3801 Checks for files in `temporary-file-directory',
3802 `small-temporary-file-directory', and /tmp."
3803 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3805 ;; Directory is under temporary-file-directory.
3806 (and (not (eq comp t))
3807 (< comp (- (length temporary-file-directory)))))
3808 (let ((comp (compare-strings "/tmp" 0 nil
3810 ;; Directory is under /tmp.
3811 (and (not (eq comp t))
3812 (< comp (- (length "/tmp")))))
3813 (if small-temporary-file-directory
3814 (let ((comp (compare-strings small-temporary-file-directory
3817 ;; Directory is under small-temporary-file-directory.
3818 (and (not (eq comp t))
3819 (< comp (- (length small-temporary-file-directory)))))))))
3821 (defun make-backup-file-name (file)
3822 "Create the non-numeric backup file name for FILE.
3823 Normally this will just be the file's name with `~' appended.
3824 Customization hooks are provided as follows.
3826 If the variable `make-backup-file-name-function' is non-nil, its value
3827 should be a function which will be called with FILE as its argument;
3828 the resulting name is used.
3830 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3831 the documentation of that variable. If the directory for the backup
3832 doesn't exist, it is created."
3833 (if make-backup-file-name-function
3834 (funcall make-backup-file-name-function file)
3835 (if (and (eq system-type 'ms-dos)
3836 (not (msdos-long-file-names)))
3837 (let ((fn (file-name-nondirectory file)))
3838 (concat (file-name-directory file)
3839 (or (and (string-match "\\`[^.]+\\'" fn)
3840 (concat (match-string 0 fn) ".~"))
3841 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3842 (concat (match-string 0 fn) "~")))))
3843 (concat (make-backup-file-name-1 file) "~"))))
3845 (defun make-backup-file-name-1 (file)
3846 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3847 (let ((alist backup-directory-alist)
3848 elt backup-directory abs-backup-directory)
3850 (setq elt (pop alist))
3851 (if (string-match (car elt) file)
3852 (setq backup-directory (cdr elt)
3854 ;; If backup-directory is relative, it should be relative to the
3855 ;; file's directory. By expanding explicitly here, we avoid
3856 ;; depending on default-directory.
3857 (if backup-directory
3858 (setq abs-backup-directory
3859 (expand-file-name backup-directory
3860 (file-name-directory file))))
3861 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3863 (make-directory abs-backup-directory 'parents)
3864 (file-error (setq backup-directory nil
3865 abs-backup-directory nil))))
3866 (if (null backup-directory)
3868 (if (file-name-absolute-p backup-directory)
3870 (when (memq system-type '(windows-nt ms-dos cygwin))
3871 ;; Normalize DOSish file names: downcase the drive
3872 ;; letter, if any, and replace the leading "x:" with
3874 (or (file-name-absolute-p file)
3875 (setq file (expand-file-name file))) ; make defaults explicit
3876 ;; Replace any invalid file-name characters (for the
3877 ;; case of backing up remote files).
3878 (setq file (expand-file-name (convert-standard-filename file)))
3879 (if (eq (aref file 1) ?:)
3880 (setq file (concat "/"
3882 (char-to-string (downcase (aref file 0)))
3883 (if (eq (aref file 2) ?/)
3886 (substring file 2)))))
3887 ;; Make the name unique by substituting directory
3888 ;; separators. It may not really be worth bothering about
3889 ;; doubling `!'s in the original name...
3891 (subst-char-in-string
3893 (replace-regexp-in-string "!" "!!" file))
3895 (expand-file-name (file-name-nondirectory file)
3896 (file-name-as-directory abs-backup-directory))))))
3898 (defun backup-file-name-p (file)
3899 "Return non-nil if FILE is a backup file name (numeric or not).
3900 This is a separate function so you can redefine it for customization.
3901 You may need to redefine `file-name-sans-versions' as well."
3902 (string-match "~\\'" file))
3904 (defvar backup-extract-version-start)
3906 ;; This is used in various files.
3907 ;; The usage of backup-extract-version-start is not very clean,
3908 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3909 (defun backup-extract-version (fn)
3910 "Given the name of a numeric backup file, FN, return the backup number.
3911 Uses the free variable `backup-extract-version-start', whose value should be
3912 the index in the name where the version number begins."
3913 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
3914 (= (match-beginning 0) backup-extract-version-start))
3915 (string-to-number (substring fn backup-extract-version-start -1))
3918 (defun find-backup-file-name (fn)
3919 "Find a file name for a backup file FN, and suggestions for deletions.
3920 Value is a list whose car is the name for the backup file
3921 and whose cdr is a list of old versions to consider deleting now.
3922 If the value is nil, don't make a backup.
3923 Uses `backup-directory-alist' in the same way as does
3924 `make-backup-file-name'."
3925 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3926 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3928 (funcall handler 'find-backup-file-name fn)
3929 (if (or (eq version-control 'never)
3930 ;; We don't support numbered backups on plain MS-DOS
3931 ;; when long file names are unavailable.
3932 (and (eq system-type 'ms-dos)
3933 (not (msdos-long-file-names))))
3934 (list (make-backup-file-name fn))
3935 (let* ((basic-name (make-backup-file-name-1 fn))
3936 (base-versions (concat (file-name-nondirectory basic-name)
3938 (backup-extract-version-start (length base-versions))
3940 (number-to-delete 0)
3941 possibilities deserve-versions-p versions)
3943 (setq possibilities (file-name-all-completions
3945 (file-name-directory basic-name))
3946 versions (sort (mapcar #'backup-extract-version
3949 high-water-mark (apply 'max 0 versions)
3950 deserve-versions-p (or version-control
3951 (> high-water-mark 0))
3952 number-to-delete (- (length versions)
3956 (file-error (setq possibilities nil)))
3957 (if (not deserve-versions-p)
3958 (list (make-backup-file-name fn))
3959 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3960 (if (and (> number-to-delete 0)
3961 ;; Delete nothing if there is overflow
3962 ;; in the number of versions to keep.
3963 (>= (+ kept-new-versions kept-old-versions -1) 0))
3965 (format "%s.~%d~" basic-name n))
3966 (let ((v (nthcdr kept-old-versions versions)))
3967 (rplacd (nthcdr (1- number-to-delete) v) ())
3970 (defun file-nlinks (filename)
3971 "Return number of names file FILENAME has."
3972 (car (cdr (file-attributes filename))))
3974 ;; (defun file-relative-name (filename &optional directory)
3975 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3976 ;; This function returns a relative file name which is equivalent to FILENAME
3977 ;; when used with that default directory as the default.
3978 ;; If this is impossible (which can happen on MSDOS and Windows
3979 ;; when the file name and directory use different drive names)
3980 ;; then it returns FILENAME."
3982 ;; (let ((fname (expand-file-name filename)))
3983 ;; (setq directory (file-name-as-directory
3984 ;; (expand-file-name (or directory default-directory))))
3985 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3986 ;; ;; drive names, they can't be relative, so return the absolute name.
3987 ;; (if (and (or (eq system-type 'ms-dos)
3988 ;; (eq system-type 'cygwin)
3989 ;; (eq system-type 'windows-nt))
3990 ;; (not (string-equal (substring fname 0 2)
3991 ;; (substring directory 0 2))))
3993 ;; (let ((ancestor ".")
3994 ;; (fname-dir (file-name-as-directory fname)))
3995 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3996 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3997 ;; (setq directory (file-name-directory (substring directory 0 -1))
3998 ;; ancestor (if (equal ancestor ".")
4000 ;; (concat "../" ancestor))))
4001 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4002 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4003 ;; ;; We matched within FNAME's directory part.
4004 ;; ;; Add the rest of FNAME onto ANCESTOR.
4005 ;; (let ((rest (substring fname (match-end 0))))
4006 ;; (if (and (equal ancestor ".")
4007 ;; (not (equal rest "")))
4008 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4010 ;; (concat (file-name-as-directory ancestor) rest)))
4011 ;; ;; We matched FNAME's directory equivalent.
4014 (defun file-relative-name (filename &optional directory)
4015 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4016 This function returns a relative file name which is equivalent to FILENAME
4017 when used with that default directory as the default.
4018 If FILENAME and DIRECTORY lie on different machines or on different drives
4019 on a DOS/Windows machine, it returns FILENAME in expanded form."
4022 (file-name-as-directory (expand-file-name (or directory
4023 default-directory))))
4024 (setq filename (expand-file-name filename))
4025 (let ((fremote (file-remote-p filename))
4026 (dremote (file-remote-p directory)))
4027 (if ;; Conditions for separate trees
4029 ;; Test for different drives on DOS/Windows
4031 ;; Should `cygwin' really be included here? --stef
4032 (memq system-type '(ms-dos cygwin windows-nt))
4033 (not (eq t (compare-strings filename 0 2 directory 0 2))))
4034 ;; Test for different remote file system identification
4035 (not (equal fremote dremote)))
4037 (let ((ancestor ".")
4038 (filename-dir (file-name-as-directory filename)))
4041 (eq t (compare-strings filename-dir nil (length directory)
4042 directory nil nil case-fold-search))
4043 (eq t (compare-strings filename nil (length directory)
4044 directory nil nil case-fold-search))))
4045 (setq directory (file-name-directory (substring directory 0 -1))
4046 ancestor (if (equal ancestor ".")
4048 (concat "../" ancestor))))
4049 ;; Now ancestor is empty, or .., or ../.., etc.
4050 (if (eq t (compare-strings filename nil (length directory)
4051 directory nil nil case-fold-search))
4052 ;; We matched within FILENAME's directory part.
4053 ;; Add the rest of FILENAME onto ANCESTOR.
4054 (let ((rest (substring filename (length directory))))
4055 (if (and (equal ancestor ".") (not (equal rest "")))
4056 ;; But don't bother with ANCESTOR if it would give us `./'.
4058 (concat (file-name-as-directory ancestor) rest)))
4059 ;; We matched FILENAME's directory equivalent.
4062 (defun save-buffer (&optional args)
4063 "Save current buffer in visited file if modified.
4064 Variations are described below.
4066 By default, makes the previous version into a backup file
4067 if previously requested or if this is the first save.
4068 Prefixed with one \\[universal-argument], marks this version
4069 to become a backup when the next save is done.
4070 Prefixed with two \\[universal-argument]'s,
4071 unconditionally makes the previous version into a backup file.
4072 Prefixed with three \\[universal-argument]'s, marks this version
4073 to become a backup when the next save is done,
4074 and unconditionally makes the previous version into a backup file.
4076 With a numeric argument of 0, never make the previous version
4079 If a file's name is FOO, the names of its numbered backup versions are
4080 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4081 Numeric backups (rather than FOO~) will be made if value of
4082 `version-control' is not the atom `never' and either there are already
4083 numeric versions of the file being backed up, or `version-control' is
4085 We don't want excessive versions piling up, so there are variables
4086 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4087 and `kept-new-versions', which tells how many newest versions to keep.
4088 Defaults are 2 old versions and 2 new.
4089 `dired-kept-versions' controls dired's clean-directory (.) command.
4090 If `delete-old-versions' is nil, system will query user
4091 before trimming versions. Otherwise it does it silently.
4093 If `vc-make-backup-files' is nil, which is the default,
4094 no backup files are made for files managed by version control.
4095 (This is because the version control system itself records previous versions.)
4097 See the subroutine `basic-save-buffer' for more information."
4099 (let ((modp (buffer-modified-p))
4100 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4101 (memq args '(16 64)))))
4102 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
4103 ;; We used to display the message below only for files > 50KB, but
4104 ;; then Rmail-mbox never displays it due to buffer swapping. If
4105 ;; the test is ever re-introduced, be sure to handle saving of
4107 (if (and modp (buffer-file-name))
4108 (message "Saving file %s..." (buffer-file-name)))
4110 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4112 (defun delete-auto-save-file-if-necessary (&optional force)
4113 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4114 Normally delete only if the file was written by this Emacs since
4115 the last real save, but optional arg FORCE non-nil means delete anyway."
4116 (and buffer-auto-save-file-name delete-auto-save-files
4117 (not (string= buffer-file-name buffer-auto-save-file-name))
4118 (or force (recent-auto-save-p))
4121 (delete-file buffer-auto-save-file-name)
4123 (set-buffer-auto-saved))))
4125 (defvar auto-save-hook nil
4126 "Normal hook run just before auto-saving.")
4128 (defcustom before-save-hook nil
4129 "Normal hook that is run before a buffer is saved to its file."
4130 :options '(copyright-update time-stamp)
4134 (defcustom after-save-hook nil
4135 "Normal hook that is run after a buffer is saved to its file."
4136 :options '(executable-make-buffer-file-executable-if-script-p)
4140 (defvar save-buffer-coding-system nil
4141 "If non-nil, use this coding system for saving the buffer.
4142 More precisely, use this coding system in place of the
4143 value of `buffer-file-coding-system', when saving the buffer.
4144 Calling `write-region' for any purpose other than saving the buffer
4145 will still use `buffer-file-coding-system'; this variable has no effect
4148 (make-variable-buffer-local 'save-buffer-coding-system)
4149 (put 'save-buffer-coding-system 'permanent-local t)
4151 (defun basic-save-buffer ()
4152 "Save the current buffer in its visited file, if it has been modified.
4153 The hooks `write-contents-functions' and `write-file-functions' get a chance
4154 to do the job of saving; if they do not, then the buffer is saved in
4155 the visited file in the usual way.
4156 Before and after saving the buffer, this function runs
4157 `before-save-hook' and `after-save-hook', respectively."
4159 (save-current-buffer
4160 ;; In an indirect buffer, save its base buffer instead.
4161 (if (buffer-base-buffer)
4162 (set-buffer (buffer-base-buffer)))
4163 (if (buffer-modified-p)
4164 (let ((recent-save (recent-auto-save-p))
4166 ;; If buffer has no file name, ask user for one.
4167 (or buffer-file-name
4170 (read-file-name "File to save in: ") nil)))
4171 (if (file-exists-p filename)
4172 (if (file-directory-p filename)
4173 ;; Signal an error if the user specified the name of an
4174 ;; existing directory.
4175 (error "%s is a directory" filename)
4176 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4178 (error "Canceled")))
4179 ;; Signal an error if the specified name refers to a
4180 ;; non-existing directory.
4181 (let ((dir (file-name-directory filename)))
4182 (unless (file-directory-p dir)
4183 (if (file-exists-p dir)
4184 (error "%s is not a directory" dir)
4185 (error "%s: no such directory" dir)))))
4186 (set-visited-file-name filename)))
4187 (or (verify-visited-file-modtime (current-buffer))
4188 (not (file-exists-p buffer-file-name))
4190 (format "%s has changed since visited or saved. Save anyway? "
4191 (file-name-nondirectory buffer-file-name)))
4192 (error "Save not confirmed"))
4196 (and (> (point-max) (point-min))
4197 (not find-file-literally)
4198 (/= (char-after (1- (point-max))) ?\n)
4199 (not (and (eq selective-display t)
4200 (= (char-after (1- (point-max))) ?\r)))
4201 (or (eq require-final-newline t)
4202 (eq require-final-newline 'visit-save)
4203 (and require-final-newline
4205 (format "Buffer %s does not end in newline. Add one? "
4208 (goto-char (point-max))
4210 ;; Support VC version backups.
4212 (run-hooks 'before-save-hook)
4213 (or (run-hook-with-args-until-success 'write-contents-functions)
4214 (run-hook-with-args-until-success 'local-write-file-hooks)
4215 (run-hook-with-args-until-success 'write-file-functions)
4216 ;; If a hook returned t, file is already "written".
4217 ;; Otherwise, write it the usual way now.
4218 (setq setmodes (basic-save-buffer-1)))
4219 ;; Now we have saved the current buffer. Let's make sure
4220 ;; that buffer-file-coding-system is fixed to what
4221 ;; actually used for saving by binding it locally.
4222 (if save-buffer-coding-system
4223 (setq save-buffer-coding-system last-coding-system-used)
4224 (setq buffer-file-coding-system last-coding-system-used))
4225 (setq buffer-file-number
4226 (nthcdr 10 (file-attributes buffer-file-name)))
4229 (set-file-modes buffer-file-name (car setmodes))
4231 ;; If the auto-save file was recent before this command,
4233 (delete-auto-save-file-if-necessary recent-save)
4234 ;; Support VC `implicit' locking.
4236 (run-hooks 'after-save-hook))
4237 (message "(No changes need to be saved)"))))
4239 ;; This does the "real job" of writing a buffer into its visited file
4240 ;; and making a backup file. This is what is normally done
4241 ;; but inhibited if one of write-file-functions returns non-nil.
4242 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4243 (defun basic-save-buffer-1 ()
4245 (if save-buffer-coding-system
4246 (let ((coding-system-for-write save-buffer-coding-system))
4247 (basic-save-buffer-2))
4248 (basic-save-buffer-2))
4249 (if buffer-file-coding-system-explicit
4250 (setcar buffer-file-coding-system-explicit last-coding-system-used)
4251 (setq buffer-file-coding-system-explicit
4252 (cons last-coding-system-used nil)))))
4254 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4255 (defun basic-save-buffer-2 ()
4256 (let (tempsetmodes setmodes)
4257 (if (not (file-writable-p buffer-file-name))
4258 (let ((dir (file-name-directory buffer-file-name)))
4259 (if (not (file-directory-p dir))
4260 (if (file-exists-p dir)
4261 (error "%s is not a directory" dir)
4262 (error "%s: no such directory" dir))
4263 (if (not (file-exists-p buffer-file-name))
4264 (error "Directory %s write-protected" dir)
4266 (format "File %s is write-protected; try to save anyway? "
4267 (file-name-nondirectory
4269 (setq tempsetmodes t)
4270 (error "Attempt to save to a file which you aren't allowed to write"))))))
4271 (or buffer-backed-up
4272 (setq setmodes (backup-buffer)))
4273 (let* ((dir (file-name-directory buffer-file-name))
4274 (dir-writable (file-writable-p dir)))
4275 (if (or (and file-precious-flag dir-writable)
4276 (and break-hardlink-on-save
4277 (> (file-nlinks buffer-file-name) 1)
4279 (error (concat (format
4280 "Directory %s write-protected; " dir)
4281 "cannot break hardlink when saving")))))
4282 ;; Write temp name, then rename it.
4283 ;; This requires write access to the containing dir,
4284 ;; which is why we don't try it if we don't have that access.
4285 (let ((realname buffer-file-name)
4287 (umask (default-file-modes))
4288 (old-modtime (visited-file-modtime)))
4289 ;; Create temp files with strict access rights. It's easy to
4290 ;; loosen them later, whereas it's impossible to close the
4291 ;; time-window of loose permissions otherwise.
4294 (clear-visited-file-modtime)
4295 (set-default-file-modes ?\700)
4296 ;; Try various temporary names.
4297 ;; This code follows the example of make-temp-file,
4298 ;; but it calls write-region in the appropriate way
4299 ;; for saving the buffer.
4300 (while (condition-case ()
4304 (expand-file-name "tmp" dir)))
4305 ;; Pass in nil&nil rather than point-min&max
4306 ;; cause we're saving the whole buffer.
4307 ;; write-region-annotate-functions may use it.
4308 (write-region nil nil
4309 tempname nil realname
4310 buffer-file-truename 'excl)
4312 (file-already-exists t))
4313 ;; The file was somehow created by someone else between
4314 ;; `make-temp-name' and `write-region', let's try again.
4318 (set-default-file-modes umask)
4319 ;; If we failed, restore the buffer's modtime.
4321 (set-visited-file-modtime old-modtime)))
4322 ;; Since we have created an entirely new file,
4323 ;; make sure it gets the right permission bits set.
4324 (setq setmodes (or setmodes
4325 (cons (or (file-modes buffer-file-name)
4326 (logand ?\666 umask))
4328 ;; We succeeded in writing the temp file,
4330 (rename-file tempname buffer-file-name t))
4331 ;; If file not writable, see if we can make it writable
4332 ;; temporarily while we write it.
4333 ;; But no need to do so if we have just backed it up
4334 ;; (setmodes is set) because that says we're superseding.
4335 (cond ((and tempsetmodes (not setmodes))
4336 ;; Change the mode back, after writing.
4337 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4338 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4342 ;; Pass in nil&nil rather than point-min&max to indicate
4343 ;; we're saving the buffer rather than just a region.
4344 ;; write-region-annotate-functions may make us of it.
4345 (write-region nil nil
4346 buffer-file-name nil t buffer-file-truename)
4348 ;; If we get an error writing the new file, and we made
4349 ;; the backup by renaming, undo the backing-up.
4350 (and setmodes (not success)
4352 (rename-file (cdr setmodes) buffer-file-name t)
4353 (setq buffer-backed-up nil)))))))
4356 (defun diff-buffer-with-file (&optional buffer)
4357 "View the differences between BUFFER and its associated file.
4358 This requires the external program `diff' to be in your `exec-path'."
4359 (interactive "bBuffer: ")
4360 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4361 (if (and buffer-file-name
4362 (file-exists-p buffer-file-name))
4363 (let ((tempfile (make-temp-file "buffer-content-")))
4366 (write-region nil nil tempfile nil 'nomessage)
4367 (diff buffer-file-name tempfile nil t)
4369 (when (file-exists-p tempfile)
4370 (delete-file tempfile))))
4371 (message "Buffer %s has no associated file on disc" (buffer-name))
4372 ;; Display that message for 1 second so that user can read it
4373 ;; in the minibuffer.
4375 ;; return always nil, so that save-buffers-kill-emacs will not move
4376 ;; over to the next unsaved buffer when calling `d'.
4379 (defvar save-some-buffers-action-alist
4382 (if (not enable-recursive-minibuffers)
4383 (progn (display-buffer buf)
4384 (setq other-window-scroll-buffer buf))
4385 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4387 ;; Return nil to ask about BUF again.
4391 (if (null (buffer-file-name buf))
4392 (message "Not applicable: no file")
4393 (save-window-excursion (diff-buffer-with-file buf))
4394 (if (not enable-recursive-minibuffers)
4395 (progn (display-buffer (get-buffer-create "*Diff*"))
4396 (setq other-window-scroll-buffer "*Diff*"))
4397 (view-buffer (get-buffer-create "*Diff*")
4398 (lambda (_) (exit-recursive-edit)))
4400 ;; Return nil to ask about BUF again.
4402 "view changes in this buffer"))
4403 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4404 (put 'save-some-buffers-action-alist 'risky-local-variable t)
4406 (defvar buffer-save-without-query nil
4407 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4408 (make-variable-buffer-local 'buffer-save-without-query)
4410 (defun save-some-buffers (&optional arg pred)
4411 "Save some modified file-visiting buffers. Asks user about each one.
4412 You can answer `y' to save, `n' not to save, `C-r' to look at the
4413 buffer in question with `view-buffer' before deciding or `d' to
4414 view the differences using `diff-buffer-with-file'.
4416 Optional argument (the prefix) non-nil means save all with no questions.
4417 Optional second argument PRED determines which buffers are considered:
4418 If PRED is nil, all the file-visiting buffers are considered.
4419 If PRED is t, then certain non-file buffers will also be considered.
4420 If PRED is a zero-argument function, it indicates for each buffer whether
4421 to consider it or not when called with that buffer current.
4423 See `save-some-buffers-action-alist' if you want to
4424 change the additional actions you can take on files."
4426 (save-window-excursion
4427 (let* (queried some-automatic
4428 files-done abbrevs-done)
4429 (dolist (buffer (buffer-list))
4430 ;; First save any buffers that we're supposed to save unconditionally.
4431 ;; That way the following code won't ask about them.
4432 (with-current-buffer buffer
4433 (when (and buffer-save-without-query (buffer-modified-p))
4434 (setq some-automatic t)
4436 ;; Ask about those buffers that merit it,
4437 ;; and record the number thus saved.
4441 ;; Note that killing some buffers may kill others via
4442 ;; hooks (e.g. Rmail and its viewing buffer).
4443 (and (buffer-live-p buffer)
4444 (buffer-modified-p buffer)
4445 (not (buffer-base-buffer buffer))
4447 (buffer-file-name buffer)
4451 (and buffer-offer-save (> (buffer-size) 0)))))
4452 (or (not (functionp pred))
4453 (with-current-buffer buffer (funcall pred)))
4457 (if (buffer-file-name buffer)
4458 (format "Save file %s? "
4459 (buffer-file-name buffer))
4460 (format "Save buffer %s? "
4461 (buffer-name buffer))))))
4463 (with-current-buffer buffer
4466 '("buffer" "buffers" "save")
4467 save-some-buffers-action-alist))
4468 ;; Maybe to save abbrevs, and record whether
4469 ;; we either saved them or asked to.
4470 (and save-abbrevs abbrevs-changed
4473 (eq save-abbrevs 'silently)
4474 (y-or-n-p (format "Save abbrevs in %s? "
4476 (write-abbrev-file nil))
4477 ;; Don't keep bothering user if he says no.
4478 (setq abbrevs-changed nil)
4479 (setq abbrevs-done t)))
4480 (or queried (> files-done 0) abbrevs-done
4481 (message (if some-automatic
4482 "(Some special files were saved without asking)"
4483 "(No files need saving)"))))))
4485 (defun not-modified (&optional arg)
4486 "Mark current buffer as unmodified, not needing to be saved.
4487 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4489 It is not a good idea to use this function in Lisp programs, because it
4490 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4492 (message (if arg "Modification-flag set"
4493 "Modification-flag cleared"))
4494 (set-buffer-modified-p arg))
4496 (defun toggle-read-only (&optional arg)
4497 "Change whether this buffer is read-only.
4498 With prefix argument ARG, make the buffer read-only if ARG is
4499 positive, otherwise make it writable. If buffer is read-only
4500 and `view-read-only' is non-nil, enter view mode."
4503 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4504 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4508 ((and buffer-read-only view-mode)
4509 (View-exit-and-edit)
4510 (make-local-variable 'view-read-only)
4511 (setq view-read-only t)) ; Must leave view mode.
4512 ((and (not buffer-read-only) view-read-only
4513 ;; If view-mode is already active, `view-mode-enter' is a nop.
4515 (not (eq (get major-mode 'mode-class) 'special)))
4517 (t (setq buffer-read-only (not buffer-read-only))
4518 (force-mode-line-update)))
4519 (if (vc-backend buffer-file-name)
4520 (message "%s" (substitute-command-keys
4521 (concat "File is under version-control; "
4522 "use \\[vc-next-action] to check in/out"))))))
4524 (defun insert-file (filename)
4525 "Insert contents of file FILENAME into buffer after point.
4526 Set mark after the inserted text.
4528 This function is meant for the user to run interactively.
4529 Don't call it from programs! Use `insert-file-contents' instead.
4530 \(Its calling sequence is different; see its documentation)."
4531 (interactive "*fInsert file: ")
4532 (insert-file-1 filename #'insert-file-contents))
4534 (defun append-to-file (start end filename)
4535 "Append the contents of the region to the end of file FILENAME.
4536 When called from a function, expects three arguments,
4537 START, END and FILENAME. START and END are normally buffer positions
4538 specifying the part of the buffer to write.
4539 If START is nil, that means to use the entire buffer contents.
4540 If START is a string, then output that string to the file
4541 instead of any buffer contents; END is ignored.
4543 This does character code conversion and applies annotations
4544 like `write-region' does."
4545 (interactive "r\nFAppend to file: ")
4546 (write-region start end filename t))
4548 (defun file-newest-backup (filename)
4549 "Return most recent backup file for FILENAME or nil if no backups exist."
4550 ;; `make-backup-file-name' will get us the right directory for
4551 ;; ordinary or numeric backups. It might create a directory for
4552 ;; backups as a side-effect, according to `backup-directory-alist'.
4553 (let* ((filename (file-name-sans-versions
4554 (make-backup-file-name (expand-file-name filename))))
4555 (file (file-name-nondirectory filename))
4556 (dir (file-name-directory filename))
4557 (comp (file-name-all-completions file dir))
4561 (setq tem (pop comp))
4562 (cond ((and (backup-file-name-p tem)
4563 (string= (file-name-sans-versions tem) file))
4564 (setq tem (concat dir tem))
4565 (if (or (null newest)
4566 (file-newer-than-file-p tem newest))
4567 (setq newest tem)))))
4570 (defun rename-uniquely ()
4571 "Rename current buffer to a similar name not already taken.
4572 This function is useful for creating multiple shell process buffers
4573 or multiple mail buffers, etc."
4576 (let ((base-name (buffer-name)))
4577 (and (string-match "<[0-9]+>\\'" base-name)
4578 (not (and buffer-file-name
4580 (file-name-nondirectory buffer-file-name))))
4581 ;; If the existing buffer name has a <NNN>,
4582 ;; which isn't part of the file name (if any),
4583 ;; then get rid of that.
4584 (setq base-name (substring base-name 0 (match-beginning 0))))
4585 (rename-buffer (generate-new-buffer-name base-name))
4586 (force-mode-line-update))))
4588 (defun make-directory (dir &optional parents)
4589 "Create the directory DIR and any nonexistent parent dirs.
4590 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4592 Interactively, the default choice of directory to create
4593 is the current default directory for file names.
4594 That is useful when you have visited a file in a nonexistent directory.
4596 Noninteractively, the second (optional) argument PARENTS says whether
4597 to create parent directories if they don't exist. Interactively,
4598 this happens by default."
4600 (list (read-file-name "Make directory: " default-directory default-directory
4603 ;; If default-directory is a remote directory,
4604 ;; make sure we find its make-directory handler.
4605 (setq dir (expand-file-name dir))
4606 (let ((handler (find-file-name-handler dir 'make-directory)))
4608 (funcall handler 'make-directory dir parents)
4610 (make-directory-internal dir)
4611 (let ((dir (directory-file-name (expand-file-name dir)))
4613 (while (and (not (file-exists-p dir))
4614 ;; If directory is its own parent, then we can't
4615 ;; keep looping forever
4617 (directory-file-name
4618 (file-name-directory dir)))))
4619 (setq create-list (cons dir create-list)
4620 dir (directory-file-name (file-name-directory dir))))
4622 (make-directory-internal (car create-list))
4623 (setq create-list (cdr create-list))))))))
4625 (put 'revert-buffer-function 'permanent-local t)
4626 (defvar revert-buffer-function nil
4627 "Function to use to revert this buffer, or nil to do the default.
4628 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4629 which are the arguments that `revert-buffer' received.")
4631 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4632 (defvar revert-buffer-insert-file-contents-function nil
4633 "Function to use to insert contents when reverting this buffer.
4634 Gets two args, first the nominal file name to use,
4635 and second, t if reading the auto-save file.
4637 The function you specify is responsible for updating (or preserving) point.")
4639 (defvar buffer-stale-function nil
4640 "Function to check whether a non-file buffer needs reverting.
4641 This should be a function with one optional argument NOCONFIRM.
4642 Auto Revert Mode passes t for NOCONFIRM. The function should return
4643 non-nil if the buffer should be reverted. A return value of
4644 `fast' means that the need for reverting was not checked, but
4645 that reverting the buffer is fast. The buffer is current when
4646 this function is called.
4648 The idea behind the NOCONFIRM argument is that it should be
4649 non-nil if the buffer is going to be reverted without asking the
4650 user. In such situations, one has to be careful with potentially
4651 time consuming operations.
4653 For more information on how this variable is used by Auto Revert mode,
4654 see Info node `(emacs)Supporting additional buffers'.")
4656 (defvar before-revert-hook nil
4657 "Normal hook for `revert-buffer' to run before reverting.
4658 If `revert-buffer-function' is used to override the normal revert
4659 mechanism, this hook is not used.")
4661 (defvar after-revert-hook nil
4662 "Normal hook for `revert-buffer' to run after reverting.
4663 Note that the hook value that it runs is the value that was in effect
4664 before reverting; that makes a difference if you have buffer-local
4667 If `revert-buffer-function' is used to override the normal revert
4668 mechanism, this hook is not used.")
4670 (defvar revert-buffer-internal-hook)
4672 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4673 "Replace current buffer text with the text of the visited file on disk.
4674 This undoes all changes since the file was visited or saved.
4675 With a prefix argument, offer to revert from latest auto-save file, if
4676 that is more recent than the visited file.
4678 This command also implements an interface for special buffers
4679 that contain text which doesn't come from a file, but reflects
4680 some other data instead (e.g. Dired buffers, `buffer-list'
4681 buffers). This is done via the variable `revert-buffer-function'.
4682 In these cases, it should reconstruct the buffer contents from the
4685 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4686 to revert from the auto-save file when this is nil. Note that the
4687 sense of this argument is the reverse of the prefix argument, for the
4688 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4691 Optional second argument NOCONFIRM means don't ask for confirmation
4692 at all. \(The variable `revert-without-query' offers another way to
4693 revert buffers without querying for confirmation.)
4695 Optional third argument PRESERVE-MODES non-nil means don't alter
4696 the files modes. Normally we reinitialize them using `normal-mode'.
4698 If the value of `revert-buffer-function' is non-nil, it is called to
4699 do all the work for this command. Otherwise, the hooks
4700 `before-revert-hook' and `after-revert-hook' are run at the beginning
4701 and the end, and if `revert-buffer-insert-file-contents-function' is
4702 non-nil, it is called instead of rereading visited file contents."
4704 ;; I admit it's odd to reverse the sense of the prefix argument, but
4705 ;; there is a lot of code out there which assumes that the first
4706 ;; argument should be t to avoid consulting the auto-save file, and
4707 ;; there's no straightforward way to encourage authors to notice a
4708 ;; reversal of the argument sense. So I'm just changing the user
4709 ;; interface, but leaving the programmatic interface the same.
4710 (interactive (list (not current-prefix-arg)))
4711 (if revert-buffer-function
4712 (funcall revert-buffer-function ignore-auto noconfirm)
4713 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4715 (let* ((auto-save-p (and (not ignore-auto)
4716 (recent-auto-save-p)
4717 buffer-auto-save-file-name
4718 (file-readable-p buffer-auto-save-file-name)
4720 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4721 (file-name (if auto-save-p
4722 buffer-auto-save-file-name
4724 (cond ((null file-name)
4725 (error "Buffer does not seem to be associated with any file"))
4727 (and (not (buffer-modified-p))
4729 (dolist (regexp revert-without-query)
4730 (when (string-match regexp file-name)
4731 (throw 'found t)))))
4732 (yes-or-no-p (format "Revert buffer from file %s? "
4734 (run-hooks 'before-revert-hook)
4735 ;; If file was backed up but has changed since,
4736 ;; we shd make another backup.
4737 (and (not auto-save-p)
4738 (not (verify-visited-file-modtime (current-buffer)))
4739 (setq buffer-backed-up nil))
4740 ;; Effectively copy the after-revert-hook status,
4741 ;; since after-find-file will clobber it.
4742 (let ((global-hook (default-value 'after-revert-hook))
4743 (local-hook (when (local-variable-p 'after-revert-hook)
4745 (inhibit-read-only t))
4747 (revert-buffer-insert-file-contents-function
4748 (unless (eq buffer-undo-list t)
4749 ;; Get rid of all undo records for this buffer.
4750 (setq buffer-undo-list nil))
4751 ;; Don't make undo records for the reversion.
4752 (let ((buffer-undo-list t))
4753 (funcall revert-buffer-insert-file-contents-function
4754 file-name auto-save-p)))
4755 ((not (file-exists-p file-name))
4756 (error (if buffer-file-number
4757 "File %s no longer exists!"
4758 "Cannot revert nonexistent file %s")
4760 ((not (file-readable-p file-name))
4761 (error (if buffer-file-number
4762 "File %s no longer readable!"
4763 "Cannot revert unreadable file %s")
4766 ;; Bind buffer-file-name to nil
4767 ;; so that we don't try to lock the file.
4768 (let ((buffer-file-name nil))
4772 (let ((coding-system-for-read
4773 ;; Auto-saved file should be read by Emacs'
4775 (if auto-save-p 'auto-save-coding
4776 (or coding-system-for-read
4778 buffer-file-coding-system-explicit
4779 (car buffer-file-coding-system-explicit))))))
4780 (if (and (not enable-multibyte-characters)
4781 coding-system-for-read
4782 (not (memq (coding-system-base
4783 coding-system-for-read)
4784 '(no-conversion raw-text))))
4785 ;; As a coding system suitable for multibyte
4786 ;; buffer is specified, make the current
4787 ;; buffer multibyte.
4788 (set-buffer-multibyte t))
4790 ;; This force after-insert-file-set-coding
4791 ;; (called from insert-file-contents) to set
4792 ;; buffer-file-coding-system to a proper value.
4793 (kill-local-variable 'buffer-file-coding-system)
4795 ;; Note that this preserves point in an intelligent way.
4797 (let ((buffer-file-format buffer-file-format))
4798 (insert-file-contents file-name (not auto-save-p)
4800 (insert-file-contents file-name (not auto-save-p)
4802 ;; Recompute the truename in case changes in symlinks
4803 ;; have changed the truename.
4804 (setq buffer-file-truename
4805 (abbreviate-file-name (file-truename buffer-file-name)))
4806 (after-find-file nil nil t t preserve-modes)
4807 ;; Run after-revert-hook as it was before we reverted.
4808 (setq-default revert-buffer-internal-hook global-hook)
4810 (set (make-local-variable 'revert-buffer-internal-hook)
4812 (kill-local-variable 'revert-buffer-internal-hook))
4813 (run-hooks 'revert-buffer-internal-hook))
4816 (defun recover-this-file ()
4817 "Recover the visited file--get contents from its last auto-save file."
4819 (recover-file buffer-file-name))
4821 (defun recover-file (file)
4822 "Visit file FILE, but get contents from its last auto-save file."
4823 ;; Actually putting the file name in the minibuffer should be used
4825 ;; Not just because users often use the default.
4826 (interactive "FRecover file: ")
4827 (setq file (expand-file-name file))
4828 (if (auto-save-file-name-p (file-name-nondirectory file))
4829 (error "%s is an auto-save file" (abbreviate-file-name file)))
4830 (let ((file-name (let ((buffer-file-name file))
4831 (make-auto-save-file-name))))
4832 (cond ((if (file-exists-p file)
4833 (not (file-newer-than-file-p file-name file))
4834 (not (file-exists-p file-name)))
4835 (error "Auto-save file %s not current"
4836 (abbreviate-file-name file-name)))
4837 ((save-window-excursion
4838 (with-output-to-temp-buffer "*Directory*"
4839 (buffer-disable-undo standard-output)
4841 (let ((switches dired-listing-switches))
4842 (if (file-symlink-p file)
4843 (setq switches (concat switches "L")))
4844 (set-buffer standard-output)
4845 ;; Use insert-directory-safely, not insert-directory,
4846 ;; because these files might not exist. In particular,
4847 ;; FILE might not exist if the auto-save file was for
4848 ;; a buffer that didn't visit a file, such as "*mail*".
4849 ;; The code in v20.x called `ls' directly, so we need
4850 ;; to emulate what `ls' did in that case.
4851 (insert-directory-safely file switches)
4852 (insert-directory-safely file-name switches))))
4853 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4854 (switch-to-buffer (find-file-noselect file t))
4855 (let ((inhibit-read-only t)
4856 ;; Keep the current buffer-file-coding-system.
4857 (coding-system buffer-file-coding-system)
4858 ;; Auto-saved file should be read with special coding.
4859 (coding-system-for-read 'auto-save-coding))
4861 (insert-file-contents file-name nil)
4862 (set-buffer-file-coding-system coding-system))
4863 (after-find-file nil nil t))
4864 (t (error "Recover-file cancelled")))))
4866 (defun recover-session ()
4867 "Recover auto save files from a previous Emacs session.
4868 This command first displays a Dired buffer showing you the
4869 previous sessions that you could recover from.
4870 To choose one, move point to the proper line and then type C-c C-c.
4871 Then you'll be asked about a number of files to recover."
4873 (if (null auto-save-list-file-prefix)
4874 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4875 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4876 (unless (file-directory-p dir)
4877 (make-directory dir t))
4878 (unless (directory-files dir nil
4879 (concat "\\`" (regexp-quote
4880 (file-name-nondirectory
4881 auto-save-list-file-prefix)))
4883 (error "No previous sessions to recover")))
4884 (let ((ls-lisp-support-shell-wildcards t))
4885 (dired (concat auto-save-list-file-prefix "*")
4886 (concat dired-listing-switches "t")))
4888 (goto-char (point-min))
4889 (or (looking-at " Move to the session you want to recover,")
4890 (let ((inhibit-read-only t))
4891 ;; Each line starts with a space
4892 ;; so that Font Lock mode won't highlight the first character.
4893 (insert " Move to the session you want to recover,\n"
4894 " then type C-c C-c to select it.\n\n"
4895 " You can also delete some of these files;\n"
4896 " type d on a line to mark that file for deletion.\n\n"))))
4897 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4898 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4900 (defun recover-session-finish ()
4901 "Choose one saved session to recover auto-save files from.
4902 This command is used in the special Dired buffer created by
4903 \\[recover-session]."
4905 ;; Get the name of the session file to recover from.
4906 (let ((file (dired-get-filename))
4908 (buffer (get-buffer-create " *recover*")))
4910 (dired-do-flagged-delete t)
4913 ;; Read in the auto-save-list file.
4916 (insert-file-contents file)
4917 ;; Loop thru the text of that file
4918 ;; and get out the names of the files to recover.
4920 (let (thisfile autofile)
4922 ;; This is a pair of lines for a non-file-visiting buffer.
4923 ;; Get the auto-save file name and manufacture
4924 ;; a "visited file name" from that.
4927 ;; If there is no auto-save file name, the
4928 ;; auto-save-list file is probably corrupted.
4931 (buffer-substring-no-properties
4933 (line-end-position)))
4937 (file-name-nondirectory autofile)
4939 (file-name-directory autofile))))
4941 ;; This pair of lines is a file-visiting
4942 ;; buffer. Use the visited file name.
4945 (buffer-substring-no-properties
4946 (point) (progn (end-of-line) (point))))
4949 (buffer-substring-no-properties
4950 (point) (progn (end-of-line) (point))))
4952 ;; Ignore a file if its auto-save file does not exist now.
4953 (if (and autofile (file-exists-p autofile))
4954 (setq files (cons thisfile files)))))
4955 (setq files (nreverse files))
4956 ;; The file contains a pair of line for each auto-saved buffer.
4957 ;; The first line of the pair contains the visited file name
4958 ;; or is empty if the buffer was not visiting a file.
4959 ;; The second line is the auto-save file name.
4961 (map-y-or-n-p "Recover %s? "
4964 (save-excursion (recover-file file))
4966 "Failed to recover `%s'" file)))
4968 '("file" "files" "recover"))
4969 (message "No files can be recovered from this session now")))
4970 (kill-buffer buffer))))
4972 (defun kill-buffer-ask (buffer)
4973 "Kill BUFFER if confirmed."
4975 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4976 (if (buffer-modified-p buffer)
4977 "HAS BEEN EDITED" "is unmodified")))
4978 (kill-buffer buffer)))
4980 (defun kill-some-buffers (&optional list)
4981 "Kill some buffers. Asks the user whether to kill each one of them.
4982 Non-interactively, if optional argument LIST is non-nil, it
4983 specifies the list of buffers to kill, asking for approval for each one."
4986 (setq list (buffer-list)))
4988 (let* ((buffer (car list))
4989 (name (buffer-name buffer)))
4990 (and name ; Can be nil for an indirect buffer
4991 ; if we killed the base buffer.
4992 (not (string-equal name ""))
4993 (/= (aref name 0) ?\s)
4994 (kill-buffer-ask buffer)))
4995 (setq list (cdr list))))
4997 (defun kill-matching-buffers (regexp &optional internal-too)
4998 "Kill buffers whose name matches the specified REGEXP.
4999 The optional second argument indicates whether to kill internal buffers too."
5000 (interactive "sKill buffers matching this regular expression: \nP")
5001 (dolist (buffer (buffer-list))
5002 (let ((name (buffer-name buffer)))
5003 (when (and name (not (string-equal name ""))
5004 (or internal-too (/= (aref name 0) ?\s))
5005 (string-match regexp name))
5006 (kill-buffer-ask buffer)))))
5009 (defun auto-save-mode (arg)
5010 "Toggle auto-saving of contents of current buffer.
5011 With prefix argument ARG, turn auto-saving on if positive, else off."
5013 (setq buffer-auto-save-file-name
5015 (or (not buffer-auto-save-file-name)
5016 ;; If auto-save is off because buffer has shrunk,
5017 ;; then toggling should turn it on.
5018 (< buffer-saved-size 0))
5019 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
5020 (if (and buffer-file-name auto-save-visited-file-name
5021 (not buffer-read-only))
5023 (make-auto-save-file-name))))
5024 ;; If -1 was stored here, to temporarily turn off saving,
5026 (and (< buffer-saved-size 0)
5027 (setq buffer-saved-size 0))
5029 (message "Auto-save %s (in this buffer)"
5030 (if buffer-auto-save-file-name "on" "off")))
5031 buffer-auto-save-file-name)
5033 (defun rename-auto-save-file ()
5034 "Adjust current buffer's auto save file name for current conditions.
5035 Also rename any existing auto save file, if it was made in this session."
5036 (let ((osave buffer-auto-save-file-name))
5037 (setq buffer-auto-save-file-name
5038 (make-auto-save-file-name))
5039 (if (and osave buffer-auto-save-file-name
5040 (not (string= buffer-auto-save-file-name buffer-file-name))
5041 (not (string= buffer-auto-save-file-name osave))
5042 (file-exists-p osave)
5043 (recent-auto-save-p))
5044 (rename-file osave buffer-auto-save-file-name t))))
5046 (defun make-auto-save-file-name ()
5047 "Return file name to use for auto-saves of current buffer.
5048 Does not consider `auto-save-visited-file-name' as that variable is checked
5049 before calling this function. You can redefine this for customization.
5050 See also `auto-save-file-name-p'."
5051 (if buffer-file-name
5052 (let ((handler (find-file-name-handler buffer-file-name
5053 'make-auto-save-file-name)))
5055 (funcall handler 'make-auto-save-file-name)
5056 (let ((list auto-save-file-name-transforms)
5057 (filename buffer-file-name)
5059 ;; Apply user-specified translations
5060 ;; to the file name.
5061 (while (and list (not result))
5062 (if (string-match (car (car list)) filename)
5063 (setq result (replace-match (cadr (car list)) t nil
5065 uniq (car (cddr (car list)))))
5066 (setq list (cdr list)))
5069 (setq filename (concat
5070 (file-name-directory result)
5071 (subst-char-in-string
5073 (replace-regexp-in-string "!" "!!"
5075 (setq filename result)))
5077 (if (and (eq system-type 'ms-dos)
5078 (not (msdos-long-file-names)))
5079 ;; We truncate the file name to DOS 8+3 limits
5080 ;; before doing anything else, because the regexp
5081 ;; passed to string-match below cannot handle
5082 ;; extensions longer than 3 characters, multiple
5083 ;; dots, and other atrocities.
5084 (let ((fn (dos-8+3-filename
5085 (file-name-nondirectory buffer-file-name))))
5087 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5089 (concat (file-name-directory buffer-file-name)
5090 "#" (match-string 1 fn)
5091 "." (match-string 3 fn) "#"))
5092 (concat (file-name-directory filename)
5094 (file-name-nondirectory filename)
5096 ;; Make sure auto-save file names don't contain characters
5097 ;; invalid for the underlying filesystem.
5098 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5099 ;; Don't modify remote (ange-ftp) filenames
5100 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5101 (convert-standard-filename result)
5104 ;; Deal with buffers that don't have any associated files. (Mail
5105 ;; mode tends to create a good number of these.)
5107 (let ((buffer-name (buffer-name))
5110 ;; Restrict the characters used in the file name to those which
5111 ;; are known to be safe on all filesystems, url-encoding the
5113 ;; We do this on all platforms, because even if we are not
5114 ;; running on DOS/Windows, the current directory may be on a
5115 ;; mounted VFAT filesystem, such as a USB memory stick.
5116 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5117 (let* ((character (aref buffer-name (match-beginning 0)))
5119 ;; For multibyte characters, this will produce more than
5120 ;; 2 hex digits, so is not true URL encoding.
5121 (format "%%%02X" character)))
5122 (setq buffer-name (replace-match replacement t t buffer-name))
5123 (setq limit (1+ (match-end 0)))))
5124 ;; Generate the file name.
5129 (format "#%s#" buffer-name)
5130 ;; Try a few alternative directories, to get one we can
5133 ((file-writable-p default-directory) default-directory)
5134 ((file-writable-p "/var/tmp/") "/var/tmp/")
5136 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5137 ;; Don't modify remote (ange-ftp) filenames
5138 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5139 ;; The call to convert-standard-filename is in case
5140 ;; buffer-name includes characters not allowed by the
5141 ;; DOS/Windows filesystems. make-temp-file writes to the
5142 ;; file it creates, so we must fix the file name _before_
5143 ;; make-temp-file is called.
5144 (convert-standard-filename fname)
5147 ;; make-temp-file creates the file,
5148 ;; but we don't want it to exist until we do an auto-save.
5150 (delete-file file-name)
5154 (defun auto-save-file-name-p (filename)
5155 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5156 FILENAME should lack slashes. You can redefine this for customization."
5157 (string-match "^#.*#$" filename))
5159 (defun wildcard-to-regexp (wildcard)
5160 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5161 The generated regexp will match a filename only if the filename
5162 matches that wildcard according to shell rules. Only wildcards known
5163 by `sh' are supported."
5164 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5165 ;; Copy the initial run of non-special characters.
5166 (result (substring wildcard 0 i))
5167 (len (length wildcard)))
5168 ;; If no special characters, we're almost done.
5171 (let ((ch (aref wildcard i))
5179 (eq (aref wildcard (1+ i)) ?\]))
5181 ((eq ch ?\[) ; [...] maps to regexp char class
5186 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5189 (if (eq (aref wildcard i) ?\])
5194 ((eq (aref wildcard i) ?^)
5195 ;; Found "[^". Insert a `\0' character
5196 ;; (which cannot happen in a filename)
5197 ;; into the character class, so that `^'
5198 ;; is not the first character after `[',
5199 ;; and thus non-special in a regexp.
5203 ((eq (aref wildcard i) ?\])
5204 ;; I don't think `]' can appear in a
5205 ;; character class in a wildcard, but
5206 ;; let's be general here.
5211 (prog1 ; copy everything upto next `]'.
5214 (setq j (string-match
5216 (setq i (if j (1- j) (1- len)))))))
5218 ((eq ch ?*) "[^\000]*")
5222 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5223 ((eq ch ??) "[^\000]")
5224 (t (char-to-string ch)))))
5226 ;; Shell wildcards should match the entire filename,
5227 ;; not its part. Make the regexp say so.
5228 (concat "\\`" result "\\'")))
5230 (defcustom list-directory-brief-switches
5232 "Switches for `list-directory' to pass to `ls' for brief listing."
5236 (defcustom list-directory-verbose-switches
5238 "Switches for `list-directory' to pass to `ls' for verbose listing."
5242 (defun file-expand-wildcards (pattern &optional full)
5243 "Expand wildcard pattern PATTERN.
5244 This returns a list of file names which match the pattern.
5246 If PATTERN is written as an absolute file name,
5247 the values are absolute also.
5249 If PATTERN is written as a relative file name, it is interpreted
5250 relative to the current default directory, `default-directory'.
5251 The file names returned are normally also relative to the current
5252 default directory. However, if FULL is non-nil, they are absolute."
5254 (let* ((nondir (file-name-nondirectory pattern))
5255 (dirpart (file-name-directory pattern))
5256 ;; A list of all dirs that DIRPART specifies.
5257 ;; This can be more than one dir
5258 ;; if DIRPART contains wildcards.
5259 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5260 (mapcar 'file-name-as-directory
5261 (file-expand-wildcards (directory-file-name dirpart)))
5265 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5266 (file-directory-p (directory-file-name (car dirs))))
5267 (let ((this-dir-contents
5268 ;; Filter out "." and ".."
5270 (mapcar #'(lambda (name)
5271 (unless (string-match "\\`\\.\\.?\\'"
5272 (file-name-nondirectory name))
5274 (directory-files (or (car dirs) ".") full
5275 (wildcard-to-regexp nondir))))))
5278 (if (and (car dirs) (not full))
5279 (mapcar (function (lambda (name) (concat (car dirs) name)))
5283 (setq dirs (cdr dirs)))
5286 (defun list-directory (dirname &optional verbose)
5287 "Display a list of files in or matching DIRNAME, a la `ls'.
5288 DIRNAME is globbed by the shell if necessary.
5289 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5290 Actions controlled by variables `list-directory-brief-switches'
5291 and `list-directory-verbose-switches'."
5292 (interactive (let ((pfx current-prefix-arg))
5293 (list (read-file-name (if pfx "List directory (verbose): "
5294 "List directory (brief): ")
5295 nil default-directory nil)
5297 (let ((switches (if verbose list-directory-verbose-switches
5298 list-directory-brief-switches))
5300 (or dirname (setq dirname default-directory))
5301 (setq dirname (expand-file-name dirname))
5302 (with-output-to-temp-buffer "*Directory*"
5303 (setq buffer standard-output)
5304 (buffer-disable-undo standard-output)
5305 (princ "Directory ")
5309 (set-buffer "*Directory*")
5310 (let ((wildcard (not (file-directory-p dirname))))
5311 (insert-directory dirname switches wildcard (not wildcard)))))
5312 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5313 (with-current-buffer buffer
5314 (setq default-directory
5315 (if (file-directory-p dirname)
5316 (file-name-as-directory dirname)
5317 (file-name-directory dirname))))))
5319 (defun shell-quote-wildcard-pattern (pattern)
5320 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5322 PATTERN is assumed to represent a file-name wildcard suitable for the
5323 underlying filesystem. For Unix and GNU/Linux, each character from the
5324 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5325 the parts of the pattern which don't include wildcard characters are
5326 quoted with double quotes.
5328 This function leaves alone existing quote characters (\\ on Unix and \"
5329 on Windows), so PATTERN can use them to quote wildcard characters that
5330 need to be passed verbatim to shell commands."
5333 ((memq system-type '(ms-dos windows-nt cygwin))
5334 ;; DOS/Windows don't allow `"' in file names. So if the
5335 ;; argument has quotes, we can safely assume it is already
5336 ;; quoted by the caller.
5337 (if (or (string-match "[\"]" pattern)
5338 ;; We quote [&()#$'] in case their shell is a port of a
5339 ;; Unixy shell. We quote [,=+] because stock DOS and
5340 ;; Windows shells require that in some cases, such as
5341 ;; passing arguments to batch files that use positional
5342 ;; arguments like %1.
5343 (not (string-match "[ \t;&()#$',=+]" pattern)))
5348 (while (string-match "[*?]+" pattern beg)
5349 (setq end (match-beginning 0)
5350 result (concat result (substring pattern beg end)
5352 (substring pattern end (match-end 0))
5355 (concat result (substring pattern beg) "\""))))
5358 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5360 (concat (substring pattern 0 (match-beginning 0))
5362 (substring pattern (match-beginning 0)))
5363 beg (1+ (match-end 0)))))
5367 (defvar insert-directory-program "ls"
5368 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5370 (defcustom directory-free-space-program "df"
5371 "Program to get the amount of free space on a file system.
5372 We assume the output has the format of `df'.
5373 The value of this variable must be just a command name or file name;
5374 if you want to specify options, use `directory-free-space-args'.
5376 A value of nil disables this feature.
5378 If the function `file-system-info' is defined, it is always used in
5379 preference to the program given by this variable."
5380 :type '(choice (string :tag "Program") (const :tag "None" nil))
5383 (defcustom directory-free-space-args
5384 (if (eq system-type 'darwin) "-k" "-Pk")
5385 "Options to use when running `directory-free-space-program'."
5389 (defun get-free-disk-space (dir)
5390 "Return the amount of free space on directory DIR's file system.
5391 The result is a string that gives the number of free 1KB blocks,
5392 or nil if the system call or the program which retrieve the information
5393 fail. It returns also nil when DIR is a remote directory.
5395 This function calls `file-system-info' if it is available, or invokes the
5396 program specified by `directory-free-space-program' if that is non-nil."
5397 (unless (file-remote-p dir)
5398 ;; Try to find the number of free blocks. Non-Posix systems don't
5399 ;; always have df, but might have an equivalent system call.
5400 (if (fboundp 'file-system-info)
5401 (let ((fsinfo (file-system-info dir)))
5403 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5404 (setq dir (expand-file-name dir))
5407 (when (and directory-free-space-program
5408 ;; Avoid failure if the default directory does
5409 ;; not exist (Bug#2631, Bug#3911).
5410 (let ((default-directory "/"))
5411 (eq (call-process directory-free-space-program
5413 directory-free-space-args
5416 ;; Usual format is a header line followed by a line of
5418 (goto-char (point-min))
5422 ;; Move to the end of the "available blocks" number.
5423 (skip-chars-forward "^ \t")
5425 ;; Copy it into AVAILABLE.
5426 (let ((end (point)))
5428 (buffer-substring (point) end))))))))))
5430 ;; The following expression replaces `dired-move-to-filename-regexp'.
5431 (defvar directory-listing-before-filename-regexp
5432 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5433 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5434 ;; In some locales, month abbreviations are as short as 2 letters,
5435 ;; and they can be followed by ".".
5436 ;; In Breton, a month name can include a quote character.
5437 (month (concat l-or-quote l-or-quote "+\\.?"))
5439 (yyyy "[0-9][0-9][0-9][0-9]")
5441 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5442 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5443 (zone "[-+][0-2][0-9][0-5][0-9]")
5444 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5445 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5446 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5447 "\\|" yyyy "-" iso-mm-dd "\\)"))
5448 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5450 "\\(" HH:MM "\\|" yyyy "\\)"))
5451 (western-comma (concat month s "+" dd "," s "+" yyyy))
5452 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5453 ;; omits the Kanji characters after month and day-of-month.
5454 ;; On Mac OS X 10.3, the date format in East Asian locales is
5455 ;; day-of-month digits followed by month digits.
5458 (concat "\\(" mm l "?" s dd l "?" s "+"
5459 "\\|" dd s mm s "+" "\\)"
5460 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5461 ;; The "[0-9]" below requires the previous column to end in a digit.
5462 ;; This avoids recognizing `1 may 1997' as a date in the line:
5463 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5465 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5466 ;; The ".*" below finds the last match if there are multiple matches.
5467 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5468 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5470 ;; vc dired listings provide the state or blanks between file
5471 ;; permissions and date. The state is always surrounded by
5473 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5474 ;; This is not supported yet.
5475 (concat ".*[0-9][BkKMGTPEZY]?" s
5476 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5478 "Regular expression to match up to the file name in a directory listing.
5479 The default value is designed to recognize dates and times
5480 regardless of the language.")
5482 (defvar insert-directory-ls-version 'unknown)
5485 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5486 ;; FULL-DIRECTORY-P is nil.
5487 ;; The single line of output must display FILE's name as it was
5488 ;; given, namely, an absolute path name.
5489 ;; - must insert exactly one line for each file if WILDCARD or
5490 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5491 ;; before the file lines, plus optional text after the file lines.
5492 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5494 ;; File lines should display the basename.
5495 ;; - must be consistent with
5496 ;; - functions dired-move-to-filename, (these two define what a file line is)
5497 ;; dired-move-to-end-of-filename,
5498 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5499 ;; dired-insert-headerline
5500 ;; dired-after-subdir-garbage (defines what a "total" line is)
5501 ;; - variable dired-subdir-regexp
5502 ;; - may be passed "--dired" as the first argument in SWITCHES.
5503 ;; Filename handlers might have to remove this switch if their
5504 ;; "ls" command does not support it.
5505 (defun insert-directory (file switches &optional wildcard full-directory-p)
5506 "Insert directory listing for FILE, formatted according to SWITCHES.
5507 Leaves point after the inserted text.
5508 SWITCHES may be a string of options, or a list of strings
5509 representing individual options.
5510 Optional third arg WILDCARD means treat FILE as shell wildcard.
5511 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5512 switches do not contain `d', so that a full listing is expected.
5514 This works by running a directory listing program
5515 whose name is in the variable `insert-directory-program'.
5516 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5518 When SWITCHES contains the long `--dired' option, this function
5519 treats it specially, for the sake of dired. However, the
5520 normally equivalent short `-D' option is just passed on to
5521 `insert-directory-program', as any other option."
5522 ;; We need the directory in order to find the right handler.
5523 (let ((handler (find-file-name-handler (expand-file-name file)
5524 'insert-directory)))
5526 (funcall handler 'insert-directory file switches
5527 wildcard full-directory-p)
5528 (let (result (beg (point)))
5530 ;; Read the actual directory using `insert-directory-program'.
5531 ;; RESULT gets the status code.
5532 (let* (;; We at first read by no-conversion, then after
5533 ;; putting text property `dired-filename, decode one
5534 ;; bunch by one to preserve that property.
5535 (coding-system-for-read 'no-conversion)
5536 ;; This is to control encoding the arguments in call-process.
5537 (coding-system-for-write
5538 (and enable-multibyte-characters
5539 (or file-name-coding-system
5540 default-file-name-coding-system))))
5543 ;; Run ls in the directory part of the file pattern
5544 ;; using the last component as argument.
5545 (let ((default-directory
5546 (if (file-name-absolute-p file)
5547 (file-name-directory file)
5548 (file-name-directory (expand-file-name file))))
5549 (pattern (file-name-nondirectory file)))
5551 shell-file-name nil t nil
5553 (concat (if (memq system-type '(ms-dos windows-nt))
5555 "\\") ; Disregard Unix shell aliases!
5556 insert-directory-program
5558 (if (stringp switches)
5560 (mapconcat 'identity switches " "))
5562 ;; Quote some characters that have
5563 ;; special meanings in shells; but
5564 ;; don't quote the wildcards--we want
5565 ;; them to be special. We also
5566 ;; currently don't quote the quoting
5567 ;; characters in case people want to
5568 ;; use them explicitly to quote
5569 ;; wildcard characters.
5570 (shell-quote-wildcard-pattern pattern))))
5571 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5572 ;; directory if FILE is a symbolic link.
5573 (apply 'call-process
5574 insert-directory-program nil t nil
5576 (if (listp switches) switches
5577 (unless (equal switches "")
5578 ;; Split the switches at any spaces so we can
5579 ;; pass separate options as separate args.
5580 (split-string switches)))
5581 ;; Avoid lossage if FILE starts with `-'.
5584 (if (string-match "\\`~" file)
5585 (setq file (expand-file-name file)))
5587 (if full-directory-p
5588 (concat (file-name-as-directory file) ".")
5591 ;; If we got "//DIRED//" in the output, it means we got a real
5592 ;; directory listing, even if `ls' returned nonzero.
5593 ;; So ignore any errors.
5594 (when (if (stringp switches)
5595 (string-match "--dired\\>" switches)
5596 (member "--dired" switches))
5599 (when (looking-at "//SUBDIRED//")
5601 (if (looking-at "//DIRED//")
5604 (when (and (not (eq 0 result))
5605 (eq insert-directory-ls-version 'unknown))
5606 ;; The first time ls returns an error,
5607 ;; find the version numbers of ls,
5608 ;; and set insert-directory-ls-version
5609 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5610 ;; is equal or if the info cannot be obtained.
5611 ;; (That can mean it isn't GNU ls.)
5614 (call-process "ls" nil t nil "--version")
5616 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5617 (let* ((version (match-string 1 version-out))
5618 (split (split-string version "[.]"))
5619 (numbers (mapcar 'string-to-number split))
5622 (while (and (not comparison) (or numbers min))
5624 (setq comparison '>))
5626 (setq comparison '<))
5627 ((> (car numbers) (car min))
5628 (setq comparison '>))
5629 ((< (car numbers) (car min))
5630 (setq comparison '<))
5632 (setq numbers (cdr numbers)
5634 (setq insert-directory-ls-version (or comparison '=)))
5635 (setq insert-directory-ls-version nil))))
5637 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5638 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5641 ;; If `insert-directory-program' failed, signal an error.
5642 (unless (eq 0 result)
5643 ;; Delete the error message it may have output.
5644 (delete-region beg (point))
5645 ;; On non-Posix systems, we cannot open a directory, so
5646 ;; don't even try, because that will always result in
5647 ;; the ubiquitous "Access denied". Instead, show the
5648 ;; command line so the user can try to guess what went wrong.
5649 (if (and (file-directory-p file)
5650 (memq system-type '(ms-dos windows-nt)))
5652 "Reading directory: \"%s %s -- %s\" exited with status %s"
5653 insert-directory-program
5654 (if (listp switches) (concat switches) switches)
5656 ;; Unix. Access the file to get a suitable error.
5657 (access-file file "Reading directory")
5658 (error "Listing directory failed but `access-file' worked")))
5660 (when (if (stringp switches)
5661 (string-match "--dired\\>" switches)
5662 (member "--dired" switches))
5663 ;; The following overshoots by one line for an empty
5664 ;; directory listed with "--dired", but without "-a"
5665 ;; switch, where the ls output contains a
5666 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5667 ;; We take care of that case later.
5669 (when (looking-at "//SUBDIRED//")
5670 (delete-region (point) (progn (forward-line 1) (point)))
5672 (if (looking-at "//DIRED//")
5673 (let ((end (line-end-position))
5676 ;; Find all the lines that are error messages,
5677 ;; and record the bounds of each one.
5679 (while (< (point) linebeg)
5680 (or (eql (following-char) ?\s)
5681 (push (list (point) (line-end-position)) error-lines))
5683 (setq error-lines (nreverse error-lines))
5684 ;; Now read the numeric positions of file names.
5688 (while (< (point) end)
5689 (let ((start (insert-directory-adj-pos
5690 (+ beg (read (current-buffer)))
5692 (end (insert-directory-adj-pos
5693 (+ beg (read (current-buffer)))
5695 (if (memq (char-after end) '(?\n ?\s))
5696 ;; End is followed by \n or by " -> ".
5697 (put-text-property start end 'dired-filename t)
5698 ;; It seems that we can't trust ls's output as to
5699 ;; byte positions of filenames.
5700 (put-text-property beg (point) 'dired-filename nil)
5704 (delete-region (point) (progn (forward-line 1) (point))))
5705 ;; Take care of the case where the ls output contains a
5706 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5707 ;; and we went one line too far back (see above).
5709 (if (looking-at "//DIRED-OPTIONS//")
5710 (delete-region (point) (progn (forward-line 1) (point)))))
5712 ;; Now decode what read if necessary.
5713 (let ((coding (or coding-system-for-read
5714 file-name-coding-system
5715 default-file-name-coding-system
5719 (when (and enable-multibyte-characters
5720 (not (memq (coding-system-base coding)
5721 '(raw-text no-conversion))))
5722 ;; If no coding system is specified or detection is
5723 ;; requested, detect the coding.
5724 (if (eq (coding-system-base coding) 'undecided)
5725 (setq coding (detect-coding-region beg (point) t)))
5726 (if (not (eq (coding-system-base coding) 'undecided))
5729 (coding-system-change-eol-conversion coding 'unix))
5730 (narrow-to-region beg (point))
5731 (goto-char (point-min))
5734 val (get-text-property (point) 'dired-filename))
5735 (goto-char (next-single-property-change
5736 (point) 'dired-filename nil (point-max)))
5737 ;; Force no eol conversion on a file name, so
5738 ;; that CR is preserved.
5739 (decode-coding-region pos (point)
5740 (if val coding-no-eol coding))
5742 (put-text-property pos (point)
5743 'dired-filename t)))))))
5745 (if full-directory-p
5746 ;; Try to insert the amount of free space.
5749 ;; First find the line to put it on.
5750 (when (re-search-forward "^ *\\(total\\)" nil t)
5751 (let ((available (get-free-disk-space ".")))
5753 ;; Replace "total" with "used", to avoid confusion.
5754 (replace-match "total used in directory" nil nil nil 1)
5756 (insert " available " available))))))))))
5758 (defun insert-directory-adj-pos (pos error-lines)
5759 "Convert `ls --dired' file name position value POS to a buffer position.
5760 File name position values returned in ls --dired output
5761 count only stdout; they don't count the error messages sent to stderr.
5762 So this function converts to them to real buffer positions.
5763 ERROR-LINES is a list of buffer positions of error message lines,
5764 of the form (START END)."
5765 (while (and error-lines (< (caar error-lines) pos))
5766 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5770 (defun insert-directory-safely (file switches
5771 &optional wildcard full-directory-p)
5772 "Insert directory listing for FILE, formatted according to SWITCHES.
5774 Like `insert-directory', but if FILE does not exist, it inserts a
5775 message to that effect instead of signaling an error."
5776 (if (file-exists-p file)
5777 (insert-directory file switches wildcard full-directory-p)
5778 ;; Simulate the message printed by `ls'.
5779 (insert (format "%s: No such file or directory\n" file))))
5781 (defvar kill-emacs-query-functions nil
5782 "Functions to call with no arguments to query about killing Emacs.
5783 If any of these functions returns nil, killing Emacs is cancelled.
5784 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5785 the low level primitive, does not. See also `kill-emacs-hook'.")
5787 (defcustom confirm-kill-emacs nil
5788 "How to ask for confirmation when leaving Emacs.
5789 If nil, the default, don't ask at all. If the value is non-nil, it should
5790 be a predicate function such as `yes-or-no-p'."
5791 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5792 (const :tag "Ask with y-or-n-p" y-or-n-p)
5793 (const :tag "Don't confirm" nil))
5797 (defun save-buffers-kill-emacs (&optional arg)
5798 "Offer to save each buffer, then kill this Emacs process.
5799 With prefix ARG, silently save all file-visiting buffers, then kill."
5801 (save-some-buffers arg t)
5802 (and (or (not (memq t (mapcar (function
5803 (lambda (buf) (and (buffer-file-name buf)
5804 (buffer-modified-p buf))))
5806 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5807 (or (not (fboundp 'process-list))
5808 ;; process-list is not defined on MSDOS.
5809 (let ((processes (process-list))
5812 (and (memq (process-status (car processes)) '(run stop open listen))
5813 (process-query-on-exit-flag (car processes))
5815 (setq processes (cdr processes)))
5818 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5819 ;; Query the user for other things, perhaps.
5820 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5821 (or (null confirm-kill-emacs)
5822 (funcall confirm-kill-emacs "Really exit Emacs? "))
5825 (defun save-buffers-kill-terminal (&optional arg)
5826 "Offer to save each buffer, then kill the current connection.
5827 If the current frame has no client, kill Emacs itself.
5829 With prefix ARG, silently save all file-visiting buffers, then kill.
5831 If emacsclient was started with a list of filenames to edit, then
5832 only these files will be asked to be saved."
5834 (if (frame-parameter (selected-frame) 'client)
5835 (server-save-buffers-kill-terminal arg)
5836 (save-buffers-kill-emacs arg)))
5838 ;; We use /: as a prefix to "quote" a file name
5839 ;; so that magic file name handlers will not apply to it.
5841 (setq file-name-handler-alist
5842 (cons '("\\`/:" . file-name-non-special)
5843 file-name-handler-alist))
5845 ;; We depend on being the last handler on the list,
5846 ;; so that anything else which does need handling
5847 ;; has been handled already.
5848 ;; So it is safe for us to inhibit *all* magic file name handlers.
5850 (defun file-name-non-special (operation &rest arguments)
5851 (let ((file-name-handler-alist nil)
5853 (if (eq operation 'insert-directory)
5854 (directory-file-name
5856 (unhandled-file-name-directory default-directory)))
5858 ;; Get a list of the indices of the args which are file names.
5860 (cdr (or (assq operation
5861 ;; The first six are special because they
5862 ;; return a file name. We want to include the /:
5863 ;; in the return value.
5864 ;; So just avoid stripping it in the first place.
5865 '((expand-file-name . nil)
5866 (file-name-directory . nil)
5867 (file-name-as-directory . nil)
5868 (directory-file-name . nil)
5869 (file-name-sans-versions . nil)
5870 (find-backup-file-name . nil)
5871 ;; `identity' means just return the first arg
5872 ;; not stripped of its quoting.
5873 (substitute-in-file-name identity)
5874 ;; `add' means add "/:" to the result.
5875 (file-truename add 0)
5876 ;; `quote' means add "/:" to buffer-file-name.
5877 (insert-file-contents quote 0)
5878 ;; `unquote-then-quote' means set buffer-file-name
5879 ;; temporarily to unquoted filename.
5880 (verify-visited-file-modtime unquote-then-quote)
5881 ;; List the arguments which are filenames.
5882 (file-name-completion 1)
5883 (file-name-all-completions 1)
5887 (make-symbolic-link 0 1)
5888 (add-name-to-file 0 1)))
5889 ;; For all other operations, treat the first argument only
5890 ;; as the file name.
5893 ;; Copy ARGUMENTS so we can replace elements in it.
5894 (arguments (copy-sequence arguments)))
5895 (if (symbolp (car file-arg-indices))
5896 (setq method (pop file-arg-indices)))
5897 ;; Strip off the /: from the file names that have it.
5899 (while (consp file-arg-indices)
5900 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5902 (string-match "\\`/:" (car pair))
5904 (if (= (length (car pair)) 2)
5906 (substring (car pair) 2)))))
5907 (setq file-arg-indices (cdr file-arg-indices))))
5908 (cond ((eq method 'identity)
5911 (concat "/:" (apply operation arguments)))
5914 (apply operation arguments)
5915 (setq buffer-file-name (concat "/:" buffer-file-name))))
5916 ((eq method 'unquote-then-quote)
5918 (setq buffer-file-name (substring buffer-file-name 2))
5919 (setq res (apply operation arguments))
5920 (setq buffer-file-name (concat "/:" buffer-file-name))
5923 (apply operation arguments)))))
5925 ;; Symbolic modes and read-file-modes.
5927 (defun file-modes-char-to-who (char)
5928 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5929 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5930 Others, or All) for whom to produce the mask.
5931 The bit-mask that is returned extracts from mode bits the access rights
5932 for the specified category of users."
5933 (cond ((= char ?u) #o4700)
5934 ((= char ?g) #o2070)
5935 ((= char ?o) #o1007)
5936 ((= char ?a) #o7777)
5937 (t (error "%c: bad `who' character" char))))
5939 (defun file-modes-char-to-right (char &optional from)
5940 "Convert CHAR to a numeric value of mode bits.
5941 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5942 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5943 (or from (setq from 0))
5944 (cond ((= char ?r) #o0444)
5945 ((= char ?w) #o0222)
5946 ((= char ?x) #o0111)
5947 ((= char ?s) #o1000)
5948 ((= char ?t) #o6000)
5949 ;; Rights relative to the previous file modes.
5950 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5951 ((= char ?u) (let ((uright (logand #o4700 from)))
5952 (+ uright (/ uright #o10) (/ uright #o100))))
5953 ((= char ?g) (let ((gright (logand #o2070 from)))
5954 (+ gright (/ gright #o10) (* gright #o10))))
5955 ((= char ?o) (let ((oright (logand #o1007 from)))
5956 (+ oright (* oright #o10) (* oright #o100))))
5957 (t (error "%c: bad right character" char))))
5959 (defun file-modes-rights-to-number (rights who-mask &optional from)
5960 "Convert a symbolic mode string specification to an equivalent number.
5961 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
5962 WHO-MASK is the bit-mask specifying the category of users to which to
5963 apply the access permissions. See `file-modes-char-to-who'.
5964 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5965 RIGHTS request to add, remove, or set permissions based on existing ones,
5967 (let* ((num-rights (or from 0))
5968 (list-rights (string-to-list rights))
5969 (op (pop list-rights)))
5970 (while (memq op '(?+ ?- ?=))
5973 (while (memq (setq char-right (pop list-rights))
5974 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5977 (file-modes-char-to-right char-right num-rights))))
5978 (setq num-right (logand who-mask num-right)
5980 (cond ((= op ?+) (logior num-rights num-right))
5981 ((= op ?-) (logand num-rights (lognot num-right)))
5982 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5986 (defun file-modes-symbolic-to-number (modes &optional from)
5987 "Convert symbolic file modes to numeric file modes.
5988 MODES is the string to convert, it should match
5989 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
5990 See (info \"(coreutils)File permissions\") for more information on this
5992 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5993 MODES request to add, remove, or set permissions based on existing ones,
5996 (let ((case-fold-search nil)
5997 (num-modes (or from 0)))
5998 (while (/= (string-to-char modes) 0)
5999 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
6000 (let ((num-who (apply 'logior 0
6001 (mapcar 'file-modes-char-to-who
6002 (match-string 1 modes)))))
6004 (setq num-who (default-file-modes)))
6006 (file-modes-rights-to-number (substring modes (match-end 1))
6008 modes (substring modes (match-end 3))))
6009 (error "Parse error in modes near `%s'" (substring modes 0))))
6012 (defun read-file-modes (&optional prompt orig-file)
6013 "Read file modes in octal or symbolic notation and return its numeric value.
6014 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6015 ORIG-FILE is the name of a file on whose mode bits to base returned
6016 permissions if what user types requests to add, remove, or set permissions
6017 based on existing mode bits, as in \"og+rX-w\"."
6018 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6019 (error "File not found")))
6020 (modestr (and (stringp orig-file)
6021 (nth 8 (file-attributes orig-file))))
6023 (and (stringp modestr)
6024 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6025 (replace-regexp-in-string
6027 (format "u=%s,g=%s,o=%s"
6028 (match-string 1 modestr)
6029 (match-string 2 modestr)
6030 (match-string 3 modestr)))))
6031 (value (read-string (or prompt "File modes (octal or symbolic): ")
6034 (if (string-match "^[0-7]+" value)
6035 (string-to-number value 8)
6036 (file-modes-symbolic-to-number value modes)))))
6039 ;; Trashcan handling.
6040 (defcustom trash-directory nil
6041 "Directory for `move-file-to-trash' to move files and directories to.
6042 This directory is only used when the function `system-move-file-to-trash'
6044 Relative paths are interpreted relative to `default-directory'.
6045 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6046 :type '(choice (const nil) directory)
6050 (defvar trash--hexify-table)
6052 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6054 (defun move-file-to-trash (filename)
6055 "Move the file (or directory) named FILENAME to the trash.
6056 When `delete-by-moving-to-trash' is non-nil, this function is
6057 called by `delete-file' and `delete-directory' instead of
6058 deleting files outright.
6060 If the function `system-move-file-to-trash' is defined, call it
6061 with FILENAME as an argument.
6062 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6064 Otherwise, trash FILENAME using the freedesktop.org conventions,
6065 like the GNOME, KDE and XFCE desktop environments. Emacs only
6066 moves files to \"home trash\", ignoring per-volume trashcans."
6067 (interactive "fMove file to trash: ")
6068 (cond (trash-directory
6069 ;; If `trash-directory' is non-nil, move the file there.
6070 (let* ((trash-dir (expand-file-name trash-directory))
6071 (fn (directory-file-name (expand-file-name filename)))
6072 (new-fn (expand-file-name (file-name-nondirectory fn)
6074 ;; We can't trash a parent directory of trash-directory.
6075 (if (string-match fn trash-dir)
6076 (error "Trash directory `%s' is a subdirectory of `%s'"
6077 trash-dir filename))
6078 (unless (file-directory-p trash-dir)
6079 (make-directory trash-dir t))
6080 ;; Ensure that the trashed file-name is unique.
6081 (if (file-exists-p new-fn)
6082 (let ((version-control t)
6083 (backup-directory-alist nil))
6084 (setq new-fn (car (find-backup-file-name new-fn)))))
6085 (let (delete-by-moving-to-trash)
6086 (rename-file fn new-fn))))
6087 ;; If `system-move-file-to-trash' is defined, use it.
6088 ((fboundp 'system-move-file-to-trash)
6089 (system-move-file-to-trash filename))
6090 ;; Otherwise, use the freedesktop.org method, as specified at
6091 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6093 (let* ((xdg-data-dir
6094 (directory-file-name
6095 (expand-file-name "Trash"
6096 (or (getenv "XDG_DATA_HOME")
6097 "~/.local/share"))))
6098 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6099 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6100 (fn (directory-file-name (expand-file-name filename))))
6102 ;; Check if we have permissions to delete.
6103 (unless (file-writable-p (directory-file-name
6104 (file-name-directory fn)))
6105 (error "Cannot move %s to trash: Permission denied" filename))
6106 ;; The trashed file cannot be the trash dir or its parent.
6107 (if (string-match fn trash-files-dir)
6108 (error "The trash directory %s is a subdirectory of %s"
6109 trash-files-dir filename))
6110 (if (string-match fn trash-info-dir)
6111 (error "The trash directory %s is a subdirectory of %s"
6112 trash-info-dir filename))
6114 ;; Ensure that the trash directory exists; otherwise, create it.
6115 (let ((saved-default-file-modes (default-file-modes)))
6116 (set-default-file-modes ?\700)
6117 (unless (file-exists-p trash-files-dir)
6118 (make-directory trash-files-dir t))
6119 (unless (file-exists-p trash-info-dir)
6120 (make-directory trash-info-dir t))
6121 (set-default-file-modes saved-default-file-modes))
6123 ;; Try to move to trash with .trashinfo undo information
6126 (set-buffer-file-coding-system 'utf-8-unix)
6127 (insert "[Trash Info]\nPath=")
6128 ;; Perform url-encoding on FN. For compatibility with
6129 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6130 ;; for path separators.
6131 (unless (boundp 'trash--hexify-table)
6132 (setq trash--hexify-table (make-vector 256 nil))
6133 (let ((unreserved-chars
6134 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6135 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6136 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6137 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6138 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6141 (aset trash--hexify-table byte
6142 (if (memq byte unreserved-chars)
6143 (char-to-string byte)
6144 (format "%%%02x" byte))))))
6145 (mapc (lambda (byte)
6146 (insert (aref trash--hexify-table byte)))
6147 (if (multibyte-string-p fn)
6148 (encode-coding-string fn 'utf-8)
6150 (insert "\nDeletionDate="
6151 (format-time-string "%Y-%m-%dT%T")
6154 ;; Attempt to make .trashinfo file, trying up to 5
6155 ;; times. The .trashinfo file is opened with O_EXCL,
6156 ;; as per trash-spec 0.7, even if that can be a problem
6157 ;; on old NFS versions...
6159 (base-fn (expand-file-name
6160 (file-name-nondirectory fn)
6165 (setq info-fn (expand-file-name
6166 (concat (file-name-nondirectory new-fn)
6169 (unless (condition-case nil
6171 (write-region nil nil info-fn nil
6172 'quiet info-fn 'excl)
6173 (setq tries 0 success t))
6174 (file-already-exists nil))
6175 (setq tries (1- tries))
6176 ;; Uniqify new-fn. (Some file managers do not
6177 ;; like Emacs-style backup file names---e.g. bug
6178 ;; 170956 in Konqueror bug tracker.)
6179 (setq new-fn (make-temp-name (concat base-fn "_")))))
6181 (error "Cannot move %s to trash: Lock failed" filename))
6183 ;; Finally, try to move the file to the trashcan.
6184 (let ((delete-by-moving-to-trash nil))
6185 (rename-file fn new-fn)))))))))
6188 (define-key ctl-x-map "\C-f" 'find-file)
6189 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6190 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6191 (define-key ctl-x-map "\C-s" 'save-buffer)
6192 (define-key ctl-x-map "s" 'save-some-buffers)
6193 (define-key ctl-x-map "\C-w" 'write-file)
6194 (define-key ctl-x-map "i" 'insert-file)
6195 (define-key esc-map "~" 'not-modified)
6196 (define-key ctl-x-map "\C-d" 'list-directory)
6197 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6198 (define-key ctl-x-map "\C-q" 'toggle-read-only)
6200 (define-key ctl-x-4-map "f" 'find-file-other-window)
6201 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6202 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6203 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6204 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6206 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6207 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6208 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6209 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6210 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6212 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6213 ;;; files.el ends here