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 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
32 (defvar font-lock-keywords)
35 "Backups of edited data files."
38 (defgroup find-file nil
43 (defcustom delete-auto-save-files t
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
51 (defcustom directory-abbrev-alist
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
66 :type '(repeat (cons :format "%v"
73 (defcustom make-backup-files t
74 "Non-nil means make a backup of a file the first time it is saved.
75 This can be done by renaming the file or by copying.
77 Renaming means that Emacs renames the existing file so that it is a
78 backup file, then writes the buffer into a new file. Any other names
79 that the old file had will now refer to the backup file. The new file
80 is owned by you and its group is defaulted.
82 Copying means that Emacs copies the existing file into the backup
83 file, then writes the buffer on top of the existing file. Any other
84 names that the old file had will now refer to the new (edited) file.
85 The file's owner and group are unchanged.
87 The choice of renaming or copying is controlled by the variables
88 `backup-by-copying', `backup-by-copying-when-linked',
89 `backup-by-copying-when-mismatch' and
90 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 ;; Do this so that local variables based on the file name
95 ;; are not overridden by the major mode.
96 (defvar backup-inhibited nil
97 "Non-nil means don't make a backup, regardless of the other parameters.
98 This variable is intended for use by making it local to a buffer.
99 But it is local only if you make it local.")
100 (put 'backup-inhibited 'permanent-local t)
102 (defcustom backup-by-copying nil
103 "Non-nil means always use copying to create backup files.
104 See documentation of variable `make-backup-files'."
108 (defcustom backup-by-copying-when-linked nil
109 "Non-nil means use copying to create backups for files with multiple names.
110 This causes the alternate names to refer to the latest version as edited.
111 This variable is relevant only if `backup-by-copying' is nil."
115 (defcustom backup-by-copying-when-mismatch nil
116 "Non-nil means create backups by copying if this preserves owner or group.
117 Renaming may still be used (subject to control of other variables)
118 when it would not result in changing the owner or group of the file;
119 that is, for files which are owned by you and whose group matches
120 the default for a new file created there by you.
121 This variable is relevant only if `backup-by-copying' is nil."
125 (defcustom backup-by-copying-when-privileged-mismatch 200
126 "Non-nil means create backups by copying to preserve a privileged owner.
127 Renaming may still be used (subject to control of other variables)
128 when it would not result in changing the owner of the file or if the owner
129 has a user id greater than the value of this variable. This is useful
130 when low-numbered uid's are used for special system users (such as root)
131 that must maintain ownership of certain files.
132 This variable is relevant only if `backup-by-copying' and
133 `backup-by-copying-when-mismatch' are nil."
134 :type '(choice (const nil) integer)
137 (defvar backup-enable-predicate 'normal-backup-enable-predicate
138 "Predicate that looks at a file name and decides whether to make backups.
139 Called with an absolute file name as argument, it returns t to enable backup.")
141 (defcustom buffer-offer-save nil
142 "Non-nil in a buffer means always offer to save buffer on exit.
143 Do so even if the buffer is not visiting a file.
144 Automatically local in all buffers."
147 (make-variable-buffer-local 'buffer-offer-save)
149 (defcustom find-file-existing-other-name t
150 "Non-nil means find a file under alternative names, in existing buffers.
151 This means if any existing buffer is visiting the file you want
152 under another name, you get the existing buffer instead of a new buffer."
156 (defcustom find-file-visit-truename nil
157 "Non-nil means visit a file under its truename.
158 The truename of a file is found by chasing all links
159 both at the file level and at the levels of the containing directories."
162 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
164 (defcustom revert-without-query nil
165 "Specify which files should be reverted without query.
166 The value is a list of regular expressions.
167 If the file name matches one of these regular expressions,
168 then `revert-buffer' reverts the file without querying
169 if the file has changed on disk and you have not edited the buffer."
170 :type '(repeat regexp)
173 (defvar buffer-file-number nil
174 "The device number and file number of the file visited in the current buffer.
175 The value is a list of the form (FILENUM DEVNUM).
176 This pair of numbers uniquely identifies the file.
177 If the buffer is visiting a new file, the value is nil.")
178 (make-variable-buffer-local 'buffer-file-number)
179 (put 'buffer-file-number 'permanent-local t)
181 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
182 "Non-nil means that `buffer-file-number' uniquely identifies files.")
184 (defvar buffer-file-read-only nil
185 "Non-nil if visited file was read-only when visited.")
186 (make-variable-buffer-local 'buffer-file-read-only)
188 (defcustom temporary-file-directory
189 (file-name-as-directory
190 (cond ((memq system-type '(ms-dos windows-nt))
191 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
193 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
194 "The directory for writing temporary files."
198 (defcustom small-temporary-file-directory
199 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
200 "The directory for writing small temporary files.
201 If non-nil, this directory is used instead of `temporary-file-directory'
202 by programs that create small temporary files. This is for systems that
203 have fast storage with limited space, such as a RAM disk."
205 :type '(choice (const nil) directory))
207 ;; The system null device. (Should reference NULL_DEVICE from C.)
208 (defvar null-device "/dev/null" "The system null device.")
210 (declare-function msdos-long-file-names "msdos.c")
211 (declare-function w32-long-file-name "w32proc.c")
212 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
213 (declare-function dired-unmark "dired" (arg))
214 (declare-function dired-do-flagged-delete "dired" (&optional nomessage))
215 (declare-function dos-8+3-filename "dos-fns" (filename))
216 (declare-function view-mode-disable "view" ())
218 (defvar file-name-invalid-regexp
219 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
220 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
221 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
222 "[\000-\037]\\|" ; control characters
223 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
224 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
225 ((memq system-type '(ms-dos windows-nt cygwin))
226 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
227 "[|<>\"?*\000-\037]")) ; invalid characters
229 "Regexp recognizing file names which aren't allowed by the filesystem.")
231 (defcustom file-precious-flag nil
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files.
244 This feature is advisory: for example, if the directory in which the
245 file is being saved is not writeable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file.
248 See also: `break-hardlink-on-save'."
252 (defcustom break-hardlink-on-save nil
253 "Non-nil means when saving a file that exists under several names
254 (i.e., has multiple hardlinks), break the hardlink associated with
255 `buffer-file-name' and write to a new file, so that the other
256 instances of the file are not affected by the save.
258 If `buffer-file-name' refers to a symlink, do not break the symlink.
260 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
261 For example, if the directory in which a file is being saved is not
262 itself writeable, then error instead of saving in some
263 hardlink-nonbreaking way.
265 See also `backup-by-copying' and `backup-by-copying-when-linked'."
269 (defcustom version-control nil
270 "Control use of version numbers for backup files.
271 When t, make numeric backup versions unconditionally.
272 When nil, make them for files that have some already.
273 The value `never' means do not make them."
274 :type '(choice (const :tag "Never" never)
275 (const :tag "If existing" nil)
276 (other :tag "Always" t))
279 (put 'version-control 'safe-local-variable
280 '(lambda (x) (or (booleanp x) (equal x 'never))))
282 (defcustom dired-kept-versions 2
283 "When cleaning directory, number of versions to keep."
288 (defcustom delete-old-versions nil
289 "If t, delete excess backup versions silently.
290 If nil, ask confirmation. Any other value prevents any trimming."
291 :type '(choice (const :tag "Delete" t)
292 (const :tag "Ask" nil)
293 (other :tag "Leave" other))
296 (defcustom kept-old-versions 2
297 "Number of oldest versions to keep when a new numbered backup is made."
300 (put 'kept-old-versions 'safe-local-variable 'integerp)
302 (defcustom kept-new-versions 2
303 "Number of newest versions to keep when a new numbered backup is made.
304 Includes the new backup. Must be > 0"
307 (put 'kept-new-versions 'safe-local-variable 'integerp)
309 (defcustom require-final-newline nil
310 "Whether to add a newline automatically at the end of the file.
312 A value of t means do this only when the file is about to be saved.
313 A value of `visit' means do this right after the file is visited.
314 A value of `visit-save' means do it at both of those times.
315 Any other non-nil value means ask user whether to add a newline, when saving.
316 A value of nil means don't add newlines.
318 Certain major modes set this locally to the value obtained
319 from `mode-require-final-newline'."
320 :type '(choice (const :tag "When visiting" visit)
321 (const :tag "When saving" t)
322 (const :tag "When visiting or saving" visit-save)
323 (const :tag "Don't add newlines" nil)
324 (other :tag "Ask each time" ask))
325 :group 'editing-basics)
327 (defcustom mode-require-final-newline t
328 "Whether to add a newline at end of file, in certain major modes.
329 Those modes set `require-final-newline' to this value when you enable them.
330 They do so because they are often used for files that are supposed
331 to end in newlines, and the question is how to arrange that.
333 A value of t means do this only when the file is about to be saved.
334 A value of `visit' means do this right after the file is visited.
335 A value of `visit-save' means do it at both of those times.
336 Any other non-nil value means ask user whether to add a newline, when saving.
338 A value of nil means do not add newlines. That is a risky choice in this
339 variable since this value is used for modes for files that ought to have
340 final newlines. So if you set this to nil, you must explicitly check and
341 add a final newline, whenever you save a file that really needs one."
342 :type '(choice (const :tag "When visiting" visit)
343 (const :tag "When saving" t)
344 (const :tag "When visiting or saving" visit-save)
345 (const :tag "Don't add newlines" nil)
346 (other :tag "Ask each time" ask))
347 :group 'editing-basics
350 (defcustom auto-save-default t
351 "Non-nil says by default do auto-saving of every file-visiting buffer."
355 (defcustom auto-save-file-name-transforms
356 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
357 ;; Don't put "\\2" inside expand-file-name, since it will be
358 ;; transformed to "/2" on DOS/Windows.
359 ,(concat temporary-file-directory "\\2") t))
360 "Transforms to apply to buffer file name before making auto-save file name.
361 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
362 REGEXP is a regular expression to match against the file name.
363 If it matches, `replace-match' is used to replace the
364 matching part with REPLACEMENT.
365 If the optional element UNIQUIFY is non-nil, the auto-save file name is
366 constructed by taking the directory part of the replaced file-name,
367 concatenated with the buffer file name with all directory separators
368 changed to `!' to prevent clashes. This will not work
369 correctly if your filesystem truncates the resulting name.
371 All the transforms in the list are tried, in the order they are listed.
372 When one transform applies, its result is final;
373 no further transforms are tried.
375 The default value is set up to put the auto-save file into the
376 temporary directory (see the variable `temporary-file-directory') for
377 editing a remote file.
379 On MS-DOS filesystems without long names this variable is always
382 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
383 (boolean :tag "Uniquify")))
386 (defcustom save-abbrevs t
387 "Non-nil means save word abbrevs too when files are saved.
388 If `silently', don't ask the user before saving."
389 :type '(choice (const t) (const nil) (const silently))
392 (defcustom find-file-run-dired t
393 "Non-nil means allow `find-file' to visit directories.
394 To visit the directory, `find-file' runs `find-directory-functions'."
398 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
399 "List of functions to try in sequence to visit a directory.
400 Each function is called with the directory name as the sole argument
401 and should return either a buffer or nil."
402 :type '(hook :options (cvs-dired-noselect dired-noselect))
405 ;;;It is not useful to make this a local variable.
406 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
407 (defvar find-file-not-found-functions nil
408 "List of functions to be called for `find-file' on nonexistent file.
409 These functions are called as soon as the error is detected.
410 Variable `buffer-file-name' is already set up.
411 The functions are called in the order given until one of them returns non-nil.")
412 (define-obsolete-variable-alias 'find-file-not-found-hooks
413 'find-file-not-found-functions "22.1")
415 ;;;It is not useful to make this a local variable.
416 ;;;(put 'find-file-hooks 'permanent-local t)
417 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
418 (defcustom find-file-hook nil
419 "List of functions to be called after a buffer is loaded from a file.
420 The buffer's local variables (if any) will have been processed before the
421 functions are called."
424 :options '(auto-insert)
427 (defvar write-file-functions nil
428 "List of functions to be called before writing out a buffer to a file.
429 If one of them returns non-nil, the file is considered already written
430 and the rest are not called.
431 These hooks are considered to pertain to the visited file.
432 So any buffer-local binding of this variable is discarded if you change
433 the visited file name with \\[set-visited-file-name], but not when you
434 change the major mode.
436 This hook is not run if any of the functions in
437 `write-contents-functions' returns non-nil. Both hooks pertain
438 to how to save a buffer to file, for instance, choosing a suitable
439 coding system and setting mode bits. (See Info
440 node `(elisp)Saving Buffers'.) To perform various checks or
441 updates before the buffer is saved, use `before-save-hook'.")
442 (put 'write-file-functions 'permanent-local t)
443 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
445 (defvar local-write-file-hooks nil)
446 (make-variable-buffer-local 'local-write-file-hooks)
447 (put 'local-write-file-hooks 'permanent-local t)
448 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
450 (defvar write-contents-functions nil
451 "List of functions to be called before writing out a buffer to a file.
452 If one of them returns non-nil, the file is considered already written
453 and the rest are not called and neither are the functions in
454 `write-file-functions'.
456 This variable is meant to be used for hooks that pertain to the
457 buffer's contents, not to the particular visited file; thus,
458 `set-visited-file-name' does not clear this variable; but changing the
459 major mode does clear it.
461 For hooks that _do_ pertain to the particular visited file, use
462 `write-file-functions'. Both this variable and
463 `write-file-functions' relate to how a buffer is saved to file.
464 To perform various checks or updates before the buffer is saved,
465 use `before-save-hook'.")
466 (make-variable-buffer-local 'write-contents-functions)
467 (define-obsolete-variable-alias 'write-contents-hooks
468 'write-contents-functions "22.1")
470 (defcustom enable-local-variables t
471 "Control use of local variables in files you visit.
472 The value can be t, nil, :safe, :all, or something else.
474 A value of t means file local variables specifications are obeyed
475 if all the specified variable values are safe; if any values are
476 not safe, Emacs queries you, once, whether to set them all.
477 \(When you say yes to certain values, they are remembered as safe.)
479 :safe means set the safe variables, and ignore the rest.
480 :all means set all variables, whether safe or not.
481 (Don't set it permanently to :all.)
482 A value of nil means always ignore the file local variables.
484 Any other value means always query you once whether to set them all.
485 \(When you say yes to certain values, they are remembered as safe, but
486 this has no effect when `enable-local-variables' is \"something else\".)
488 This variable also controls use of major modes specified in
491 The command \\[normal-mode], when used interactively,
492 always obeys file local variable specifications and the -*- line,
493 and ignores this variable."
494 :type '(choice (const :tag "Query Unsafe" t)
495 (const :tag "Safe Only" :safe)
496 (const :tag "Do all" :all)
497 (const :tag "Ignore" nil)
498 (other :tag "Query" other))
501 (defvar local-enable-local-variables t
502 "Like `enable-local-variables' but meant for buffer-local bindings.
503 The meaningful values are nil and non-nil. The default is non-nil.
504 If a major mode sets this to nil, buffer-locally, then any local
505 variables list in the file will be ignored.
507 This variable does not affect the use of major modes
508 specified in a -*- line.")
510 (defcustom enable-local-eval 'maybe
511 "Control processing of the \"variable\" `eval' in a file's local variables.
512 The value can be t, nil or something else.
513 A value of t means obey `eval' variables.
514 A value of nil means ignore them; anything else means query."
515 :type '(choice (const :tag "Obey" t)
516 (const :tag "Ignore" nil)
517 (other :tag "Query" other))
520 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
521 (or (fboundp 'lock-buffer)
522 (defalias 'lock-buffer 'ignore))
523 (or (fboundp 'unlock-buffer)
524 (defalias 'unlock-buffer 'ignore))
525 (or (fboundp 'file-locked-p)
526 (defalias 'file-locked-p 'ignore))
528 (defcustom view-read-only nil
529 "Non-nil means buffers visiting files read-only do so in view mode.
530 In fact, this means that all read-only buffers normally have
531 View mode enabled, including buffers that are read-only because
532 you visit a file you cannot alter, and buffers you make read-only
533 using \\[toggle-read-only]."
537 (defvar file-name-history nil
538 "History list of file names entered in the minibuffer.
540 Maximum length of the history list is determined by the value
541 of `history-length', which see.")
543 (put 'ange-ftp-completion-hook-function 'safe-magic t)
544 (defun ange-ftp-completion-hook-function (op &rest args)
545 "Provides support for ange-ftp host name completion.
546 Runs the usual ange-ftp hook, but only for completion operations."
547 ;; Having this here avoids the need to load ange-ftp when it's not
549 (if (memq op '(file-name-completion file-name-all-completions))
550 (apply 'ange-ftp-hook-function op args)
551 (let ((inhibit-file-name-handlers
552 (cons 'ange-ftp-completion-hook-function
553 (and (eq inhibit-file-name-operation op)
554 inhibit-file-name-handlers)))
555 (inhibit-file-name-operation op))
558 (defun convert-standard-filename (filename)
559 "Convert a standard file's name to something suitable for the OS.
560 This means to guarantee valid names and perhaps to canonicalize
563 FILENAME should be an absolute file name since the conversion rules
564 sometimes vary depending on the position in the file name. E.g. c:/foo
565 is a valid DOS file name, but c:/bar/c:/foo is not.
567 This function's standard definition is trivial; it just returns
568 the argument. However, on Windows and DOS, replace invalid
569 characters. On DOS, make sure to obey the 8.3 limitations.
570 In the native Windows build, turn Cygwin names into native names,
571 and also turn slashes into backslashes if the shell requires it (see
572 `w32-shell-dos-semantics').
574 See Info node `(elisp)Standard File Names' for more details."
575 (if (eq system-type 'cygwin)
576 (let ((name (copy-sequence filename))
578 ;; Replace invalid filename characters with !
579 (while (string-match "[?*:<>|\"\000-\037]" name start)
580 (aset name (match-beginning 0) ?!)
581 (setq start (match-end 0)))
585 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
586 "Read directory name, prompting with PROMPT and completing in directory DIR.
587 Value is not expanded---you must call `expand-file-name' yourself.
588 Default name to DEFAULT-DIRNAME if user exits with the same
589 non-empty string that was inserted by this function.
590 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
591 or just DIR if INITIAL is nil.)
592 If the user exits with an empty minibuffer, this function returns
593 an empty string. (This can only happen if the user erased the
594 pre-inserted contents or if `insert-default-directory' is nil.)
595 Fourth arg MUSTMATCH non-nil means require existing directory's name.
596 Non-nil and non-t means also require confirmation after completion.
597 Fifth arg INITIAL specifies text to start with.
598 DIR should be an absolute directory name. It defaults to
599 the value of `default-directory'."
601 (setq dir default-directory))
602 (read-file-name prompt dir (or default-dirname
603 (if initial (expand-file-name initial dir)
610 "Show the current default directory."
612 (message "Directory %s" default-directory))
615 "Value of the CDPATH environment variable, as a list.
616 Not actually set up until the first time you use it.")
618 (defun parse-colon-path (cd-path)
619 "Explode a search path into a list of directory names.
620 Directories are separated by occurrences of `path-separator'
621 \(which is colon in GNU and GNU-like systems)."
622 ;; We could use split-string here.
624 (let (cd-list (cd-start 0) cd-colon)
625 (setq cd-path (concat cd-path path-separator))
626 (while (setq cd-colon (string-match path-separator cd-path cd-start))
629 (list (if (= cd-start cd-colon)
631 (substitute-in-file-name
632 (file-name-as-directory
633 (substring cd-path cd-start cd-colon)))))))
634 (setq cd-start (+ cd-colon 1)))
637 (defun cd-absolute (dir)
638 "Change current directory to given absolute file name DIR."
639 ;; Put the name into directory syntax now,
640 ;; because otherwise expand-file-name may give some bad results.
641 (setq dir (file-name-as-directory dir))
642 (setq dir (abbreviate-file-name (expand-file-name dir)))
643 (if (not (file-directory-p dir))
644 (if (file-exists-p dir)
645 (error "%s is not a directory" dir)
646 (error "%s: no such directory" dir))
647 (unless (file-executable-p dir)
648 (error "Cannot cd to %s: Permission denied" dir))
649 (setq default-directory dir)
650 (set (make-local-variable 'list-buffers-directory) dir)))
653 "Make DIR become the current buffer's default directory.
654 If your environment includes a `CDPATH' variable, try each one of
655 that list of directories (separated by occurrences of
656 `path-separator') when resolving a relative directory name.
657 The path separator is colon in GNU and GNU-like systems."
659 (list (read-directory-name "Change default directory: "
660 default-directory default-directory
661 (and (member cd-path '(nil ("./")))
662 (null (getenv "CDPATH"))))))
663 (if (file-name-absolute-p dir)
664 (cd-absolute (expand-file-name dir))
666 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
667 (setq cd-path (or trypath (list "./")))))
668 (if (not (catch 'found
670 (function (lambda (x)
671 (let ((f (expand-file-name (concat x dir))))
672 (if (file-directory-p f)
675 (throw 'found t))))))
678 (error "No such directory found via CDPATH environment variable"))))
680 (defun load-file (file)
681 "Load the Lisp file named FILE."
682 ;; This is a case where .elc makes a lot of sense.
683 (interactive (list (let ((completion-ignored-extensions
684 (remove ".elc" completion-ignored-extensions)))
685 (read-file-name "Load file: "))))
686 (load (expand-file-name file) nil nil t))
688 (defun locate-file (filename path &optional suffixes predicate)
689 "Search for FILENAME through PATH.
690 If found, return the absolute file name of FILENAME, with its suffixes;
691 otherwise return nil.
692 PATH should be a list of directories to look in, like the lists in
693 `exec-path' or `load-path'.
694 If SUFFIXES is non-nil, it should be a list of suffixes to append to
695 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
696 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
697 If non-nil, PREDICATE is used instead of `file-readable-p'.
698 PREDICATE can also be an integer to pass to the `access' system call,
699 in which case file-name handlers are ignored. This usage is deprecated.
701 For compatibility, PREDICATE can also be one of the symbols
702 `executable', `readable', `writable', or `exists', or a list of
703 one or more of those symbols."
704 (if (and predicate (symbolp predicate) (not (functionp predicate)))
705 (setq predicate (list predicate)))
706 (when (and (consp predicate) (not (functionp predicate)))
708 (logior (if (memq 'executable predicate) 1 0)
709 (if (memq 'writable predicate) 2 0)
710 (if (memq 'readable predicate) 4 0))))
711 (locate-file-internal filename path suffixes predicate))
713 (defun locate-file-completion-table (dirs suffixes string pred action)
714 "Do completion for file names passed to `locate-file'."
715 (if (file-name-absolute-p string)
716 (let ((read-file-name-predicate pred))
717 (read-file-name-internal string nil action))
719 (suffix (concat (regexp-opt suffixes t) "\\'"))
720 (string-dir (file-name-directory string)))
723 (setq dir default-directory))
724 (if string-dir (setq dir (expand-file-name string-dir dir)))
725 (when (file-directory-p dir)
726 (dolist (file (file-name-all-completions
727 (file-name-nondirectory string) dir))
728 (add-to-list 'names (if string-dir (concat string-dir file) file))
729 (when (string-match suffix file)
730 (setq file (substring file 0 (match-beginning 0)))
731 (push (if string-dir (concat string-dir file) file) names)))))
732 (complete-with-action action names string pred))))
734 (defun locate-file-completion (string path-and-suffixes action)
735 "Do completion for file names passed to `locate-file'.
736 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
737 (locate-file-completion-table (car path-and-suffixes)
738 (cdr path-and-suffixes)
740 (make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
742 (defvar locate-dominating-stop-dir-regexp
743 "\\`\\(?:[\\/][\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
744 "Regexp of directory names which stop the search in `locate-dominating-file'.
745 Any directory whose name matches this regexp will be treated like
746 a kind of root directory by `locate-dominating-file' which will stop its search
747 when it bumps into it.
748 The default regexp prevents fruitless and time-consuming attempts to find
749 special files in directories in which filenames are interpreted as hostnames.")
751 ;; (defun locate-dominating-files (file regexp)
752 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
753 ;; Stop at the first parent where a matching file is found and return the list
754 ;; of files that that match in this directory."
756 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
757 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
759 ;; ;; Abbreviate, so as to stop when we cross ~/.
760 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
763 ;; ;; As a heuristic, we stop looking up the hierarchy of
764 ;; ;; directories as soon as we find a directory belonging to
765 ;; ;; another user. This should save us from looking in
766 ;; ;; things like /net and /afs. This assumes that all the
767 ;; ;; files inside a project belong to the same user.
768 ;; (let ((prev-user user))
769 ;; (setq user (nth 2 (file-attributes dir)))
770 ;; (or (null prev-user) (equal user prev-user))))
771 ;; (if (setq files (condition-case nil
772 ;; (directory-files dir 'full regexp 'nosort)
774 ;; (throw 'found files)
776 ;; (setq dir (file-name-directory
777 ;; (directory-file-name dir))))
781 (defun locate-dominating-file (file name)
782 "Look up the directory hierarchy from FILE for a file named NAME.
783 Stop at the first parent directory containing a file NAME,
784 and return the directory. Return nil if not found."
785 ;; We used to use the above locate-dominating-files code, but the
786 ;; directory-files call is very costly, so we're much better off doing
787 ;; multiple calls using the code in here.
789 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
790 ;; `name' in /home or in /.
791 (setq file (abbreviate-file-name file))
794 ;; `user' is not initialized outside the loop because
795 ;; `file' may not exist, so we may have to walk up part of the
796 ;; hierarchy before we find the "initial UID".
801 ;; FIXME: Disabled this heuristic because it is sometimes
803 ;; As a heuristic, we stop looking up the hierarchy of
804 ;; directories as soon as we find a directory belonging
805 ;; to another user. This should save us from looking in
806 ;; things like /net and /afs. This assumes that all the
807 ;; files inside a project belong to the same user.
808 ;; (let ((prev-user user))
809 ;; (setq user (nth 2 (file-attributes file)))
810 ;; (and prev-user (not (equal user prev-user))))
811 (string-match locate-dominating-stop-dir-regexp file)))
812 (setq try (file-exists-p (expand-file-name name file)))
813 (cond (try (setq root file))
814 ((equal file (setq prev-file file
815 file (file-name-directory
816 (directory-file-name file))))
821 (defun executable-find (command)
822 "Search for COMMAND in `exec-path' and return the absolute file name.
823 Return nil if COMMAND is not found anywhere in `exec-path'."
824 ;; Use 1 rather than file-executable-p to better match the behavior of
826 (locate-file command exec-path exec-suffixes 1))
828 (defun load-library (library)
829 "Load the library named LIBRARY.
830 This is an interface to the function `load'."
832 (list (completing-read "Load library: "
833 (apply-partially 'locate-file-completion-table
835 (get-load-suffixes)))))
838 (defun file-remote-p (file &optional identification connected)
839 "Test whether FILE specifies a location on a remote system.
840 Returns nil or a string identifying the remote connection (ideally
841 a prefix of FILE). For example, the remote identification for filename
842 \"/user@host:/foo\" could be \"/user@host:\".
843 A file is considered \"remote\" if accessing it is likely to be slower or
844 less reliable than accessing local files.
845 Furthermore, relative file names do not work across remote connections.
847 IDENTIFICATION specifies which part of the identification shall
848 be returned as string. IDENTIFICATION can be the symbol
849 `method', `user', `host' or `localname'; any other value is
850 handled like nil and means to return the complete identification
853 If CONNECTED is non-nil, the function returns an identification only
854 if FILE is located on a remote system, and a connection is established
855 to that remote system.
857 `file-remote-p' will never open a connection on its own."
858 (let ((handler (find-file-name-handler file 'file-remote-p)))
860 (funcall handler 'file-remote-p file identification connected)
863 (defun file-local-copy (file)
864 "Copy the file FILE into a temporary file on this machine.
865 Returns the name of the local copy, or nil, if FILE is directly
867 ;; This formerly had an optional BUFFER argument that wasn't used by
869 (let ((handler (find-file-name-handler file 'file-local-copy)))
871 (funcall handler 'file-local-copy file)
874 (defun file-truename (filename &optional counter prev-dirs)
875 "Return the truename of FILENAME, which should be absolute.
876 The truename of a file name is found by chasing symbolic links
877 both at the level of the file and at the level of the directories
878 containing it, until no links are left at any level.
880 \(fn FILENAME)" ;; Don't document the optional arguments.
881 ;; COUNTER and PREV-DIRS are only used in recursive calls.
882 ;; COUNTER can be a cons cell whose car is the count of how many
883 ;; more links to chase before getting an error.
884 ;; PREV-DIRS can be a cons cell whose car is an alist
885 ;; of truenames we've just recently computed.
886 (cond ((or (string= filename "") (string= filename "~"))
887 (setq filename (expand-file-name filename))
888 (if (string= filename "")
889 (setq filename "/")))
890 ((and (string= (substring filename 0 1) "~")
891 (string-match "~[^/]*/?" filename))
893 (substring filename 0 (match-end 0)))
894 (rest (substring filename (match-end 0))))
895 (setq filename (concat (expand-file-name first-part) rest)))))
897 (or counter (setq counter (list 100)))
899 ;; For speed, remove the ange-ftp completion handler from the list.
900 ;; We know it's not needed here.
901 ;; For even more speed, do this only on the outermost call.
902 (file-name-handler-alist
903 (if prev-dirs file-name-handler-alist
904 (let ((tem (copy-sequence file-name-handler-alist)))
905 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
906 (or prev-dirs (setq prev-dirs (list nil)))
908 ;; andrewi@harlequin.co.uk - none of the following code (except for
909 ;; invoking the file-name handler) currently applies on Windows
910 ;; (ie. there are no native symlinks), but there is an issue with
911 ;; case differences being ignored by the OS, and short "8.3 DOS"
912 ;; name aliases existing for all files. (The short names are not
913 ;; reported by directory-files, but can be used to refer to files.)
914 ;; It seems appropriate for file-truename to resolve these issues in
915 ;; the most natural way, which on Windows is to call the function
916 ;; `w32-long-file-name' - this returns the exact name of a file as
917 ;; it is stored on disk (expanding short name aliases with the full
918 ;; name in the process).
919 (if (eq system-type 'windows-nt)
920 (let ((handler (find-file-name-handler filename 'file-truename)))
921 ;; For file name that has a special handler, call handler.
922 ;; This is so that ange-ftp can save time by doing a no-op.
924 (setq filename (funcall handler 'file-truename filename))
925 ;; If filename contains a wildcard, newname will be the old name.
926 (unless (string-match "[[*?]" filename)
927 ;; If filename exists, use the long name. If it doesn't exist,
928 ;; drill down until we find a directory that exists, and use
929 ;; the long name of that, with the extra non-existent path
930 ;; components concatenated.
931 (let ((longname (w32-long-file-name filename))
934 (setq filename longname)
935 ;; Include the preceding directory separator in the missing
936 ;; part so subsequent recursion on the rest works.
937 (setq missing (concat "/" (file-name-nondirectory filename)))
938 (let ((length (length missing)))
940 (if (> length (length filename))
942 (substring filename 0 (- length)))))
943 (setq filename (concat (file-truename rest) missing))))))
946 ;; If this file directly leads to a link, process that iteratively
947 ;; so that we don't use lots of stack.
949 (setcar counter (1- (car counter)))
950 (if (< (car counter) 0)
951 (error "Apparent cycle of symbolic links for %s" filename))
952 (let ((handler (find-file-name-handler filename 'file-truename)))
953 ;; For file name that has a special handler, call handler.
954 ;; This is so that ange-ftp can save time by doing a no-op.
956 (setq filename (funcall handler 'file-truename filename)
958 (let ((dir (or (file-name-directory filename) default-directory))
960 ;; Get the truename of the directory.
961 (setq dirfile (directory-file-name dir))
962 ;; If these are equal, we have the (or a) root directory.
963 (or (string= dir dirfile)
964 ;; If this is the same dir we last got the truename for,
965 ;; save time--don't recalculate.
966 (if (assoc dir (car prev-dirs))
967 (setq dir (cdr (assoc dir (car prev-dirs))))
969 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
970 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
972 (if (equal ".." (file-name-nondirectory filename))
974 (directory-file-name (file-name-directory (directory-file-name dir)))
976 (if (equal "." (file-name-nondirectory filename))
977 (setq filename (directory-file-name dir)
979 ;; Put it back on the file name.
980 (setq filename (concat dir (file-name-nondirectory filename)))
981 ;; Is the file name the name of a link?
982 (setq target (file-symlink-p filename))
984 ;; Yes => chase that link, then start all over
985 ;; since the link may point to a directory name that uses links.
986 ;; We can't safely use expand-file-name here
987 ;; since target might look like foo/../bar where foo
988 ;; is itself a link. Instead, we handle . and .. above.
990 (if (file-name-absolute-p target)
998 (defun file-chase-links (filename &optional limit)
999 "Chase links in FILENAME until a name that is not a link.
1000 Unlike `file-truename', this does not check whether a parent
1001 directory name is a symbolic link.
1002 If the optional argument LIMIT is a number,
1003 it means chase no more than that many links and then stop."
1004 (let (tem (newname filename)
1006 (while (and (or (null limit) (< count limit))
1007 (setq tem (file-symlink-p newname)))
1009 (if (and (null limit) (= count 100))
1010 (error "Apparent cycle of symbolic links for %s" filename))
1011 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1012 (while (string-match "//+" tem)
1013 (setq tem (replace-match "/" nil nil tem)))
1014 ;; Handle `..' by hand, since it needs to work in the
1015 ;; target of any directory symlink.
1016 ;; This code is not quite complete; it does not handle
1017 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1018 (while (string-match "\\`\\.\\./" tem)
1019 (setq tem (substring tem 3))
1020 (setq newname (expand-file-name newname))
1021 ;; Chase links in the default dir of the symlink.
1024 (directory-file-name (file-name-directory newname))))
1025 ;; Now find the parent of that dir.
1026 (setq newname (file-name-directory newname)))
1027 (setq newname (expand-file-name tem (file-name-directory newname)))
1028 (setq count (1+ count))))
1031 (defun make-temp-file (prefix &optional dir-flag suffix)
1032 "Create a temporary file.
1033 The returned file name (created by appending some random characters at the end
1034 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1035 is guaranteed to point to a newly created empty file.
1036 You can then use `write-region' to write new data into the file.
1038 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1040 If SUFFIX is non-nil, add that at the end of the file name."
1041 (let ((umask (default-file-modes))
1045 ;; Create temp files with strict access rights. It's easy to
1046 ;; loosen them later, whereas it's impossible to close the
1047 ;; time-window of loose permissions otherwise.
1048 (set-default-file-modes ?\700)
1049 (while (condition-case ()
1053 (if (zerop (length prefix))
1054 (file-name-as-directory
1055 temporary-file-directory)
1056 (expand-file-name prefix
1057 temporary-file-directory))))
1059 (setq file (concat file suffix)))
1061 (make-directory file)
1062 (write-region "" nil file nil 'silent nil 'excl))
1064 (file-already-exists t))
1065 ;; the file was somehow created by someone else between
1066 ;; `make-temp-name' and `write-region', let's try again.
1070 (set-default-file-modes umask))))
1072 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1073 "Change the encoding of FILE's name from CODING to NEW-CODING.
1074 The value is a new name of FILE.
1075 Signals a `file-already-exists' error if a file of the new name
1076 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1077 is non-nil. A number as fourth arg means request confirmation if
1078 the new name already exists. This is what happens in interactive
1081 (let ((default-coding (or file-name-coding-system
1082 default-file-name-coding-system))
1083 (filename (read-file-name "Recode filename: " nil nil t))
1084 from-coding to-coding)
1085 (if (and default-coding
1086 ;; We provide the default coding only when it seems that
1087 ;; the filename is correctly decoded by the default
1089 (let ((charsets (find-charset-string filename)))
1090 (and (not (memq 'eight-bit-control charsets))
1091 (not (memq 'eight-bit-graphic charsets)))))
1092 (setq from-coding (read-coding-system
1093 (format "Recode filename %s from (default %s): "
1094 filename default-coding)
1096 (setq from-coding (read-coding-system
1097 (format "Recode filename %s from: " filename))))
1099 ;; We provide the default coding only when a user is going to
1100 ;; change the encoding not from the default coding.
1101 (if (eq from-coding default-coding)
1102 (setq to-coding (read-coding-system
1103 (format "Recode filename %s from %s to: "
1104 filename from-coding)))
1105 (setq to-coding (read-coding-system
1106 (format "Recode filename %s from %s to (default %s): "
1107 filename from-coding default-coding)
1109 (list filename from-coding to-coding)))
1111 (let* ((default-coding (or file-name-coding-system
1112 default-file-name-coding-system))
1113 ;; FILE should have been decoded by DEFAULT-CODING.
1114 (encoded (encode-coding-string file default-coding))
1115 (newname (decode-coding-string encoded coding))
1116 (new-encoded (encode-coding-string newname new-coding))
1117 ;; Suppress further encoding.
1118 (file-name-coding-system nil)
1119 (default-file-name-coding-system nil)
1120 (locale-coding-system nil))
1121 (rename-file encoded new-encoded ok-if-already-exists)
1124 (defcustom confirm-nonexistent-file-or-buffer 'after-completion
1125 "Whether confirmation is requested before visiting a new file or buffer.
1126 If nil, confirmation is not requested.
1127 If the value is `after-completion', confirmation is only
1128 requested if the user called `minibuffer-complete' right before
1129 `minibuffer-complete-and-exit'.
1130 Any other non-nil value means to request confirmation.
1132 This affects commands like `switch-to-buffer' and `find-file'."
1135 :type '(choice (other :tag "Always" t)
1136 (const :tag "After completion" after-completion)
1137 (const :tag "Never" nil)))
1139 (defun confirm-nonexistent-file-or-buffer ()
1140 "Whether to request confirmation before visiting a new file or buffer.
1141 The variable `confirm-nonexistent-file-or-buffer' determines the
1142 return value, which may be passed as the REQUIRE-MATCH arg to
1143 `read-buffer' or `find-file-read-args'."
1144 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1145 'confirm-after-completion)
1146 (confirm-nonexistent-file-or-buffer
1150 (defun read-buffer-to-switch (prompt)
1151 "Read the name of a buffer to switch to and return as a string.
1152 It is intended for `switch-to-buffer' family of commands since they
1153 need to omit the name of current buffer from the list of completions
1154 and default values."
1155 (let ((rbts-completion-table (internal-complete-buffer-except)))
1156 (minibuffer-with-setup-hook
1157 (lambda () (setq minibuffer-completion-table rbts-completion-table))
1158 (read-buffer prompt (other-buffer (current-buffer))
1159 (confirm-nonexistent-file-or-buffer)))))
1161 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
1162 "Select the buffer specified by BUFFER-OR-NAME in another window.
1163 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1164 nil. Return the buffer switched to.
1166 If called interactively, prompt for the buffer name using the
1167 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1168 determines whether to request confirmation before creating a new
1171 If BUFFER-OR-NAME is a string and does not identify an existing
1172 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1173 nil, switch to the buffer returned by `other-buffer'.
1175 Optional second argument NORECORD non-nil means do not put this
1176 buffer at the front of the list of recently selected ones.
1178 This uses the function `display-buffer' as a subroutine; see its
1179 documentation for additional customization information."
1181 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1182 (let ((pop-up-windows t)
1183 same-window-buffer-names same-window-regexps)
1184 (pop-to-buffer buffer-or-name t norecord)))
1186 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
1187 "Switch to buffer BUFFER-OR-NAME in another frame.
1188 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1189 nil. Return the buffer switched to.
1191 If called interactively, prompt for the buffer name using the
1192 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1193 determines whether to request confirmation before creating a new
1196 If BUFFER-OR-NAME is a string and does not identify an existing
1197 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1198 nil, switch to the buffer returned by `other-buffer'.
1200 Optional second arg NORECORD non-nil means do not put this
1201 buffer at the front of the list of recently selected ones.
1203 This uses the function `display-buffer' as a subroutine; see its
1204 documentation for additional customization information."
1206 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1207 (let ((pop-up-frames t)
1208 same-window-buffer-names same-window-regexps)
1209 (pop-to-buffer buffer-or-name t norecord)))
1211 (defun display-buffer-other-frame (buffer)
1212 "Display buffer BUFFER in another frame.
1213 This uses the function `display-buffer' as a subroutine; see
1214 its documentation for additional customization information."
1215 (interactive "BDisplay buffer in other frame: ")
1216 (let ((pop-up-frames t)
1217 same-window-buffer-names same-window-regexps
1218 (old-window (selected-window))
1220 (setq new-window (display-buffer buffer t))
1221 ;; This may have been here in order to prevent the new frame from hiding
1222 ;; the old frame. But it does more harm than good.
1223 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1224 ;;(lower-frame (window-frame new-window))
1226 ;; This may have been here in order to make sure the old-frame gets the
1227 ;; focus. But not only can it cause an annoying flicker, with some
1228 ;; window-managers it just makes the window invisible, with no easy
1229 ;; way to recover it. --Stef
1230 ;;(make-frame-invisible (window-frame old-window))
1231 ;;(make-frame-visible (window-frame old-window))
1234 (defvar find-file-default nil
1235 "Used within `find-file-read-args'.")
1237 (defmacro minibuffer-with-setup-hook (fun &rest body)
1238 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1239 BODY should use the minibuffer at most once.
1240 Recursive uses of the minibuffer will not be affected."
1241 (declare (indent 1) (debug t))
1242 (let ((hook (make-symbol "setup-hook")))
1246 ;; Clear out this hook so it does not interfere
1247 ;; with any recursive minibuffer usage.
1248 (remove-hook 'minibuffer-setup-hook ,hook)
1252 (add-hook 'minibuffer-setup-hook ,hook)
1254 (remove-hook 'minibuffer-setup-hook ,hook)))))
1256 (defun find-file-read-args (prompt mustmatch)
1257 (list (let ((find-file-default
1258 (and buffer-file-name
1259 (abbreviate-file-name buffer-file-name))))
1260 (minibuffer-with-setup-hook
1261 (lambda () (setq minibuffer-default find-file-default))
1262 (read-file-name prompt nil default-directory mustmatch)))
1265 (defun find-file (filename &optional wildcards)
1266 "Edit file FILENAME.
1267 Switch to a buffer visiting file FILENAME,
1268 creating one if none already exists.
1269 Interactively, the default if you just type RET is the current directory,
1270 but the visited file name is available through the minibuffer history:
1271 type M-n to pull it into the minibuffer.
1273 You can visit files on remote machines by specifying something
1274 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1275 also visit local files as a different user by specifying
1276 /sudo::FILE for the file name.
1277 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1278 manual, for more about this.
1280 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1281 expand wildcards (if any) and visit multiple files. You can
1282 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1284 To visit a file without any kind of conversion and without
1285 automatically choosing a major mode, use \\[find-file-literally]."
1287 (find-file-read-args "Find file: "
1288 (confirm-nonexistent-file-or-buffer)))
1289 (let ((value (find-file-noselect filename nil nil wildcards)))
1291 (mapcar 'switch-to-buffer (nreverse value))
1292 (switch-to-buffer value))))
1294 (defun find-file-other-window (filename &optional wildcards)
1295 "Edit file FILENAME, in another window.
1297 Like \\[find-file] (which see), but creates a new window or reuses
1298 an existing one. See the function `display-buffer'.
1300 Interactively, the default if you just type RET is the current directory,
1301 but the visited file name is available through the minibuffer history:
1302 type M-n to pull it into the minibuffer.
1304 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1305 expand wildcards (if any) and visit multiple files."
1307 (find-file-read-args "Find file in other window: "
1308 (confirm-nonexistent-file-or-buffer)))
1309 (let ((value (find-file-noselect filename nil nil wildcards)))
1312 (setq value (nreverse value))
1313 (cons (switch-to-buffer-other-window (car value))
1314 (mapcar 'switch-to-buffer (cdr value))))
1315 (switch-to-buffer-other-window value))))
1317 (defun find-file-other-frame (filename &optional wildcards)
1318 "Edit file FILENAME, in another frame.
1320 Like \\[find-file] (which see), but creates a new frame or reuses
1321 an existing one. See the function `display-buffer'.
1323 Interactively, the default if you just type RET is the current directory,
1324 but the visited file name is available through the minibuffer history:
1325 type M-n to pull it into the minibuffer.
1327 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1328 expand wildcards (if any) and visit multiple files."
1330 (find-file-read-args "Find file in other frame: "
1331 (confirm-nonexistent-file-or-buffer)))
1332 (let ((value (find-file-noselect filename nil nil wildcards)))
1335 (setq value (nreverse value))
1336 (cons (switch-to-buffer-other-frame (car value))
1337 (mapcar 'switch-to-buffer (cdr value))))
1338 (switch-to-buffer-other-frame value))))
1340 (defun find-file-existing (filename)
1341 "Edit the existing file FILENAME.
1342 Like \\[find-file], but only allow a file that exists, and do not allow
1343 file names with wildcards."
1344 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1345 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1346 (error "%s does not exist" filename)
1347 (find-file filename)
1350 (defun find-file-read-only (filename &optional wildcards)
1351 "Edit file FILENAME but don't allow changes.
1352 Like \\[find-file], but marks buffer as read-only.
1353 Use \\[toggle-read-only] to permit editing."
1355 (find-file-read-args "Find file read-only: "
1356 (confirm-nonexistent-file-or-buffer)))
1357 (unless (or (and wildcards find-file-wildcards
1358 (not (string-match "\\`/:" filename))
1359 (string-match "[[*?]" filename))
1360 (file-exists-p filename))
1361 (error "%s does not exist" filename))
1362 (let ((value (find-file filename wildcards)))
1363 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1364 (if (listp value) value (list value)))
1367 (defun find-file-read-only-other-window (filename &optional wildcards)
1368 "Edit file FILENAME in another window but don't allow changes.
1369 Like \\[find-file-other-window], but marks buffer as read-only.
1370 Use \\[toggle-read-only] to permit editing."
1372 (find-file-read-args "Find file read-only other window: "
1373 (confirm-nonexistent-file-or-buffer)))
1374 (unless (or (and wildcards find-file-wildcards
1375 (not (string-match "\\`/:" filename))
1376 (string-match "[[*?]" filename))
1377 (file-exists-p filename))
1378 (error "%s does not exist" filename))
1379 (let ((value (find-file-other-window filename wildcards)))
1380 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1381 (if (listp value) value (list value)))
1384 (defun find-file-read-only-other-frame (filename &optional wildcards)
1385 "Edit file FILENAME in another frame but don't allow changes.
1386 Like \\[find-file-other-frame], but marks buffer as read-only.
1387 Use \\[toggle-read-only] to permit editing."
1389 (find-file-read-args "Find file read-only other frame: "
1390 (confirm-nonexistent-file-or-buffer)))
1391 (unless (or (and wildcards find-file-wildcards
1392 (not (string-match "\\`/:" filename))
1393 (string-match "[[*?]" filename))
1394 (file-exists-p filename))
1395 (error "%s does not exist" filename))
1396 (let ((value (find-file-other-frame filename wildcards)))
1397 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1398 (if (listp value) value (list value)))
1401 (defun find-alternate-file-other-window (filename &optional wildcards)
1402 "Find file FILENAME as a replacement for the file in the next window.
1403 This command does not select that window.
1405 See \\[find-file] for the possible forms of the FILENAME argument.
1407 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1408 expand wildcards (if any) and replace the file with multiple files."
1410 (save-selected-window
1412 (let ((file buffer-file-name)
1416 (setq file-name (file-name-nondirectory file)
1417 file-dir (file-name-directory file)))
1418 (list (read-file-name
1419 "Find alternate file: " file-dir nil nil file-name)
1422 (find-file-other-window filename wildcards)
1423 (save-selected-window
1425 (find-alternate-file filename wildcards))))
1427 (defun find-alternate-file (filename &optional wildcards)
1428 "Find file FILENAME, select its buffer, kill previous buffer.
1429 If the current buffer now contains an empty file that you just visited
1430 \(presumably by mistake), use this command to visit the file you really want.
1432 See \\[find-file] for the possible forms of the FILENAME argument.
1434 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1435 expand wildcards (if any) and replace the file with multiple files.
1437 If the current buffer is an indirect buffer, or the base buffer
1438 for one or more indirect buffers, the other buffer(s) are not
1441 (let ((file buffer-file-name)
1445 (setq file-name (file-name-nondirectory file)
1446 file-dir (file-name-directory file)))
1447 (list (read-file-name
1448 "Find alternate file: " file-dir nil nil file-name)
1450 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1452 (when (and (buffer-modified-p) (buffer-file-name))
1453 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1455 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1458 (let ((obuf (current-buffer))
1459 (ofile buffer-file-name)
1460 (onum buffer-file-number)
1461 (odir dired-directory)
1462 (otrue buffer-file-truename)
1463 (oname (buffer-name)))
1464 (if (get-buffer " **lose**")
1465 (kill-buffer " **lose**"))
1466 (rename-buffer " **lose**")
1470 ;; This prevents us from finding the same buffer
1471 ;; if we specified the same file again.
1472 (setq buffer-file-name nil)
1473 (setq buffer-file-number nil)
1474 (setq buffer-file-truename nil)
1475 ;; Likewise for dired buffers.
1476 (setq dired-directory nil)
1477 (find-file filename wildcards))
1478 (when (eq obuf (current-buffer))
1479 ;; This executes if find-file gets an error
1480 ;; and does not really find anything.
1481 ;; We put things back as they were.
1482 ;; If find-file actually finds something, we kill obuf below.
1483 (setq buffer-file-name ofile)
1484 (setq buffer-file-number onum)
1485 (setq buffer-file-truename otrue)
1486 (setq dired-directory odir)
1488 (rename-buffer oname)))
1489 (unless (eq (current-buffer) obuf)
1490 (with-current-buffer obuf
1491 ;; We already asked; don't ask again.
1492 (let ((kill-buffer-query-functions))
1493 (kill-buffer obuf))))))
1495 (defun create-file-buffer (filename)
1496 "Create a suitably named buffer for visiting FILENAME, and return it.
1497 FILENAME (sans directory) is used unchanged if that name is free;
1498 otherwise a string <2> or <3> or ... is appended to get an unused name.
1499 Spaces at the start of FILENAME (sans directory) are removed."
1500 (let ((lastname (file-name-nondirectory filename)))
1501 (if (string= lastname "")
1502 (setq lastname filename))
1504 (string-match "^ *\\(.*\\)" lastname)
1505 (generate-new-buffer (match-string 1 lastname)))))
1507 (defun generate-new-buffer (name)
1508 "Create and return a buffer with a name based on NAME.
1509 Choose the buffer's name using `generate-new-buffer-name'."
1510 (get-buffer-create (generate-new-buffer-name name)))
1512 (defcustom automount-dir-prefix "^/tmp_mnt/"
1513 "Regexp to match the automounter prefix in a directory name."
1517 (defvar abbreviated-home-dir nil
1518 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1520 (defun abbreviate-file-name (filename)
1521 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1522 This also substitutes \"~\" for the user's home directory (unless the
1523 home directory is a root directory) and removes automounter prefixes
1524 \(see the variable `automount-dir-prefix')."
1525 ;; Get rid of the prefixes added by the automounter.
1527 (if (and automount-dir-prefix
1528 (string-match automount-dir-prefix filename)
1529 (file-exists-p (file-name-directory
1530 (substring filename (1- (match-end 0))))))
1531 (setq filename (substring filename (1- (match-end 0)))))
1532 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1533 ;; To fix this right, we need a `file-name-case-sensitive-p'
1534 ;; function, but we don't have that yet, so just guess.
1535 (let ((case-fold-search
1536 (memq system-type '(ms-dos windows-nt darwin cygwin))))
1537 ;; If any elt of directory-abbrev-alist matches this name,
1538 ;; abbreviate accordingly.
1539 (dolist (dir-abbrev directory-abbrev-alist)
1540 (if (string-match (car dir-abbrev) filename)
1542 (concat (cdr dir-abbrev)
1543 (substring filename (match-end 0))))))
1544 ;; Compute and save the abbreviated homedir name.
1545 ;; We defer computing this until the first time it's needed, to
1546 ;; give time for directory-abbrev-alist to be set properly.
1547 ;; We include a slash at the end, to avoid spurious matches
1548 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1549 (or abbreviated-home-dir
1550 (setq abbreviated-home-dir
1551 (let ((abbreviated-home-dir "$foo"))
1552 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1555 ;; If FILENAME starts with the abbreviated homedir,
1556 ;; make it start with `~' instead.
1557 (if (and (string-match abbreviated-home-dir filename)
1558 ;; If the home dir is just /, don't change it.
1559 (not (and (= (match-end 0) 1)
1560 (= (aref filename 0) ?/)))
1561 ;; MS-DOS root directories can come with a drive letter;
1562 ;; Novell Netware allows drive letters beyond `Z:'.
1563 (not (and (or (eq system-type 'ms-dos)
1564 (eq system-type 'cygwin)
1565 (eq system-type 'windows-nt))
1567 (string-match "^[a-zA-`]:/$" filename)))))
1570 (match-string 1 filename)
1571 (substring filename (match-end 0)))))
1574 (defcustom find-file-not-true-dirname-list nil
1575 "List of logical names for which visiting shouldn't save the true dirname."
1576 :type '(repeat (string :tag "Name"))
1579 (defun find-buffer-visiting (filename &optional predicate)
1580 "Return the buffer visiting file FILENAME (a string).
1581 This is like `get-file-buffer', except that it checks for any buffer
1582 visiting the same file, possibly under a different name.
1583 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1584 and others are ignored.
1585 If there is no such live buffer, return nil."
1586 (let ((predicate (or predicate #'identity))
1587 (truename (abbreviate-file-name (file-truename filename))))
1588 (or (let ((buf (get-file-buffer filename)))
1589 (when (and buf (funcall predicate buf)) buf))
1590 (let ((list (buffer-list)) found)
1591 (while (and (not found) list)
1593 (set-buffer (car list))
1594 (if (and buffer-file-name
1595 (string= buffer-file-truename truename)
1596 (funcall predicate (current-buffer)))
1597 (setq found (car list))))
1598 (setq list (cdr list)))
1600 (let* ((attributes (file-attributes truename))
1601 (number (nthcdr 10 attributes))
1602 (list (buffer-list)) found)
1603 (and buffer-file-numbers-unique
1604 (car-safe number) ;Make sure the inode is not just nil.
1605 (while (and (not found) list)
1606 (with-current-buffer (car list)
1607 (if (and buffer-file-name
1608 (equal buffer-file-number number)
1609 ;; Verify this buffer's file number
1610 ;; still belongs to its file.
1611 (file-exists-p buffer-file-name)
1612 (equal (file-attributes buffer-file-truename)
1614 (funcall predicate (current-buffer)))
1615 (setq found (car list))))
1616 (setq list (cdr list))))
1619 (defcustom find-file-wildcards t
1620 "Non-nil means file-visiting commands should handle wildcards.
1621 For example, if you specify `*.c', that would visit all the files
1622 whose names match the pattern."
1627 (defcustom find-file-suppress-same-file-warnings nil
1628 "Non-nil means suppress warning messages for symlinked files.
1629 When nil, Emacs prints a warning when visiting a file that is already
1630 visited, but with a different name. Setting this option to t
1631 suppresses this warning."
1636 (defcustom large-file-warning-threshold 10000000
1637 "Maximum size of file above which a confirmation is requested.
1638 When nil, never request confirmation."
1642 :type '(choice integer (const :tag "Never request confirmation" nil)))
1644 (defun abort-if-file-too-large (size op-type)
1645 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1646 OP-TYPE specifies the file operation being performed (for message to user)."
1647 (when (and large-file-warning-threshold size
1648 (> size large-file-warning-threshold)
1650 (format "File %s is large (%dMB), really %s? "
1651 (file-name-nondirectory filename)
1652 (/ size 1048576) op-type))))
1655 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1656 "Read file FILENAME into a buffer and return the buffer.
1657 If a buffer exists visiting FILENAME, return that one, but
1658 verify that the file has not changed since visited or saved.
1659 The buffer is not selected, just returned to the caller.
1660 Optional second arg NOWARN non-nil means suppress any warning messages.
1661 Optional third arg RAWFILE non-nil means the file is read literally.
1662 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1663 and visit all the matching files. When wildcards are actually
1664 used and expanded, return a list of buffers that are visiting
1667 (abbreviate-file-name
1668 (expand-file-name filename)))
1669 (if (file-directory-p filename)
1670 (or (and find-file-run-dired
1671 (run-hook-with-args-until-success
1672 'find-directory-functions
1673 (if find-file-visit-truename
1674 (abbreviate-file-name (file-truename filename))
1676 (error "%s is a directory" filename))
1679 (not (string-match "\\`/:" filename))
1680 (string-match "[[*?]" filename))
1681 (let ((files (condition-case nil
1682 (file-expand-wildcards filename t)
1683 (error (list filename))))
1684 (find-file-wildcards nil))
1686 (find-file-noselect filename)
1687 (mapcar #'find-file-noselect files)))
1688 (let* ((buf (get-file-buffer filename))
1689 (truename (abbreviate-file-name (file-truename filename)))
1690 (attributes (file-attributes truename))
1691 (number (nthcdr 10 attributes))
1692 ;; Find any buffer for a file which has same truename.
1693 (other (and (not buf) (find-buffer-visiting filename))))
1694 ;; Let user know if there is a buffer with the same truename.
1698 find-file-suppress-same-file-warnings
1699 (string-equal filename (buffer-file-name other))
1700 (message "%s and %s are the same file"
1701 filename (buffer-file-name other)))
1702 ;; Optionally also find that buffer.
1703 (if (or find-file-existing-other-name find-file-visit-truename)
1705 ;; Check to see if the file looks uncommonly large.
1706 (when (not (or buf nowarn))
1707 (abort-if-file-too-large (nth 7 attributes) "open"))
1709 ;; We are using an existing buffer.
1712 (verify-visited-file-modtime buf)
1713 (cond ((not (file-exists-p filename))
1714 (setq nonexistent t)
1715 (message "File %s no longer exists!" filename))
1716 ;; Certain files should be reverted automatically
1717 ;; if they have changed on disk and not in the buffer.
1718 ((and (not (buffer-modified-p buf))
1719 (let ((tail revert-without-query)
1722 (if (string-match (car tail) filename)
1724 (setq tail (cdr tail)))
1726 (with-current-buffer buf
1727 (message "Reverting file %s..." filename)
1729 (message "Reverting file %s...done" filename)))
1731 (if (string= (file-name-nondirectory filename)
1734 (if (buffer-modified-p buf)
1735 "File %s changed on disk. Discard your edits? "
1736 "File %s changed on disk. Reread from disk? ")
1737 (file-name-nondirectory filename))
1739 (if (buffer-modified-p buf)
1740 "File %s changed on disk. Discard your edits in %s? "
1741 "File %s changed on disk. Reread from disk into %s? ")
1742 (file-name-nondirectory filename)
1743 (buffer-name buf))))
1744 (with-current-buffer buf
1745 (revert-buffer t t)))))
1746 (with-current-buffer buf
1748 ;; Check if a formerly read-only file has become
1749 ;; writable and vice versa, but if the buffer agrees
1750 ;; with the new state of the file, that is ok too.
1751 (let ((read-only (not (file-writable-p buffer-file-name))))
1752 (unless (or nonexistent
1753 (eq read-only buffer-file-read-only)
1754 (eq read-only buffer-read-only))
1757 (format "File %s is %s on disk. Change buffer mode? "
1759 (if read-only "read-only" "writable"))))
1760 (y-or-n-p question)))
1761 (setq buffer-read-only read-only)))
1762 (setq buffer-file-read-only read-only))
1764 (when (and (not (eq (not (null rawfile))
1765 (not (null find-file-literally))))
1767 ;; It is confusing to ask whether to visit
1768 ;; non-literally if they have the file in
1770 (not (eq major-mode 'hexl-mode)))
1771 (if (buffer-modified-p)
1775 "The file %s is already visited normally,
1776 and you have edited the buffer. Now you have asked to visit it literally,
1777 meaning no coding system handling, format conversion, or local variables.
1778 Emacs can only visit a file in one way at a time.
1780 Do you want to save the file, and visit it literally instead? "
1781 "The file %s is already visited literally,
1782 meaning no coding system handling, format conversion, or local variables.
1783 You have edited the buffer. Now you have asked to visit the file normally,
1784 but Emacs can only visit a file in one way at a time.
1786 Do you want to save the file, and visit it normally instead? ")
1787 (file-name-nondirectory filename)))
1790 (find-file-noselect-1 buf filename nowarn
1791 rawfile truename number))
1796 Do you want to discard your changes, and visit the file literally now? "
1798 Do you want to discard your changes, and visit the file normally now? ")))
1799 (find-file-noselect-1 buf filename nowarn
1800 rawfile truename number)
1801 (error (if rawfile "File already visited non-literally"
1802 "File already visited literally"))))
1806 "The file %s is already visited normally.
1807 You have asked to visit it literally,
1808 meaning no coding system decoding, format conversion, or local variables.
1809 But Emacs can only visit a file in one way at a time.
1811 Do you want to revisit the file literally now? "
1812 "The file %s is already visited literally,
1813 meaning no coding system decoding, format conversion, or local variables.
1814 You have asked to visit it normally,
1815 but Emacs can only visit a file in one way at a time.
1817 Do you want to revisit the file normally now? ")
1818 (file-name-nondirectory filename)))
1819 (find-file-noselect-1 buf filename nowarn
1820 rawfile truename number)
1821 (error (if rawfile "File already visited non-literally"
1822 "File already visited literally"))))))
1823 ;; Return the buffer we are using.
1825 ;; Create a new buffer.
1826 (setq buf (create-file-buffer filename))
1827 ;; find-file-noselect-1 may use a different buffer.
1828 (find-file-noselect-1 buf filename nowarn
1829 rawfile truename number))))))
1831 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1833 (with-current-buffer buf
1834 (kill-local-variable 'find-file-literally)
1835 ;; Needed in case we are re-visiting the file with a different
1836 ;; text representation.
1837 (kill-local-variable 'buffer-file-coding-system)
1838 (kill-local-variable 'cursor-type)
1839 (let ((inhibit-read-only t))
1841 (and (default-value 'enable-multibyte-characters)
1843 (set-buffer-multibyte t))
1846 (let ((inhibit-read-only t))
1847 (insert-file-contents-literally filename t))
1849 (when (and (file-exists-p filename)
1850 (not (file-readable-p filename)))
1852 (signal 'file-error (list "File is not readable"
1854 ;; Unconditionally set error
1857 (let ((inhibit-read-only t))
1858 (insert-file-contents filename t))
1860 (when (and (file-exists-p filename)
1861 (not (file-readable-p filename)))
1863 (signal 'file-error (list "File is not readable"
1865 ;; Run find-file-not-found-functions until one returns non-nil.
1866 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1867 ;; If they fail too, set error.
1869 ;; Record the file's truename, and maybe use that as visited name.
1870 (if (equal filename buffer-file-name)
1871 (setq buffer-file-truename truename)
1872 (setq buffer-file-truename
1873 (abbreviate-file-name (file-truename buffer-file-name))))
1874 (setq buffer-file-number number)
1875 (if find-file-visit-truename
1876 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1877 ;; Set buffer's default directory to that of the file.
1878 (setq default-directory (file-name-directory buffer-file-name))
1879 ;; Turn off backup files for certain file names. Since
1880 ;; this is a permanent local, the major mode won't eliminate it.
1881 (and backup-enable-predicate
1882 (not (funcall backup-enable-predicate buffer-file-name))
1884 (make-local-variable 'backup-inhibited)
1885 (setq backup-inhibited t)))
1888 (set-buffer-multibyte nil)
1889 (setq buffer-file-coding-system 'no-conversion)
1890 (set-buffer-major-mode buf)
1891 (make-local-variable 'find-file-literally)
1892 (setq find-file-literally t))
1893 (after-find-file error (not nowarn)))
1896 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1897 "Like `insert-file-contents', but only reads in the file literally.
1898 A buffer may be modified in several ways after reading into the buffer,
1899 to Emacs features such as format decoding, character code
1900 conversion, `find-file-hook', automatic uncompression, etc.
1902 This function ensures that none of these modifications will take place."
1903 (let ((format-alist nil)
1904 (after-insert-file-functions nil)
1905 (coding-system-for-read 'no-conversion)
1906 (coding-system-for-write 'no-conversion)
1907 (find-buffer-file-type-function
1908 (if (fboundp 'find-buffer-file-type)
1909 (symbol-function 'find-buffer-file-type)
1911 (inhibit-file-name-handlers
1912 (append '(jka-compr-handler image-file-handler epa-file-handler)
1913 inhibit-file-name-handlers))
1914 (inhibit-file-name-operation 'insert-file-contents))
1917 (fset 'find-buffer-file-type (lambda (filename) t))
1918 (insert-file-contents filename visit beg end replace))
1919 (if find-buffer-file-type-function
1920 (fset 'find-buffer-file-type find-buffer-file-type-function)
1921 (fmakunbound 'find-buffer-file-type)))))
1923 (defun insert-file-1 (filename insert-func)
1924 (if (file-directory-p filename)
1925 (signal 'file-error (list "Opening input file" "file is a directory"
1927 ;; Check whether the file is uncommonly large
1928 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert")
1929 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1930 #'buffer-modified-p))
1931 (tem (funcall insert-func filename)))
1932 (push-mark (+ (point) (car (cdr tem))))
1934 (message "File %s already visited and modified in buffer %s"
1935 filename (buffer-name buffer)))))
1937 (defun insert-file-literally (filename)
1938 "Insert contents of file FILENAME into buffer after point with no conversion.
1940 This function is meant for the user to run interactively.
1941 Don't call it from programs! Use `insert-file-contents-literally' instead.
1942 \(Its calling sequence is different; see its documentation)."
1943 (interactive "*fInsert file literally: ")
1944 (insert-file-1 filename #'insert-file-contents-literally))
1946 (defvar find-file-literally nil
1947 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1948 This is a permanent local.")
1949 (put 'find-file-literally 'permanent-local t)
1951 (defun find-file-literally (filename)
1952 "Visit file FILENAME with no conversion of any kind.
1953 Format conversion and character code conversion are both disabled,
1954 and multibyte characters are disabled in the resulting buffer.
1955 The major mode used is Fundamental mode regardless of the file name,
1956 and local variable specifications in the file are ignored.
1957 Automatic uncompression and adding a newline at the end of the
1958 file due to `require-final-newline' is also disabled.
1960 You cannot absolutely rely on this function to result in
1961 visiting the file literally. If Emacs already has a buffer
1962 which is visiting the file, you get the existing buffer,
1963 regardless of whether it was created literally or not.
1965 In a Lisp program, if you want to be sure of accessing a file's
1966 contents literally, you should create a temporary buffer and then read
1967 the file contents into it using `insert-file-contents-literally'."
1968 (interactive "FFind file literally: ")
1969 (switch-to-buffer (find-file-noselect filename nil t)))
1971 (defvar after-find-file-from-revert-buffer nil)
1973 (defun after-find-file (&optional error warn noauto
1974 after-find-file-from-revert-buffer
1976 "Called after finding a file and by the default revert function.
1977 Sets buffer mode, parses local variables.
1978 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1979 error in reading the file. WARN non-nil means warn if there
1980 exists an auto-save file more recent than the visited file.
1981 NOAUTO means don't mess with auto-save mode.
1982 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1983 means this call was from `revert-buffer'.
1984 Fifth arg NOMODES non-nil means don't alter the file's modes.
1985 Finishes by calling the functions in `find-file-hook'
1986 unless NOMODES is non-nil."
1987 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1994 ((and error (file-attributes buffer-file-name))
1995 (setq buffer-read-only t)
1996 "File exists, but cannot be read")
1997 ((not buffer-read-only)
1999 ;; No need to warn if buffer is auto-saved
2000 ;; under the name of the visited file.
2001 (not (and buffer-file-name
2002 auto-save-visited-file-name))
2003 (file-newer-than-file-p (or buffer-auto-save-file-name
2004 (make-auto-save-file-name))
2006 (format "%s has auto save data; consider M-x recover-this-file"
2007 (file-name-nondirectory buffer-file-name))
2008 (setq not-serious t)
2009 (if error "(New file)" nil)))
2011 (setq not-serious t)
2012 "Note: file is write protected")
2013 ((file-attributes (directory-file-name default-directory))
2014 "File not found and directory write-protected")
2015 ((file-exists-p (file-name-directory buffer-file-name))
2016 (setq buffer-read-only nil))
2018 (setq buffer-read-only nil)
2019 "Use M-x make-directory RET RET to create the directory and its parents"))))
2022 (or not-serious (sit-for 1 t))))
2023 (when (and auto-save-default (not noauto))
2024 (auto-save-mode t)))
2025 ;; Make people do a little extra work (C-x C-q)
2026 ;; before altering a backup file.
2027 (when (backup-file-name-p buffer-file-name)
2028 (setq buffer-read-only t))
2029 ;; When a file is marked read-only,
2030 ;; make the buffer read-only even if root is looking at it.
2031 (when (and (file-modes (buffer-file-name))
2032 (zerop (logand (file-modes (buffer-file-name)) #o222)))
2033 (setq buffer-read-only t))
2035 (when (and view-read-only view-mode)
2036 (view-mode-disable))
2038 ;; If requested, add a newline at the end of the file.
2039 (and (memq require-final-newline '(visit visit-save))
2040 (> (point-max) (point-min))
2041 (/= (char-after (1- (point-max))) ?\n)
2042 (not (and (eq selective-display t)
2043 (= (char-after (1- (point-max))) ?\r)))
2045 (goto-char (point-max))
2047 (when (and buffer-read-only
2049 (not (eq (get major-mode 'mode-class) 'special)))
2051 (run-hooks 'find-file-hook)))
2053 (defmacro report-errors (format &rest body)
2054 "Eval BODY and turn any error into a FORMAT message.
2055 FORMAT can have a %s escape which will be replaced with the actual error.
2056 If `debug-on-error' is set, errors are not caught, so that you can
2058 Avoid using a large BODY since it is duplicated."
2059 (declare (debug t) (indent 1))
2064 (error (message ,format (prin1-to-string err))))))
2066 (defun normal-mode (&optional find-file)
2067 "Choose the major mode for this buffer automatically.
2068 Also sets up any specified local variables of the file.
2069 Uses the visited file name, the -*- line, and the local variables spec.
2071 This function is called automatically from `find-file'. In that case,
2072 we may set up the file-specified mode and local variables,
2073 depending on the value of `enable-local-variables'.
2074 In addition, if `local-enable-local-variables' is nil, we do
2075 not set local variables (though we do notice a mode specified with -*-.)
2077 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2078 or from Lisp without specifying the optional argument FIND-FILE;
2079 in that case, this function acts as if `enable-local-variables' were t."
2081 (funcall (or default-major-mode 'fundamental-mode))
2082 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2083 (report-errors "File mode specification error: %s"
2085 (report-errors "File local-variables error: %s"
2086 (hack-local-variables)))
2087 ;; Turn font lock off and on, to make sure it takes account of
2088 ;; whatever file local variables are relevant to it.
2089 (when (and font-lock-mode
2090 ;; Font-lock-mode (now in font-core.el) can be ON when
2091 ;; font-lock.el still hasn't been loaded.
2092 (boundp 'font-lock-keywords)
2093 (eq (car font-lock-keywords) t))
2094 (setq font-lock-keywords (cadr font-lock-keywords))
2097 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2098 (ucs-set-table-for-input)))
2100 (defcustom auto-mode-case-fold nil
2101 "Non-nil means to try second pass through `auto-mode-alist'.
2102 This means that if the first case-sensitive search through the alist fails
2103 to find a matching major mode, a second case-insensitive search is made.
2104 On systems with case-insensitive file names, this variable is ignored,
2105 since only a single case-insensitive search through the alist is made."
2110 (defvar auto-mode-alist
2111 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2112 ;; c++-mode, java-mode and more) are added through autoload
2113 ;; directives in that file. That way is discouraged since it
2114 ;; spreads out the definition of the initial value.
2117 (cons (purecopy (car elt)) (cdr elt)))
2118 `(;; do this first, so that .html.pl is Polish html, not Perl
2119 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2120 ("\\.te?xt\\'" . text-mode)
2121 ("\\.[tT]e[xX]\\'" . tex-mode)
2122 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2123 ("\\.ltx\\'" . latex-mode)
2124 ("\\.dtx\\'" . doctex-mode)
2125 ("\\.org\\'" . org-mode)
2126 ("\\.el\\'" . emacs-lisp-mode)
2127 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2128 ("\\.l\\'" . lisp-mode)
2129 ("\\.li?sp\\'" . lisp-mode)
2130 ("\\.[fF]\\'" . fortran-mode)
2131 ("\\.for\\'" . fortran-mode)
2132 ("\\.p\\'" . pascal-mode)
2133 ("\\.pas\\'" . pascal-mode)
2134 ("\\.ad[abs]\\'" . ada-mode)
2135 ("\\.ad[bs].dg\\'" . ada-mode)
2136 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2137 ("Imakefile\\'" . makefile-imake-mode)
2138 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2139 ("\\.makepp\\'" . makefile-makepp-mode)
2140 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
2141 '(("\\.mk\\'" . makefile-bsdmake-mode)
2142 ("GNUmakefile\\'" . makefile-gmake-mode)
2143 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2144 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2145 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2146 ("\\.am\\'" . makefile-automake-mode)
2147 ;; Less common extensions come here
2148 ;; so more common ones above are found faster.
2149 ("\\.texinfo\\'" . texinfo-mode)
2150 ("\\.te?xi\\'" . texinfo-mode)
2151 ("\\.[sS]\\'" . asm-mode)
2152 ("\\.asm\\'" . asm-mode)
2153 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2154 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2155 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2156 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2157 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2158 ("\\.bash\\'" . sh-mode)
2159 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2160 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2161 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2162 ("\\.m?spec\\'" . sh-mode)
2163 ("\\.m[mes]\\'" . nroff-mode)
2164 ("\\.man\\'" . nroff-mode)
2165 ("\\.sty\\'" . latex-mode)
2166 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2167 ("\\.bbl\\'" . latex-mode)
2168 ("\\.bib\\'" . bibtex-mode)
2169 ("\\.sql\\'" . sql-mode)
2170 ("\\.m[4c]\\'" . m4-mode)
2171 ("\\.mf\\'" . metafont-mode)
2172 ("\\.mp\\'" . metapost-mode)
2173 ("\\.vhdl?\\'" . vhdl-mode)
2174 ("\\.article\\'" . text-mode)
2175 ("\\.letter\\'" . text-mode)
2176 ("\\.i?tcl\\'" . tcl-mode)
2177 ("\\.exp\\'" . tcl-mode)
2178 ("\\.itk\\'" . tcl-mode)
2179 ("\\.icn\\'" . icon-mode)
2180 ("\\.sim\\'" . simula-mode)
2181 ("\\.mss\\'" . scribe-mode)
2182 ("\\.f9[05]\\'" . f90-mode)
2183 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2184 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2185 ("\\.prolog\\'" . prolog-mode)
2186 ("\\.tar\\'" . tar-mode)
2187 ;; The list of archive file extensions should be in sync with
2188 ;; `auto-coding-alist' with `no-conversion' coding system.
2190 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2191 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2192 ("\\.\\(sx[dmicw]\\|od[fgpst]\\)\\'" . archive-mode) ; OpenOffice.org
2193 ("\\.\\(deb\\)\\'" . archive-mode) ; Debian packages.
2194 ;; Mailer puts message to be edited in
2195 ;; /tmp/Re.... or Message
2196 ("\\`/tmp/Re" . text-mode)
2197 ("/Message[0-9]*\\'" . text-mode)
2198 ("\\.zone\\'" . zone-mode)
2199 ;; some news reader is reported to use this
2200 ("\\`/tmp/fol/" . text-mode)
2201 ("\\.oak\\'" . scheme-mode)
2202 ("\\.sgml?\\'" . sgml-mode)
2203 ("\\.x[ms]l\\'" . xml-mode)
2204 ("\\.dtd\\'" . sgml-mode)
2205 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2206 ("\\.js\\'" . java-mode) ; javascript-mode would be better
2207 ("\\.[ds]?v\\'" . verilog-mode)
2208 ;; .emacs or .gnus or .viper following a directory delimiter in
2209 ;; Unix, MSDOG or VMS syntax.
2210 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2211 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2212 ;; _emacs following a directory delimiter
2214 ("[:/]_emacs\\'" . emacs-lisp-mode)
2215 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2216 ("\\.ml\\'" . lisp-mode)
2217 ;; Common Lisp ASDF package system.
2218 ("\\.asd\\'" . lisp-mode)
2219 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2220 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2221 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2222 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2223 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2224 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2225 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2226 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2227 ("BROWSE\\'" . ebrowse-tree-mode)
2228 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2229 ("#\\*mail\\*" . mail-mode)
2230 ("\\.g\\'" . antlr-mode)
2231 ("\\.ses\\'" . ses-mode)
2232 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2233 ("\\.docbook\\'" . sgml-mode)
2234 ("\\.com\\'" . dcl-mode)
2235 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2236 ;; Windows candidates may be opened case sensitively on Unix
2237 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2238 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2239 ("\\.ppd\\'" . conf-ppd-mode)
2240 ("java.+\\.conf\\'" . conf-javaprop-mode)
2241 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2242 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2243 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2244 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2245 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2246 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2247 ;; this has lower priority to avoid matching changelog.sgml etc.
2248 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2249 ;; either user's dot-files or under /etc or some such
2250 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2251 ;; alas not all ~/.*rc files are like this
2252 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2253 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2254 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2255 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2256 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2257 ;; this contains everything twice, with space and with colon :-(
2258 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2259 ;; Get rid of any trailing .n.m and try again.
2260 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2261 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2262 ;; Using mode nil rather than `ignore' would let the search continue
2263 ;; through this list (with the shortened name) rather than start over.
2264 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2265 ;; The following should come after the ChangeLog pattern
2266 ;; for the sake of ChangeLog.1, etc.
2267 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2268 ("\\.[1-9]\\'" . nroff-mode)
2269 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2270 "Alist of filename patterns vs corresponding major mode functions.
2271 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2272 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2273 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2274 mode function to use. FUNCTION will be called, unless it is nil.
2276 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2277 calling FUNCTION (if it's not nil), we delete the suffix that matched
2278 REGEXP and search the list again for another match.
2280 If the file name matches `inhibit-first-line-modes-regexps',
2281 then `auto-mode-alist' is not processed.
2283 The extensions whose FUNCTION is `archive-mode' should also
2284 appear in `auto-coding-alist' with `no-conversion' coding system.
2286 See also `interpreter-mode-alist', which detects executable script modes
2287 based on the interpreters they specify to run,
2288 and `magic-mode-alist', which determines modes based on file contents.")
2290 (defun conf-mode-maybe ()
2291 "Select Conf mode or XML mode according to start of file."
2295 (goto-char (point-min))
2296 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2300 (defvar interpreter-mode-alist
2301 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2302 ;; and pike-mode) are added through autoload directives in that
2303 ;; file. That way is discouraged since it spreads out the
2304 ;; definition of the initial value.
2307 (cons (purecopy (car l)) (cdr l)))
2308 '(("perl" . perl-mode)
2309 ("perl5" . perl-mode)
2310 ("miniperl" . perl-mode)
2312 ("wishx" . tcl-mode)
2314 ("tclsh" . tcl-mode)
2315 ("scm" . scheme-mode)
2335 ("tail" . text-mode)
2336 ("more" . text-mode)
2337 ("less" . text-mode)
2339 ("make" . makefile-gmake-mode) ; Debian uses this
2340 ("guile" . scheme-mode)
2341 ("clisp" . lisp-mode)))
2342 "Alist mapping interpreter names to major modes.
2343 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2344 Each element looks like (INTERPRETER . MODE).
2345 If INTERPRETER matches the name of the interpreter specified in the first line
2346 of a script, mode MODE is enabled.
2348 See also `auto-mode-alist'.")
2350 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2351 "List of regexps; if one matches a file name, don't look for `-*-'.")
2353 (defvar inhibit-first-line-modes-suffixes nil
2354 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2355 When checking `inhibit-first-line-modes-regexps', we first discard
2356 from the end of the file name anything that matches one of these regexps.")
2358 (defvar auto-mode-interpreter-regexp
2359 "#![ \t]?\\([^ \t\n]*\
2360 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2361 "Regexp matching interpreters, for file mode determination.
2362 This regular expression is matched against the first line of a file
2363 to determine the file's mode in `set-auto-mode'. If it matches, the file
2364 is assumed to be interpreted by the interpreter matched by the second group
2365 of the regular expression. The mode is then determined as the mode
2366 associated with that interpreter in `interpreter-mode-alist'.")
2368 (defvar magic-mode-alist nil
2369 "Alist of buffer beginnings vs. corresponding major mode functions.
2370 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2371 After visiting a file, if REGEXP matches the text at the beginning of the
2372 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2373 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2376 If FUNCTION is nil, then it is not called. (That is a way of saying
2377 \"allow `auto-mode-alist' to decide for these files.\")")
2378 (put 'magic-mode-alist 'risky-local-variable t)
2380 (defvar magic-fallback-mode-alist
2381 `((image-type-auto-detected-p . image-mode)
2382 ;; The < comes before the groups (but the first) to reduce backtracking.
2383 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2384 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2385 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2386 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2387 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2389 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2390 "[Hh][Tt][Mm][Ll]"))
2392 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2393 ;; These two must come after html, because they are more general:
2394 ("<\\?xml " . xml-mode)
2395 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2396 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2397 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2400 ("# xmcd " . conf-unix-mode))
2401 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2402 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2403 After visiting a file, if REGEXP matches the text at the beginning of the
2404 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2405 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2406 have not specified a mode for this file.
2408 If FUNCTION is nil, then it is not called.")
2409 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2411 (defvar magic-mode-regexp-match-limit 4000
2412 "Upper limit on `magic-mode-alist' regexp matches.
2413 Also applies to `magic-fallback-mode-alist'.")
2415 (defun set-auto-mode (&optional keep-mode-if-same)
2416 "Select major mode appropriate for current buffer.
2418 To find the right major mode, this function checks for a -*- mode tag,
2419 checks if it uses an interpreter listed in `interpreter-mode-alist',
2420 matches the buffer beginning against `magic-mode-alist',
2421 compares the filename against the entries in `auto-mode-alist',
2422 then matches the buffer beginning against `magic-fallback-mode-alist'.
2424 It does not check for the `mode:' local variable in the
2425 Local Variables section of the file; for that, use `hack-local-variables'.
2427 If `enable-local-variables' is nil, this function does not check for a
2430 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2431 set the major mode only if that would change it. In other words
2432 we don't actually set it to the same mode the buffer already has."
2433 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2434 (let (end done mode modes)
2435 ;; Find a -*- mode tag
2437 (goto-char (point-min))
2438 (skip-chars-forward " \t\n")
2439 (and enable-local-variables
2440 (setq end (set-auto-mode-1))
2441 (if (save-excursion (search-forward ":" end t))
2442 ;; Find all specifications for the `mode:' variable
2443 ;; and execute them left to right.
2444 (while (let ((case-fold-search t))
2445 (or (and (looking-at "mode:")
2446 (goto-char (match-end 0)))
2447 (re-search-forward "[ \t;]mode:" end t)))
2448 (skip-chars-forward " \t")
2449 (let ((beg (point)))
2450 (if (search-forward ";" end t)
2453 (skip-chars-backward " \t")
2454 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2456 ;; Simple -*-MODE-*- case.
2457 (push (intern (concat (downcase (buffer-substring (point) end))
2460 ;; If we found modes to use, invoke them now, outside the save-excursion.
2463 (dolist (mode (nreverse modes))
2464 (if (not (functionp mode))
2465 (message "Ignoring unknown mode `%s'" mode)
2467 (or (set-auto-mode-0 mode keep-mode-if-same)
2468 ;; continuing would call minor modes again, toggling them off
2469 (throw 'nop nil))))))
2470 ;; If we didn't, look for an interpreter specified in the first line.
2471 ;; As a special case, allow for things like "#!/bin/env perl", which
2472 ;; finds the interpreter anywhere in $PATH.
2474 (setq mode (save-excursion
2475 (goto-char (point-min))
2476 (if (looking-at auto-mode-interpreter-regexp)
2479 ;; Map interpreter name to a mode, signalling we're done at the
2481 done (assoc (file-name-nondirectory mode)
2482 interpreter-mode-alist))
2483 ;; If we found an interpreter mode to use, invoke it now.
2485 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2486 ;; Next try matching the buffer beginning against magic-mode-alist.
2488 (if (setq done (save-excursion
2489 (goto-char (point-min))
2491 (narrow-to-region (point-min)
2493 (+ (point-min) magic-mode-regexp-match-limit)))
2494 (assoc-default nil magic-mode-alist
2498 (looking-at re)))))))
2499 (set-auto-mode-0 done keep-mode-if-same)))
2500 ;; Next compare the filename against the entries in auto-mode-alist.
2502 (if buffer-file-name
2503 (let ((name buffer-file-name)
2504 (remote-id (file-remote-p buffer-file-name)))
2505 ;; Remove remote file name identification.
2506 (when (and (stringp remote-id)
2507 (string-match (regexp-quote remote-id) name))
2508 (setq name (substring name (match-end 0))))
2509 ;; Remove backup-suffixes from file name.
2510 (setq name (file-name-sans-versions name))
2512 ;; Find first matching alist entry.
2514 (if (memq system-type '(windows-nt cygwin))
2515 ;; System is case-insensitive.
2516 (let ((case-fold-search t))
2517 (assoc-default name auto-mode-alist
2519 ;; System is case-sensitive.
2521 ;; First match case-sensitively.
2522 (let ((case-fold-search nil))
2523 (assoc-default name auto-mode-alist
2525 ;; Fallback to case-insensitive match.
2526 (and auto-mode-case-fold
2527 (let ((case-fold-search t))
2528 (assoc-default name auto-mode-alist
2533 (setq mode (car mode)
2534 name (substring name 0 (match-beginning 0)))
2537 (set-auto-mode-0 mode keep-mode-if-same)
2539 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2541 (if (setq done (save-excursion
2542 (goto-char (point-min))
2544 (narrow-to-region (point-min)
2546 (+ (point-min) magic-mode-regexp-match-limit)))
2547 (assoc-default nil magic-fallback-mode-alist
2551 (looking-at re)))))))
2552 (set-auto-mode-0 done keep-mode-if-same)))))
2554 ;; When `keep-mode-if-same' is set, we are working on behalf of
2555 ;; set-visited-file-name. In that case, if the major mode specified is the
2556 ;; same one we already have, don't actually reset it. We don't want to lose
2557 ;; minor modes such as Font Lock.
2558 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2559 "Apply MODE and return it.
2560 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2561 any aliases and compared to current major mode. If they are the
2562 same, do nothing and return nil."
2563 (unless (and keep-mode-if-same
2564 (eq (indirect-function mode)
2565 (indirect-function major-mode)))
2570 (defun set-auto-mode-1 ()
2571 "Find the -*- spec in the buffer.
2572 Call with point at the place to start searching from.
2573 If one is found, set point to the beginning
2574 and return the position of the end.
2575 Otherwise, return nil; point may be changed."
2578 ;; Don't look for -*- if this file name matches any
2579 ;; of the regexps in inhibit-first-line-modes-regexps.
2580 (let ((temp inhibit-first-line-modes-regexps)
2581 (name (if buffer-file-name
2582 (file-name-sans-versions buffer-file-name)
2584 (while (let ((sufs inhibit-first-line-modes-suffixes))
2585 (while (and sufs (not (string-match (car sufs) name)))
2586 (setq sufs (cdr sufs)))
2588 (setq name (substring name 0 (match-beginning 0))))
2590 (not (string-match (car temp) name)))
2591 (setq temp (cdr temp)))
2594 (search-forward "-*-" (line-end-position
2595 ;; If the file begins with "#!"
2596 ;; (exec interpreter magic), look
2597 ;; for mode frobs in the first two
2598 ;; lines. You cannot necessarily
2599 ;; put them in the first line of
2600 ;; such a file without screwing up
2601 ;; the interpreter invocation.
2602 ;; The same holds for
2604 ;; in man pages (preprocessor
2605 ;; magic for the `man' program).
2606 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2608 (skip-chars-forward " \t")
2610 (search-forward "-*-" (line-end-position) t))
2613 (skip-chars-backward " \t")
2618 ;;; Handling file local variables
2620 (defvar ignored-local-variables
2621 '(ignored-local-variables safe-local-variable-values
2622 file-local-variables-alist)
2623 "Variables to be ignored in a file's local variable spec.")
2625 (defvar hack-local-variables-hook nil
2626 "Normal hook run after processing a file's local variables specs.
2627 Major modes can use this to examine user-specified local variables
2628 in order to initialize other data structure based on them.")
2630 (defcustom safe-local-variable-values nil
2631 "List variable-value pairs that are considered safe.
2632 Each element is a cons cell (VAR . VAL), where VAR is a variable
2633 symbol and VAL is a value that is considered safe."
2637 (defcustom safe-local-eval-forms '((add-hook 'write-file-hooks 'time-stamp))
2638 "Expressions that are considered safe in an `eval:' local variable.
2639 Add expressions to this list if you want Emacs to evaluate them, when
2640 they appear in an `eval' local variable specification, without first
2641 asking you for confirmation."
2644 :type '(repeat sexp))
2646 ;; Risky local variables:
2647 (mapc (lambda (var) (put var 'risky-local-variable t))
2650 buffer-auto-save-file-name
2652 buffer-file-truename
2654 dabbrev-case-fold-search
2655 dabbrev-case-replace
2657 default-text-properties
2660 enable-local-variables
2664 file-name-handler-alist
2671 ignored-local-variables
2673 imenu-generic-expression
2680 minor-mode-map-alist
2681 minor-mode-overriding-map-alist
2682 mode-line-buffer-identification
2693 overriding-local-map
2694 overriding-terminal-local-map
2697 rmail-output-file-alist
2698 safe-local-variable-values
2699 safe-local-eval-forms
2700 save-some-buffers-action-alist
2701 special-display-buffer-names
2704 unread-command-events
2707 ;; Safe local variables:
2709 ;; For variables defined by major modes, the safety declarations can go into
2710 ;; the major mode's file, since that will be loaded before file variables are
2713 ;; For variables defined by minor modes, put the safety declarations in the
2714 ;; file defining the minor mode after the defcustom/defvar using an autoload
2717 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2719 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2720 ;; minor mode file may not be loaded yet.
2722 ;; For variables defined in the C source code the declaration should go here:
2724 (mapc (lambda (pair)
2725 (put (car pair) 'safe-local-variable (cdr pair)))
2726 '((buffer-read-only . booleanp) ;; C source code
2727 (default-directory . stringp) ;; C source code
2728 (fill-column . integerp) ;; C source code
2729 (indent-tabs-mode . booleanp) ;; C source code
2730 (left-margin . integerp) ;; C source code
2731 (no-update-autoloads . booleanp)
2732 (tab-width . integerp) ;; C source code
2733 (truncate-lines . booleanp))) ;; C source code
2735 (put 'c-set-style 'safe-local-eval-function t)
2737 (defvar file-local-variables-alist nil
2738 "Alist of file-local variable settings in the current buffer.
2739 Each element in this list has the form (VAR . VALUE), where VAR
2740 is a file-local variable (a symbol) and VALUE is the value
2741 specified. The actual value in the buffer may differ from VALUE,
2742 if it is changed by the major or minor modes, or by the user.")
2743 (make-variable-buffer-local 'file-local-variables-alist)
2745 (defvar before-hack-local-variables-hook nil
2746 "Normal hook run before setting file-local variables.
2747 It is called after checking for unsafe/risky variables and
2748 setting `file-local-variables-alist', and before applying the
2749 variables stored in `file-local-variables-alist'. A hook
2750 function is allowed to change the contents of this alist.
2752 This hook is called only if there is at least one file-local
2755 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2756 "Get confirmation before setting up local variable values.
2757 ALL-VARS is the list of all variables to be set up.
2758 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2759 RISKY-VARS is the list of those that are marked as risky.
2760 DIR-NAME is a directory name if these settings come from
2761 directory-local variables, or nil otherwise."
2764 (let ((name (or dir-name
2765 (if buffer-file-name
2766 (file-name-nondirectory buffer-file-name)
2767 (concat "buffer " (buffer-name)))))
2768 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2770 (save-window-excursion
2771 (let ((buf (get-buffer-create "*Local Variables*")))
2773 (set (make-local-variable 'cursor-type) nil)
2776 (insert "The local variables list in " name
2777 "\ncontains values that may not be safe (*)"
2779 ", and variables that are risky (**)."
2782 (insert "The local variables list in " name
2783 "\ncontains variables that are risky (**).")
2784 (insert "A local variables list is specified in " name ".")))
2785 (insert "\n\nDo you want to apply it? You can type
2786 y -- to apply the local variables list.
2787 n -- to ignore the local variables list.")
2790 ! -- to apply the local variables list, and permanently mark these
2791 values (*) as safe (in the future, they will be set automatically.)\n\n")
2793 (dolist (elt all-vars)
2794 (cond ((member elt unsafe-vars)
2796 ((member elt risky-vars)
2800 (princ (car elt) buf)
2802 ;; Make strings with embedded whitespace easier to read.
2803 (let ((print-escape-newlines t))
2804 (prin1 (cdr elt) buf))
2807 (format "Please type %s%s: "
2808 (if offer-save "y, n, or !" "y or n")
2809 (if (< (line-number-at-pos) (window-body-height))
2811 ", or C-v to scroll")))
2812 (goto-char (point-min))
2813 (let ((cursor-in-echo-area t)
2814 (executing-kbd-macro executing-kbd-macro)
2816 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2819 (message "%s" prompt)
2820 (setq char (read-event))
2822 (cond ((eq char ?\C-v)
2825 (error (goto-char (point-min)))))
2826 ;; read-event returns -1 if we are in a kbd
2827 ;; macro and there are no more events in the
2828 ;; macro. In that case, attempt to get an
2829 ;; event interactively.
2830 ((and executing-kbd-macro (= char -1))
2831 (setq executing-kbd-macro nil))
2832 (t (setq done (memq (downcase char) exit-chars)))))))
2833 (setq char (downcase char))
2834 (when (and offer-save (= char ?!) unsafe-vars)
2835 (dolist (elt unsafe-vars)
2836 (add-to-list 'safe-local-variable-values elt))
2837 ;; When this is called from desktop-restore-file-buffer,
2838 ;; coding-system-for-read may be non-nil. Reset it before
2839 ;; writing to .emacs.
2840 (if (or custom-file user-init-file)
2841 (let ((coding-system-for-read nil))
2842 (customize-save-variable
2843 'safe-local-variable-values
2844 safe-local-variable-values))))
2850 (defun hack-local-variables-prop-line (&optional mode-only)
2851 "Return local variables specified in the -*- line.
2852 Ignore any specification for `mode:' and `coding:';
2853 `set-auto-mode' should already have handled `mode:',
2854 `set-auto-coding' should already have handled `coding:'.
2856 If MODE-ONLY is non-nil, all we do is check whether the major
2857 mode is specified, returning t if it is specified. Otherwise,
2858 return an alist of elements (VAR . VAL), where VAR is a variable
2859 and VAL is the specified value."
2861 (goto-char (point-min))
2862 (let ((end (set-auto-mode-1))
2863 result mode-specified)
2864 ;; Parse the -*- line into the RESULT alist.
2865 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2868 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2869 ;; Simple form: "-*- MODENAME -*-". Already handled.
2870 (setq mode-specified t)
2873 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2874 ;; (last ";" is optional).
2875 (while (< (point) end)
2876 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2877 (error "Malformed -*- line"))
2878 (goto-char (match-end 0))
2879 ;; There used to be a downcase here,
2880 ;; but the manual didn't say so,
2881 ;; and people want to set var names that aren't all lc.
2882 (let ((key (intern (match-string 1)))
2883 (val (save-restriction
2884 (narrow-to-region (point) end)
2885 (read (current-buffer)))))
2886 ;; It is traditional to ignore
2887 ;; case when checking for `mode' in set-auto-mode,
2888 ;; so we must do that here as well.
2889 ;; That is inconsistent, but we're stuck with it.
2890 ;; The same can be said for `coding' in set-auto-coding.
2891 (or (and (equal (downcase (symbol-name key)) "mode")
2892 (setq mode-specified t))
2893 (equal (downcase (symbol-name key)) "coding")
2895 (push (cons (if (eq key 'eval)
2897 (indirect-variable key))
2900 (skip-chars-forward " \t;")))))
2906 (defun hack-local-variables-filter (variables dir-name)
2907 "Filter local variable settings, querying the user if necessary.
2908 VARIABLES is the alist of variable-value settings. This alist is
2909 filtered based on the values of `ignored-local-variables',
2910 `enable-local-eval', `enable-local-variables', and (if necessary)
2911 user interaction. The results are added to
2912 `file-local-variables-alist', without applying them.
2913 DIR-NAME is a directory name if these settings come from
2914 directory-local variables, or nil otherwise."
2915 ;; Strip any variables that are in `ignored-local-variables'.
2916 (dolist (ignored ignored-local-variables)
2917 (setq variables (assq-delete-all ignored variables)))
2918 ;; If `enable-local-eval' is nil, strip eval "variables".
2919 (if (null enable-local-eval)
2920 (setq variables (assq-delete-all 'eval variables)))
2921 (setq variables (nreverse variables))
2923 ;; Find those variables that we may want to save to
2924 ;; `safe-local-variable-values'.
2925 (let (risky-vars unsafe-vars)
2926 (dolist (elt variables)
2927 (let ((var (car elt))
2929 ;; Don't query about the fake variables.
2930 (or (memq var '(mode unibyte coding))
2932 (or (eq enable-local-eval t)
2933 (hack-one-local-variable-eval-safep
2934 (eval (quote val)))))
2935 (safe-local-variable-p var val)
2936 (and (risky-local-variable-p var val)
2937 (push elt risky-vars))
2938 (push elt unsafe-vars))))
2939 (if (eq enable-local-variables :safe)
2940 ;; If caller wants only safe variables, store only these.
2941 (dolist (elt variables)
2942 (unless (or (member elt unsafe-vars)
2943 (member elt risky-vars))
2944 (push elt file-local-variables-alist)))
2945 ;; Query, unless all are known safe or the user wants no
2947 (if (or (and (eq enable-local-variables t)
2950 (eq enable-local-variables :all)
2951 (hack-local-variables-confirm
2952 variables unsafe-vars risky-vars dir-name))
2953 (dolist (elt variables)
2954 (push elt file-local-variables-alist)))))))
2956 (defun hack-local-variables (&optional mode-only)
2957 "Parse and put into effect this buffer's local variables spec.
2958 If MODE-ONLY is non-nil, all we do is check whether the major mode
2959 is specified, returning t if it is specified."
2960 (let ((enable-local-variables
2961 (and local-enable-local-variables enable-local-variables))
2964 (setq file-local-variables-alist nil)
2965 (report-errors "Directory-local variables error: %s"
2966 (hack-dir-local-variables)))
2967 (when (or mode-only enable-local-variables)
2968 (setq result (hack-local-variables-prop-line mode-only))
2969 ;; Look for "Local variables:" line in last page.
2971 (goto-char (point-max))
2972 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2974 (when (let ((case-fold-search t))
2975 (search-forward "Local Variables:" nil t))
2976 (skip-chars-forward " \t")
2977 ;; suffix is what comes after "local variables:" in its line.
2978 ;; prefix is what comes before "local variables:" in its line.
2981 (regexp-quote (buffer-substring (point)
2982 (line-end-position)))
2985 (concat "^" (regexp-quote
2986 (buffer-substring (line-beginning-position)
2987 (match-beginning 0)))))
2991 (let ((startpos (point))
2993 (thisbuf (current-buffer)))
2995 (unless (let ((case-fold-search t))
2997 (concat prefix "[ \t]*End:[ \t]*" suffix)
2999 ;; This used to be an error, but really all it means is
3000 ;; that this may simply not be a local-variables section,
3001 ;; so just ignore it.
3002 (message "Local variables list is not properly terminated"))
3004 (setq endpos (point)))
3007 (insert-buffer-substring thisbuf startpos endpos)
3008 (goto-char (point-min))
3009 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3011 ;; Discard the prefix.
3012 (if (looking-at prefix)
3013 (delete-region (point) (match-end 0))
3014 (error "Local variables entry is missing the prefix"))
3016 ;; Discard the suffix.
3017 (if (looking-back suffix)
3018 (delete-region (match-beginning 0) (point))
3019 (error "Local variables entry is missing the suffix"))
3021 (goto-char (point-min))
3024 ;; Find the variable name; strip whitespace.
3025 (skip-chars-forward " \t")
3027 (skip-chars-forward "^:\n")
3028 (if (eolp) (error "Missing colon in local variables entry"))
3029 (skip-chars-backward " \t")
3030 (let* ((str (buffer-substring beg (point)))
3033 ;; Read the variable value.
3034 (skip-chars-forward "^:")
3036 (setq val (read (current-buffer)))
3040 (unless (eq var 'coding)
3042 (push (cons (if (eq var 'eval)
3044 (indirect-variable var))
3047 (forward-line 1))))))))
3048 ;; Now we've read all the local variables.
3049 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3050 (cond (mode-only result)
3051 ;; Otherwise, set the variables.
3052 (enable-local-variables
3053 (hack-local-variables-filter result nil)
3054 (when file-local-variables-alist
3055 (setq file-local-variables-alist
3056 (nreverse file-local-variables-alist))
3057 (run-hooks 'before-hack-local-variables-hook)
3058 (dolist (elt file-local-variables-alist)
3059 (hack-one-local-variable (car elt) (cdr elt))))
3060 (run-hooks 'hack-local-variables-hook)))))
3062 (defun safe-local-variable-p (sym val)
3063 "Non-nil if SYM is safe as a file-local variable with value VAL.
3064 It is safe if any of these conditions are met:
3066 * There is a matching entry (SYM . VAL) in the
3067 `safe-local-variable-values' user option.
3069 * The `safe-local-variable' property of SYM is a function that
3070 evaluates to a non-nil value with VAL as an argument."
3071 (or (member (cons sym val) safe-local-variable-values)
3072 (let ((safep (get sym 'safe-local-variable)))
3073 (and (functionp safep) (funcall safep val)))))
3075 (defun risky-local-variable-p (sym &optional ignored)
3076 "Non-nil if SYM could be dangerous as a file-local variable.
3077 It is dangerous if either of these conditions are met:
3079 * Its `risky-local-variable' property is non-nil.
3081 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3082 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3083 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3084 \"map-alist\", or \"bindat-spec\"."
3085 ;; If this is an alias, check the base name.
3087 (setq sym (indirect-variable sym))
3089 (or (get sym 'risky-local-variable)
3090 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3091 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3092 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3093 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3095 (defun hack-one-local-variable-quotep (exp)
3096 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3098 (defun hack-one-local-variable-constantp (exp)
3099 (or (and (not (symbolp exp)) (not (consp exp)))
3102 (hack-one-local-variable-quotep exp)))
3104 (defun hack-one-local-variable-eval-safep (exp)
3105 "Return t if it is safe to eval EXP when it is found in a file."
3106 (or (not (consp exp))
3107 ;; Detect certain `put' expressions.
3108 (and (eq (car exp) 'put)
3109 (hack-one-local-variable-quotep (nth 1 exp))
3110 (hack-one-local-variable-quotep (nth 2 exp))
3111 (let ((prop (nth 1 (nth 2 exp)))
3113 (cond ((memq prop '(lisp-indent-hook
3114 lisp-indent-function
3115 scheme-indent-function))
3116 ;; Only allow safe values (not functions).
3118 (and (hack-one-local-variable-quotep val)
3119 (eq (nth 1 val) 'defun))))
3120 ((eq prop 'edebug-form-spec)
3121 ;; Only allow indirect form specs.
3122 ;; During bootstrapping, edebug-basic-spec might not be
3124 (and (fboundp 'edebug-basic-spec)
3125 (hack-one-local-variable-quotep val)
3126 (edebug-basic-spec (nth 1 val)))))))
3127 ;; Allow expressions that the user requested.
3128 (member exp safe-local-eval-forms)
3129 ;; Certain functions can be allowed with safe arguments
3130 ;; or can specify verification functions to try.
3131 (and (symbolp (car exp))
3132 (let ((prop (get (car exp) 'safe-local-eval-function)))
3135 (dolist (arg (cdr exp))
3136 (unless (hack-one-local-variable-constantp arg)
3143 (dolist (function prop)
3144 (if (funcall function exp)
3148 (defun hack-one-local-variable (var val)
3149 "Set local variable VAR with value VAL.
3150 If VAR is `mode', call `VAL-mode' as a function unless it's
3151 already the major mode."
3152 (cond ((eq var 'mode)
3153 (let ((mode (intern (concat (downcase (symbol-name val))
3155 (unless (eq (indirect-function mode)
3156 (indirect-function major-mode))
3159 (save-excursion (eval val)))
3161 ;; Make sure the string has no text properties.
3162 ;; Some text properties can get evaluated in various ways,
3163 ;; so it is risky to put them on with a local variable list.
3165 (set-text-properties 0 (length val) nil val))
3166 (set (make-local-variable var) val))))
3168 ;;; Handling directory-local variables, aka project settings.
3170 (defvar dir-locals-class-alist '()
3171 "Alist mapping class names (symbols) to variable lists.")
3173 (defvar dir-locals-directory-alist '()
3174 "Alist mapping directory roots to variable classes.")
3176 (defsubst dir-locals-get-class-variables (class)
3177 "Return the variable list for CLASS."
3178 (cdr (assq class dir-locals-class-alist)))
3180 (defun dir-locals-collect-mode-variables (mode-variables variables)
3181 "Collect directory-local variables from MODE-VARIABLES.
3182 VARIABLES is the initial list of variables.
3183 Returns the new list."
3184 (dolist (pair mode-variables variables)
3185 (let* ((variable (car pair))
3187 (slot (assq variable variables)))
3190 ;; Need a new cons in case we setcdr later.
3191 (push (cons variable value) variables)))))
3193 (defun dir-locals-collect-variables (class-variables root variables)
3194 "Collect entries from CLASS-VARIABLES into VARIABLES.
3195 ROOT is the root directory of the project.
3196 Return the new variables list."
3197 (let* ((file-name (buffer-file-name))
3198 (sub-file-name (if file-name
3199 (substring file-name (length root)))))
3200 (dolist (entry class-variables variables)
3201 (let ((key (car entry)))
3204 ;; Don't include this in the previous condition, because we
3205 ;; want to filter all strings before the next condition.
3206 (when (and sub-file-name
3207 (>= (length sub-file-name) (length key))
3208 (string= key (substring sub-file-name 0 (length key))))
3209 (setq variables (dir-locals-collect-variables
3210 (cdr entry) root variables))))
3212 (derived-mode-p key))
3213 (setq variables (dir-locals-collect-mode-variables
3214 (cdr entry) variables))))))))
3216 (defun dir-locals-set-directory-class (directory class)
3217 "Declare that the DIRECTORY root is an instance of CLASS.
3218 DIRECTORY is the name of a directory, a string.
3219 CLASS is the name of a project class, a symbol.
3221 When a file beneath DIRECTORY is visited, the mode-specific
3222 variables from CLASS will be applied to the buffer. The variables
3223 for a class are defined using `dir-locals-set-class-variables'."
3224 (setq directory (file-name-as-directory (expand-file-name directory)))
3225 (unless (assq class dir-locals-class-alist)
3226 (error "No such class `%s'" (symbol-name class)))
3227 (push (cons directory class) dir-locals-directory-alist))
3229 (defun dir-locals-set-class-variables (class variables)
3230 "Map the type CLASS to a list of variable settings.
3231 CLASS is the project class, a symbol. VARIABLES is a list
3232 that declares directory-local variables for the class.
3233 An element in VARIABLES is either of the form:
3234 (MAJOR-MODE . ALIST)
3238 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3239 whose elements are of the form (VARIABLE . VALUE).
3241 In the second form, DIRECTORY is a directory name (a string), and
3242 LIST is a list of the form accepted by the function.
3244 When a file is visited, the file's class is found. A directory
3245 may be assigned a class using `dir-locals-set-directory-class'.
3246 Then variables are set in the file's buffer according to the
3247 class' LIST. The list is processed in order.
3249 * If the element is of the form (MAJOR-MODE . ALIST), and the
3250 buffer's major mode is derived from MAJOR-MODE (as determined
3251 by `derived-mode-p'), then all the variables in ALIST are
3252 applied. A MAJOR-MODE of nil may be used to match any buffer.
3253 `make-local-variable' is called for each variable before it is
3256 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3257 is an initial substring of the file's directory, then LIST is
3258 applied by recursively following these rules."
3259 (let ((elt (assq class dir-locals-class-alist)))
3261 (setcdr elt variables)
3262 (push (cons class variables) dir-locals-class-alist))))
3264 (defconst dir-locals-file ".dir-locals.el"
3265 "File that contains directory-local variables.
3266 It has to be constant to enforce uniform values
3267 across different environments and users.")
3269 (defun dir-locals-find-file (file)
3270 "Find the directory-local variables FILE.
3271 This searches upward in the directory tree.
3272 If a local variables file is found, the file name is returned.
3273 If the file is already registered, a cons from
3274 `dir-locals-directory-alist' is returned.
3275 Otherwise this returns nil."
3276 (setq file (expand-file-name file))
3277 (let ((locals-file (locate-dominating-file file dir-locals-file))
3279 ;; `locate-dominating-file' may have abbreviated the name.
3281 (setq locals-file (expand-file-name dir-locals-file locals-file)))
3282 (dolist (elt dir-locals-directory-alist)
3283 (when (and (eq t (compare-strings file nil (length (car elt))
3285 (> (length (car elt)) (length (car dir-elt))))
3286 (setq dir-elt elt)))
3287 (if (and locals-file dir-elt)
3288 (if (> (length (file-name-directory locals-file))
3289 (length (car dir-elt)))
3292 (or locals-file dir-elt))))
3294 (defun dir-locals-read-from-file (file)
3295 "Load a variables FILE and register a new class and instance.
3296 FILE is the name of the file holding the variables to apply.
3297 The new class name is the same as the directory in which FILE
3298 is found. Returns the new class name."
3300 ;; We should probably store the modtime of FILE and then
3301 ;; reload it whenever it changes.
3302 (insert-file-contents file)
3303 (let* ((dir-name (file-name-directory file))
3304 (class-name (intern dir-name))
3305 (variables (read (current-buffer))))
3306 (dir-locals-set-class-variables class-name variables)
3307 (dir-locals-set-directory-class dir-name class-name)
3310 (declare-function c-postprocess-file-styles "cc-mode" ())
3312 (defun hack-dir-local-variables ()
3313 "Read per-directory local variables for the current buffer.
3314 Store the directory-local variables in `file-local-variables-alist',
3315 without applying them."
3316 (when (and enable-local-variables
3318 (not (file-remote-p (buffer-file-name))))
3319 ;; Find the variables file.
3320 (let ((variables-file (dir-locals-find-file (buffer-file-name)))
3324 ((stringp variables-file)
3325 (setq dir-name (file-name-directory (buffer-file-name)))
3326 (setq class (dir-locals-read-from-file variables-file)))
3327 ((consp variables-file)
3328 (setq dir-name (car variables-file))
3329 (setq class (cdr variables-file))))
3332 (dir-locals-collect-variables
3333 (dir-locals-get-class-variables class) dir-name nil)))
3335 (hack-local-variables-filter variables dir-name)))))))
3338 (defcustom change-major-mode-with-file-name t
3339 "Non-nil means \\[write-file] should set the major mode from the file name.
3340 However, the mode will not be changed if
3341 \(1) a local variables list or the `-*-' line specifies a major mode, or
3342 \(2) the current major mode is a \"special\" mode,
3343 \ not suitable for ordinary files, or
3344 \(3) the new file name does not particularly specify any mode."
3346 :group 'editing-basics)
3348 (defun set-visited-file-name (filename &optional no-query along-with-file)
3349 "Change name of file visited in current buffer to FILENAME.
3350 This also renames the buffer to correspond to the new file.
3351 The next time the buffer is saved it will go in the newly specified file.
3352 FILENAME nil or an empty string means mark buffer as not visiting any file.
3353 Remember to delete the initial contents of the minibuffer
3354 if you wish to pass an empty string as the argument.
3356 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3357 confirmation in the case where another buffer is already visiting FILENAME.
3359 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3360 the old visited file has been renamed to the new name FILENAME."
3361 (interactive "FSet visited file name: ")
3362 (if (buffer-base-buffer)
3363 (error "An indirect buffer cannot visit a file"))
3367 (if (string-equal filename "")
3369 (expand-file-name filename))))
3372 (setq truename (file-truename filename))
3373 (if find-file-visit-truename
3374 (setq filename truename))))
3376 (let ((new-name (file-name-nondirectory filename)))
3377 (if (string= new-name "")
3378 (error "Empty file name"))))
3379 (let ((buffer (and filename (find-buffer-visiting filename))))
3380 (and buffer (not (eq buffer (current-buffer)))
3382 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3385 (or (equal filename buffer-file-name)
3387 (and filename (lock-buffer filename))
3389 (setq buffer-file-name filename)
3390 (if filename ; make buffer name reflect filename.
3391 (let ((new-name (file-name-nondirectory buffer-file-name)))
3392 (setq default-directory (file-name-directory buffer-file-name))
3393 ;; If new-name == old-name, renaming would add a spurious <2>
3394 ;; and it's considered as a feature in rename-buffer.
3395 (or (string= new-name (buffer-name))
3396 (rename-buffer new-name t))))
3397 (setq buffer-backed-up nil)
3399 (clear-visited-file-modtime))
3400 ;; Abbreviate the file names of the buffer.
3403 (setq buffer-file-truename (abbreviate-file-name truename))
3404 (if find-file-visit-truename
3405 (setq buffer-file-name truename))))
3406 (setq buffer-file-number
3408 (nthcdr 10 (file-attributes buffer-file-name))
3410 ;; write-file-functions is normally used for things like ftp-find-file
3411 ;; that visit things that are not local files as if they were files.
3412 ;; Changing to visit an ordinary local file instead should flush the hook.
3413 (kill-local-variable 'write-file-functions)
3414 (kill-local-variable 'local-write-file-hooks)
3415 (kill-local-variable 'revert-buffer-function)
3416 (kill-local-variable 'backup-inhibited)
3417 ;; If buffer was read-only because of version control,
3418 ;; that reason is gone now, so make it writable.
3420 (setq buffer-read-only nil))
3421 (kill-local-variable 'vc-mode)
3422 ;; Turn off backup files for certain file names.
3423 ;; Since this is a permanent local, the major mode won't eliminate it.
3424 (and buffer-file-name
3425 backup-enable-predicate
3426 (not (funcall backup-enable-predicate buffer-file-name))
3428 (make-local-variable 'backup-inhibited)
3429 (setq backup-inhibited t)))
3430 (let ((oauto buffer-auto-save-file-name))
3431 ;; If auto-save was not already on, turn it on if appropriate.
3432 (if (not buffer-auto-save-file-name)
3433 (and buffer-file-name auto-save-default
3435 ;; If auto save is on, start using a new name.
3436 ;; We deliberately don't rename or delete the old auto save
3437 ;; for the old visited file name. This is because perhaps
3438 ;; the user wants to save the new state and then compare with the
3439 ;; previous state from the auto save file.
3440 (setq buffer-auto-save-file-name
3441 (make-auto-save-file-name)))
3442 ;; Rename the old auto save file if any.
3443 (and oauto buffer-auto-save-file-name
3444 (file-exists-p oauto)
3445 (rename-file oauto buffer-auto-save-file-name t)))
3446 (and buffer-file-name
3447 (not along-with-file)
3448 (set-buffer-modified-p t))
3449 ;; Update the major mode, if the file name determines it.
3451 ;; Don't change the mode if it is special.
3452 (or (not change-major-mode-with-file-name)
3453 (get major-mode 'mode-class)
3454 ;; Don't change the mode if the local variable list specifies it.
3455 (hack-local-variables t)
3459 (defun write-file (filename &optional confirm)
3460 "Write current buffer into file FILENAME.
3461 This makes the buffer visit that file, and marks it as not modified.
3463 If you specify just a directory name as FILENAME, that means to use
3464 the default file name but in that directory. You can also yank
3465 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3467 If the buffer is not already visiting a file, the default file name
3468 for the output file is the buffer name.
3470 If optional second arg CONFIRM is non-nil, this function
3471 asks for confirmation before overwriting an existing file.
3472 Interactively, confirmation is required unless you supply a prefix argument."
3473 ;; (interactive "FWrite file: ")
3475 (list (if buffer-file-name
3476 (read-file-name "Write file: "
3478 (read-file-name "Write file: " default-directory
3480 (file-name-nondirectory (buffer-name))
3483 (not current-prefix-arg)))
3484 (or (null filename) (string-equal filename "")
3486 ;; If arg is just a directory,
3487 ;; use the default file name, but in that directory.
3488 (if (file-directory-p filename)
3489 (setq filename (concat (file-name-as-directory filename)
3490 (file-name-nondirectory
3491 (or buffer-file-name (buffer-name))))))
3493 (file-exists-p filename)
3494 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3495 (error "Canceled")))
3496 (set-visited-file-name filename (not confirm))))
3497 (set-buffer-modified-p t)
3498 ;; Make buffer writable if file is writable.
3499 (and buffer-file-name
3500 (file-writable-p buffer-file-name)
3501 (setq buffer-read-only nil))
3503 ;; It's likely that the VC status at the new location is different from
3504 ;; the one at the old location.
3505 (vc-find-file-hook))
3507 (defun backup-buffer ()
3508 "Make a backup of the disk file visited by the current buffer, if appropriate.
3509 This is normally done before saving the buffer the first time.
3511 A backup may be done by renaming or by copying; see documentation of
3512 variable `make-backup-files'. If it's done by renaming, then the file is
3513 no longer accessible under its old name.
3515 The value is non-nil after a backup was made by renaming.
3516 It has the form (MODES . BACKUPNAME).
3517 MODES is the result of `file-modes' on the original
3518 file; this means that the caller, after saving the buffer, should change
3519 the modes of the new file to agree with the old modes.
3520 BACKUPNAME is the backup file name, which is the old file renamed."
3521 (if (and make-backup-files (not backup-inhibited)
3522 (not buffer-backed-up)
3523 (file-exists-p buffer-file-name)
3524 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3526 (let ((real-file-name buffer-file-name)
3527 backup-info backupname targets setmodes)
3528 ;; If specified name is a symbolic link, chase it to the target.
3529 ;; Thus we make the backups in the directory where the real file is.
3530 (setq real-file-name (file-chase-links real-file-name))
3531 (setq backup-info (find-backup-file-name real-file-name)
3532 backupname (car backup-info)
3533 targets (cdr backup-info))
3534 ;; (if (file-directory-p buffer-file-name)
3535 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3538 (let ((delete-old-versions
3539 ;; If have old versions to maybe delete,
3540 ;; ask the user to confirm now, before doing anything.
3541 ;; But don't actually delete til later.
3543 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3544 (or delete-old-versions
3545 (y-or-n-p (format "Delete excess backup versions of %s? "
3547 (modes (file-modes buffer-file-name)))
3548 ;; Actually write the back up file.
3550 (if (or file-precious-flag
3551 ; (file-symlink-p buffer-file-name)
3553 ;; Don't rename a suid or sgid file.
3554 (and modes (< 0 (logand modes #o6000)))
3555 (not (file-writable-p (file-name-directory real-file-name)))
3556 (and backup-by-copying-when-linked
3557 (> (file-nlinks real-file-name) 1))
3558 (and (or backup-by-copying-when-mismatch
3559 (integerp backup-by-copying-when-privileged-mismatch))
3560 (let ((attr (file-attributes real-file-name)))
3561 (and (or backup-by-copying-when-mismatch
3562 (and (integerp (nth 2 attr))
3563 (integerp backup-by-copying-when-privileged-mismatch)
3564 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3566 (not (file-ownership-preserved-p real-file-name)))))))
3567 (backup-buffer-copy real-file-name backupname modes)
3568 ;; rename-file should delete old backup.
3569 (rename-file real-file-name backupname t)
3570 (setq setmodes (cons modes backupname)))
3572 ;; If trouble writing the backup, write it in ~.
3573 (setq backupname (expand-file-name
3574 (convert-standard-filename
3576 (message "Cannot write backup file; backing up in %s"
3579 (backup-buffer-copy real-file-name backupname modes)))
3580 (setq buffer-backed-up t)
3581 ;; Now delete the old versions, if desired.
3582 (if delete-old-versions
3585 (delete-file (car targets))
3587 (setq targets (cdr targets))))
3589 (file-error nil))))))
3591 (defun backup-buffer-copy (from-name to-name modes)
3592 (let ((umask (default-file-modes)))
3595 ;; Create temp files with strict access rights. It's easy to
3596 ;; loosen them later, whereas it's impossible to close the
3597 ;; time-window of loose permissions otherwise.
3598 (set-default-file-modes ?\700)
3599 (when (condition-case nil
3600 ;; Try to overwrite old backup first.
3601 (copy-file from-name to-name t t t)
3603 (while (condition-case nil
3605 (when (file-exists-p to-name)
3606 (delete-file to-name))
3607 (copy-file from-name to-name nil t t)
3609 (file-already-exists t))
3610 ;; The file was somehow created by someone else between
3611 ;; `delete-file' and `copy-file', so let's try again.
3612 ;; rms says "I think there is also a possible race
3613 ;; condition for making backup files" (emacs-devel 20070821).
3616 (set-default-file-modes umask)))
3618 (set-file-modes to-name (logand modes #o1777))))
3620 (defun file-name-sans-versions (name &optional keep-backup-version)
3621 "Return file NAME sans backup versions or strings.
3622 This is a separate procedure so your site-init or startup file can
3624 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3625 we do not remove backup version numbers, only true file version numbers."
3626 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3628 (funcall handler 'file-name-sans-versions name keep-backup-version)
3630 (if keep-backup-version
3632 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3633 (string-match "~\\'" name)
3636 (defun file-ownership-preserved-p (file)
3637 "Return t if deleting FILE and rewriting it would preserve the owner."
3638 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3640 (funcall handler 'file-ownership-preserved-p file)
3641 (let ((attributes (file-attributes file)))
3642 ;; Return t if the file doesn't exist, since it's true that no
3643 ;; information would be lost by an (attempted) delete and create.
3644 (or (null attributes)
3645 (= (nth 2 attributes) (user-uid)))))))
3647 (defun file-name-sans-extension (filename)
3648 "Return FILENAME sans final \"extension\".
3649 The extension, in a file name, is the part that follows the last `.',
3650 except that a leading `.', if any, doesn't count."
3652 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3654 (if (and (string-match "\\.[^.]*\\'" file)
3655 (not (eq 0 (match-beginning 0))))
3656 (if (setq directory (file-name-directory filename))
3657 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3658 ;; we don't want to expand it.
3659 (concat directory (substring file 0 (match-beginning 0)))
3660 (substring file 0 (match-beginning 0)))
3663 (defun file-name-extension (filename &optional period)
3664 "Return FILENAME's final \"extension\".
3665 The extension, in a file name, is the part that follows the last `.',
3666 excluding version numbers and backup suffixes,
3667 except that a leading `.', if any, doesn't count.
3668 Return nil for extensionless file names such as `foo'.
3669 Return the empty string for file names such as `foo.'.
3671 If PERIOD is non-nil, then the returned value includes the period
3672 that delimits the extension, and if FILENAME has no extension,
3675 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3676 (if (and (string-match "\\.[^.]*\\'" file)
3677 (not (eq 0 (match-beginning 0))))
3678 (substring file (+ (match-beginning 0) (if period 0 1)))
3682 (defcustom make-backup-file-name-function nil
3683 "A function to use instead of the default `make-backup-file-name'.
3684 A value of nil gives the default `make-backup-file-name' behavior.
3686 This could be buffer-local to do something special for specific
3687 files. If you define it, you may need to change `backup-file-name-p'
3688 and `file-name-sans-versions' too.
3690 See also `backup-directory-alist'."
3692 :type '(choice (const :tag "Default" nil)
3693 (function :tag "Your function")))
3695 (defcustom backup-directory-alist nil
3696 "Alist of filename patterns and backup directory names.
3697 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3698 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3699 relative or absolute. If it is absolute, so that all matching files
3700 are backed up into the same directory, the file names in this
3701 directory will be the full name of the file backed up with all
3702 directory separators changed to `!' to prevent clashes. This will not
3703 work correctly if your filesystem truncates the resulting name.
3705 For the common case of all backups going into one directory, the alist
3706 should contain a single element pairing \".\" with the appropriate
3709 If this variable is nil, or it fails to match a filename, the backup
3710 is made in the original file's directory.
3712 On MS-DOS filesystems without long names this variable is always
3715 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3716 (directory :tag "Backup directory name"))))
3718 (defun normal-backup-enable-predicate (name)
3719 "Default `backup-enable-predicate' function.
3720 Checks for files in `temporary-file-directory',
3721 `small-temporary-file-directory', and /tmp."
3722 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3724 ;; Directory is under temporary-file-directory.
3725 (and (not (eq comp t))
3726 (< comp (- (length temporary-file-directory)))))
3727 (let ((comp (compare-strings "/tmp" 0 nil
3729 ;; Directory is under /tmp.
3730 (and (not (eq comp t))
3731 (< comp (- (length "/tmp")))))
3732 (if small-temporary-file-directory
3733 (let ((comp (compare-strings small-temporary-file-directory
3736 ;; Directory is under small-temporary-file-directory.
3737 (and (not (eq comp t))
3738 (< comp (- (length small-temporary-file-directory)))))))))
3740 (defun make-backup-file-name (file)
3741 "Create the non-numeric backup file name for FILE.
3742 Normally this will just be the file's name with `~' appended.
3743 Customization hooks are provided as follows.
3745 If the variable `make-backup-file-name-function' is non-nil, its value
3746 should be a function which will be called with FILE as its argument;
3747 the resulting name is used.
3749 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3750 the documentation of that variable. If the directory for the backup
3751 doesn't exist, it is created."
3752 (if make-backup-file-name-function
3753 (funcall make-backup-file-name-function file)
3754 (if (and (eq system-type 'ms-dos)
3755 (not (msdos-long-file-names)))
3756 (let ((fn (file-name-nondirectory file)))
3757 (concat (file-name-directory file)
3758 (or (and (string-match "\\`[^.]+\\'" fn)
3759 (concat (match-string 0 fn) ".~"))
3760 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3761 (concat (match-string 0 fn) "~")))))
3762 (concat (make-backup-file-name-1 file) "~"))))
3764 (defun make-backup-file-name-1 (file)
3765 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3766 (let ((alist backup-directory-alist)
3767 elt backup-directory abs-backup-directory)
3769 (setq elt (pop alist))
3770 (if (string-match (car elt) file)
3771 (setq backup-directory (cdr elt)
3773 ;; If backup-directory is relative, it should be relative to the
3774 ;; file's directory. By expanding explicitly here, we avoid
3775 ;; depending on default-directory.
3776 (if backup-directory
3777 (setq abs-backup-directory
3778 (expand-file-name backup-directory
3779 (file-name-directory file))))
3780 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3782 (make-directory abs-backup-directory 'parents)
3783 (file-error (setq backup-directory nil
3784 abs-backup-directory nil))))
3785 (if (null backup-directory)
3787 (if (file-name-absolute-p backup-directory)
3789 (when (memq system-type '(windows-nt ms-dos cygwin))
3790 ;; Normalize DOSish file names: downcase the drive
3791 ;; letter, if any, and replace the leading "x:" with
3793 (or (file-name-absolute-p file)
3794 (setq file (expand-file-name file))) ; make defaults explicit
3795 ;; Replace any invalid file-name characters (for the
3796 ;; case of backing up remote files).
3797 (setq file (expand-file-name (convert-standard-filename file)))
3798 (if (eq (aref file 1) ?:)
3799 (setq file (concat "/"
3801 (char-to-string (downcase (aref file 0)))
3802 (if (eq (aref file 2) ?/)
3805 (substring file 2)))))
3806 ;; Make the name unique by substituting directory
3807 ;; separators. It may not really be worth bothering about
3808 ;; doubling `!'s in the original name...
3810 (subst-char-in-string
3812 (replace-regexp-in-string "!" "!!" file))
3814 (expand-file-name (file-name-nondirectory file)
3815 (file-name-as-directory abs-backup-directory))))))
3817 (defun backup-file-name-p (file)
3818 "Return non-nil if FILE is a backup file name (numeric or not).
3819 This is a separate function so you can redefine it for customization.
3820 You may need to redefine `file-name-sans-versions' as well."
3821 (string-match "~\\'" file))
3823 (defvar backup-extract-version-start)
3825 ;; This is used in various files.
3826 ;; The usage of backup-extract-version-start is not very clean,
3827 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3828 (defun backup-extract-version (fn)
3829 "Given the name of a numeric backup file, FN, return the backup number.
3830 Uses the free variable `backup-extract-version-start', whose value should be
3831 the index in the name where the version number begins."
3832 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
3833 (= (match-beginning 0) backup-extract-version-start))
3834 (string-to-number (substring fn backup-extract-version-start -1))
3837 (defun find-backup-file-name (fn)
3838 "Find a file name for a backup file FN, and suggestions for deletions.
3839 Value is a list whose car is the name for the backup file
3840 and whose cdr is a list of old versions to consider deleting now.
3841 If the value is nil, don't make a backup.
3842 Uses `backup-directory-alist' in the same way as does
3843 `make-backup-file-name'."
3844 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3845 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3847 (funcall handler 'find-backup-file-name fn)
3848 (if (or (eq version-control 'never)
3849 ;; We don't support numbered backups on plain MS-DOS
3850 ;; when long file names are unavailable.
3851 (and (eq system-type 'ms-dos)
3852 (not (msdos-long-file-names))))
3853 (list (make-backup-file-name fn))
3854 (let* ((basic-name (make-backup-file-name-1 fn))
3855 (base-versions (concat (file-name-nondirectory basic-name)
3857 (backup-extract-version-start (length base-versions))
3859 (number-to-delete 0)
3860 possibilities deserve-versions-p versions)
3862 (setq possibilities (file-name-all-completions
3864 (file-name-directory basic-name))
3865 versions (sort (mapcar #'backup-extract-version
3868 high-water-mark (apply 'max 0 versions)
3869 deserve-versions-p (or version-control
3870 (> high-water-mark 0))
3871 number-to-delete (- (length versions)
3875 (file-error (setq possibilities nil)))
3876 (if (not deserve-versions-p)
3877 (list (make-backup-file-name fn))
3878 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3879 (if (and (> number-to-delete 0)
3880 ;; Delete nothing if there is overflow
3881 ;; in the number of versions to keep.
3882 (>= (+ kept-new-versions kept-old-versions -1) 0))
3884 (format "%s.~%d~" basic-name n))
3885 (let ((v (nthcdr kept-old-versions versions)))
3886 (rplacd (nthcdr (1- number-to-delete) v) ())
3889 (defun file-nlinks (filename)
3890 "Return number of names file FILENAME has."
3891 (car (cdr (file-attributes filename))))
3893 ;; (defun file-relative-name (filename &optional directory)
3894 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3895 ;; This function returns a relative file name which is equivalent to FILENAME
3896 ;; when used with that default directory as the default.
3897 ;; If this is impossible (which can happen on MSDOS and Windows
3898 ;; when the file name and directory use different drive names)
3899 ;; then it returns FILENAME."
3901 ;; (let ((fname (expand-file-name filename)))
3902 ;; (setq directory (file-name-as-directory
3903 ;; (expand-file-name (or directory default-directory))))
3904 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3905 ;; ;; drive names, they can't be relative, so return the absolute name.
3906 ;; (if (and (or (eq system-type 'ms-dos)
3907 ;; (eq system-type 'cygwin)
3908 ;; (eq system-type 'windows-nt))
3909 ;; (not (string-equal (substring fname 0 2)
3910 ;; (substring directory 0 2))))
3912 ;; (let ((ancestor ".")
3913 ;; (fname-dir (file-name-as-directory fname)))
3914 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3915 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3916 ;; (setq directory (file-name-directory (substring directory 0 -1))
3917 ;; ancestor (if (equal ancestor ".")
3919 ;; (concat "../" ancestor))))
3920 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3921 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3922 ;; ;; We matched within FNAME's directory part.
3923 ;; ;; Add the rest of FNAME onto ANCESTOR.
3924 ;; (let ((rest (substring fname (match-end 0))))
3925 ;; (if (and (equal ancestor ".")
3926 ;; (not (equal rest "")))
3927 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3929 ;; (concat (file-name-as-directory ancestor) rest)))
3930 ;; ;; We matched FNAME's directory equivalent.
3933 (defun file-relative-name (filename &optional directory)
3934 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3935 This function returns a relative file name which is equivalent to FILENAME
3936 when used with that default directory as the default.
3937 If FILENAME and DIRECTORY lie on different machines or on different drives
3938 on a DOS/Windows machine, it returns FILENAME in expanded form."
3941 (file-name-as-directory (expand-file-name (or directory
3942 default-directory))))
3943 (setq filename (expand-file-name filename))
3944 (let ((fremote (file-remote-p filename))
3945 (dremote (file-remote-p directory)))
3946 (if ;; Conditions for separate trees
3948 ;; Test for different drives on DOS/Windows
3950 ;; Should `cygwin' really be included here? --stef
3951 (memq system-type '(ms-dos cygwin windows-nt))
3952 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3953 ;; Test for different remote file system identification
3954 (not (equal fremote dremote)))
3956 (let ((ancestor ".")
3957 (filename-dir (file-name-as-directory filename)))
3960 (eq t (compare-strings filename-dir nil (length directory)
3961 directory nil nil case-fold-search))
3962 (eq t (compare-strings filename nil (length directory)
3963 directory nil nil case-fold-search))))
3964 (setq directory (file-name-directory (substring directory 0 -1))
3965 ancestor (if (equal ancestor ".")
3967 (concat "../" ancestor))))
3968 ;; Now ancestor is empty, or .., or ../.., etc.
3969 (if (eq t (compare-strings filename nil (length directory)
3970 directory nil nil case-fold-search))
3971 ;; We matched within FILENAME's directory part.
3972 ;; Add the rest of FILENAME onto ANCESTOR.
3973 (let ((rest (substring filename (length directory))))
3974 (if (and (equal ancestor ".") (not (equal rest "")))
3975 ;; But don't bother with ANCESTOR if it would give us `./'.
3977 (concat (file-name-as-directory ancestor) rest)))
3978 ;; We matched FILENAME's directory equivalent.
3981 (defun save-buffer (&optional args)
3982 "Save current buffer in visited file if modified.
3983 Variations are described below.
3985 By default, makes the previous version into a backup file
3986 if previously requested or if this is the first save.
3987 Prefixed with one \\[universal-argument], marks this version
3988 to become a backup when the next save is done.
3989 Prefixed with two \\[universal-argument]'s,
3990 unconditionally makes the previous version into a backup file.
3991 Prefixed with three \\[universal-argument]'s, marks this version
3992 to become a backup when the next save is done,
3993 and unconditionally makes the previous version into a backup file.
3995 With a numeric argument of 0, never make the previous version
3998 If a file's name is FOO, the names of its numbered backup versions are
3999 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4000 Numeric backups (rather than FOO~) will be made if value of
4001 `version-control' is not the atom `never' and either there are already
4002 numeric versions of the file being backed up, or `version-control' is
4004 We don't want excessive versions piling up, so there are variables
4005 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4006 and `kept-new-versions', which tells how many newest versions to keep.
4007 Defaults are 2 old versions and 2 new.
4008 `dired-kept-versions' controls dired's clean-directory (.) command.
4009 If `delete-old-versions' is nil, system will query user
4010 before trimming versions. Otherwise it does it silently.
4012 If `vc-make-backup-files' is nil, which is the default,
4013 no backup files are made for files managed by version control.
4014 (This is because the version control system itself records previous versions.)
4016 See the subroutine `basic-save-buffer' for more information."
4018 (let ((modp (buffer-modified-p))
4019 (large (> (buffer-size) 50000))
4020 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4021 (memq args '(16 64)))))
4022 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
4023 (if (and modp large (buffer-file-name))
4024 (message "Saving file %s..." (buffer-file-name)))
4026 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4028 (defun delete-auto-save-file-if-necessary (&optional force)
4029 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4030 Normally delete only if the file was written by this Emacs since
4031 the last real save, but optional arg FORCE non-nil means delete anyway."
4032 (and buffer-auto-save-file-name delete-auto-save-files
4033 (not (string= buffer-file-name buffer-auto-save-file-name))
4034 (or force (recent-auto-save-p))
4037 (delete-file buffer-auto-save-file-name)
4039 (set-buffer-auto-saved))))
4041 (defvar auto-save-hook nil
4042 "Normal hook run just before auto-saving.")
4044 (defcustom before-save-hook nil
4045 "Normal hook that is run before a buffer is saved to its file."
4046 :options '(copyright-update time-stamp)
4050 (defcustom after-save-hook nil
4051 "Normal hook that is run after a buffer is saved to its file."
4052 :options '(executable-make-buffer-file-executable-if-script-p)
4056 (defvar save-buffer-coding-system nil
4057 "If non-nil, use this coding system for saving the buffer.
4058 More precisely, use this coding system in place of the
4059 value of `buffer-file-coding-system', when saving the buffer.
4060 Calling `write-region' for any purpose other than saving the buffer
4061 will still use `buffer-file-coding-system'; this variable has no effect
4064 (make-variable-buffer-local 'save-buffer-coding-system)
4065 (put 'save-buffer-coding-system 'permanent-local t)
4067 (defun basic-save-buffer ()
4068 "Save the current buffer in its visited file, if it has been modified.
4069 The hooks `write-contents-functions' and `write-file-functions' get a chance
4070 to do the job of saving; if they do not, then the buffer is saved in
4071 the visited file in the usual way.
4072 Before and after saving the buffer, this function runs
4073 `before-save-hook' and `after-save-hook', respectively."
4075 (save-current-buffer
4076 ;; In an indirect buffer, save its base buffer instead.
4077 (if (buffer-base-buffer)
4078 (set-buffer (buffer-base-buffer)))
4079 (if (buffer-modified-p)
4080 (let ((recent-save (recent-auto-save-p))
4082 ;; If buffer has no file name, ask user for one.
4083 (or buffer-file-name
4086 (read-file-name "File to save in: ") nil)))
4087 (if (file-exists-p filename)
4088 (if (file-directory-p filename)
4089 ;; Signal an error if the user specified the name of an
4090 ;; existing directory.
4091 (error "%s is a directory" filename)
4092 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4094 (error "Canceled")))
4095 ;; Signal an error if the specified name refers to a
4096 ;; non-existing directory.
4097 (let ((dir (file-name-directory filename)))
4098 (unless (file-directory-p dir)
4099 (if (file-exists-p dir)
4100 (error "%s is not a directory" dir)
4101 (error "%s: no such directory" dir)))))
4102 (set-visited-file-name filename)))
4103 (or (verify-visited-file-modtime (current-buffer))
4104 (not (file-exists-p buffer-file-name))
4106 (format "%s has changed since visited or saved. Save anyway? "
4107 (file-name-nondirectory buffer-file-name)))
4108 (error "Save not confirmed"))
4112 (and (> (point-max) (point-min))
4113 (not find-file-literally)
4114 (/= (char-after (1- (point-max))) ?\n)
4115 (not (and (eq selective-display t)
4116 (= (char-after (1- (point-max))) ?\r)))
4117 (or (eq require-final-newline t)
4118 (eq require-final-newline 'visit-save)
4119 (and require-final-newline
4121 (format "Buffer %s does not end in newline. Add one? "
4124 (goto-char (point-max))
4126 ;; Support VC version backups.
4128 (run-hooks 'before-save-hook)
4129 (or (run-hook-with-args-until-success 'write-contents-functions)
4130 (run-hook-with-args-until-success 'local-write-file-hooks)
4131 (run-hook-with-args-until-success 'write-file-functions)
4132 ;; If a hook returned t, file is already "written".
4133 ;; Otherwise, write it the usual way now.
4134 (setq setmodes (basic-save-buffer-1)))
4135 ;; Now we have saved the current buffer. Let's make sure
4136 ;; that buffer-file-coding-system is fixed to what
4137 ;; actually used for saving by binding it locally.
4138 (if save-buffer-coding-system
4139 (setq save-buffer-coding-system last-coding-system-used)
4140 (setq buffer-file-coding-system last-coding-system-used))
4141 (setq buffer-file-number
4142 (nthcdr 10 (file-attributes buffer-file-name)))
4145 (set-file-modes buffer-file-name (car setmodes))
4147 ;; If the auto-save file was recent before this command,
4149 (delete-auto-save-file-if-necessary recent-save)
4150 ;; Support VC `implicit' locking.
4152 (run-hooks 'after-save-hook))
4153 (message "(No changes need to be saved)"))))
4155 ;; This does the "real job" of writing a buffer into its visited file
4156 ;; and making a backup file. This is what is normally done
4157 ;; but inhibited if one of write-file-functions returns non-nil.
4158 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4159 (defun basic-save-buffer-1 ()
4161 (if save-buffer-coding-system
4162 (let ((coding-system-for-write save-buffer-coding-system))
4163 (basic-save-buffer-2))
4164 (basic-save-buffer-2))
4165 (setq buffer-file-coding-system-explicit last-coding-system-used)))
4167 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4168 (defun basic-save-buffer-2 ()
4169 (let (tempsetmodes setmodes)
4170 (if (not (file-writable-p buffer-file-name))
4171 (let ((dir (file-name-directory buffer-file-name)))
4172 (if (not (file-directory-p dir))
4173 (if (file-exists-p dir)
4174 (error "%s is not a directory" dir)
4175 (error "%s: no such directory" dir))
4176 (if (not (file-exists-p buffer-file-name))
4177 (error "Directory %s write-protected" dir)
4179 (format "File %s is write-protected; try to save anyway? "
4180 (file-name-nondirectory
4182 (setq tempsetmodes t)
4183 (error "Attempt to save to a file which you aren't allowed to write"))))))
4184 (or buffer-backed-up
4185 (setq setmodes (backup-buffer)))
4186 (let* ((dir (file-name-directory buffer-file-name))
4187 (dir-writable (file-writable-p dir)))
4188 (if (or (and file-precious-flag dir-writable)
4189 (and break-hardlink-on-save
4190 (> (file-nlinks buffer-file-name) 1)
4192 (error (concat (format
4193 "Directory %s write-protected; " dir)
4194 "cannot break hardlink when saving")))))
4195 ;; Write temp name, then rename it.
4196 ;; This requires write access to the containing dir,
4197 ;; which is why we don't try it if we don't have that access.
4198 (let ((realname buffer-file-name)
4200 (umask (default-file-modes))
4201 (old-modtime (visited-file-modtime)))
4202 ;; Create temp files with strict access rights. It's easy to
4203 ;; loosen them later, whereas it's impossible to close the
4204 ;; time-window of loose permissions otherwise.
4207 (clear-visited-file-modtime)
4208 (set-default-file-modes ?\700)
4209 ;; Try various temporary names.
4210 ;; This code follows the example of make-temp-file,
4211 ;; but it calls write-region in the appropriate way
4212 ;; for saving the buffer.
4213 (while (condition-case ()
4217 (expand-file-name "tmp" dir)))
4218 ;; Pass in nil&nil rather than point-min&max
4219 ;; cause we're saving the whole buffer.
4220 ;; write-region-annotate-functions may use it.
4221 (write-region nil nil
4222 tempname nil realname
4223 buffer-file-truename 'excl)
4225 (file-already-exists t))
4226 ;; The file was somehow created by someone else between
4227 ;; `make-temp-name' and `write-region', let's try again.
4231 (set-default-file-modes umask)
4232 ;; If we failed, restore the buffer's modtime.
4234 (set-visited-file-modtime old-modtime)))
4235 ;; Since we have created an entirely new file,
4236 ;; make sure it gets the right permission bits set.
4237 (setq setmodes (or setmodes
4238 (cons (or (file-modes buffer-file-name)
4239 (logand ?\666 umask))
4241 ;; We succeeded in writing the temp file,
4243 (rename-file tempname buffer-file-name t))
4244 ;; If file not writable, see if we can make it writable
4245 ;; temporarily while we write it.
4246 ;; But no need to do so if we have just backed it up
4247 ;; (setmodes is set) because that says we're superseding.
4248 (cond ((and tempsetmodes (not setmodes))
4249 ;; Change the mode back, after writing.
4250 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4251 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4255 ;; Pass in nil&nil rather than point-min&max to indicate
4256 ;; we're saving the buffer rather than just a region.
4257 ;; write-region-annotate-functions may make us of it.
4258 (write-region nil nil
4259 buffer-file-name nil t buffer-file-truename)
4261 ;; If we get an error writing the new file, and we made
4262 ;; the backup by renaming, undo the backing-up.
4263 (and setmodes (not success)
4265 (rename-file (cdr setmodes) buffer-file-name t)
4266 (setq buffer-backed-up nil)))))))
4269 (defun diff-buffer-with-file (&optional buffer)
4270 "View the differences between BUFFER and its associated file.
4271 This requires the external program `diff' to be in your `exec-path'."
4272 (interactive "bBuffer: ")
4273 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4274 (if (and buffer-file-name
4275 (file-exists-p buffer-file-name))
4276 (let ((tempfile (make-temp-file "buffer-content-")))
4279 (write-region nil nil tempfile nil 'nomessage)
4280 (diff buffer-file-name tempfile nil t)
4282 (when (file-exists-p tempfile)
4283 (delete-file tempfile))))
4284 (message "Buffer %s has no associated file on disc" (buffer-name))
4285 ;; Display that message for 1 second so that user can read it
4286 ;; in the minibuffer.
4288 ;; return always nil, so that save-buffers-kill-emacs will not move
4289 ;; over to the next unsaved buffer when calling `d'.
4292 (defvar save-some-buffers-action-alist
4295 (if (not enable-recursive-minibuffers)
4296 (progn (display-buffer buf)
4297 (setq other-window-scroll-buffer buf))
4298 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4300 ;; Return nil to ask about BUF again.
4304 (if (null buffer-file-name)
4305 (message "Not applicable: no file")
4306 (save-window-excursion (diff-buffer-with-file buf))
4307 (if (not enable-recursive-minibuffers)
4308 (progn (display-buffer (get-buffer-create "*Diff*"))
4309 (setq other-window-scroll-buffer "*Diff*"))
4310 (view-buffer (get-buffer-create "*Diff*")
4311 (lambda (_) (exit-recursive-edit)))
4313 ;; Return nil to ask about BUF again.
4315 "view changes in this buffer"))
4316 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4318 (defvar buffer-save-without-query nil
4319 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4320 (make-variable-buffer-local 'buffer-save-without-query)
4322 (defun save-some-buffers (&optional arg pred)
4323 "Save some modified file-visiting buffers. Asks user about each one.
4324 You can answer `y' to save, `n' not to save, `C-r' to look at the
4325 buffer in question with `view-buffer' before deciding or `d' to
4326 view the differences using `diff-buffer-with-file'.
4328 Optional argument (the prefix) non-nil means save all with no questions.
4329 Optional second argument PRED determines which buffers are considered:
4330 If PRED is nil, all the file-visiting buffers are considered.
4331 If PRED is t, then certain non-file buffers will also be considered.
4332 If PRED is a zero-argument function, it indicates for each buffer whether
4333 to consider it or not when called with that buffer current.
4335 See `save-some-buffers-action-alist' if you want to
4336 change the additional actions you can take on files."
4338 (save-window-excursion
4339 (let* (queried some-automatic
4340 files-done abbrevs-done)
4341 (dolist (buffer (buffer-list))
4342 ;; First save any buffers that we're supposed to save unconditionally.
4343 ;; That way the following code won't ask about them.
4344 (with-current-buffer buffer
4345 (when (and buffer-save-without-query (buffer-modified-p))
4346 (setq some-automatic t)
4348 ;; Ask about those buffers that merit it,
4349 ;; and record the number thus saved.
4353 (and (buffer-modified-p buffer)
4354 (not (buffer-base-buffer buffer))
4356 (buffer-file-name buffer)
4360 (and buffer-offer-save (> (buffer-size) 0)))))
4361 (or (not (functionp pred))
4362 (with-current-buffer buffer (funcall pred)))
4366 (if (buffer-file-name buffer)
4367 (format "Save file %s? "
4368 (buffer-file-name buffer))
4369 (format "Save buffer %s? "
4370 (buffer-name buffer))))))
4372 (with-current-buffer buffer
4375 '("buffer" "buffers" "save")
4376 save-some-buffers-action-alist))
4377 ;; Maybe to save abbrevs, and record whether
4378 ;; we either saved them or asked to.
4379 (and save-abbrevs abbrevs-changed
4382 (eq save-abbrevs 'silently)
4383 (y-or-n-p (format "Save abbrevs in %s? "
4385 (write-abbrev-file nil))
4386 ;; Don't keep bothering user if he says no.
4387 (setq abbrevs-changed nil)
4388 (setq abbrevs-done t)))
4389 (or queried (> files-done 0) abbrevs-done
4390 (message (if some-automatic
4391 "(Some special files were saved without asking)"
4392 "(No files need saving)"))))))
4394 (defun not-modified (&optional arg)
4395 "Mark current buffer as unmodified, not needing to be saved.
4396 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4398 It is not a good idea to use this function in Lisp programs, because it
4399 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4401 (message (if arg "Modification-flag set"
4402 "Modification-flag cleared"))
4403 (set-buffer-modified-p arg))
4405 (defun toggle-read-only (&optional arg)
4406 "Change whether this buffer is visiting its file read-only.
4407 With prefix argument ARG, make the buffer read-only if ARG is
4408 positive, otherwise make it writable. If visiting file read-only
4409 and `view-read-only' is non-nil, enter view mode."
4412 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4413 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4417 ((and buffer-read-only view-mode)
4418 (View-exit-and-edit)
4419 (make-local-variable 'view-read-only)
4420 (setq view-read-only t)) ; Must leave view mode.
4421 ((and (not buffer-read-only) view-read-only
4422 ;; If view-mode is already active, `view-mode-enter' is a nop.
4424 (not (eq (get major-mode 'mode-class) 'special)))
4426 (t (setq buffer-read-only (not buffer-read-only))
4427 (force-mode-line-update)))
4428 (if (vc-backend buffer-file-name)
4429 (message "%s" (substitute-command-keys
4430 (concat "File is under version-control; "
4431 "use \\[vc-next-action] to check in/out"))))))
4433 (defun insert-file (filename)
4434 "Insert contents of file FILENAME into buffer after point.
4435 Set mark after the inserted text.
4437 This function is meant for the user to run interactively.
4438 Don't call it from programs! Use `insert-file-contents' instead.
4439 \(Its calling sequence is different; see its documentation)."
4440 (interactive "*fInsert file: ")
4441 (insert-file-1 filename #'insert-file-contents))
4443 (defun append-to-file (start end filename)
4444 "Append the contents of the region to the end of file FILENAME.
4445 When called from a function, expects three arguments,
4446 START, END and FILENAME. START and END are buffer positions
4447 saying what text to write."
4448 (interactive "r\nFAppend to file: ")
4449 (write-region start end filename t))
4451 (defun file-newest-backup (filename)
4452 "Return most recent backup file for FILENAME or nil if no backups exist."
4453 ;; `make-backup-file-name' will get us the right directory for
4454 ;; ordinary or numeric backups. It might create a directory for
4455 ;; backups as a side-effect, according to `backup-directory-alist'.
4456 (let* ((filename (file-name-sans-versions
4457 (make-backup-file-name (expand-file-name filename))))
4458 (file (file-name-nondirectory filename))
4459 (dir (file-name-directory filename))
4460 (comp (file-name-all-completions file dir))
4464 (setq tem (pop comp))
4465 (cond ((and (backup-file-name-p tem)
4466 (string= (file-name-sans-versions tem) file))
4467 (setq tem (concat dir tem))
4468 (if (or (null newest)
4469 (file-newer-than-file-p tem newest))
4470 (setq newest tem)))))
4473 (defun rename-uniquely ()
4474 "Rename current buffer to a similar name not already taken.
4475 This function is useful for creating multiple shell process buffers
4476 or multiple mail buffers, etc."
4479 (let ((base-name (buffer-name)))
4480 (and (string-match "<[0-9]+>\\'" base-name)
4481 (not (and buffer-file-name
4483 (file-name-nondirectory buffer-file-name))))
4484 ;; If the existing buffer name has a <NNN>,
4485 ;; which isn't part of the file name (if any),
4486 ;; then get rid of that.
4487 (setq base-name (substring base-name 0 (match-beginning 0))))
4488 (rename-buffer (generate-new-buffer-name base-name))
4489 (force-mode-line-update))))
4491 (defun make-directory (dir &optional parents)
4492 "Create the directory DIR and any nonexistent parent dirs.
4493 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4495 Interactively, the default choice of directory to create
4496 is the current default directory for file names.
4497 That is useful when you have visited a file in a nonexistent directory.
4499 Noninteractively, the second (optional) argument PARENTS says whether
4500 to create parent directories if they don't exist. Interactively,
4501 this happens by default."
4503 (list (read-file-name "Make directory: " default-directory default-directory
4506 ;; If default-directory is a remote directory,
4507 ;; make sure we find its make-directory handler.
4508 (setq dir (expand-file-name dir))
4509 (let ((handler (find-file-name-handler dir 'make-directory)))
4511 (funcall handler 'make-directory dir parents)
4513 (make-directory-internal dir)
4514 (let ((dir (directory-file-name (expand-file-name dir)))
4516 (while (not (file-exists-p dir))
4517 (setq create-list (cons dir create-list)
4518 dir (directory-file-name (file-name-directory dir))))
4520 (make-directory-internal (car create-list))
4521 (setq create-list (cdr create-list))))))))
4523 (put 'revert-buffer-function 'permanent-local t)
4524 (defvar revert-buffer-function nil
4525 "Function to use to revert this buffer, or nil to do the default.
4526 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4527 which are the arguments that `revert-buffer' received.")
4529 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4530 (defvar revert-buffer-insert-file-contents-function nil
4531 "Function to use to insert contents when reverting this buffer.
4532 Gets two args, first the nominal file name to use,
4533 and second, t if reading the auto-save file.
4535 The function you specify is responsible for updating (or preserving) point.")
4537 (defvar buffer-stale-function nil
4538 "Function to check whether a non-file buffer needs reverting.
4539 This should be a function with one optional argument NOCONFIRM.
4540 Auto Revert Mode passes t for NOCONFIRM. The function should return
4541 non-nil if the buffer should be reverted. A return value of
4542 `fast' means that the need for reverting was not checked, but
4543 that reverting the buffer is fast. The buffer is current when
4544 this function is called.
4546 The idea behind the NOCONFIRM argument is that it should be
4547 non-nil if the buffer is going to be reverted without asking the
4548 user. In such situations, one has to be careful with potentially
4549 time consuming operations.
4551 For more information on how this variable is used by Auto Revert mode,
4552 see Info node `(emacs)Supporting additional buffers'.")
4554 (defvar before-revert-hook nil
4555 "Normal hook for `revert-buffer' to run before reverting.
4556 If `revert-buffer-function' is used to override the normal revert
4557 mechanism, this hook is not used.")
4559 (defvar after-revert-hook nil
4560 "Normal hook for `revert-buffer' to run after reverting.
4561 Note that the hook value that it runs is the value that was in effect
4562 before reverting; that makes a difference if you have buffer-local
4565 If `revert-buffer-function' is used to override the normal revert
4566 mechanism, this hook is not used.")
4568 (defvar revert-buffer-internal-hook)
4570 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4571 "Replace current buffer text with the text of the visited file on disk.
4572 This undoes all changes since the file was visited or saved.
4573 With a prefix argument, offer to revert from latest auto-save file, if
4574 that is more recent than the visited file.
4576 This command also implements an interface for special buffers
4577 that contain text which doesn't come from a file, but reflects
4578 some other data instead (e.g. Dired buffers, `buffer-list'
4579 buffers). This is done via the variable `revert-buffer-function'.
4580 In these cases, it should reconstruct the buffer contents from the
4583 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4584 to revert from the auto-save file when this is nil. Note that the
4585 sense of this argument is the reverse of the prefix argument, for the
4586 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4589 Optional second argument NOCONFIRM means don't ask for confirmation
4590 at all. \(The variable `revert-without-query' offers another way to
4591 revert buffers without querying for confirmation.)
4593 Optional third argument PRESERVE-MODES non-nil means don't alter
4594 the files modes. Normally we reinitialize them using `normal-mode'.
4596 If the value of `revert-buffer-function' is non-nil, it is called to
4597 do all the work for this command. Otherwise, the hooks
4598 `before-revert-hook' and `after-revert-hook' are run at the beginning
4599 and the end, and if `revert-buffer-insert-file-contents-function' is
4600 non-nil, it is called instead of rereading visited file contents."
4602 ;; I admit it's odd to reverse the sense of the prefix argument, but
4603 ;; there is a lot of code out there which assumes that the first
4604 ;; argument should be t to avoid consulting the auto-save file, and
4605 ;; there's no straightforward way to encourage authors to notice a
4606 ;; reversal of the argument sense. So I'm just changing the user
4607 ;; interface, but leaving the programmatic interface the same.
4608 (interactive (list (not current-prefix-arg)))
4609 (if revert-buffer-function
4610 (funcall revert-buffer-function ignore-auto noconfirm)
4611 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4613 (let* ((auto-save-p (and (not ignore-auto)
4614 (recent-auto-save-p)
4615 buffer-auto-save-file-name
4616 (file-readable-p buffer-auto-save-file-name)
4618 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4619 (file-name (if auto-save-p
4620 buffer-auto-save-file-name
4622 (cond ((null file-name)
4623 (error "Buffer does not seem to be associated with any file"))
4625 (and (not (buffer-modified-p))
4627 (dolist (regexp revert-without-query)
4628 (when (string-match regexp file-name)
4629 (throw 'found t)))))
4630 (yes-or-no-p (format "Revert buffer from file %s? "
4632 (run-hooks 'before-revert-hook)
4633 ;; If file was backed up but has changed since,
4634 ;; we shd make another backup.
4635 (and (not auto-save-p)
4636 (not (verify-visited-file-modtime (current-buffer)))
4637 (setq buffer-backed-up nil))
4638 ;; Effectively copy the after-revert-hook status,
4639 ;; since after-find-file will clobber it.
4640 (let ((global-hook (default-value 'after-revert-hook))
4641 (local-hook (when (local-variable-p 'after-revert-hook)
4643 (inhibit-read-only t))
4645 (revert-buffer-insert-file-contents-function
4646 (unless (eq buffer-undo-list t)
4647 ;; Get rid of all undo records for this buffer.
4648 (setq buffer-undo-list nil))
4649 ;; Don't make undo records for the reversion.
4650 (let ((buffer-undo-list t))
4651 (funcall revert-buffer-insert-file-contents-function
4652 file-name auto-save-p)))
4653 ((not (file-exists-p file-name))
4654 (error (if buffer-file-number
4655 "File %s no longer exists!"
4656 "Cannot revert nonexistent file %s")
4658 ((not (file-readable-p file-name))
4659 (error (if buffer-file-number
4660 "File %s no longer readable!"
4661 "Cannot revert unreadable file %s")
4664 ;; Bind buffer-file-name to nil
4665 ;; so that we don't try to lock the file.
4666 (let ((buffer-file-name nil))
4670 (let ((coding-system-for-read
4671 ;; Auto-saved file should be read by Emacs'
4673 (if auto-save-p 'auto-save-coding
4674 (or coding-system-for-read
4675 buffer-file-coding-system-explicit))))
4676 (if (and (not enable-multibyte-characters)
4677 coding-system-for-read
4678 (not (memq (coding-system-base
4679 coding-system-for-read)
4680 '(no-conversion raw-text))))
4681 ;; As a coding system suitable for multibyte
4682 ;; buffer is specified, make the current
4683 ;; buffer multibyte.
4684 (set-buffer-multibyte t))
4686 ;; This force after-insert-file-set-coding
4687 ;; (called from insert-file-contents) to set
4688 ;; buffer-file-coding-system to a proper value.
4689 (kill-local-variable 'buffer-file-coding-system)
4691 ;; Note that this preserves point in an intelligent way.
4693 (let ((buffer-file-format buffer-file-format))
4694 (insert-file-contents file-name (not auto-save-p)
4696 (insert-file-contents file-name (not auto-save-p)
4698 ;; Recompute the truename in case changes in symlinks
4699 ;; have changed the truename.
4700 (setq buffer-file-truename
4701 (abbreviate-file-name (file-truename buffer-file-name)))
4702 (after-find-file nil nil t t preserve-modes)
4703 ;; Run after-revert-hook as it was before we reverted.
4704 (setq-default revert-buffer-internal-hook global-hook)
4706 (set (make-local-variable 'revert-buffer-internal-hook)
4708 (kill-local-variable 'revert-buffer-internal-hook))
4709 (run-hooks 'revert-buffer-internal-hook))
4712 (defun recover-this-file ()
4713 "Recover the visited file--get contents from its last auto-save file."
4715 (recover-file buffer-file-name))
4717 (defun recover-file (file)
4718 "Visit file FILE, but get contents from its last auto-save file."
4719 ;; Actually putting the file name in the minibuffer should be used
4721 ;; Not just because users often use the default.
4722 (interactive "FRecover file: ")
4723 (setq file (expand-file-name file))
4724 (if (auto-save-file-name-p (file-name-nondirectory file))
4725 (error "%s is an auto-save file" (abbreviate-file-name file)))
4726 (let ((file-name (let ((buffer-file-name file))
4727 (make-auto-save-file-name))))
4728 (cond ((if (file-exists-p file)
4729 (not (file-newer-than-file-p file-name file))
4730 (not (file-exists-p file-name)))
4731 (error "Auto-save file %s not current"
4732 (abbreviate-file-name file-name)))
4733 ((save-window-excursion
4734 (with-output-to-temp-buffer "*Directory*"
4735 (buffer-disable-undo standard-output)
4737 (let ((switches dired-listing-switches))
4738 (if (file-symlink-p file)
4739 (setq switches (concat switches "L")))
4740 (set-buffer standard-output)
4741 ;; Use insert-directory-safely, not insert-directory,
4742 ;; because these files might not exist. In particular,
4743 ;; FILE might not exist if the auto-save file was for
4744 ;; a buffer that didn't visit a file, such as "*mail*".
4745 ;; The code in v20.x called `ls' directly, so we need
4746 ;; to emulate what `ls' did in that case.
4747 (insert-directory-safely file switches)
4748 (insert-directory-safely file-name switches))))
4749 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4750 (switch-to-buffer (find-file-noselect file t))
4751 (let ((inhibit-read-only t)
4752 ;; Keep the current buffer-file-coding-system.
4753 (coding-system buffer-file-coding-system)
4754 ;; Auto-saved file should be read with special coding.
4755 (coding-system-for-read 'auto-save-coding))
4757 (insert-file-contents file-name nil)
4758 (set-buffer-file-coding-system coding-system))
4759 (after-find-file nil nil t))
4760 (t (error "Recover-file cancelled")))))
4762 (defun recover-session ()
4763 "Recover auto save files from a previous Emacs session.
4764 This command first displays a Dired buffer showing you the
4765 previous sessions that you could recover from.
4766 To choose one, move point to the proper line and then type C-c C-c.
4767 Then you'll be asked about a number of files to recover."
4769 (if (null auto-save-list-file-prefix)
4770 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4771 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4772 (unless (file-directory-p dir)
4773 (make-directory dir t))
4774 (unless (directory-files dir nil
4775 (concat "\\`" (regexp-quote
4776 (file-name-nondirectory
4777 auto-save-list-file-prefix)))
4779 (error "No previous sessions to recover")))
4780 (let ((ls-lisp-support-shell-wildcards t))
4781 (dired (concat auto-save-list-file-prefix "*")
4782 (concat dired-listing-switches "t")))
4784 (goto-char (point-min))
4785 (or (looking-at " Move to the session you want to recover,")
4786 (let ((inhibit-read-only t))
4787 ;; Each line starts with a space
4788 ;; so that Font Lock mode won't highlight the first character.
4789 (insert " Move to the session you want to recover,\n"
4790 " then type C-c C-c to select it.\n\n"
4791 " You can also delete some of these files;\n"
4792 " type d on a line to mark that file for deletion.\n\n"))))
4793 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4794 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4796 (defun recover-session-finish ()
4797 "Choose one saved session to recover auto-save files from.
4798 This command is used in the special Dired buffer created by
4799 \\[recover-session]."
4801 ;; Get the name of the session file to recover from.
4802 (let ((file (dired-get-filename))
4804 (buffer (get-buffer-create " *recover*")))
4806 (dired-do-flagged-delete t)
4809 ;; Read in the auto-save-list file.
4812 (insert-file-contents file)
4813 ;; Loop thru the text of that file
4814 ;; and get out the names of the files to recover.
4816 (let (thisfile autofile)
4818 ;; This is a pair of lines for a non-file-visiting buffer.
4819 ;; Get the auto-save file name and manufacture
4820 ;; a "visited file name" from that.
4823 ;; If there is no auto-save file name, the
4824 ;; auto-save-list file is probably corrupted.
4827 (buffer-substring-no-properties
4829 (line-end-position)))
4833 (file-name-nondirectory autofile)
4835 (file-name-directory autofile))))
4837 ;; This pair of lines is a file-visiting
4838 ;; buffer. Use the visited file name.
4841 (buffer-substring-no-properties
4842 (point) (progn (end-of-line) (point))))
4845 (buffer-substring-no-properties
4846 (point) (progn (end-of-line) (point))))
4848 ;; Ignore a file if its auto-save file does not exist now.
4849 (if (and autofile (file-exists-p autofile))
4850 (setq files (cons thisfile files)))))
4851 (setq files (nreverse files))
4852 ;; The file contains a pair of line for each auto-saved buffer.
4853 ;; The first line of the pair contains the visited file name
4854 ;; or is empty if the buffer was not visiting a file.
4855 ;; The second line is the auto-save file name.
4857 (map-y-or-n-p "Recover %s? "
4860 (save-excursion (recover-file file))
4862 "Failed to recover `%s'" file)))
4864 '("file" "files" "recover"))
4865 (message "No files can be recovered from this session now")))
4866 (kill-buffer buffer))))
4868 (defun kill-buffer-ask (buffer)
4869 "Kill BUFFER if confirmed."
4871 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4872 (if (buffer-modified-p buffer)
4873 "HAS BEEN EDITED" "is unmodified")))
4874 (kill-buffer buffer)))
4876 (defun kill-some-buffers (&optional list)
4877 "Kill some buffers. Asks the user whether to kill each one of them.
4878 Non-interactively, if optional argument LIST is non-nil, it
4879 specifies the list of buffers to kill, asking for approval for each one."
4882 (setq list (buffer-list)))
4884 (let* ((buffer (car list))
4885 (name (buffer-name buffer)))
4886 (and name ; Can be nil for an indirect buffer
4887 ; if we killed the base buffer.
4888 (not (string-equal name ""))
4889 (/= (aref name 0) ?\s)
4890 (kill-buffer-ask buffer)))
4891 (setq list (cdr list))))
4893 (defun kill-matching-buffers (regexp &optional internal-too)
4894 "Kill buffers whose name matches the specified REGEXP.
4895 The optional second argument indicates whether to kill internal buffers too."
4896 (interactive "sKill buffers matching this regular expression: \nP")
4897 (dolist (buffer (buffer-list))
4898 (let ((name (buffer-name buffer)))
4899 (when (and name (not (string-equal name ""))
4900 (or internal-too (/= (aref name 0) ?\s))
4901 (string-match regexp name))
4902 (kill-buffer-ask buffer)))))
4905 (defun auto-save-mode (arg)
4906 "Toggle auto-saving of contents of current buffer.
4907 With prefix argument ARG, turn auto-saving on if positive, else off."
4909 (setq buffer-auto-save-file-name
4911 (or (not buffer-auto-save-file-name)
4912 ;; If auto-save is off because buffer has shrunk,
4913 ;; then toggling should turn it on.
4914 (< buffer-saved-size 0))
4915 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4916 (if (and buffer-file-name auto-save-visited-file-name
4917 (not buffer-read-only))
4919 (make-auto-save-file-name))))
4920 ;; If -1 was stored here, to temporarily turn off saving,
4922 (and (< buffer-saved-size 0)
4923 (setq buffer-saved-size 0))
4925 (message "Auto-save %s (in this buffer)"
4926 (if buffer-auto-save-file-name "on" "off")))
4927 buffer-auto-save-file-name)
4929 (defun rename-auto-save-file ()
4930 "Adjust current buffer's auto save file name for current conditions.
4931 Also rename any existing auto save file, if it was made in this session."
4932 (let ((osave buffer-auto-save-file-name))
4933 (setq buffer-auto-save-file-name
4934 (make-auto-save-file-name))
4935 (if (and osave buffer-auto-save-file-name
4936 (not (string= buffer-auto-save-file-name buffer-file-name))
4937 (not (string= buffer-auto-save-file-name osave))
4938 (file-exists-p osave)
4939 (recent-auto-save-p))
4940 (rename-file osave buffer-auto-save-file-name t))))
4942 (defun make-auto-save-file-name ()
4943 "Return file name to use for auto-saves of current buffer.
4944 Does not consider `auto-save-visited-file-name' as that variable is checked
4945 before calling this function. You can redefine this for customization.
4946 See also `auto-save-file-name-p'."
4947 (if buffer-file-name
4948 (let ((handler (find-file-name-handler buffer-file-name
4949 'make-auto-save-file-name)))
4951 (funcall handler 'make-auto-save-file-name)
4952 (let ((list auto-save-file-name-transforms)
4953 (filename buffer-file-name)
4955 ;; Apply user-specified translations
4956 ;; to the file name.
4957 (while (and list (not result))
4958 (if (string-match (car (car list)) filename)
4959 (setq result (replace-match (cadr (car list)) t nil
4961 uniq (car (cddr (car list)))))
4962 (setq list (cdr list)))
4965 (setq filename (concat
4966 (file-name-directory result)
4967 (subst-char-in-string
4969 (replace-regexp-in-string "!" "!!"
4971 (setq filename result)))
4973 (if (and (eq system-type 'ms-dos)
4974 (not (msdos-long-file-names)))
4975 ;; We truncate the file name to DOS 8+3 limits
4976 ;; before doing anything else, because the regexp
4977 ;; passed to string-match below cannot handle
4978 ;; extensions longer than 3 characters, multiple
4979 ;; dots, and other atrocities.
4980 (let ((fn (dos-8+3-filename
4981 (file-name-nondirectory buffer-file-name))))
4983 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4985 (concat (file-name-directory buffer-file-name)
4986 "#" (match-string 1 fn)
4987 "." (match-string 3 fn) "#"))
4988 (concat (file-name-directory filename)
4990 (file-name-nondirectory filename)
4992 ;; Make sure auto-save file names don't contain characters
4993 ;; invalid for the underlying filesystem.
4994 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4995 ;; Don't modify remote (ange-ftp) filenames
4996 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4997 (convert-standard-filename result)
5000 ;; Deal with buffers that don't have any associated files. (Mail
5001 ;; mode tends to create a good number of these.)
5003 (let ((buffer-name (buffer-name))
5006 ;; Restrict the characters used in the file name to those which
5007 ;; are known to be safe on all filesystems, url-encoding the
5009 ;; We do this on all platforms, because even if we are not
5010 ;; running on DOS/Windows, the current directory may be on a
5011 ;; mounted VFAT filesystem, such as a USB memory stick.
5012 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5013 (let* ((character (aref buffer-name (match-beginning 0)))
5015 ;; For multibyte characters, this will produce more than
5016 ;; 2 hex digits, so is not true URL encoding.
5017 (format "%%%02X" character)))
5018 (setq buffer-name (replace-match replacement t t buffer-name))
5019 (setq limit (1+ (match-end 0)))))
5020 ;; Generate the file name.
5025 (format "#%s#" buffer-name)
5026 ;; Try a few alternative directories, to get one we can
5029 ((file-writable-p default-directory) default-directory)
5030 ((file-writable-p "/var/tmp/") "/var/tmp/")
5032 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5033 ;; Don't modify remote (ange-ftp) filenames
5034 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5035 ;; The call to convert-standard-filename is in case
5036 ;; buffer-name includes characters not allowed by the
5037 ;; DOS/Windows filesystems. make-temp-file writes to the
5038 ;; file it creates, so we must fix the file name _before_
5039 ;; make-temp-file is called.
5040 (convert-standard-filename fname)
5043 ;; make-temp-file creates the file,
5044 ;; but we don't want it to exist until we do an auto-save.
5046 (delete-file file-name)
5050 (defun auto-save-file-name-p (filename)
5051 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5052 FILENAME should lack slashes. You can redefine this for customization."
5053 (string-match "^#.*#$" filename))
5055 (defun wildcard-to-regexp (wildcard)
5056 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5057 The generated regexp will match a filename only if the filename
5058 matches that wildcard according to shell rules. Only wildcards known
5059 by `sh' are supported."
5060 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5061 ;; Copy the initial run of non-special characters.
5062 (result (substring wildcard 0 i))
5063 (len (length wildcard)))
5064 ;; If no special characters, we're almost done.
5067 (let ((ch (aref wildcard i))
5075 (eq (aref wildcard (1+ i)) ?\]))
5077 ((eq ch ?\[) ; [...] maps to regexp char class
5082 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5085 (if (eq (aref wildcard i) ?\])
5090 ((eq (aref wildcard i) ?^)
5091 ;; Found "[^". Insert a `\0' character
5092 ;; (which cannot happen in a filename)
5093 ;; into the character class, so that `^'
5094 ;; is not the first character after `[',
5095 ;; and thus non-special in a regexp.
5099 ((eq (aref wildcard i) ?\])
5100 ;; I don't think `]' can appear in a
5101 ;; character class in a wildcard, but
5102 ;; let's be general here.
5107 (prog1 ; copy everything upto next `]'.
5110 (setq j (string-match
5112 (setq i (if j (1- j) (1- len)))))))
5114 ((eq ch ?*) "[^\000]*")
5118 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5119 ((eq ch ??) "[^\000]")
5120 (t (char-to-string ch)))))
5122 ;; Shell wildcards should match the entire filename,
5123 ;; not its part. Make the regexp say so.
5124 (concat "\\`" result "\\'")))
5126 (defcustom list-directory-brief-switches
5128 "Switches for `list-directory' to pass to `ls' for brief listing."
5132 (defcustom list-directory-verbose-switches
5134 "Switches for `list-directory' to pass to `ls' for verbose listing."
5138 (defun file-expand-wildcards (pattern &optional full)
5139 "Expand wildcard pattern PATTERN.
5140 This returns a list of file names which match the pattern.
5142 If PATTERN is written as an absolute file name,
5143 the values are absolute also.
5145 If PATTERN is written as a relative file name, it is interpreted
5146 relative to the current default directory, `default-directory'.
5147 The file names returned are normally also relative to the current
5148 default directory. However, if FULL is non-nil, they are absolute."
5150 (let* ((nondir (file-name-nondirectory pattern))
5151 (dirpart (file-name-directory pattern))
5152 ;; A list of all dirs that DIRPART specifies.
5153 ;; This can be more than one dir
5154 ;; if DIRPART contains wildcards.
5155 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5156 (mapcar 'file-name-as-directory
5157 (file-expand-wildcards (directory-file-name dirpart)))
5161 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5162 (file-directory-p (directory-file-name (car dirs))))
5163 (let ((this-dir-contents
5164 ;; Filter out "." and ".."
5166 (mapcar #'(lambda (name)
5167 (unless (string-match "\\`\\.\\.?\\'"
5168 (file-name-nondirectory name))
5170 (directory-files (or (car dirs) ".") full
5171 (wildcard-to-regexp nondir))))))
5174 (if (and (car dirs) (not full))
5175 (mapcar (function (lambda (name) (concat (car dirs) name)))
5179 (setq dirs (cdr dirs)))
5182 (defun list-directory (dirname &optional verbose)
5183 "Display a list of files in or matching DIRNAME, a la `ls'.
5184 DIRNAME is globbed by the shell if necessary.
5185 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5186 Actions controlled by variables `list-directory-brief-switches'
5187 and `list-directory-verbose-switches'."
5188 (interactive (let ((pfx current-prefix-arg))
5189 (list (read-file-name (if pfx "List directory (verbose): "
5190 "List directory (brief): ")
5191 nil default-directory nil)
5193 (let ((switches (if verbose list-directory-verbose-switches
5194 list-directory-brief-switches))
5196 (or dirname (setq dirname default-directory))
5197 (setq dirname (expand-file-name dirname))
5198 (with-output-to-temp-buffer "*Directory*"
5199 (setq buffer standard-output)
5200 (buffer-disable-undo standard-output)
5201 (princ "Directory ")
5205 (set-buffer "*Directory*")
5206 (let ((wildcard (not (file-directory-p dirname))))
5207 (insert-directory dirname switches wildcard (not wildcard)))))
5208 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5209 (with-current-buffer buffer
5210 (setq default-directory
5211 (if (file-directory-p dirname)
5212 (file-name-as-directory dirname)
5213 (file-name-directory dirname))))))
5215 (defun shell-quote-wildcard-pattern (pattern)
5216 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5218 PATTERN is assumed to represent a file-name wildcard suitable for the
5219 underlying filesystem. For Unix and GNU/Linux, the characters from the
5220 set [ \\t\\n;<>&|()'\"#$] are quoted with a backslash; for DOS/Windows, all
5221 the parts of the pattern which don't include wildcard characters are
5222 quoted with double quotes.
5223 Existing quote characters in PATTERN are left alone, so you can pass
5224 PATTERN that already quotes some of the special characters."
5227 ((memq system-type '(ms-dos windows-nt cygwin))
5228 ;; DOS/Windows don't allow `"' in file names. So if the
5229 ;; argument has quotes, we can safely assume it is already
5230 ;; quoted by the caller.
5231 (if (or (string-match "[\"]" pattern)
5232 ;; We quote [&()#$'] in case their shell is a port of a
5233 ;; Unixy shell. We quote [,=+] because stock DOS and
5234 ;; Windows shells require that in some cases, such as
5235 ;; passing arguments to batch files that use positional
5236 ;; arguments like %1.
5237 (not (string-match "[ \t;&()#$',=+]" pattern)))
5242 (while (string-match "[*?]+" pattern beg)
5243 (setq end (match-beginning 0)
5244 result (concat result (substring pattern beg end)
5246 (substring pattern end (match-end 0))
5249 (concat result (substring pattern beg) "\""))))
5252 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5254 (concat (substring pattern 0 (match-beginning 0))
5256 (substring pattern (match-beginning 0)))
5257 beg (1+ (match-end 0)))))
5261 (defvar insert-directory-program "ls"
5262 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5264 (defcustom directory-free-space-program "df"
5265 "Program to get the amount of free space on a file system.
5266 We assume the output has the format of `df'.
5267 The value of this variable must be just a command name or file name;
5268 if you want to specify options, use `directory-free-space-args'.
5270 A value of nil disables this feature.
5272 If the function `file-system-info' is defined, it is always used in
5273 preference to the program given by this variable."
5274 :type '(choice (string :tag "Program") (const :tag "None" nil))
5277 (defcustom directory-free-space-args
5278 (if (eq system-type 'darwin) "-k" "-Pk")
5279 "Options to use when running `directory-free-space-program'."
5283 (defun get-free-disk-space (dir)
5284 "Return the amount of free space on directory DIR's file system.
5285 The result is a string that gives the number of free 1KB blocks,
5286 or nil if the system call or the program which retrieve the information
5287 fail. It returns also nil when DIR is a remote directory.
5289 This function calls `file-system-info' if it is available, or invokes the
5290 program specified by `directory-free-space-program' if that is non-nil."
5291 (when (not (file-remote-p dir))
5292 ;; Try to find the number of free blocks. Non-Posix systems don't
5293 ;; always have df, but might have an equivalent system call.
5294 (if (fboundp 'file-system-info)
5295 (let ((fsinfo (file-system-info dir)))
5297 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5300 (when (and directory-free-space-program
5301 (eq 0 (call-process directory-free-space-program
5303 directory-free-space-args
5305 ;; Usual format is a header line followed by a line of
5307 (goto-char (point-min))
5311 ;; Move to the end of the "available blocks" number.
5312 (skip-chars-forward "^ \t")
5314 ;; Copy it into AVAILABLE.
5315 (let ((end (point)))
5317 (buffer-substring (point) end))))))))))
5319 ;; The following expression replaces `dired-move-to-filename-regexp'.
5320 (defvar directory-listing-before-filename-regexp
5321 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5322 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5323 ;; In some locales, month abbreviations are as short as 2 letters,
5324 ;; and they can be followed by ".".
5325 ;; In Breton, a month name can include a quote character.
5326 (month (concat l-or-quote l-or-quote "+\\.?"))
5328 (yyyy "[0-9][0-9][0-9][0-9]")
5330 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5331 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5332 (zone "[-+][0-2][0-9][0-5][0-9]")
5333 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5334 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5335 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5336 "\\|" yyyy "-" iso-mm-dd "\\)"))
5337 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5339 "\\(" HH:MM "\\|" yyyy "\\)"))
5340 (western-comma (concat month s "+" dd "," s "+" yyyy))
5341 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5342 ;; omits the Kanji characters after month and day-of-month.
5343 ;; On Mac OS X 10.3, the date format in East Asian locales is
5344 ;; day-of-month digits followed by month digits.
5347 (concat "\\(" mm l "?" s dd l "?" s "+"
5348 "\\|" dd s mm s "+" "\\)"
5349 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5350 ;; The "[0-9]" below requires the previous column to end in a digit.
5351 ;; This avoids recognizing `1 may 1997' as a date in the line:
5352 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5354 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5355 ;; The ".*" below finds the last match if there are multiple matches.
5356 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5357 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5359 ;; vc dired listings provide the state or blanks between file
5360 ;; permissions and date. The state is always surrounded by
5362 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5363 ;; This is not supported yet.
5364 (concat ".*[0-9][BkKMGTPEZY]?" s
5365 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5367 "Regular expression to match up to the file name in a directory listing.
5368 The default value is designed to recognize dates and times
5369 regardless of the language.")
5371 (defvar insert-directory-ls-version 'unknown)
5374 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5375 ;; FULL-DIRECTORY-P is nil.
5376 ;; The single line of output must display FILE's name as it was
5377 ;; given, namely, an absolute path name.
5378 ;; - must insert exactly one line for each file if WILDCARD or
5379 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5380 ;; before the file lines, plus optional text after the file lines.
5381 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5383 ;; File lines should display the basename.
5384 ;; - must be consistent with
5385 ;; - functions dired-move-to-filename, (these two define what a file line is)
5386 ;; dired-move-to-end-of-filename,
5387 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5388 ;; dired-insert-headerline
5389 ;; dired-after-subdir-garbage (defines what a "total" line is)
5390 ;; - variable dired-subdir-regexp
5391 ;; - may be passed "--dired" as the first argument in SWITCHES.
5392 ;; Filename handlers might have to remove this switch if their
5393 ;; "ls" command does not support it.
5394 (defun insert-directory (file switches &optional wildcard full-directory-p)
5395 "Insert directory listing for FILE, formatted according to SWITCHES.
5396 Leaves point after the inserted text.
5397 SWITCHES may be a string of options, or a list of strings
5398 representing individual options.
5399 Optional third arg WILDCARD means treat FILE as shell wildcard.
5400 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5401 switches do not contain `d', so that a full listing is expected.
5403 This works by running a directory listing program
5404 whose name is in the variable `insert-directory-program'.
5405 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5407 When SWITCHES contains the long `--dired' option, this function
5408 treats it specially, for the sake of dired. However, the
5409 normally equivalent short `-D' option is just passed on to
5410 `insert-directory-program', as any other option."
5411 ;; We need the directory in order to find the right handler.
5412 (let ((handler (find-file-name-handler (expand-file-name file)
5413 'insert-directory)))
5415 (funcall handler 'insert-directory file switches
5416 wildcard full-directory-p)
5417 (let (result (beg (point)))
5419 ;; Read the actual directory using `insert-directory-program'.
5420 ;; RESULT gets the status code.
5421 (let* (;; We at first read by no-conversion, then after
5422 ;; putting text property `dired-filename, decode one
5423 ;; bunch by one to preserve that property.
5424 (coding-system-for-read 'no-conversion)
5425 ;; This is to control encoding the arguments in call-process.
5426 (coding-system-for-write
5427 (and enable-multibyte-characters
5428 (or file-name-coding-system
5429 default-file-name-coding-system))))
5432 ;; Run ls in the directory part of the file pattern
5433 ;; using the last component as argument.
5434 (let ((default-directory
5435 (if (file-name-absolute-p file)
5436 (file-name-directory file)
5437 (file-name-directory (expand-file-name file))))
5438 (pattern (file-name-nondirectory file)))
5440 shell-file-name nil t nil
5442 (concat (if (memq system-type '(ms-dos windows-nt))
5444 "\\") ; Disregard Unix shell aliases!
5445 insert-directory-program
5447 (if (stringp switches)
5449 (mapconcat 'identity switches " "))
5451 ;; Quote some characters that have
5452 ;; special meanings in shells; but
5453 ;; don't quote the wildcards--we want
5454 ;; them to be special. We also
5455 ;; currently don't quote the quoting
5456 ;; characters in case people want to
5457 ;; use them explicitly to quote
5458 ;; wildcard characters.
5459 (shell-quote-wildcard-pattern pattern))))
5460 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5461 ;; directory if FILE is a symbolic link.
5462 (apply 'call-process
5463 insert-directory-program nil t nil
5465 (if (listp switches) switches
5466 (unless (equal switches "")
5467 ;; Split the switches at any spaces so we can
5468 ;; pass separate options as separate args.
5469 (split-string switches)))
5470 ;; Avoid lossage if FILE starts with `-'.
5473 (if (string-match "\\`~" file)
5474 (setq file (expand-file-name file)))
5476 (if full-directory-p
5477 (concat (file-name-as-directory file) ".")
5480 ;; If we got "//DIRED//" in the output, it means we got a real
5481 ;; directory listing, even if `ls' returned nonzero.
5482 ;; So ignore any errors.
5483 (when (if (stringp switches)
5484 (string-match "--dired\\>" switches)
5485 (member "--dired" switches))
5488 (when (looking-at "//SUBDIRED//")
5490 (if (looking-at "//DIRED//")
5493 (when (and (not (eq 0 result))
5494 (eq insert-directory-ls-version 'unknown))
5495 ;; The first time ls returns an error,
5496 ;; find the version numbers of ls,
5497 ;; and set insert-directory-ls-version
5498 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5499 ;; is equal or if the info cannot be obtained.
5500 ;; (That can mean it isn't GNU ls.)
5503 (call-process "ls" nil t nil "--version")
5505 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5506 (let* ((version (match-string 1 version-out))
5507 (split (split-string version "[.]"))
5508 (numbers (mapcar 'string-to-number split))
5511 (while (and (not comparison) (or numbers min))
5513 (setq comparison '>))
5515 (setq comparison '<))
5516 ((> (car numbers) (car min))
5517 (setq comparison '>))
5518 ((< (car numbers) (car min))
5519 (setq comparison '<))
5521 (setq numbers (cdr numbers)
5523 (setq insert-directory-ls-version (or comparison '=)))
5524 (setq insert-directory-ls-version nil))))
5526 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5527 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5530 ;; If `insert-directory-program' failed, signal an error.
5531 (unless (eq 0 result)
5532 ;; Delete the error message it may have output.
5533 (delete-region beg (point))
5534 ;; On non-Posix systems, we cannot open a directory, so
5535 ;; don't even try, because that will always result in
5536 ;; the ubiquitous "Access denied". Instead, show the
5537 ;; command line so the user can try to guess what went wrong.
5538 (if (and (file-directory-p file)
5539 (memq system-type '(ms-dos windows-nt)))
5541 "Reading directory: \"%s %s -- %s\" exited with status %s"
5542 insert-directory-program
5543 (if (listp switches) (concat switches) switches)
5545 ;; Unix. Access the file to get a suitable error.
5546 (access-file file "Reading directory")
5547 (error "Listing directory failed but `access-file' worked")))
5549 (when (if (stringp switches)
5550 (string-match "--dired\\>" switches)
5551 (member "--dired" switches))
5552 ;; The following overshoots by one line for an empty
5553 ;; directory listed with "--dired", but without "-a"
5554 ;; switch, where the ls output contains a
5555 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5556 ;; We take care of that case later.
5558 (when (looking-at "//SUBDIRED//")
5559 (delete-region (point) (progn (forward-line 1) (point)))
5561 (if (looking-at "//DIRED//")
5562 (let ((end (line-end-position))
5565 ;; Find all the lines that are error messages,
5566 ;; and record the bounds of each one.
5568 (while (< (point) linebeg)
5569 (or (eql (following-char) ?\s)
5570 (push (list (point) (line-end-position)) error-lines))
5572 (setq error-lines (nreverse error-lines))
5573 ;; Now read the numeric positions of file names.
5577 (while (< (point) end)
5578 (let ((start (insert-directory-adj-pos
5579 (+ beg (read (current-buffer)))
5581 (end (insert-directory-adj-pos
5582 (+ beg (read (current-buffer)))
5584 (if (memq (char-after end) '(?\n ?\s))
5585 ;; End is followed by \n or by " -> ".
5586 (put-text-property start end 'dired-filename t)
5587 ;; It seems that we can't trust ls's output as to
5588 ;; byte positions of filenames.
5589 (put-text-property beg (point) 'dired-filename nil)
5593 (delete-region (point) (progn (forward-line 1) (point))))
5594 ;; Take care of the case where the ls output contains a
5595 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5596 ;; and we went one line too far back (see above).
5598 (if (looking-at "//DIRED-OPTIONS//")
5599 (delete-region (point) (progn (forward-line 1) (point)))))
5601 ;; Now decode what read if necessary.
5602 (let ((coding (or coding-system-for-read
5603 file-name-coding-system
5604 default-file-name-coding-system
5608 (when (and enable-multibyte-characters
5609 (not (memq (coding-system-base coding)
5610 '(raw-text no-conversion))))
5611 ;; If no coding system is specified or detection is
5612 ;; requested, detect the coding.
5613 (if (eq (coding-system-base coding) 'undecided)
5614 (setq coding (detect-coding-region beg (point) t)))
5615 (if (not (eq (coding-system-base coding) 'undecided))
5618 (coding-system-change-eol-conversion coding 'unix))
5619 (narrow-to-region beg (point))
5620 (goto-char (point-min))
5623 val (get-text-property (point) 'dired-filename))
5624 (goto-char (next-single-property-change
5625 (point) 'dired-filename nil (point-max)))
5626 ;; Force no eol conversion on a file name, so
5627 ;; that CR is preserved.
5628 (decode-coding-region pos (point)
5629 (if val coding-no-eol coding))
5631 (put-text-property pos (point)
5632 'dired-filename t)))))))
5634 (if full-directory-p
5635 ;; Try to insert the amount of free space.
5638 ;; First find the line to put it on.
5639 (when (re-search-forward "^ *\\(total\\)" nil t)
5640 (let ((available (get-free-disk-space ".")))
5642 ;; Replace "total" with "used", to avoid confusion.
5643 (replace-match "total used in directory" nil nil nil 1)
5645 (insert " available " available))))))))))
5647 (defun insert-directory-adj-pos (pos error-lines)
5648 "Convert `ls --dired' file name position value POS to a buffer position.
5649 File name position values returned in ls --dired output
5650 count only stdout; they don't count the error messages sent to stderr.
5651 So this function converts to them to real buffer positions.
5652 ERROR-LINES is a list of buffer positions of error message lines,
5653 of the form (START END)."
5654 (while (and error-lines (< (caar error-lines) pos))
5655 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5659 (defun insert-directory-safely (file switches
5660 &optional wildcard full-directory-p)
5661 "Insert directory listing for FILE, formatted according to SWITCHES.
5663 Like `insert-directory', but if FILE does not exist, it inserts a
5664 message to that effect instead of signaling an error."
5665 (if (file-exists-p file)
5666 (insert-directory file switches wildcard full-directory-p)
5667 ;; Simulate the message printed by `ls'.
5668 (insert (format "%s: No such file or directory\n" file))))
5670 (defvar kill-emacs-query-functions nil
5671 "Functions to call with no arguments to query about killing Emacs.
5672 If any of these functions returns nil, killing Emacs is cancelled.
5673 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5674 the low level primitive, does not. See also `kill-emacs-hook'.")
5676 (defcustom confirm-kill-emacs nil
5677 "How to ask for confirmation when leaving Emacs.
5678 If nil, the default, don't ask at all. If the value is non-nil, it should
5679 be a predicate function such as `yes-or-no-p'."
5680 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5681 (const :tag "Ask with y-or-n-p" y-or-n-p)
5682 (const :tag "Don't confirm" nil))
5686 (defun save-buffers-kill-emacs (&optional arg)
5687 "Offer to save each buffer, then kill this Emacs process.
5688 With prefix ARG, silently save all file-visiting buffers, then kill."
5690 (save-some-buffers arg t)
5691 (and (or (not (memq t (mapcar (function
5692 (lambda (buf) (and (buffer-file-name buf)
5693 (buffer-modified-p buf))))
5695 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5696 (or (not (fboundp 'process-list))
5697 ;; process-list is not defined on MSDOS.
5698 (let ((processes (process-list))
5701 (and (memq (process-status (car processes)) '(run stop open listen))
5702 (process-query-on-exit-flag (car processes))
5704 (setq processes (cdr processes)))
5707 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5708 ;; Query the user for other things, perhaps.
5709 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5710 (or (null confirm-kill-emacs)
5711 (funcall confirm-kill-emacs "Really exit Emacs? "))
5714 (defun save-buffers-kill-terminal (&optional arg)
5715 "Offer to save each buffer, then kill the current connection.
5716 If the current frame has no client, kill Emacs itself.
5718 With prefix ARG, silently save all file-visiting buffers, then kill.
5720 If emacsclient was started with a list of filenames to edit, then
5721 only these files will be asked to be saved."
5723 (let ((proc (frame-parameter (selected-frame) 'client))
5724 (frame (selected-frame)))
5726 (save-buffers-kill-emacs)
5727 (server-save-buffers-kill-terminal proc arg))))
5730 ;; We use /: as a prefix to "quote" a file name
5731 ;; so that magic file name handlers will not apply to it.
5733 (setq file-name-handler-alist
5734 (cons '("\\`/:" . file-name-non-special)
5735 file-name-handler-alist))
5737 ;; We depend on being the last handler on the list,
5738 ;; so that anything else which does need handling
5739 ;; has been handled already.
5740 ;; So it is safe for us to inhibit *all* magic file name handlers.
5742 (defun file-name-non-special (operation &rest arguments)
5743 (let ((file-name-handler-alist nil)
5745 (if (eq operation 'insert-directory)
5746 (directory-file-name
5748 (unhandled-file-name-directory default-directory)))
5750 ;; Get a list of the indices of the args which are file names.
5752 (cdr (or (assq operation
5753 ;; The first six are special because they
5754 ;; return a file name. We want to include the /:
5755 ;; in the return value.
5756 ;; So just avoid stripping it in the first place.
5757 '((expand-file-name . nil)
5758 (file-name-directory . nil)
5759 (file-name-as-directory . nil)
5760 (directory-file-name . nil)
5761 (file-name-sans-versions . nil)
5762 (find-backup-file-name . nil)
5763 ;; `identity' means just return the first arg
5764 ;; not stripped of its quoting.
5765 (substitute-in-file-name identity)
5766 ;; `add' means add "/:" to the result.
5767 (file-truename add 0)
5768 ;; `quote' means add "/:" to buffer-file-name.
5769 (insert-file-contents quote 0)
5770 ;; `unquote-then-quote' means set buffer-file-name
5771 ;; temporarily to unquoted filename.
5772 (verify-visited-file-modtime unquote-then-quote)
5773 ;; List the arguments which are filenames.
5774 (file-name-completion 1)
5775 (file-name-all-completions 1)
5779 (make-symbolic-link 0 1)
5780 (add-name-to-file 0 1)))
5781 ;; For all other operations, treat the first argument only
5782 ;; as the file name.
5785 ;; Copy ARGUMENTS so we can replace elements in it.
5786 (arguments (copy-sequence arguments)))
5787 (if (symbolp (car file-arg-indices))
5788 (setq method (pop file-arg-indices)))
5789 ;; Strip off the /: from the file names that have it.
5791 (while (consp file-arg-indices)
5792 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5794 (string-match "\\`/:" (car pair))
5796 (if (= (length (car pair)) 2)
5798 (substring (car pair) 2)))))
5799 (setq file-arg-indices (cdr file-arg-indices))))
5800 (cond ((eq method 'identity)
5803 (concat "/:" (apply operation arguments)))
5806 (apply operation arguments)
5807 (setq buffer-file-name (concat "/:" buffer-file-name))))
5808 ((eq method 'unquote-then-quote)
5810 (setq buffer-file-name (substring buffer-file-name 2))
5811 (setq res (apply operation arguments))
5812 (setq buffer-file-name (concat "/:" buffer-file-name))
5815 (apply operation arguments)))))
5817 ;; Symbolic modes and read-file-modes.
5819 (defun file-modes-char-to-who (char)
5820 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5821 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5822 Others, or All) for whom to produce the mask.
5823 The bit-mask that is returned extracts from mode bits the access rights
5824 for the specified category of users."
5825 (cond ((= char ?u) #o4700)
5826 ((= char ?g) #o2070)
5827 ((= char ?o) #o1007)
5828 ((= char ?a) #o7777)
5829 (t (error "%c: bad `who' character" char))))
5831 (defun file-modes-char-to-right (char &optional from)
5832 "Convert CHAR to a numeric value of mode bits.
5833 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5834 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5835 (or from (setq from 0))
5836 (cond ((= char ?r) #o0444)
5837 ((= char ?w) #o0222)
5838 ((= char ?x) #o0111)
5839 ((= char ?s) #o1000)
5840 ((= char ?t) #o6000)
5841 ;; Rights relative to the previous file modes.
5842 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5843 ((= char ?u) (let ((uright (logand #o4700 from)))
5844 (+ uright (/ uright #o10) (/ uright #o100))))
5845 ((= char ?g) (let ((gright (logand #o2070 from)))
5846 (+ gright (/ gright #o10) (* gright #o10))))
5847 ((= char ?o) (let ((oright (logand #o1007 from)))
5848 (+ oright (* oright #o10) (* oright #o100))))
5849 (t (error "%c: bad right character" char))))
5851 (defun file-modes-rights-to-number (rights who-mask &optional from)
5852 "Convert a symbolic mode string specification to an equivalent number.
5853 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]+)+\".
5854 WHO-MASK is the bit-mask specifying the category of users to which to
5855 apply the access permissions. See `file-modes-char-to-who'.
5856 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5857 RIGHTS request to add, remove, or set permissions based on existing ones,
5859 (let* ((num-rights (or from 0))
5860 (list-rights (string-to-list rights))
5861 (op (pop list-rights)))
5862 (while (memq op '(?+ ?- ?=))
5865 (while (memq (setq char-right (pop list-rights))
5866 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5869 (file-modes-char-to-right char-right num-rights))))
5870 (setq num-right (logand who-mask num-right)
5872 (cond ((= op ?+) (logior num-rights num-right))
5873 ((= op ?-) (logand num-rights (lognot num-right)))
5874 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5878 (defun file-modes-symbolic-to-number (modes &optional from)
5879 "Convert symbolic file modes to numeric file modes.
5880 MODES is the string to convert, it should match
5881 \"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5882 See (info \"(coreutils)File permissions\") for more information on this
5884 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5885 MODES request to add, remove, or set permissions based on existing ones,
5888 (let ((case-fold-search nil)
5889 (num-modes (or from 0)))
5890 (while (/= (string-to-char modes) 0)
5891 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5892 (let ((num-who (apply 'logior 0
5893 (mapcar 'file-modes-char-to-who
5894 (match-string 1 modes)))))
5896 (setq num-who (default-file-modes)))
5898 (file-modes-rights-to-number (substring modes (match-end 1))
5900 modes (substring modes (match-end 3))))
5901 (error "Parse error in modes near `%s'" (substring modes 0))))
5904 (defun read-file-modes (&optional prompt orig-file)
5905 "Read file modes in octal or symbolic notation and return its numeric value.
5906 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5907 ORIG-FILE is the name of a file on whose mode bits to base returned
5908 permissions if what user types requests to add, remove, or set permissions
5909 based on existing mode bits, as in \"og+rX-w\"."
5910 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5911 (error "File not found")))
5912 (modestr (and (stringp orig-file)
5913 (nth 8 (file-attributes orig-file))))
5915 (and (stringp modestr)
5916 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
5917 (replace-regexp-in-string
5919 (format "u=%s,g=%s,o=%s"
5920 (match-string 1 modestr)
5921 (match-string 2 modestr)
5922 (match-string 3 modestr)))))
5923 (value (read-string (or prompt "File modes (octal or symbolic): ")
5926 (if (string-match "^[0-7]+" value)
5927 (string-to-number value 8)
5928 (file-modes-symbolic-to-number value modes)))))
5931 ;; Trashcan handling.
5932 (defcustom trash-directory (convert-standard-filename "~/.Trash")
5933 "Directory for `move-file-to-trash' to move files and directories to.
5934 This directory is only used when the function `system-move-file-to-trash' is
5935 not defined. Relative paths are interpreted relative to `default-directory'.
5936 See also `delete-by-moving-to-trash'."
5941 (declare-function system-move-file-to-trash "w32fns.c" (filename))
5943 (defun move-file-to-trash (filename)
5944 "Move file (or directory) name FILENAME to the trash.
5945 This function is called by `delete-file' and `delete-directory' when
5946 `delete-by-moving-to-trash' is non-nil. On platforms that define
5947 `system-move-file-to-trash', that function is used to move FILENAME to the
5948 system trash, otherwise FILENAME is moved to `trash-directory'.
5949 Returns nil on success."
5950 (interactive "fMove file to trash: ")
5952 ((fboundp 'system-move-file-to-trash)
5953 (system-move-file-to-trash filename))
5955 (let* ((trash-dir (expand-file-name trash-directory))
5956 (fn (directory-file-name (expand-file-name filename)))
5957 (fn-nondir (file-name-nondirectory fn))
5958 (new-fn (expand-file-name fn-nondir trash-dir)))
5959 (or (file-directory-p trash-dir)
5960 (make-directory trash-dir t))
5961 (and (file-exists-p new-fn)
5962 ;; make new-fn unique.
5963 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5964 (let ((version-control t))
5965 (setq new-fn (car (find-backup-file-name new-fn)))))
5966 ;; stop processing if fn is same or parent directory of trash-dir.
5967 (and (string-match fn trash-dir)
5968 (error "Filename `%s' is same or parent directory of trash-directory"
5970 (let ((delete-by-moving-to-trash nil))
5971 (rename-file fn new-fn))))))
5974 (define-key ctl-x-map "\C-f" 'find-file)
5975 (define-key ctl-x-map "\C-r" 'find-file-read-only)
5976 (define-key ctl-x-map "\C-v" 'find-alternate-file)
5977 (define-key ctl-x-map "\C-s" 'save-buffer)
5978 (define-key ctl-x-map "s" 'save-some-buffers)
5979 (define-key ctl-x-map "\C-w" 'write-file)
5980 (define-key ctl-x-map "i" 'insert-file)
5981 (define-key esc-map "~" 'not-modified)
5982 (define-key ctl-x-map "\C-d" 'list-directory)
5983 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
5984 (define-key ctl-x-map "\C-q" 'toggle-read-only)
5986 (define-key ctl-x-4-map "f" 'find-file-other-window)
5987 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5988 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5989 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
5990 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5992 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5993 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5994 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5995 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5996 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
5998 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5999 ;;; files.el ends here