1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985,86,87,92,93,94,95,96,97,98,99,2000,01,02,03,2004
4 ;;; Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
34 "Backups of edited data files."
37 (defgroup find-file nil
42 (defcustom delete-auto-save-files t
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
50 (defcustom directory-abbrev-alist
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
64 :type '(repeat (cons :format "%v"
71 ;; Turn off backup files on VMS since it has version numbers.
72 (defcustom make-backup-files (not (eq system-type 'vax-vms))
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
95 (defvar backup-inhibited nil
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
98 But it is local only if you make it local.")
99 (put 'backup-inhibited 'permanent-local t)
101 (defcustom backup-by-copying nil
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
107 (defcustom backup-by-copying-when-linked nil
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
114 (defcustom backup-by-copying-when-mismatch nil
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
124 (defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
136 (defvar backup-enable-predicate 'normal-backup-enable-predicate
137 "Predicate that looks at a file name and decides whether to make backups.
138 Called with an absolute file name as argument, it returns t to enable backup.")
140 (defcustom buffer-offer-save nil
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
146 (make-variable-buffer-local 'buffer-offer-save)
148 (defcustom find-file-existing-other-name t
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
155 (defcustom find-file-visit-truename nil
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
162 (defcustom revert-without-query
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
169 :type '(repeat regexp)
172 (defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
176 If the buffer is visiting a new file, the value is nil.")
177 (make-variable-buffer-local 'buffer-file-number)
178 (put 'buffer-file-number 'permanent-local t)
180 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
183 (defvar buffer-file-read-only nil
184 "Non-nil if visited file was read-only when visited.")
185 (make-variable-buffer-local 'buffer-file-read-only)
187 (defcustom temporary-file-directory
188 (file-name-as-directory
189 (cond ((memq system-type '(ms-dos windows-nt))
190 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
191 ((memq system-type '(vax-vms axp-vms))
192 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 "The directory for writing temporary files."
199 (defcustom small-temporary-file-directory
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
206 :type '(choice (const nil) directory))
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
209 (defvar null-device "/dev/null" "The system null device.")
211 (defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
215 "[\000-\031]\\|" ; control characters
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
218 ((memq system-type '(ms-dos windows-nt cygwin))
219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
220 "[|<>\"?*\000-\031]")) ; invalid characters
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
224 (defcustom file-precious-flag nil
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
239 (defcustom version-control nil
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
244 :type '(choice (const :tag "Never" never)
245 (const :tag "If existing" nil)
246 (other :tag "Always" t))
250 (defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
256 (defcustom delete-old-versions nil
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
259 :type '(choice (const :tag "Delete" t)
260 (const :tag "Ask" nil)
261 (other :tag "Leave" other))
264 (defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
269 (defcustom kept-new-versions 2
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
275 (defcustom require-final-newline nil
276 "*Whether to add a newline automatically at the end of the file.
278 A value of t means do this only when the file is about to be saved.
279 A value of `visit' means do this right after the file is visited.
280 A value of `visit-save' means do it at both of those times.
281 Any other non-nil value means ask user whether to add a newline, when saving.
282 nil means don't add newlines.
284 Certain major modes set this locally to the value obtained
285 from `mode-require-final-newline'."
286 :type '(choice (const :tag "When visiting" visit)
287 (const :tag "When saving" t)
288 (const :tag "When visiting or saving" visit-save)
289 (const :tag "Never" nil)
290 (other :tag "Ask" ask))
291 :group 'editing-basics)
293 (defcustom mode-require-final-newline t
294 "*Whether to add a newline at the end of the file, in certain major modes.
295 Those modes set `require-final-newline' to this value when you enable them.
296 They do so because they are used for files that are supposed
297 to end in newlines, and the question is how to arrange that.
299 A value of t means do this only when the file is about to be saved.
300 A value of `visit' means do this right after the file is visited.
301 A value of `visit-save' means do it at both of those times.
302 Any other non-nil value means ask user whether to add a newline, when saving."
303 :type '(choice (const :tag "When visiting" visit)
304 (const :tag "When saving" t)
305 (const :tag "When visiting or saving" visit-save)
306 (other :tag "Ask" ask))
307 :group 'editing-basics
310 (defcustom auto-save-default t
311 "*Non-nil says by default do auto-saving of every file-visiting buffer."
315 (defcustom auto-save-visited-file-name nil
316 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
317 Normally auto-save files are written under other names."
321 (defcustom auto-save-file-name-transforms
322 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
323 ;; Don't put "\\2" inside expand-file-name, since it will be
324 ;; transformed to "/2" on DOS/Windows.
325 ,(concat temporary-file-directory "\\2") t))
326 "*Transforms to apply to buffer file name before making auto-save file name.
327 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
328 REGEXP is a regular expression to match against the file name.
329 If it matches, `replace-match' is used to replace the
330 matching part with REPLACEMENT.
331 If the optional element UNIQUIFY is non-nil, the auto-save file name is
332 constructed by taking the directory part of the replaced file-name,
333 concatenated with the buffer file name with all directory separators
334 changed to `!' to prevent clashes. This will not work
335 correctly if your filesystem truncates the resulting name.
337 All the transforms in the list are tried, in the order they are listed.
338 When one transform applies, its result is final;
339 no further transforms are tried.
341 The default value is set up to put the auto-save file into the
342 temporary directory (see the variable `temporary-file-directory') for
343 editing a remote file.
345 On MS-DOS filesystems without long names this variable is always
348 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
349 (boolean :tag "Uniquify")))
352 (defcustom save-abbrevs t
353 "*Non-nil means save word abbrevs too when files are saved.
354 If `silently', don't ask the user before saving."
355 :type '(choice (const t) (const nil) (const silently))
358 (defcustom find-file-run-dired t
359 "*Non-nil means allow `find-file' to visit directories.
360 To visit the directory, `find-file' runs `find-directory-functions'."
364 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
365 "*List of functions to try in sequence to visit a directory.
366 Each function is called with the directory name as the sole argument
367 and should return either a buffer or nil."
368 :type '(hook :options (cvs-dired-noselect dired-noselect))
371 ;;;It is not useful to make this a local variable.
372 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
373 (defvar find-file-not-found-functions nil
374 "List of functions to be called for `find-file' on nonexistent file.
375 These functions are called as soon as the error is detected.
376 Variable `buffer-file-name' is already set up.
377 The functions are called in the order given until one of them returns non-nil.")
378 (defvaralias 'find-file-not-found-hooks 'find-file-not-found-functions)
379 (make-obsolete-variable
380 'find-file-not-found-hooks 'find-file-not-found-functions "21.4")
382 ;;;It is not useful to make this a local variable.
383 ;;;(put 'find-file-hooks 'permanent-local t)
384 (defcustom find-file-hook nil
385 "List of functions to be called after a buffer is loaded from a file.
386 The buffer's local variables (if any) will have been processed before the
387 functions are called."
390 :options '(auto-insert)
392 (defvaralias 'find-file-hooks 'find-file-hook)
393 (make-obsolete-variable 'find-file-hooks 'find-file-hook "21.4")
395 (defvar write-file-functions nil
396 "List of functions to be called before writing out a buffer to a file.
397 If one of them returns non-nil, the file is considered already written
398 and the rest are not called.
399 These hooks are considered to pertain to the visited file.
400 So any buffer-local binding of this variable is discarded if you change
401 the visited file name with \\[set-visited-file-name], but not when you
402 change the major mode.
404 This hook is not run if any of the functions in
405 `write-contents-functions' returns non-nil. Both hooks pertain
406 to how to save a buffer to file, for instance, choosing a suitable
407 coding system and setting mode bits. (See Info
408 node `(elisp)Saving Buffers'.) To perform various checks or
409 updates before the buffer is saved, use `before-save-hook' .")
410 (put 'write-file-functions 'permanent-local t)
411 (defvaralias 'write-file-hooks 'write-file-functions)
412 (make-obsolete-variable 'write-file-hooks 'write-file-functions "21.4")
414 (defvar local-write-file-hooks nil)
415 (make-variable-buffer-local 'local-write-file-hooks)
416 (put 'local-write-file-hooks 'permanent-local t)
417 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "21.4")
419 (defvar write-contents-functions nil
420 "List of functions to be called before writing out a buffer to a file.
421 If one of them returns non-nil, the file is considered already written
422 and the rest are not called and neither are the functions in
423 `write-file-functions'.
425 This variable is meant to be used for hooks that pertain to the
426 buffer's contents, not to the particular visited file; thus,
427 `set-visited-file-name' does not clear this variable; but changing the
428 major mode does clear it.
430 For hooks that _do_ pertain to the particular visited file, use
431 `write-file-functions'. Both this variable and
432 `write-file-functions' relate to how a buffer is saved to file.
433 To perform various checks or updates before the buffer is saved,
434 use `before-save-hook'.")
435 (make-variable-buffer-local 'write-contents-functions)
436 (defvaralias 'write-contents-hooks 'write-contents-functions)
437 (make-obsolete-variable 'write-contents-hooks 'write-contents-functions "21.4")
439 (defcustom enable-local-variables t
440 "*Control use of local variables in files you visit.
441 The value can be t, nil or something else.
442 A value of t means file local variables specifications are obeyed;
443 nil means they are ignored; anything else means query.
444 This variable also controls use of major modes specified in
447 The command \\[normal-mode], when used interactively,
448 always obeys file local variable specifications and the -*- line,
449 and ignores this variable."
450 :type '(choice (const :tag "Obey" t)
451 (const :tag "Ignore" nil)
452 (other :tag "Query" other))
455 (defvar local-enable-local-variables t
456 "Like `enable-local-variables' but meant for buffer-local bindings.
457 The meaningful values are nil and non-nil. The default is non-nil.
458 If a major mode sets this to nil, buffer-locally, then any local
459 variables list in the file will be ignored.
461 This variable does not affect the use of major modes
462 specified in a -*- line.")
464 (defcustom enable-local-eval 'maybe
465 "*Control processing of the \"variable\" `eval' in a file's local variables.
466 The value can be t, nil or something else.
467 A value of t means obey `eval' variables;
468 nil means ignore them; anything else means query."
469 :type '(choice (const :tag "Obey" t)
470 (const :tag "Ignore" nil)
471 (other :tag "Query" other))
474 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
475 (or (fboundp 'lock-buffer)
476 (defalias 'lock-buffer 'ignore))
477 (or (fboundp 'unlock-buffer)
478 (defalias 'unlock-buffer 'ignore))
479 (or (fboundp 'file-locked-p)
480 (defalias 'file-locked-p 'ignore))
482 (defcustom view-read-only nil
483 "*Non-nil means buffers visiting files read-only do so in view mode.
484 In fact, this means that all read-only buffers normally have
485 View mode enabled, including buffers that are read-only because
486 you visit a file you cannot alter, and buffers you make read-only
487 using \\[toggle-read-only]."
491 (put 'ange-ftp-completion-hook-function 'safe-magic t)
492 (defun ange-ftp-completion-hook-function (op &rest args)
493 "Provides support for ange-ftp host name completion.
494 Runs the usual ange-ftp hook, but only for completion operations."
495 ;; Having this here avoids the need to load ange-ftp when it's not
497 (if (memq op '(file-name-completion file-name-all-completions))
498 (apply 'ange-ftp-hook-function op args)
499 (let ((inhibit-file-name-handlers
500 (cons 'ange-ftp-completion-hook-function
501 (and (eq inhibit-file-name-operation op)
502 inhibit-file-name-handlers)))
503 (inhibit-file-name-operation op))
506 (defun convert-standard-filename (filename)
507 "Convert a standard file's name to something suitable for the OS.
508 This means to guarantee valid names and perhaps to canonicalize
511 This function's standard definition is trivial; it just returns
512 the argument. However, on Windows and DOS, replace invalid
513 characters. On DOS, make sure to obey the 8.3 limitations. On
514 Windows, turn Cygwin names into native names, and also turn
515 slashes into backslashes if the shell requires it (see
516 `w32-shell-dos-semantics').
518 See Info node `(elisp)Standard File Names' for more details."
521 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
522 "Read directory name, prompting with PROMPT and completing in directory DIR.
523 Value is not expanded---you must call `expand-file-name' yourself.
524 Default name to DEFAULT-DIRNAME if user exits with the same
525 non-empty string that was inserted by this function.
526 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
527 except that if INITIAL is specified, that combined with DIR is used.)
528 If the user exits with an empty minibuffer, this function returns
529 an empty string. (This can only happen if the user erased the
530 pre-inserted contents or if `insert-default-directory' is nil.)
531 Fourth arg MUSTMATCH non-nil means require existing directory's name.
532 Non-nil and non-t means also require confirmation after completion.
533 Fifth arg INITIAL specifies text to start with.
534 DIR should be an absolute directory name. It defaults to
535 the value of `default-directory'."
537 (setq dir default-directory))
538 (unless default-dirname
539 (setq default-dirname
540 (if initial (concat dir initial) default-directory)))
541 (read-file-name prompt dir default-dirname mustmatch initial
546 "Show the current default directory."
548 (message "Directory %s" default-directory))
551 "Value of the CDPATH environment variable, as a list.
552 Not actually set up until the first time you use it.")
554 (defun parse-colon-path (cd-path)
555 "Explode a search path into a list of directory names.
556 Directories are separated by occurrences of `path-separator'
557 \(which is colon in GNU and GNU-like systems)."
558 ;; We could use split-string here.
560 (let (cd-list (cd-start 0) cd-colon)
561 (setq cd-path (concat cd-path path-separator))
562 (while (setq cd-colon (string-match path-separator cd-path cd-start))
565 (list (if (= cd-start cd-colon)
567 (substitute-in-file-name
568 (file-name-as-directory
569 (substring cd-path cd-start cd-colon)))))))
570 (setq cd-start (+ cd-colon 1)))
573 (defun cd-absolute (dir)
574 "Change current directory to given absolute file name DIR."
575 ;; Put the name into directory syntax now,
576 ;; because otherwise expand-file-name may give some bad results.
577 (if (not (eq system-type 'vax-vms))
578 (setq dir (file-name-as-directory dir)))
579 (setq dir (abbreviate-file-name (expand-file-name dir)))
580 (if (not (file-directory-p dir))
581 (if (file-exists-p dir)
582 (error "%s is not a directory" dir)
583 (error "%s: no such directory" dir))
584 (if (file-executable-p dir)
585 (setq default-directory dir)
586 (error "Cannot cd to %s: Permission denied" dir))))
589 "Make DIR become the current buffer's default directory.
590 If your environment includes a `CDPATH' variable, try each one of
591 that list of directories (separated by occurrences of
592 `path-separator') when resolving a relative directory name.
593 The path separator is colon in GNU and GNU-like systems."
595 (list (read-directory-name "Change default directory: "
596 default-directory default-directory
597 (and (member cd-path '(nil ("./")))
598 (null (getenv "CDPATH"))))))
599 (if (file-name-absolute-p dir)
600 (cd-absolute (expand-file-name dir))
602 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
603 (setq cd-path (or trypath (list "./")))))
604 (if (not (catch 'found
606 (function (lambda (x)
607 (let ((f (expand-file-name (concat x dir))))
608 (if (file-directory-p f)
611 (throw 'found t))))))
614 (error "No such directory found via CDPATH environment variable"))))
616 (defun load-file (file)
617 "Load the Lisp file named FILE."
618 ;; This is a case where .elc makes a lot of sense.
619 (interactive (list (let ((completion-ignored-extensions
620 (remove ".elc" completion-ignored-extensions)))
621 (read-file-name "Load file: "))))
622 (load (expand-file-name file) nil nil t))
624 (defun locate-file (filename path &optional suffixes predicate)
625 "Search for FILENAME through PATH.
626 If SUFFIXES is non-nil, it should be a list of suffixes to append to
627 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
628 If non-nil, PREDICATE is used instead of `file-readable-p'.
629 PREDICATE can also be an integer to pass to the `access' system call,
630 in which case file-name handlers are ignored. This usage is deprecated.
632 For compatibility, PREDICATE can also be one of the symbols
633 `executable', `readable', `writable', or `exists', or a list of
634 one or more of those symbols."
635 (if (and predicate (symbolp predicate) (not (functionp predicate)))
636 (setq predicate (list predicate)))
637 (when (and (consp predicate) (not (functionp predicate)))
639 (logior (if (memq 'executable predicate) 1 0)
640 (if (memq 'writable predicate) 2 0)
641 (if (memq 'readable predicate) 4 0))))
642 (locate-file-internal filename path suffixes predicate))
644 (defun locate-file-completion (string path-and-suffixes action)
645 "Do completion for file names passed to `locate-file'.
646 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
647 (if (file-name-absolute-p string)
648 (read-file-name-internal string nil action)
650 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
651 (string-dir (file-name-directory string)))
652 (dolist (dir (car path-and-suffixes))
654 (setq dir default-directory))
655 (if string-dir (setq dir (expand-file-name string-dir dir)))
656 (when (file-directory-p dir)
657 (dolist (file (file-name-all-completions
658 (file-name-nondirectory string) dir))
659 (push (if string-dir (concat string-dir file) file) names)
660 (when (string-match suffix file)
661 (setq file (substring file 0 (match-beginning 0)))
662 (push (if string-dir (concat string-dir file) file) names)))))
664 ((eq action t) (all-completions string names))
665 ((null action) (try-completion string names))
666 (t (test-completion string names))))))
668 (defun load-library (library)
669 "Load the library named LIBRARY.
670 This is an interface to the function `load'."
672 (list (completing-read "Load library: "
673 'locate-file-completion
674 (cons load-path load-suffixes))))
677 (defun file-remote-p (file)
678 "Test whether FILE specifies a location on a remote system.
679 Return an identification of the system if the location is indeed
680 remote. The identification of the system may comprise a method
681 to access the system and its hostname, amongst other things.
683 For example, the filename \"/user@host:/foo\" specifies a location
684 on the system \"/user@host:\"."
685 (let ((handler (find-file-name-handler file 'file-remote-p)))
687 (funcall handler 'file-remote-p file)
690 (defun file-local-copy (file)
691 "Copy the file FILE into a temporary file on this machine.
692 Returns the name of the local copy, or nil, if FILE is directly
694 ;; This formerly had an optional BUFFER argument that wasn't used by
696 (let ((handler (find-file-name-handler file 'file-local-copy)))
698 (funcall handler 'file-local-copy file)
701 (defun file-truename (filename &optional counter prev-dirs)
702 "Return the truename of FILENAME, which should be absolute.
703 The truename of a file name is found by chasing symbolic links
704 both at the level of the file and at the level of the directories
705 containing it, until no links are left at any level.
707 \(fn FILENAME)" ;; Don't document the optional arguments.
708 ;; COUNTER and PREV-DIRS are only used in recursive calls.
709 ;; COUNTER can be a cons cell whose car is the count of how many
710 ;; more links to chase before getting an error.
711 ;; PREV-DIRS can be a cons cell whose car is an alist
712 ;; of truenames we've just recently computed.
713 (cond ((or (string= filename "") (string= filename "~"))
714 (setq filename (expand-file-name filename))
715 (if (string= filename "")
716 (setq filename "/")))
717 ((and (string= (substring filename 0 1) "~")
718 (string-match "~[^/]*/?" filename))
720 (substring filename 0 (match-end 0)))
721 (rest (substring filename (match-end 0))))
722 (setq filename (concat (expand-file-name first-part) rest)))))
724 (or counter (setq counter (list 100)))
726 ;; For speed, remove the ange-ftp completion handler from the list.
727 ;; We know it's not needed here.
728 ;; For even more speed, do this only on the outermost call.
729 (file-name-handler-alist
730 (if prev-dirs file-name-handler-alist
731 (let ((tem (copy-sequence file-name-handler-alist)))
732 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
733 (or prev-dirs (setq prev-dirs (list nil)))
735 ;; andrewi@harlequin.co.uk - none of the following code (except for
736 ;; invoking the file-name handler) currently applies on Windows
737 ;; (ie. there are no native symlinks), but there is an issue with
738 ;; case differences being ignored by the OS, and short "8.3 DOS"
739 ;; name aliases existing for all files. (The short names are not
740 ;; reported by directory-files, but can be used to refer to files.)
741 ;; It seems appropriate for file-truename to resolve these issues in
742 ;; the most natural way, which on Windows is to call the function
743 ;; `w32-long-file-name' - this returns the exact name of a file as
744 ;; it is stored on disk (expanding short name aliases with the full
745 ;; name in the process).
746 (if (eq system-type 'windows-nt)
747 (let ((handler (find-file-name-handler filename 'file-truename)))
748 ;; For file name that has a special handler, call handler.
749 ;; This is so that ange-ftp can save time by doing a no-op.
751 (setq filename (funcall handler 'file-truename filename))
752 ;; If filename contains a wildcard, newname will be the old name.
753 (unless (string-match "[[*?]" filename)
754 ;; If filename exists, use the long name
755 (setq filename (or (w32-long-file-name filename) filename))))
758 ;; If this file directly leads to a link, process that iteratively
759 ;; so that we don't use lots of stack.
761 (setcar counter (1- (car counter)))
762 (if (< (car counter) 0)
763 (error "Apparent cycle of symbolic links for %s" filename))
764 (let ((handler (find-file-name-handler filename 'file-truename)))
765 ;; For file name that has a special handler, call handler.
766 ;; This is so that ange-ftp can save time by doing a no-op.
768 (setq filename (funcall handler 'file-truename filename)
770 (let ((dir (or (file-name-directory filename) default-directory))
772 ;; Get the truename of the directory.
773 (setq dirfile (directory-file-name dir))
774 ;; If these are equal, we have the (or a) root directory.
775 (or (string= dir dirfile)
776 ;; If this is the same dir we last got the truename for,
777 ;; save time--don't recalculate.
778 (if (assoc dir (car prev-dirs))
779 (setq dir (cdr (assoc dir (car prev-dirs))))
781 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
782 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
784 (if (equal ".." (file-name-nondirectory filename))
786 (directory-file-name (file-name-directory (directory-file-name dir)))
788 (if (equal "." (file-name-nondirectory filename))
789 (setq filename (directory-file-name dir)
791 ;; Put it back on the file name.
792 (setq filename (concat dir (file-name-nondirectory filename)))
793 ;; Is the file name the name of a link?
794 (setq target (file-symlink-p filename))
796 ;; Yes => chase that link, then start all over
797 ;; since the link may point to a directory name that uses links.
798 ;; We can't safely use expand-file-name here
799 ;; since target might look like foo/../bar where foo
800 ;; is itself a link. Instead, we handle . and .. above.
802 (if (file-name-absolute-p target)
810 (defun file-chase-links (filename &optional limit)
811 "Chase links in FILENAME until a name that is not a link.
812 Unlike `file-truename', this does not check whether a parent
813 directory name is a symbolic link.
814 If the optional argument LIMIT is a number,
815 it means chase no more than that many links and then stop."
816 (let (tem (newname filename)
818 (while (and (or (null limit) (< count limit))
819 (setq tem (file-symlink-p newname)))
821 (if (and (null limit) (= count 100))
822 (error "Apparent cycle of symbolic links for %s" filename))
823 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
824 (while (string-match "//+" tem)
825 (setq tem (replace-match "/" nil nil tem)))
826 ;; Handle `..' by hand, since it needs to work in the
827 ;; target of any directory symlink.
828 ;; This code is not quite complete; it does not handle
829 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
830 (while (string-match "\\`\\.\\./" tem)
831 (setq tem (substring tem 3))
832 (setq newname (expand-file-name newname))
833 ;; Chase links in the default dir of the symlink.
836 (directory-file-name (file-name-directory newname))))
837 ;; Now find the parent of that dir.
838 (setq newname (file-name-directory newname)))
839 (setq newname (expand-file-name tem (file-name-directory newname)))
840 (setq count (1+ count))))
843 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
844 "Change the encoding of FILE's name from CODING to NEW-CODING.
845 The value is a new name of FILE.
846 Signals a `file-already-exists' error if a file of the new name
847 already exists unless optional third argument OK-IF-ALREADY-EXISTS
848 is non-nil. A number as third arg means request confirmation if
849 the new name already exists. This is what happens in interactive
852 (let ((default-coding (or file-name-coding-system
853 default-file-name-coding-system))
854 (filename (read-file-name "Recode filename: " nil nil t))
855 from-coding to-coding)
856 (if (and default-coding
857 ;; We provide the default coding only when it seems that
858 ;; the filename is correctly decoded by the default
860 (let ((charsets (find-charset-string filename)))
861 (and (not (memq 'eight-bit-control charsets))
862 (not (memq 'eight-bit-graphic charsets)))))
863 (setq from-coding (read-coding-system
864 (format "Recode filename %s from (default %s): "
865 filename default-coding)
867 (setq from-coding (read-coding-system
868 (format "Recode filename %s from: " filename))))
870 ;; We provide the default coding only when a user is going to
871 ;; change the encoding not from the default coding.
872 (if (eq from-coding default-coding)
873 (setq to-coding (read-coding-system
874 (format "Recode filename %s from %s to: "
875 filename from-coding)))
876 (setq to-coding (read-coding-system
877 (format "Recode filename %s from %s to (default %s): "
878 filename from-coding default-coding)
880 (list filename from-coding to-coding)))
882 (let* ((default-coding (or file-name-coding-system
883 default-file-name-coding-system))
884 ;; FILE should have been decoded by DEFAULT-CODING.
885 (encoded (encode-coding-string file default-coding))
886 (newname (decode-coding-string encoded coding))
887 (new-encoded (encode-coding-string newname new-coding))
888 ;; Suppress further encoding.
889 (file-name-coding-system nil)
890 (default-file-name-coding-system nil)
891 (locale-coding-system nil))
892 (rename-file encoded new-encoded ok-if-already-exists)
895 (defun switch-to-buffer-other-window (buffer &optional norecord)
896 "Select buffer BUFFER in another window.
897 If BUFFER does not identify an existing buffer, then this function
898 creates a buffer with that name.
900 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
901 or nil. If BUFFER is nil, then this function chooses a buffer
902 using `other-buffer'.
903 Optional second arg NORECORD non-nil means
904 do not put this buffer at the front of the list of recently selected ones.
905 This function returns the buffer it switched to.
907 This uses the function `display-buffer' as a subroutine; see its
908 documentation for additional customization information."
909 (interactive "BSwitch to buffer in other window: ")
910 (let ((pop-up-windows t)
911 ;; Don't let these interfere.
912 same-window-buffer-names same-window-regexps)
913 (pop-to-buffer buffer t norecord)))
915 (defun switch-to-buffer-other-frame (buffer &optional norecord)
916 "Switch to buffer BUFFER in another frame.
917 Optional second arg NORECORD non-nil means
918 do not put this buffer at the front of the list of recently selected ones.
920 This uses the function `display-buffer' as a subroutine; see its
921 documentation for additional customization information."
922 (interactive "BSwitch to buffer in other frame: ")
923 (let ((pop-up-frames t)
924 same-window-buffer-names same-window-regexps)
925 (pop-to-buffer buffer t norecord)
926 (raise-frame (window-frame (selected-window)))))
928 (defvar find-file-default nil
929 "Used within `find-file-read-args'.")
931 (defun find-file-read-args (prompt mustmatch)
932 (list (let ((find-file-default
933 (and buffer-file-name
934 (abbreviate-file-name buffer-file-name)))
937 (setq minibuffer-default find-file-default)
938 ;; Clear out this hook so it does not interfere
939 ;; with any recursive minibuffer usage.
940 (pop minibuffer-setup-hook)))
941 (minibuffer-setup-hook
942 minibuffer-setup-hook))
943 (add-hook 'minibuffer-setup-hook munge-default-fun)
944 (read-file-name prompt nil default-directory mustmatch))
947 (defun find-file (filename &optional wildcards)
949 Switch to a buffer visiting file FILENAME,
950 creating one if none already exists.
951 Interactively, the default if you just type RET is the current directory,
952 but the visited file name is available through the minibuffer history:
953 type M-n to pull it into the minibuffer.
955 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
956 expand wildcards (if any) and visit multiple files. You can
957 suppress wildcard expansion by setting `find-file-wildcards'.
959 To visit a file without any kind of conversion and without
960 automatically choosing a major mode, use \\[find-file-literally]."
961 (interactive (find-file-read-args "Find file: " nil))
962 (let ((value (find-file-noselect filename nil nil wildcards)))
964 (mapcar 'switch-to-buffer (nreverse value))
965 (switch-to-buffer value))))
967 (defun find-file-other-window (filename &optional wildcards)
968 "Edit file FILENAME, in another window.
969 May create a new window, or reuse an existing one.
970 See the function `display-buffer'.
972 Interactively, the default if you just type RET is the current directory,
973 but the visited file name is available through the minibuffer history:
974 type M-n to pull it into the minibuffer.
976 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
977 expand wildcards (if any) and visit multiple files."
978 (interactive (find-file-read-args "Find file in other window: " nil))
979 (let ((value (find-file-noselect filename nil nil wildcards)))
982 (setq value (nreverse value))
983 (cons (switch-to-buffer-other-window (car value))
984 (mapcar 'switch-to-buffer (cdr value))))
985 (switch-to-buffer-other-window value))))
987 (defun find-file-other-frame (filename &optional wildcards)
988 "Edit file FILENAME, in another frame.
989 May create a new frame, or reuse an existing one.
990 See the function `display-buffer'.
992 Interactively, the default if you just type RET is the current directory,
993 but the visited file name is available through the minibuffer history:
994 type M-n to pull it into the minibuffer.
996 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
997 expand wildcards (if any) and visit multiple files."
998 (interactive (find-file-read-args "Find file in other frame: " nil))
999 (let ((value (find-file-noselect filename nil nil wildcards)))
1002 (setq value (nreverse value))
1003 (cons (switch-to-buffer-other-frame (car value))
1004 (mapcar 'switch-to-buffer (cdr value))))
1005 (switch-to-buffer-other-frame value))))
1007 (defun find-file-existing (filename &optional wildcards)
1008 "Edit the existing file FILENAME.
1009 Like \\[find-file] but only allow files that exists."
1010 (interactive (find-file-read-args "Find existing file: " t))
1011 (unless (file-exists-p filename) (error "%s does not exist" filename))
1012 (find-file filename wildcards)
1015 (defun find-file-read-only (filename &optional wildcards)
1016 "Edit file FILENAME but don't allow changes.
1017 Like \\[find-file] but marks buffer as read-only.
1018 Use \\[toggle-read-only] to permit editing."
1019 (interactive (find-file-read-args "Find file read-only: " nil))
1020 (unless (or (and wildcards find-file-wildcards
1021 (not (string-match "\\`/:" filename))
1022 (string-match "[[*?]" filename))
1023 (file-exists-p filename))
1024 (error "%s does not exist" filename))
1025 (let ((value (find-file filename wildcards)))
1026 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1027 (if (listp value) value (list value)))
1030 (defun find-file-read-only-other-window (filename &optional wildcards)
1031 "Edit file FILENAME in another window but don't allow changes.
1032 Like \\[find-file-other-window] but marks buffer as read-only.
1033 Use \\[toggle-read-only] to permit editing."
1034 (interactive (find-file-read-args "Find file read-only other window: " nil))
1035 (unless (or (and wildcards find-file-wildcards
1036 (not (string-match "\\`/:" filename))
1037 (string-match "[[*?]" filename))
1038 (file-exists-p filename))
1039 (error "%s does not exist" filename))
1040 (let ((value (find-file-other-window filename wildcards)))
1041 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1042 (if (listp value) value (list value)))
1045 (defun find-file-read-only-other-frame (filename &optional wildcards)
1046 "Edit file FILENAME in another frame but don't allow changes.
1047 Like \\[find-file-other-frame] but marks buffer as read-only.
1048 Use \\[toggle-read-only] to permit editing."
1049 (interactive (find-file-read-args "Find file read-only other frame: " nil))
1050 (unless (or (and wildcards find-file-wildcards
1051 (not (string-match "\\`/:" filename))
1052 (string-match "[[*?]" filename))
1053 (file-exists-p filename))
1054 (error "%s does not exist" filename))
1055 (let ((value (find-file-other-frame filename wildcards)))
1056 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1057 (if (listp value) value (list value)))
1060 (defun find-alternate-file-other-window (filename &optional wildcards)
1061 "Find file FILENAME as a replacement for the file in the next window.
1062 This command does not select that window.
1064 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1065 expand wildcards (if any) and replace the file with multiple files."
1067 (save-selected-window
1069 (let ((file buffer-file-name)
1073 (setq file-name (file-name-nondirectory file)
1074 file-dir (file-name-directory file)))
1075 (list (read-file-name
1076 "Find alternate file: " file-dir nil nil file-name)
1079 (find-file-other-window filename wildcards)
1080 (save-selected-window
1082 (find-alternate-file filename wildcards))))
1084 (defun find-alternate-file (filename &optional wildcards)
1085 "Find file FILENAME, select its buffer, kill previous buffer.
1086 If the current buffer now contains an empty file that you just visited
1087 \(presumably by mistake), use this command to visit the file you really want.
1089 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1090 expand wildcards (if any) and replace the file with multiple files."
1092 (let ((file buffer-file-name)
1096 (setq file-name (file-name-nondirectory file)
1097 file-dir (file-name-directory file)))
1098 (list (read-file-name
1099 "Find alternate file: " file-dir nil nil file-name)
1101 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1103 (when (and (buffer-modified-p) (buffer-file-name))
1104 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1107 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1108 (error "Aborted"))))
1109 (let ((obuf (current-buffer))
1110 (ofile buffer-file-name)
1111 (onum buffer-file-number)
1112 (odir dired-directory)
1113 (otrue buffer-file-truename)
1114 (oname (buffer-name)))
1115 (if (get-buffer " **lose**")
1116 (kill-buffer " **lose**"))
1117 (rename-buffer " **lose**")
1121 ;; This prevents us from finding the same buffer
1122 ;; if we specified the same file again.
1123 (setq buffer-file-name nil)
1124 (setq buffer-file-number nil)
1125 (setq buffer-file-truename nil)
1126 ;; Likewise for dired buffers.
1127 (setq dired-directory nil)
1128 (find-file filename wildcards))
1129 (when (eq obuf (current-buffer))
1130 ;; This executes if find-file gets an error
1131 ;; and does not really find anything.
1132 ;; We put things back as they were.
1133 ;; If find-file actually finds something, we kill obuf below.
1134 (setq buffer-file-name ofile)
1135 (setq buffer-file-number onum)
1136 (setq buffer-file-truename otrue)
1137 (setq dired-directory odir)
1139 (rename-buffer oname)))
1140 (unless (eq (current-buffer) obuf)
1141 (with-current-buffer obuf
1142 ;; We already asked; don't ask again.
1143 (let ((kill-buffer-query-functions))
1144 (kill-buffer obuf))))))
1146 (defun create-file-buffer (filename)
1147 "Create a suitably named buffer for visiting FILENAME, and return it.
1148 FILENAME (sans directory) is used unchanged if that name is free;
1149 otherwise a string <2> or <3> or ... is appended to get an unused name."
1150 (let ((lastname (file-name-nondirectory filename)))
1151 (if (string= lastname "")
1152 (setq lastname filename))
1153 (generate-new-buffer lastname)))
1155 (defun generate-new-buffer (name)
1156 "Create and return a buffer with a name based on NAME.
1157 Choose the buffer's name using `generate-new-buffer-name'."
1158 (get-buffer-create (generate-new-buffer-name name)))
1160 (defcustom automount-dir-prefix "^/tmp_mnt/"
1161 "Regexp to match the automounter prefix in a directory name."
1165 (defvar abbreviated-home-dir nil
1166 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1168 (defun abbreviate-file-name (filename)
1169 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1170 This also substitutes \"~\" for the user's home directory and
1171 removes automounter prefixes (see the variable `automount-dir-prefix')."
1172 ;; Get rid of the prefixes added by the automounter.
1173 (if (and automount-dir-prefix
1174 (string-match automount-dir-prefix filename)
1175 (file-exists-p (file-name-directory
1176 (substring filename (1- (match-end 0))))))
1177 (setq filename (substring filename (1- (match-end 0)))))
1178 (let ((tail directory-abbrev-alist))
1179 ;; If any elt of directory-abbrev-alist matches this name,
1180 ;; abbreviate accordingly.
1182 (if (string-match (car (car tail)) filename)
1184 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1185 (setq tail (cdr tail)))
1186 ;; Compute and save the abbreviated homedir name.
1187 ;; We defer computing this until the first time it's needed, to
1188 ;; give time for directory-abbrev-alist to be set properly.
1189 ;; We include a slash at the end, to avoid spurious matches
1190 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1191 (or abbreviated-home-dir
1192 (setq abbreviated-home-dir
1193 (let ((abbreviated-home-dir "$foo"))
1194 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1197 ;; If FILENAME starts with the abbreviated homedir,
1198 ;; make it start with `~' instead.
1199 (if (and (string-match abbreviated-home-dir filename)
1200 ;; If the home dir is just /, don't change it.
1201 (not (and (= (match-end 0) 1)
1202 (= (aref filename 0) ?/)))
1203 ;; MS-DOS root directories can come with a drive letter;
1204 ;; Novell Netware allows drive letters beyond `Z:'.
1205 (not (and (or (eq system-type 'ms-dos)
1206 (eq system-type 'cygwin)
1207 (eq system-type 'windows-nt))
1209 (string-match "^[a-zA-`]:/$" filename)))))
1212 (substring filename (match-beginning 1) (match-end 1))
1213 (substring filename (match-end 0)))))
1216 (defcustom find-file-not-true-dirname-list nil
1217 "*List of logical names for which visiting shouldn't save the true dirname.
1218 On VMS, when you visit a file using a logical name that searches a path,
1219 you may or may not want the visited file name to record the specific
1220 directory where the file was found. If you *do not* want that, add the logical
1221 name to this list as a string."
1222 :type '(repeat (string :tag "Name"))
1225 (defun find-buffer-visiting (filename &optional predicate)
1226 "Return the buffer visiting file FILENAME (a string).
1227 This is like `get-file-buffer', except that it checks for any buffer
1228 visiting the same file, possibly under a different name.
1229 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1230 and others are ignored.
1231 If there is no such live buffer, return nil."
1232 (let ((predicate (or predicate #'identity))
1233 (truename (abbreviate-file-name (file-truename filename))))
1234 (or (let ((buf (get-file-buffer filename)))
1235 (when (and buf (funcall predicate buf)) buf))
1236 (let ((list (buffer-list)) found)
1237 (while (and (not found) list)
1239 (set-buffer (car list))
1240 (if (and buffer-file-name
1241 (string= buffer-file-truename truename)
1242 (funcall predicate (current-buffer)))
1243 (setq found (car list))))
1244 (setq list (cdr list)))
1246 (let* ((attributes (file-attributes truename))
1247 (number (nthcdr 10 attributes))
1248 (list (buffer-list)) found)
1249 (and buffer-file-numbers-unique
1251 (while (and (not found) list)
1252 (with-current-buffer (car list)
1253 (if (and buffer-file-name
1254 (equal buffer-file-number number)
1255 ;; Verify this buffer's file number
1256 ;; still belongs to its file.
1257 (file-exists-p buffer-file-name)
1258 (equal (file-attributes buffer-file-truename)
1260 (funcall predicate (current-buffer)))
1261 (setq found (car list))))
1262 (setq list (cdr list))))
1265 (defcustom find-file-wildcards t
1266 "*Non-nil means file-visiting commands should handle wildcards.
1267 For example, if you specify `*.c', that would visit all the files
1268 whose names match the pattern."
1273 (defcustom find-file-suppress-same-file-warnings nil
1274 "*Non-nil means suppress warning messages for symlinked files.
1275 When nil, Emacs prints a warning when visiting a file that is already
1276 visited, but with a different name. Setting this option to t
1277 suppresses this warning."
1282 (defcustom large-file-warning-threshold 10000000
1283 "Maximum size of file above which a confirmation is requested.
1284 When nil, never request confirmation."
1288 :type '(choice integer (const :tag "Never request confirmation" nil)))
1290 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1291 "Read file FILENAME into a buffer and return the buffer.
1292 If a buffer exists visiting FILENAME, return that one, but
1293 verify that the file has not changed since visited or saved.
1294 The buffer is not selected, just returned to the caller.
1295 Optional first arg NOWARN non-nil means suppress any warning messages.
1296 Optional second arg RAWFILE non-nil means the file is read literally.
1297 Optional third arg WILDCARDS non-nil means do wildcard processing
1298 and visit all the matching files. When wildcards are actually
1299 used and expanded, return a list of buffers that are visiting
1302 (abbreviate-file-name
1303 (expand-file-name filename)))
1304 (if (file-directory-p filename)
1305 (or (and find-file-run-dired
1306 (run-hook-with-args-until-success
1307 'find-directory-functions
1308 (if find-file-visit-truename
1309 (abbreviate-file-name (file-truename filename))
1311 (error "%s is a directory" filename))
1314 (not (string-match "\\`/:" filename))
1315 (string-match "[[*?]" filename))
1316 (let ((files (condition-case nil
1317 (file-expand-wildcards filename t)
1318 (error (list filename))))
1319 (find-file-wildcards nil))
1321 (find-file-noselect filename)
1322 (mapcar #'find-file-noselect files)))
1323 (let* ((buf (get-file-buffer filename))
1324 (truename (abbreviate-file-name (file-truename filename)))
1325 (attributes (file-attributes truename))
1326 (number (nthcdr 10 attributes))
1327 ;; Find any buffer for a file which has same truename.
1328 (other (and (not buf) (find-buffer-visiting filename))))
1329 ;; Let user know if there is a buffer with the same truename.
1333 find-file-suppress-same-file-warnings
1334 (string-equal filename (buffer-file-name other))
1335 (message "%s and %s are the same file"
1336 filename (buffer-file-name other)))
1337 ;; Optionally also find that buffer.
1338 (if (or find-file-existing-other-name find-file-visit-truename)
1340 ;; Check to see if the file looks uncommonly large.
1341 (when (and large-file-warning-threshold (nth 7 attributes)
1342 ;; Don't ask again if we already have the file or
1343 ;; if we're asked to be quiet.
1344 (not (or buf nowarn))
1345 (> (nth 7 attributes) large-file-warning-threshold)
1347 (format "File %s is large (%sMB), really open? "
1348 (file-name-nondirectory filename)
1349 (/ (nth 7 attributes) 1048576)))))
1352 ;; We are using an existing buffer.
1355 (verify-visited-file-modtime buf)
1356 (cond ((not (file-exists-p filename))
1357 (error "File %s no longer exists!" filename))
1358 ;; Certain files should be reverted automatically
1359 ;; if they have changed on disk and not in the buffer.
1360 ((and (not (buffer-modified-p buf))
1361 (let ((tail revert-without-query)
1364 (if (string-match (car tail) filename)
1366 (setq tail (cdr tail)))
1368 (with-current-buffer buf
1369 (message "Reverting file %s..." filename)
1371 (message "Reverting file %s...done" filename)))
1373 (if (string= (file-name-nondirectory filename)
1376 (if (buffer-modified-p buf)
1377 "File %s changed on disk. Discard your edits? "
1378 "File %s changed on disk. Reread from disk? ")
1379 (file-name-nondirectory filename))
1381 (if (buffer-modified-p buf)
1382 "File %s changed on disk. Discard your edits in %s? "
1383 "File %s changed on disk. Reread from disk into %s? ")
1384 (file-name-nondirectory filename)
1385 (buffer-name buf))))
1386 (with-current-buffer buf
1387 (revert-buffer t t)))))
1388 (with-current-buffer buf
1390 ;; Check if a formerly read-only file has become
1391 ;; writable and vice versa, but if the buffer agrees
1392 ;; with the new state of the file, that is ok too.
1393 (let ((read-only (not (file-writable-p buffer-file-name))))
1394 (unless (or (eq read-only buffer-file-read-only)
1395 (eq read-only buffer-read-only))
1398 (format "File %s is %s on disk. Change buffer mode? "
1400 (if read-only "read-only" "writable"))))
1401 (y-or-n-p question)))
1402 (setq buffer-read-only read-only)))
1403 (setq buffer-file-read-only read-only))
1405 (when (and (not (eq (not (null rawfile))
1406 (not (null find-file-literally))))
1407 ;; It is confusing to ask whether to visit
1408 ;; non-literally if they have the file in
1410 (not (eq major-mode 'hexl-mode)))
1411 (if (buffer-modified-p)
1412 (if (y-or-n-p (if rawfile
1413 "Save file and revisit literally? "
1414 "Save file and revisit non-literally? "))
1417 (find-file-noselect-1 buf filename nowarn
1418 rawfile truename number))
1419 (if (y-or-n-p (if rawfile
1420 "Discard your edits and revisit file literally? "
1421 "Discard your edits and revisit file non-literally? "))
1422 (find-file-noselect-1 buf filename nowarn
1423 rawfile truename number)
1424 (error (if rawfile "File already visited non-literally"
1425 "File already visited literally"))))
1426 (if (y-or-n-p (if rawfile
1427 "Revisit file literally? "
1428 "Revisit file non-literally? "))
1429 (find-file-noselect-1 buf filename nowarn
1430 rawfile truename number)
1431 (error (if rawfile "File already visited non-literally"
1432 "File already visited literally"))))))
1433 ;; Return the buffer we are using.
1435 ;; Create a new buffer.
1436 (setq buf (create-file-buffer filename))
1437 (set-buffer-major-mode buf)
1438 ;; find-file-noselect-1 may use a different buffer.
1439 (find-file-noselect-1 buf filename nowarn
1440 rawfile truename number))))))
1442 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1444 (with-current-buffer buf
1445 (kill-local-variable 'find-file-literally)
1446 ;; Needed in case we are re-visiting the file with a different
1447 ;; text representation.
1448 (kill-local-variable 'buffer-file-coding-system)
1449 (kill-local-variable 'cursor-type)
1450 (let ((inhibit-read-only t))
1452 (and (default-value 'enable-multibyte-characters)
1454 (set-buffer-multibyte t))
1457 (let ((inhibit-read-only t))
1458 (insert-file-contents-literally filename t))
1460 (when (and (file-exists-p filename)
1461 (not (file-readable-p filename)))
1463 (signal 'file-error (list "File is not readable"
1465 ;; Unconditionally set error
1468 (let ((inhibit-read-only t))
1469 (insert-file-contents filename t))
1471 (when (and (file-exists-p filename)
1472 (not (file-readable-p filename)))
1474 (signal 'file-error (list "File is not readable"
1476 ;; Run find-file-not-found-hooks until one returns non-nil.
1477 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1478 ;; If they fail too, set error.
1480 ;; Record the file's truename, and maybe use that as visited name.
1481 (if (equal filename buffer-file-name)
1482 (setq buffer-file-truename truename)
1483 (setq buffer-file-truename
1484 (abbreviate-file-name (file-truename buffer-file-name))))
1485 (setq buffer-file-number number)
1486 ;; On VMS, we may want to remember which directory in a search list
1487 ;; the file was found in.
1488 (and (eq system-type 'vax-vms)
1490 (if (string-match ":" (file-name-directory filename))
1491 (setq logical (substring (file-name-directory filename)
1492 0 (match-beginning 0))))
1493 (not (member logical find-file-not-true-dirname-list)))
1494 (setq buffer-file-name buffer-file-truename))
1495 (if find-file-visit-truename
1496 (setq buffer-file-name
1498 (expand-file-name buffer-file-truename))))
1499 ;; Set buffer's default directory to that of the file.
1500 (setq default-directory (file-name-directory buffer-file-name))
1501 ;; Turn off backup files for certain file names. Since
1502 ;; this is a permanent local, the major mode won't eliminate it.
1503 (and (not (funcall backup-enable-predicate buffer-file-name))
1505 (make-local-variable 'backup-inhibited)
1506 (setq backup-inhibited t)))
1509 (set-buffer-multibyte nil)
1510 (setq buffer-file-coding-system 'no-conversion)
1511 (make-local-variable 'find-file-literally)
1512 (setq find-file-literally t))
1513 (after-find-file error (not nowarn)))
1516 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1517 "Like `insert-file-contents', but only reads in the file literally.
1518 A buffer may be modified in several ways after reading into the buffer,
1519 to Emacs features such as format decoding, character code
1520 conversion, `find-file-hook', automatic uncompression, etc.
1522 This function ensures that none of these modifications will take place."
1523 (let ((format-alist nil)
1524 (after-insert-file-functions nil)
1525 (coding-system-for-read 'no-conversion)
1526 (coding-system-for-write 'no-conversion)
1527 (find-buffer-file-type-function
1528 (if (fboundp 'find-buffer-file-type)
1529 (symbol-function 'find-buffer-file-type)
1531 (inhibit-file-name-handlers
1532 (append '(jka-compr-handler image-file-handler)
1533 inhibit-file-name-handlers))
1534 (inhibit-file-name-operation 'insert-file-contents))
1537 (fset 'find-buffer-file-type (lambda (filename) t))
1538 (insert-file-contents filename visit beg end replace))
1539 (if find-buffer-file-type-function
1540 (fset 'find-buffer-file-type find-buffer-file-type-function)
1541 (fmakunbound 'find-buffer-file-type)))))
1543 (defun insert-file-1 (filename insert-func)
1544 (if (file-directory-p filename)
1545 (signal 'file-error (list "Opening input file" "file is a directory"
1547 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1548 #'buffer-modified-p))
1549 (tem (funcall insert-func filename)))
1550 (push-mark (+ (point) (car (cdr tem))))
1552 (message "File %s already visited and modified in buffer %s"
1553 filename (buffer-name buffer)))))
1555 (defun insert-file-literally (filename)
1556 "Insert contents of file FILENAME into buffer after point with no conversion.
1558 This function is meant for the user to run interactively.
1559 Don't call it from programs! Use `insert-file-contents-literally' instead.
1560 \(Its calling sequence is different; see its documentation)."
1561 (interactive "*fInsert file literally: ")
1562 (insert-file-1 filename #'insert-file-contents-literally))
1564 (defvar find-file-literally nil
1565 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1566 This is a permanent local.")
1567 (put 'find-file-literally 'permanent-local t)
1569 (defun find-file-literally (filename)
1570 "Visit file FILENAME with no conversion of any kind.
1571 Format conversion and character code conversion are both disabled,
1572 and multibyte characters are disabled in the resulting buffer.
1573 The major mode used is Fundamental mode regardless of the file name,
1574 and local variable specifications in the file are ignored.
1575 Automatic uncompression and adding a newline at the end of the
1576 file due to `require-final-newline' is also disabled.
1578 You cannot absolutely rely on this function to result in
1579 visiting the file literally. If Emacs already has a buffer
1580 which is visiting the file, you get the existing buffer,
1581 regardless of whether it was created literally or not.
1583 In a Lisp program, if you want to be sure of accessing a file's
1584 contents literally, you should create a temporary buffer and then read
1585 the file contents into it using `insert-file-contents-literally'."
1586 (interactive "FFind file literally: ")
1587 (switch-to-buffer (find-file-noselect filename nil t)))
1589 (defvar after-find-file-from-revert-buffer nil)
1591 (defun after-find-file (&optional error warn noauto
1592 after-find-file-from-revert-buffer
1594 "Called after finding a file and by the default revert function.
1595 Sets buffer mode, parses local variables.
1596 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1597 error in reading the file. WARN non-nil means warn if there
1598 exists an auto-save file more recent than the visited file.
1599 NOAUTO means don't mess with auto-save mode.
1600 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1601 means this call was from `revert-buffer'.
1602 Fifth arg NOMODES non-nil means don't alter the file's modes.
1603 Finishes by calling the functions in `find-file-hook'
1604 unless NOMODES is non-nil."
1605 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1612 ((and error (file-attributes buffer-file-name))
1613 (setq buffer-read-only t)
1614 "File exists, but cannot be read")
1615 ((not buffer-read-only)
1617 ;; No need to warn if buffer is auto-saved
1618 ;; under the name of the visited file.
1619 (not (and buffer-file-name
1620 auto-save-visited-file-name))
1621 (file-newer-than-file-p (or buffer-auto-save-file-name
1622 (make-auto-save-file-name))
1624 (format "%s has auto save data; consider M-x recover-this-file"
1625 (file-name-nondirectory buffer-file-name))
1626 (setq not-serious t)
1627 (if error "(New file)" nil)))
1629 (setq not-serious t)
1630 "Note: file is write protected")
1631 ((file-attributes (directory-file-name default-directory))
1632 "File not found and directory write-protected")
1633 ((file-exists-p (file-name-directory buffer-file-name))
1634 (setq buffer-read-only nil))
1636 (setq buffer-read-only nil)
1637 "Use M-x make-directory RET RET to create the directory and its parents"))))
1640 (or not-serious (sit-for 1 t))))
1641 (when (and auto-save-default (not noauto))
1642 (auto-save-mode t)))
1643 ;; Make people do a little extra work (C-x C-q)
1644 ;; before altering a backup file.
1645 (when (backup-file-name-p buffer-file-name)
1646 (setq buffer-read-only t))
1647 ;; When a file is marked read-only,
1648 ;; make the buffer read-only even if root is looking at it.
1649 (when (and (file-modes (buffer-file-name))
1650 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1651 (setq buffer-read-only t))
1653 (when (and view-read-only view-mode)
1654 (view-mode-disable))
1656 ;; If requested, add a newline at the end of the file.
1657 (and (memq require-final-newline '(visit visit-save))
1658 (> (point-max) (point-min))
1659 (/= (char-after (1- (point-max))) ?\n)
1660 (not (and (eq selective-display t)
1661 (= (char-after (1- (point-max))) ?\r)))
1663 (goto-char (point-max))
1665 (when (and buffer-read-only
1667 (not (eq (get major-mode 'mode-class) 'special)))
1669 (run-hooks 'find-file-hook)))
1671 (defmacro report-errors (format &rest body)
1672 "Eval BODY and turn any error into a FORMAT message.
1673 FORMAT can have a %s escape which will be replaced with the actual error.
1674 If `debug-on-error' is set, errors are not caught, so that you can
1676 Avoid using a large BODY since it is duplicated."
1677 (declare (debug t) (indent 1))
1682 (error (message ,format (prin1-to-string err))))))
1684 (defun normal-mode (&optional find-file)
1685 "Choose the major mode for this buffer automatically.
1686 Also sets up any specified local variables of the file.
1687 Uses the visited file name, the -*- line, and the local variables spec.
1689 This function is called automatically from `find-file'. In that case,
1690 we may set up the file-specified mode and local variables,
1691 depending on the value of `enable-local-variables': if it is t, we do;
1692 if it is nil, we don't; otherwise, we query.
1693 In addition, if `local-enable-local-variables' is nil, we do
1694 not set local variables (though we do notice a mode specified with -*-.)
1696 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1697 or from Lisp without specifying the optional argument FIND-FILE;
1698 in that case, this function acts as if `enable-local-variables' were t."
1700 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1701 (report-errors "File mode specification error: %s"
1703 (report-errors "File local-variables error: %s"
1704 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1705 (hack-local-variables)))
1706 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1707 (ucs-set-table-for-input)))
1709 (defvar auto-mode-alist
1710 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1711 ;; c++-mode, java-mode and more) are added through autoload
1712 ;; directives in that file. That way is discouraged since it
1713 ;; spreads out the definition of the initial value.
1716 (cons (purecopy (car elt)) (cdr elt)))
1717 '(;; do this first, so that .html.pl is Polish html, not Perl
1718 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1719 ("\\.te?xt\\'" . text-mode)
1720 ("\\.[tT]e[xX]\\'" . tex-mode)
1721 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1722 ("\\.ltx\\'" . latex-mode)
1723 ("\\.dtx\\'" . doctex-mode)
1724 ("\\.el\\'" . emacs-lisp-mode)
1725 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
1726 ("\\.l\\'" . lisp-mode)
1727 ("\\.li?sp\\'" . lisp-mode)
1728 ("\\.[fF]\\'" . fortran-mode)
1729 ("\\.for\\'" . fortran-mode)
1730 ("\\.p\\'" . pascal-mode)
1731 ("\\.pas\\'" . pascal-mode)
1732 ("\\.ad[abs]\\'" . ada-mode)
1733 ("\\.ad[bs].dg\\'" . ada-mode)
1734 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
1735 ("\\.mk\\'" . makefile-mode)
1736 ("\\([Mm]\\|GNUm\\)akep*file\\'" . makefile-mode)
1737 ("\\.am\\'" . makefile-mode) ;For Automake.
1738 ;; Less common extensions come here
1739 ;; so more common ones above are found faster.
1740 ("\\.texinfo\\'" . texinfo-mode)
1741 ("\\.te?xi\\'" . texinfo-mode)
1742 ("\\.[sS]\\'" . asm-mode)
1743 ("\\.asm\\'" . asm-mode)
1744 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
1745 ("[cC]hange[lL]og\\.[0-9]+\\'" . change-log-mode)
1746 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1747 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1748 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1749 ("\\.bash\\'" . sh-mode)
1750 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1751 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1752 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1753 ("\\.m?spec\\'" . sh-mode)
1754 ("\\.m[mes]\\'" . nroff-mode)
1755 ("\\.man\\'" . nroff-mode)
1756 ("\\.sty\\'" . latex-mode)
1757 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
1758 ("\\.bbl\\'" . latex-mode)
1759 ("\\.bib\\'" . bibtex-mode)
1760 ("\\.sql\\'" . sql-mode)
1761 ("\\.m[4c]\\'" . m4-mode)
1762 ("\\.mf\\'" . metafont-mode)
1763 ("\\.mp\\'" . metapost-mode)
1764 ("\\.vhdl?\\'" . vhdl-mode)
1765 ("\\.article\\'" . text-mode)
1766 ("\\.letter\\'" . text-mode)
1767 ("\\.i?tcl\\'" . tcl-mode)
1768 ("\\.exp\\'" . tcl-mode)
1769 ("\\.itk\\'" . tcl-mode)
1770 ("\\.icn\\'" . icon-mode)
1771 ("\\.sim\\'" . simula-mode)
1772 ("\\.mss\\'" . scribe-mode)
1773 ("\\.f9[05]\\'" . f90-mode)
1774 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1775 ("\\.pro\\'" . idlwave-mode)
1776 ("\\.prolog\\'" . prolog-mode)
1777 ("\\.tar\\'" . tar-mode)
1778 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|ear\\|jar\\|war\\)\\'" . archive-mode)
1779 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|EAR\\|JAR\\|WAR\\)\\'" . archive-mode)
1780 ("\\.sx[dmicw]\\'" . archive-mode) ; OpenOffice.org
1781 ;; Mailer puts message to be edited in
1782 ;; /tmp/Re.... or Message
1783 ("\\`/tmp/Re" . text-mode)
1784 ("/Message[0-9]*\\'" . text-mode)
1785 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1786 ("\\.zone\\'" . zone-mode)
1787 ;; some news reader is reported to use this
1788 ("\\`/tmp/fol/" . text-mode)
1789 ("\\.oak\\'" . scheme-mode)
1790 ("\\.sgml?\\'" . sgml-mode)
1791 ("\\.x[ms]l\\'" . xml-mode)
1792 ("\\.dtd\\'" . sgml-mode)
1793 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1794 ("\\.js\\'" . java-mode) ; javascript-mode would be better
1795 ("\\.x[bp]m\\'" . c-mode)
1796 ;; .emacs or .gnus or .viper following a directory delimiter in
1797 ;; Unix, MSDOG or VMS syntax.
1798 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
1799 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1800 ;; _emacs following a directory delimiter
1802 ("[:/]_emacs\\'" . emacs-lisp-mode)
1803 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1804 ("\\.ml\\'" . lisp-mode)
1805 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1806 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1807 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1808 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1809 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1810 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1811 ("BROWSE\\'" . ebrowse-tree-mode)
1812 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1813 ("#\\*mail\\*" . mail-mode)
1814 ("\\.g\\'" . antlr-mode)
1815 ("\\.ses\\'" . ses-mode)
1816 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
1817 ("\\.docbook\\'" . sgml-mode)
1818 ("\\.com\\'" . dcl-mode)
1819 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
1820 ;; Windows candidates may be opened case sensitively on Unix
1821 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
1822 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
1823 ("\\.ppd\\'" . conf-ppd-mode)
1824 ("java.+\\.conf\\'" . conf-javaprop-mode)
1825 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
1826 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
1827 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
1828 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
1829 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\)\\'" . conf-mode)
1830 ;; either user's dot-files or under /etc or some such
1831 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
1832 ;; alas not all ~/.*rc files are like this
1833 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
1834 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
1835 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
1836 ("/X11.+app-defaults/" . conf-xdefaults-mode)
1837 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
1838 ;; this contains everything twice, with space and with colon :-(
1839 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
1840 ;; Get rid of any trailing .n.m and try again.
1841 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1842 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1843 ;; Using mode nil rather than `ignore' would let the search continue
1844 ;; through this list (with the shortened name) rather than start over.
1845 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
1846 ;; The following should come after the ChangeLog pattern
1847 ;; for the sake of ChangeLog.1, etc.
1848 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1849 ("\\.[1-9]\\'" . nroff-mode)
1850 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
1851 "Alist of filename patterns vs corresponding major mode functions.
1852 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1853 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1854 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1855 mode function to use. FUNCTION will be called, unless it is nil.
1857 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1858 calling FUNCTION (if it's not nil), we delete the suffix that matched
1859 REGEXP and search the list again for another match.")
1862 (defvar interpreter-mode-alist
1863 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
1864 ;; and pike-mode) are added through autoload directives in that
1865 ;; file. That way is discouraged since it spreads out the
1866 ;; definition of the initial value.
1869 (cons (purecopy (car l)) (cdr l)))
1870 '(("perl" . perl-mode)
1871 ("perl5" . perl-mode)
1872 ("miniperl" . perl-mode)
1874 ("wishx" . tcl-mode)
1876 ("tclsh" . tcl-mode)
1877 ("scm" . scheme-mode)
1897 ("tail" . text-mode)
1898 ("more" . text-mode)
1899 ("less" . text-mode)
1901 ("make" . makefile-mode) ; Debian uses this
1902 ("guile" . scheme-mode)
1903 ("clisp" . lisp-mode)))
1904 "Alist mapping interpreter names to major modes.
1905 This alist applies to files whose first line starts with `#!'.
1906 Each element looks like (INTERPRETER . MODE).
1907 The car of each element is compared with
1908 the name of the interpreter specified in the first line.
1909 If it matches, mode MODE is selected.")
1911 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1912 "List of regexps; if one matches a file name, don't look for `-*-'.")
1914 (defvar inhibit-first-line-modes-suffixes nil
1915 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1916 When checking `inhibit-first-line-modes-regexps', we first discard
1917 from the end of the file name anything that matches one of these regexps.")
1919 (defvar auto-mode-interpreter-regexp
1920 "#![ \t]?\\([^ \t\n]*\
1921 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1922 "Regular expression matching interpreters, for file mode determination.
1923 This regular expression is matched against the first line of a file
1924 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1925 a mode from the file's name. If it matches, the file is assumed to
1926 be interpreted by the interpreter matched by the second group of the
1927 regular expression. The mode is then determined as the mode associated
1928 with that interpreter in `interpreter-mode-alist'.")
1930 (defvar magic-mode-alist
1931 `(;; The < comes before the groups (but the first) to reduce backtracking.
1932 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
1933 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
1934 (comment-re (concat "\\(?:!--" incomment-re "*-->\\s *<\\)")))
1935 (concat "\\(?:<\\?xml\\s +[^>]*>\\)?\\s *<"
1937 "\\(?:!DOCTYPE\\s +[^>]*>\\s *<\\s *" comment-re "*\\)?"
1938 "[Hh][Tt][Mm][Ll]")) . html-mode)
1939 ;; These two must come after html, because they are more general:
1940 ("<\\?xml " . xml-mode)
1941 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
1942 (comment-re (concat "\\(?:!--" incomment-re "*-->\\s *<\\)")))
1943 (concat "\\s *<" comment-re "*!DOCTYPE ")) . sgml-mode)
1944 ("%![^V]" . ps-mode)
1945 ("# xmcd " . conf-unix-mode))
1946 "Alist of buffer beginnings vs. corresponding major mode functions.
1947 Each element looks like (REGEXP . FUNCTION). FUNCTION will be
1948 called, unless it is nil (to allow `auto-mode-alist' to override).")
1950 (defun set-auto-mode (&optional keep-mode-if-same)
1951 "Select major mode appropriate for current buffer.
1953 This checks for a -*- mode tag in the buffer's text, checks the
1954 interpreter that runs this file against `interpreter-mode-alist',
1955 compares the buffer beginning against `magic-mode-alist', or
1956 compares the filename against the entries in `auto-mode-alist'.
1958 It does not check for the `mode:' local variable in the
1959 Local Variables section of the file; for that, use `hack-local-variables'.
1961 If `enable-local-variables' is nil, this function does not check for a
1964 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
1965 only set the major mode, if that would change it."
1966 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1967 (let (end done mode modes)
1968 ;; Find a -*- mode tag
1970 (goto-char (point-min))
1971 (skip-chars-forward " \t\n")
1972 (and enable-local-variables
1973 (setq end (set-auto-mode-1))
1974 (if (save-excursion (search-forward ":" end t))
1975 ;; Find all specifications for the `mode:' variable
1976 ;; and execute them left to right.
1977 (while (let ((case-fold-search t))
1978 (or (and (looking-at "mode:")
1979 (goto-char (match-end 0)))
1980 (re-search-forward "[ \t;]mode:" end t)))
1981 (skip-chars-forward " \t")
1982 (let ((beg (point)))
1983 (if (search-forward ";" end t)
1986 (skip-chars-backward " \t")
1987 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1989 ;; Simple -*-MODE-*- case.
1990 (push (intern (concat (downcase (buffer-substring (point) end))
1993 ;; If we found modes to use, invoke them now, outside the save-excursion.
1996 (dolist (mode (nreverse modes))
1997 (if (not (functionp mode))
1998 (message "Ignoring unknown mode `%s'" mode)
2000 (or (set-auto-mode-0 mode keep-mode-if-same)
2001 ;; continuing would call minor modes again, toggling them off
2002 (throw 'nop nil)))))
2003 ;; If we didn't, look for an interpreter specified in the first line.
2004 ;; As a special case, allow for things like "#!/bin/env perl", which
2005 ;; finds the interpreter anywhere in $PATH.
2006 (setq mode (save-excursion
2007 (goto-char (point-min))
2008 (if (looking-at auto-mode-interpreter-regexp)
2011 ;; Map interpreter name to a mode, signalling we're done at the
2013 done (assoc (file-name-nondirectory mode)
2014 interpreter-mode-alist))
2015 ;; If we found an interpreter mode to use, invoke it now.
2017 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2018 ;; If we didn't, match the buffer beginning against magic-mode-alist.
2020 (if (setq done (save-excursion
2021 (goto-char (point-min))
2022 (assoc-default nil magic-mode-alist
2025 (set-auto-mode-0 done keep-mode-if-same)
2026 ;; Compare the filename against the entries in auto-mode-alist.
2027 (if buffer-file-name
2028 (let ((name buffer-file-name))
2029 ;; Remove backup-suffixes from file name.
2030 (setq name (file-name-sans-versions name))
2032 ;; Find first matching alist entry.
2033 (let ((case-fold-search
2034 (memq system-type '(vax-vms windows-nt cygwin))))
2035 (if (and (setq mode (assoc-default name auto-mode-alist
2039 (setq mode (car mode)
2040 name (substring name 0 (match-beginning 0)))
2043 (set-auto-mode-0 mode keep-mode-if-same)))))))))
2045 ;; When `keep-mode-if-same' is set, we are working on behalf of
2046 ;; set-visited-file-name. In that case, if the major mode specified is the
2047 ;; same one we already have, don't actually reset it. We don't want to lose
2048 ;; minor modes such as Font Lock.
2049 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2050 "Apply MODE and return it.
2051 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2052 any aliases and compared to current major mode. If they are the
2053 same, do nothing and return nil."
2054 (when keep-mode-if-same
2055 (while (symbolp (symbol-function mode))
2056 (setq mode (symbol-function mode)))
2057 (if (eq mode major-mode)
2063 (defun set-auto-mode-1 ()
2064 "Find the -*- spec in the buffer.
2065 Call with point at the place to start searching from.
2066 If one is found, set point to the beginning
2067 and return the position of the end.
2068 Otherwise, return nil; point may be changed."
2071 ;; Don't look for -*- if this file name matches any
2072 ;; of the regexps in inhibit-first-line-modes-regexps.
2073 (let ((temp inhibit-first-line-modes-regexps)
2074 (name (if buffer-file-name
2075 (file-name-sans-versions buffer-file-name)
2077 (while (let ((sufs inhibit-first-line-modes-suffixes))
2078 (while (and sufs (not (string-match (car sufs) name)))
2079 (setq sufs (cdr sufs)))
2081 (setq name (substring name 0 (match-beginning 0))))
2083 (not (string-match (car temp) name)))
2084 (setq temp (cdr temp)))
2087 (search-forward "-*-" (save-excursion
2088 ;; If the file begins with "#!"
2089 ;; (exec interpreter magic), look
2090 ;; for mode frobs in the first two
2091 ;; lines. You cannot necessarily
2092 ;; put them in the first line of
2093 ;; such a file without screwing up
2094 ;; the interpreter invocation.
2095 (end-of-line (and (looking-at "^#!") 2))
2098 (skip-chars-forward " \t")
2100 (search-forward "-*-"
2101 (save-excursion (end-of-line) (point))
2105 (skip-chars-backward " \t")
2110 (defun hack-local-variables-prop-line (&optional mode-only)
2111 "Set local variables specified in the -*- line.
2112 Ignore any specification for `mode:' and `coding:';
2113 `set-auto-mode' should already have handled `mode:',
2114 `set-auto-coding' should already have handled `coding:'.
2115 If MODE-ONLY is non-nil, all we do is check whether the major mode
2116 is specified, returning t if it is specified."
2118 (goto-char (point-min))
2120 (end (set-auto-mode-1))
2122 (enable-local-variables
2123 (and local-enable-local-variables enable-local-variables)))
2124 ;; Parse the -*- line into the RESULT alist.
2125 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2128 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2129 ;; Simple form: "-*- MODENAME -*-". Already handled.
2130 (setq mode-specified t)
2133 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2134 ;; (last ";" is optional).
2135 (while (< (point) end)
2136 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2137 (error "Malformed -*- line"))
2138 (goto-char (match-end 0))
2139 ;; There used to be a downcase here,
2140 ;; but the manual didn't say so,
2141 ;; and people want to set var names that aren't all lc.
2142 (let ((key (intern (buffer-substring
2145 (val (save-restriction
2146 (narrow-to-region (point) end)
2147 (read (current-buffer)))))
2148 ;; It is traditional to ignore
2149 ;; case when checking for `mode' in set-auto-mode,
2150 ;; so we must do that here as well.
2151 ;; That is inconsistent, but we're stuck with it.
2152 ;; The same can be said for `coding' in set-auto-coding.
2153 (or (equal (downcase (symbol-name key)) "mode")
2154 (equal (downcase (symbol-name key)) "coding")
2155 (setq result (cons (cons key val) result)))
2156 (if (equal (downcase (symbol-name key)) "mode")
2157 (setq mode-specified t))
2158 (skip-chars-forward " \t;")))
2159 (setq result (nreverse result))))
2161 (if mode-only mode-specified
2164 (eq enable-local-variables t)
2165 (and enable-local-variables
2166 (save-window-excursion
2168 (switch-to-buffer (current-buffer))
2170 ;; If we fail to switch in the selected window,
2171 ;; it is probably a minibuffer.
2172 ;; So try another window.
2174 (switch-to-buffer-other-window (current-buffer))
2176 (switch-to-buffer-other-frame (current-buffer))))))
2177 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
2178 (file-name-nondirectory buffer-file-name)))))))
2179 (let ((enable-local-eval enable-local-eval))
2181 (hack-one-local-variable (car (car result)) (cdr (car result)))
2182 (setq result (cdr result)))))
2185 (defvar hack-local-variables-hook nil
2186 "Normal hook run after processing a file's local variables specs.
2187 Major modes can use this to examine user-specified local variables
2188 in order to initialize other data structure based on them.")
2190 (defun hack-local-variables (&optional mode-only)
2191 "Parse and put into effect this buffer's local variables spec.
2192 If MODE-ONLY is non-nil, all we do is check whether the major mode
2193 is specified, returning t if it is specified."
2194 (let ((mode-specified
2195 ;; If MODE-ONLY is t, we check here for specifying the mode
2196 ;; in the -*- line. If MODE-ONLY is nil, we process
2197 ;; the -*- line here.
2198 (hack-local-variables-prop-line mode-only))
2199 (enable-local-variables
2200 (and local-enable-local-variables enable-local-variables)))
2201 ;; Look for "Local variables:" line in last page.
2203 (goto-char (point-max))
2204 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
2205 (if (let ((case-fold-search t))
2206 (and (search-forward "Local Variables:" nil t)
2207 (or (eq enable-local-variables t)
2209 (and enable-local-variables
2210 (save-window-excursion
2211 (switch-to-buffer (current-buffer))
2214 (set-window-start (selected-window) (point)))
2215 (y-or-n-p (format "Set local variables as specified at end of %s? "
2216 (if buffer-file-name
2217 (file-name-nondirectory
2220 (buffer-name))))))))))
2221 (let (prefix suffix beg
2222 (enable-local-eval enable-local-eval))
2223 ;; The prefix is what comes before "local variables:" in its line.
2224 ;; The suffix is what comes after "local variables:" in its line.
2225 (skip-chars-forward " \t")
2227 (setq suffix (buffer-substring (point)
2228 (progn (end-of-line) (point)))))
2229 (goto-char (match-beginning 0))
2232 (buffer-substring (point)
2233 (progn (beginning-of-line) (point)))))
2235 (setq prefix (if prefix (regexp-quote prefix) "^"))
2236 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
2238 (let ((startpos (point))
2240 (thisbuf (current-buffer)))
2242 (if (not (re-search-forward
2243 (concat (or prefix "")
2247 (error "Local variables list is not properly terminated"))
2249 (setq endpos (point)))
2252 (insert-buffer-substring thisbuf startpos endpos)
2253 (goto-char (point-min))
2254 (subst-char-in-region (point) (point-max)
2257 ;; Discard the prefix, if any.
2259 (if (looking-at prefix)
2260 (delete-region (point) (match-end 0))
2261 (error "Local variables entry is missing the prefix")))
2263 ;; Discard the suffix, if any.
2265 (if (looking-back suffix)
2266 (delete-region (match-beginning 0) (point))
2267 (error "Local variables entry is missing the suffix")))
2269 (goto-char (point-min))
2272 ;; Find the variable name; strip whitespace.
2273 (skip-chars-forward " \t")
2275 (skip-chars-forward "^:\n")
2276 (if (eolp) (error "Missing colon in local variables entry"))
2277 (skip-chars-backward " \t")
2278 (let* ((str (buffer-substring beg (point)))
2281 ;; Read the variable value.
2282 (skip-chars-forward "^:")
2284 (setq val (read (current-buffer)))
2287 (setq mode-specified t))
2288 ;; Set the variable. "Variables" mode and eval are funny.
2289 (with-current-buffer thisbuf
2290 (hack-one-local-variable var val))))
2291 (forward-line 1)))))))
2293 (run-hooks 'hack-local-variables-hook))
2296 (defvar ignored-local-variables ()
2297 "Variables to be ignored in a file's local variable spec.")
2299 ;; Get confirmation before setting these variables as locals in a file.
2300 (put 'debugger 'risky-local-variable t)
2301 (put 'enable-local-eval 'risky-local-variable t)
2302 (put 'ignored-local-variables 'risky-local-variable t)
2303 (put 'eval 'risky-local-variable t)
2304 (put 'file-name-handler-alist 'risky-local-variable t)
2305 (put 'inhibit-quit 'risky-local-variable t)
2306 (put 'minor-mode-alist 'risky-local-variable t)
2307 (put 'minor-mode-map-alist 'risky-local-variable t)
2308 (put 'minor-mode-overriding-map-alist 'risky-local-variable t)
2309 (put 'overriding-local-map 'risky-local-variable t)
2310 (put 'overriding-terminal-local-map 'risky-local-variable t)
2311 (put 'auto-mode-alist 'risky-local-variable t)
2312 (put 'after-load-alist 'risky-local-variable t)
2313 (put 'buffer-file-name 'risky-local-variable t)
2314 (put 'buffer-undo-list 'risky-local-variable t)
2315 (put 'buffer-auto-save-file-name 'risky-local-variable t)
2316 (put 'buffer-file-truename 'risky-local-variable t)
2317 (put 'default-text-properties 'risky-local-variable t)
2318 (put 'exec-path 'risky-local-variable t)
2319 (put 'load-path 'risky-local-variable t)
2320 (put 'exec-directory 'risky-local-variable t)
2321 (put 'process-environment 'risky-local-variable t)
2322 (put 'dabbrev-case-fold-search 'risky-local-variable t)
2323 (put 'dabbrev-case-replace 'risky-local-variable t)
2324 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2325 (put 'outline-level 'risky-local-variable t)
2326 (put 'rmail-output-file-alist 'risky-local-variable t)
2327 (put 'font-lock-defaults 'risky-local-variable t)
2328 (put 'special-display-buffer-names 'risky-local-variable t)
2329 (put 'frame-title-format 'risky-local-variable t)
2330 (put 'global-mode-string 'risky-local-variable t)
2331 (put 'header-line-format 'risky-local-variable t)
2332 (put 'icon-title-format 'risky-local-variable t)
2333 (put 'input-method-alist 'risky-local-variable t)
2334 (put 'format-alist 'risky-local-variable t)
2335 (put 'vc-mode 'risky-local-variable t)
2336 (put 'imenu-generic-expression 'risky-local-variable t)
2337 (put 'imenu--index-alist 'risky-local-variable t)
2338 (put 'standard-input 'risky-local-variable t)
2339 (put 'standard-output 'risky-local-variable t)
2340 (put 'unread-command-events 'risky-local-variable t)
2341 (put 'max-lisp-eval-depth 'risky-local-variable t)
2342 (put 'max-specpdl-size 'risky-local-variable t)
2343 (put 'mode-line-format 'risky-local-variable t)
2344 (put 'mode-line-modified 'risky-local-variable t)
2345 (put 'mode-line-mule-info 'risky-local-variable t)
2346 (put 'mode-line-buffer-identification 'risky-local-variable t)
2347 (put 'mode-line-modes 'risky-local-variable t)
2348 (put 'mode-line-position 'risky-local-variable t)
2349 (put 'mode-line-process 'risky-local-variable t)
2350 (put 'mode-name 'risky-local-variable t)
2351 (put 'display-time-string 'risky-local-variable t)
2352 (put 'parse-time-rules 'risky-local-variable t)
2354 ;; This case is safe because the user gets to check it before it is used.
2355 (put 'compile-command 'safe-local-variable 'stringp)
2357 (defun risky-local-variable-p (sym &optional val)
2358 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2359 If VAL is nil or omitted, the question is whether any value might be
2361 (let ((safep (get sym 'safe-local-variable)))
2362 (or (get sym 'risky-local-variable)
2363 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2366 ;; If the safe-local-variable property isn't t or nil,
2367 ;; then it must return non-nil on the proposed value to be safe.
2368 (and (not (memq safep '(t nil)))
2370 (not (funcall safep val)))))))
2372 (defcustom safe-local-eval-forms nil
2373 "*Expressions that are considered \"safe\" in an `eval:' local variable.
2374 Add expressions to this list if you want Emacs to evaluate them, when
2375 they appear in an `eval' local variable specification, without first
2376 asking you for confirmation."
2379 :type '(repeat sexp))
2381 (put 'c-set-style 'safe-local-eval-function t)
2383 (defun hack-one-local-variable-quotep (exp)
2384 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2386 (defun hack-one-local-variable-constantp (exp)
2387 (or (and (not (symbolp exp)) (not (consp exp)))
2390 (hack-one-local-variable-quotep exp)))
2392 (defun hack-one-local-variable-eval-safep (exp)
2393 "Return t if it is safe to eval EXP when it is found in a file."
2394 (or (not (consp exp))
2395 ;; Detect certain `put' expressions.
2396 (and (eq (car exp) 'put)
2397 (hack-one-local-variable-quotep (nth 1 exp))
2398 (hack-one-local-variable-quotep (nth 2 exp))
2399 (memq (nth 1 (nth 2 exp))
2400 '(lisp-indent-hook))
2401 ;; Only allow safe values of lisp-indent-hook;
2403 (or (numberp (nth 3 exp))
2404 (equal (nth 3 exp) ''defun)))
2405 ;; Allow expressions that the user requested.
2406 (member exp safe-local-eval-forms)
2407 ;; Certain functions can be allowed with safe arguments
2408 ;; or can specify verification functions to try.
2409 (and (symbolp (car exp))
2410 (let ((prop (get (car exp) 'safe-local-eval-function)))
2413 (dolist (arg (cdr exp))
2414 (unless (hack-one-local-variable-constantp arg)
2421 (dolist (function prop)
2422 (if (funcall function exp)
2426 (defun hack-one-local-variable (var val)
2427 "\"Set\" one variable in a local variables spec.
2428 A few patterns are specified so that any name which matches one
2429 is considered risky."
2430 (cond ((eq var 'mode)
2431 (funcall (intern (concat (downcase (symbol-name val))
2434 ;; We have already handled coding: tag in set-auto-coding.
2436 ((memq var ignored-local-variables)
2438 ;; "Setting" eval means either eval it or do nothing.
2439 ;; Likewise for setting hook variables.
2440 ((risky-local-variable-p var val)
2441 ;; Permit evalling a put of a harmless property.
2442 ;; if the args do nothing tricky.
2443 (if (or (and (eq var 'eval)
2444 (hack-one-local-variable-eval-safep val))
2445 ;; Permit eval if not root and user says ok.
2446 (and (not (zerop (user-uid)))
2447 (or (eq enable-local-eval t)
2448 (and enable-local-eval
2449 (save-window-excursion
2450 (switch-to-buffer (current-buffer))
2453 (set-window-start (selected-window) (point)))
2454 (setq enable-local-eval
2455 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
2456 (if buffer-file-name
2457 (concat "file " (file-name-nondirectory buffer-file-name))
2458 (concat "buffer " (buffer-name)))))))))))
2460 (save-excursion (eval val))
2461 (make-local-variable var)
2463 (message "Ignoring risky spec in the local variables list")))
2464 ;; Ordinary variable, really set it.
2465 (t (make-local-variable var)
2466 ;; Make sure the string has no text properties.
2467 ;; Some text properties can get evaluated in various ways,
2468 ;; so it is risky to put them on with a local variable list.
2470 (set-text-properties 0 (length val) nil val))
2474 (defcustom change-major-mode-with-file-name t
2475 "*Non-nil means \\[write-file] should set the major mode from the file name.
2476 However, the mode will not be changed if
2477 \(1) a local variables list or the `-*-' line specifies a major mode, or
2478 \(2) the current major mode is a \"special\" mode,
2479 \ not suitable for ordinary files, or
2480 \(3) the new file name does not particularly specify any mode."
2482 :group 'editing-basics)
2484 (defun set-visited-file-name (filename &optional no-query along-with-file)
2485 "Change name of file visited in current buffer to FILENAME.
2486 The next time the buffer is saved it will go in the newly specified file.
2487 FILENAME nil or an empty string means make buffer not be visiting any file.
2488 Remember to delete the initial contents of the minibuffer
2489 if you wish to pass an empty string as the argument.
2491 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2492 confirmation in the case where another buffer is already visiting FILENAME.
2494 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2495 the old visited file has been renamed to the new name FILENAME."
2496 (interactive "FSet visited file name: ")
2497 (if (buffer-base-buffer)
2498 (error "An indirect buffer cannot visit a file"))
2502 (if (string-equal filename "")
2504 (expand-file-name filename))))
2507 (setq truename (file-truename filename))
2508 (if find-file-visit-truename
2509 (setq filename truename))))
2510 (let ((buffer (and filename (find-buffer-visiting filename))))
2511 (and buffer (not (eq buffer (current-buffer)))
2513 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2516 (or (equal filename buffer-file-name)
2518 (and filename (lock-buffer filename))
2520 (setq buffer-file-name filename)
2521 (if filename ; make buffer name reflect filename.
2522 (let ((new-name (file-name-nondirectory buffer-file-name)))
2523 (if (string= new-name "")
2524 (error "Empty file name"))
2525 (if (eq system-type 'vax-vms)
2526 (setq new-name (downcase new-name)))
2527 (setq default-directory (file-name-directory buffer-file-name))
2528 ;; If new-name == old-name, renaming would add a spurious <2>
2529 ;; and it's considered as a feature in rename-buffer.
2530 (or (string= new-name (buffer-name))
2531 (rename-buffer new-name t))))
2532 (setq buffer-backed-up nil)
2534 (clear-visited-file-modtime))
2535 ;; Abbreviate the file names of the buffer.
2538 (setq buffer-file-truename (abbreviate-file-name truename))
2539 (if find-file-visit-truename
2540 (setq buffer-file-name truename))))
2541 (setq buffer-file-number
2543 (nthcdr 10 (file-attributes buffer-file-name))
2545 ;; write-file-functions is normally used for things like ftp-find-file
2546 ;; that visit things that are not local files as if they were files.
2547 ;; Changing to visit an ordinary local file instead should flush the hook.
2548 (kill-local-variable 'write-file-functions)
2549 (kill-local-variable 'local-write-file-hooks)
2550 (kill-local-variable 'revert-buffer-function)
2551 (kill-local-variable 'backup-inhibited)
2552 ;; If buffer was read-only because of version control,
2553 ;; that reason is gone now, so make it writable.
2555 (setq buffer-read-only nil))
2556 (kill-local-variable 'vc-mode)
2557 ;; Turn off backup files for certain file names.
2558 ;; Since this is a permanent local, the major mode won't eliminate it.
2559 (and buffer-file-name
2560 (not (funcall backup-enable-predicate buffer-file-name))
2562 (make-local-variable 'backup-inhibited)
2563 (setq backup-inhibited t)))
2564 (let ((oauto buffer-auto-save-file-name))
2565 ;; If auto-save was not already on, turn it on if appropriate.
2566 (if (not buffer-auto-save-file-name)
2567 (and buffer-file-name auto-save-default
2569 ;; If auto save is on, start using a new name.
2570 ;; We deliberately don't rename or delete the old auto save
2571 ;; for the old visited file name. This is because perhaps
2572 ;; the user wants to save the new state and then compare with the
2573 ;; previous state from the auto save file.
2574 (setq buffer-auto-save-file-name
2575 (make-auto-save-file-name)))
2576 ;; Rename the old auto save file if any.
2577 (and oauto buffer-auto-save-file-name
2578 (file-exists-p oauto)
2579 (rename-file oauto buffer-auto-save-file-name t)))
2580 (and buffer-file-name
2581 (not along-with-file)
2582 (set-buffer-modified-p t))
2583 ;; Update the major mode, if the file name determines it.
2585 ;; Don't change the mode if it is special.
2586 (or (not change-major-mode-with-file-name)
2587 (get major-mode 'mode-class)
2588 ;; Don't change the mode if the local variable list specifies it.
2589 (hack-local-variables t)
2593 (defun write-file (filename &optional confirm)
2594 "Write current buffer into file FILENAME.
2595 This makes the buffer visit that file, and marks it as not modified.
2597 If you specify just a directory name as FILENAME, that means to use
2598 the default file name but in that directory. You can also yank
2599 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
2601 If the buffer is not already visiting a file, the default file name
2602 for the output file is the buffer name.
2604 If optional second arg CONFIRM is non-nil, this function
2605 asks for confirmation before overwriting an existing file.
2606 Interactively, confirmation is required unless you supply a prefix argument."
2607 ;; (interactive "FWrite file: ")
2609 (list (if buffer-file-name
2610 (read-file-name "Write file: "
2612 (read-file-name "Write file: " default-directory
2614 (file-name-nondirectory (buffer-name))
2617 (not current-prefix-arg)))
2618 (or (null filename) (string-equal filename "")
2620 ;; If arg is just a directory,
2621 ;; use the default file name, but in that directory.
2622 (if (file-directory-p filename)
2623 (setq filename (concat (file-name-as-directory filename)
2624 (file-name-nondirectory
2625 (or buffer-file-name (buffer-name))))))
2627 (file-exists-p filename)
2628 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2629 (error "Canceled")))
2630 (set-visited-file-name filename (not confirm))))
2631 (set-buffer-modified-p t)
2632 ;; Make buffer writable if file is writable.
2633 (and buffer-file-name
2634 (file-writable-p buffer-file-name)
2635 (setq buffer-read-only nil))
2638 (defun backup-buffer ()
2639 "Make a backup of the disk file visited by the current buffer, if appropriate.
2640 This is normally done before saving the buffer the first time.
2642 A backup may be done by renaming or by copying; see documentation of
2643 variable `make-backup-files'. If it's done by renaming, then the file is
2644 no longer accessible under its old name.
2646 The value is non-nil after a backup was made by renaming.
2647 It has the form (MODES . BACKUPNAME).
2648 MODES is the result of `file-modes' on the original
2649 file; this means that the caller, after saving the buffer, should change
2650 the modes of the new file to agree with the old modes.
2651 BACKUPNAME is the backup file name, which is the old file renamed."
2652 (if (and make-backup-files (not backup-inhibited)
2653 (not buffer-backed-up)
2654 (file-exists-p buffer-file-name)
2655 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2657 (let ((real-file-name buffer-file-name)
2658 backup-info backupname targets setmodes)
2659 ;; If specified name is a symbolic link, chase it to the target.
2660 ;; Thus we make the backups in the directory where the real file is.
2661 (setq real-file-name (file-chase-links real-file-name))
2662 (setq backup-info (find-backup-file-name real-file-name)
2663 backupname (car backup-info)
2664 targets (cdr backup-info))
2665 ;; (if (file-directory-p buffer-file-name)
2666 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2669 (let ((delete-old-versions
2670 ;; If have old versions to maybe delete,
2671 ;; ask the user to confirm now, before doing anything.
2672 ;; But don't actually delete til later.
2674 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2675 (or delete-old-versions
2676 (y-or-n-p (format "Delete excess backup versions of %s? "
2678 (modes (file-modes buffer-file-name)))
2679 ;; Actually write the back up file.
2681 (if (or file-precious-flag
2682 ; (file-symlink-p buffer-file-name)
2684 ;; Don't rename a suid or sgid file.
2685 (and modes (< 0 (logand modes #o6000)))
2686 (and backup-by-copying-when-linked
2687 (> (file-nlinks real-file-name) 1))
2688 (and (or backup-by-copying-when-mismatch
2689 (integerp backup-by-copying-when-privileged-mismatch))
2690 (let ((attr (file-attributes real-file-name)))
2691 (and (or backup-by-copying-when-mismatch
2692 (and (integerp (nth 2 attr))
2693 (integerp backup-by-copying-when-privileged-mismatch)
2694 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2696 (not (file-ownership-preserved-p real-file-name)))))))
2697 (backup-buffer-copy real-file-name backupname modes)
2698 ;; rename-file should delete old backup.
2699 (rename-file real-file-name backupname t)
2700 (setq setmodes (cons modes backupname)))
2702 ;; If trouble writing the backup, write it in ~.
2703 (setq backupname (expand-file-name
2704 (convert-standard-filename
2706 (message "Cannot write backup file; backing up in %s"
2707 (file-name-nondirectory backupname))
2709 (backup-buffer-copy real-file-name backupname modes)))
2710 (setq buffer-backed-up t)
2711 ;; Now delete the old versions, if desired.
2712 (if delete-old-versions
2715 (delete-file (car targets))
2717 (setq targets (cdr targets))))
2719 (file-error nil))))))
2721 (defun backup-buffer-copy (from-name to-name modes)
2723 (copy-file from-name to-name t t)
2725 ;; If copying fails because file TO-NAME
2726 ;; is not writable, delete that file and try again.
2727 (if (and (file-exists-p to-name)
2728 (not (file-writable-p to-name)))
2729 (delete-file to-name))
2730 (copy-file from-name to-name t t)))
2732 (set-file-modes to-name (logand modes #o1777))))
2734 (defun file-name-sans-versions (name &optional keep-backup-version)
2735 "Return file NAME sans backup versions or strings.
2736 This is a separate procedure so your site-init or startup file can
2738 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2739 we do not remove backup version numbers, only true file version numbers."
2740 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2742 (funcall handler 'file-name-sans-versions name keep-backup-version)
2744 (if (eq system-type 'vax-vms)
2745 ;; VMS version number is (a) semicolon, optional
2746 ;; sign, zero or more digits or (b) period, option
2747 ;; sign, zero or more digits, provided this is the
2748 ;; second period encountered outside of the
2749 ;; device/directory part of the file name.
2750 (or (string-match ";[-+]?[0-9]*\\'" name)
2751 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2753 (match-beginning 1))
2755 (if keep-backup-version
2757 (or (string-match "\\.~[0-9.]+~\\'" name)
2758 (string-match "~\\'" name)
2759 (length name))))))))
2761 (defun file-ownership-preserved-p (file)
2762 "Return t if deleting FILE and rewriting it would preserve the owner."
2763 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2765 (funcall handler 'file-ownership-preserved-p file)
2766 (let ((attributes (file-attributes file)))
2767 ;; Return t if the file doesn't exist, since it's true that no
2768 ;; information would be lost by an (attempted) delete and create.
2769 (or (null attributes)
2770 (= (nth 2 attributes) (user-uid)))))))
2772 (defun file-name-sans-extension (filename)
2773 "Return FILENAME sans final \"extension\".
2774 The extension, in a file name, is the part that follows the last `.',
2775 except that a leading `.', if any, doesn't count."
2777 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2779 (if (and (string-match "\\.[^.]*\\'" file)
2780 (not (eq 0 (match-beginning 0))))
2781 (if (setq directory (file-name-directory filename))
2782 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2783 ;; we don't want to expand it.
2784 (concat directory (substring file 0 (match-beginning 0)))
2785 (substring file 0 (match-beginning 0)))
2788 (defun file-name-extension (filename &optional period)
2789 "Return FILENAME's final \"extension\".
2790 The extension, in a file name, is the part that follows the last `.',
2791 except that a leading `.', if any, doesn't count.
2792 Return nil for extensionless file names such as `foo'.
2793 Return the empty string for file names such as `foo.'.
2795 If PERIOD is non-nil, then the returned value includes the period
2796 that delimits the extension, and if FILENAME has no extension,
2799 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2800 (if (and (string-match "\\.[^.]*\\'" file)
2801 (not (eq 0 (match-beginning 0))))
2802 (substring file (+ (match-beginning 0) (if period 0 1)))
2806 (defcustom make-backup-file-name-function nil
2807 "A function to use instead of the default `make-backup-file-name'.
2808 A value of nil gives the default `make-backup-file-name' behaviour.
2810 This could be buffer-local to do something special for specific
2811 files. If you define it, you may need to change `backup-file-name-p'
2812 and `file-name-sans-versions' too.
2814 See also `backup-directory-alist'."
2816 :type '(choice (const :tag "Default" nil)
2817 (function :tag "Your function")))
2819 (defcustom backup-directory-alist nil
2820 "Alist of filename patterns and backup directory names.
2821 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2822 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2823 relative or absolute. If it is absolute, so that all matching files
2824 are backed up into the same directory, the file names in this
2825 directory will be the full name of the file backed up with all
2826 directory separators changed to `!' to prevent clashes. This will not
2827 work correctly if your filesystem truncates the resulting name.
2829 For the common case of all backups going into one directory, the alist
2830 should contain a single element pairing \".\" with the appropriate
2833 If this variable is nil, or it fails to match a filename, the backup
2834 is made in the original file's directory.
2836 On MS-DOS filesystems without long names this variable is always
2839 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2840 (directory :tag "Backup directory name"))))
2842 (defun normal-backup-enable-predicate (name)
2843 "Default `backup-enable-predicate' function.
2844 Checks for files in `temporary-file-directory' or
2845 `small-temporary-file-directory'."
2846 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2848 ;; Directory is under temporary-file-directory.
2849 (and (not (eq comp t))
2850 (< comp (- (length temporary-file-directory)))))
2851 (if small-temporary-file-directory
2852 (let ((comp (compare-strings small-temporary-file-directory
2855 ;; Directory is under small-temporary-file-directory.
2856 (and (not (eq comp t))
2857 (< comp (- (length small-temporary-file-directory)))))))))
2859 (defun make-backup-file-name (file)
2860 "Create the non-numeric backup file name for FILE.
2861 Normally this will just be the file's name with `~' appended.
2862 Customization hooks are provided as follows.
2864 If the variable `make-backup-file-name-function' is non-nil, its value
2865 should be a function which will be called with FILE as its argument;
2866 the resulting name is used.
2868 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2869 the documentation of that variable. If the directory for the backup
2870 doesn't exist, it is created."
2871 (if make-backup-file-name-function
2872 (funcall make-backup-file-name-function file)
2873 (if (and (eq system-type 'ms-dos)
2874 (not (msdos-long-file-names)))
2875 (let ((fn (file-name-nondirectory file)))
2876 (concat (file-name-directory file)
2877 (or (and (string-match "\\`[^.]+\\'" fn)
2878 (concat (match-string 0 fn) ".~"))
2879 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2880 (concat (match-string 0 fn) "~")))))
2881 (concat (make-backup-file-name-1 file) "~"))))
2883 (defun make-backup-file-name-1 (file)
2884 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2885 (let ((alist backup-directory-alist)
2886 elt backup-directory)
2888 (setq elt (pop alist))
2889 (if (string-match (car elt) file)
2890 (setq backup-directory (cdr elt)
2892 (if (and backup-directory (not (file-exists-p backup-directory)))
2894 (make-directory backup-directory 'parents)
2895 (file-error (setq backup-directory nil))))
2896 (if (null backup-directory)
2898 (if (file-name-absolute-p backup-directory)
2900 (when (memq system-type '(windows-nt ms-dos cygwin))
2901 ;; Normalize DOSish file names: downcase the drive
2902 ;; letter, if any, and replace the leading "x:" with
2904 (or (file-name-absolute-p file)
2905 (setq file (expand-file-name file))) ; make defaults explicit
2906 ;; Replace any invalid file-name characters (for the
2907 ;; case of backing up remote files).
2908 (setq file (expand-file-name (convert-standard-filename file)))
2909 (if (eq (aref file 1) ?:)
2910 (setq file (concat "/"
2912 (char-to-string (downcase (aref file 0)))
2913 (if (eq (aref file 2) ?/)
2916 (substring file 2)))))
2917 ;; Make the name unique by substituting directory
2918 ;; separators. It may not really be worth bothering about
2919 ;; doubling `!'s in the original name...
2921 (subst-char-in-string
2923 (replace-regexp-in-string "!" "!!" file))
2925 (expand-file-name (file-name-nondirectory file)
2926 (file-name-as-directory
2927 (expand-file-name backup-directory
2928 (file-name-directory file))))))))
2930 (defun backup-file-name-p (file)
2931 "Return non-nil if FILE is a backup file name (numeric or not).
2932 This is a separate function so you can redefine it for customization.
2933 You may need to redefine `file-name-sans-versions' as well."
2934 (string-match "~\\'" file))
2936 (defvar backup-extract-version-start)
2938 ;; This is used in various files.
2939 ;; The usage of backup-extract-version-start is not very clean,
2940 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2941 (defun backup-extract-version (fn)
2942 "Given the name of a numeric backup file, FN, return the backup number.
2943 Uses the free variable `backup-extract-version-start', whose value should be
2944 the index in the name where the version number begins."
2945 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2946 (= (match-beginning 0) backup-extract-version-start))
2947 (string-to-int (substring fn backup-extract-version-start -1))
2950 ;; I believe there is no need to alter this behavior for VMS;
2951 ;; since backup files are not made on VMS, it should not get called.
2952 (defun find-backup-file-name (fn)
2953 "Find a file name for a backup file FN, and suggestions for deletions.
2954 Value is a list whose car is the name for the backup file
2955 and whose cdr is a list of old versions to consider deleting now.
2956 If the value is nil, don't make a backup.
2957 Uses `backup-directory-alist' in the same way as does
2958 `make-backup-file-name'."
2959 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2960 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2962 (funcall handler 'find-backup-file-name fn)
2963 (if (or (eq version-control 'never)
2964 ;; We don't support numbered backups on plain MS-DOS
2965 ;; when long file names are unavailable.
2966 (and (eq system-type 'ms-dos)
2967 (not (msdos-long-file-names))))
2968 (list (make-backup-file-name fn))
2969 (let* ((basic-name (make-backup-file-name-1 fn))
2970 (base-versions (concat (file-name-nondirectory basic-name)
2972 (backup-extract-version-start (length base-versions))
2974 (number-to-delete 0)
2975 possibilities deserve-versions-p versions)
2977 (setq possibilities (file-name-all-completions
2979 (file-name-directory basic-name))
2980 versions (sort (mapcar #'backup-extract-version
2983 high-water-mark (apply 'max 0 versions)
2984 deserve-versions-p (or version-control
2985 (> high-water-mark 0))
2986 number-to-delete (- (length versions)
2990 (file-error (setq possibilities nil)))
2991 (if (not deserve-versions-p)
2992 (list (make-backup-file-name fn))
2993 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
2994 (if (and (> number-to-delete 0)
2995 ;; Delete nothing if there is overflow
2996 ;; in the number of versions to keep.
2997 (>= (+ kept-new-versions kept-old-versions -1) 0))
2999 (format "%s.~%d~" basic-name n))
3000 (let ((v (nthcdr kept-old-versions versions)))
3001 (rplacd (nthcdr (1- number-to-delete) v) ())
3004 (defun file-nlinks (filename)
3005 "Return number of names file FILENAME has."
3006 (car (cdr (file-attributes filename))))
3008 ;; (defun file-relative-name (filename &optional directory)
3009 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3010 ;; This function returns a relative file name which is equivalent to FILENAME
3011 ;; when used with that default directory as the default.
3012 ;; If this is impossible (which can happen on MSDOS and Windows
3013 ;; when the file name and directory use different drive names)
3014 ;; then it returns FILENAME."
3016 ;; (let ((fname (expand-file-name filename)))
3017 ;; (setq directory (file-name-as-directory
3018 ;; (expand-file-name (or directory default-directory))))
3019 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3020 ;; ;; drive names, they can't be relative, so return the absolute name.
3021 ;; (if (and (or (eq system-type 'ms-dos)
3022 ;; (eq system-type 'cygwin)
3023 ;; (eq system-type 'windows-nt))
3024 ;; (not (string-equal (substring fname 0 2)
3025 ;; (substring directory 0 2))))
3027 ;; (let ((ancestor ".")
3028 ;; (fname-dir (file-name-as-directory fname)))
3029 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3030 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3031 ;; (setq directory (file-name-directory (substring directory 0 -1))
3032 ;; ancestor (if (equal ancestor ".")
3034 ;; (concat "../" ancestor))))
3035 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3036 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3037 ;; ;; We matched within FNAME's directory part.
3038 ;; ;; Add the rest of FNAME onto ANCESTOR.
3039 ;; (let ((rest (substring fname (match-end 0))))
3040 ;; (if (and (equal ancestor ".")
3041 ;; (not (equal rest "")))
3042 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3044 ;; (concat (file-name-as-directory ancestor) rest)))
3045 ;; ;; We matched FNAME's directory equivalent.
3048 (defun file-relative-name (filename &optional directory)
3049 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3050 This function returns a relative file name which is equivalent to FILENAME
3051 when used with that default directory as the default.
3052 If FILENAME and DIRECTORY lie on different machines or on different drives
3053 on a DOS/Windows machine, it returns FILENAME on expanded form."
3056 (file-name-as-directory (expand-file-name (or directory
3057 default-directory))))
3058 (setq filename (expand-file-name filename))
3059 (let ((fremote (file-remote-p filename))
3060 (dremote (file-remote-p directory)))
3061 (if ;; Conditions for separate trees
3063 ;; Test for different drives on DOS/Windows
3065 ;; Should `cygwin' really be included here? --stef
3066 (memq system-type '(ms-dos cygwin windows-nt))
3067 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3068 ;; Test for different remote file system identification
3069 (not (equal fremote dremote)))
3071 (let ((ancestor ".")
3072 (filename-dir (file-name-as-directory filename)))
3075 (eq t (compare-strings filename-dir nil (length directory)
3076 directory nil nil case-fold-search))
3077 (eq t (compare-strings filename nil (length directory)
3078 directory nil nil case-fold-search))))
3079 (setq directory (file-name-directory (substring directory 0 -1))
3080 ancestor (if (equal ancestor ".")
3082 (concat "../" ancestor))))
3083 ;; Now ancestor is empty, or .., or ../.., etc.
3084 (if (eq t (compare-strings filename nil (length directory)
3085 directory nil nil case-fold-search))
3086 ;; We matched within FILENAME's directory part.
3087 ;; Add the rest of FILENAME onto ANCESTOR.
3088 (let ((rest (substring filename (length directory))))
3089 (if (and (equal ancestor ".") (not (equal rest "")))
3090 ;; But don't bother with ANCESTOR if it would give us `./'.
3092 (concat (file-name-as-directory ancestor) rest)))
3093 ;; We matched FILENAME's directory equivalent.
3096 (defun save-buffer (&optional args)
3097 "Save current buffer in visited file if modified. Versions described below.
3098 By default, makes the previous version into a backup file
3099 if previously requested or if this is the first save.
3100 With 1 \\[universal-argument], marks this version
3101 to become a backup when the next save is done.
3102 With 2 \\[universal-argument]'s,
3103 unconditionally makes the previous version into a backup file.
3104 With 3 \\[universal-argument]'s, marks this version
3105 to become a backup when the next save is done,
3106 and unconditionally makes the previous version into a backup file.
3108 With argument of 0, never make the previous version into a backup file.
3110 If a file's name is FOO, the names of its numbered backup versions are
3111 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3112 Numeric backups (rather than FOO~) will be made if value of
3113 `version-control' is not the atom `never' and either there are already
3114 numeric versions of the file being backed up, or `version-control' is
3116 We don't want excessive versions piling up, so there are variables
3117 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3118 and `kept-new-versions', which tells how many newest versions to keep.
3119 Defaults are 2 old versions and 2 new.
3120 `dired-kept-versions' controls dired's clean-directory (.) command.
3121 If `delete-old-versions' is nil, system will query user
3122 before trimming versions. Otherwise it does it silently.
3124 If `vc-make-backup-files' is nil, which is the default,
3125 no backup files are made for files managed by version control.
3126 (This is because the version control system itself records previous versions.)
3128 See the subroutine `basic-save-buffer' for more information."
3130 (let ((modp (buffer-modified-p))
3131 (large (> (buffer-size) 50000))
3132 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3133 (memq args '(16 64)))))
3134 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3135 (if (and modp large (buffer-file-name))
3136 (message "Saving file %s..." (buffer-file-name)))
3138 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3140 (defun delete-auto-save-file-if-necessary (&optional force)
3141 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3142 Normally delete only if the file was written by this Emacs since
3143 the last real save, but optional arg FORCE non-nil means delete anyway."
3144 (and buffer-auto-save-file-name delete-auto-save-files
3145 (not (string= buffer-file-name buffer-auto-save-file-name))
3146 (or force (recent-auto-save-p))
3149 (delete-file buffer-auto-save-file-name)
3151 (set-buffer-auto-saved))))
3153 (defvar auto-save-hook nil
3154 "Normal hook run just before auto-saving.")
3156 (defcustom before-save-hook nil
3157 "Normal hook that is run before a buffer is saved to its file."
3158 :options '(copyright-update time-stamp)
3162 (defcustom after-save-hook nil
3163 "Normal hook that is run after a buffer is saved to its file."
3164 :options '(executable-make-buffer-file-executable-if-script-p)
3168 (defvar save-buffer-coding-system nil
3169 "If non-nil, use this coding system for saving the buffer.
3170 More precisely, use this coding system in place of the
3171 value of `buffer-file-coding-system', when saving the buffer.
3172 Calling `write-region' for any purpose other than saving the buffer
3173 will still use `buffer-file-coding-system'; this variable has no effect
3176 (make-variable-buffer-local 'save-buffer-coding-system)
3177 (put 'save-buffer-coding-system 'permanent-local t)
3179 (defun basic-save-buffer ()
3180 "Save the current buffer in its visited file, if it has been modified.
3181 The hooks `write-contents-functions' and `write-file-functions' get a chance
3182 to do the job of saving; if they do not, then the buffer is saved in
3183 the visited file file in the usual way.
3184 Before and after saving the buffer, this function runs
3185 `before-save-hook' and `after-save-hook', respectively."
3187 (save-current-buffer
3188 ;; In an indirect buffer, save its base buffer instead.
3189 (if (buffer-base-buffer)
3190 (set-buffer (buffer-base-buffer)))
3191 (if (buffer-modified-p)
3192 (let ((recent-save (recent-auto-save-p))
3194 ;; On VMS, rename file and buffer to get rid of version number.
3195 (if (and (eq system-type 'vax-vms)
3196 (not (string= buffer-file-name
3197 (file-name-sans-versions buffer-file-name))))
3198 (let (buffer-new-name)
3199 ;; Strip VMS version number before save.
3200 (setq buffer-file-name
3201 (file-name-sans-versions buffer-file-name))
3202 ;; Construct a (unique) buffer name to correspond.
3203 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3204 (setq buffer-new-name (buffer-name buf))
3206 (rename-buffer buffer-new-name)))
3207 ;; If buffer has no file name, ask user for one.
3208 (or buffer-file-name
3211 (read-file-name "File to save in: ") nil)))
3212 (and (file-exists-p filename)
3213 (or (y-or-n-p (format "File `%s' exists; overwrite? "
3215 (error "Canceled")))
3216 (set-visited-file-name filename)))
3217 (or (verify-visited-file-modtime (current-buffer))
3218 (not (file-exists-p buffer-file-name))
3220 (format "%s has changed since visited or saved. Save anyway? "
3221 (file-name-nondirectory buffer-file-name)))
3222 (error "Save not confirmed"))
3226 (and (> (point-max) (point-min))
3227 (not find-file-literally)
3228 (/= (char-after (1- (point-max))) ?\n)
3229 (not (and (eq selective-display t)
3230 (= (char-after (1- (point-max))) ?\r)))
3231 (or (eq require-final-newline t)
3232 (eq require-final-newline 'visit-save)
3233 (and require-final-newline
3235 (format "Buffer %s does not end in newline. Add one? "
3238 (goto-char (point-max))
3240 ;; Support VC version backups.
3242 (run-hooks 'before-save-hook)
3243 (or (run-hook-with-args-until-success 'write-contents-functions)
3244 (run-hook-with-args-until-success 'local-write-file-hooks)
3245 (run-hook-with-args-until-success 'write-file-functions)
3246 ;; If a hook returned t, file is already "written".
3247 ;; Otherwise, write it the usual way now.
3248 (setq setmodes (basic-save-buffer-1)))
3249 ;; Now we have saved the current buffer. Let's make sure
3250 ;; that buffer-file-coding-system is fixed to what
3251 ;; actually used for saving by binding it locally.
3252 (if save-buffer-coding-system
3253 (setq save-buffer-coding-system last-coding-system-used)
3254 (setq buffer-file-coding-system last-coding-system-used))
3255 (setq buffer-file-number
3256 (nthcdr 10 (file-attributes buffer-file-name)))
3259 (set-file-modes buffer-file-name (car setmodes))
3261 ;; If the auto-save file was recent before this command,
3263 (delete-auto-save-file-if-necessary recent-save)
3264 ;; Support VC `implicit' locking.
3266 (run-hooks 'after-save-hook))
3267 (message "(No changes need to be saved)"))))
3269 ;; This does the "real job" of writing a buffer into its visited file
3270 ;; and making a backup file. This is what is normally done
3271 ;; but inhibited if one of write-file-functions returns non-nil.
3272 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3273 (defun basic-save-buffer-1 ()
3274 (if save-buffer-coding-system
3275 (let ((coding-system-for-write save-buffer-coding-system))
3276 (basic-save-buffer-2))
3277 (basic-save-buffer-2))
3278 (setq buffer-file-coding-system-explicit last-coding-system-used))
3280 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3281 (defun basic-save-buffer-2 ()
3282 (let (tempsetmodes setmodes)
3283 (if (not (file-writable-p buffer-file-name))
3284 (let ((dir (file-name-directory buffer-file-name)))
3285 (if (not (file-directory-p dir))
3286 (if (file-exists-p dir)
3287 (error "%s is not a directory" dir)
3288 (error "%s: no such directory" buffer-file-name))
3289 (if (not (file-exists-p buffer-file-name))
3290 (error "Directory %s write-protected" dir)
3292 (format "File %s is write-protected; try to save anyway? "
3293 (file-name-nondirectory
3295 (setq tempsetmodes t)
3296 (error "Attempt to save to a file which you aren't allowed to write"))))))
3297 (or buffer-backed-up
3298 (setq setmodes (backup-buffer)))
3299 (let ((dir (file-name-directory buffer-file-name)))
3300 (if (and file-precious-flag
3301 (file-writable-p dir))
3302 ;; If file is precious, write temp name, then rename it.
3303 ;; This requires write access to the containing dir,
3304 ;; which is why we don't try it if we don't have that access.
3305 (let ((realname buffer-file-name)
3306 tempname nogood i succeed
3307 (old-modtime (visited-file-modtime)))
3310 ;; Find the temporary name to write under.
3312 (setq tempname (format
3313 (if (and (eq system-type 'ms-dos)
3314 (not (msdos-long-file-names)))
3315 "%s#%d.tm#" ; MSDOS limits files to 8+3
3316 (if (memq system-type '(vax-vms axp-vms))
3320 (setq nogood (file-exists-p tempname))
3323 (progn (clear-visited-file-modtime)
3324 (write-region (point-min) (point-max)
3325 tempname nil realname
3326 buffer-file-truename)
3328 ;; If writing the temp file fails,
3329 ;; delete the temp file.
3333 (delete-file tempname)
3335 (set-visited-file-modtime old-modtime))))
3336 ;; Since we have created an entirely new file
3337 ;; and renamed it, make sure it gets the
3338 ;; right permission bits set.
3339 (setq setmodes (or setmodes (cons (file-modes buffer-file-name)
3341 ;; We succeeded in writing the temp file,
3343 (rename-file tempname buffer-file-name t))
3344 ;; If file not writable, see if we can make it writable
3345 ;; temporarily while we write it.
3346 ;; But no need to do so if we have just backed it up
3347 ;; (setmodes is set) because that says we're superseding.
3348 (cond ((and tempsetmodes (not setmodes))
3349 ;; Change the mode back, after writing.
3350 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3351 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3355 (write-region (point-min) (point-max)
3356 buffer-file-name nil t buffer-file-truename)
3358 ;; If we get an error writing the new file, and we made
3359 ;; the backup by renaming, undo the backing-up.
3360 (and setmodes (not success)
3361 (rename-file (cdr setmodes) buffer-file-name))))))
3364 (defun diff-buffer-with-file (&optional buffer)
3365 "View the differences between BUFFER and its associated file.
3366 This requires the external program `diff' to be in your `exec-path'."
3367 (interactive "bBuffer: ")
3368 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3369 (if (and buffer-file-name
3370 (file-exists-p buffer-file-name))
3371 (let ((tempfile (make-temp-file "buffer-content-")))
3375 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3376 (diff buffer-file-name tempfile nil t)
3378 (when (file-exists-p tempfile)
3379 (delete-file tempfile))))
3380 (message "Buffer %s has no associated file on disc" (buffer-name))
3381 ;; Display that message for 1 second so that user can read it
3382 ;; in the minibuffer.
3384 ;; return always nil, so that save-buffers-kill-emacs will not move
3385 ;; over to the next unsaved buffer when calling `d'.
3388 (defvar save-some-buffers-action-alist
3393 (exit-recursive-edit)))
3395 ;; Return nil to ask about BUF again.
3397 "display the current buffer")
3398 (?d diff-buffer-with-file
3399 "show difference to last saved version"))
3400 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3401 (put 'save-some-buffers-action-alist 'risky-local-variable t)
3403 (defvar buffer-save-without-query nil
3404 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3405 (make-variable-buffer-local 'buffer-save-without-query)
3407 (defun save-some-buffers (&optional arg pred)
3408 "Save some modified file-visiting buffers. Asks user about each one.
3409 You can answer `y' to save, `n' not to save, `C-r' to look at the
3410 buffer in question with `view-buffer' before deciding or `d' to
3411 view the differences using `diff-buffer-to-file'.
3413 Optional argument (the prefix) non-nil means save all with no questions.
3414 Optional second argument PRED determines which buffers are considered:
3415 If PRED is nil, all the file-visiting buffers are considered.
3416 If PRED is t, then certain non-file buffers will also be considered.
3417 If PRED is a zero-argument function, it indicates for each buffer whether
3418 to consider it or not when called with that buffer current.
3420 See `save-some-buffers-action-alist' if you want to
3421 change the additional actions you can take on files."
3423 (save-window-excursion
3424 (let* (queried some-automatic
3425 files-done abbrevs-done)
3426 (dolist (buffer (buffer-list))
3427 ;; First save any buffers that we're supposed to save unconditionally.
3428 ;; That way the following code won't ask about them.
3429 (with-current-buffer buffer
3430 (when (and buffer-save-without-query (buffer-modified-p))
3431 (setq some-automatic t)
3433 ;; Ask about those buffers that merit it,
3434 ;; and record the number thus saved.
3439 (and (buffer-modified-p buffer)
3440 (not (buffer-base-buffer buffer))
3442 (buffer-file-name buffer)
3446 (and buffer-offer-save (> (buffer-size) 0)))))
3447 (or (not (functionp pred))
3448 (with-current-buffer buffer (funcall pred)))
3452 (if (buffer-file-name buffer)
3453 (format "Save file %s? "
3454 (buffer-file-name buffer))
3455 (format "Save buffer %s? "
3456 (buffer-name buffer)))))))
3462 '("buffer" "buffers" "save")
3463 save-some-buffers-action-alist))
3464 ;; Maybe to save abbrevs, and record whether
3465 ;; we either saved them or asked to.
3466 (and save-abbrevs abbrevs-changed
3469 (eq save-abbrevs 'silently)
3470 (y-or-n-p (format "Save abbrevs in %s? "
3472 (write-abbrev-file nil))
3473 ;; Don't keep bothering user if he says no.
3474 (setq abbrevs-changed nil)
3475 (setq abbrevs-done t)))
3476 (or queried (> files-done 0) abbrevs-done
3477 (message (if some-automatic
3478 "(Some special files were saved without asking)"
3479 "(No files need saving)"))))))
3481 (defun not-modified (&optional arg)
3482 "Mark current buffer as unmodified, not needing to be saved.
3483 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3485 It is not a good idea to use this function in Lisp programs, because it
3486 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3488 (message (if arg "Modification-flag set"
3489 "Modification-flag cleared"))
3490 (set-buffer-modified-p arg))
3492 (defun toggle-read-only (&optional arg)
3493 "Change whether this buffer is visiting its file read-only.
3494 With arg, set read-only iff arg is positive.
3495 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3498 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3499 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3503 ((and buffer-read-only view-mode)
3504 (View-exit-and-edit)
3505 (make-local-variable 'view-read-only)
3506 (setq view-read-only t)) ; Must leave view mode.
3507 ((and (not buffer-read-only) view-read-only
3508 ;; If view-mode is already active, `view-mode-enter' is a nop.
3510 (not (eq (get major-mode 'mode-class) 'special)))
3512 (t (setq buffer-read-only (not buffer-read-only))
3513 (force-mode-line-update)))
3514 (if (vc-backend buffer-file-name)
3515 (message (substitute-command-keys
3516 (concat "File is under version-control; "
3517 "use \\[vc-next-action] to check in/out"))))))
3519 (defun insert-file (filename)
3520 "Insert contents of file FILENAME into buffer after point.
3521 Set mark after the inserted text.
3523 This function is meant for the user to run interactively.
3524 Don't call it from programs! Use `insert-file-contents' instead.
3525 \(Its calling sequence is different; see its documentation)."
3526 (interactive "*fInsert file: ")
3527 (insert-file-1 filename #'insert-file-contents))
3529 (defun append-to-file (start end filename)
3530 "Append the contents of the region to the end of file FILENAME.
3531 When called from a function, expects three arguments,
3532 START, END and FILENAME. START and END are buffer positions
3533 saying what text to write."
3534 (interactive "r\nFAppend to file: ")
3535 (write-region start end filename t))
3537 (defun file-newest-backup (filename)
3538 "Return most recent backup file for FILENAME or nil if no backups exist."
3539 ;; `make-backup-file-name' will get us the right directory for
3540 ;; ordinary or numeric backups. It might create a directory for
3541 ;; backups as a side-effect, according to `backup-directory-alist'.
3542 (let* ((filename (file-name-sans-versions
3543 (make-backup-file-name (expand-file-name filename))))
3544 (file (file-name-nondirectory filename))
3545 (dir (file-name-directory filename))
3546 (comp (file-name-all-completions file dir))
3550 (setq tem (pop comp))
3551 (cond ((and (backup-file-name-p tem)
3552 (string= (file-name-sans-versions tem) file))
3553 (setq tem (concat dir tem))
3554 (if (or (null newest)
3555 (file-newer-than-file-p tem newest))
3556 (setq newest tem)))))
3559 (defun rename-uniquely ()
3560 "Rename current buffer to a similar name not already taken.
3561 This function is useful for creating multiple shell process buffers
3562 or multiple mail buffers, etc."
3565 (let ((base-name (buffer-name)))
3566 (and (string-match "<[0-9]+>\\'" base-name)
3567 (not (and buffer-file-name
3569 (file-name-nondirectory buffer-file-name))))
3570 ;; If the existing buffer name has a <NNN>,
3571 ;; which isn't part of the file name (if any),
3572 ;; then get rid of that.
3573 (setq base-name (substring base-name 0 (match-beginning 0))))
3574 (rename-buffer (generate-new-buffer-name base-name))
3575 (force-mode-line-update))))
3577 (defun make-directory (dir &optional parents)
3578 "Create the directory DIR and any nonexistent parent dirs.
3579 Interactively, the default choice of directory to create
3580 is the current default directory for file names.
3581 That is useful when you have visited a file in a nonexistent directory.
3583 Noninteractively, the second (optional) argument PARENTS says whether
3584 to create parent directories if they don't exist. Interactively,
3585 this happens by default."
3587 (list (read-file-name "Make directory: " default-directory default-directory
3590 ;; If default-directory is a remote directory,
3591 ;; make sure we find its make-directory handler.
3592 (setq dir (expand-file-name dir))
3593 (let ((handler (find-file-name-handler dir 'make-directory)))
3595 (funcall handler 'make-directory dir parents)
3597 (make-directory-internal dir)
3598 (let ((dir (directory-file-name (expand-file-name dir)))
3600 (while (not (file-exists-p dir))
3601 (setq create-list (cons dir create-list)
3602 dir (directory-file-name (file-name-directory dir))))
3604 (make-directory-internal (car create-list))
3605 (setq create-list (cdr create-list))))))))
3607 (put 'revert-buffer-function 'permanent-local t)
3608 (defvar revert-buffer-function nil
3609 "Function to use to revert this buffer, or nil to do the default.
3610 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3611 which are the arguments that `revert-buffer' received.")
3613 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3614 (defvar revert-buffer-insert-file-contents-function nil
3615 "Function to use to insert contents when reverting this buffer.
3616 Gets two args, first the nominal file name to use,
3617 and second, t if reading the auto-save file.
3619 The function you specify is responsible for updating (or preserving) point.")
3621 (defvar buffer-stale-function nil
3622 "Function to check whether a non-file buffer needs reverting.
3623 This should be a function with one optional argument NOCONFIRM.
3624 Auto Revert Mode sets NOCONFIRM to t. The function should return
3625 non-nil if the buffer should be reverted. A return value of
3626 `fast' means that the need for reverting was not checked, but
3627 that reverting the buffer is fast. The buffer is current when
3628 this function is called.
3630 The idea behind the NOCONFIRM argument is that it should be
3631 non-nil if the buffer is going to be reverted without asking the
3632 user. In such situations, one has to be careful with potentially
3633 time consuming operations.
3635 For more information on how this variable is used by Auto Revert mode,
3636 see Info node `(emacs-xtra)Supporting additional buffers'.")
3638 (defvar before-revert-hook nil
3639 "Normal hook for `revert-buffer' to run before reverting.
3640 If `revert-buffer-function' is used to override the normal revert
3641 mechanism, this hook is not used.")
3643 (defvar after-revert-hook nil
3644 "Normal hook for `revert-buffer' to run after reverting.
3645 Note that the hook value that it runs is the value that was in effect
3646 before reverting; that makes a difference if you have buffer-local
3649 If `revert-buffer-function' is used to override the normal revert
3650 mechanism, this hook is not used.")
3652 (defvar revert-buffer-internal-hook)
3654 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
3655 "Replace current buffer text with the text of the visited file on disk.
3656 This undoes all changes since the file was visited or saved.
3657 With a prefix argument, offer to revert from latest auto-save file, if
3658 that is more recent than the visited file.
3660 This command also works for special buffers that contain text which
3661 doesn't come from a file, but reflects some other data base instead:
3662 for example, Dired buffers and `buffer-list' buffers. In these cases,
3663 it reconstructs the buffer contents from the appropriate data base.
3665 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3666 to revert from the auto-save file when this is nil. Note that the
3667 sense of this argument is the reverse of the prefix argument, for the
3668 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3671 Optional second argument NOCONFIRM means don't ask for confirmation at
3672 all. (The local variable `revert-without-query', if non-nil, prevents
3675 Optional third argument PRESERVE-MODES non-nil means don't alter
3676 the files modes. Normally we reinitialize them using `normal-mode'.
3678 If the value of `revert-buffer-function' is non-nil, it is called to
3679 do all the work for this command. Otherwise, the hooks
3680 `before-revert-hook' and `after-revert-hook' are run at the beginning
3681 and the end, and if `revert-buffer-insert-file-contents-function' is
3682 non-nil, it is called instead of rereading visited file contents."
3684 ;; I admit it's odd to reverse the sense of the prefix argument, but
3685 ;; there is a lot of code out there which assumes that the first
3686 ;; argument should be t to avoid consulting the auto-save file, and
3687 ;; there's no straightforward way to encourage authors to notice a
3688 ;; reversal of the argument sense. So I'm just changing the user
3689 ;; interface, but leaving the programmatic interface the same.
3690 (interactive (list (not current-prefix-arg)))
3691 (if revert-buffer-function
3692 (funcall revert-buffer-function ignore-auto noconfirm)
3693 (let* ((auto-save-p (and (not ignore-auto)
3694 (recent-auto-save-p)
3695 buffer-auto-save-file-name
3696 (file-readable-p buffer-auto-save-file-name)
3698 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3699 (file-name (if auto-save-p
3700 buffer-auto-save-file-name
3702 (cond ((null file-name)
3703 (error "Buffer does not seem to be associated with any file"))
3705 (and (not (buffer-modified-p))
3706 (let ((tail revert-without-query)
3709 (if (string-match (car tail) file-name)
3711 (setq tail (cdr tail)))
3713 (yes-or-no-p (format "Revert buffer from file %s? "
3715 (run-hooks 'before-revert-hook)
3716 ;; If file was backed up but has changed since,
3717 ;; we shd make another backup.
3718 (and (not auto-save-p)
3719 (not (verify-visited-file-modtime (current-buffer)))
3720 (setq buffer-backed-up nil))
3721 ;; Get rid of all undo records for this buffer.
3722 (or (eq buffer-undo-list t)
3723 (setq buffer-undo-list nil))
3724 ;; Effectively copy the after-revert-hook status,
3725 ;; since after-find-file will clobber it.
3726 (let ((global-hook (default-value 'after-revert-hook))
3727 (local-hook-p (local-variable-p 'after-revert-hook))
3728 (local-hook (and (local-variable-p 'after-revert-hook)
3729 after-revert-hook)))
3730 (let (buffer-read-only
3731 ;; Don't make undo records for the reversion.
3732 (buffer-undo-list t))
3733 (if revert-buffer-insert-file-contents-function
3734 (funcall revert-buffer-insert-file-contents-function
3735 file-name auto-save-p)
3736 (if (not (file-exists-p file-name))
3737 (error (if buffer-file-number
3738 "File %s no longer exists!"
3739 "Cannot revert nonexistent file %s")
3741 ;; Bind buffer-file-name to nil
3742 ;; so that we don't try to lock the file.
3743 (let ((buffer-file-name nil))
3747 (let ((coding-system-for-read
3748 ;; Auto-saved file shoule be read by Emacs'
3750 (if auto-save-p 'auto-save-coding
3751 (or coding-system-for-read
3752 buffer-file-coding-system-explicit))))
3753 ;; This force after-insert-file-set-coding
3754 ;; (called from insert-file-contents) to set
3755 ;; buffer-file-coding-system to a proper value.
3756 (kill-local-variable 'buffer-file-coding-system)
3758 ;; Note that this preserves point in an intelligent way.
3760 (let ((buffer-file-format buffer-file-format))
3761 (insert-file-contents file-name (not auto-save-p)
3763 (insert-file-contents file-name (not auto-save-p)
3765 ;; Recompute the truename in case changes in symlinks
3766 ;; have changed the truename.
3767 (setq buffer-file-truename
3768 (abbreviate-file-name (file-truename buffer-file-name)))
3769 (after-find-file nil nil t t preserve-modes)
3770 ;; Run after-revert-hook as it was before we reverted.
3771 (setq-default revert-buffer-internal-hook global-hook)
3773 (set (make-local-variable 'revert-buffer-internal-hook)
3775 (kill-local-variable 'revert-buffer-internal-hook))
3776 (run-hooks 'revert-buffer-internal-hook))
3779 (defun recover-this-file ()
3780 "Recover the visited file--get contents from its last auto-save file."
3782 (recover-file buffer-file-name))
3784 (defun recover-file (file)
3785 "Visit file FILE, but get contents from its last auto-save file."
3786 ;; Actually putting the file name in the minibuffer should be used
3788 ;; Not just because users often use the default.
3789 (interactive "FRecover file: ")
3790 (setq file (expand-file-name file))
3791 (if (auto-save-file-name-p (file-name-nondirectory file))
3792 (error "%s is an auto-save file" (abbreviate-file-name file)))
3793 (let ((file-name (let ((buffer-file-name file))
3794 (make-auto-save-file-name))))
3795 (cond ((if (file-exists-p file)
3796 (not (file-newer-than-file-p file-name file))
3797 (not (file-exists-p file-name)))
3798 (error "Auto-save file %s not current"
3799 (abbreviate-file-name file-name)))
3800 ((save-window-excursion
3801 (with-output-to-temp-buffer "*Directory*"
3802 (buffer-disable-undo standard-output)
3804 (let ((switches dired-listing-switches))
3805 (if (file-symlink-p file)
3806 (setq switches (concat switches "L")))
3807 (set-buffer standard-output)
3808 ;; Use insert-directory-safely, not insert-directory,
3809 ;; because these files might not exist. In particular,
3810 ;; FILE might not exist if the auto-save file was for
3811 ;; a buffer that didn't visit a file, such as "*mail*".
3812 ;; The code in v20.x called `ls' directly, so we need
3813 ;; to emulate what `ls' did in that case.
3814 (insert-directory-safely file switches)
3815 (insert-directory-safely file-name switches))))
3816 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3817 (switch-to-buffer (find-file-noselect file t))
3818 (let ((buffer-read-only nil)
3819 ;; Keep the current buffer-file-coding-system.
3820 (coding-system buffer-file-coding-system)
3821 ;; Auto-saved file shoule be read with special coding.
3822 (coding-system-for-read 'auto-save-coding))
3824 (insert-file-contents file-name nil)
3825 (set-buffer-file-coding-system coding-system))
3826 (after-find-file nil nil t))
3827 (t (error "Recover-file cancelled")))))
3829 (defun recover-session ()
3830 "Recover auto save files from a previous Emacs session.
3831 This command first displays a Dired buffer showing you the
3832 previous sessions that you could recover from.
3833 To choose one, move point to the proper line and then type C-c C-c.
3834 Then you'll be asked about a number of files to recover."
3836 (if (null auto-save-list-file-prefix)
3837 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3838 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3839 (unless (file-directory-p dir)
3840 (make-directory dir t))
3841 (unless (directory-files dir nil
3842 (concat "\\`" (regexp-quote
3843 (file-name-nondirectory
3844 auto-save-list-file-prefix)))
3846 (error "No previous sessions to recover")))
3847 (let ((ls-lisp-support-shell-wildcards t))
3848 (dired (concat auto-save-list-file-prefix "*")
3849 (concat dired-listing-switches "t")))
3851 (goto-char (point-min))
3852 (or (looking-at " Move to the session you want to recover,")
3853 (let ((inhibit-read-only t))
3854 ;; Each line starts with a space
3855 ;; so that Font Lock mode won't highlight the first character.
3856 (insert " Move to the session you want to recover,\n"
3857 " then type C-c C-c to select it.\n\n"
3858 " You can also delete some of these files;\n"
3859 " type d on a line to mark that file for deletion.\n\n"))))
3860 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3861 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3863 (defun recover-session-finish ()
3864 "Choose one saved session to recover auto-save files from.
3865 This command is used in the special Dired buffer created by
3866 \\[recover-session]."
3868 ;; Get the name of the session file to recover from.
3869 (let ((file (dired-get-filename))
3871 (buffer (get-buffer-create " *recover*")))
3873 (dired-do-flagged-delete t)
3876 ;; Read in the auto-save-list file.
3879 (insert-file-contents file)
3880 ;; Loop thru the text of that file
3881 ;; and get out the names of the files to recover.
3883 (let (thisfile autofile)
3885 ;; This is a pair of lines for a non-file-visiting buffer.
3886 ;; Get the auto-save file name and manufacture
3887 ;; a "visited file name" from that.
3890 ;; If there is no auto-save file name, the
3891 ;; auto-save-list file is probably corrupted.
3894 (buffer-substring-no-properties
3902 (file-name-nondirectory autofile)
3904 (file-name-directory autofile))))
3906 ;; This pair of lines is a file-visiting
3907 ;; buffer. Use the visited file name.
3910 (buffer-substring-no-properties
3911 (point) (progn (end-of-line) (point))))
3914 (buffer-substring-no-properties
3915 (point) (progn (end-of-line) (point))))
3917 ;; Ignore a file if its auto-save file does not exist now.
3918 (if (and autofile (file-exists-p autofile))
3919 (setq files (cons thisfile files)))))
3920 (setq files (nreverse files))
3921 ;; The file contains a pair of line for each auto-saved buffer.
3922 ;; The first line of the pair contains the visited file name
3923 ;; or is empty if the buffer was not visiting a file.
3924 ;; The second line is the auto-save file name.
3926 (map-y-or-n-p "Recover %s? "
3929 (save-excursion (recover-file file))
3931 "Failed to recover `%s'" file)))
3933 '("file" "files" "recover"))
3934 (message "No files can be recovered from this session now")))
3935 (kill-buffer buffer))))
3937 (defun kill-some-buffers (&optional list)
3938 "Kill some buffers. Asks the user whether to kill each one of them.
3939 Non-interactively, if optional argument LIST is non-nil, it
3940 specifies the list of buffers to kill, asking for approval for each one."
3943 (setq list (buffer-list)))
3945 (let* ((buffer (car list))
3946 (name (buffer-name buffer)))
3947 (and (not (string-equal name ""))
3948 (/= (aref name 0) ? )
3950 (format "Buffer %s %s. Kill? "
3952 (if (buffer-modified-p buffer)
3953 "HAS BEEN EDITED" "is unmodified")))
3954 (kill-buffer buffer)))
3955 (setq list (cdr list))))
3957 (defun auto-save-mode (arg)
3958 "Toggle auto-saving of contents of current buffer.
3959 With prefix argument ARG, turn auto-saving on if positive, else off."
3961 (setq buffer-auto-save-file-name
3963 (or (not buffer-auto-save-file-name)
3964 ;; If auto-save is off because buffer has shrunk,
3965 ;; then toggling should turn it on.
3966 (< buffer-saved-size 0))
3967 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3968 (if (and buffer-file-name auto-save-visited-file-name
3969 (not buffer-read-only))
3971 (make-auto-save-file-name))))
3972 ;; If -1 was stored here, to temporarily turn off saving,
3974 (and (< buffer-saved-size 0)
3975 (setq buffer-saved-size 0))
3977 (message "Auto-save %s (in this buffer)"
3978 (if buffer-auto-save-file-name "on" "off")))
3979 buffer-auto-save-file-name)
3981 (defun rename-auto-save-file ()
3982 "Adjust current buffer's auto save file name for current conditions.
3983 Also rename any existing auto save file, if it was made in this session."
3984 (let ((osave buffer-auto-save-file-name))
3985 (setq buffer-auto-save-file-name
3986 (make-auto-save-file-name))
3987 (if (and osave buffer-auto-save-file-name
3988 (not (string= buffer-auto-save-file-name buffer-file-name))
3989 (not (string= buffer-auto-save-file-name osave))
3990 (file-exists-p osave)
3991 (recent-auto-save-p))
3992 (rename-file osave buffer-auto-save-file-name t))))
3994 (defun make-auto-save-file-name ()
3995 "Return file name to use for auto-saves of current buffer.
3996 Does not consider `auto-save-visited-file-name' as that variable is checked
3997 before calling this function. You can redefine this for customization.
3998 See also `auto-save-file-name-p'."
3999 (if buffer-file-name
4000 (let ((list auto-save-file-name-transforms)
4001 (filename buffer-file-name)
4003 ;; Apply user-specified translations
4004 ;; to the file name.
4005 (while (and list (not result))
4006 (if (string-match (car (car list)) filename)
4007 (setq result (replace-match (cadr (car list)) t nil
4009 uniq (car (cddr (car list)))))
4010 (setq list (cdr list)))
4013 (setq filename (concat
4014 (file-name-directory result)
4015 (subst-char-in-string
4017 (replace-regexp-in-string "!" "!!"
4019 (setq filename result)))
4021 (if (and (eq system-type 'ms-dos)
4022 (not (msdos-long-file-names)))
4023 ;; We truncate the file name to DOS 8+3 limits
4024 ;; before doing anything else, because the regexp
4025 ;; passed to string-match below cannot handle
4026 ;; extensions longer than 3 characters, multiple
4027 ;; dots, and other atrocities.
4028 (let ((fn (dos-8+3-filename
4029 (file-name-nondirectory buffer-file-name))))
4031 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4033 (concat (file-name-directory buffer-file-name)
4034 "#" (match-string 1 fn)
4035 "." (match-string 3 fn) "#"))
4036 (concat (file-name-directory filename)
4038 (file-name-nondirectory filename)
4040 ;; Make sure auto-save file names don't contain characters
4041 ;; invalid for the underlying filesystem.
4042 (if (and (memq system-type '(ms-dos windows-nt))
4043 ;; Don't modify remote (ange-ftp) filenames
4044 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4045 (convert-standard-filename result)
4048 ;; Deal with buffers that don't have any associated files. (Mail
4049 ;; mode tends to create a good number of these.)
4051 (let ((buffer-name (buffer-name))
4054 ;; Eliminate all slashes and backslashes by
4055 ;; replacing them with sequences that start with %.
4056 ;; Quote % also, to keep distinct names distinct.
4057 (while (string-match "[/\\%]" buffer-name limit)
4058 (let* ((character (aref buffer-name (match-beginning 0)))
4060 (cond ((eq character ?%) "%%")
4061 ((eq character ?/) "%+")
4062 ((eq character ?\\) "%-"))))
4063 (setq buffer-name (replace-match replacement t t buffer-name))
4064 (setq limit (1+ (match-end 0)))))
4065 ;; Generate the file name.
4070 (format "#%s#" buffer-name)
4071 ;; Try a few alternative directories, to get one we can
4074 ((file-writable-p default-directory) default-directory)
4075 ((file-writable-p "/var/tmp/") "/var/tmp/")
4077 (if (and (memq system-type '(ms-dos windows-nt))
4078 ;; Don't modify remote (ange-ftp) filenames
4079 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4080 ;; The call to convert-standard-filename is in case
4081 ;; buffer-name includes characters not allowed by the
4082 ;; DOS/Windows filesystems. make-temp-file writes to the
4083 ;; file it creates, so we must fix the file name _before_
4084 ;; make-temp-file is called.
4085 (convert-standard-filename fname)
4088 ;; make-temp-file creates the file,
4089 ;; but we don't want it to exist until we do an auto-save.
4091 (delete-file file-name)
4095 (defun auto-save-file-name-p (filename)
4096 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4097 FILENAME should lack slashes. You can redefine this for customization."
4098 (string-match "^#.*#$" filename))
4100 (defun wildcard-to-regexp (wildcard)
4101 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4102 The generated regexp will match a filename iff the filename
4103 matches that wildcard according to shell rules. Only wildcards known
4104 by `sh' are supported."
4105 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4106 ;; Copy the initial run of non-special characters.
4107 (result (substring wildcard 0 i))
4108 (len (length wildcard)))
4109 ;; If no special characters, we're almost done.
4112 (let ((ch (aref wildcard i))
4120 (eq (aref wildcard (1+ i)) ?\]))
4122 ((eq ch ?\[) ; [...] maps to regexp char class
4127 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4130 (if (eq (aref wildcard i) ?\])
4135 ((eq (aref wildcard i) ?^)
4136 ;; Found "[^". Insert a `\0' character
4137 ;; (which cannot happen in a filename)
4138 ;; into the character class, so that `^'
4139 ;; is not the first character after `[',
4140 ;; and thus non-special in a regexp.
4144 ((eq (aref wildcard i) ?\])
4145 ;; I don't think `]' can appear in a
4146 ;; character class in a wildcard, but
4147 ;; let's be general here.
4152 (prog1 ; copy everything upto next `]'.
4155 (setq j (string-match
4157 (setq i (if j (1- j) (1- len)))))))
4159 ((eq ch ?*) "[^\000]*")
4163 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4164 ((eq ch ??) "[^\000]")
4165 (t (char-to-string ch)))))
4167 ;; Shell wildcards should match the entire filename,
4168 ;; not its part. Make the regexp say so.
4169 (concat "\\`" result "\\'")))
4171 (defcustom list-directory-brief-switches
4172 (if (eq system-type 'vax-vms) "" "-CF")
4173 "*Switches for `list-directory' to pass to `ls' for brief listing."
4177 (defcustom list-directory-verbose-switches
4178 (if (eq system-type 'vax-vms)
4179 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4181 "*Switches for `list-directory' to pass to `ls' for verbose listing."
4185 (defun file-expand-wildcards (pattern &optional full)
4186 "Expand wildcard pattern PATTERN.
4187 This returns a list of file names which match the pattern.
4189 If PATTERN is written as an absolute file name,
4190 the values are absolute also.
4192 If PATTERN is written as a relative file name, it is interpreted
4193 relative to the current default directory, `default-directory'.
4194 The file names returned are normally also relative to the current
4195 default directory. However, if FULL is non-nil, they are absolute."
4197 (let* ((nondir (file-name-nondirectory pattern))
4198 (dirpart (file-name-directory pattern))
4199 ;; A list of all dirs that DIRPART specifies.
4200 ;; This can be more than one dir
4201 ;; if DIRPART contains wildcards.
4202 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4203 (mapcar 'file-name-as-directory
4204 (file-expand-wildcards (directory-file-name dirpart)))
4208 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4209 (file-directory-p (directory-file-name (car dirs))))
4210 (let ((this-dir-contents
4211 ;; Filter out "." and ".."
4213 (mapcar #'(lambda (name)
4214 (unless (string-match "\\`\\.\\.?\\'"
4215 (file-name-nondirectory name))
4217 (directory-files (or (car dirs) ".") full
4218 (wildcard-to-regexp nondir))))))
4221 (if (and (car dirs) (not full))
4222 (mapcar (function (lambda (name) (concat (car dirs) name)))
4226 (setq dirs (cdr dirs)))
4229 (defun list-directory (dirname &optional verbose)
4230 "Display a list of files in or matching DIRNAME, a la `ls'.
4231 DIRNAME is globbed by the shell if necessary.
4232 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4233 Actions controlled by variables `list-directory-brief-switches'
4234 and `list-directory-verbose-switches'."
4235 (interactive (let ((pfx current-prefix-arg))
4236 (list (read-file-name (if pfx "List directory (verbose): "
4237 "List directory (brief): ")
4238 nil default-directory nil)
4240 (let ((switches (if verbose list-directory-verbose-switches
4241 list-directory-brief-switches))
4243 (or dirname (setq dirname default-directory))
4244 (setq dirname (expand-file-name dirname))
4245 (with-output-to-temp-buffer "*Directory*"
4246 (setq buffer standard-output)
4247 (buffer-disable-undo standard-output)
4248 (princ "Directory ")
4252 (set-buffer "*Directory*")
4253 (let ((wildcard (not (file-directory-p dirname))))
4254 (insert-directory dirname switches wildcard (not wildcard)))))
4255 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4256 (with-current-buffer buffer
4257 (setq default-directory
4258 (if (file-directory-p dirname)
4259 (file-name-as-directory dirname)
4260 (file-name-directory dirname))))))
4262 (defun shell-quote-wildcard-pattern (pattern)
4263 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4265 PATTERN is assumed to represent a file-name wildcard suitable for the
4266 underlying filesystem. For Unix and GNU/Linux, the characters from the
4267 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4268 the parts of the pattern which don't include wildcard characters are
4269 quoted with double quotes.
4270 Existing quote characters in PATTERN are left alone, so you can pass
4271 PATTERN that already quotes some of the special characters."
4274 ((memq system-type '(ms-dos windows-nt cygwin))
4275 ;; DOS/Windows don't allow `"' in file names. So if the
4276 ;; argument has quotes, we can safely assume it is already
4277 ;; quoted by the caller.
4278 (if (or (string-match "[\"]" pattern)
4279 ;; We quote [&()#$'] in case their shell is a port of a
4280 ;; Unixy shell. We quote [,=+] because stock DOS and
4281 ;; Windows shells require that in some cases, such as
4282 ;; passing arguments to batch files that use positional
4283 ;; arguments like %1.
4284 (not (string-match "[ \t;&()#$',=+]" pattern)))
4289 (while (string-match "[*?]+" pattern beg)
4290 (setq end (match-beginning 0)
4291 result (concat result (substring pattern beg end)
4293 (substring pattern end (match-end 0))
4296 (concat result (substring pattern beg) "\""))))
4299 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4301 (concat (substring pattern 0 (match-beginning 0))
4303 (substring pattern (match-beginning 0)))
4304 beg (1+ (match-end 0)))))
4308 (defvar insert-directory-program "ls"
4309 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4311 (defcustom directory-free-space-program "df"
4312 "*Program to get the amount of free space on a file system.
4313 We assume the output has the format of `df'.
4314 The value of this variable must be just a command name or file name;
4315 if you want to specify options, use `directory-free-space-args'.
4317 A value of nil disables this feature.
4319 If the function `file-system-info' is defined, it is always used in
4320 preference to the program given by this variable."
4321 :type '(choice (string :tag "Program") (const :tag "None" nil))
4324 (defcustom directory-free-space-args
4325 (if (eq system-type 'darwin) "-k" "-Pk")
4326 "*Options to use when running `directory-free-space-program'."
4330 (defun get-free-disk-space (dir)
4331 "Return the mount of free space on directory DIR's file system.
4332 The result is a string that gives the number of free 1KB blocks,
4333 or nil if the system call or the program which retrieve the infornmation
4336 This function calls `file-system-info' if it is available, or invokes the
4337 program specified by `directory-free-space-program' if that is non-nil."
4338 ;; Try to find the number of free blocks. Non-Posix systems don't
4339 ;; always have df, but might have an equivalent system call.
4340 (if (fboundp 'file-system-info)
4341 (let ((fsinfo (file-system-info dir)))
4343 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4346 (when (and directory-free-space-program
4347 (eq 0 (call-process directory-free-space-program
4349 directory-free-space-args
4351 ;; Usual format is a header line followed by a line of
4353 (goto-char (point-min))
4357 ;; Move to the end of the "available blocks" number.
4358 (skip-chars-forward "^ \t")
4360 ;; Copy it into AVAILABLE.
4361 (let ((end (point)))
4363 (buffer-substring (point) end)))))))))
4366 (defvar insert-directory-ls-version 'unknown)
4369 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4370 ;; FULL-DIRECTORY-P is nil.
4371 ;; The single line of output must display FILE's name as it was
4372 ;; given, namely, an absolute path name.
4373 ;; - must insert exactly one line for each file if WILDCARD or
4374 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4375 ;; before the file lines, plus optional text after the file lines.
4376 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4378 ;; File lines should display the basename.
4379 ;; - must be consistent with
4380 ;; - functions dired-move-to-filename, (these two define what a file line is)
4381 ;; dired-move-to-end-of-filename,
4382 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4383 ;; dired-insert-headerline
4384 ;; dired-after-subdir-garbage (defines what a "total" line is)
4385 ;; - variable dired-subdir-regexp
4386 ;; - may be passed "--dired" as the first argument in SWITCHES.
4387 ;; Filename handlers might have to remove this switch if their
4388 ;; "ls" command does not support it.
4389 (defun insert-directory (file switches &optional wildcard full-directory-p)
4390 "Insert directory listing for FILE, formatted according to SWITCHES.
4391 Leaves point after the inserted text.
4392 SWITCHES may be a string of options, or a list of strings
4393 representing individual options.
4394 Optional third arg WILDCARD means treat FILE as shell wildcard.
4395 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4396 switches do not contain `d', so that a full listing is expected.
4398 This works by running a directory listing program
4399 whose name is in the variable `insert-directory-program'.
4400 If WILDCARD, it also runs the shell specified by `shell-file-name'.
4402 When SWITCHES contains the long `--dired' option, this function
4403 treats it specially, for the sake of dired. However, the
4404 normally equivalent short `-D' option is just passed on to
4405 `insert-directory-program', as any other option."
4406 ;; We need the directory in order to find the right handler.
4407 (let ((handler (find-file-name-handler (expand-file-name file)
4408 'insert-directory)))
4410 (funcall handler 'insert-directory file switches
4411 wildcard full-directory-p)
4412 (if (eq system-type 'vax-vms)
4413 (vms-read-directory file switches (current-buffer))
4414 (let (result (beg (point)))
4416 ;; Read the actual directory using `insert-directory-program'.
4417 ;; RESULT gets the status code.
4418 (let* (;; We at first read by no-conversion, then after
4419 ;; putting text property `dired-filename, decode one
4420 ;; bunch by one to preserve that property.
4421 (coding-system-for-read 'no-conversion)
4422 ;; This is to control encoding the arguments in call-process.
4423 (coding-system-for-write
4424 (and enable-multibyte-characters
4425 (or file-name-coding-system
4426 default-file-name-coding-system))))
4429 ;; Run ls in the directory part of the file pattern
4430 ;; using the last component as argument.
4431 (let ((default-directory
4432 (if (file-name-absolute-p file)
4433 (file-name-directory file)
4434 (file-name-directory (expand-file-name file))))
4435 (pattern (file-name-nondirectory file)))
4437 shell-file-name nil t nil
4439 (concat (if (memq system-type '(ms-dos windows-nt))
4441 "\\") ; Disregard Unix shell aliases!
4442 insert-directory-program
4444 (if (stringp switches)
4446 (mapconcat 'identity switches " "))
4448 ;; Quote some characters that have
4449 ;; special meanings in shells; but
4450 ;; don't quote the wildcards--we want
4451 ;; them to be special. We also
4452 ;; currently don't quote the quoting
4453 ;; characters in case people want to
4454 ;; use them explicitly to quote
4455 ;; wildcard characters.
4456 (shell-quote-wildcard-pattern pattern))))
4457 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4458 ;; directory if FILE is a symbolic link.
4459 (apply 'call-process
4460 insert-directory-program nil t nil
4462 (if (listp switches) switches
4463 (unless (equal switches "")
4464 ;; Split the switches at any spaces so we can
4465 ;; pass separate options as separate args.
4466 (split-string switches)))
4467 ;; Avoid lossage if FILE starts with `-'.
4470 (if (string-match "\\`~" file)
4471 (setq file (expand-file-name file)))
4473 (if full-directory-p
4474 (concat (file-name-as-directory file) ".")
4477 ;; If we got "//DIRED//" in the output, it means we got a real
4478 ;; directory listing, even if `ls' returned nonzero.
4479 ;; So ignore any errors.
4480 (when (if (stringp switches)
4481 (string-match "--dired\\>" switches)
4482 (member "--dired" switches))
4485 (when (looking-at "//SUBDIRED//")
4487 (if (looking-at "//DIRED//")
4490 (when (and (not (eq 0 result))
4491 (eq insert-directory-ls-version 'unknown))
4492 ;; The first time ls returns an error,
4493 ;; find the version numbers of ls,
4494 ;; and set insert-directory-ls-version
4495 ;; to > if it is more than 5.2.1, < if it is less, nil if it
4496 ;; is equal or if the info cannot be obtained.
4497 ;; (That can mean it isn't GNU ls.)
4500 (call-process "ls" nil t nil "--version")
4502 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
4503 (let* ((version (match-string 1 version-out))
4504 (split (split-string version "[.]"))
4505 (numbers (mapcar 'string-to-int split))
4508 (while (and (not comparison) (or numbers min))
4510 (setq comparison '>))
4512 (setq comparison '<))
4513 ((> (car numbers) (car min))
4514 (setq comparison '>))
4515 ((< (car numbers) (car min))
4516 (setq comparison '<))
4518 (setq numbers (cdr numbers)
4520 (setq insert-directory-ls-version (or comparison '=)))
4521 (setq insert-directory-ls-version nil))))
4523 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
4524 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
4527 ;; If `insert-directory-program' failed, signal an error.
4528 (unless (eq 0 result)
4529 ;; Delete the error message it may have output.
4530 (delete-region beg (point))
4531 ;; On non-Posix systems, we cannot open a directory, so
4532 ;; don't even try, because that will always result in
4533 ;; the ubiquitous "Access denied". Instead, show the
4534 ;; command line so the user can try to guess what went wrong.
4535 (if (and (file-directory-p file)
4536 (memq system-type '(ms-dos windows-nt)))
4538 "Reading directory: \"%s %s -- %s\" exited with status %s"
4539 insert-directory-program
4540 (if (listp switches) (concat switches) switches)
4542 ;; Unix. Access the file to get a suitable error.
4543 (access-file file "Reading directory")
4544 (error "Listing directory failed but `access-file' worked")))
4546 (when (if (stringp switches)
4547 (string-match "--dired\\>" switches)
4548 (member "--dired" switches))
4550 (when (looking-at "//SUBDIRED//")
4551 (delete-region (point) (progn (forward-line 1) (point)))
4553 (when (looking-at "//DIRED//")
4554 (let ((end (line-end-position))
4557 ;; Find all the lines that are error messages,
4558 ;; and record the bounds of each one.
4559 (goto-char (point-min))
4560 (while (< (point) linebeg)
4561 (or (eql (following-char) ?\s)
4562 (push (list (point) (line-end-position)) error-lines))
4564 (setq error-lines (nreverse error-lines))
4565 ;; Now read the numeric positions of file names.
4569 (while (< (point) end)
4570 (let ((start (insert-directory-adj-pos
4571 (+ beg (read (current-buffer)))
4573 (end (insert-directory-adj-pos
4574 (+ beg (read (current-buffer)))
4576 (if (memq (char-after end) '(?\n ?\ ))
4577 ;; End is followed by \n or by " -> ".
4578 (put-text-property start end 'dired-filename t)
4579 ;; It seems that we can't trust ls's output as to
4580 ;; byte positions of filenames.
4581 (put-text-property beg (point) 'dired-filename nil)
4585 (delete-region (point) (progn (forward-line 2) (point))))
4587 (if (looking-at "//DIRED-OPTIONS//")
4588 (delete-region (point) (progn (forward-line 1) (point)))
4591 ;; Now decode what read if necessary.
4592 (let ((coding (or coding-system-for-read
4593 file-name-coding-system
4594 default-file-name-coding-system
4598 (when (and enable-multibyte-characters
4599 (not (memq (coding-system-base coding)
4600 '(raw-text no-conversion))))
4601 ;; If no coding system is specified or detection is
4602 ;; requested, detect the coding.
4603 (if (eq (coding-system-base coding) 'undecided)
4604 (setq coding (detect-coding-region beg (point) t)))
4605 (if (not (eq (coding-system-base coding) 'undecided))
4608 (coding-system-change-eol-conversion coding 'unix))
4609 (narrow-to-region beg (point))
4610 (goto-char (point-min))
4613 val (get-text-property (point) 'dired-filename))
4614 (goto-char (next-single-property-change
4615 (point) 'dired-filename nil (point-max)))
4616 ;; Force no eol conversion on a file name, so
4617 ;; that CR is preserved.
4618 (decode-coding-region pos (point)
4619 (if val coding-no-eol coding))
4621 (put-text-property pos (point)
4622 'dired-filename t)))))))
4624 (if full-directory-p
4625 ;; Try to insert the amount of free space.
4628 ;; First find the line to put it on.
4629 (when (re-search-forward "^ *\\(total\\)" nil t)
4630 (let ((available (get-free-disk-space ".")))
4632 ;; Replace "total" with "used", to avoid confusion.
4633 (replace-match "total used in directory" nil nil nil 1)
4635 (insert " available " available)))))))))))
4637 (defun insert-directory-adj-pos (pos error-lines)
4638 "Convert `ls --dired' file name position value POS to a buffer position.
4639 File name position values returned in ls --dired output
4640 count only stdout; they don't count the error messages sent to stderr.
4641 So this function converts to them to real buffer positions.
4642 ERROR-LINES is a list of buffer positions of error message lines,
4643 of the form (START END)."
4644 (while (and error-lines (< (caar error-lines) pos))
4645 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
4649 (defun insert-directory-safely (file switches
4650 &optional wildcard full-directory-p)
4651 "Insert directory listing for FILE, formatted according to SWITCHES.
4653 Like `insert-directory', but if FILE does not exist, it inserts a
4654 message to that effect instead of signaling an error."
4655 (if (file-exists-p file)
4656 (insert-directory file switches wildcard full-directory-p)
4657 ;; Simulate the message printed by `ls'.
4658 (insert (format "%s: No such file or directory\n" file))))
4660 (defvar kill-emacs-query-functions nil
4661 "Functions to call with no arguments to query about killing Emacs.
4662 If any of these functions returns nil, killing Emacs is cancelled.
4663 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
4664 but `kill-emacs', the low level primitive, does not.
4665 See also `kill-emacs-hook'.")
4667 (defcustom confirm-kill-emacs nil
4668 "How to ask for confirmation when leaving Emacs.
4669 If nil, the default, don't ask at all. If the value is non-nil, it should
4670 be a predicate function such as `yes-or-no-p'."
4671 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
4672 (const :tag "Ask with y-or-n-p" y-or-n-p)
4673 (const :tag "Don't confirm" nil))
4677 (defun save-buffers-kill-emacs (&optional arg)
4678 "Offer to save each buffer, then kill this Emacs process.
4679 With prefix arg, silently save all file-visiting buffers, then kill."
4681 (save-some-buffers arg t)
4682 (and (or (not (memq t (mapcar (function
4683 (lambda (buf) (and (buffer-file-name buf)
4684 (buffer-modified-p buf))))
4686 (yes-or-no-p "Modified buffers exist; exit anyway? "))
4687 (or (not (fboundp 'process-list))
4688 ;; process-list is not defined on VMS.
4689 (let ((processes (process-list))
4692 (and (memq (process-status (car processes)) '(run stop open listen))
4693 (process-query-on-exit-flag (car processes))
4695 (setq processes (cdr processes)))
4698 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
4699 ;; Query the user for other things, perhaps.
4700 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
4701 (or (null confirm-kill-emacs)
4702 (funcall confirm-kill-emacs "Really exit Emacs? "))
4705 ;; We use /: as a prefix to "quote" a file name
4706 ;; so that magic file name handlers will not apply to it.
4708 (setq file-name-handler-alist
4709 (cons '("\\`/:" . file-name-non-special)
4710 file-name-handler-alist))
4712 ;; We depend on being the last handler on the list,
4713 ;; so that anything else which does need handling
4714 ;; has been handled already.
4715 ;; So it is safe for us to inhibit *all* magic file name handlers.
4717 (defun file-name-non-special (operation &rest arguments)
4718 (let ((file-name-handler-alist nil)
4720 (if (eq operation 'insert-directory)
4721 (directory-file-name
4723 (unhandled-file-name-directory default-directory)))
4725 ;; Get a list of the indices of the args which are file names.
4727 (cdr (or (assq operation
4728 ;; The first six are special because they
4729 ;; return a file name. We want to include the /:
4730 ;; in the return value.
4731 ;; So just avoid stripping it in the first place.
4732 '((expand-file-name . nil)
4733 (file-name-directory . nil)
4734 (file-name-as-directory . nil)
4735 (directory-file-name . nil)
4736 (file-name-sans-versions . nil)
4737 (find-backup-file-name . nil)
4738 ;; `identity' means just return the first arg
4739 ;; not stripped of its quoting.
4740 (substitute-in-file-name identity)
4741 ;; `add' means add "/:" to the result.
4742 (file-truename add 0)
4743 ;; `quote' means add "/:" to buffer-file-name.
4744 (insert-file-contents quote 0)
4745 ;; `unquote-then-quote' means set buffer-file-name
4746 ;; temporarily to unquoted filename.
4747 (verify-visited-file-modtime unquote-then-quote)
4748 ;; List the arguments which are filenames.
4749 (file-name-completion 1)
4750 (file-name-all-completions 1)
4754 (make-symbolic-link 0 1)
4755 (add-name-to-file 0 1)))
4756 ;; For all other operations, treat the first argument only
4757 ;; as the file name.
4760 ;; Copy ARGUMENTS so we can replace elements in it.
4761 (arguments (copy-sequence arguments)))
4762 (if (symbolp (car file-arg-indices))
4763 (setq method (pop file-arg-indices)))
4764 ;; Strip off the /: from the file names that have it.
4766 (while (consp file-arg-indices)
4767 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4769 (string-match "\\`/:" (car pair))
4771 (if (= (length (car pair)) 2)
4773 (substring (car pair) 2)))))
4774 (setq file-arg-indices (cdr file-arg-indices))))
4775 (cond ((eq method 'identity)
4778 (concat "/:" (apply operation arguments)))
4780 (prog1 (apply operation arguments)
4781 (setq buffer-file-name (concat "/:" buffer-file-name))))
4782 ((eq method 'unquote-then-quote)
4784 (setq buffer-file-name (substring buffer-file-name 2))
4785 (setq res (apply operation arguments))
4786 (setq buffer-file-name (concat "/:" buffer-file-name))
4789 (apply operation arguments)))))
4791 (define-key ctl-x-map "\C-f" 'find-file)
4792 (define-key ctl-x-map "\C-r" 'find-file-read-only)
4793 (define-key ctl-x-map "\C-v" 'find-alternate-file)
4794 (define-key ctl-x-map "\C-s" 'save-buffer)
4795 (define-key ctl-x-map "s" 'save-some-buffers)
4796 (define-key ctl-x-map "\C-w" 'write-file)
4797 (define-key ctl-x-map "i" 'insert-file)
4798 (define-key esc-map "~" 'not-modified)
4799 (define-key ctl-x-map "\C-d" 'list-directory)
4800 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
4801 (define-key ctl-x-map "\C-q" 'toggle-read-only)
4803 (define-key ctl-x-4-map "f" 'find-file-other-window)
4804 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4805 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4806 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
4807 (define-key ctl-x-4-map "\C-o" 'display-buffer)
4809 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
4810 (define-key ctl-x-5-map "f" 'find-file-other-frame)
4811 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
4812 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
4814 ;;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
4815 ;;; files.el ends here