Fix sectrioning errors in files.texi.
[emacs.git] / lisp / files.el
blobf4881911381cf5790a04961faca1a0522f9c67fd
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007 Free Software Foundation, Inc.
7 ;; Maintainer: FSF
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
32 ;;; Code:
34 (defvar font-lock-keywords)
37 (defgroup backup nil
38 "Backups of edited data files."
39 :group 'files)
41 (defgroup find-file nil
42 "Finding files."
43 :group 'files)
46 (defcustom delete-auto-save-files t
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
51 :type 'boolean
52 :group 'auto-save)
54 (defcustom directory-abbrev-alist
55 nil
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 Do not use `~' in the TO strings.
63 They should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
68 :type '(repeat (cons :format "%v"
69 :value ("" . "")
70 (regexp :tag "From")
71 (regexp :tag "To")))
72 :group 'abbrev
73 :group 'find-file)
75 ;; Turn off backup files on VMS since it has version numbers.
76 (defcustom make-backup-files (not (eq system-type 'vax-vms))
77 "Non-nil means make a backup of a file the first time it is saved.
78 This can be done by renaming the file or by copying.
80 Renaming means that Emacs renames the existing file so that it is a
81 backup file, then writes the buffer into a new file. Any other names
82 that the old file had will now refer to the backup file. The new file
83 is owned by you and its group is defaulted.
85 Copying means that Emacs copies the existing file into the backup
86 file, then writes the buffer on top of the existing file. Any other
87 names that the old file had will now refer to the new (edited) file.
88 The file's owner and group are unchanged.
90 The choice of renaming or copying is controlled by the variables
91 `backup-by-copying', `backup-by-copying-when-linked',
92 `backup-by-copying-when-mismatch' and
93 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
94 :type 'boolean
95 :group 'backup)
97 ;; Do this so that local variables based on the file name
98 ;; are not overridden by the major mode.
99 (defvar backup-inhibited nil
100 "Non-nil means don't make a backup, regardless of the other parameters.
101 This variable is intended for use by making it local to a buffer.
102 But it is local only if you make it local.")
103 (put 'backup-inhibited 'permanent-local t)
105 (defcustom backup-by-copying nil
106 "Non-nil means always use copying to create backup files.
107 See documentation of variable `make-backup-files'."
108 :type 'boolean
109 :group 'backup)
111 (defcustom backup-by-copying-when-linked nil
112 "Non-nil means use copying to create backups for files with multiple names.
113 This causes the alternate names to refer to the latest version as edited.
114 This variable is relevant only if `backup-by-copying' is nil."
115 :type 'boolean
116 :group 'backup)
118 (defcustom backup-by-copying-when-mismatch nil
119 "Non-nil means create backups by copying if this preserves owner or group.
120 Renaming may still be used (subject to control of other variables)
121 when it would not result in changing the owner or group of the file;
122 that is, for files which are owned by you and whose group matches
123 the default for a new file created there by you.
124 This variable is relevant only if `backup-by-copying' is nil."
125 :type 'boolean
126 :group 'backup)
128 (defcustom backup-by-copying-when-privileged-mismatch 200
129 "Non-nil means create backups by copying to preserve a privileged owner.
130 Renaming may still be used (subject to control of other variables)
131 when it would not result in changing the owner of the file or if the owner
132 has a user id greater than the value of this variable. This is useful
133 when low-numbered uid's are used for special system users (such as root)
134 that must maintain ownership of certain files.
135 This variable is relevant only if `backup-by-copying' and
136 `backup-by-copying-when-mismatch' are nil."
137 :type '(choice (const nil) integer)
138 :group 'backup)
140 (defvar backup-enable-predicate 'normal-backup-enable-predicate
141 "Predicate that looks at a file name and decides whether to make backups.
142 Called with an absolute file name as argument, it returns t to enable backup.")
144 (defcustom buffer-offer-save nil
145 "Non-nil in a buffer means always offer to save buffer on exit.
146 Do so even if the buffer is not visiting a file.
147 Automatically local in all buffers."
148 :type 'boolean
149 :group 'backup)
150 (make-variable-buffer-local 'buffer-offer-save)
152 (defcustom find-file-existing-other-name t
153 "Non-nil means find a file under alternative names, in existing buffers.
154 This means if any existing buffer is visiting the file you want
155 under another name, you get the existing buffer instead of a new buffer."
156 :type 'boolean
157 :group 'find-file)
159 (defcustom find-file-visit-truename nil
160 "*Non-nil means visit a file under its truename.
161 The truename of a file is found by chasing all links
162 both at the file level and at the levels of the containing directories."
163 :type 'boolean
164 :group 'find-file)
165 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
167 (defcustom revert-without-query nil
168 "Specify which files should be reverted without query.
169 The value is a list of regular expressions.
170 If the file name matches one of these regular expressions,
171 then `revert-buffer' reverts the file without querying
172 if the file has changed on disk and you have not edited the buffer."
173 :type '(repeat regexp)
174 :group 'find-file)
176 (defvar buffer-file-number nil
177 "The device number and file number of the file visited in the current buffer.
178 The value is a list of the form (FILENUM DEVNUM).
179 This pair of numbers uniquely identifies the file.
180 If the buffer is visiting a new file, the value is nil.")
181 (make-variable-buffer-local 'buffer-file-number)
182 (put 'buffer-file-number 'permanent-local t)
184 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
185 "Non-nil means that `buffer-file-number' uniquely identifies files.")
187 (defvar buffer-file-read-only nil
188 "Non-nil if visited file was read-only when visited.")
189 (make-variable-buffer-local 'buffer-file-read-only)
191 (defcustom temporary-file-directory
192 (file-name-as-directory
193 (cond ((memq system-type '(ms-dos windows-nt))
194 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
195 ((memq system-type '(vax-vms axp-vms))
196 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
198 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
199 "The directory for writing temporary files."
200 :group 'files
201 :type 'directory)
203 (defcustom small-temporary-file-directory
204 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
205 "The directory for writing small temporary files.
206 If non-nil, this directory is used instead of `temporary-file-directory'
207 by programs that create small temporary files. This is for systems that
208 have fast storage with limited space, such as a RAM disk."
209 :group 'files
210 :type '(choice (const nil) directory))
212 ;; The system null device. (Should reference NULL_DEVICE from C.)
213 (defvar null-device "/dev/null" "The system null device.")
215 (defvar file-name-invalid-regexp
216 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
217 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
218 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
219 "[\000-\031]\\|" ; control characters
220 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
221 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
222 ((memq system-type '(ms-dos windows-nt cygwin))
223 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
224 "[|<>\"?*\000-\031]")) ; invalid characters
225 (t "[\000]"))
226 "Regexp recognizing file names which aren't allowed by the filesystem.")
228 (defcustom file-precious-flag nil
229 "Non-nil means protect against I/O errors while saving files.
230 Some modes set this non-nil in particular buffers.
232 This feature works by writing the new contents into a temporary file
233 and then renaming the temporary file to replace the original.
234 In this way, any I/O error in writing leaves the original untouched,
235 and there is never any instant where the file is nonexistent.
237 Note that this feature forces backups to be made by copying.
238 Yet, at the same time, saving a precious file
239 breaks any hard links between it and other files."
240 :type 'boolean
241 :group 'backup)
243 (defcustom version-control nil
244 "Control use of version numbers for backup files.
245 When t, make numeric backup versions unconditionally.
246 When nil, make them for files that have some already.
247 The value `never' means do not make them."
248 :type '(choice (const :tag "Never" never)
249 (const :tag "If existing" nil)
250 (other :tag "Always" t))
251 :group 'backup
252 :group 'vc)
253 (put 'version-control 'safe-local-variable
254 '(lambda (x) (or (booleanp x) (equal x 'never))))
256 (defcustom dired-kept-versions 2
257 "When cleaning directory, number of versions to keep."
258 :type 'integer
259 :group 'backup
260 :group 'dired)
262 (defcustom delete-old-versions nil
263 "If t, delete excess backup versions silently.
264 If nil, ask confirmation. Any other value prevents any trimming."
265 :type '(choice (const :tag "Delete" t)
266 (const :tag "Ask" nil)
267 (other :tag "Leave" other))
268 :group 'backup)
270 (defcustom kept-old-versions 2
271 "Number of oldest versions to keep when a new numbered backup is made."
272 :type 'integer
273 :group 'backup)
274 (put 'kept-old-versions 'safe-local-variable 'integerp)
276 (defcustom kept-new-versions 2
277 "Number of newest versions to keep when a new numbered backup is made.
278 Includes the new backup. Must be > 0"
279 :type 'integer
280 :group 'backup)
281 (put 'kept-new-versions 'safe-local-variable 'integerp)
283 (defcustom require-final-newline nil
284 "Whether to add a newline automatically at the end of the file.
286 A value of t means do this only when the file is about to be saved.
287 A value of `visit' means do this right after the file is visited.
288 A value of `visit-save' means do it at both of those times.
289 Any other non-nil value means ask user whether to add a newline, when saving.
290 A value of nil means don't add newlines.
292 Certain major modes set this locally to the value obtained
293 from `mode-require-final-newline'."
294 :type '(choice (const :tag "When visiting" visit)
295 (const :tag "When saving" t)
296 (const :tag "When visiting or saving" visit-save)
297 (const :tag "Don't add newlines" nil)
298 (other :tag "Ask each time" ask))
299 :group 'editing-basics)
301 (defcustom mode-require-final-newline t
302 "Whether to add a newline at end of file, in certain major modes.
303 Those modes set `require-final-newline' to this value when you enable them.
304 They do so because they are often used for files that are supposed
305 to end in newlines, and the question is how to arrange that.
307 A value of t means do this only when the file is about to be saved.
308 A value of `visit' means do this right after the file is visited.
309 A value of `visit-save' means do it at both of those times.
310 Any other non-nil value means ask user whether to add a newline, when saving.
312 A value of nil means do not add newlines. That is a risky choice in this
313 variable since this value is used for modes for files that ought to have
314 final newlines. So if you set this to nil, you must explicitly check and
315 add a final newline, whenever you save a file that really needs one."
316 :type '(choice (const :tag "When visiting" visit)
317 (const :tag "When saving" t)
318 (const :tag "When visiting or saving" visit-save)
319 (const :tag "Don't add newlines" nil)
320 (other :tag "Ask each time" ask))
321 :group 'editing-basics
322 :version "22.1")
324 (defcustom auto-save-default t
325 "Non-nil says by default do auto-saving of every file-visiting buffer."
326 :type 'boolean
327 :group 'auto-save)
329 (defcustom auto-save-visited-file-name nil
330 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
331 Normally auto-save files are written under other names."
332 :type 'boolean
333 :group 'auto-save)
335 (defcustom auto-save-file-name-transforms
336 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
337 ;; Don't put "\\2" inside expand-file-name, since it will be
338 ;; transformed to "/2" on DOS/Windows.
339 ,(concat temporary-file-directory "\\2") t))
340 "Transforms to apply to buffer file name before making auto-save file name.
341 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
342 REGEXP is a regular expression to match against the file name.
343 If it matches, `replace-match' is used to replace the
344 matching part with REPLACEMENT.
345 If the optional element UNIQUIFY is non-nil, the auto-save file name is
346 constructed by taking the directory part of the replaced file-name,
347 concatenated with the buffer file name with all directory separators
348 changed to `!' to prevent clashes. This will not work
349 correctly if your filesystem truncates the resulting name.
351 All the transforms in the list are tried, in the order they are listed.
352 When one transform applies, its result is final;
353 no further transforms are tried.
355 The default value is set up to put the auto-save file into the
356 temporary directory (see the variable `temporary-file-directory') for
357 editing a remote file.
359 On MS-DOS filesystems without long names this variable is always
360 ignored."
361 :group 'auto-save
362 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
363 (boolean :tag "Uniquify")))
364 :version "21.1")
366 (defcustom save-abbrevs t
367 "Non-nil means save word abbrevs too when files are saved.
368 If `silently', don't ask the user before saving."
369 :type '(choice (const t) (const nil) (const silently))
370 :group 'abbrev)
372 (defcustom find-file-run-dired t
373 "Non-nil means allow `find-file' to visit directories.
374 To visit the directory, `find-file' runs `find-directory-functions'."
375 :type 'boolean
376 :group 'find-file)
378 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
379 "List of functions to try in sequence to visit a directory.
380 Each function is called with the directory name as the sole argument
381 and should return either a buffer or nil."
382 :type '(hook :options (cvs-dired-noselect dired-noselect))
383 :group 'find-file)
385 ;;;It is not useful to make this a local variable.
386 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
387 (defvar find-file-not-found-functions nil
388 "List of functions to be called for `find-file' on nonexistent file.
389 These functions are called as soon as the error is detected.
390 Variable `buffer-file-name' is already set up.
391 The functions are called in the order given until one of them returns non-nil.")
392 (define-obsolete-variable-alias 'find-file-not-found-hooks
393 'find-file-not-found-functions "22.1")
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-hooks 'permanent-local t)
397 (defcustom find-file-hook nil
398 "List of functions to be called after a buffer is loaded from a file.
399 The buffer's local variables (if any) will have been processed before the
400 functions are called."
401 :group 'find-file
402 :type 'hook
403 :options '(auto-insert)
404 :version "22.1")
405 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
407 (defvar write-file-functions nil
408 "List of functions to be called before writing out a buffer to a file.
409 If one of them returns non-nil, the file is considered already written
410 and the rest are not called.
411 These hooks are considered to pertain to the visited file.
412 So any buffer-local binding of this variable is discarded if you change
413 the visited file name with \\[set-visited-file-name], but not when you
414 change the major mode.
416 This hook is not run if any of the functions in
417 `write-contents-functions' returns non-nil. Both hooks pertain
418 to how to save a buffer to file, for instance, choosing a suitable
419 coding system and setting mode bits. (See Info
420 node `(elisp)Saving Buffers'.) To perform various checks or
421 updates before the buffer is saved, use `before-save-hook'.")
422 (put 'write-file-functions 'permanent-local t)
423 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
425 (defvar local-write-file-hooks nil)
426 (make-variable-buffer-local 'local-write-file-hooks)
427 (put 'local-write-file-hooks 'permanent-local t)
428 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
430 (defvar write-contents-functions nil
431 "List of functions to be called before writing out a buffer to a file.
432 If one of them returns non-nil, the file is considered already written
433 and the rest are not called and neither are the functions in
434 `write-file-functions'.
436 This variable is meant to be used for hooks that pertain to the
437 buffer's contents, not to the particular visited file; thus,
438 `set-visited-file-name' does not clear this variable; but changing the
439 major mode does clear it.
441 For hooks that _do_ pertain to the particular visited file, use
442 `write-file-functions'. Both this variable and
443 `write-file-functions' relate to how a buffer is saved to file.
444 To perform various checks or updates before the buffer is saved,
445 use `before-save-hook'.")
446 (make-variable-buffer-local 'write-contents-functions)
447 (define-obsolete-variable-alias 'write-contents-hooks
448 'write-contents-functions "22.1")
450 (defcustom enable-local-variables t
451 "Control use of local variables in files you visit.
452 The value can be t, nil, :safe, or something else.
454 A value of t means file local variables specifications are obeyed
455 if all the specified variable values are safe; if any values are
456 not safe, Emacs queries you, once, whether to set them all.
457 \(When you say yes to certain values, they are remembered as safe.)
459 :safe means set the safe variables, and ignore the rest.
460 :all means set all variables, whether safe or not.
461 (Don't set it permanently to :all.)
462 A value of nil means always ignore the file local variables.
464 Any other value means always query you once whether to set them all.
465 \(When you say yes to certain values, they are remembered as safe, but
466 this has no effect when `enable-local-variables' is \"something else\".)
468 This variable also controls use of major modes specified in
469 a -*- line.
471 The command \\[normal-mode], when used interactively,
472 always obeys file local variable specifications and the -*- line,
473 and ignores this variable."
474 :type '(choice (const :tag "Query Unsafe" t)
475 (const :tag "Safe Only" :safe)
476 (const :tag "Do all" :all)
477 (const :tag "Ignore" nil)
478 (other :tag "Query" other))
479 :group 'find-file)
481 (defvar local-enable-local-variables t
482 "Like `enable-local-variables' but meant for buffer-local bindings.
483 The meaningful values are nil and non-nil. The default is non-nil.
484 If a major mode sets this to nil, buffer-locally, then any local
485 variables list in the file will be ignored.
487 This variable does not affect the use of major modes
488 specified in a -*- line.")
490 (defcustom enable-local-eval 'maybe
491 "Control processing of the \"variable\" `eval' in a file's local variables.
492 The value can be t, nil or something else.
493 A value of t means obey `eval' variables;
494 A value of nil means ignore them; anything else means query."
495 :type '(choice (const :tag "Obey" t)
496 (const :tag "Ignore" nil)
497 (other :tag "Query" other))
498 :group 'find-file)
500 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
501 (or (fboundp 'lock-buffer)
502 (defalias 'lock-buffer 'ignore))
503 (or (fboundp 'unlock-buffer)
504 (defalias 'unlock-buffer 'ignore))
505 (or (fboundp 'file-locked-p)
506 (defalias 'file-locked-p 'ignore))
508 (defcustom view-read-only nil
509 "Non-nil means buffers visiting files read-only do so in view mode.
510 In fact, this means that all read-only buffers normally have
511 View mode enabled, including buffers that are read-only because
512 you visit a file you cannot alter, and buffers you make read-only
513 using \\[toggle-read-only]."
514 :type 'boolean
515 :group 'view)
517 (defvar file-name-history nil
518 "History list of file names entered in the minibuffer.")
520 (put 'ange-ftp-completion-hook-function 'safe-magic t)
521 (defun ange-ftp-completion-hook-function (op &rest args)
522 "Provides support for ange-ftp host name completion.
523 Runs the usual ange-ftp hook, but only for completion operations."
524 ;; Having this here avoids the need to load ange-ftp when it's not
525 ;; really in use.
526 (if (memq op '(file-name-completion file-name-all-completions))
527 (apply 'ange-ftp-hook-function op args)
528 (let ((inhibit-file-name-handlers
529 (cons 'ange-ftp-completion-hook-function
530 (and (eq inhibit-file-name-operation op)
531 inhibit-file-name-handlers)))
532 (inhibit-file-name-operation op))
533 (apply op args))))
535 (defun convert-standard-filename (filename)
536 "Convert a standard file's name to something suitable for the OS.
537 This means to guarantee valid names and perhaps to canonicalize
538 certain patterns.
540 FILENAME should be an absolute file name since the conversion rules
541 sometimes vary depending on the position in the file name. E.g. c:/foo
542 is a valid DOS file name, but c:/bar/c:/foo is not.
544 This function's standard definition is trivial; it just returns
545 the argument. However, on Windows and DOS, replace invalid
546 characters. On DOS, make sure to obey the 8.3 limitations.
547 In the native Windows build, turn Cygwin names into native names,
548 and also turn slashes into backslashes if the shell requires it (see
549 `w32-shell-dos-semantics').
551 See Info node `(elisp)Standard File Names' for more details."
552 (if (eq system-type 'cygwin)
553 (let ((name (copy-sequence filename))
554 (start 0))
555 ;; Replace invalid filename characters with !
556 (while (string-match "[?*:<>|\"\000-\037]" name start)
557 (aset name (match-beginning 0) ?!)
558 (setq start (match-end 0)))
559 name)
560 filename))
562 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
563 "Read directory name, prompting with PROMPT and completing in directory DIR.
564 Value is not expanded---you must call `expand-file-name' yourself.
565 Default name to DEFAULT-DIRNAME if user exits with the same
566 non-empty string that was inserted by this function.
567 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
568 or just DIR if INITIAL is nil.)
569 If the user exits with an empty minibuffer, this function returns
570 an empty string. (This can only happen if the user erased the
571 pre-inserted contents or if `insert-default-directory' is nil.)
572 Fourth arg MUSTMATCH non-nil means require existing directory's name.
573 Non-nil and non-t means also require confirmation after completion.
574 Fifth arg INITIAL specifies text to start with.
575 DIR should be an absolute directory name. It defaults to
576 the value of `default-directory'."
577 (unless dir
578 (setq dir default-directory))
579 (read-file-name prompt dir (or default-dirname
580 (if initial (expand-file-name initial dir)
581 dir))
582 mustmatch initial
583 'file-directory-p))
586 (defun pwd ()
587 "Show the current default directory."
588 (interactive nil)
589 (message "Directory %s" default-directory))
591 (defvar cd-path nil
592 "Value of the CDPATH environment variable, as a list.
593 Not actually set up until the first time you use it.")
595 (defun parse-colon-path (cd-path)
596 "Explode a search path into a list of directory names.
597 Directories are separated by occurrences of `path-separator'
598 \(which is colon in GNU and GNU-like systems)."
599 ;; We could use split-string here.
600 (and cd-path
601 (let (cd-list (cd-start 0) cd-colon)
602 (setq cd-path (concat cd-path path-separator))
603 (while (setq cd-colon (string-match path-separator cd-path cd-start))
604 (setq cd-list
605 (nconc cd-list
606 (list (if (= cd-start cd-colon)
608 (substitute-in-file-name
609 (file-name-as-directory
610 (substring cd-path cd-start cd-colon)))))))
611 (setq cd-start (+ cd-colon 1)))
612 cd-list)))
614 (defun cd-absolute (dir)
615 "Change current directory to given absolute file name DIR."
616 ;; Put the name into directory syntax now,
617 ;; because otherwise expand-file-name may give some bad results.
618 (if (not (eq system-type 'vax-vms))
619 (setq dir (file-name-as-directory dir)))
620 (setq dir (abbreviate-file-name (expand-file-name dir)))
621 (if (not (file-directory-p dir))
622 (if (file-exists-p dir)
623 (error "%s is not a directory" dir)
624 (error "%s: no such directory" dir))
625 (if (file-executable-p dir)
626 (setq default-directory dir)
627 (error "Cannot cd to %s: Permission denied" dir))))
629 (defun cd (dir)
630 "Make DIR become the current buffer's default directory.
631 If your environment includes a `CDPATH' variable, try each one of
632 that list of directories (separated by occurrences of
633 `path-separator') when resolving a relative directory name.
634 The path separator is colon in GNU and GNU-like systems."
635 (interactive
636 (list (read-directory-name "Change default directory: "
637 default-directory default-directory
638 (and (member cd-path '(nil ("./")))
639 (null (getenv "CDPATH"))))))
640 (if (file-name-absolute-p dir)
641 (cd-absolute (expand-file-name dir))
642 (if (null cd-path)
643 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
644 (setq cd-path (or trypath (list "./")))))
645 (if (not (catch 'found
646 (mapc
647 (function (lambda (x)
648 (let ((f (expand-file-name (concat x dir))))
649 (if (file-directory-p f)
650 (progn
651 (cd-absolute f)
652 (throw 'found t))))))
653 cd-path)
654 nil))
655 (error "No such directory found via CDPATH environment variable"))))
657 (defun load-file (file)
658 "Load the Lisp file named FILE."
659 ;; This is a case where .elc makes a lot of sense.
660 (interactive (list (let ((completion-ignored-extensions
661 (remove ".elc" completion-ignored-extensions)))
662 (read-file-name "Load file: "))))
663 (load (expand-file-name file) nil nil t))
665 (defun locate-file (filename path &optional suffixes predicate)
666 "Search for FILENAME through PATH.
667 If found, return the absolute file name of FILENAME, with its suffixes;
668 otherwise return nil.
669 PATH should be a list of directories to look in, like the lists in
670 `exec-path' or `load-path'.
671 If SUFFIXES is non-nil, it should be a list of suffixes to append to
672 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
673 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
674 If non-nil, PREDICATE is used instead of `file-readable-p'.
675 PREDICATE can also be an integer to pass to the `access' system call,
676 in which case file-name handlers are ignored. This usage is deprecated.
678 For compatibility, PREDICATE can also be one of the symbols
679 `executable', `readable', `writable', or `exists', or a list of
680 one or more of those symbols."
681 (if (and predicate (symbolp predicate) (not (functionp predicate)))
682 (setq predicate (list predicate)))
683 (when (and (consp predicate) (not (functionp predicate)))
684 (setq predicate
685 (logior (if (memq 'executable predicate) 1 0)
686 (if (memq 'writable predicate) 2 0)
687 (if (memq 'readable predicate) 4 0))))
688 (locate-file-internal filename path suffixes predicate))
690 (defun locate-file-completion (string path-and-suffixes action)
691 "Do completion for file names passed to `locate-file'.
692 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
693 (if (file-name-absolute-p string)
694 (read-file-name-internal string nil action)
695 (let ((names nil)
696 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
697 (string-dir (file-name-directory string)))
698 (dolist (dir (car path-and-suffixes))
699 (unless dir
700 (setq dir default-directory))
701 (if string-dir (setq dir (expand-file-name string-dir dir)))
702 (when (file-directory-p dir)
703 (dolist (file (file-name-all-completions
704 (file-name-nondirectory string) dir))
705 (add-to-list 'names (if string-dir (concat string-dir file) file))
706 (when (string-match suffix file)
707 (setq file (substring file 0 (match-beginning 0)))
708 (push (if string-dir (concat string-dir file) file) names)))))
709 (cond
710 ((eq action t) (all-completions string names))
711 ((null action) (try-completion string names))
712 (t (test-completion string names))))))
714 (defun locate-dominating-file (file regexp)
715 "Look up the directory hierarchy from FILE for a file matching REGEXP."
716 (while (and file (not (file-directory-p file)))
717 (setq file (file-name-directory (directory-file-name file))))
718 (catch 'found
719 (let ((user (nth 2 (file-attributes file)))
720 ;; Abbreviate, so as to stop when we cross ~/.
721 (dir (abbreviate-file-name (file-name-as-directory file)))
722 files)
723 ;; As a heuristic, we stop looking up the hierarchy of directories as
724 ;; soon as we find a directory belonging to another user. This should
725 ;; save us from looking in things like /net and /afs. This assumes
726 ;; that all the files inside a project belong to the same user.
727 (while (and dir (equal user (nth 2 (file-attributes dir))))
728 (if (setq files (directory-files dir 'full regexp))
729 (throw 'found (car files))
730 (if (equal dir
731 (setq dir (file-name-directory
732 (directory-file-name dir))))
733 (setq dir nil))))
734 nil)))
736 (defun executable-find (command)
737 "Search for COMMAND in `exec-path' and return the absolute file name.
738 Return nil if COMMAND is not found anywhere in `exec-path'."
739 ;; Use 1 rather than file-executable-p to better match the behavior of
740 ;; call-process.
741 (locate-file command exec-path exec-suffixes 1))
743 (defun load-library (library)
744 "Load the library named LIBRARY.
745 This is an interface to the function `load'."
746 (interactive
747 (list (completing-read "Load library: "
748 'locate-file-completion
749 (cons load-path (get-load-suffixes)))))
750 (load library))
752 (defun file-remote-p (file &optional identification connected)
753 "Test whether FILE specifies a location on a remote system.
754 Return an identification of the system if the location is indeed
755 remote. The identification of the system may comprise a method
756 to access the system and its hostname, amongst other things.
758 For example, the filename \"/user@host:/foo\" specifies a location
759 on the system \"/user@host:\".
761 IDENTIFICATION specifies which part of the identification shall
762 be returned as string. IDENTIFICATION can be the symbol
763 `method', `user' or `host'; any other value is handled like nil
764 and means to return the complete identification string.
766 If CONNECTED is non-nil, the function returns an identification only
767 if FILE is located on a remote system, and a connection is established
768 to that remote system.
770 `file-remote-p' will never open a connection on its own."
771 (let ((handler (find-file-name-handler file 'file-remote-p)))
772 (if handler
773 (funcall handler 'file-remote-p file identification connected)
774 nil)))
776 (defun file-local-copy (file)
777 "Copy the file FILE into a temporary file on this machine.
778 Returns the name of the local copy, or nil, if FILE is directly
779 accessible."
780 ;; This formerly had an optional BUFFER argument that wasn't used by
781 ;; anything.
782 (let ((handler (find-file-name-handler file 'file-local-copy)))
783 (if handler
784 (funcall handler 'file-local-copy file)
785 nil)))
787 (defun file-truename (filename &optional counter prev-dirs)
788 "Return the truename of FILENAME, which should be absolute.
789 The truename of a file name is found by chasing symbolic links
790 both at the level of the file and at the level of the directories
791 containing it, until no links are left at any level.
793 \(fn FILENAME)" ;; Don't document the optional arguments.
794 ;; COUNTER and PREV-DIRS are only used in recursive calls.
795 ;; COUNTER can be a cons cell whose car is the count of how many
796 ;; more links to chase before getting an error.
797 ;; PREV-DIRS can be a cons cell whose car is an alist
798 ;; of truenames we've just recently computed.
799 (cond ((or (string= filename "") (string= filename "~"))
800 (setq filename (expand-file-name filename))
801 (if (string= filename "")
802 (setq filename "/")))
803 ((and (string= (substring filename 0 1) "~")
804 (string-match "~[^/]*/?" filename))
805 (let ((first-part
806 (substring filename 0 (match-end 0)))
807 (rest (substring filename (match-end 0))))
808 (setq filename (concat (expand-file-name first-part) rest)))))
810 (or counter (setq counter (list 100)))
811 (let (done
812 ;; For speed, remove the ange-ftp completion handler from the list.
813 ;; We know it's not needed here.
814 ;; For even more speed, do this only on the outermost call.
815 (file-name-handler-alist
816 (if prev-dirs file-name-handler-alist
817 (let ((tem (copy-sequence file-name-handler-alist)))
818 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
819 (or prev-dirs (setq prev-dirs (list nil)))
821 ;; andrewi@harlequin.co.uk - none of the following code (except for
822 ;; invoking the file-name handler) currently applies on Windows
823 ;; (ie. there are no native symlinks), but there is an issue with
824 ;; case differences being ignored by the OS, and short "8.3 DOS"
825 ;; name aliases existing for all files. (The short names are not
826 ;; reported by directory-files, but can be used to refer to files.)
827 ;; It seems appropriate for file-truename to resolve these issues in
828 ;; the most natural way, which on Windows is to call the function
829 ;; `w32-long-file-name' - this returns the exact name of a file as
830 ;; it is stored on disk (expanding short name aliases with the full
831 ;; name in the process).
832 (if (eq system-type 'windows-nt)
833 (let ((handler (find-file-name-handler filename 'file-truename)))
834 ;; For file name that has a special handler, call handler.
835 ;; This is so that ange-ftp can save time by doing a no-op.
836 (if handler
837 (setq filename (funcall handler 'file-truename filename))
838 ;; If filename contains a wildcard, newname will be the old name.
839 (unless (string-match "[[*?]" filename)
840 ;; If filename exists, use the long name
841 (setq filename (or (w32-long-file-name filename) filename))))
842 (setq done t)))
844 ;; If this file directly leads to a link, process that iteratively
845 ;; so that we don't use lots of stack.
846 (while (not done)
847 (setcar counter (1- (car counter)))
848 (if (< (car counter) 0)
849 (error "Apparent cycle of symbolic links for %s" filename))
850 (let ((handler (find-file-name-handler filename 'file-truename)))
851 ;; For file name that has a special handler, call handler.
852 ;; This is so that ange-ftp can save time by doing a no-op.
853 (if handler
854 (setq filename (funcall handler 'file-truename filename)
855 done t)
856 (let ((dir (or (file-name-directory filename) default-directory))
857 target dirfile)
858 ;; Get the truename of the directory.
859 (setq dirfile (directory-file-name dir))
860 ;; If these are equal, we have the (or a) root directory.
861 (or (string= dir dirfile)
862 ;; If this is the same dir we last got the truename for,
863 ;; save time--don't recalculate.
864 (if (assoc dir (car prev-dirs))
865 (setq dir (cdr (assoc dir (car prev-dirs))))
866 (let ((old dir)
867 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
868 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
869 (setq dir new))))
870 (if (equal ".." (file-name-nondirectory filename))
871 (setq filename
872 (directory-file-name (file-name-directory (directory-file-name dir)))
873 done t)
874 (if (equal "." (file-name-nondirectory filename))
875 (setq filename (directory-file-name dir)
876 done t)
877 ;; Put it back on the file name.
878 (setq filename (concat dir (file-name-nondirectory filename)))
879 ;; Is the file name the name of a link?
880 (setq target (file-symlink-p filename))
881 (if target
882 ;; Yes => chase that link, then start all over
883 ;; since the link may point to a directory name that uses links.
884 ;; We can't safely use expand-file-name here
885 ;; since target might look like foo/../bar where foo
886 ;; is itself a link. Instead, we handle . and .. above.
887 (setq filename
888 (if (file-name-absolute-p target)
889 target
890 (concat dir target))
891 done nil)
892 ;; No, we are done!
893 (setq done t))))))))
894 filename))
896 (defun file-chase-links (filename &optional limit)
897 "Chase links in FILENAME until a name that is not a link.
898 Unlike `file-truename', this does not check whether a parent
899 directory name is a symbolic link.
900 If the optional argument LIMIT is a number,
901 it means chase no more than that many links and then stop."
902 (let (tem (newname filename)
903 (count 0))
904 (while (and (or (null limit) (< count limit))
905 (setq tem (file-symlink-p newname)))
906 (save-match-data
907 (if (and (null limit) (= count 100))
908 (error "Apparent cycle of symbolic links for %s" filename))
909 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
910 (while (string-match "//+" tem)
911 (setq tem (replace-match "/" nil nil tem)))
912 ;; Handle `..' by hand, since it needs to work in the
913 ;; target of any directory symlink.
914 ;; This code is not quite complete; it does not handle
915 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
916 (while (string-match "\\`\\.\\./" tem)
917 (setq tem (substring tem 3))
918 (setq newname (expand-file-name newname))
919 ;; Chase links in the default dir of the symlink.
920 (setq newname
921 (file-chase-links
922 (directory-file-name (file-name-directory newname))))
923 ;; Now find the parent of that dir.
924 (setq newname (file-name-directory newname)))
925 (setq newname (expand-file-name tem (file-name-directory newname)))
926 (setq count (1+ count))))
927 newname))
929 (defun make-temp-file (prefix &optional dir-flag suffix)
930 "Create a temporary file.
931 The returned file name (created by appending some random characters at the end
932 of PREFIX, and expanding against `temporary-file-directory' if necessary),
933 is guaranteed to point to a newly created empty file.
934 You can then use `write-region' to write new data into the file.
936 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
938 If SUFFIX is non-nil, add that at the end of the file name."
939 (let ((umask (default-file-modes))
940 file)
941 (unwind-protect
942 (progn
943 ;; Create temp files with strict access rights. It's easy to
944 ;; loosen them later, whereas it's impossible to close the
945 ;; time-window of loose permissions otherwise.
946 (set-default-file-modes ?\700)
947 (while (condition-case ()
948 (progn
949 (setq file
950 (make-temp-name
951 (expand-file-name prefix temporary-file-directory)))
952 (if suffix
953 (setq file (concat file suffix)))
954 (if dir-flag
955 (make-directory file)
956 (write-region "" nil file nil 'silent nil 'excl))
957 nil)
958 (file-already-exists t))
959 ;; the file was somehow created by someone else between
960 ;; `make-temp-name' and `write-region', let's try again.
961 nil)
962 file)
963 ;; Reset the umask.
964 (set-default-file-modes umask))))
966 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
967 "Change the encoding of FILE's name from CODING to NEW-CODING.
968 The value is a new name of FILE.
969 Signals a `file-already-exists' error if a file of the new name
970 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
971 is non-nil. A number as fourth arg means request confirmation if
972 the new name already exists. This is what happens in interactive
973 use with M-x."
974 (interactive
975 (let ((default-coding (or file-name-coding-system
976 default-file-name-coding-system))
977 (filename (read-file-name "Recode filename: " nil nil t))
978 from-coding to-coding)
979 (if (and default-coding
980 ;; We provide the default coding only when it seems that
981 ;; the filename is correctly decoded by the default
982 ;; coding.
983 (let ((charsets (find-charset-string filename)))
984 (and (not (memq 'eight-bit-control charsets))
985 (not (memq 'eight-bit-graphic charsets)))))
986 (setq from-coding (read-coding-system
987 (format "Recode filename %s from (default %s): "
988 filename default-coding)
989 default-coding))
990 (setq from-coding (read-coding-system
991 (format "Recode filename %s from: " filename))))
993 ;; We provide the default coding only when a user is going to
994 ;; change the encoding not from the default coding.
995 (if (eq from-coding default-coding)
996 (setq to-coding (read-coding-system
997 (format "Recode filename %s from %s to: "
998 filename from-coding)))
999 (setq to-coding (read-coding-system
1000 (format "Recode filename %s from %s to (default %s): "
1001 filename from-coding default-coding)
1002 default-coding)))
1003 (list filename from-coding to-coding)))
1005 (let* ((default-coding (or file-name-coding-system
1006 default-file-name-coding-system))
1007 ;; FILE should have been decoded by DEFAULT-CODING.
1008 (encoded (encode-coding-string file default-coding))
1009 (newname (decode-coding-string encoded coding))
1010 (new-encoded (encode-coding-string newname new-coding))
1011 ;; Suppress further encoding.
1012 (file-name-coding-system nil)
1013 (default-file-name-coding-system nil)
1014 (locale-coding-system nil))
1015 (rename-file encoded new-encoded ok-if-already-exists)
1016 newname))
1018 (defun switch-to-buffer-other-window (buffer &optional norecord)
1019 "Select buffer BUFFER in another window.
1020 If BUFFER does not identify an existing buffer, then this function
1021 creates a buffer with that name.
1023 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1024 or nil. If BUFFER is nil, then this function chooses a buffer
1025 using `other-buffer'.
1026 Optional second arg NORECORD non-nil means
1027 do not put this buffer at the front of the list of recently selected ones.
1028 This function returns the buffer it switched to.
1030 This uses the function `display-buffer' as a subroutine; see its
1031 documentation for additional customization information."
1032 (interactive "BSwitch to buffer in other window: ")
1033 (let ((pop-up-windows t)
1034 ;; Don't let these interfere.
1035 same-window-buffer-names same-window-regexps)
1036 (pop-to-buffer buffer t norecord)))
1038 (defun switch-to-buffer-other-frame (buffer &optional norecord)
1039 "Switch to buffer BUFFER in another frame.
1040 Optional second arg NORECORD non-nil means
1041 do not put this buffer at the front of the list of recently selected ones.
1043 This uses the function `display-buffer' as a subroutine; see its
1044 documentation for additional customization information."
1045 (interactive "BSwitch to buffer in other frame: ")
1046 (let ((pop-up-frames t)
1047 same-window-buffer-names same-window-regexps)
1048 (pop-to-buffer buffer t norecord)
1049 (raise-frame (window-frame (selected-window)))))
1051 (defun display-buffer-other-frame (buffer)
1052 "Switch to buffer BUFFER in another frame.
1053 This uses the function `display-buffer' as a subroutine; see its
1054 documentation for additional customization information."
1055 (interactive "BDisplay buffer in other frame: ")
1056 (let ((pop-up-frames t)
1057 same-window-buffer-names same-window-regexps
1058 (old-window (selected-window))
1059 new-window)
1060 (setq new-window (display-buffer buffer t))
1061 (lower-frame (window-frame new-window))
1062 (make-frame-invisible (window-frame old-window))
1063 (make-frame-visible (window-frame old-window))))
1065 (defvar find-file-default nil
1066 "Used within `find-file-read-args'.")
1068 (defmacro minibuffer-with-setup-hook (fun &rest body)
1069 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1070 BODY should use the minibuffer at most once.
1071 Recursive uses of the minibuffer will not be affected."
1072 (declare (indent 1) (debug t))
1073 (let ((hook (make-symbol "setup-hook")))
1074 `(let (,hook)
1075 (setq ,hook
1076 (lambda ()
1077 ;; Clear out this hook so it does not interfere
1078 ;; with any recursive minibuffer usage.
1079 (remove-hook 'minibuffer-setup-hook ,hook)
1080 (,fun)))
1081 (unwind-protect
1082 (progn
1083 (add-hook 'minibuffer-setup-hook ,hook)
1084 ,@body)
1085 (remove-hook 'minibuffer-setup-hook ,hook)))))
1087 (defcustom find-file-confirm-nonexistent-file nil
1088 "If non-nil, `find-file' requires confirmation before visiting a new file."
1089 :group 'find-file
1090 :version "23.1"
1091 :type 'boolean)
1093 (defun find-file-read-args (prompt mustmatch)
1094 (list (let ((find-file-default
1095 (and buffer-file-name
1096 (abbreviate-file-name buffer-file-name))))
1097 (minibuffer-with-setup-hook
1098 (lambda () (setq minibuffer-default find-file-default))
1099 (read-file-name prompt nil default-directory mustmatch)))
1102 (defun find-file (filename &optional wildcards)
1103 "Edit file FILENAME.
1104 Switch to a buffer visiting file FILENAME,
1105 creating one if none already exists.
1106 Interactively, the default if you just type RET is the current directory,
1107 but the visited file name is available through the minibuffer history:
1108 type M-n to pull it into the minibuffer.
1110 You can visit files on remote machines by specifying something
1111 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1112 also visit local files as a different user by specifying
1113 /sudo::FILE for the file name.
1114 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1115 manual, for more about this.
1117 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1118 expand wildcards (if any) and visit multiple files. You can
1119 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1121 To visit a file without any kind of conversion and without
1122 automatically choosing a major mode, use \\[find-file-literally]."
1123 (interactive
1124 (find-file-read-args "Find file: "
1125 (if find-file-confirm-nonexistent-file 'confirm-only)))
1126 (let ((value (find-file-noselect filename nil nil wildcards)))
1127 (if (listp value)
1128 (mapcar 'switch-to-buffer (nreverse value))
1129 (switch-to-buffer value))))
1131 (defun find-file-other-window (filename &optional wildcards)
1132 "Edit file FILENAME, in another window.
1134 Like \\[find-file] (which see), but creates a new window or reuses
1135 an existing one. See the function `display-buffer'.
1137 Interactively, the default if you just type RET is the current directory,
1138 but the visited file name is available through the minibuffer history:
1139 type M-n to pull it into the minibuffer.
1141 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1142 expand wildcards (if any) and visit multiple files."
1143 (interactive
1144 (find-file-read-args "Find file in other window: "
1145 (if find-file-confirm-nonexistent-file 'confirm-only)))
1146 (let ((value (find-file-noselect filename nil nil wildcards)))
1147 (if (listp value)
1148 (progn
1149 (setq value (nreverse value))
1150 (cons (switch-to-buffer-other-window (car value))
1151 (mapcar 'switch-to-buffer (cdr value))))
1152 (switch-to-buffer-other-window value))))
1154 (defun find-file-other-frame (filename &optional wildcards)
1155 "Edit file FILENAME, in another frame.
1157 Like \\[find-file] (which see), but creates a new frame or reuses
1158 an existing one. See the function `display-buffer'.
1160 Interactively, the default if you just type RET is the current directory,
1161 but the visited file name is available through the minibuffer history:
1162 type M-n to pull it into the minibuffer.
1164 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1165 expand wildcards (if any) and visit multiple files."
1166 (interactive
1167 (find-file-read-args "Find file in other frame: "
1168 (if find-file-confirm-nonexistent-file 'confirm-only)))
1169 (let ((value (find-file-noselect filename nil nil wildcards)))
1170 (if (listp value)
1171 (progn
1172 (setq value (nreverse value))
1173 (cons (switch-to-buffer-other-frame (car value))
1174 (mapcar 'switch-to-buffer (cdr value))))
1175 (switch-to-buffer-other-frame value))))
1177 (defun find-file-existing (filename)
1178 "Edit the existing file FILENAME.
1179 Like \\[find-file], but only allow a file that exists, and do not allow
1180 file names with wildcards."
1181 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1182 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1183 (error "%s does not exist" filename)
1184 (find-file filename)
1185 (current-buffer)))
1187 (defun find-file-read-only (filename &optional wildcards)
1188 "Edit file FILENAME but don't allow changes.
1189 Like \\[find-file], but marks buffer as read-only.
1190 Use \\[toggle-read-only] to permit editing."
1191 (interactive
1192 (find-file-read-args "Find file read-only: "
1193 (if find-file-confirm-nonexistent-file 'confirm-only)))
1194 (unless (or (and wildcards find-file-wildcards
1195 (not (string-match "\\`/:" filename))
1196 (string-match "[[*?]" filename))
1197 (file-exists-p filename))
1198 (error "%s does not exist" filename))
1199 (let ((value (find-file filename wildcards)))
1200 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1201 (if (listp value) value (list value)))
1202 value))
1204 (defun find-file-read-only-other-window (filename &optional wildcards)
1205 "Edit file FILENAME in another window but don't allow changes.
1206 Like \\[find-file-other-window], but marks buffer as read-only.
1207 Use \\[toggle-read-only] to permit editing."
1208 (interactive
1209 (find-file-read-args "Find file read-only other window: "
1210 (if find-file-confirm-nonexistent-file 'confirm-only)))
1211 (unless (or (and wildcards find-file-wildcards
1212 (not (string-match "\\`/:" filename))
1213 (string-match "[[*?]" filename))
1214 (file-exists-p filename))
1215 (error "%s does not exist" filename))
1216 (let ((value (find-file-other-window filename wildcards)))
1217 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1218 (if (listp value) value (list value)))
1219 value))
1221 (defun find-file-read-only-other-frame (filename &optional wildcards)
1222 "Edit file FILENAME in another frame but don't allow changes.
1223 Like \\[find-file-other-frame], but marks buffer as read-only.
1224 Use \\[toggle-read-only] to permit editing."
1225 (interactive
1226 (find-file-read-args "Find file read-only other frame: "
1227 (if find-file-confirm-nonexistent-file 'confirm-only)))
1228 (unless (or (and wildcards find-file-wildcards
1229 (not (string-match "\\`/:" filename))
1230 (string-match "[[*?]" filename))
1231 (file-exists-p filename))
1232 (error "%s does not exist" filename))
1233 (let ((value (find-file-other-frame filename wildcards)))
1234 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1235 (if (listp value) value (list value)))
1236 value))
1238 (defun find-alternate-file-other-window (filename &optional wildcards)
1239 "Find file FILENAME as a replacement for the file in the next window.
1240 This command does not select that window.
1242 See \\[find-file] for the possible forms of the FILENAME argument.
1244 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1245 expand wildcards (if any) and replace the file with multiple files."
1246 (interactive
1247 (save-selected-window
1248 (other-window 1)
1249 (let ((file buffer-file-name)
1250 (file-name nil)
1251 (file-dir nil))
1252 (and file
1253 (setq file-name (file-name-nondirectory file)
1254 file-dir (file-name-directory file)))
1255 (list (read-file-name
1256 "Find alternate file: " file-dir nil nil file-name)
1257 t))))
1258 (if (one-window-p)
1259 (find-file-other-window filename wildcards)
1260 (save-selected-window
1261 (other-window 1)
1262 (find-alternate-file filename wildcards))))
1264 (defun find-alternate-file (filename &optional wildcards)
1265 "Find file FILENAME, select its buffer, kill previous buffer.
1266 If the current buffer now contains an empty file that you just visited
1267 \(presumably by mistake), use this command to visit the file you really want.
1269 See \\[find-file] for the possible forms of the FILENAME argument.
1271 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1272 expand wildcards (if any) and replace the file with multiple files.
1274 If the current buffer is an indirect buffer, or the base buffer
1275 for one or more indirect buffers, the other buffer(s) are not
1276 killed."
1277 (interactive
1278 (let ((file buffer-file-name)
1279 (file-name nil)
1280 (file-dir nil))
1281 (and file
1282 (setq file-name (file-name-nondirectory file)
1283 file-dir (file-name-directory file)))
1284 (list (read-file-name
1285 "Find alternate file: " file-dir nil nil file-name)
1286 t)))
1287 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1288 (error "Aborted"))
1289 (when (and (buffer-modified-p) (buffer-file-name))
1290 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1291 (buffer-name)))
1292 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1293 (error "Aborted"))
1294 (save-buffer)))
1295 (let ((obuf (current-buffer))
1296 (ofile buffer-file-name)
1297 (onum buffer-file-number)
1298 (odir dired-directory)
1299 (otrue buffer-file-truename)
1300 (oname (buffer-name)))
1301 (if (get-buffer " **lose**")
1302 (kill-buffer " **lose**"))
1303 (rename-buffer " **lose**")
1304 (unwind-protect
1305 (progn
1306 (unlock-buffer)
1307 ;; This prevents us from finding the same buffer
1308 ;; if we specified the same file again.
1309 (setq buffer-file-name nil)
1310 (setq buffer-file-number nil)
1311 (setq buffer-file-truename nil)
1312 ;; Likewise for dired buffers.
1313 (setq dired-directory nil)
1314 (find-file filename wildcards))
1315 (when (eq obuf (current-buffer))
1316 ;; This executes if find-file gets an error
1317 ;; and does not really find anything.
1318 ;; We put things back as they were.
1319 ;; If find-file actually finds something, we kill obuf below.
1320 (setq buffer-file-name ofile)
1321 (setq buffer-file-number onum)
1322 (setq buffer-file-truename otrue)
1323 (setq dired-directory odir)
1324 (lock-buffer)
1325 (rename-buffer oname)))
1326 (unless (eq (current-buffer) obuf)
1327 (with-current-buffer obuf
1328 ;; We already asked; don't ask again.
1329 (let ((kill-buffer-query-functions))
1330 (kill-buffer obuf))))))
1332 (defun create-file-buffer (filename)
1333 "Create a suitably named buffer for visiting FILENAME, and return it.
1334 FILENAME (sans directory) is used unchanged if that name is free;
1335 otherwise a string <2> or <3> or ... is appended to get an unused name.
1336 Spaces at the start of FILENAME (sans directory) are removed."
1337 (let ((lastname (file-name-nondirectory filename)))
1338 (if (string= lastname "")
1339 (setq lastname filename))
1340 (save-match-data
1341 (string-match "^ *\\(.*\\)" lastname)
1342 (generate-new-buffer (match-string 1 lastname)))))
1344 (defun generate-new-buffer (name)
1345 "Create and return a buffer with a name based on NAME.
1346 Choose the buffer's name using `generate-new-buffer-name'."
1347 (get-buffer-create (generate-new-buffer-name name)))
1349 (defcustom automount-dir-prefix "^/tmp_mnt/"
1350 "Regexp to match the automounter prefix in a directory name."
1351 :group 'files
1352 :type 'regexp)
1354 (defvar abbreviated-home-dir nil
1355 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1357 (defun abbreviate-file-name (filename)
1358 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1359 This also substitutes \"~\" for the user's home directory (unless the
1360 home directory is a root directory) and removes automounter prefixes
1361 \(see the variable `automount-dir-prefix')."
1362 ;; Get rid of the prefixes added by the automounter.
1363 (save-match-data
1364 (if (and automount-dir-prefix
1365 (string-match automount-dir-prefix filename)
1366 (file-exists-p (file-name-directory
1367 (substring filename (1- (match-end 0))))))
1368 (setq filename (substring filename (1- (match-end 0)))))
1369 (let ((tail directory-abbrev-alist))
1370 ;; If any elt of directory-abbrev-alist matches this name,
1371 ;; abbreviate accordingly.
1372 (while tail
1373 (if (string-match (car (car tail)) filename)
1374 (setq filename
1375 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1376 (setq tail (cdr tail)))
1377 ;; Compute and save the abbreviated homedir name.
1378 ;; We defer computing this until the first time it's needed, to
1379 ;; give time for directory-abbrev-alist to be set properly.
1380 ;; We include a slash at the end, to avoid spurious matches
1381 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1382 (or abbreviated-home-dir
1383 (setq abbreviated-home-dir
1384 (let ((abbreviated-home-dir "$foo"))
1385 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1386 "\\(/\\|\\'\\)"))))
1388 ;; If FILENAME starts with the abbreviated homedir,
1389 ;; make it start with `~' instead.
1390 (if (and (string-match abbreviated-home-dir filename)
1391 ;; If the home dir is just /, don't change it.
1392 (not (and (= (match-end 0) 1)
1393 (= (aref filename 0) ?/)))
1394 ;; MS-DOS root directories can come with a drive letter;
1395 ;; Novell Netware allows drive letters beyond `Z:'.
1396 (not (and (or (eq system-type 'ms-dos)
1397 (eq system-type 'cygwin)
1398 (eq system-type 'windows-nt))
1399 (save-match-data
1400 (string-match "^[a-zA-`]:/$" filename)))))
1401 (setq filename
1402 (concat "~"
1403 (match-string 1 filename)
1404 (substring filename (match-end 0)))))
1405 filename)))
1407 (defcustom find-file-not-true-dirname-list nil
1408 "List of logical names for which visiting shouldn't save the true dirname.
1409 On VMS, when you visit a file using a logical name that searches a path,
1410 you may or may not want the visited file name to record the specific
1411 directory where the file was found. If you *do not* want that, add the logical
1412 name to this list as a string."
1413 :type '(repeat (string :tag "Name"))
1414 :group 'find-file)
1416 (defun find-buffer-visiting (filename &optional predicate)
1417 "Return the buffer visiting file FILENAME (a string).
1418 This is like `get-file-buffer', except that it checks for any buffer
1419 visiting the same file, possibly under a different name.
1420 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1421 and others are ignored.
1422 If there is no such live buffer, return nil."
1423 (let ((predicate (or predicate #'identity))
1424 (truename (abbreviate-file-name (file-truename filename))))
1425 (or (let ((buf (get-file-buffer filename)))
1426 (when (and buf (funcall predicate buf)) buf))
1427 (let ((list (buffer-list)) found)
1428 (while (and (not found) list)
1429 (save-excursion
1430 (set-buffer (car list))
1431 (if (and buffer-file-name
1432 (string= buffer-file-truename truename)
1433 (funcall predicate (current-buffer)))
1434 (setq found (car list))))
1435 (setq list (cdr list)))
1436 found)
1437 (let* ((attributes (file-attributes truename))
1438 (number (nthcdr 10 attributes))
1439 (list (buffer-list)) found)
1440 (and buffer-file-numbers-unique
1441 (car-safe number) ;Make sure the inode is not just nil.
1442 (while (and (not found) list)
1443 (with-current-buffer (car list)
1444 (if (and buffer-file-name
1445 (equal buffer-file-number number)
1446 ;; Verify this buffer's file number
1447 ;; still belongs to its file.
1448 (file-exists-p buffer-file-name)
1449 (equal (file-attributes buffer-file-truename)
1450 attributes)
1451 (funcall predicate (current-buffer)))
1452 (setq found (car list))))
1453 (setq list (cdr list))))
1454 found))))
1456 (defcustom find-file-wildcards t
1457 "Non-nil means file-visiting commands should handle wildcards.
1458 For example, if you specify `*.c', that would visit all the files
1459 whose names match the pattern."
1460 :group 'files
1461 :version "20.4"
1462 :type 'boolean)
1464 (defcustom find-file-suppress-same-file-warnings nil
1465 "Non-nil means suppress warning messages for symlinked files.
1466 When nil, Emacs prints a warning when visiting a file that is already
1467 visited, but with a different name. Setting this option to t
1468 suppresses this warning."
1469 :group 'files
1470 :version "21.1"
1471 :type 'boolean)
1473 (defcustom large-file-warning-threshold 10000000
1474 "Maximum size of file above which a confirmation is requested.
1475 When nil, never request confirmation."
1476 :group 'files
1477 :group 'find-file
1478 :version "22.1"
1479 :type '(choice integer (const :tag "Never request confirmation" nil)))
1481 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1482 "Read file FILENAME into a buffer and return the buffer.
1483 If a buffer exists visiting FILENAME, return that one, but
1484 verify that the file has not changed since visited or saved.
1485 The buffer is not selected, just returned to the caller.
1486 Optional second arg NOWARN non-nil means suppress any warning messages.
1487 Optional third arg RAWFILE non-nil means the file is read literally.
1488 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1489 and visit all the matching files. When wildcards are actually
1490 used and expanded, return a list of buffers that are visiting
1491 the various files."
1492 (setq filename
1493 (abbreviate-file-name
1494 (expand-file-name filename)))
1495 (if (file-directory-p filename)
1496 (or (and find-file-run-dired
1497 (run-hook-with-args-until-success
1498 'find-directory-functions
1499 (if find-file-visit-truename
1500 (abbreviate-file-name (file-truename filename))
1501 filename)))
1502 (error "%s is a directory" filename))
1503 (if (and wildcards
1504 find-file-wildcards
1505 (not (string-match "\\`/:" filename))
1506 (string-match "[[*?]" filename))
1507 (let ((files (condition-case nil
1508 (file-expand-wildcards filename t)
1509 (error (list filename))))
1510 (find-file-wildcards nil))
1511 (if (null files)
1512 (find-file-noselect filename)
1513 (mapcar #'find-file-noselect files)))
1514 (let* ((buf (get-file-buffer filename))
1515 (truename (abbreviate-file-name (file-truename filename)))
1516 (attributes (file-attributes truename))
1517 (number (nthcdr 10 attributes))
1518 ;; Find any buffer for a file which has same truename.
1519 (other (and (not buf) (find-buffer-visiting filename))))
1520 ;; Let user know if there is a buffer with the same truename.
1521 (if other
1522 (progn
1523 (or nowarn
1524 find-file-suppress-same-file-warnings
1525 (string-equal filename (buffer-file-name other))
1526 (message "%s and %s are the same file"
1527 filename (buffer-file-name other)))
1528 ;; Optionally also find that buffer.
1529 (if (or find-file-existing-other-name find-file-visit-truename)
1530 (setq buf other))))
1531 ;; Check to see if the file looks uncommonly large.
1532 (when (and large-file-warning-threshold (nth 7 attributes)
1533 ;; Don't ask again if we already have the file or
1534 ;; if we're asked to be quiet.
1535 (not (or buf nowarn))
1536 (> (nth 7 attributes) large-file-warning-threshold)
1537 (not (y-or-n-p
1538 (format "File %s is large (%dMB), really open? "
1539 (file-name-nondirectory filename)
1540 (/ (nth 7 attributes) 1048576)))))
1541 (error "Aborted"))
1542 (if buf
1543 ;; We are using an existing buffer.
1544 (let (nonexistent)
1545 (or nowarn
1546 (verify-visited-file-modtime buf)
1547 (cond ((not (file-exists-p filename))
1548 (setq nonexistent t)
1549 (message "File %s no longer exists!" filename))
1550 ;; Certain files should be reverted automatically
1551 ;; if they have changed on disk and not in the buffer.
1552 ((and (not (buffer-modified-p buf))
1553 (let ((tail revert-without-query)
1554 (found nil))
1555 (while tail
1556 (if (string-match (car tail) filename)
1557 (setq found t))
1558 (setq tail (cdr tail)))
1559 found))
1560 (with-current-buffer buf
1561 (message "Reverting file %s..." filename)
1562 (revert-buffer t t)
1563 (message "Reverting file %s...done" filename)))
1564 ((yes-or-no-p
1565 (if (string= (file-name-nondirectory filename)
1566 (buffer-name buf))
1567 (format
1568 (if (buffer-modified-p buf)
1569 "File %s changed on disk. Discard your edits? "
1570 "File %s changed on disk. Reread from disk? ")
1571 (file-name-nondirectory filename))
1572 (format
1573 (if (buffer-modified-p buf)
1574 "File %s changed on disk. Discard your edits in %s? "
1575 "File %s changed on disk. Reread from disk into %s? ")
1576 (file-name-nondirectory filename)
1577 (buffer-name buf))))
1578 (with-current-buffer buf
1579 (revert-buffer t t)))))
1580 (with-current-buffer buf
1582 ;; Check if a formerly read-only file has become
1583 ;; writable and vice versa, but if the buffer agrees
1584 ;; with the new state of the file, that is ok too.
1585 (let ((read-only (not (file-writable-p buffer-file-name))))
1586 (unless (or nonexistent
1587 (eq read-only buffer-file-read-only)
1588 (eq read-only buffer-read-only))
1589 (when (or nowarn
1590 (let ((question
1591 (format "File %s is %s on disk. Change buffer mode? "
1592 buffer-file-name
1593 (if read-only "read-only" "writable"))))
1594 (y-or-n-p question)))
1595 (setq buffer-read-only read-only)))
1596 (setq buffer-file-read-only read-only))
1598 (when (and (not (eq (not (null rawfile))
1599 (not (null find-file-literally))))
1600 (not nonexistent)
1601 ;; It is confusing to ask whether to visit
1602 ;; non-literally if they have the file in
1603 ;; hexl-mode.
1604 (not (eq major-mode 'hexl-mode)))
1605 (if (buffer-modified-p)
1606 (if (y-or-n-p
1607 (format
1608 (if rawfile
1609 "The file %s is already visited normally,
1610 and you have edited the buffer. Now you have asked to visit it literally,
1611 meaning no coding system handling, format conversion, or local variables.
1612 Emacs can only visit a file in one way at a time.
1614 Do you want to save the file, and visit it literally instead? "
1615 "The file %s is already visited literally,
1616 meaning no coding system handling, format conversion, or local variables.
1617 You have edited the buffer. Now you have asked to visit the file normally,
1618 but Emacs can only visit a file in one way at a time.
1620 Do you want to save the file, and visit it normally instead? ")
1621 (file-name-nondirectory filename)))
1622 (progn
1623 (save-buffer)
1624 (find-file-noselect-1 buf filename nowarn
1625 rawfile truename number))
1626 (if (y-or-n-p
1627 (format
1628 (if rawfile
1630 Do you want to discard your changes, and visit the file literally now? "
1632 Do you want to discard your changes, and visit the file normally now? ")))
1633 (find-file-noselect-1 buf filename nowarn
1634 rawfile truename number)
1635 (error (if rawfile "File already visited non-literally"
1636 "File already visited literally"))))
1637 (if (y-or-n-p
1638 (format
1639 (if rawfile
1640 "The file %s is already visited normally.
1641 You have asked to visit it literally,
1642 meaning no coding system decoding, format conversion, or local variables.
1643 But Emacs can only visit a file in one way at a time.
1645 Do you want to revisit the file literally now? "
1646 "The file %s is already visited literally,
1647 meaning no coding system decoding, format conversion, or local variables.
1648 You have asked to visit it normally,
1649 but Emacs can only visit a file in one way at a time.
1651 Do you want to revisit the file normally now? ")
1652 (file-name-nondirectory filename)))
1653 (find-file-noselect-1 buf filename nowarn
1654 rawfile truename number)
1655 (error (if rawfile "File already visited non-literally"
1656 "File already visited literally"))))))
1657 ;; Return the buffer we are using.
1658 buf)
1659 ;; Create a new buffer.
1660 (setq buf (create-file-buffer filename))
1661 ;; find-file-noselect-1 may use a different buffer.
1662 (find-file-noselect-1 buf filename nowarn
1663 rawfile truename number))))))
1665 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1666 (let (error)
1667 (with-current-buffer buf
1668 (kill-local-variable 'find-file-literally)
1669 ;; Needed in case we are re-visiting the file with a different
1670 ;; text representation.
1671 (kill-local-variable 'buffer-file-coding-system)
1672 (kill-local-variable 'cursor-type)
1673 (let ((inhibit-read-only t))
1674 (erase-buffer))
1675 (and (default-value 'enable-multibyte-characters)
1676 (not rawfile)
1677 (set-buffer-multibyte t))
1678 (if rawfile
1679 (condition-case ()
1680 (let ((inhibit-read-only t))
1681 (insert-file-contents-literally filename t))
1682 (file-error
1683 (when (and (file-exists-p filename)
1684 (not (file-readable-p filename)))
1685 (kill-buffer buf)
1686 (signal 'file-error (list "File is not readable"
1687 filename)))
1688 ;; Unconditionally set error
1689 (setq error t)))
1690 (condition-case ()
1691 (let ((inhibit-read-only t))
1692 (insert-file-contents filename t))
1693 (file-error
1694 (when (and (file-exists-p filename)
1695 (not (file-readable-p filename)))
1696 (kill-buffer buf)
1697 (signal 'file-error (list "File is not readable"
1698 filename)))
1699 ;; Run find-file-not-found-functions until one returns non-nil.
1700 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1701 ;; If they fail too, set error.
1702 (setq error t)))))
1703 ;; Record the file's truename, and maybe use that as visited name.
1704 (if (equal filename buffer-file-name)
1705 (setq buffer-file-truename truename)
1706 (setq buffer-file-truename
1707 (abbreviate-file-name (file-truename buffer-file-name))))
1708 (setq buffer-file-number number)
1709 ;; On VMS, we may want to remember which directory in a search list
1710 ;; the file was found in.
1711 (and (eq system-type 'vax-vms)
1712 (let (logical)
1713 (if (string-match ":" (file-name-directory filename))
1714 (setq logical (substring (file-name-directory filename)
1715 0 (match-beginning 0))))
1716 (not (member logical find-file-not-true-dirname-list)))
1717 (setq buffer-file-name buffer-file-truename))
1718 (if find-file-visit-truename
1719 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1720 ;; Set buffer's default directory to that of the file.
1721 (setq default-directory (file-name-directory buffer-file-name))
1722 ;; Turn off backup files for certain file names. Since
1723 ;; this is a permanent local, the major mode won't eliminate it.
1724 (and backup-enable-predicate
1725 (not (funcall backup-enable-predicate buffer-file-name))
1726 (progn
1727 (make-local-variable 'backup-inhibited)
1728 (setq backup-inhibited t)))
1729 (if rawfile
1730 (progn
1731 (set-buffer-multibyte nil)
1732 (setq buffer-file-coding-system 'no-conversion)
1733 (set-buffer-major-mode buf)
1734 (make-local-variable 'find-file-literally)
1735 (setq find-file-literally t))
1736 (after-find-file error (not nowarn)))
1737 (current-buffer))))
1739 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1740 "Like `insert-file-contents', but only reads in the file literally.
1741 A buffer may be modified in several ways after reading into the buffer,
1742 to Emacs features such as format decoding, character code
1743 conversion, `find-file-hook', automatic uncompression, etc.
1745 This function ensures that none of these modifications will take place."
1746 (let ((format-alist nil)
1747 (after-insert-file-functions nil)
1748 (coding-system-for-read 'no-conversion)
1749 (coding-system-for-write 'no-conversion)
1750 (find-buffer-file-type-function
1751 (if (fboundp 'find-buffer-file-type)
1752 (symbol-function 'find-buffer-file-type)
1753 nil))
1754 (inhibit-file-name-handlers
1755 (append '(jka-compr-handler image-file-handler)
1756 inhibit-file-name-handlers))
1757 (inhibit-file-name-operation 'insert-file-contents))
1758 (unwind-protect
1759 (progn
1760 (fset 'find-buffer-file-type (lambda (filename) t))
1761 (insert-file-contents filename visit beg end replace))
1762 (if find-buffer-file-type-function
1763 (fset 'find-buffer-file-type find-buffer-file-type-function)
1764 (fmakunbound 'find-buffer-file-type)))))
1766 (defun insert-file-1 (filename insert-func)
1767 (if (file-directory-p filename)
1768 (signal 'file-error (list "Opening input file" "file is a directory"
1769 filename)))
1770 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1771 #'buffer-modified-p))
1772 (tem (funcall insert-func filename)))
1773 (push-mark (+ (point) (car (cdr tem))))
1774 (when buffer
1775 (message "File %s already visited and modified in buffer %s"
1776 filename (buffer-name buffer)))))
1778 (defun insert-file-literally (filename)
1779 "Insert contents of file FILENAME into buffer after point with no conversion.
1781 This function is meant for the user to run interactively.
1782 Don't call it from programs! Use `insert-file-contents-literally' instead.
1783 \(Its calling sequence is different; see its documentation)."
1784 (interactive "*fInsert file literally: ")
1785 (insert-file-1 filename #'insert-file-contents-literally))
1787 (defvar find-file-literally nil
1788 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1789 This is a permanent local.")
1790 (put 'find-file-literally 'permanent-local t)
1792 (defun find-file-literally (filename)
1793 "Visit file FILENAME with no conversion of any kind.
1794 Format conversion and character code conversion are both disabled,
1795 and multibyte characters are disabled in the resulting buffer.
1796 The major mode used is Fundamental mode regardless of the file name,
1797 and local variable specifications in the file are ignored.
1798 Automatic uncompression and adding a newline at the end of the
1799 file due to `require-final-newline' is also disabled.
1801 You cannot absolutely rely on this function to result in
1802 visiting the file literally. If Emacs already has a buffer
1803 which is visiting the file, you get the existing buffer,
1804 regardless of whether it was created literally or not.
1806 In a Lisp program, if you want to be sure of accessing a file's
1807 contents literally, you should create a temporary buffer and then read
1808 the file contents into it using `insert-file-contents-literally'."
1809 (interactive "FFind file literally: ")
1810 (switch-to-buffer (find-file-noselect filename nil t)))
1812 (defvar after-find-file-from-revert-buffer nil)
1814 (defun after-find-file (&optional error warn noauto
1815 after-find-file-from-revert-buffer
1816 nomodes)
1817 "Called after finding a file and by the default revert function.
1818 Sets buffer mode, parses local variables.
1819 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1820 error in reading the file. WARN non-nil means warn if there
1821 exists an auto-save file more recent than the visited file.
1822 NOAUTO means don't mess with auto-save mode.
1823 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1824 means this call was from `revert-buffer'.
1825 Fifth arg NOMODES non-nil means don't alter the file's modes.
1826 Finishes by calling the functions in `find-file-hook'
1827 unless NOMODES is non-nil."
1828 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1829 (if noninteractive
1831 (let* (not-serious
1832 (msg
1833 (cond
1834 ((not warn) nil)
1835 ((and error (file-attributes buffer-file-name))
1836 (setq buffer-read-only t)
1837 "File exists, but cannot be read")
1838 ((not buffer-read-only)
1839 (if (and warn
1840 ;; No need to warn if buffer is auto-saved
1841 ;; under the name of the visited file.
1842 (not (and buffer-file-name
1843 auto-save-visited-file-name))
1844 (file-newer-than-file-p (or buffer-auto-save-file-name
1845 (make-auto-save-file-name))
1846 buffer-file-name))
1847 (format "%s has auto save data; consider M-x recover-this-file"
1848 (file-name-nondirectory buffer-file-name))
1849 (setq not-serious t)
1850 (if error "(New file)" nil)))
1851 ((not error)
1852 (setq not-serious t)
1853 "Note: file is write protected")
1854 ((file-attributes (directory-file-name default-directory))
1855 "File not found and directory write-protected")
1856 ((file-exists-p (file-name-directory buffer-file-name))
1857 (setq buffer-read-only nil))
1859 (setq buffer-read-only nil)
1860 "Use M-x make-directory RET RET to create the directory and its parents"))))
1861 (when msg
1862 (message "%s" msg)
1863 (or not-serious (sit-for 1 t))))
1864 (when (and auto-save-default (not noauto))
1865 (auto-save-mode t)))
1866 ;; Make people do a little extra work (C-x C-q)
1867 ;; before altering a backup file.
1868 (when (backup-file-name-p buffer-file-name)
1869 (setq buffer-read-only t))
1870 ;; When a file is marked read-only,
1871 ;; make the buffer read-only even if root is looking at it.
1872 (when (and (file-modes (buffer-file-name))
1873 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1874 (setq buffer-read-only t))
1875 (unless nomodes
1876 (when (and view-read-only view-mode)
1877 (view-mode-disable))
1878 (normal-mode t)
1879 ;; If requested, add a newline at the end of the file.
1880 (and (memq require-final-newline '(visit visit-save))
1881 (> (point-max) (point-min))
1882 (/= (char-after (1- (point-max))) ?\n)
1883 (not (and (eq selective-display t)
1884 (= (char-after (1- (point-max))) ?\r)))
1885 (save-excursion
1886 (goto-char (point-max))
1887 (insert "\n")))
1888 (when (and buffer-read-only
1889 view-read-only
1890 (not (eq (get major-mode 'mode-class) 'special)))
1891 (view-mode-enter))
1892 (run-hooks 'find-file-hook)))
1894 (defmacro report-errors (format &rest body)
1895 "Eval BODY and turn any error into a FORMAT message.
1896 FORMAT can have a %s escape which will be replaced with the actual error.
1897 If `debug-on-error' is set, errors are not caught, so that you can
1898 debug them.
1899 Avoid using a large BODY since it is duplicated."
1900 (declare (debug t) (indent 1))
1901 `(if debug-on-error
1902 (progn . ,body)
1903 (condition-case err
1904 (progn . ,body)
1905 (error (message ,format (prin1-to-string err))))))
1907 (defun normal-mode (&optional find-file)
1908 "Choose the major mode for this buffer automatically.
1909 Also sets up any specified local variables of the file.
1910 Uses the visited file name, the -*- line, and the local variables spec.
1912 This function is called automatically from `find-file'. In that case,
1913 we may set up the file-specified mode and local variables,
1914 depending on the value of `enable-local-variables'.
1915 In addition, if `local-enable-local-variables' is nil, we do
1916 not set local variables (though we do notice a mode specified with -*-.)
1918 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1919 or from Lisp without specifying the optional argument FIND-FILE;
1920 in that case, this function acts as if `enable-local-variables' were t."
1921 (interactive)
1922 (funcall (or default-major-mode 'fundamental-mode))
1923 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1924 (report-errors "File mode specification error: %s"
1925 (set-auto-mode))
1926 (report-errors "File local-variables error: %s"
1927 (hack-local-variables)))
1928 ;; Turn font lock off and on, to make sure it takes account of
1929 ;; whatever file local variables are relevant to it.
1930 (when (and font-lock-mode
1931 ;; Font-lock-mode (now in font-core.el) can be ON when
1932 ;; font-lock.el still hasn't been loaded.
1933 (boundp 'font-lock-keywords)
1934 (eq (car font-lock-keywords) t))
1935 (setq font-lock-keywords (cadr font-lock-keywords))
1936 (font-lock-mode 1))
1938 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1939 (ucs-set-table-for-input)))
1941 (defcustom auto-mode-case-fold nil
1942 "Non-nil means to try second pass through `auto-mode-alist'.
1943 This means that if the first case-sensitive search through the alist fails
1944 to find a matching major mode, a second case-insensitive search is made.
1945 On systems with case-insensitive file names, this variable is ignored,
1946 since only a single case-insensitive search through the alist is made."
1947 :group 'files
1948 :version "22.1"
1949 :type 'boolean)
1951 (defvar auto-mode-alist
1952 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
1953 ;; c++-mode, java-mode and more) are added through autoload
1954 ;; directives in that file. That way is discouraged since it
1955 ;; spreads out the definition of the initial value.
1956 (mapcar
1957 (lambda (elt)
1958 (cons (purecopy (car elt)) (cdr elt)))
1959 `(;; do this first, so that .html.pl is Polish html, not Perl
1960 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
1961 ("\\.te?xt\\'" . text-mode)
1962 ("\\.[tT]e[xX]\\'" . tex-mode)
1963 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1964 ("\\.ltx\\'" . latex-mode)
1965 ("\\.dtx\\'" . doctex-mode)
1966 ("\\.el\\'" . emacs-lisp-mode)
1967 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
1968 ("\\.l\\'" . lisp-mode)
1969 ("\\.li?sp\\'" . lisp-mode)
1970 ("\\.[fF]\\'" . fortran-mode)
1971 ("\\.for\\'" . fortran-mode)
1972 ("\\.p\\'" . pascal-mode)
1973 ("\\.pas\\'" . pascal-mode)
1974 ("\\.ad[abs]\\'" . ada-mode)
1975 ("\\.ad[bs].dg\\'" . ada-mode)
1976 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
1977 ("Imakefile\\'" . makefile-imake-mode)
1978 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
1979 ("\\.makepp\\'" . makefile-makepp-mode)
1980 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
1981 '(("\\.mk\\'" . makefile-bsdmake-mode)
1982 ("GNUmakefile\\'" . makefile-gmake-mode)
1983 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
1984 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
1985 ("[Mm]akefile\\'" . makefile-gmake-mode)))
1986 ("\\.am\\'" . makefile-automake-mode)
1987 ;; Less common extensions come here
1988 ;; so more common ones above are found faster.
1989 ("\\.texinfo\\'" . texinfo-mode)
1990 ("\\.te?xi\\'" . texinfo-mode)
1991 ("\\.[sS]\\'" . asm-mode)
1992 ("\\.asm\\'" . asm-mode)
1993 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
1994 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
1995 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1996 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1997 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1998 ("\\.bash\\'" . sh-mode)
1999 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2000 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2001 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2002 ("\\.m?spec\\'" . sh-mode)
2003 ("\\.m[mes]\\'" . nroff-mode)
2004 ("\\.man\\'" . nroff-mode)
2005 ("\\.sty\\'" . latex-mode)
2006 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2007 ("\\.bbl\\'" . latex-mode)
2008 ("\\.bib\\'" . bibtex-mode)
2009 ("\\.sql\\'" . sql-mode)
2010 ("\\.m[4c]\\'" . m4-mode)
2011 ("\\.mf\\'" . metafont-mode)
2012 ("\\.mp\\'" . metapost-mode)
2013 ("\\.vhdl?\\'" . vhdl-mode)
2014 ("\\.article\\'" . text-mode)
2015 ("\\.letter\\'" . text-mode)
2016 ("\\.i?tcl\\'" . tcl-mode)
2017 ("\\.exp\\'" . tcl-mode)
2018 ("\\.itk\\'" . tcl-mode)
2019 ("\\.icn\\'" . icon-mode)
2020 ("\\.sim\\'" . simula-mode)
2021 ("\\.mss\\'" . scribe-mode)
2022 ("\\.f9[05]\\'" . f90-mode)
2023 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2024 ("\\.pro\\'" . idlwave-mode)
2025 ("\\.prolog\\'" . prolog-mode)
2026 ("\\.tar\\'" . tar-mode)
2027 ;; The list of archive file extensions should be in sync with
2028 ;; `auto-coding-alist' with `no-conversion' coding system.
2029 ("\\.\\(\
2030 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2031 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2032 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
2033 ;; Mailer puts message to be edited in
2034 ;; /tmp/Re.... or Message
2035 ("\\`/tmp/Re" . text-mode)
2036 ("/Message[0-9]*\\'" . text-mode)
2037 ("\\.zone\\'" . zone-mode)
2038 ;; some news reader is reported to use this
2039 ("\\`/tmp/fol/" . text-mode)
2040 ("\\.oak\\'" . scheme-mode)
2041 ("\\.sgml?\\'" . sgml-mode)
2042 ("\\.x[ms]l\\'" . xml-mode)
2043 ("\\.dtd\\'" . sgml-mode)
2044 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2045 ("\\.js\\'" . java-mode) ; javascript-mode would be better
2046 ;; .emacs or .gnus or .viper following a directory delimiter in
2047 ;; Unix, MSDOG or VMS syntax.
2048 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2049 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2050 ;; _emacs following a directory delimiter
2051 ;; in MsDos syntax
2052 ("[:/]_emacs\\'" . emacs-lisp-mode)
2053 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2054 ("\\.ml\\'" . lisp-mode)
2055 ;; Common Lisp ASDF package system.
2056 ("\\.asd\\'" . lisp-mode)
2057 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2058 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2059 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2060 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2061 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2062 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2063 ("BROWSE\\'" . ebrowse-tree-mode)
2064 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2065 ("#\\*mail\\*" . mail-mode)
2066 ("\\.g\\'" . antlr-mode)
2067 ("\\.ses\\'" . ses-mode)
2068 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2069 ("\\.docbook\\'" . sgml-mode)
2070 ("\\.com\\'" . dcl-mode)
2071 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2072 ;; Windows candidates may be opened case sensitively on Unix
2073 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2074 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2075 ("\\.ppd\\'" . conf-ppd-mode)
2076 ("java.+\\.conf\\'" . conf-javaprop-mode)
2077 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2078 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2079 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode)
2080 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2081 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2082 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2083 ;; this has lower priority to avoid matching changelog.sgml etc.
2084 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2085 ;; either user's dot-files or under /etc or some such
2086 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2087 ;; alas not all ~/.*rc files are like this
2088 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2089 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2090 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2091 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2092 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2093 ;; this contains everything twice, with space and with colon :-(
2094 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2095 ;; Get rid of any trailing .n.m and try again.
2096 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2097 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2098 ;; Using mode nil rather than `ignore' would let the search continue
2099 ;; through this list (with the shortened name) rather than start over.
2100 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2101 ;; The following should come after the ChangeLog pattern
2102 ;; for the sake of ChangeLog.1, etc.
2103 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2104 ("\\.[1-9]\\'" . nroff-mode)
2105 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2106 "Alist of filename patterns vs corresponding major mode functions.
2107 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2108 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2109 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2110 mode function to use. FUNCTION will be called, unless it is nil.
2112 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2113 calling FUNCTION (if it's not nil), we delete the suffix that matched
2114 REGEXP and search the list again for another match.
2116 If the file name matches `inhibit-first-line-modes-regexps',
2117 then `auto-mode-alist' is not processed.
2119 The extensions whose FUNCTION is `archive-mode' should also
2120 appear in `auto-coding-alist' with `no-conversion' coding system.
2122 See also `interpreter-mode-alist', which detects executable script modes
2123 based on the interpreters they specify to run,
2124 and `magic-mode-alist', which determines modes based on file contents.")
2126 (defvar interpreter-mode-alist
2127 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2128 ;; and pike-mode) are added through autoload directives in that
2129 ;; file. That way is discouraged since it spreads out the
2130 ;; definition of the initial value.
2131 (mapc
2132 (lambda (l)
2133 (cons (purecopy (car l)) (cdr l)))
2134 '(("perl" . perl-mode)
2135 ("perl5" . perl-mode)
2136 ("miniperl" . perl-mode)
2137 ("wish" . tcl-mode)
2138 ("wishx" . tcl-mode)
2139 ("tcl" . tcl-mode)
2140 ("tclsh" . tcl-mode)
2141 ("scm" . scheme-mode)
2142 ("ash" . sh-mode)
2143 ("bash" . sh-mode)
2144 ("bash2" . sh-mode)
2145 ("csh" . sh-mode)
2146 ("dtksh" . sh-mode)
2147 ("es" . sh-mode)
2148 ("itcsh" . sh-mode)
2149 ("jsh" . sh-mode)
2150 ("ksh" . sh-mode)
2151 ("oash" . sh-mode)
2152 ("pdksh" . sh-mode)
2153 ("rc" . sh-mode)
2154 ("rpm" . sh-mode)
2155 ("sh" . sh-mode)
2156 ("sh5" . sh-mode)
2157 ("tcsh" . sh-mode)
2158 ("wksh" . sh-mode)
2159 ("wsh" . sh-mode)
2160 ("zsh" . sh-mode)
2161 ("tail" . text-mode)
2162 ("more" . text-mode)
2163 ("less" . text-mode)
2164 ("pg" . text-mode)
2165 ("make" . makefile-gmake-mode) ; Debian uses this
2166 ("guile" . scheme-mode)
2167 ("clisp" . lisp-mode)))
2168 "Alist mapping interpreter names to major modes.
2169 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2170 Each element looks like (INTERPRETER . MODE).
2171 If INTERPRETER matches the name of the interpreter specified in the first line
2172 of a script, mode MODE is enabled.
2174 See also `auto-mode-alist'.")
2176 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2177 "List of regexps; if one matches a file name, don't look for `-*-'.")
2179 (defvar inhibit-first-line-modes-suffixes nil
2180 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2181 When checking `inhibit-first-line-modes-regexps', we first discard
2182 from the end of the file name anything that matches one of these regexps.")
2184 (defvar auto-mode-interpreter-regexp
2185 "#![ \t]?\\([^ \t\n]*\
2186 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2187 "Regexp matching interpreters, for file mode determination.
2188 This regular expression is matched against the first line of a file
2189 to determine the file's mode in `set-auto-mode'. If it matches, the file
2190 is assumed to be interpreted by the interpreter matched by the second group
2191 of the regular expression. The mode is then determined as the mode
2192 associated with that interpreter in `interpreter-mode-alist'.")
2194 (defvar magic-mode-alist nil
2195 "Alist of buffer beginnings vs. corresponding major mode functions.
2196 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2197 After visiting a file, if REGEXP matches the text at the beginning of the
2198 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2199 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2200 major mode.
2202 If FUNCTION is nil, then it is not called. (That is a way of saying
2203 \"allow `auto-mode-alist' to decide for these files.\")")
2204 (put 'magic-mode-alist 'risky-local-variable t)
2206 (defvar magic-fallback-mode-alist
2207 `((image-type-auto-detected-p . image-mode)
2208 ;; The < comes before the groups (but the first) to reduce backtracking.
2209 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2210 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2211 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2212 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2213 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2214 comment-re "*"
2215 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2216 "[Hh][Tt][Mm][Ll]"))
2217 . html-mode)
2218 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2219 ;; These two must come after html, because they are more general:
2220 ("<\\?xml " . xml-mode)
2221 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2222 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2223 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2224 . sgml-mode)
2225 ("%!PS" . ps-mode)
2226 ("# xmcd " . conf-unix-mode))
2227 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2228 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2229 After visiting a file, if REGEXP matches the text at the beginning of the
2230 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2231 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2232 have not specified a mode for this file.
2234 If FUNCTION is nil, then it is not called.")
2235 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2237 (defvar magic-mode-regexp-match-limit 4000
2238 "Upper limit on `magic-mode-alist' regexp matches.
2239 Also applies to `magic-fallback-mode-alist'.")
2241 (defun set-auto-mode (&optional keep-mode-if-same)
2242 "Select major mode appropriate for current buffer.
2244 To find the right major mode, this function checks for a -*- mode tag,
2245 checks if it uses an interpreter listed in `interpreter-mode-alist',
2246 matches the buffer beginning against `magic-mode-alist',
2247 compares the filename against the entries in `auto-mode-alist',
2248 then matches the buffer beginning against `magic-fallback-mode-alist'.
2250 It does not check for the `mode:' local variable in the
2251 Local Variables section of the file; for that, use `hack-local-variables'.
2253 If `enable-local-variables' is nil, this function does not check for a
2254 -*- mode tag.
2256 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2257 set the major mode only if that would change it. In other words
2258 we don't actually set it to the same mode the buffer already has."
2259 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2260 (let (end done mode modes)
2261 ;; Find a -*- mode tag
2262 (save-excursion
2263 (goto-char (point-min))
2264 (skip-chars-forward " \t\n")
2265 (and enable-local-variables
2266 (setq end (set-auto-mode-1))
2267 (if (save-excursion (search-forward ":" end t))
2268 ;; Find all specifications for the `mode:' variable
2269 ;; and execute them left to right.
2270 (while (let ((case-fold-search t))
2271 (or (and (looking-at "mode:")
2272 (goto-char (match-end 0)))
2273 (re-search-forward "[ \t;]mode:" end t)))
2274 (skip-chars-forward " \t")
2275 (let ((beg (point)))
2276 (if (search-forward ";" end t)
2277 (forward-char -1)
2278 (goto-char end))
2279 (skip-chars-backward " \t")
2280 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2281 modes)))
2282 ;; Simple -*-MODE-*- case.
2283 (push (intern (concat (downcase (buffer-substring (point) end))
2284 "-mode"))
2285 modes))))
2286 ;; If we found modes to use, invoke them now, outside the save-excursion.
2287 (if modes
2288 (catch 'nop
2289 (dolist (mode (nreverse modes))
2290 (if (not (functionp mode))
2291 (message "Ignoring unknown mode `%s'" mode)
2292 (setq done t)
2293 (or (set-auto-mode-0 mode keep-mode-if-same)
2294 ;; continuing would call minor modes again, toggling them off
2295 (throw 'nop nil))))))
2296 ;; If we didn't, look for an interpreter specified in the first line.
2297 ;; As a special case, allow for things like "#!/bin/env perl", which
2298 ;; finds the interpreter anywhere in $PATH.
2299 (unless done
2300 (setq mode (save-excursion
2301 (goto-char (point-min))
2302 (if (looking-at auto-mode-interpreter-regexp)
2303 (match-string 2)
2304 ""))
2305 ;; Map interpreter name to a mode, signalling we're done at the
2306 ;; same time.
2307 done (assoc (file-name-nondirectory mode)
2308 interpreter-mode-alist))
2309 ;; If we found an interpreter mode to use, invoke it now.
2310 (if done
2311 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2312 ;; Next try matching the buffer beginning against magic-mode-alist.
2313 (unless done
2314 (if (setq done (save-excursion
2315 (goto-char (point-min))
2316 (save-restriction
2317 (narrow-to-region (point-min)
2318 (min (point-max)
2319 (+ (point-min) magic-mode-regexp-match-limit)))
2320 (assoc-default nil magic-mode-alist
2321 (lambda (re dummy)
2322 (if (functionp re)
2323 (funcall re)
2324 (looking-at re)))))))
2325 (set-auto-mode-0 done keep-mode-if-same)))
2326 ;; Next compare the filename against the entries in auto-mode-alist.
2327 (unless done
2328 (if buffer-file-name
2329 (let ((name buffer-file-name)
2330 (remote-id (file-remote-p buffer-file-name)))
2331 ;; Remove remote file name identification.
2332 (when (and (stringp remote-id)
2333 (string-match (regexp-quote remote-id) name))
2334 (setq name (substring name (match-end 0))))
2335 ;; Remove backup-suffixes from file name.
2336 (setq name (file-name-sans-versions name))
2337 (while name
2338 ;; Find first matching alist entry.
2339 (setq mode
2340 (if (memq system-type '(vax-vms windows-nt cygwin))
2341 ;; System is case-insensitive.
2342 (let ((case-fold-search t))
2343 (assoc-default name auto-mode-alist
2344 'string-match))
2345 ;; System is case-sensitive.
2347 ;; First match case-sensitively.
2348 (let ((case-fold-search nil))
2349 (assoc-default name auto-mode-alist
2350 'string-match))
2351 ;; Fallback to case-insensitive match.
2352 (and auto-mode-case-fold
2353 (let ((case-fold-search t))
2354 (assoc-default name auto-mode-alist
2355 'string-match))))))
2356 (if (and mode
2357 (consp mode)
2358 (cadr mode))
2359 (setq mode (car mode)
2360 name (substring name 0 (match-beginning 0)))
2361 (setq name))
2362 (when mode
2363 (set-auto-mode-0 mode keep-mode-if-same)
2364 (setq done t))))))
2365 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2366 (unless done
2367 (if (setq done (save-excursion
2368 (goto-char (point-min))
2369 (save-restriction
2370 (narrow-to-region (point-min)
2371 (min (point-max)
2372 (+ (point-min) magic-mode-regexp-match-limit)))
2373 (assoc-default nil magic-fallback-mode-alist
2374 (lambda (re dummy)
2375 (if (functionp re)
2376 (funcall re)
2377 (looking-at re)))))))
2378 (set-auto-mode-0 done keep-mode-if-same)))))
2380 ;; When `keep-mode-if-same' is set, we are working on behalf of
2381 ;; set-visited-file-name. In that case, if the major mode specified is the
2382 ;; same one we already have, don't actually reset it. We don't want to lose
2383 ;; minor modes such as Font Lock.
2384 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2385 "Apply MODE and return it.
2386 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2387 any aliases and compared to current major mode. If they are the
2388 same, do nothing and return nil."
2389 (unless (and keep-mode-if-same
2390 (eq (indirect-function mode)
2391 (indirect-function major-mode)))
2392 (when mode
2393 (funcall mode)
2394 mode)))
2396 (defun set-auto-mode-1 ()
2397 "Find the -*- spec in the buffer.
2398 Call with point at the place to start searching from.
2399 If one is found, set point to the beginning
2400 and return the position of the end.
2401 Otherwise, return nil; point may be changed."
2402 (let (beg end)
2403 (and
2404 ;; Don't look for -*- if this file name matches any
2405 ;; of the regexps in inhibit-first-line-modes-regexps.
2406 (let ((temp inhibit-first-line-modes-regexps)
2407 (name (if buffer-file-name
2408 (file-name-sans-versions buffer-file-name)
2409 (buffer-name))))
2410 (while (let ((sufs inhibit-first-line-modes-suffixes))
2411 (while (and sufs (not (string-match (car sufs) name)))
2412 (setq sufs (cdr sufs)))
2413 sufs)
2414 (setq name (substring name 0 (match-beginning 0))))
2415 (while (and temp
2416 (not (string-match (car temp) name)))
2417 (setq temp (cdr temp)))
2418 (not temp))
2420 (search-forward "-*-" (line-end-position
2421 ;; If the file begins with "#!"
2422 ;; (exec interpreter magic), look
2423 ;; for mode frobs in the first two
2424 ;; lines. You cannot necessarily
2425 ;; put them in the first line of
2426 ;; such a file without screwing up
2427 ;; the interpreter invocation.
2428 (and (looking-at "^#!") 2)) t)
2429 (progn
2430 (skip-chars-forward " \t")
2431 (setq beg (point))
2432 (search-forward "-*-" (line-end-position) t))
2433 (progn
2434 (forward-char -3)
2435 (skip-chars-backward " \t")
2436 (setq end (point))
2437 (goto-char beg)
2438 end))))
2440 ;;; Handling file local variables
2442 (defvar ignored-local-variables
2443 '(ignored-local-variables safe-local-variable-values)
2444 "Variables to be ignored in a file's local variable spec.")
2446 (defvar hack-local-variables-hook nil
2447 "Normal hook run after processing a file's local variables specs.
2448 Major modes can use this to examine user-specified local variables
2449 in order to initialize other data structure based on them.")
2451 (defcustom safe-local-variable-values nil
2452 "List variable-value pairs that are considered safe.
2453 Each element is a cons cell (VAR . VAL), where VAR is a variable
2454 symbol and VAL is a value that is considered safe."
2455 :group 'find-file
2456 :type 'alist)
2458 (defcustom safe-local-eval-forms nil
2459 "Expressions that are considered safe in an `eval:' local variable.
2460 Add expressions to this list if you want Emacs to evaluate them, when
2461 they appear in an `eval' local variable specification, without first
2462 asking you for confirmation."
2463 :group 'find-file
2464 :version "22.1"
2465 :type '(repeat sexp))
2467 ;; Risky local variables:
2468 (mapc (lambda (var) (put var 'risky-local-variable t))
2469 '(after-load-alist
2470 auto-mode-alist
2471 buffer-auto-save-file-name
2472 buffer-file-name
2473 buffer-file-truename
2474 buffer-undo-list
2475 dabbrev-case-fold-search
2476 dabbrev-case-replace
2477 debugger
2478 default-text-properties
2479 display-time-string
2480 enable-local-eval
2481 enable-local-variables
2482 eval
2483 exec-directory
2484 exec-path
2485 file-name-handler-alist
2486 font-lock-defaults
2487 format-alist
2488 frame-title-format
2489 global-mode-string
2490 header-line-format
2491 icon-title-format
2492 ignored-local-variables
2493 imenu--index-alist
2494 imenu-generic-expression
2495 inhibit-quit
2496 input-method-alist
2497 load-path
2498 max-lisp-eval-depth
2499 max-specpdl-size
2500 minor-mode-alist
2501 minor-mode-map-alist
2502 minor-mode-overriding-map-alist
2503 mode-line-buffer-identification
2504 mode-line-format
2505 mode-line-client
2506 mode-line-modes
2507 mode-line-modified
2508 mode-line-mule-info
2509 mode-line-position
2510 mode-line-process
2511 mode-line-remote
2512 mode-name
2513 outline-level
2514 overriding-local-map
2515 overriding-terminal-local-map
2516 parse-time-rules
2517 process-environment
2518 rmail-output-file-alist
2519 safe-local-variable-values
2520 safe-local-eval-forms
2521 save-some-buffers-action-alist
2522 special-display-buffer-names
2523 standard-input
2524 standard-output
2525 unread-command-events
2526 vc-mode))
2528 ;; Safe local variables:
2530 ;; For variables defined by major modes, the safety declarations can go into
2531 ;; the major mode's file, since that will be loaded before file variables are
2532 ;; processed.
2534 ;; For variables defined by minor modes, put the safety declarations in the
2535 ;; file defining the minor mode after the defcustom/defvar using an autoload
2536 ;; cookie, e.g.:
2538 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2540 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2541 ;; minor mode file may not be loaded yet.
2543 ;; For variables defined in the C source code the declaration should go here:
2545 (mapc (lambda (pair)
2546 (put (car pair) 'safe-local-variable (cdr pair)))
2547 '((buffer-read-only . booleanp) ;; C source code
2548 (default-directory . stringp) ;; C source code
2549 (fill-column . integerp) ;; C source code
2550 (indent-tabs-mode . booleanp) ;; C source code
2551 (left-margin . integerp) ;; C source code
2552 (no-update-autoloads . booleanp)
2553 (tab-width . integerp) ;; C source code
2554 (truncate-lines . booleanp))) ;; C source code
2556 (put 'c-set-style 'safe-local-eval-function t)
2558 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars)
2559 "Get confirmation before setting up local variable values.
2560 ALL-VARS is the list of all variables to be set up.
2561 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2562 RISKY-VARS is the list of those that are marked as risky."
2563 (if noninteractive
2565 (let ((name (if buffer-file-name
2566 (file-name-nondirectory buffer-file-name)
2567 (concat "buffer " (buffer-name))))
2568 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2569 prompt char)
2570 (save-window-excursion
2571 (let ((buf (get-buffer-create "*Local Variables*")))
2572 (pop-to-buffer buf)
2573 (set (make-local-variable 'cursor-type) nil)
2574 (erase-buffer)
2575 (if unsafe-vars
2576 (insert "The local variables list in " name
2577 "\ncontains values that may not be safe (*)"
2578 (if risky-vars
2579 ", and variables that are risky (**)."
2580 "."))
2581 (if risky-vars
2582 (insert "The local variables list in " name
2583 "\ncontains variables that are risky (**).")
2584 (insert "A local variables list is specified in " name ".")))
2585 (insert "\n\nDo you want to apply it? You can type
2586 y -- to apply the local variables list.
2587 n -- to ignore the local variables list.")
2588 (if offer-save
2589 (insert "
2590 ! -- to apply the local variables list, and permanently mark these
2591 values (*) as safe (in the future, they will be set automatically.)\n\n")
2592 (insert "\n\n"))
2593 (dolist (elt all-vars)
2594 (cond ((member elt unsafe-vars)
2595 (insert " * "))
2596 ((member elt risky-vars)
2597 (insert " ** "))
2599 (insert " ")))
2600 (princ (car elt) buf)
2601 (insert " : ")
2602 ;; Make strings with embedded whitespace easier to read.
2603 (let ((print-escape-newlines t))
2604 (prin1 (cdr elt) buf))
2605 (insert "\n"))
2606 (setq prompt
2607 (format "Please type %s%s: "
2608 (if offer-save "y, n, or !" "y or n")
2609 (if (< (line-number-at-pos) (window-body-height))
2611 ", or C-v to scroll")))
2612 (goto-char (point-min))
2613 (let ((cursor-in-echo-area t)
2614 (executing-kbd-macro executing-kbd-macro)
2615 (exit-chars
2616 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2617 done)
2618 (while (not done)
2619 (message prompt)
2620 (setq char (read-event))
2621 (if (numberp char)
2622 (cond ((eq char ?\C-v)
2623 (condition-case nil
2624 (scroll-up)
2625 (error (goto-char (point-min)))))
2626 ;; read-event returns -1 if we are in a kbd
2627 ;; macro and there are no more events in the
2628 ;; macro. In that case, attempt to get an
2629 ;; event interactively.
2630 ((and executing-kbd-macro (= char -1))
2631 (setq executing-kbd-macro nil))
2632 (t (setq done (memq (downcase char) exit-chars)))))))
2633 (setq char (downcase char))
2634 (when (and offer-save (= char ?!) unsafe-vars)
2635 (dolist (elt unsafe-vars)
2636 (add-to-list 'safe-local-variable-values elt))
2637 ;; When this is called from desktop-restore-file-buffer,
2638 ;; coding-system-for-read may be non-nil. Reset it before
2639 ;; writing to .emacs.
2640 (if (or custom-file user-init-file)
2641 (let ((coding-system-for-read nil))
2642 (customize-save-variable
2643 'safe-local-variable-values
2644 safe-local-variable-values))))
2645 (kill-buffer buf)
2646 (or (= char ?!)
2647 (= char ?\s)
2648 (= char ?y)))))))
2650 (defun hack-local-variables-prop-line (&optional mode-only)
2651 "Return local variables specified in the -*- line.
2652 Ignore any specification for `mode:' and `coding:';
2653 `set-auto-mode' should already have handled `mode:',
2654 `set-auto-coding' should already have handled `coding:'.
2656 If MODE-ONLY is non-nil, all we do is check whether the major
2657 mode is specified, returning t if it is specified. Otherwise,
2658 return an alist of elements (VAR . VAL), where VAR is a variable
2659 and VAL is the specified value."
2660 (save-excursion
2661 (goto-char (point-min))
2662 (let ((end (set-auto-mode-1))
2663 result mode-specified)
2664 ;; Parse the -*- line into the RESULT alist.
2665 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2666 (cond ((not end)
2667 nil)
2668 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2669 ;; Simple form: "-*- MODENAME -*-". Already handled.
2670 (setq mode-specified t)
2671 nil)
2673 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2674 ;; (last ";" is optional).
2675 (while (< (point) end)
2676 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2677 (error "Malformed -*- line"))
2678 (goto-char (match-end 0))
2679 ;; There used to be a downcase here,
2680 ;; but the manual didn't say so,
2681 ;; and people want to set var names that aren't all lc.
2682 (let ((key (intern (match-string 1)))
2683 (val (save-restriction
2684 (narrow-to-region (point) end)
2685 (read (current-buffer)))))
2686 ;; It is traditional to ignore
2687 ;; case when checking for `mode' in set-auto-mode,
2688 ;; so we must do that here as well.
2689 ;; That is inconsistent, but we're stuck with it.
2690 ;; The same can be said for `coding' in set-auto-coding.
2691 (or (and (equal (downcase (symbol-name key)) "mode")
2692 (setq mode-specified t))
2693 (equal (downcase (symbol-name key)) "coding")
2694 (condition-case nil
2695 (push (cons (if (eq key 'eval)
2696 'eval
2697 (indirect-variable key))
2698 val) result)
2699 (error nil)))
2700 (skip-chars-forward " \t;")))))
2702 (if mode-only
2703 mode-specified
2704 result))))
2706 (defun hack-local-variables (&optional mode-only)
2707 "Parse and put into effect this buffer's local variables spec.
2708 If MODE-ONLY is non-nil, all we do is check whether the major mode
2709 is specified, returning t if it is specified."
2710 (let ((enable-local-variables
2711 (and local-enable-local-variables enable-local-variables))
2712 result)
2713 (when (or mode-only enable-local-variables)
2714 (setq result (hack-local-variables-prop-line mode-only))
2715 ;; Look for "Local variables:" line in last page.
2716 (save-excursion
2717 (goto-char (point-max))
2718 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2719 'move)
2720 (when (let ((case-fold-search t))
2721 (search-forward "Local Variables:" nil t))
2722 (skip-chars-forward " \t")
2723 ;; suffix is what comes after "local variables:" in its line.
2724 ;; prefix is what comes before "local variables:" in its line.
2725 (let ((suffix
2726 (concat
2727 (regexp-quote (buffer-substring (point)
2728 (line-end-position)))
2729 "$"))
2730 (prefix
2731 (concat "^" (regexp-quote
2732 (buffer-substring (line-beginning-position)
2733 (match-beginning 0)))))
2734 beg)
2736 (forward-line 1)
2737 (let ((startpos (point))
2738 endpos
2739 (thisbuf (current-buffer)))
2740 (save-excursion
2741 (unless (let ((case-fold-search t))
2742 (re-search-forward
2743 (concat prefix "[ \t]*End:[ \t]*" suffix)
2744 nil t))
2745 (error "Local variables list is not properly terminated"))
2746 (beginning-of-line)
2747 (setq endpos (point)))
2749 (with-temp-buffer
2750 (insert-buffer-substring thisbuf startpos endpos)
2751 (goto-char (point-min))
2752 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2753 (while (not (eobp))
2754 ;; Discard the prefix.
2755 (if (looking-at prefix)
2756 (delete-region (point) (match-end 0))
2757 (error "Local variables entry is missing the prefix"))
2758 (end-of-line)
2759 ;; Discard the suffix.
2760 (if (looking-back suffix)
2761 (delete-region (match-beginning 0) (point))
2762 (error "Local variables entry is missing the suffix"))
2763 (forward-line 1))
2764 (goto-char (point-min))
2766 (while (not (eobp))
2767 ;; Find the variable name; strip whitespace.
2768 (skip-chars-forward " \t")
2769 (setq beg (point))
2770 (skip-chars-forward "^:\n")
2771 (if (eolp) (error "Missing colon in local variables entry"))
2772 (skip-chars-backward " \t")
2773 (let* ((str (buffer-substring beg (point)))
2774 (var (read str))
2775 val)
2776 ;; Read the variable value.
2777 (skip-chars-forward "^:")
2778 (forward-char 1)
2779 (setq val (read (current-buffer)))
2780 (if mode-only
2781 (if (eq var 'mode)
2782 (setq result t))
2783 (unless (eq var 'coding)
2784 (condition-case nil
2785 (push (cons (if (eq var 'eval)
2786 'eval
2787 (indirect-variable var))
2788 val) result)
2789 (error nil)))))
2790 (forward-line 1)))))))
2792 ;; We've read all the local variables. Now, return whether the
2793 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2794 ;; variables (if MODE-ONLY is nil.)
2795 (if mode-only
2796 result
2797 (dolist (ignored ignored-local-variables)
2798 (setq result (assq-delete-all ignored result)))
2799 (if (null enable-local-eval)
2800 (setq result (assq-delete-all 'eval result)))
2801 (when result
2802 (setq result (nreverse result))
2803 ;; Find those variables that we may want to save to
2804 ;; `safe-local-variable-values'.
2805 (let (risky-vars unsafe-vars)
2806 (dolist (elt result)
2807 (let ((var (car elt))
2808 (val (cdr elt)))
2809 (or (eq var 'mode)
2810 (and (eq var 'eval)
2811 (or (eq enable-local-eval t)
2812 (hack-one-local-variable-eval-safep
2813 (eval (quote val)))))
2814 (safe-local-variable-p var val)
2815 (and (risky-local-variable-p var val)
2816 (push elt risky-vars))
2817 (push elt unsafe-vars))))
2818 (if (eq enable-local-variables :safe)
2819 ;; If caller wants only the safe variables,
2820 ;; install only them.
2821 (dolist (elt result)
2822 (unless (or (memq (car elt) unsafe-vars)
2823 (memq (car elt) risky-vars))
2824 (hack-one-local-variable (car elt) (cdr elt))))
2825 ;; Query, except in the case where all are known safe
2826 ;; if the user wants no quuery in that case.
2827 (if (or (and (eq enable-local-variables t)
2828 (null unsafe-vars)
2829 (null risky-vars))
2830 (eq enable-local-variables :all)
2831 (hack-local-variables-confirm
2832 result unsafe-vars risky-vars))
2833 (dolist (elt result)
2834 (hack-one-local-variable (car elt) (cdr elt)))))))
2835 (run-hooks 'hack-local-variables-hook)))))
2837 (defun safe-local-variable-p (sym val)
2838 "Non-nil if SYM is safe as a file-local variable with value VAL.
2839 It is safe if any of these conditions are met:
2841 * There is a matching entry (SYM . VAL) in the
2842 `safe-local-variable-values' user option.
2844 * The `safe-local-variable' property of SYM is a function that
2845 evaluates to a non-nil value with VAL as an argument."
2846 (or (member (cons sym val) safe-local-variable-values)
2847 (let ((safep (get sym 'safe-local-variable)))
2848 (and (functionp safep) (funcall safep val)))))
2850 (defun risky-local-variable-p (sym &optional ignored)
2851 "Non-nil if SYM could be dangerous as a file-local variable.
2852 It is dangerous if either of these conditions are met:
2854 * Its `risky-local-variable' property is non-nil.
2856 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2857 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
2858 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2859 \"map-alist\", or \"bindat-spec\"."
2860 ;; If this is an alias, check the base name.
2861 (condition-case nil
2862 (setq sym (indirect-variable sym))
2863 (error nil))
2864 (or (get sym 'risky-local-variable)
2865 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2866 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2867 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
2868 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
2870 (defun hack-one-local-variable-quotep (exp)
2871 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2873 (defun hack-one-local-variable-constantp (exp)
2874 (or (and (not (symbolp exp)) (not (consp exp)))
2875 (memq exp '(t nil))
2876 (keywordp exp)
2877 (hack-one-local-variable-quotep exp)))
2879 (defun hack-one-local-variable-eval-safep (exp)
2880 "Return t if it is safe to eval EXP when it is found in a file."
2881 (or (not (consp exp))
2882 ;; Detect certain `put' expressions.
2883 (and (eq (car exp) 'put)
2884 (hack-one-local-variable-quotep (nth 1 exp))
2885 (hack-one-local-variable-quotep (nth 2 exp))
2886 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2887 (cond ((eq prop 'lisp-indent-hook)
2888 ;; Only allow safe values of lisp-indent-hook;
2889 ;; not functions.
2890 (or (numberp val) (equal val ''defun)))
2891 ((eq prop 'edebug-form-spec)
2892 ;; Only allow indirect form specs.
2893 ;; During bootstrapping, edebug-basic-spec might not be
2894 ;; defined yet.
2895 (and (fboundp 'edebug-basic-spec)
2896 (hack-one-local-variable-quotep val)
2897 (edebug-basic-spec (nth 1 val)))))))
2898 ;; Allow expressions that the user requested.
2899 (member exp safe-local-eval-forms)
2900 ;; Certain functions can be allowed with safe arguments
2901 ;; or can specify verification functions to try.
2902 (and (symbolp (car exp))
2903 (let ((prop (get (car exp) 'safe-local-eval-function)))
2904 (cond ((eq prop t)
2905 (let ((ok t))
2906 (dolist (arg (cdr exp))
2907 (unless (hack-one-local-variable-constantp arg)
2908 (setq ok nil)))
2909 ok))
2910 ((functionp prop)
2911 (funcall prop exp))
2912 ((listp prop)
2913 (let ((ok nil))
2914 (dolist (function prop)
2915 (if (funcall function exp)
2916 (setq ok t)))
2917 ok)))))))
2919 (defun hack-one-local-variable (var val)
2920 "Set local variable VAR with value VAL.
2921 If VAR is `mode', call `VAL-mode' as a function unless it's
2922 already the major mode."
2923 (cond ((eq var 'mode)
2924 (let ((mode (intern (concat (downcase (symbol-name val))
2925 "-mode"))))
2926 (unless (eq (indirect-function mode)
2927 (indirect-function major-mode))
2928 (funcall mode))))
2929 ((eq var 'eval)
2930 (save-excursion (eval val)))
2932 ;; Make sure the string has no text properties.
2933 ;; Some text properties can get evaluated in various ways,
2934 ;; so it is risky to put them on with a local variable list.
2935 (if (stringp val)
2936 (set-text-properties 0 (length val) nil val))
2937 (set (make-local-variable var) val))))
2940 (defcustom change-major-mode-with-file-name t
2941 "Non-nil means \\[write-file] should set the major mode from the file name.
2942 However, the mode will not be changed if
2943 \(1) a local variables list or the `-*-' line specifies a major mode, or
2944 \(2) the current major mode is a \"special\" mode,
2945 \ not suitable for ordinary files, or
2946 \(3) the new file name does not particularly specify any mode."
2947 :type 'boolean
2948 :group 'editing-basics)
2950 (defun set-visited-file-name (filename &optional no-query along-with-file)
2951 "Change name of file visited in current buffer to FILENAME.
2952 This also renames the buffer to correspond to the new file.
2953 The next time the buffer is saved it will go in the newly specified file.
2954 FILENAME nil or an empty string means mark buffer as not visiting any file.
2955 Remember to delete the initial contents of the minibuffer
2956 if you wish to pass an empty string as the argument.
2958 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2959 confirmation in the case where another buffer is already visiting FILENAME.
2961 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2962 the old visited file has been renamed to the new name FILENAME."
2963 (interactive "FSet visited file name: ")
2964 (if (buffer-base-buffer)
2965 (error "An indirect buffer cannot visit a file"))
2966 (let (truename)
2967 (if filename
2968 (setq filename
2969 (if (string-equal filename "")
2971 (expand-file-name filename))))
2972 (if filename
2973 (progn
2974 (setq truename (file-truename filename))
2975 (if find-file-visit-truename
2976 (setq filename truename))))
2977 (if filename
2978 (let ((new-name (file-name-nondirectory filename)))
2979 (if (string= new-name "")
2980 (error "Empty file name"))))
2981 (let ((buffer (and filename (find-buffer-visiting filename))))
2982 (and buffer (not (eq buffer (current-buffer)))
2983 (not no-query)
2984 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
2985 filename)))
2986 (error "Aborted")))
2987 (or (equal filename buffer-file-name)
2988 (progn
2989 (and filename (lock-buffer filename))
2990 (unlock-buffer)))
2991 (setq buffer-file-name filename)
2992 (if filename ; make buffer name reflect filename.
2993 (let ((new-name (file-name-nondirectory buffer-file-name)))
2994 (if (eq system-type 'vax-vms)
2995 (setq new-name (downcase new-name)))
2996 (setq default-directory (file-name-directory buffer-file-name))
2997 ;; If new-name == old-name, renaming would add a spurious <2>
2998 ;; and it's considered as a feature in rename-buffer.
2999 (or (string= new-name (buffer-name))
3000 (rename-buffer new-name t))))
3001 (setq buffer-backed-up nil)
3002 (or along-with-file
3003 (clear-visited-file-modtime))
3004 ;; Abbreviate the file names of the buffer.
3005 (if truename
3006 (progn
3007 (setq buffer-file-truename (abbreviate-file-name truename))
3008 (if find-file-visit-truename
3009 (setq buffer-file-name truename))))
3010 (setq buffer-file-number
3011 (if filename
3012 (nthcdr 10 (file-attributes buffer-file-name))
3013 nil)))
3014 ;; write-file-functions is normally used for things like ftp-find-file
3015 ;; that visit things that are not local files as if they were files.
3016 ;; Changing to visit an ordinary local file instead should flush the hook.
3017 (kill-local-variable 'write-file-functions)
3018 (kill-local-variable 'local-write-file-hooks)
3019 (kill-local-variable 'revert-buffer-function)
3020 (kill-local-variable 'backup-inhibited)
3021 ;; If buffer was read-only because of version control,
3022 ;; that reason is gone now, so make it writable.
3023 (if vc-mode
3024 (setq buffer-read-only nil))
3025 (kill-local-variable 'vc-mode)
3026 ;; Turn off backup files for certain file names.
3027 ;; Since this is a permanent local, the major mode won't eliminate it.
3028 (and buffer-file-name
3029 backup-enable-predicate
3030 (not (funcall backup-enable-predicate buffer-file-name))
3031 (progn
3032 (make-local-variable 'backup-inhibited)
3033 (setq backup-inhibited t)))
3034 (let ((oauto buffer-auto-save-file-name))
3035 ;; If auto-save was not already on, turn it on if appropriate.
3036 (if (not buffer-auto-save-file-name)
3037 (and buffer-file-name auto-save-default
3038 (auto-save-mode t))
3039 ;; If auto save is on, start using a new name.
3040 ;; We deliberately don't rename or delete the old auto save
3041 ;; for the old visited file name. This is because perhaps
3042 ;; the user wants to save the new state and then compare with the
3043 ;; previous state from the auto save file.
3044 (setq buffer-auto-save-file-name
3045 (make-auto-save-file-name)))
3046 ;; Rename the old auto save file if any.
3047 (and oauto buffer-auto-save-file-name
3048 (file-exists-p oauto)
3049 (rename-file oauto buffer-auto-save-file-name t)))
3050 (and buffer-file-name
3051 (not along-with-file)
3052 (set-buffer-modified-p t))
3053 ;; Update the major mode, if the file name determines it.
3054 (condition-case nil
3055 ;; Don't change the mode if it is special.
3056 (or (not change-major-mode-with-file-name)
3057 (get major-mode 'mode-class)
3058 ;; Don't change the mode if the local variable list specifies it.
3059 (hack-local-variables t)
3060 (set-auto-mode t))
3061 (error nil)))
3063 (defun write-file (filename &optional confirm)
3064 "Write current buffer into file FILENAME.
3065 This makes the buffer visit that file, and marks it as not modified.
3067 If you specify just a directory name as FILENAME, that means to use
3068 the default file name but in that directory. You can also yank
3069 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3071 If the buffer is not already visiting a file, the default file name
3072 for the output file is the buffer name.
3074 If optional second arg CONFIRM is non-nil, this function
3075 asks for confirmation before overwriting an existing file.
3076 Interactively, confirmation is required unless you supply a prefix argument."
3077 ;; (interactive "FWrite file: ")
3078 (interactive
3079 (list (if buffer-file-name
3080 (read-file-name "Write file: "
3081 nil nil nil nil)
3082 (read-file-name "Write file: " default-directory
3083 (expand-file-name
3084 (file-name-nondirectory (buffer-name))
3085 default-directory)
3086 nil nil))
3087 (not current-prefix-arg)))
3088 (or (null filename) (string-equal filename "")
3089 (progn
3090 ;; If arg is just a directory,
3091 ;; use the default file name, but in that directory.
3092 (if (file-directory-p filename)
3093 (setq filename (concat (file-name-as-directory filename)
3094 (file-name-nondirectory
3095 (or buffer-file-name (buffer-name))))))
3096 (and confirm
3097 (file-exists-p filename)
3098 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3099 (error "Canceled")))
3100 (set-visited-file-name filename (not confirm))))
3101 (set-buffer-modified-p t)
3102 ;; Make buffer writable if file is writable.
3103 (and buffer-file-name
3104 (file-writable-p buffer-file-name)
3105 (setq buffer-read-only nil))
3106 (save-buffer)
3107 ;; It's likely that the VC status at the new location is different from
3108 ;; the one at the old location.
3109 (vc-find-file-hook))
3111 (defun backup-buffer ()
3112 "Make a backup of the disk file visited by the current buffer, if appropriate.
3113 This is normally done before saving the buffer the first time.
3115 A backup may be done by renaming or by copying; see documentation of
3116 variable `make-backup-files'. If it's done by renaming, then the file is
3117 no longer accessible under its old name.
3119 The value is non-nil after a backup was made by renaming.
3120 It has the form (MODES . BACKUPNAME).
3121 MODES is the result of `file-modes' on the original
3122 file; this means that the caller, after saving the buffer, should change
3123 the modes of the new file to agree with the old modes.
3124 BACKUPNAME is the backup file name, which is the old file renamed."
3125 (if (and make-backup-files (not backup-inhibited)
3126 (not buffer-backed-up)
3127 (file-exists-p buffer-file-name)
3128 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3129 '(?- ?l)))
3130 (let ((real-file-name buffer-file-name)
3131 backup-info backupname targets setmodes)
3132 ;; If specified name is a symbolic link, chase it to the target.
3133 ;; Thus we make the backups in the directory where the real file is.
3134 (setq real-file-name (file-chase-links real-file-name))
3135 (setq backup-info (find-backup-file-name real-file-name)
3136 backupname (car backup-info)
3137 targets (cdr backup-info))
3138 ;; (if (file-directory-p buffer-file-name)
3139 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3140 (if backup-info
3141 (condition-case ()
3142 (let ((delete-old-versions
3143 ;; If have old versions to maybe delete,
3144 ;; ask the user to confirm now, before doing anything.
3145 ;; But don't actually delete til later.
3146 (and targets
3147 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3148 (or delete-old-versions
3149 (y-or-n-p (format "Delete excess backup versions of %s? "
3150 real-file-name)))))
3151 (modes (file-modes buffer-file-name)))
3152 ;; Actually write the back up file.
3153 (condition-case ()
3154 (if (or file-precious-flag
3155 ; (file-symlink-p buffer-file-name)
3156 backup-by-copying
3157 ;; Don't rename a suid or sgid file.
3158 (and modes (< 0 (logand modes #o6000)))
3159 (not (file-writable-p (file-name-directory real-file-name)))
3160 (and backup-by-copying-when-linked
3161 (> (file-nlinks real-file-name) 1))
3162 (and (or backup-by-copying-when-mismatch
3163 (integerp backup-by-copying-when-privileged-mismatch))
3164 (let ((attr (file-attributes real-file-name)))
3165 (and (or backup-by-copying-when-mismatch
3166 (and (integerp (nth 2 attr))
3167 (integerp backup-by-copying-when-privileged-mismatch)
3168 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3169 (or (nth 9 attr)
3170 (not (file-ownership-preserved-p real-file-name)))))))
3171 (backup-buffer-copy real-file-name backupname modes)
3172 ;; rename-file should delete old backup.
3173 (rename-file real-file-name backupname t)
3174 (setq setmodes (cons modes backupname)))
3175 (file-error
3176 ;; If trouble writing the backup, write it in ~.
3177 (setq backupname (expand-file-name
3178 (convert-standard-filename
3179 "~/%backup%~")))
3180 (message "Cannot write backup file; backing up in %s"
3181 backupname)
3182 (sleep-for 1)
3183 (backup-buffer-copy real-file-name backupname modes)))
3184 (setq buffer-backed-up t)
3185 ;; Now delete the old versions, if desired.
3186 (if delete-old-versions
3187 (while targets
3188 (condition-case ()
3189 (delete-file (car targets))
3190 (file-error nil))
3191 (setq targets (cdr targets))))
3192 setmodes)
3193 (file-error nil))))))
3195 (defun backup-buffer-copy (from-name to-name modes)
3196 (let ((umask (default-file-modes)))
3197 (unwind-protect
3198 (progn
3199 ;; Create temp files with strict access rights. It's easy to
3200 ;; loosen them later, whereas it's impossible to close the
3201 ;; time-window of loose permissions otherwise.
3202 (set-default-file-modes ?\700)
3203 (when (condition-case nil
3204 ;; Try to overwrite old backup first.
3205 (copy-file from-name to-name t t)
3206 (error t))
3207 (while (condition-case nil
3208 (progn
3209 (when (file-exists-p to-name)
3210 (delete-file to-name))
3211 (copy-file from-name to-name nil t)
3212 nil)
3213 (file-already-exists t))
3214 ;; The file was somehow created by someone else between
3215 ;; `delete-file' and `copy-file', so let's try again.
3216 ;; rms says "I think there is also a possible race
3217 ;; condition for making backup files" (emacs-devel 20070821).
3218 nil)))
3219 ;; Reset the umask.
3220 (set-default-file-modes umask)))
3221 (and modes
3222 (set-file-modes to-name (logand modes #o1777))))
3224 (defun file-name-sans-versions (name &optional keep-backup-version)
3225 "Return file NAME sans backup versions or strings.
3226 This is a separate procedure so your site-init or startup file can
3227 redefine it.
3228 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3229 we do not remove backup version numbers, only true file version numbers."
3230 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3231 (if handler
3232 (funcall handler 'file-name-sans-versions name keep-backup-version)
3233 (substring name 0
3234 (if (eq system-type 'vax-vms)
3235 ;; VMS version number is (a) semicolon, optional
3236 ;; sign, zero or more digits or (b) period, option
3237 ;; sign, zero or more digits, provided this is the
3238 ;; second period encountered outside of the
3239 ;; device/directory part of the file name.
3240 (or (string-match ";[-+]?[0-9]*\\'" name)
3241 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
3242 name)
3243 (match-beginning 1))
3244 (length name))
3245 (if keep-backup-version
3246 (length name)
3247 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3248 (string-match "~\\'" name)
3249 (length name))))))))
3251 (defun file-ownership-preserved-p (file)
3252 "Return t if deleting FILE and rewriting it would preserve the owner."
3253 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3254 (if handler
3255 (funcall handler 'file-ownership-preserved-p file)
3256 (let ((attributes (file-attributes file)))
3257 ;; Return t if the file doesn't exist, since it's true that no
3258 ;; information would be lost by an (attempted) delete and create.
3259 (or (null attributes)
3260 (= (nth 2 attributes) (user-uid)))))))
3262 (defun file-name-sans-extension (filename)
3263 "Return FILENAME sans final \"extension\".
3264 The extension, in a file name, is the part that follows the last `.',
3265 except that a leading `.', if any, doesn't count."
3266 (save-match-data
3267 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3268 directory)
3269 (if (and (string-match "\\.[^.]*\\'" file)
3270 (not (eq 0 (match-beginning 0))))
3271 (if (setq directory (file-name-directory filename))
3272 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3273 ;; we don't want to expand it.
3274 (concat directory (substring file 0 (match-beginning 0)))
3275 (substring file 0 (match-beginning 0)))
3276 filename))))
3278 (defun file-name-extension (filename &optional period)
3279 "Return FILENAME's final \"extension\".
3280 The extension, in a file name, is the part that follows the last `.',
3281 excluding version numbers and backup suffixes,
3282 except that a leading `.', if any, doesn't count.
3283 Return nil for extensionless file names such as `foo'.
3284 Return the empty string for file names such as `foo.'.
3286 If PERIOD is non-nil, then the returned value includes the period
3287 that delimits the extension, and if FILENAME has no extension,
3288 the value is \"\"."
3289 (save-match-data
3290 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3291 (if (and (string-match "\\.[^.]*\\'" file)
3292 (not (eq 0 (match-beginning 0))))
3293 (substring file (+ (match-beginning 0) (if period 0 1)))
3294 (if period
3295 "")))))
3297 (defcustom make-backup-file-name-function nil
3298 "A function to use instead of the default `make-backup-file-name'.
3299 A value of nil gives the default `make-backup-file-name' behavior.
3301 This could be buffer-local to do something special for specific
3302 files. If you define it, you may need to change `backup-file-name-p'
3303 and `file-name-sans-versions' too.
3305 See also `backup-directory-alist'."
3306 :group 'backup
3307 :type '(choice (const :tag "Default" nil)
3308 (function :tag "Your function")))
3310 (defcustom backup-directory-alist nil
3311 "Alist of filename patterns and backup directory names.
3312 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3313 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3314 relative or absolute. If it is absolute, so that all matching files
3315 are backed up into the same directory, the file names in this
3316 directory will be the full name of the file backed up with all
3317 directory separators changed to `!' to prevent clashes. This will not
3318 work correctly if your filesystem truncates the resulting name.
3320 For the common case of all backups going into one directory, the alist
3321 should contain a single element pairing \".\" with the appropriate
3322 directory name.
3324 If this variable is nil, or it fails to match a filename, the backup
3325 is made in the original file's directory.
3327 On MS-DOS filesystems without long names this variable is always
3328 ignored."
3329 :group 'backup
3330 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3331 (directory :tag "Backup directory name"))))
3333 (defun normal-backup-enable-predicate (name)
3334 "Default `backup-enable-predicate' function.
3335 Checks for files in `temporary-file-directory',
3336 `small-temporary-file-directory', and /tmp."
3337 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3338 name 0 nil)))
3339 ;; Directory is under temporary-file-directory.
3340 (and (not (eq comp t))
3341 (< comp (- (length temporary-file-directory)))))
3342 (let ((comp (compare-strings "/tmp" 0 nil
3343 name 0 nil)))
3344 ;; Directory is under /tmp.
3345 (and (not (eq comp t))
3346 (< comp (- (length "/tmp")))))
3347 (if small-temporary-file-directory
3348 (let ((comp (compare-strings small-temporary-file-directory
3349 0 nil
3350 name 0 nil)))
3351 ;; Directory is under small-temporary-file-directory.
3352 (and (not (eq comp t))
3353 (< comp (- (length small-temporary-file-directory)))))))))
3355 (defun make-backup-file-name (file)
3356 "Create the non-numeric backup file name for FILE.
3357 Normally this will just be the file's name with `~' appended.
3358 Customization hooks are provided as follows.
3360 If the variable `make-backup-file-name-function' is non-nil, its value
3361 should be a function which will be called with FILE as its argument;
3362 the resulting name is used.
3364 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3365 the documentation of that variable. If the directory for the backup
3366 doesn't exist, it is created."
3367 (if make-backup-file-name-function
3368 (funcall make-backup-file-name-function file)
3369 (if (and (eq system-type 'ms-dos)
3370 (not (msdos-long-file-names)))
3371 (let ((fn (file-name-nondirectory file)))
3372 (concat (file-name-directory file)
3373 (or (and (string-match "\\`[^.]+\\'" fn)
3374 (concat (match-string 0 fn) ".~"))
3375 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3376 (concat (match-string 0 fn) "~")))))
3377 (concat (make-backup-file-name-1 file) "~"))))
3379 (defun make-backup-file-name-1 (file)
3380 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3381 (let ((alist backup-directory-alist)
3382 elt backup-directory abs-backup-directory)
3383 (while alist
3384 (setq elt (pop alist))
3385 (if (string-match (car elt) file)
3386 (setq backup-directory (cdr elt)
3387 alist nil)))
3388 ;; If backup-directory is relative, it should be relative to the
3389 ;; file's directory. By expanding explicitly here, we avoid
3390 ;; depending on default-directory.
3391 (if backup-directory
3392 (setq abs-backup-directory
3393 (expand-file-name backup-directory
3394 (file-name-directory file))))
3395 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3396 (condition-case nil
3397 (make-directory abs-backup-directory 'parents)
3398 (file-error (setq backup-directory nil
3399 abs-backup-directory nil))))
3400 (if (null backup-directory)
3401 file
3402 (if (file-name-absolute-p backup-directory)
3403 (progn
3404 (when (memq system-type '(windows-nt ms-dos cygwin))
3405 ;; Normalize DOSish file names: downcase the drive
3406 ;; letter, if any, and replace the leading "x:" with
3407 ;; "/drive_x".
3408 (or (file-name-absolute-p file)
3409 (setq file (expand-file-name file))) ; make defaults explicit
3410 ;; Replace any invalid file-name characters (for the
3411 ;; case of backing up remote files).
3412 (setq file (expand-file-name (convert-standard-filename file)))
3413 (if (eq (aref file 1) ?:)
3414 (setq file (concat "/"
3415 "drive_"
3416 (char-to-string (downcase (aref file 0)))
3417 (if (eq (aref file 2) ?/)
3419 "/")
3420 (substring file 2)))))
3421 ;; Make the name unique by substituting directory
3422 ;; separators. It may not really be worth bothering about
3423 ;; doubling `!'s in the original name...
3424 (expand-file-name
3425 (subst-char-in-string
3426 ?/ ?!
3427 (replace-regexp-in-string "!" "!!" file))
3428 backup-directory))
3429 (expand-file-name (file-name-nondirectory file)
3430 (file-name-as-directory abs-backup-directory))))))
3432 (defun backup-file-name-p (file)
3433 "Return non-nil if FILE is a backup file name (numeric or not).
3434 This is a separate function so you can redefine it for customization.
3435 You may need to redefine `file-name-sans-versions' as well."
3436 (string-match "~\\'" file))
3438 (defvar backup-extract-version-start)
3440 ;; This is used in various files.
3441 ;; The usage of backup-extract-version-start is not very clean,
3442 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3443 (defun backup-extract-version (fn)
3444 "Given the name of a numeric backup file, FN, return the backup number.
3445 Uses the free variable `backup-extract-version-start', whose value should be
3446 the index in the name where the version number begins."
3447 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
3448 (= (match-beginning 0) backup-extract-version-start))
3449 (string-to-number (substring fn backup-extract-version-start -1))
3452 ;; I believe there is no need to alter this behavior for VMS;
3453 ;; since backup files are not made on VMS, it should not get called.
3454 (defun find-backup-file-name (fn)
3455 "Find a file name for a backup file FN, and suggestions for deletions.
3456 Value is a list whose car is the name for the backup file
3457 and whose cdr is a list of old versions to consider deleting now.
3458 If the value is nil, don't make a backup.
3459 Uses `backup-directory-alist' in the same way as does
3460 `make-backup-file-name'."
3461 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3462 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3463 (if handler
3464 (funcall handler 'find-backup-file-name fn)
3465 (if (or (eq version-control 'never)
3466 ;; We don't support numbered backups on plain MS-DOS
3467 ;; when long file names are unavailable.
3468 (and (eq system-type 'ms-dos)
3469 (not (msdos-long-file-names))))
3470 (list (make-backup-file-name fn))
3471 (let* ((basic-name (make-backup-file-name-1 fn))
3472 (base-versions (concat (file-name-nondirectory basic-name)
3473 ".~"))
3474 (backup-extract-version-start (length base-versions))
3475 (high-water-mark 0)
3476 (number-to-delete 0)
3477 possibilities deserve-versions-p versions)
3478 (condition-case ()
3479 (setq possibilities (file-name-all-completions
3480 base-versions
3481 (file-name-directory basic-name))
3482 versions (sort (mapcar #'backup-extract-version
3483 possibilities)
3484 #'<)
3485 high-water-mark (apply 'max 0 versions)
3486 deserve-versions-p (or version-control
3487 (> high-water-mark 0))
3488 number-to-delete (- (length versions)
3489 kept-old-versions
3490 kept-new-versions
3491 -1))
3492 (file-error (setq possibilities nil)))
3493 (if (not deserve-versions-p)
3494 (list (make-backup-file-name fn))
3495 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3496 (if (and (> number-to-delete 0)
3497 ;; Delete nothing if there is overflow
3498 ;; in the number of versions to keep.
3499 (>= (+ kept-new-versions kept-old-versions -1) 0))
3500 (mapcar (lambda (n)
3501 (format "%s.~%d~" basic-name n))
3502 (let ((v (nthcdr kept-old-versions versions)))
3503 (rplacd (nthcdr (1- number-to-delete) v) ())
3504 v))))))))))
3506 (defun file-nlinks (filename)
3507 "Return number of names file FILENAME has."
3508 (car (cdr (file-attributes filename))))
3510 ;; (defun file-relative-name (filename &optional directory)
3511 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3512 ;; This function returns a relative file name which is equivalent to FILENAME
3513 ;; when used with that default directory as the default.
3514 ;; If this is impossible (which can happen on MSDOS and Windows
3515 ;; when the file name and directory use different drive names)
3516 ;; then it returns FILENAME."
3517 ;; (save-match-data
3518 ;; (let ((fname (expand-file-name filename)))
3519 ;; (setq directory (file-name-as-directory
3520 ;; (expand-file-name (or directory default-directory))))
3521 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3522 ;; ;; drive names, they can't be relative, so return the absolute name.
3523 ;; (if (and (or (eq system-type 'ms-dos)
3524 ;; (eq system-type 'cygwin)
3525 ;; (eq system-type 'windows-nt))
3526 ;; (not (string-equal (substring fname 0 2)
3527 ;; (substring directory 0 2))))
3528 ;; filename
3529 ;; (let ((ancestor ".")
3530 ;; (fname-dir (file-name-as-directory fname)))
3531 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3532 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3533 ;; (setq directory (file-name-directory (substring directory 0 -1))
3534 ;; ancestor (if (equal ancestor ".")
3535 ;; ".."
3536 ;; (concat "../" ancestor))))
3537 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3538 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3539 ;; ;; We matched within FNAME's directory part.
3540 ;; ;; Add the rest of FNAME onto ANCESTOR.
3541 ;; (let ((rest (substring fname (match-end 0))))
3542 ;; (if (and (equal ancestor ".")
3543 ;; (not (equal rest "")))
3544 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3545 ;; rest
3546 ;; (concat (file-name-as-directory ancestor) rest)))
3547 ;; ;; We matched FNAME's directory equivalent.
3548 ;; ancestor))))))
3550 (defun file-relative-name (filename &optional directory)
3551 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3552 This function returns a relative file name which is equivalent to FILENAME
3553 when used with that default directory as the default.
3554 If FILENAME and DIRECTORY lie on different machines or on different drives
3555 on a DOS/Windows machine, it returns FILENAME in expanded form."
3556 (save-match-data
3557 (setq directory
3558 (file-name-as-directory (expand-file-name (or directory
3559 default-directory))))
3560 (setq filename (expand-file-name filename))
3561 (let ((fremote (file-remote-p filename))
3562 (dremote (file-remote-p directory)))
3563 (if ;; Conditions for separate trees
3565 ;; Test for different drives on DOS/Windows
3566 (and
3567 ;; Should `cygwin' really be included here? --stef
3568 (memq system-type '(ms-dos cygwin windows-nt))
3569 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3570 ;; Test for different remote file system identification
3571 (not (equal fremote dremote)))
3572 filename
3573 (let ((ancestor ".")
3574 (filename-dir (file-name-as-directory filename)))
3575 (while (not
3577 (eq t (compare-strings filename-dir nil (length directory)
3578 directory nil nil case-fold-search))
3579 (eq t (compare-strings filename nil (length directory)
3580 directory nil nil case-fold-search))))
3581 (setq directory (file-name-directory (substring directory 0 -1))
3582 ancestor (if (equal ancestor ".")
3583 ".."
3584 (concat "../" ancestor))))
3585 ;; Now ancestor is empty, or .., or ../.., etc.
3586 (if (eq t (compare-strings filename nil (length directory)
3587 directory nil nil case-fold-search))
3588 ;; We matched within FILENAME's directory part.
3589 ;; Add the rest of FILENAME onto ANCESTOR.
3590 (let ((rest (substring filename (length directory))))
3591 (if (and (equal ancestor ".") (not (equal rest "")))
3592 ;; But don't bother with ANCESTOR if it would give us `./'.
3593 rest
3594 (concat (file-name-as-directory ancestor) rest)))
3595 ;; We matched FILENAME's directory equivalent.
3596 ancestor))))))
3598 (defun save-buffer (&optional args)
3599 "Save current buffer in visited file if modified.
3600 Variations are described below.
3602 By default, makes the previous version into a backup file
3603 if previously requested or if this is the first save.
3604 Prefixed with one \\[universal-argument], marks this version
3605 to become a backup when the next save is done.
3606 Prefixed with two \\[universal-argument]'s,
3607 unconditionally makes the previous version into a backup file.
3608 Prefixed with three \\[universal-argument]'s, marks this version
3609 to become a backup when the next save is done,
3610 and unconditionally makes the previous version into a backup file.
3612 With a numeric argument of 0, never make the previous version
3613 into a backup file.
3615 If a file's name is FOO, the names of its numbered backup versions are
3616 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3617 Numeric backups (rather than FOO~) will be made if value of
3618 `version-control' is not the atom `never' and either there are already
3619 numeric versions of the file being backed up, or `version-control' is
3620 non-nil.
3621 We don't want excessive versions piling up, so there are variables
3622 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3623 and `kept-new-versions', which tells how many newest versions to keep.
3624 Defaults are 2 old versions and 2 new.
3625 `dired-kept-versions' controls dired's clean-directory (.) command.
3626 If `delete-old-versions' is nil, system will query user
3627 before trimming versions. Otherwise it does it silently.
3629 If `vc-make-backup-files' is nil, which is the default,
3630 no backup files are made for files managed by version control.
3631 (This is because the version control system itself records previous versions.)
3633 See the subroutine `basic-save-buffer' for more information."
3634 (interactive "p")
3635 (let ((modp (buffer-modified-p))
3636 (large (> (buffer-size) 50000))
3637 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3638 (memq args '(16 64)))))
3639 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3640 (if (and modp large (buffer-file-name))
3641 (message "Saving file %s..." (buffer-file-name)))
3642 (basic-save-buffer)
3643 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3645 (defun delete-auto-save-file-if-necessary (&optional force)
3646 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3647 Normally delete only if the file was written by this Emacs since
3648 the last real save, but optional arg FORCE non-nil means delete anyway."
3649 (and buffer-auto-save-file-name delete-auto-save-files
3650 (not (string= buffer-file-name buffer-auto-save-file-name))
3651 (or force (recent-auto-save-p))
3652 (progn
3653 (condition-case ()
3654 (delete-file buffer-auto-save-file-name)
3655 (file-error nil))
3656 (set-buffer-auto-saved))))
3658 (defvar auto-save-hook nil
3659 "Normal hook run just before auto-saving.")
3661 (defcustom before-save-hook nil
3662 "Normal hook that is run before a buffer is saved to its file."
3663 :options '(copyright-update time-stamp)
3664 :type 'hook
3665 :group 'files)
3667 (defcustom after-save-hook nil
3668 "Normal hook that is run after a buffer is saved to its file."
3669 :options '(executable-make-buffer-file-executable-if-script-p)
3670 :type 'hook
3671 :group 'files)
3673 (defvar save-buffer-coding-system nil
3674 "If non-nil, use this coding system for saving the buffer.
3675 More precisely, use this coding system in place of the
3676 value of `buffer-file-coding-system', when saving the buffer.
3677 Calling `write-region' for any purpose other than saving the buffer
3678 will still use `buffer-file-coding-system'; this variable has no effect
3679 in such cases.")
3681 (make-variable-buffer-local 'save-buffer-coding-system)
3682 (put 'save-buffer-coding-system 'permanent-local t)
3684 (defun basic-save-buffer ()
3685 "Save the current buffer in its visited file, if it has been modified.
3686 The hooks `write-contents-functions' and `write-file-functions' get a chance
3687 to do the job of saving; if they do not, then the buffer is saved in
3688 the visited file in the usual way.
3689 Before and after saving the buffer, this function runs
3690 `before-save-hook' and `after-save-hook', respectively."
3691 (interactive)
3692 (save-current-buffer
3693 ;; In an indirect buffer, save its base buffer instead.
3694 (if (buffer-base-buffer)
3695 (set-buffer (buffer-base-buffer)))
3696 (if (buffer-modified-p)
3697 (let ((recent-save (recent-auto-save-p))
3698 setmodes)
3699 ;; On VMS, rename file and buffer to get rid of version number.
3700 (if (and (eq system-type 'vax-vms)
3701 (not (string= buffer-file-name
3702 (file-name-sans-versions buffer-file-name))))
3703 (let (buffer-new-name)
3704 ;; Strip VMS version number before save.
3705 (setq buffer-file-name
3706 (file-name-sans-versions buffer-file-name))
3707 ;; Construct a (unique) buffer name to correspond.
3708 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3709 (setq buffer-new-name (buffer-name buf))
3710 (kill-buffer buf))
3711 (rename-buffer buffer-new-name)))
3712 ;; If buffer has no file name, ask user for one.
3713 (or buffer-file-name
3714 (let ((filename
3715 (expand-file-name
3716 (read-file-name "File to save in: ") nil)))
3717 (if (file-exists-p filename)
3718 (if (file-directory-p filename)
3719 ;; Signal an error if the user specified the name of an
3720 ;; existing directory.
3721 (error "%s is a directory" filename)
3722 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3723 filename))
3724 (error "Canceled")))
3725 ;; Signal an error if the specified name refers to a
3726 ;; non-existing directory.
3727 (let ((dir (file-name-directory filename)))
3728 (unless (file-directory-p dir)
3729 (if (file-exists-p dir)
3730 (error "%s is not a directory" dir)
3731 (error "%s: no such directory" dir)))))
3732 (set-visited-file-name filename)))
3733 (or (verify-visited-file-modtime (current-buffer))
3734 (not (file-exists-p buffer-file-name))
3735 (yes-or-no-p
3736 (format "%s has changed since visited or saved. Save anyway? "
3737 (file-name-nondirectory buffer-file-name)))
3738 (error "Save not confirmed"))
3739 (save-restriction
3740 (widen)
3741 (save-excursion
3742 (and (> (point-max) (point-min))
3743 (not find-file-literally)
3744 (/= (char-after (1- (point-max))) ?\n)
3745 (not (and (eq selective-display t)
3746 (= (char-after (1- (point-max))) ?\r)))
3747 (or (eq require-final-newline t)
3748 (eq require-final-newline 'visit-save)
3749 (and require-final-newline
3750 (y-or-n-p
3751 (format "Buffer %s does not end in newline. Add one? "
3752 (buffer-name)))))
3753 (save-excursion
3754 (goto-char (point-max))
3755 (insert ?\n))))
3756 ;; Support VC version backups.
3757 (vc-before-save)
3758 (run-hooks 'before-save-hook)
3759 (or (run-hook-with-args-until-success 'write-contents-functions)
3760 (run-hook-with-args-until-success 'local-write-file-hooks)
3761 (run-hook-with-args-until-success 'write-file-functions)
3762 ;; If a hook returned t, file is already "written".
3763 ;; Otherwise, write it the usual way now.
3764 (setq setmodes (basic-save-buffer-1)))
3765 ;; Now we have saved the current buffer. Let's make sure
3766 ;; that buffer-file-coding-system is fixed to what
3767 ;; actually used for saving by binding it locally.
3768 (if save-buffer-coding-system
3769 (setq save-buffer-coding-system last-coding-system-used)
3770 (setq buffer-file-coding-system last-coding-system-used))
3771 (setq buffer-file-number
3772 (nthcdr 10 (file-attributes buffer-file-name)))
3773 (if setmodes
3774 (condition-case ()
3775 (set-file-modes buffer-file-name (car setmodes))
3776 (error nil))))
3777 ;; If the auto-save file was recent before this command,
3778 ;; delete it now.
3779 (delete-auto-save-file-if-necessary recent-save)
3780 ;; Support VC `implicit' locking.
3781 (vc-after-save)
3782 (run-hooks 'after-save-hook))
3783 (message "(No changes need to be saved)"))))
3785 ;; This does the "real job" of writing a buffer into its visited file
3786 ;; and making a backup file. This is what is normally done
3787 ;; but inhibited if one of write-file-functions returns non-nil.
3788 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3789 (defun basic-save-buffer-1 ()
3790 (prog1
3791 (if save-buffer-coding-system
3792 (let ((coding-system-for-write save-buffer-coding-system))
3793 (basic-save-buffer-2))
3794 (basic-save-buffer-2))
3795 (setq buffer-file-coding-system-explicit last-coding-system-used)))
3797 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3798 (defun basic-save-buffer-2 ()
3799 (let (tempsetmodes setmodes)
3800 (if (not (file-writable-p buffer-file-name))
3801 (let ((dir (file-name-directory buffer-file-name)))
3802 (if (not (file-directory-p dir))
3803 (if (file-exists-p dir)
3804 (error "%s is not a directory" dir)
3805 (error "%s: no such directory" dir))
3806 (if (not (file-exists-p buffer-file-name))
3807 (error "Directory %s write-protected" dir)
3808 (if (yes-or-no-p
3809 (format "File %s is write-protected; try to save anyway? "
3810 (file-name-nondirectory
3811 buffer-file-name)))
3812 (setq tempsetmodes t)
3813 (error "Attempt to save to a file which you aren't allowed to write"))))))
3814 (or buffer-backed-up
3815 (setq setmodes (backup-buffer)))
3816 (let ((dir (file-name-directory buffer-file-name)))
3817 (if (and file-precious-flag
3818 (file-writable-p dir))
3819 ;; If file is precious, write temp name, then rename it.
3820 ;; This requires write access to the containing dir,
3821 ;; which is why we don't try it if we don't have that access.
3822 (let ((realname buffer-file-name)
3823 tempname succeed
3824 (umask (default-file-modes))
3825 (old-modtime (visited-file-modtime)))
3826 ;; Create temp files with strict access rights. It's easy to
3827 ;; loosen them later, whereas it's impossible to close the
3828 ;; time-window of loose permissions otherwise.
3829 (unwind-protect
3830 (progn
3831 (clear-visited-file-modtime)
3832 (set-default-file-modes ?\700)
3833 ;; Try various temporary names.
3834 ;; This code follows the example of make-temp-file,
3835 ;; but it calls write-region in the appropriate way
3836 ;; for saving the buffer.
3837 (while (condition-case ()
3838 (progn
3839 (setq tempname
3840 (make-temp-name
3841 (expand-file-name "tmp" dir)))
3842 (write-region (point-min) (point-max)
3843 tempname nil realname
3844 buffer-file-truename 'excl)
3845 nil)
3846 (file-already-exists t))
3847 ;; The file was somehow created by someone else between
3848 ;; `make-temp-name' and `write-region', let's try again.
3849 nil)
3850 (setq succeed t))
3851 ;; Reset the umask.
3852 (set-default-file-modes umask)
3853 ;; If we failed, restore the buffer's modtime.
3854 (unless succeed
3855 (set-visited-file-modtime old-modtime)))
3856 ;; Since we have created an entirely new file,
3857 ;; make sure it gets the right permission bits set.
3858 (setq setmodes (or setmodes
3859 (cons (or (file-modes buffer-file-name)
3860 (logand ?\666 umask))
3861 buffer-file-name)))
3862 ;; We succeeded in writing the temp file,
3863 ;; so rename it.
3864 (rename-file tempname buffer-file-name t))
3865 ;; If file not writable, see if we can make it writable
3866 ;; temporarily while we write it.
3867 ;; But no need to do so if we have just backed it up
3868 ;; (setmodes is set) because that says we're superseding.
3869 (cond ((and tempsetmodes (not setmodes))
3870 ;; Change the mode back, after writing.
3871 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3872 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3873 (let (success)
3874 (unwind-protect
3875 (progn
3876 (write-region (point-min) (point-max)
3877 buffer-file-name nil t buffer-file-truename)
3878 (setq success t))
3879 ;; If we get an error writing the new file, and we made
3880 ;; the backup by renaming, undo the backing-up.
3881 (and setmodes (not success)
3882 (progn
3883 (rename-file (cdr setmodes) buffer-file-name t)
3884 (setq buffer-backed-up nil)))))))
3885 setmodes))
3887 (defun diff-buffer-with-file (&optional buffer)
3888 "View the differences between BUFFER and its associated file.
3889 This requires the external program `diff' to be in your `exec-path'."
3890 (interactive "bBuffer: ")
3891 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3892 (if (and buffer-file-name
3893 (file-exists-p buffer-file-name))
3894 (let ((tempfile (make-temp-file "buffer-content-")))
3895 (unwind-protect
3896 (save-restriction
3897 (widen)
3898 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3899 (diff buffer-file-name tempfile nil t)
3900 (sit-for 0))
3901 (when (file-exists-p tempfile)
3902 (delete-file tempfile))))
3903 (message "Buffer %s has no associated file on disc" (buffer-name))
3904 ;; Display that message for 1 second so that user can read it
3905 ;; in the minibuffer.
3906 (sit-for 1)))
3907 ;; return always nil, so that save-buffers-kill-emacs will not move
3908 ;; over to the next unsaved buffer when calling `d'.
3909 nil)
3911 (defvar save-some-buffers-action-alist
3912 '((?\C-r
3913 (lambda (buf)
3914 (view-buffer buf
3915 (lambda (ignore)
3916 (exit-recursive-edit)))
3917 (recursive-edit)
3918 ;; Return nil to ask about BUF again.
3919 nil)
3920 "view this buffer")
3921 (?d (lambda (buf)
3922 (save-window-excursion
3923 (diff-buffer-with-file buf))
3924 (view-buffer (get-buffer-create "*Diff*")
3925 (lambda (ignore) (exit-recursive-edit)))
3926 (recursive-edit)
3927 nil)
3928 "view changes in this buffer"))
3929 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3931 (defvar buffer-save-without-query nil
3932 "Non-nil means `save-some-buffers' should save this buffer without asking.")
3933 (make-variable-buffer-local 'buffer-save-without-query)
3935 (defun save-some-buffers (&optional arg pred)
3936 "Save some modified file-visiting buffers. Asks user about each one.
3937 You can answer `y' to save, `n' not to save, `C-r' to look at the
3938 buffer in question with `view-buffer' before deciding or `d' to
3939 view the differences using `diff-buffer-with-file'.
3941 Optional argument (the prefix) non-nil means save all with no questions.
3942 Optional second argument PRED determines which buffers are considered:
3943 If PRED is nil, all the file-visiting buffers are considered.
3944 If PRED is t, then certain non-file buffers will also be considered.
3945 If PRED is a zero-argument function, it indicates for each buffer whether
3946 to consider it or not when called with that buffer current.
3948 See `save-some-buffers-action-alist' if you want to
3949 change the additional actions you can take on files."
3950 (interactive "P")
3951 (save-window-excursion
3952 (let* (queried some-automatic
3953 files-done abbrevs-done)
3954 (dolist (buffer (buffer-list))
3955 ;; First save any buffers that we're supposed to save unconditionally.
3956 ;; That way the following code won't ask about them.
3957 (with-current-buffer buffer
3958 (when (and buffer-save-without-query (buffer-modified-p))
3959 (setq some-automatic t)
3960 (save-buffer))))
3961 ;; Ask about those buffers that merit it,
3962 ;; and record the number thus saved.
3963 (setq files-done
3964 (map-y-or-n-p
3965 (function
3966 (lambda (buffer)
3967 (and (buffer-modified-p buffer)
3968 (not (buffer-base-buffer buffer))
3970 (buffer-file-name buffer)
3971 (and pred
3972 (progn
3973 (set-buffer buffer)
3974 (and buffer-offer-save (> (buffer-size) 0)))))
3975 (or (not (functionp pred))
3976 (with-current-buffer buffer (funcall pred)))
3977 (if arg
3979 (setq queried t)
3980 (if (buffer-file-name buffer)
3981 (format "Save file %s? "
3982 (buffer-file-name buffer))
3983 (format "Save buffer %s? "
3984 (buffer-name buffer)))))))
3985 (function
3986 (lambda (buffer)
3987 (set-buffer buffer)
3988 (save-buffer)))
3989 (buffer-list)
3990 '("buffer" "buffers" "save")
3991 save-some-buffers-action-alist))
3992 ;; Maybe to save abbrevs, and record whether
3993 ;; we either saved them or asked to.
3994 (and save-abbrevs abbrevs-changed
3995 (progn
3996 (if (or arg
3997 (eq save-abbrevs 'silently)
3998 (y-or-n-p (format "Save abbrevs in %s? "
3999 abbrev-file-name)))
4000 (write-abbrev-file nil))
4001 ;; Don't keep bothering user if he says no.
4002 (setq abbrevs-changed nil)
4003 (setq abbrevs-done t)))
4004 (or queried (> files-done 0) abbrevs-done
4005 (message (if some-automatic
4006 "(Some special files were saved without asking)"
4007 "(No files need saving)"))))))
4009 (defun not-modified (&optional arg)
4010 "Mark current buffer as unmodified, not needing to be saved.
4011 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
4013 It is not a good idea to use this function in Lisp programs, because it
4014 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4015 (interactive "P")
4016 (message (if arg "Modification-flag set"
4017 "Modification-flag cleared"))
4018 (set-buffer-modified-p arg))
4020 (defun toggle-read-only (&optional arg)
4021 "Change whether this buffer is visiting its file read-only.
4022 With prefix argument ARG, make the buffer read-only if ARG is
4023 positive, otherwise make it writable. If visiting file read-only
4024 and `view-read-only' is non-nil, enter view mode."
4025 (interactive "P")
4026 (if (and arg
4027 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4028 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4029 nil ; do nothing.
4030 ;; Toggle.
4031 (cond
4032 ((and buffer-read-only view-mode)
4033 (View-exit-and-edit)
4034 (make-local-variable 'view-read-only)
4035 (setq view-read-only t)) ; Must leave view mode.
4036 ((and (not buffer-read-only) view-read-only
4037 ;; If view-mode is already active, `view-mode-enter' is a nop.
4038 (not view-mode)
4039 (not (eq (get major-mode 'mode-class) 'special)))
4040 (view-mode-enter))
4041 (t (setq buffer-read-only (not buffer-read-only))
4042 (force-mode-line-update)))
4043 (if (vc-backend buffer-file-name)
4044 (message "%s" (substitute-command-keys
4045 (concat "File is under version-control; "
4046 "use \\[vc-next-action] to check in/out"))))))
4048 (defun insert-file (filename)
4049 "Insert contents of file FILENAME into buffer after point.
4050 Set mark after the inserted text.
4052 This function is meant for the user to run interactively.
4053 Don't call it from programs! Use `insert-file-contents' instead.
4054 \(Its calling sequence is different; see its documentation)."
4055 (interactive "*fInsert file: ")
4056 (insert-file-1 filename #'insert-file-contents))
4058 (defun append-to-file (start end filename)
4059 "Append the contents of the region to the end of file FILENAME.
4060 When called from a function, expects three arguments,
4061 START, END and FILENAME. START and END are buffer positions
4062 saying what text to write."
4063 (interactive "r\nFAppend to file: ")
4064 (write-region start end filename t))
4066 (defun file-newest-backup (filename)
4067 "Return most recent backup file for FILENAME or nil if no backups exist."
4068 ;; `make-backup-file-name' will get us the right directory for
4069 ;; ordinary or numeric backups. It might create a directory for
4070 ;; backups as a side-effect, according to `backup-directory-alist'.
4071 (let* ((filename (file-name-sans-versions
4072 (make-backup-file-name (expand-file-name filename))))
4073 (file (file-name-nondirectory filename))
4074 (dir (file-name-directory filename))
4075 (comp (file-name-all-completions file dir))
4076 (newest nil)
4077 tem)
4078 (while comp
4079 (setq tem (pop comp))
4080 (cond ((and (backup-file-name-p tem)
4081 (string= (file-name-sans-versions tem) file))
4082 (setq tem (concat dir tem))
4083 (if (or (null newest)
4084 (file-newer-than-file-p tem newest))
4085 (setq newest tem)))))
4086 newest))
4088 (defun rename-uniquely ()
4089 "Rename current buffer to a similar name not already taken.
4090 This function is useful for creating multiple shell process buffers
4091 or multiple mail buffers, etc."
4092 (interactive)
4093 (save-match-data
4094 (let ((base-name (buffer-name)))
4095 (and (string-match "<[0-9]+>\\'" base-name)
4096 (not (and buffer-file-name
4097 (string= base-name
4098 (file-name-nondirectory buffer-file-name))))
4099 ;; If the existing buffer name has a <NNN>,
4100 ;; which isn't part of the file name (if any),
4101 ;; then get rid of that.
4102 (setq base-name (substring base-name 0 (match-beginning 0))))
4103 (rename-buffer (generate-new-buffer-name base-name))
4104 (force-mode-line-update))))
4106 (defun make-directory (dir &optional parents)
4107 "Create the directory DIR and any nonexistent parent dirs.
4108 If DIR already exists as a directory, do nothing.
4110 Interactively, the default choice of directory to create
4111 is the current default directory for file names.
4112 That is useful when you have visited a file in a nonexistent directory.
4114 Noninteractively, the second (optional) argument PARENTS says whether
4115 to create parent directories if they don't exist. Interactively,
4116 this happens by default."
4117 (interactive
4118 (list (read-file-name "Make directory: " default-directory default-directory
4119 nil nil)
4121 ;; If default-directory is a remote directory,
4122 ;; make sure we find its make-directory handler.
4123 (setq dir (expand-file-name dir))
4124 (let ((handler (find-file-name-handler dir 'make-directory)))
4125 (if handler
4126 (funcall handler 'make-directory dir parents)
4127 (if (not parents)
4128 (make-directory-internal dir)
4129 (let ((dir (directory-file-name (expand-file-name dir)))
4130 create-list)
4131 (while (not (file-exists-p dir))
4132 (setq create-list (cons dir create-list)
4133 dir (directory-file-name (file-name-directory dir))))
4134 (while create-list
4135 (make-directory-internal (car create-list))
4136 (setq create-list (cdr create-list))))))))
4138 (put 'revert-buffer-function 'permanent-local t)
4139 (defvar revert-buffer-function nil
4140 "Function to use to revert this buffer, or nil to do the default.
4141 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4142 which are the arguments that `revert-buffer' received.")
4144 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4145 (defvar revert-buffer-insert-file-contents-function nil
4146 "Function to use to insert contents when reverting this buffer.
4147 Gets two args, first the nominal file name to use,
4148 and second, t if reading the auto-save file.
4150 The function you specify is responsible for updating (or preserving) point.")
4152 (defvar buffer-stale-function nil
4153 "Function to check whether a non-file buffer needs reverting.
4154 This should be a function with one optional argument NOCONFIRM.
4155 Auto Revert Mode passes t for NOCONFIRM. The function should return
4156 non-nil if the buffer should be reverted. A return value of
4157 `fast' means that the need for reverting was not checked, but
4158 that reverting the buffer is fast. The buffer is current when
4159 this function is called.
4161 The idea behind the NOCONFIRM argument is that it should be
4162 non-nil if the buffer is going to be reverted without asking the
4163 user. In such situations, one has to be careful with potentially
4164 time consuming operations.
4166 For more information on how this variable is used by Auto Revert mode,
4167 see Info node `(emacs)Supporting additional buffers'.")
4169 (defvar before-revert-hook nil
4170 "Normal hook for `revert-buffer' to run before reverting.
4171 If `revert-buffer-function' is used to override the normal revert
4172 mechanism, this hook is not used.")
4174 (defvar after-revert-hook nil
4175 "Normal hook for `revert-buffer' to run after reverting.
4176 Note that the hook value that it runs is the value that was in effect
4177 before reverting; that makes a difference if you have buffer-local
4178 hook functions.
4180 If `revert-buffer-function' is used to override the normal revert
4181 mechanism, this hook is not used.")
4183 (defvar revert-buffer-internal-hook)
4185 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4186 "Replace current buffer text with the text of the visited file on disk.
4187 This undoes all changes since the file was visited or saved.
4188 With a prefix argument, offer to revert from latest auto-save file, if
4189 that is more recent than the visited file.
4191 This command also works for special buffers that contain text which
4192 doesn't come from a file, but reflects some other data base instead:
4193 for example, Dired buffers and `buffer-list' buffers. In these cases,
4194 it reconstructs the buffer contents from the appropriate data base.
4196 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4197 to revert from the auto-save file when this is nil. Note that the
4198 sense of this argument is the reverse of the prefix argument, for the
4199 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4200 to nil.
4202 Optional second argument NOCONFIRM means don't ask for confirmation at
4203 all. \(The variable `revert-without-query' offers another way to
4204 revert buffers without querying for confirmation.)
4206 Optional third argument PRESERVE-MODES non-nil means don't alter
4207 the files modes. Normally we reinitialize them using `normal-mode'.
4209 If the value of `revert-buffer-function' is non-nil, it is called to
4210 do all the work for this command. Otherwise, the hooks
4211 `before-revert-hook' and `after-revert-hook' are run at the beginning
4212 and the end, and if `revert-buffer-insert-file-contents-function' is
4213 non-nil, it is called instead of rereading visited file contents."
4215 ;; I admit it's odd to reverse the sense of the prefix argument, but
4216 ;; there is a lot of code out there which assumes that the first
4217 ;; argument should be t to avoid consulting the auto-save file, and
4218 ;; there's no straightforward way to encourage authors to notice a
4219 ;; reversal of the argument sense. So I'm just changing the user
4220 ;; interface, but leaving the programmatic interface the same.
4221 (interactive (list (not current-prefix-arg)))
4222 (if revert-buffer-function
4223 (funcall revert-buffer-function ignore-auto noconfirm)
4224 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4225 (current-buffer))
4226 (let* ((auto-save-p (and (not ignore-auto)
4227 (recent-auto-save-p)
4228 buffer-auto-save-file-name
4229 (file-readable-p buffer-auto-save-file-name)
4230 (y-or-n-p
4231 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4232 (file-name (if auto-save-p
4233 buffer-auto-save-file-name
4234 buffer-file-name)))
4235 (cond ((null file-name)
4236 (error "Buffer does not seem to be associated with any file"))
4237 ((or noconfirm
4238 (and (not (buffer-modified-p))
4239 (catch 'found
4240 (dolist (regexp revert-without-query)
4241 (when (string-match regexp file-name)
4242 (throw 'found t)))))
4243 (yes-or-no-p (format "Revert buffer from file %s? "
4244 file-name)))
4245 (run-hooks 'before-revert-hook)
4246 ;; If file was backed up but has changed since,
4247 ;; we shd make another backup.
4248 (and (not auto-save-p)
4249 (not (verify-visited-file-modtime (current-buffer)))
4250 (setq buffer-backed-up nil))
4251 ;; Effectively copy the after-revert-hook status,
4252 ;; since after-find-file will clobber it.
4253 (let ((global-hook (default-value 'after-revert-hook))
4254 (local-hook (when (local-variable-p 'after-revert-hook)
4255 after-revert-hook))
4256 (inhibit-read-only t))
4257 (cond
4258 (revert-buffer-insert-file-contents-function
4259 (unless (eq buffer-undo-list t)
4260 ;; Get rid of all undo records for this buffer.
4261 (setq buffer-undo-list nil))
4262 ;; Don't make undo records for the reversion.
4263 (let ((buffer-undo-list t))
4264 (funcall revert-buffer-insert-file-contents-function
4265 file-name auto-save-p)))
4266 ((not (file-exists-p file-name))
4267 (error (if buffer-file-number
4268 "File %s no longer exists!"
4269 "Cannot revert nonexistent file %s")
4270 file-name))
4271 ((not (file-readable-p file-name))
4272 (error (if buffer-file-number
4273 "File %s no longer readable!"
4274 "Cannot revert unreadable file %s")
4275 file-name))
4277 ;; Bind buffer-file-name to nil
4278 ;; so that we don't try to lock the file.
4279 (let ((buffer-file-name nil))
4280 (or auto-save-p
4281 (unlock-buffer)))
4282 (widen)
4283 (let ((coding-system-for-read
4284 ;; Auto-saved file should be read by Emacs'
4285 ;; internal coding.
4286 (if auto-save-p 'auto-save-coding
4287 (or coding-system-for-read
4288 buffer-file-coding-system-explicit))))
4289 (if (and (not enable-multibyte-characters)
4290 coding-system-for-read
4291 (not (memq (coding-system-base
4292 coding-system-for-read)
4293 '(no-conversion raw-text))))
4294 ;; As a coding system suitable for multibyte
4295 ;; buffer is specified, make the current
4296 ;; buffer multibyte.
4297 (set-buffer-multibyte t))
4299 ;; This force after-insert-file-set-coding
4300 ;; (called from insert-file-contents) to set
4301 ;; buffer-file-coding-system to a proper value.
4302 (kill-local-variable 'buffer-file-coding-system)
4304 ;; Note that this preserves point in an intelligent way.
4305 (if preserve-modes
4306 (let ((buffer-file-format buffer-file-format))
4307 (insert-file-contents file-name (not auto-save-p)
4308 nil nil t))
4309 (insert-file-contents file-name (not auto-save-p)
4310 nil nil t)))))
4311 ;; Recompute the truename in case changes in symlinks
4312 ;; have changed the truename.
4313 (setq buffer-file-truename
4314 (abbreviate-file-name (file-truename buffer-file-name)))
4315 (after-find-file nil nil t t preserve-modes)
4316 ;; Run after-revert-hook as it was before we reverted.
4317 (setq-default revert-buffer-internal-hook global-hook)
4318 (if local-hook
4319 (set (make-local-variable 'revert-buffer-internal-hook)
4320 local-hook)
4321 (kill-local-variable 'revert-buffer-internal-hook))
4322 (run-hooks 'revert-buffer-internal-hook))
4323 t))))))
4325 (defun recover-this-file ()
4326 "Recover the visited file--get contents from its last auto-save file."
4327 (interactive)
4328 (recover-file buffer-file-name))
4330 (defun recover-file (file)
4331 "Visit file FILE, but get contents from its last auto-save file."
4332 ;; Actually putting the file name in the minibuffer should be used
4333 ;; only rarely.
4334 ;; Not just because users often use the default.
4335 (interactive "FRecover file: ")
4336 (setq file (expand-file-name file))
4337 (if (auto-save-file-name-p (file-name-nondirectory file))
4338 (error "%s is an auto-save file" (abbreviate-file-name file)))
4339 (let ((file-name (let ((buffer-file-name file))
4340 (make-auto-save-file-name))))
4341 (cond ((if (file-exists-p file)
4342 (not (file-newer-than-file-p file-name file))
4343 (not (file-exists-p file-name)))
4344 (error "Auto-save file %s not current"
4345 (abbreviate-file-name file-name)))
4346 ((save-window-excursion
4347 (with-output-to-temp-buffer "*Directory*"
4348 (buffer-disable-undo standard-output)
4349 (save-excursion
4350 (let ((switches dired-listing-switches))
4351 (if (file-symlink-p file)
4352 (setq switches (concat switches "L")))
4353 (set-buffer standard-output)
4354 ;; Use insert-directory-safely, not insert-directory,
4355 ;; because these files might not exist. In particular,
4356 ;; FILE might not exist if the auto-save file was for
4357 ;; a buffer that didn't visit a file, such as "*mail*".
4358 ;; The code in v20.x called `ls' directly, so we need
4359 ;; to emulate what `ls' did in that case.
4360 (insert-directory-safely file switches)
4361 (insert-directory-safely file-name switches))))
4362 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4363 (switch-to-buffer (find-file-noselect file t))
4364 (let ((inhibit-read-only t)
4365 ;; Keep the current buffer-file-coding-system.
4366 (coding-system buffer-file-coding-system)
4367 ;; Auto-saved file should be read with special coding.
4368 (coding-system-for-read 'auto-save-coding))
4369 (erase-buffer)
4370 (insert-file-contents file-name nil)
4371 (set-buffer-file-coding-system coding-system))
4372 (after-find-file nil nil t))
4373 (t (error "Recover-file cancelled")))))
4375 (defun recover-session ()
4376 "Recover auto save files from a previous Emacs session.
4377 This command first displays a Dired buffer showing you the
4378 previous sessions that you could recover from.
4379 To choose one, move point to the proper line and then type C-c C-c.
4380 Then you'll be asked about a number of files to recover."
4381 (interactive)
4382 (if (null auto-save-list-file-prefix)
4383 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4384 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4385 (unless (file-directory-p dir)
4386 (make-directory dir t))
4387 (unless (directory-files dir nil
4388 (concat "\\`" (regexp-quote
4389 (file-name-nondirectory
4390 auto-save-list-file-prefix)))
4392 (error "No previous sessions to recover")))
4393 (let ((ls-lisp-support-shell-wildcards t))
4394 (dired (concat auto-save-list-file-prefix "*")
4395 (concat dired-listing-switches "t")))
4396 (save-excursion
4397 (goto-char (point-min))
4398 (or (looking-at " Move to the session you want to recover,")
4399 (let ((inhibit-read-only t))
4400 ;; Each line starts with a space
4401 ;; so that Font Lock mode won't highlight the first character.
4402 (insert " Move to the session you want to recover,\n"
4403 " then type C-c C-c to select it.\n\n"
4404 " You can also delete some of these files;\n"
4405 " type d on a line to mark that file for deletion.\n\n"))))
4406 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4407 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4409 (defun recover-session-finish ()
4410 "Choose one saved session to recover auto-save files from.
4411 This command is used in the special Dired buffer created by
4412 \\[recover-session]."
4413 (interactive)
4414 ;; Get the name of the session file to recover from.
4415 (let ((file (dired-get-filename))
4416 files
4417 (buffer (get-buffer-create " *recover*")))
4418 (dired-unmark 1)
4419 (dired-do-flagged-delete t)
4420 (unwind-protect
4421 (save-excursion
4422 ;; Read in the auto-save-list file.
4423 (set-buffer buffer)
4424 (erase-buffer)
4425 (insert-file-contents file)
4426 ;; Loop thru the text of that file
4427 ;; and get out the names of the files to recover.
4428 (while (not (eobp))
4429 (let (thisfile autofile)
4430 (if (eolp)
4431 ;; This is a pair of lines for a non-file-visiting buffer.
4432 ;; Get the auto-save file name and manufacture
4433 ;; a "visited file name" from that.
4434 (progn
4435 (forward-line 1)
4436 ;; If there is no auto-save file name, the
4437 ;; auto-save-list file is probably corrupted.
4438 (unless (eolp)
4439 (setq autofile
4440 (buffer-substring-no-properties
4441 (point)
4442 (line-end-position)))
4443 (setq thisfile
4444 (expand-file-name
4445 (substring
4446 (file-name-nondirectory autofile)
4447 1 -1)
4448 (file-name-directory autofile))))
4449 (forward-line 1))
4450 ;; This pair of lines is a file-visiting
4451 ;; buffer. Use the visited file name.
4452 (progn
4453 (setq thisfile
4454 (buffer-substring-no-properties
4455 (point) (progn (end-of-line) (point))))
4456 (forward-line 1)
4457 (setq autofile
4458 (buffer-substring-no-properties
4459 (point) (progn (end-of-line) (point))))
4460 (forward-line 1)))
4461 ;; Ignore a file if its auto-save file does not exist now.
4462 (if (and autofile (file-exists-p autofile))
4463 (setq files (cons thisfile files)))))
4464 (setq files (nreverse files))
4465 ;; The file contains a pair of line for each auto-saved buffer.
4466 ;; The first line of the pair contains the visited file name
4467 ;; or is empty if the buffer was not visiting a file.
4468 ;; The second line is the auto-save file name.
4469 (if files
4470 (map-y-or-n-p "Recover %s? "
4471 (lambda (file)
4472 (condition-case nil
4473 (save-excursion (recover-file file))
4474 (error
4475 "Failed to recover `%s'" file)))
4476 files
4477 '("file" "files" "recover"))
4478 (message "No files can be recovered from this session now")))
4479 (kill-buffer buffer))))
4481 (defun kill-buffer-ask (buffer)
4482 "Kill buffer if confirmed."
4483 (when (yes-or-no-p
4484 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4485 (if (buffer-modified-p buffer)
4486 "HAS BEEN EDITED" "is unmodified")))
4487 (kill-buffer buffer)))
4489 (defun kill-some-buffers (&optional list)
4490 "Kill some buffers. Asks the user whether to kill each one of them.
4491 Non-interactively, if optional argument LIST is non-nil, it
4492 specifies the list of buffers to kill, asking for approval for each one."
4493 (interactive)
4494 (if (null list)
4495 (setq list (buffer-list)))
4496 (while list
4497 (let* ((buffer (car list))
4498 (name (buffer-name buffer)))
4499 (and name ; Can be nil for an indirect buffer
4500 ; if we killed the base buffer.
4501 (not (string-equal name ""))
4502 (/= (aref name 0) ?\s)
4503 (kill-buffer-ask buffer)))
4504 (setq list (cdr list))))
4506 (defun kill-matching-buffers (regexp &optional internal-too)
4507 "Kill buffers whose name matches the specified regexp.
4508 The optional second argument indicates whether to kill internal buffers too."
4509 (interactive "sKill buffers matching this regular expression: \nP")
4510 (dolist (buffer (buffer-list))
4511 (let ((name (buffer-name buffer)))
4512 (when (and name (not (string-equal name ""))
4513 (or internal-too (/= (aref name 0) ?\s))
4514 (string-match regexp name))
4515 (kill-buffer-ask buffer)))))
4518 (defun auto-save-mode (arg)
4519 "Toggle auto-saving of contents of current buffer.
4520 With prefix argument ARG, turn auto-saving on if positive, else off."
4521 (interactive "P")
4522 (setq buffer-auto-save-file-name
4523 (and (if (null arg)
4524 (or (not buffer-auto-save-file-name)
4525 ;; If auto-save is off because buffer has shrunk,
4526 ;; then toggling should turn it on.
4527 (< buffer-saved-size 0))
4528 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4529 (if (and buffer-file-name auto-save-visited-file-name
4530 (not buffer-read-only))
4531 buffer-file-name
4532 (make-auto-save-file-name))))
4533 ;; If -1 was stored here, to temporarily turn off saving,
4534 ;; turn it back on.
4535 (and (< buffer-saved-size 0)
4536 (setq buffer-saved-size 0))
4537 (if (interactive-p)
4538 (message "Auto-save %s (in this buffer)"
4539 (if buffer-auto-save-file-name "on" "off")))
4540 buffer-auto-save-file-name)
4542 (defun rename-auto-save-file ()
4543 "Adjust current buffer's auto save file name for current conditions.
4544 Also rename any existing auto save file, if it was made in this session."
4545 (let ((osave buffer-auto-save-file-name))
4546 (setq buffer-auto-save-file-name
4547 (make-auto-save-file-name))
4548 (if (and osave buffer-auto-save-file-name
4549 (not (string= buffer-auto-save-file-name buffer-file-name))
4550 (not (string= buffer-auto-save-file-name osave))
4551 (file-exists-p osave)
4552 (recent-auto-save-p))
4553 (rename-file osave buffer-auto-save-file-name t))))
4555 (defun make-auto-save-file-name ()
4556 "Return file name to use for auto-saves of current buffer.
4557 Does not consider `auto-save-visited-file-name' as that variable is checked
4558 before calling this function. You can redefine this for customization.
4559 See also `auto-save-file-name-p'."
4560 (if buffer-file-name
4561 (let ((handler (find-file-name-handler buffer-file-name
4562 'make-auto-save-file-name)))
4563 (if handler
4564 (funcall handler 'make-auto-save-file-name)
4565 (let ((list auto-save-file-name-transforms)
4566 (filename buffer-file-name)
4567 result uniq)
4568 ;; Apply user-specified translations
4569 ;; to the file name.
4570 (while (and list (not result))
4571 (if (string-match (car (car list)) filename)
4572 (setq result (replace-match (cadr (car list)) t nil
4573 filename)
4574 uniq (car (cddr (car list)))))
4575 (setq list (cdr list)))
4576 (if result
4577 (if uniq
4578 (setq filename (concat
4579 (file-name-directory result)
4580 (subst-char-in-string
4581 ?/ ?!
4582 (replace-regexp-in-string "!" "!!"
4583 filename))))
4584 (setq filename result)))
4585 (setq result
4586 (if (and (eq system-type 'ms-dos)
4587 (not (msdos-long-file-names)))
4588 ;; We truncate the file name to DOS 8+3 limits
4589 ;; before doing anything else, because the regexp
4590 ;; passed to string-match below cannot handle
4591 ;; extensions longer than 3 characters, multiple
4592 ;; dots, and other atrocities.
4593 (let ((fn (dos-8+3-filename
4594 (file-name-nondirectory buffer-file-name))))
4595 (string-match
4596 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4598 (concat (file-name-directory buffer-file-name)
4599 "#" (match-string 1 fn)
4600 "." (match-string 3 fn) "#"))
4601 (concat (file-name-directory filename)
4603 (file-name-nondirectory filename)
4604 "#")))
4605 ;; Make sure auto-save file names don't contain characters
4606 ;; invalid for the underlying filesystem.
4607 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4608 ;; Don't modify remote (ange-ftp) filenames
4609 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4610 (convert-standard-filename result)
4611 result))))
4613 ;; Deal with buffers that don't have any associated files. (Mail
4614 ;; mode tends to create a good number of these.)
4616 (let ((buffer-name (buffer-name))
4617 (limit 0)
4618 file-name)
4619 ;; Eliminate all slashes and backslashes by
4620 ;; replacing them with sequences that start with %.
4621 ;; Quote % also, to keep distinct names distinct.
4622 (while (string-match "[/\\%]" buffer-name limit)
4623 (let* ((character (aref buffer-name (match-beginning 0)))
4624 (replacement
4625 (cond ((eq character ?%) "%%")
4626 ((eq character ?/) "%+")
4627 ((eq character ?\\) "%-"))))
4628 (setq buffer-name (replace-match replacement t t buffer-name))
4629 (setq limit (1+ (match-end 0)))))
4630 ;; Generate the file name.
4631 (setq file-name
4632 (make-temp-file
4633 (let ((fname
4634 (expand-file-name
4635 (format "#%s#" buffer-name)
4636 ;; Try a few alternative directories, to get one we can
4637 ;; write it.
4638 (cond
4639 ((file-writable-p default-directory) default-directory)
4640 ((file-writable-p "/var/tmp/") "/var/tmp/")
4641 ("~/")))))
4642 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4643 ;; Don't modify remote (ange-ftp) filenames
4644 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4645 ;; The call to convert-standard-filename is in case
4646 ;; buffer-name includes characters not allowed by the
4647 ;; DOS/Windows filesystems. make-temp-file writes to the
4648 ;; file it creates, so we must fix the file name _before_
4649 ;; make-temp-file is called.
4650 (convert-standard-filename fname)
4651 fname))
4652 nil "#"))
4653 ;; make-temp-file creates the file,
4654 ;; but we don't want it to exist until we do an auto-save.
4655 (condition-case ()
4656 (delete-file file-name)
4657 (file-error nil))
4658 file-name)))
4660 (defun auto-save-file-name-p (filename)
4661 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4662 FILENAME should lack slashes. You can redefine this for customization."
4663 (string-match "^#.*#$" filename))
4665 (defun wildcard-to-regexp (wildcard)
4666 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4667 The generated regexp will match a filename only if the filename
4668 matches that wildcard according to shell rules. Only wildcards known
4669 by `sh' are supported."
4670 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4671 ;; Copy the initial run of non-special characters.
4672 (result (substring wildcard 0 i))
4673 (len (length wildcard)))
4674 ;; If no special characters, we're almost done.
4675 (if i
4676 (while (< i len)
4677 (let ((ch (aref wildcard i))
4679 (setq
4680 result
4681 (concat result
4682 (cond
4683 ((and (eq ch ?\[)
4684 (< (1+ i) len)
4685 (eq (aref wildcard (1+ i)) ?\]))
4686 "\\[")
4687 ((eq ch ?\[) ; [...] maps to regexp char class
4688 (progn
4689 (setq i (1+ i))
4690 (concat
4691 (cond
4692 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4693 (progn
4694 (setq i (1+ i))
4695 (if (eq (aref wildcard i) ?\])
4696 (progn
4697 (setq i (1+ i))
4698 "[^]")
4699 "[^")))
4700 ((eq (aref wildcard i) ?^)
4701 ;; Found "[^". Insert a `\0' character
4702 ;; (which cannot happen in a filename)
4703 ;; into the character class, so that `^'
4704 ;; is not the first character after `[',
4705 ;; and thus non-special in a regexp.
4706 (progn
4707 (setq i (1+ i))
4708 "[\000^"))
4709 ((eq (aref wildcard i) ?\])
4710 ;; I don't think `]' can appear in a
4711 ;; character class in a wildcard, but
4712 ;; let's be general here.
4713 (progn
4714 (setq i (1+ i))
4715 "[]"))
4716 (t "["))
4717 (prog1 ; copy everything upto next `]'.
4718 (substring wildcard
4720 (setq j (string-match
4721 "]" wildcard i)))
4722 (setq i (if j (1- j) (1- len)))))))
4723 ((eq ch ?.) "\\.")
4724 ((eq ch ?*) "[^\000]*")
4725 ((eq ch ?+) "\\+")
4726 ((eq ch ?^) "\\^")
4727 ((eq ch ?$) "\\$")
4728 ((eq ch ?\\) "\\\\") ; probably cannot happen...
4729 ((eq ch ??) "[^\000]")
4730 (t (char-to-string ch)))))
4731 (setq i (1+ i)))))
4732 ;; Shell wildcards should match the entire filename,
4733 ;; not its part. Make the regexp say so.
4734 (concat "\\`" result "\\'")))
4736 (defcustom list-directory-brief-switches
4737 (if (eq system-type 'vax-vms) "" "-CF")
4738 "Switches for `list-directory' to pass to `ls' for brief listing."
4739 :type 'string
4740 :group 'dired)
4742 (defcustom list-directory-verbose-switches
4743 (if (eq system-type 'vax-vms)
4744 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4745 "-l")
4746 "Switches for `list-directory' to pass to `ls' for verbose listing."
4747 :type 'string
4748 :group 'dired)
4750 (defun file-expand-wildcards (pattern &optional full)
4751 "Expand wildcard pattern PATTERN.
4752 This returns a list of file names which match the pattern.
4754 If PATTERN is written as an absolute file name,
4755 the values are absolute also.
4757 If PATTERN is written as a relative file name, it is interpreted
4758 relative to the current default directory, `default-directory'.
4759 The file names returned are normally also relative to the current
4760 default directory. However, if FULL is non-nil, they are absolute."
4761 (save-match-data
4762 (let* ((nondir (file-name-nondirectory pattern))
4763 (dirpart (file-name-directory pattern))
4764 ;; A list of all dirs that DIRPART specifies.
4765 ;; This can be more than one dir
4766 ;; if DIRPART contains wildcards.
4767 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
4768 (mapcar 'file-name-as-directory
4769 (file-expand-wildcards (directory-file-name dirpart)))
4770 (list dirpart)))
4771 contents)
4772 (while dirs
4773 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
4774 (file-directory-p (directory-file-name (car dirs))))
4775 (let ((this-dir-contents
4776 ;; Filter out "." and ".."
4777 (delq nil
4778 (mapcar #'(lambda (name)
4779 (unless (string-match "\\`\\.\\.?\\'"
4780 (file-name-nondirectory name))
4781 name))
4782 (directory-files (or (car dirs) ".") full
4783 (wildcard-to-regexp nondir))))))
4784 (setq contents
4785 (nconc
4786 (if (and (car dirs) (not full))
4787 (mapcar (function (lambda (name) (concat (car dirs) name)))
4788 this-dir-contents)
4789 this-dir-contents)
4790 contents))))
4791 (setq dirs (cdr dirs)))
4792 contents)))
4794 (defun list-directory (dirname &optional verbose)
4795 "Display a list of files in or matching DIRNAME, a la `ls'.
4796 DIRNAME is globbed by the shell if necessary.
4797 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4798 Actions controlled by variables `list-directory-brief-switches'
4799 and `list-directory-verbose-switches'."
4800 (interactive (let ((pfx current-prefix-arg))
4801 (list (read-file-name (if pfx "List directory (verbose): "
4802 "List directory (brief): ")
4803 nil default-directory nil)
4804 pfx)))
4805 (let ((switches (if verbose list-directory-verbose-switches
4806 list-directory-brief-switches))
4807 buffer)
4808 (or dirname (setq dirname default-directory))
4809 (setq dirname (expand-file-name dirname))
4810 (with-output-to-temp-buffer "*Directory*"
4811 (setq buffer standard-output)
4812 (buffer-disable-undo standard-output)
4813 (princ "Directory ")
4814 (princ dirname)
4815 (terpri)
4816 (save-excursion
4817 (set-buffer "*Directory*")
4818 (let ((wildcard (not (file-directory-p dirname))))
4819 (insert-directory dirname switches wildcard (not wildcard)))))
4820 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4821 (with-current-buffer buffer
4822 (setq default-directory
4823 (if (file-directory-p dirname)
4824 (file-name-as-directory dirname)
4825 (file-name-directory dirname))))))
4827 (defun shell-quote-wildcard-pattern (pattern)
4828 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4830 PATTERN is assumed to represent a file-name wildcard suitable for the
4831 underlying filesystem. For Unix and GNU/Linux, the characters from the
4832 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4833 the parts of the pattern which don't include wildcard characters are
4834 quoted with double quotes.
4835 Existing quote characters in PATTERN are left alone, so you can pass
4836 PATTERN that already quotes some of the special characters."
4837 (save-match-data
4838 (cond
4839 ((memq system-type '(ms-dos windows-nt cygwin))
4840 ;; DOS/Windows don't allow `"' in file names. So if the
4841 ;; argument has quotes, we can safely assume it is already
4842 ;; quoted by the caller.
4843 (if (or (string-match "[\"]" pattern)
4844 ;; We quote [&()#$'] in case their shell is a port of a
4845 ;; Unixy shell. We quote [,=+] because stock DOS and
4846 ;; Windows shells require that in some cases, such as
4847 ;; passing arguments to batch files that use positional
4848 ;; arguments like %1.
4849 (not (string-match "[ \t;&()#$',=+]" pattern)))
4850 pattern
4851 (let ((result "\"")
4852 (beg 0)
4853 end)
4854 (while (string-match "[*?]+" pattern beg)
4855 (setq end (match-beginning 0)
4856 result (concat result (substring pattern beg end)
4857 "\""
4858 (substring pattern end (match-end 0))
4859 "\"")
4860 beg (match-end 0)))
4861 (concat result (substring pattern beg) "\""))))
4863 (let ((beg 0))
4864 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4865 (setq pattern
4866 (concat (substring pattern 0 (match-beginning 0))
4867 "\\"
4868 (substring pattern (match-beginning 0)))
4869 beg (1+ (match-end 0)))))
4870 pattern))))
4873 (defvar insert-directory-program "ls"
4874 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4876 (defcustom directory-free-space-program "df"
4877 "Program to get the amount of free space on a file system.
4878 We assume the output has the format of `df'.
4879 The value of this variable must be just a command name or file name;
4880 if you want to specify options, use `directory-free-space-args'.
4882 A value of nil disables this feature.
4884 If the function `file-system-info' is defined, it is always used in
4885 preference to the program given by this variable."
4886 :type '(choice (string :tag "Program") (const :tag "None" nil))
4887 :group 'dired)
4889 (defcustom directory-free-space-args
4890 (if (eq system-type 'darwin) "-k" "-Pk")
4891 "Options to use when running `directory-free-space-program'."
4892 :type 'string
4893 :group 'dired)
4895 (defun get-free-disk-space (dir)
4896 "Return the amount of free space on directory DIR's file system.
4897 The result is a string that gives the number of free 1KB blocks,
4898 or nil if the system call or the program which retrieve the information
4899 fail. It returns also nil when DIR is a remote directory.
4901 This function calls `file-system-info' if it is available, or invokes the
4902 program specified by `directory-free-space-program' if that is non-nil."
4903 (when (not (file-remote-p dir))
4904 ;; Try to find the number of free blocks. Non-Posix systems don't
4905 ;; always have df, but might have an equivalent system call.
4906 (if (fboundp 'file-system-info)
4907 (let ((fsinfo (file-system-info dir)))
4908 (if fsinfo
4909 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4910 (save-match-data
4911 (with-temp-buffer
4912 (when (and directory-free-space-program
4913 (eq 0 (call-process directory-free-space-program
4914 nil t nil
4915 directory-free-space-args
4916 dir)))
4917 ;; Usual format is a header line followed by a line of
4918 ;; numbers.
4919 (goto-char (point-min))
4920 (forward-line 1)
4921 (if (not (eobp))
4922 (progn
4923 ;; Move to the end of the "available blocks" number.
4924 (skip-chars-forward "^ \t")
4925 (forward-word 3)
4926 ;; Copy it into AVAILABLE.
4927 (let ((end (point)))
4928 (forward-word -1)
4929 (buffer-substring (point) end))))))))))
4931 ;; The following expression replaces `dired-move-to-filename-regexp'.
4932 (defvar directory-listing-before-filename-regexp
4933 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
4934 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
4935 ;; In some locales, month abbreviations are as short as 2 letters,
4936 ;; and they can be followed by ".".
4937 ;; In Breton, a month name can include a quote character.
4938 (month (concat l-or-quote l-or-quote "+\\.?"))
4939 (s " ")
4940 (yyyy "[0-9][0-9][0-9][0-9]")
4941 (dd "[ 0-3][0-9]")
4942 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
4943 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
4944 (zone "[-+][0-2][0-9][0-5][0-9]")
4945 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
4946 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
4947 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
4948 "\\|" yyyy "-" iso-mm-dd "\\)"))
4949 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
4950 s "+"
4951 "\\(" HH:MM "\\|" yyyy "\\)"))
4952 (western-comma (concat month s "+" dd "," s "+" yyyy))
4953 ;; Japanese MS-Windows ls-lisp has one-digit months, and
4954 ;; omits the Kanji characters after month and day-of-month.
4955 ;; On Mac OS X 10.3, the date format in East Asian locales is
4956 ;; day-of-month digits followed by month digits.
4957 (mm "[ 0-1]?[0-9]")
4958 (east-asian
4959 (concat "\\(" mm l "?" s dd l "?" s "+"
4960 "\\|" dd s mm s "+" "\\)"
4961 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
4962 ;; The "[0-9]" below requires the previous column to end in a digit.
4963 ;; This avoids recognizing `1 may 1997' as a date in the line:
4964 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
4966 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
4967 ;; The ".*" below finds the last match if there are multiple matches.
4968 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
4969 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
4971 ;; vc dired listings provide the state or blanks between file
4972 ;; permissions and date. The state is always surrounded by
4973 ;; parantheses:
4974 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
4975 ;; This is not supported yet.
4976 (concat ".*[0-9][BkKMGTPEZY]?" s
4977 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
4978 s "+"))
4979 "Regular expression to match up to the file name in a directory listing.
4980 The default value is designed to recognize dates and times
4981 regardless of the language.")
4983 (defvar insert-directory-ls-version 'unknown)
4985 ;; insert-directory
4986 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4987 ;; FULL-DIRECTORY-P is nil.
4988 ;; The single line of output must display FILE's name as it was
4989 ;; given, namely, an absolute path name.
4990 ;; - must insert exactly one line for each file if WILDCARD or
4991 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4992 ;; before the file lines, plus optional text after the file lines.
4993 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4994 ;; allowed.
4995 ;; File lines should display the basename.
4996 ;; - must be consistent with
4997 ;; - functions dired-move-to-filename, (these two define what a file line is)
4998 ;; dired-move-to-end-of-filename,
4999 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5000 ;; dired-insert-headerline
5001 ;; dired-after-subdir-garbage (defines what a "total" line is)
5002 ;; - variable dired-subdir-regexp
5003 ;; - may be passed "--dired" as the first argument in SWITCHES.
5004 ;; Filename handlers might have to remove this switch if their
5005 ;; "ls" command does not support it.
5006 (defun insert-directory (file switches &optional wildcard full-directory-p)
5007 "Insert directory listing for FILE, formatted according to SWITCHES.
5008 Leaves point after the inserted text.
5009 SWITCHES may be a string of options, or a list of strings
5010 representing individual options.
5011 Optional third arg WILDCARD means treat FILE as shell wildcard.
5012 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5013 switches do not contain `d', so that a full listing is expected.
5015 This works by running a directory listing program
5016 whose name is in the variable `insert-directory-program'.
5017 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5019 When SWITCHES contains the long `--dired' option, this function
5020 treats it specially, for the sake of dired. However, the
5021 normally equivalent short `-D' option is just passed on to
5022 `insert-directory-program', as any other option."
5023 ;; We need the directory in order to find the right handler.
5024 (let ((handler (find-file-name-handler (expand-file-name file)
5025 'insert-directory)))
5026 (if handler
5027 (funcall handler 'insert-directory file switches
5028 wildcard full-directory-p)
5029 (if (eq system-type 'vax-vms)
5030 (vms-read-directory file switches (current-buffer))
5031 (let (result (beg (point)))
5033 ;; Read the actual directory using `insert-directory-program'.
5034 ;; RESULT gets the status code.
5035 (let* (;; We at first read by no-conversion, then after
5036 ;; putting text property `dired-filename, decode one
5037 ;; bunch by one to preserve that property.
5038 (coding-system-for-read 'no-conversion)
5039 ;; This is to control encoding the arguments in call-process.
5040 (coding-system-for-write
5041 (and enable-multibyte-characters
5042 (or file-name-coding-system
5043 default-file-name-coding-system))))
5044 (setq result
5045 (if wildcard
5046 ;; Run ls in the directory part of the file pattern
5047 ;; using the last component as argument.
5048 (let ((default-directory
5049 (if (file-name-absolute-p file)
5050 (file-name-directory file)
5051 (file-name-directory (expand-file-name file))))
5052 (pattern (file-name-nondirectory file)))
5053 (call-process
5054 shell-file-name nil t nil
5055 "-c"
5056 (concat (if (memq system-type '(ms-dos windows-nt))
5058 "\\") ; Disregard Unix shell aliases!
5059 insert-directory-program
5060 " -d "
5061 (if (stringp switches)
5062 switches
5063 (mapconcat 'identity switches " "))
5064 " -- "
5065 ;; Quote some characters that have
5066 ;; special meanings in shells; but
5067 ;; don't quote the wildcards--we want
5068 ;; them to be special. We also
5069 ;; currently don't quote the quoting
5070 ;; characters in case people want to
5071 ;; use them explicitly to quote
5072 ;; wildcard characters.
5073 (shell-quote-wildcard-pattern pattern))))
5074 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5075 ;; directory if FILE is a symbolic link.
5076 (apply 'call-process
5077 insert-directory-program nil t nil
5078 (append
5079 (if (listp switches) switches
5080 (unless (equal switches "")
5081 ;; Split the switches at any spaces so we can
5082 ;; pass separate options as separate args.
5083 (split-string switches)))
5084 ;; Avoid lossage if FILE starts with `-'.
5085 '("--")
5086 (progn
5087 (if (string-match "\\`~" file)
5088 (setq file (expand-file-name file)))
5089 (list
5090 (if full-directory-p
5091 (concat (file-name-as-directory file) ".")
5092 file))))))))
5094 ;; If we got "//DIRED//" in the output, it means we got a real
5095 ;; directory listing, even if `ls' returned nonzero.
5096 ;; So ignore any errors.
5097 (when (if (stringp switches)
5098 (string-match "--dired\\>" switches)
5099 (member "--dired" switches))
5100 (save-excursion
5101 (forward-line -2)
5102 (when (looking-at "//SUBDIRED//")
5103 (forward-line -1))
5104 (if (looking-at "//DIRED//")
5105 (setq result 0))))
5107 (when (and (not (eq 0 result))
5108 (eq insert-directory-ls-version 'unknown))
5109 ;; The first time ls returns an error,
5110 ;; find the version numbers of ls,
5111 ;; and set insert-directory-ls-version
5112 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5113 ;; is equal or if the info cannot be obtained.
5114 ;; (That can mean it isn't GNU ls.)
5115 (let ((version-out
5116 (with-temp-buffer
5117 (call-process "ls" nil t nil "--version")
5118 (buffer-string))))
5119 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5120 (let* ((version (match-string 1 version-out))
5121 (split (split-string version "[.]"))
5122 (numbers (mapcar 'string-to-number split))
5123 (min '(5 2 1))
5124 comparison)
5125 (while (and (not comparison) (or numbers min))
5126 (cond ((null min)
5127 (setq comparison '>))
5128 ((null numbers)
5129 (setq comparison '<))
5130 ((> (car numbers) (car min))
5131 (setq comparison '>))
5132 ((< (car numbers) (car min))
5133 (setq comparison '<))
5135 (setq numbers (cdr numbers)
5136 min (cdr min)))))
5137 (setq insert-directory-ls-version (or comparison '=)))
5138 (setq insert-directory-ls-version nil))))
5140 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5141 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5142 (setq result 0))
5144 ;; If `insert-directory-program' failed, signal an error.
5145 (unless (eq 0 result)
5146 ;; Delete the error message it may have output.
5147 (delete-region beg (point))
5148 ;; On non-Posix systems, we cannot open a directory, so
5149 ;; don't even try, because that will always result in
5150 ;; the ubiquitous "Access denied". Instead, show the
5151 ;; command line so the user can try to guess what went wrong.
5152 (if (and (file-directory-p file)
5153 (memq system-type '(ms-dos windows-nt)))
5154 (error
5155 "Reading directory: \"%s %s -- %s\" exited with status %s"
5156 insert-directory-program
5157 (if (listp switches) (concat switches) switches)
5158 file result)
5159 ;; Unix. Access the file to get a suitable error.
5160 (access-file file "Reading directory")
5161 (error "Listing directory failed but `access-file' worked")))
5163 (when (if (stringp switches)
5164 (string-match "--dired\\>" switches)
5165 (member "--dired" switches))
5166 ;; The following overshoots by one line for an empty
5167 ;; directory listed with "--dired", but without "-a"
5168 ;; switch, where the ls output contains a
5169 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5170 ;; We take care of that case later.
5171 (forward-line -2)
5172 (when (looking-at "//SUBDIRED//")
5173 (delete-region (point) (progn (forward-line 1) (point)))
5174 (forward-line -1))
5175 (if (looking-at "//DIRED//")
5176 (let ((end (line-end-position))
5177 (linebeg (point))
5178 error-lines)
5179 ;; Find all the lines that are error messages,
5180 ;; and record the bounds of each one.
5181 (goto-char beg)
5182 (while (< (point) linebeg)
5183 (or (eql (following-char) ?\s)
5184 (push (list (point) (line-end-position)) error-lines))
5185 (forward-line 1))
5186 (setq error-lines (nreverse error-lines))
5187 ;; Now read the numeric positions of file names.
5188 (goto-char linebeg)
5189 (forward-word 1)
5190 (forward-char 3)
5191 (while (< (point) end)
5192 (let ((start (insert-directory-adj-pos
5193 (+ beg (read (current-buffer)))
5194 error-lines))
5195 (end (insert-directory-adj-pos
5196 (+ beg (read (current-buffer)))
5197 error-lines)))
5198 (if (memq (char-after end) '(?\n ?\s))
5199 ;; End is followed by \n or by " -> ".
5200 (put-text-property start end 'dired-filename t)
5201 ;; It seems that we can't trust ls's output as to
5202 ;; byte positions of filenames.
5203 (put-text-property beg (point) 'dired-filename nil)
5204 (end-of-line))))
5205 (goto-char end)
5206 (beginning-of-line)
5207 (delete-region (point) (progn (forward-line 1) (point))))
5208 ;; Take care of the case where the ls output contains a
5209 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5210 ;; and we went one line too far back (see above).
5211 (forward-line 1))
5212 (if (looking-at "//DIRED-OPTIONS//")
5213 (delete-region (point) (progn (forward-line 1) (point)))))
5215 ;; Now decode what read if necessary.
5216 (let ((coding (or coding-system-for-read
5217 file-name-coding-system
5218 default-file-name-coding-system
5219 'undecided))
5220 coding-no-eol
5221 val pos)
5222 (when (and enable-multibyte-characters
5223 (not (memq (coding-system-base coding)
5224 '(raw-text no-conversion))))
5225 ;; If no coding system is specified or detection is
5226 ;; requested, detect the coding.
5227 (if (eq (coding-system-base coding) 'undecided)
5228 (setq coding (detect-coding-region beg (point) t)))
5229 (if (not (eq (coding-system-base coding) 'undecided))
5230 (save-restriction
5231 (setq coding-no-eol
5232 (coding-system-change-eol-conversion coding 'unix))
5233 (narrow-to-region beg (point))
5234 (goto-char (point-min))
5235 (while (not (eobp))
5236 (setq pos (point)
5237 val (get-text-property (point) 'dired-filename))
5238 (goto-char (next-single-property-change
5239 (point) 'dired-filename nil (point-max)))
5240 ;; Force no eol conversion on a file name, so
5241 ;; that CR is preserved.
5242 (decode-coding-region pos (point)
5243 (if val coding-no-eol coding))
5244 (if val
5245 (put-text-property pos (point)
5246 'dired-filename t)))))))
5248 (if full-directory-p
5249 ;; Try to insert the amount of free space.
5250 (save-excursion
5251 (goto-char beg)
5252 ;; First find the line to put it on.
5253 (when (re-search-forward "^ *\\(total\\)" nil t)
5254 (let ((available (get-free-disk-space ".")))
5255 (when available
5256 ;; Replace "total" with "used", to avoid confusion.
5257 (replace-match "total used in directory" nil nil nil 1)
5258 (end-of-line)
5259 (insert " available " available)))))))))))
5261 (defun insert-directory-adj-pos (pos error-lines)
5262 "Convert `ls --dired' file name position value POS to a buffer position.
5263 File name position values returned in ls --dired output
5264 count only stdout; they don't count the error messages sent to stderr.
5265 So this function converts to them to real buffer positions.
5266 ERROR-LINES is a list of buffer positions of error message lines,
5267 of the form (START END)."
5268 (while (and error-lines (< (caar error-lines) pos))
5269 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5270 (pop error-lines))
5271 pos)
5273 (defun insert-directory-safely (file switches
5274 &optional wildcard full-directory-p)
5275 "Insert directory listing for FILE, formatted according to SWITCHES.
5277 Like `insert-directory', but if FILE does not exist, it inserts a
5278 message to that effect instead of signaling an error."
5279 (if (file-exists-p file)
5280 (insert-directory file switches wildcard full-directory-p)
5281 ;; Simulate the message printed by `ls'.
5282 (insert (format "%s: No such file or directory\n" file))))
5284 (defvar kill-emacs-query-functions nil
5285 "Functions to call with no arguments to query about killing Emacs.
5286 If any of these functions returns nil, killing Emacs is cancelled.
5287 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
5288 but `kill-emacs', the low level primitive, does not.
5289 See also `kill-emacs-hook'.")
5291 (defcustom confirm-kill-emacs nil
5292 "How to ask for confirmation when leaving Emacs.
5293 If nil, the default, don't ask at all. If the value is non-nil, it should
5294 be a predicate function such as `yes-or-no-p'."
5295 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5296 (const :tag "Ask with y-or-n-p" y-or-n-p)
5297 (const :tag "Don't confirm" nil))
5298 :group 'convenience
5299 :version "21.1")
5301 (defun save-buffers-kill-emacs (&optional arg)
5302 "Offer to save each buffer, then kill this Emacs process.
5303 With prefix arg, silently save all file-visiting buffers, then kill."
5304 (interactive "P")
5305 (save-some-buffers arg t)
5306 (and (or (not (memq t (mapcar (function
5307 (lambda (buf) (and (buffer-file-name buf)
5308 (buffer-modified-p buf))))
5309 (buffer-list))))
5310 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5311 (or (not (fboundp 'process-list))
5312 ;; process-list is not defined on VMS.
5313 (let ((processes (process-list))
5314 active)
5315 (while processes
5316 (and (memq (process-status (car processes)) '(run stop open listen))
5317 (process-query-on-exit-flag (car processes))
5318 (setq active t))
5319 (setq processes (cdr processes)))
5320 (or (not active)
5321 (list-processes t)
5322 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5323 ;; Query the user for other things, perhaps.
5324 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5325 (or (null confirm-kill-emacs)
5326 (funcall confirm-kill-emacs "Really exit Emacs? "))
5327 (kill-emacs)))
5329 (defun save-buffers-kill-terminal (&optional arg)
5330 "Offer to save each buffer, then kill the current connection.
5331 If the current frame has no client, kill Emacs itself.
5333 With prefix arg, silently save all file-visiting buffers, then kill.
5335 If emacsclient was started with a list of filenames to edit, then
5336 only these files will be asked to be saved."
5337 (interactive "P")
5338 (let ((proc (frame-parameter (selected-frame) 'client))
5339 (frame (selected-frame)))
5340 (if (null proc)
5341 (save-buffers-kill-emacs)
5342 (server-save-buffers-kill-terminal proc arg))))
5345 ;; We use /: as a prefix to "quote" a file name
5346 ;; so that magic file name handlers will not apply to it.
5348 (setq file-name-handler-alist
5349 (cons '("\\`/:" . file-name-non-special)
5350 file-name-handler-alist))
5352 ;; We depend on being the last handler on the list,
5353 ;; so that anything else which does need handling
5354 ;; has been handled already.
5355 ;; So it is safe for us to inhibit *all* magic file name handlers.
5357 (defun file-name-non-special (operation &rest arguments)
5358 (let ((file-name-handler-alist nil)
5359 (default-directory
5360 (if (eq operation 'insert-directory)
5361 (directory-file-name
5362 (expand-file-name
5363 (unhandled-file-name-directory default-directory)))
5364 default-directory))
5365 ;; Get a list of the indices of the args which are file names.
5366 (file-arg-indices
5367 (cdr (or (assq operation
5368 ;; The first six are special because they
5369 ;; return a file name. We want to include the /:
5370 ;; in the return value.
5371 ;; So just avoid stripping it in the first place.
5372 '((expand-file-name . nil)
5373 (file-name-directory . nil)
5374 (file-name-as-directory . nil)
5375 (directory-file-name . nil)
5376 (file-name-sans-versions . nil)
5377 (find-backup-file-name . nil)
5378 ;; `identity' means just return the first arg
5379 ;; not stripped of its quoting.
5380 (substitute-in-file-name identity)
5381 ;; `add' means add "/:" to the result.
5382 (file-truename add 0)
5383 ;; `quote' means add "/:" to buffer-file-name.
5384 (insert-file-contents quote 0)
5385 ;; `unquote-then-quote' means set buffer-file-name
5386 ;; temporarily to unquoted filename.
5387 (verify-visited-file-modtime unquote-then-quote)
5388 ;; List the arguments which are filenames.
5389 (file-name-completion 1)
5390 (file-name-all-completions 1)
5391 (write-region 2 5)
5392 (rename-file 0 1)
5393 (copy-file 0 1)
5394 (make-symbolic-link 0 1)
5395 (add-name-to-file 0 1)))
5396 ;; For all other operations, treat the first argument only
5397 ;; as the file name.
5398 '(nil 0))))
5399 method
5400 ;; Copy ARGUMENTS so we can replace elements in it.
5401 (arguments (copy-sequence arguments)))
5402 (if (symbolp (car file-arg-indices))
5403 (setq method (pop file-arg-indices)))
5404 ;; Strip off the /: from the file names that have it.
5405 (save-match-data
5406 (while (consp file-arg-indices)
5407 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5408 (and (car pair)
5409 (string-match "\\`/:" (car pair))
5410 (setcar pair
5411 (if (= (length (car pair)) 2)
5413 (substring (car pair) 2)))))
5414 (setq file-arg-indices (cdr file-arg-indices))))
5415 (cond ((eq method 'identity)
5416 (car arguments))
5417 ((eq method 'add)
5418 (concat "/:" (apply operation arguments)))
5419 ((eq method 'quote)
5420 (unwind-protect
5421 (apply operation arguments)
5422 (setq buffer-file-name (concat "/:" buffer-file-name))))
5423 ((eq method 'unquote-then-quote)
5424 (let (res)
5425 (setq buffer-file-name (substring buffer-file-name 2))
5426 (setq res (apply operation arguments))
5427 (setq buffer-file-name (concat "/:" buffer-file-name))
5428 res))
5430 (apply operation arguments)))))
5432 ;; Symbolic modes and read-file-modes.
5434 (defun file-modes-char-to-who (char)
5435 "Convert CHAR to a who-mask from a symbolic mode notation.
5436 CHAR is in [ugoa] and represents the users on which rights are applied."
5437 (cond ((= char ?u) #o4700)
5438 ((= char ?g) #o2070)
5439 ((= char ?o) #o1007)
5440 ((= char ?a) #o7777)
5441 (t (error "%c: bad `who' character" char))))
5443 (defun file-modes-char-to-right (char &optional from)
5444 "Convert CHAR to a right-mask from a symbolic mode notation.
5445 CHAR is in [rwxXstugo] and represents a right.
5446 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5447 (or from (setq from 0))
5448 (cond ((= char ?r) #o0444)
5449 ((= char ?w) #o0222)
5450 ((= char ?x) #o0111)
5451 ((= char ?s) #o1000)
5452 ((= char ?t) #o6000)
5453 ;; Rights relative to the previous file modes.
5454 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5455 ((= char ?u) (let ((uright (logand #o4700 from)))
5456 (+ uright (/ uright #o10) (/ uright #o100))))
5457 ((= char ?g) (let ((gright (logand #o2070 from)))
5458 (+ gright (/ gright #o10) (* gright #o10))))
5459 ((= char ?o) (let ((oright (logand #o1007 from)))
5460 (+ oright (* oright #o10) (* oright #o100))))
5461 (t (error "%c: bad right character" char))))
5463 (defun file-modes-rights-to-number (rights who-mask &optional from)
5464 "Convert a right string to a right-mask from a symbolic modes notation.
5465 RIGHTS is the right string, it should match \"([+=-][rwxXstugo]+)+\".
5466 WHO-MASK is the mask number of the users on which the rights are to be applied.
5467 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5468 (let* ((num-rights (or from 0))
5469 (list-rights (string-to-list rights))
5470 (op (pop list-rights)))
5471 (while (memq op '(?+ ?- ?=))
5472 (let ((num-right 0)
5473 char-right)
5474 (while (memq (setq char-right (pop list-rights))
5475 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5476 (setq num-right
5477 (logior num-right
5478 (file-modes-char-to-right char-right num-rights))))
5479 (setq num-right (logand who-mask num-right)
5480 num-rights
5481 (cond ((= op ?+) (logior num-rights num-right))
5482 ((= op ?-) (logand num-rights (lognot num-right)))
5483 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5484 op char-right)))
5485 num-rights))
5487 (defun file-modes-symbolic-to-number (modes &optional from)
5488 "Convert symbolic file modes to numeric file modes.
5489 MODES is the string to convert, it should match
5490 \"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5491 See (info \"(coreutils)File permissions\") for more information on this
5492 notation.
5493 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5494 (save-match-data
5495 (let ((case-fold-search nil)
5496 (num-modes (or from 0)))
5497 (while (/= (string-to-char modes) 0)
5498 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5499 (let ((num-who (apply 'logior 0
5500 (mapcar 'file-modes-char-to-who
5501 (match-string 1 modes)))))
5502 (when (= num-who 0)
5503 (setq num-who (default-file-modes)))
5504 (setq num-modes
5505 (file-modes-rights-to-number (substring modes (match-end 1))
5506 num-who num-modes)
5507 modes (substring modes (match-end 3))))
5508 (error "Parse error in modes near `%s'" (substring modes 0))))
5509 num-modes)))
5511 (defun read-file-modes (&optional prompt orig-file)
5512 "Read file modes in octal or symbolic notation.
5513 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5514 ORIG-FILE is the original file of which modes will be change."
5515 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5516 (error "File not found")))
5517 (value (read-string (or prompt "File modes (octal or symbolic): "))))
5518 (save-match-data
5519 (if (string-match "^[0-7]+" value)
5520 (string-to-number value 8)
5521 (file-modes-symbolic-to-number value modes)))))
5524 (define-key ctl-x-map "\C-f" 'find-file)
5525 (define-key ctl-x-map "\C-r" 'find-file-read-only)
5526 (define-key ctl-x-map "\C-v" 'find-alternate-file)
5527 (define-key ctl-x-map "\C-s" 'save-buffer)
5528 (define-key ctl-x-map "s" 'save-some-buffers)
5529 (define-key ctl-x-map "\C-w" 'write-file)
5530 (define-key ctl-x-map "i" 'insert-file)
5531 (define-key esc-map "~" 'not-modified)
5532 (define-key ctl-x-map "\C-d" 'list-directory)
5533 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
5534 (define-key ctl-x-map "\C-q" 'toggle-read-only)
5536 (define-key ctl-x-4-map "f" 'find-file-other-window)
5537 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5538 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5539 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
5540 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5542 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5543 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5544 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5545 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5546 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
5548 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5549 ;;; files.el ends here