1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
32 (eval-when-compile (require 'cl
))
34 (defvar font-lock-keywords
)
37 "Backups of edited data files."
40 (defgroup find-file nil
45 (defcustom delete-auto-save-files t
46 "Non-nil means delete auto-save file when a buffer is saved or killed.
48 Note that the auto-save file will not be deleted if the buffer is killed
49 when it has unsaved changes."
53 (defcustom directory-abbrev-alist
55 "Alist of abbreviations for file directories.
56 A list of elements of the form (FROM . TO), each meaning to replace
57 FROM with TO when it appears in a directory name. This replacement is
58 done when setting up the default directory of a newly visited file.
59 *Every* FROM string should start with `^'.
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
68 :type
'(repeat (cons :format
"%v"
75 (defcustom make-backup-files t
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
98 (defvar backup-inhibited nil
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
101 But it is local only if you make it local.")
102 (put 'backup-inhibited
'permanent-local t
)
104 (defcustom backup-by-copying nil
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
110 (defcustom backup-by-copying-when-linked nil
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
117 (defcustom backup-by-copying-when-mismatch nil
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
127 (defcustom backup-by-copying-when-privileged-mismatch
200
128 "Non-nil means create backups by copying to preserve a privileged owner.
129 Renaming may still be used (subject to control of other variables)
130 when it would not result in changing the owner of the file or if the owner
131 has a user id greater than the value of this variable. This is useful
132 when low-numbered uid's are used for special system users (such as root)
133 that must maintain ownership of certain files.
134 This variable is relevant only if `backup-by-copying' and
135 `backup-by-copying-when-mismatch' are nil."
136 :type
'(choice (const nil
) integer
)
139 (defvar backup-enable-predicate
'normal-backup-enable-predicate
140 "Predicate that looks at a file name and decides whether to make backups.
141 Called with an absolute file name as argument, it returns t to enable backup.")
143 (defcustom buffer-offer-save nil
144 "Non-nil in a buffer means always offer to save buffer on exit.
145 Do so even if the buffer is not visiting a file.
146 Automatically local in all buffers."
149 (make-variable-buffer-local 'buffer-offer-save
)
151 (defcustom find-file-existing-other-name t
152 "Non-nil means find a file under alternative names, in existing buffers.
153 This means if any existing buffer is visiting the file you want
154 under another name, you get the existing buffer instead of a new buffer."
158 (defcustom find-file-visit-truename nil
159 "Non-nil means visit a file under its truename.
160 The truename of a file is found by chasing all links
161 both at the file level and at the levels of the containing directories."
164 (put 'find-file-visit-truename
'safe-local-variable
'booleanp
)
166 (defcustom revert-without-query nil
167 "Specify which files should be reverted without query.
168 The value is a list of regular expressions.
169 If the file name matches one of these regular expressions,
170 then `revert-buffer' reverts the file without querying
171 if the file has changed on disk and you have not edited the buffer."
172 :type
'(repeat regexp
)
175 (defvar buffer-file-number nil
176 "The device number and file number of the file visited in the current buffer.
177 The value is a list of the form (FILENUM DEVNUM).
178 This pair of numbers uniquely identifies the file.
179 If the buffer is visiting a new file, the value is nil.")
180 (make-variable-buffer-local 'buffer-file-number
)
181 (put 'buffer-file-number
'permanent-local t
)
183 (defvar buffer-file-numbers-unique
(not (memq system-type
'(windows-nt)))
184 "Non-nil means that `buffer-file-number' uniquely identifies files.")
186 (defvar buffer-file-read-only nil
187 "Non-nil if visited file was read-only when visited.")
188 (make-variable-buffer-local 'buffer-file-read-only
)
190 (defcustom temporary-file-directory
191 (file-name-as-directory
192 (cond ((memq system-type
'(ms-dos windows-nt
))
193 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
195 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
196 "The directory for writing temporary files."
198 :initialize
'custom-initialize-delay
201 (defcustom small-temporary-file-directory
202 (if (eq system-type
'ms-dos
) (getenv "TMPDIR"))
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
208 :initialize
'custom-initialize-delay
209 :type
'(choice (const nil
) directory
))
211 ;; The system null device. (Should reference NULL_DEVICE from C.)
212 (defvar null-device
"/dev/null" "The system null device.")
214 (declare-function msdos-long-file-names
"msdos.c")
215 (declare-function w32-long-file-name
"w32proc.c")
216 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
217 (declare-function dired-unmark
"dired" (arg))
218 (declare-function dired-do-flagged-delete
"dired" (&optional nomessage
))
219 (declare-function dos-8
+3-filename
"dos-fns" (filename))
220 (declare-function view-mode-disable
"view" ())
221 (declare-function dosified-file-name
"dos-fns" (file-name))
223 (defvar file-name-invalid-regexp
224 (cond ((and (eq system-type
'ms-dos
) (not (msdos-long-file-names)))
225 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
226 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
227 "[\000-\037]\\|" ; control characters
228 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
229 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
230 ((memq system-type
'(ms-dos windows-nt cygwin
))
231 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
232 "[|<>\"?*\000-\037]")) ; invalid characters
234 "Regexp recognizing file names which aren't allowed by the filesystem.")
236 (defcustom file-precious-flag nil
237 "Non-nil means protect against I/O errors while saving files.
238 Some modes set this non-nil in particular buffers.
240 This feature works by writing the new contents into a temporary file
241 and then renaming the temporary file to replace the original.
242 In this way, any I/O error in writing leaves the original untouched,
243 and there is never any instant where the file is nonexistent.
245 Note that this feature forces backups to be made by copying.
246 Yet, at the same time, saving a precious file
247 breaks any hard links between it and other files.
249 This feature is advisory: for example, if the directory in which the
250 file is being saved is not writable, Emacs may ignore a non-nil value
251 of `file-precious-flag' and write directly into the file.
253 See also: `break-hardlink-on-save'."
257 (defcustom break-hardlink-on-save nil
258 "Non-nil means when saving a file that exists under several names
259 \(i.e., has multiple hardlinks), break the hardlink associated with
260 `buffer-file-name' and write to a new file, so that the other
261 instances of the file are not affected by the save.
263 If `buffer-file-name' refers to a symlink, do not break the symlink.
265 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
266 For example, if the directory in which a file is being saved is not
267 itself writable, then error instead of saving in some
268 hardlink-nonbreaking way.
270 See also `backup-by-copying' and `backup-by-copying-when-linked'."
275 (defcustom version-control nil
276 "Control use of version numbers for backup files.
277 When t, make numeric backup versions unconditionally.
278 When nil, make them for files that have some already.
279 The value `never' means do not make them."
280 :type
'(choice (const :tag
"Never" never
)
281 (const :tag
"If existing" nil
)
282 (other :tag
"Always" t
))
285 (put 'version-control
'safe-local-variable
286 '(lambda (x) (or (booleanp x
) (equal x
'never
))))
288 (defcustom dired-kept-versions
2
289 "When cleaning directory, number of versions to keep."
294 (defcustom delete-old-versions nil
295 "If t, delete excess backup versions silently.
296 If nil, ask confirmation. Any other value prevents any trimming."
297 :type
'(choice (const :tag
"Delete" t
)
298 (const :tag
"Ask" nil
)
299 (other :tag
"Leave" other
))
302 (defcustom kept-old-versions
2
303 "Number of oldest versions to keep when a new numbered backup is made."
306 (put 'kept-old-versions
'safe-local-variable
'integerp
)
308 (defcustom kept-new-versions
2
309 "Number of newest versions to keep when a new numbered backup is made.
310 Includes the new backup. Must be > 0"
313 (put 'kept-new-versions
'safe-local-variable
'integerp
)
315 (defcustom require-final-newline nil
316 "Whether to add a newline automatically at the end of the file.
318 A value of t means do this only when the file is about to be saved.
319 A value of `visit' means do this right after the file is visited.
320 A value of `visit-save' means do it at both of those times.
321 Any other non-nil value means ask user whether to add a newline, when saving.
322 A value of nil means don't add newlines.
324 Certain major modes set this locally to the value obtained
325 from `mode-require-final-newline'."
326 :type
'(choice (const :tag
"When visiting" visit
)
327 (const :tag
"When saving" t
)
328 (const :tag
"When visiting or saving" visit-save
)
329 (const :tag
"Don't add newlines" nil
)
330 (other :tag
"Ask each time" ask
))
331 :group
'editing-basics
)
333 (defcustom mode-require-final-newline t
334 "Whether to add a newline at end of file, in certain major modes.
335 Those modes set `require-final-newline' to this value when you enable them.
336 They do so because they are often used for files that are supposed
337 to end in newlines, and the question is how to arrange that.
339 A value of t means do this only when the file is about to be saved.
340 A value of `visit' means do this right after the file is visited.
341 A value of `visit-save' means do it at both of those times.
342 Any other non-nil value means ask user whether to add a newline, when saving.
344 A value of nil means do not add newlines. That is a risky choice in this
345 variable since this value is used for modes for files that ought to have
346 final newlines. So if you set this to nil, you must explicitly check and
347 add a final newline, whenever you save a file that really needs one."
348 :type
'(choice (const :tag
"When visiting" visit
)
349 (const :tag
"When saving" t
)
350 (const :tag
"When visiting or saving" visit-save
)
351 (const :tag
"Don't add newlines" nil
)
352 (other :tag
"Ask each time" ask
))
353 :group
'editing-basics
356 (defcustom auto-save-default t
357 "Non-nil says by default do auto-saving of every file-visiting buffer."
361 (defcustom auto-save-file-name-transforms
362 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
363 ;; Don't put "\\2" inside expand-file-name, since it will be
364 ;; transformed to "/2" on DOS/Windows.
365 ,(concat temporary-file-directory
"\\2") t
))
366 "Transforms to apply to buffer file name before making auto-save file name.
367 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
368 REGEXP is a regular expression to match against the file name.
369 If it matches, `replace-match' is used to replace the
370 matching part with REPLACEMENT.
371 If the optional element UNIQUIFY is non-nil, the auto-save file name is
372 constructed by taking the directory part of the replaced file-name,
373 concatenated with the buffer file name with all directory separators
374 changed to `!' to prevent clashes. This will not work
375 correctly if your filesystem truncates the resulting name.
377 All the transforms in the list are tried, in the order they are listed.
378 When one transform applies, its result is final;
379 no further transforms are tried.
381 The default value is set up to put the auto-save file into the
382 temporary directory (see the variable `temporary-file-directory') for
383 editing a remote file.
385 On MS-DOS filesystems without long names this variable is always
388 :type
'(repeat (list (string :tag
"Regexp") (string :tag
"Replacement")
389 (boolean :tag
"Uniquify")))
390 :initialize
'custom-initialize-delay
393 (defcustom save-abbrevs t
394 "Non-nil means save word abbrevs too when files are saved.
395 If `silently', don't ask the user before saving."
396 :type
'(choice (const t
) (const nil
) (const silently
))
399 (defcustom find-file-run-dired t
400 "Non-nil means allow `find-file' to visit directories.
401 To visit the directory, `find-file' runs `find-directory-functions'."
405 (defcustom find-directory-functions
'(cvs-dired-noselect dired-noselect
)
406 "List of functions to try in sequence to visit a directory.
407 Each function is called with the directory name as the sole argument
408 and should return either a buffer or nil."
409 :type
'(hook :options
(cvs-dired-noselect dired-noselect
))
412 ;;;It is not useful to make this a local variable.
413 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
414 (defvar find-file-not-found-functions nil
415 "List of functions to be called for `find-file' on nonexistent file.
416 These functions are called as soon as the error is detected.
417 Variable `buffer-file-name' is already set up.
418 The functions are called in the order given until one of them returns non-nil.")
419 (define-obsolete-variable-alias 'find-file-not-found-hooks
420 'find-file-not-found-functions
"22.1")
422 ;;;It is not useful to make this a local variable.
423 ;;;(put 'find-file-hooks 'permanent-local t)
424 (define-obsolete-variable-alias 'find-file-hooks
'find-file-hook
"22.1")
425 (defcustom find-file-hook nil
426 "List of functions to be called after a buffer is loaded from a file.
427 The buffer's local variables (if any) will have been processed before the
428 functions are called."
431 :options
'(auto-insert)
434 (defvar write-file-functions nil
435 "List of functions to be called before writing out a buffer to a file.
436 If one of them returns non-nil, the file is considered already written
437 and the rest are not called.
438 These hooks are considered to pertain to the visited file.
439 So any buffer-local binding of this variable is discarded if you change
440 the visited file name with \\[set-visited-file-name], but not when you
441 change the major mode.
443 This hook is not run if any of the functions in
444 `write-contents-functions' returns non-nil. Both hooks pertain
445 to how to save a buffer to file, for instance, choosing a suitable
446 coding system and setting mode bits. (See Info
447 node `(elisp)Saving Buffers'.) To perform various checks or
448 updates before the buffer is saved, use `before-save-hook'.")
449 (put 'write-file-functions
'permanent-local t
)
450 (define-obsolete-variable-alias 'write-file-hooks
'write-file-functions
"22.1")
452 (defvar local-write-file-hooks nil
)
453 (make-variable-buffer-local 'local-write-file-hooks
)
454 (put 'local-write-file-hooks
'permanent-local t
)
455 (make-obsolete-variable 'local-write-file-hooks
'write-file-functions
"22.1")
457 (defvar write-contents-functions nil
458 "List of functions to be called before writing out a buffer to a file.
459 If one of them returns non-nil, the file is considered already written
460 and the rest are not called and neither are the functions in
461 `write-file-functions'.
463 This variable is meant to be used for hooks that pertain to the
464 buffer's contents, not to the particular visited file; thus,
465 `set-visited-file-name' does not clear this variable; but changing the
466 major mode does clear it.
468 For hooks that _do_ pertain to the particular visited file, use
469 `write-file-functions'. Both this variable and
470 `write-file-functions' relate to how a buffer is saved to file.
471 To perform various checks or updates before the buffer is saved,
472 use `before-save-hook'.")
473 (make-variable-buffer-local 'write-contents-functions
)
474 (define-obsolete-variable-alias 'write-contents-hooks
475 'write-contents-functions
"22.1")
477 (defcustom enable-local-variables t
478 "Control use of local variables in files you visit.
479 The value can be t, nil, :safe, :all, or something else.
481 A value of t means file local variables specifications are obeyed
482 if all the specified variable values are safe; if any values are
483 not safe, Emacs queries you, once, whether to set them all.
484 \(When you say yes to certain values, they are remembered as safe.)
486 :safe means set the safe variables, and ignore the rest.
487 :all means set all variables, whether safe or not.
488 (Don't set it permanently to :all.)
489 A value of nil means always ignore the file local variables.
491 Any other value means always query you once whether to set them all.
492 \(When you say yes to certain values, they are remembered as safe, but
493 this has no effect when `enable-local-variables' is \"something else\".)
495 This variable also controls use of major modes specified in
498 The command \\[normal-mode], when used interactively,
499 always obeys file local variable specifications and the -*- line,
500 and ignores this variable."
502 :type
'(choice (const :tag
"Query Unsafe" t
)
503 (const :tag
"Safe Only" :safe
)
504 (const :tag
"Do all" :all
)
505 (const :tag
"Ignore" nil
)
506 (other :tag
"Query" other
))
509 (defvar local-enable-local-variables t
510 "Like `enable-local-variables' but meant for buffer-local bindings.
511 The meaningful values are nil and non-nil. The default is non-nil.
512 If a major mode sets this to nil, buffer-locally, then any local
513 variables list in the file will be ignored.
515 This variable does not affect the use of major modes
516 specified in a -*- line.")
518 (defcustom enable-local-eval
'maybe
519 "Control processing of the \"variable\" `eval' in a file's local variables.
520 The value can be t, nil or something else.
521 A value of t means obey `eval' variables.
522 A value of nil means ignore them; anything else means query."
524 :type
'(choice (const :tag
"Obey" t
)
525 (const :tag
"Ignore" nil
)
526 (other :tag
"Query" other
))
529 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
530 (or (fboundp 'lock-buffer
)
531 (defalias 'lock-buffer
'ignore
))
532 (or (fboundp 'unlock-buffer
)
533 (defalias 'unlock-buffer
'ignore
))
534 (or (fboundp 'file-locked-p
)
535 (defalias 'file-locked-p
'ignore
))
537 (defcustom view-read-only nil
538 "Non-nil means buffers visiting files read-only do so in view mode.
539 In fact, this means that all read-only buffers normally have
540 View mode enabled, including buffers that are read-only because
541 you visit a file you cannot alter, and buffers you make read-only
542 using \\[toggle-read-only]."
546 (defvar file-name-history nil
547 "History list of file names entered in the minibuffer.
549 Maximum length of the history list is determined by the value
550 of `history-length', which see.")
552 (put 'ange-ftp-completion-hook-function
'safe-magic t
)
553 (defun ange-ftp-completion-hook-function (op &rest args
)
554 "Provides support for ange-ftp host name completion.
555 Runs the usual ange-ftp hook, but only for completion operations."
556 ;; Having this here avoids the need to load ange-ftp when it's not
558 (if (memq op
'(file-name-completion file-name-all-completions
))
559 (apply 'ange-ftp-hook-function op args
)
560 (let ((inhibit-file-name-handlers
561 (cons 'ange-ftp-completion-hook-function
562 (and (eq inhibit-file-name-operation op
)
563 inhibit-file-name-handlers
)))
564 (inhibit-file-name-operation op
))
567 (defun convert-standard-filename (filename)
568 "Convert a standard file's name to something suitable for the OS.
569 This means to guarantee valid names and perhaps to canonicalize
572 FILENAME should be an absolute file name since the conversion rules
573 sometimes vary depending on the position in the file name. E.g. c:/foo
574 is a valid DOS file name, but c:/bar/c:/foo is not.
576 This function's standard definition is trivial; it just returns
577 the argument. However, on Windows and DOS, replace invalid
578 characters. On DOS, make sure to obey the 8.3 limitations.
579 In the native Windows build, turn Cygwin names into native names,
580 and also turn slashes into backslashes if the shell requires it (see
581 `w32-shell-dos-semantics').
583 See Info node `(elisp)Standard File Names' for more details."
584 (if (eq system-type
'cygwin
)
585 (let ((name (copy-sequence filename
))
587 ;; Replace invalid filename characters with !
588 (while (string-match "[?*:<>|\"\000-\037]" name start
)
589 (aset name
(match-beginning 0) ?
!)
590 (setq start
(match-end 0)))
594 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
595 "Read directory name, prompting with PROMPT and completing in directory DIR.
596 Value is not expanded---you must call `expand-file-name' yourself.
597 Default name to DEFAULT-DIRNAME if user exits with the same
598 non-empty string that was inserted by this function.
599 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
600 or just DIR if INITIAL is nil.)
601 If the user exits with an empty minibuffer, this function returns
602 an empty string. (This can only happen if the user erased the
603 pre-inserted contents or if `insert-default-directory' is nil.)
604 Fourth arg MUSTMATCH non-nil means require existing directory's name.
605 Non-nil and non-t means also require confirmation after completion.
606 Fifth arg INITIAL specifies text to start with.
607 DIR should be an absolute directory name. It defaults to
608 the value of `default-directory'."
610 (setq dir default-directory
))
611 (read-file-name prompt dir
(or default-dirname
612 (if initial
(expand-file-name initial dir
)
619 "Show the current default directory."
621 (message "Directory %s" default-directory
))
624 "Value of the CDPATH environment variable, as a list.
625 Not actually set up until the first time you use it.")
627 (defun parse-colon-path (cd-path)
628 "Explode a search path into a list of directory names.
629 Directories are separated by occurrences of `path-separator'
630 \(which is colon in GNU and GNU-like systems)."
631 ;; We could use split-string here.
633 (let (cd-list (cd-start 0) cd-colon
)
634 (setq cd-path
(concat cd-path path-separator
))
635 (while (setq cd-colon
(string-match path-separator cd-path cd-start
))
638 (list (if (= cd-start cd-colon
)
640 (substitute-in-file-name
641 (file-name-as-directory
642 (substring cd-path cd-start cd-colon
)))))))
643 (setq cd-start
(+ cd-colon
1)))
646 (defun cd-absolute (dir)
647 "Change current directory to given absolute file name DIR."
648 ;; Put the name into directory syntax now,
649 ;; because otherwise expand-file-name may give some bad results.
650 (setq dir
(file-name-as-directory dir
))
651 (setq dir
(abbreviate-file-name (expand-file-name dir
)))
652 (if (not (file-directory-p dir
))
653 (if (file-exists-p dir
)
654 (error "%s is not a directory" dir
)
655 (error "%s: no such directory" dir
))
656 (unless (file-executable-p dir
)
657 (error "Cannot cd to %s: Permission denied" dir
))
658 (setq default-directory dir
)
659 (setq list-buffers-directory dir
)))
662 "Make DIR become the current buffer's default directory.
663 If your environment includes a `CDPATH' variable, try each one of
664 that list of directories (separated by occurrences of
665 `path-separator') when resolving a relative directory name.
666 The path separator is colon in GNU and GNU-like systems."
668 (list (read-directory-name "Change default directory: "
669 default-directory default-directory
670 (and (member cd-path
'(nil ("./")))
671 (null (getenv "CDPATH"))))))
672 (if (file-name-absolute-p dir
)
673 (cd-absolute (expand-file-name dir
))
675 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
676 (setq cd-path
(or trypath
(list "./")))))
677 (if (not (catch 'found
679 (function (lambda (x)
680 (let ((f (expand-file-name (concat x dir
))))
681 (if (file-directory-p f
)
684 (throw 'found t
))))))
687 (error "No such directory found via CDPATH environment variable"))))
689 (defun load-file (file)
690 "Load the Lisp file named FILE."
691 ;; This is a case where .elc makes a lot of sense.
692 (interactive (list (let ((completion-ignored-extensions
693 (remove ".elc" completion-ignored-extensions
)))
694 (read-file-name "Load file: "))))
695 (load (expand-file-name file
) nil nil t
))
697 (defun locate-file (filename path
&optional suffixes predicate
)
698 "Search for FILENAME through PATH.
699 If found, return the absolute file name of FILENAME, with its suffixes;
700 otherwise return nil.
701 PATH should be a list of directories to look in, like the lists in
702 `exec-path' or `load-path'.
703 If SUFFIXES is non-nil, it should be a list of suffixes to append to
704 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
705 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
706 If non-nil, PREDICATE is used instead of `file-readable-p'.
707 PREDICATE can also be an integer to pass to the `access' system call,
708 in which case file-name handlers are ignored. This usage is deprecated.
710 For compatibility, PREDICATE can also be one of the symbols
711 `executable', `readable', `writable', or `exists', or a list of
712 one or more of those symbols."
713 (if (and predicate
(symbolp predicate
) (not (functionp predicate
)))
714 (setq predicate
(list predicate
)))
715 (when (and (consp predicate
) (not (functionp predicate
)))
717 (logior (if (memq 'executable predicate
) 1 0)
718 (if (memq 'writable predicate
) 2 0)
719 (if (memq 'readable predicate
) 4 0))))
720 (locate-file-internal filename path suffixes predicate
))
722 (defun locate-file-completion-table (dirs suffixes string pred action
)
723 "Do completion for file names passed to `locate-file'."
725 ((file-name-absolute-p string
)
726 (let ((read-file-name-predicate pred
))
727 (read-file-name-internal string nil action
)))
728 ((eq (car-safe action
) 'boundaries
)
729 (let ((suffix (cdr action
)))
731 (length (file-name-directory string
))
732 (let ((x (file-name-directory suffix
)))
733 (if x
(1- (length x
)) (length suffix
))))))
736 (suffix (concat (regexp-opt suffixes t
) "\\'"))
737 (string-dir (file-name-directory string
))
738 (string-file (file-name-nondirectory string
)))
741 (setq dir default-directory
))
742 (if string-dir
(setq dir
(expand-file-name string-dir dir
)))
743 (when (file-directory-p dir
)
744 (dolist (file (file-name-all-completions
747 (when (string-match suffix file
)
748 (setq file
(substring file
0 (match-beginning 0)))
749 (push file names
)))))
750 (completion-table-with-context
751 string-dir names string-file pred action
)))))
753 (defun locate-file-completion (string path-and-suffixes action
)
754 "Do completion for file names passed to `locate-file'.
755 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
756 (locate-file-completion-table (car path-and-suffixes
)
757 (cdr path-and-suffixes
)
759 (make-obsolete 'locate-file-completion
'locate-file-completion-table
"23.1")
761 (defvar locate-dominating-stop-dir-regexp
762 "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'"
763 "Regexp of directory names which stop the search in `locate-dominating-file'.
764 Any directory whose name matches this regexp will be treated like
765 a kind of root directory by `locate-dominating-file' which will stop its search
766 when it bumps into it.
767 The default regexp prevents fruitless and time-consuming attempts to find
768 special files in directories in which filenames are interpreted as hostnames,
769 or mount points potentially requiring authentication as a different user.")
771 ;; (defun locate-dominating-files (file regexp)
772 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
773 ;; Stop at the first parent where a matching file is found and return the list
774 ;; of files that that match in this directory."
776 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
777 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
779 ;; ;; Abbreviate, so as to stop when we cross ~/.
780 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
783 ;; ;; As a heuristic, we stop looking up the hierarchy of
784 ;; ;; directories as soon as we find a directory belonging to
785 ;; ;; another user. This should save us from looking in
786 ;; ;; things like /net and /afs. This assumes that all the
787 ;; ;; files inside a project belong to the same user.
788 ;; (let ((prev-user user))
789 ;; (setq user (nth 2 (file-attributes dir)))
790 ;; (or (null prev-user) (equal user prev-user))))
791 ;; (if (setq files (condition-case nil
792 ;; (directory-files dir 'full regexp 'nosort)
794 ;; (throw 'found files)
796 ;; (setq dir (file-name-directory
797 ;; (directory-file-name dir))))
801 (defun locate-dominating-file (file name
)
802 "Look up the directory hierarchy from FILE for a file named NAME.
803 Stop at the first parent directory containing a file NAME,
804 and return the directory. Return nil if not found."
805 ;; We used to use the above locate-dominating-files code, but the
806 ;; directory-files call is very costly, so we're much better off doing
807 ;; multiple calls using the code in here.
809 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
810 ;; `name' in /home or in /.
811 (setq file
(abbreviate-file-name file
))
814 ;; `user' is not initialized outside the loop because
815 ;; `file' may not exist, so we may have to walk up part of the
816 ;; hierarchy before we find the "initial UID".
821 ;; FIXME: Disabled this heuristic because it is sometimes
823 ;; As a heuristic, we stop looking up the hierarchy of
824 ;; directories as soon as we find a directory belonging
825 ;; to another user. This should save us from looking in
826 ;; things like /net and /afs. This assumes that all the
827 ;; files inside a project belong to the same user.
828 ;; (let ((prev-user user))
829 ;; (setq user (nth 2 (file-attributes file)))
830 ;; (and prev-user (not (equal user prev-user))))
831 (string-match locate-dominating-stop-dir-regexp file
)))
832 (setq try
(file-exists-p (expand-file-name name file
)))
833 (cond (try (setq root file
))
834 ((equal file
(setq prev-file file
835 file
(file-name-directory
836 (directory-file-name file
))))
841 (defun executable-find (command)
842 "Search for COMMAND in `exec-path' and return the absolute file name.
843 Return nil if COMMAND is not found anywhere in `exec-path'."
844 ;; Use 1 rather than file-executable-p to better match the behavior of
846 (locate-file command exec-path exec-suffixes
1))
848 (defun load-library (library)
849 "Load the Emacs Lisp library named LIBRARY.
850 This is an interface to the function `load'. LIBRARY is searched
851 for in `load-path', both with and without `load-suffixes' (as
852 well as `load-file-rep-suffixes').
854 See Info node `(emacs)Lisp Libraries' for more details.
855 See `load-file' for a different interface to `load'."
857 (list (completing-read "Load library: "
858 (apply-partially 'locate-file-completion-table
860 (get-load-suffixes)))))
863 (defun file-remote-p (file &optional identification connected
)
864 "Test whether FILE specifies a location on a remote system.
865 Returns nil or a string identifying the remote connection (ideally
866 a prefix of FILE). For example, the remote identification for filename
867 \"/user@host:/foo\" could be \"/user@host:\".
868 A file is considered \"remote\" if accessing it is likely to be slower or
869 less reliable than accessing local files.
870 Furthermore, relative file names do not work across remote connections.
872 IDENTIFICATION specifies which part of the identification shall
873 be returned as string. IDENTIFICATION can be the symbol
874 `method', `user', `host' or `localname'; any other value is
875 handled like nil and means to return the complete identification
878 If CONNECTED is non-nil, the function returns an identification only
879 if FILE is located on a remote system, and a connection is established
880 to that remote system.
882 `file-remote-p' will never open a connection on its own."
883 (let ((handler (find-file-name-handler file
'file-remote-p
)))
885 (funcall handler
'file-remote-p file identification connected
)
888 (defun file-local-copy (file)
889 "Copy the file FILE into a temporary file on this machine.
890 Returns the name of the local copy, or nil, if FILE is directly
892 ;; This formerly had an optional BUFFER argument that wasn't used by
894 (let ((handler (find-file-name-handler file
'file-local-copy
)))
896 (funcall handler
'file-local-copy file
)
899 (defun file-truename (filename &optional counter prev-dirs
)
900 "Return the truename of FILENAME, which should be absolute.
901 The truename of a file name is found by chasing symbolic links
902 both at the level of the file and at the level of the directories
903 containing it, until no links are left at any level.
905 \(fn FILENAME)" ;; Don't document the optional arguments.
906 ;; COUNTER and PREV-DIRS are only used in recursive calls.
907 ;; COUNTER can be a cons cell whose car is the count of how many
908 ;; more links to chase before getting an error.
909 ;; PREV-DIRS can be a cons cell whose car is an alist
910 ;; of truenames we've just recently computed.
911 (cond ((or (string= filename
"") (string= filename
"~"))
912 (setq filename
(expand-file-name filename
))
913 (if (string= filename
"")
914 (setq filename
"/")))
915 ((and (string= (substring filename
0 1) "~")
916 (string-match "~[^/]*/?" filename
))
918 (substring filename
0 (match-end 0)))
919 (rest (substring filename
(match-end 0))))
920 (setq filename
(concat (expand-file-name first-part
) rest
)))))
922 (or counter
(setq counter
(list 100)))
924 ;; For speed, remove the ange-ftp completion handler from the list.
925 ;; We know it's not needed here.
926 ;; For even more speed, do this only on the outermost call.
927 (file-name-handler-alist
928 (if prev-dirs file-name-handler-alist
929 (let ((tem (copy-sequence file-name-handler-alist
)))
930 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
931 (or prev-dirs
(setq prev-dirs
(list nil
)))
933 ;; andrewi@harlequin.co.uk - none of the following code (except for
934 ;; invoking the file-name handler) currently applies on Windows
935 ;; (ie. there are no native symlinks), but there is an issue with
936 ;; case differences being ignored by the OS, and short "8.3 DOS"
937 ;; name aliases existing for all files. (The short names are not
938 ;; reported by directory-files, but can be used to refer to files.)
939 ;; It seems appropriate for file-truename to resolve these issues in
940 ;; the most natural way, which on Windows is to call the function
941 ;; `w32-long-file-name' - this returns the exact name of a file as
942 ;; it is stored on disk (expanding short name aliases with the full
943 ;; name in the process).
944 (if (eq system-type
'windows-nt
)
945 (let ((handler (find-file-name-handler filename
'file-truename
)))
946 ;; For file name that has a special handler, call handler.
947 ;; This is so that ange-ftp can save time by doing a no-op.
949 (setq filename
(funcall handler
'file-truename filename
))
950 ;; If filename contains a wildcard, newname will be the old name.
951 (unless (string-match "[[*?]" filename
)
952 ;; If filename exists, use the long name. If it doesn't exist,
953 ;; drill down until we find a directory that exists, and use
954 ;; the long name of that, with the extra non-existent path
955 ;; components concatenated.
956 (let ((longname (w32-long-file-name filename
))
959 (setq filename longname
)
960 ;; Include the preceding directory separator in the missing
961 ;; part so subsequent recursion on the rest works.
962 (setq missing
(concat "/" (file-name-nondirectory filename
)))
963 (let ((length (length missing
)))
965 (if (> length
(length filename
))
967 (substring filename
0 (- length
)))))
968 (setq filename
(concat (file-truename rest
) missing
))))))
971 ;; If this file directly leads to a link, process that iteratively
972 ;; so that we don't use lots of stack.
974 (setcar counter
(1- (car counter
)))
975 (if (< (car counter
) 0)
976 (error "Apparent cycle of symbolic links for %s" filename
))
977 (let ((handler (find-file-name-handler filename
'file-truename
)))
978 ;; For file name that has a special handler, call handler.
979 ;; This is so that ange-ftp can save time by doing a no-op.
981 (setq filename
(funcall handler
'file-truename filename
)
983 (let ((dir (or (file-name-directory filename
) default-directory
))
985 ;; Get the truename of the directory.
986 (setq dirfile
(directory-file-name dir
))
987 ;; If these are equal, we have the (or a) root directory.
988 (or (string= dir dirfile
)
989 ;; If this is the same dir we last got the truename for,
990 ;; save time--don't recalculate.
991 (if (assoc dir
(car prev-dirs
))
992 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
994 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
995 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
997 (if (equal ".." (file-name-nondirectory filename
))
999 (directory-file-name (file-name-directory (directory-file-name dir
)))
1001 (if (equal "." (file-name-nondirectory filename
))
1002 (setq filename
(directory-file-name dir
)
1004 ;; Put it back on the file name.
1005 (setq filename
(concat dir
(file-name-nondirectory filename
)))
1006 ;; Is the file name the name of a link?
1007 (setq target
(file-symlink-p filename
))
1009 ;; Yes => chase that link, then start all over
1010 ;; since the link may point to a directory name that uses links.
1011 ;; We can't safely use expand-file-name here
1012 ;; since target might look like foo/../bar where foo
1013 ;; is itself a link. Instead, we handle . and .. above.
1015 (if (file-name-absolute-p target
)
1017 (concat dir target
))
1020 (setq done t
))))))))
1023 (defun file-chase-links (filename &optional limit
)
1024 "Chase links in FILENAME until a name that is not a link.
1025 Unlike `file-truename', this does not check whether a parent
1026 directory name is a symbolic link.
1027 If the optional argument LIMIT is a number,
1028 it means chase no more than that many links and then stop."
1029 (let (tem (newname filename
)
1031 (while (and (or (null limit
) (< count limit
))
1032 (setq tem
(file-symlink-p newname
)))
1034 (if (and (null limit
) (= count
100))
1035 (error "Apparent cycle of symbolic links for %s" filename
))
1036 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1037 (while (string-match "//+" tem
)
1038 (setq tem
(replace-match "/" nil nil tem
)))
1039 ;; Handle `..' by hand, since it needs to work in the
1040 ;; target of any directory symlink.
1041 ;; This code is not quite complete; it does not handle
1042 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1043 (while (string-match "\\`\\.\\./" tem
)
1044 (setq tem
(substring tem
3))
1045 (setq newname
(expand-file-name newname
))
1046 ;; Chase links in the default dir of the symlink.
1049 (directory-file-name (file-name-directory newname
))))
1050 ;; Now find the parent of that dir.
1051 (setq newname
(file-name-directory newname
)))
1052 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
1053 (setq count
(1+ count
))))
1056 (defun make-temp-file (prefix &optional dir-flag suffix
)
1057 "Create a temporary file.
1058 The returned file name (created by appending some random characters at the end
1059 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1060 is guaranteed to point to a newly created empty file.
1061 You can then use `write-region' to write new data into the file.
1063 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1065 If SUFFIX is non-nil, add that at the end of the file name."
1066 (let ((umask (default-file-modes))
1070 ;; Create temp files with strict access rights. It's easy to
1071 ;; loosen them later, whereas it's impossible to close the
1072 ;; time-window of loose permissions otherwise.
1073 (set-default-file-modes ?
\700)
1074 (while (condition-case ()
1078 (if (zerop (length prefix
))
1079 (file-name-as-directory
1080 temporary-file-directory
)
1081 (expand-file-name prefix
1082 temporary-file-directory
))))
1084 (setq file
(concat file suffix
)))
1086 (make-directory file
)
1087 (write-region "" nil file nil
'silent nil
'excl
))
1089 (file-already-exists t
))
1090 ;; the file was somehow created by someone else between
1091 ;; `make-temp-name' and `write-region', let's try again.
1095 (set-default-file-modes umask
))))
1097 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
1098 "Change the encoding of FILE's name from CODING to NEW-CODING.
1099 The value is a new name of FILE.
1100 Signals a `file-already-exists' error if a file of the new name
1101 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1102 is non-nil. A number as fourth arg means request confirmation if
1103 the new name already exists. This is what happens in interactive
1106 (let ((default-coding (or file-name-coding-system
1107 default-file-name-coding-system
))
1108 (filename (read-file-name "Recode filename: " nil nil t
))
1109 from-coding to-coding
)
1110 (if (and default-coding
1111 ;; We provide the default coding only when it seems that
1112 ;; the filename is correctly decoded by the default
1114 (let ((charsets (find-charset-string filename
)))
1115 (and (not (memq 'eight-bit-control charsets
))
1116 (not (memq 'eight-bit-graphic charsets
)))))
1117 (setq from-coding
(read-coding-system
1118 (format "Recode filename %s from (default %s): "
1119 filename default-coding
)
1121 (setq from-coding
(read-coding-system
1122 (format "Recode filename %s from: " filename
))))
1124 ;; We provide the default coding only when a user is going to
1125 ;; change the encoding not from the default coding.
1126 (if (eq from-coding default-coding
)
1127 (setq to-coding
(read-coding-system
1128 (format "Recode filename %s from %s to: "
1129 filename from-coding
)))
1130 (setq to-coding
(read-coding-system
1131 (format "Recode filename %s from %s to (default %s): "
1132 filename from-coding default-coding
)
1134 (list filename from-coding to-coding
)))
1136 (let* ((default-coding (or file-name-coding-system
1137 default-file-name-coding-system
))
1138 ;; FILE should have been decoded by DEFAULT-CODING.
1139 (encoded (encode-coding-string file default-coding
))
1140 (newname (decode-coding-string encoded coding
))
1141 (new-encoded (encode-coding-string newname new-coding
))
1142 ;; Suppress further encoding.
1143 (file-name-coding-system nil
)
1144 (default-file-name-coding-system nil
)
1145 (locale-coding-system nil
))
1146 (rename-file encoded new-encoded ok-if-already-exists
)
1149 (defcustom confirm-nonexistent-file-or-buffer
'after-completion
1150 "Whether confirmation is requested before visiting a new file or buffer.
1151 If nil, confirmation is not requested.
1152 If the value is `after-completion', confirmation is only
1153 requested if the user called `minibuffer-complete' right before
1154 `minibuffer-complete-and-exit'.
1155 Any other non-nil value means to request confirmation.
1157 This affects commands like `switch-to-buffer' and `find-file'."
1160 :type
'(choice (const :tag
"After completion" after-completion
)
1161 (const :tag
"Never" nil
)
1162 (other :tag
"Always" t
)))
1164 (defun confirm-nonexistent-file-or-buffer ()
1165 "Whether to request confirmation before visiting a new file or buffer.
1166 The variable `confirm-nonexistent-file-or-buffer' determines the
1167 return value, which may be passed as the REQUIRE-MATCH arg to
1168 `read-buffer' or `find-file-read-args'."
1169 (cond ((eq confirm-nonexistent-file-or-buffer
'after-completion
)
1170 'confirm-after-completion
)
1171 (confirm-nonexistent-file-or-buffer
1175 (defun read-buffer-to-switch (prompt)
1176 "Read the name of a buffer to switch to and return as a string.
1177 It is intended for `switch-to-buffer' family of commands since they
1178 need to omit the name of current buffer from the list of completions
1179 and default values."
1180 (let ((rbts-completion-table (internal-complete-buffer-except)))
1181 (minibuffer-with-setup-hook
1183 (setq minibuffer-completion-table rbts-completion-table
)
1184 ;; Since rbts-completion-table is built dynamically, we
1185 ;; can't just add it to the default value of
1186 ;; icomplete-with-completion-tables, so we add it
1188 (if (and (boundp 'icomplete-with-completion-tables
)
1189 (listp icomplete-with-completion-tables
))
1190 (set (make-local-variable 'icomplete-with-completion-tables
)
1191 (cons rbts-completion-table
1192 icomplete-with-completion-tables
))))
1193 (read-buffer prompt
(other-buffer (current-buffer))
1194 (confirm-nonexistent-file-or-buffer)))))
1196 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord
)
1197 "Select the buffer specified by BUFFER-OR-NAME in another window.
1198 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1199 nil. Return the buffer switched to.
1201 If called interactively, prompt for the buffer name using the
1202 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1203 determines whether to request confirmation before creating a new
1206 If BUFFER-OR-NAME is a string and does not identify an existing
1207 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1208 nil, switch to the buffer returned by `other-buffer'.
1210 Optional second argument NORECORD non-nil means do not put this
1211 buffer at the front of the list of recently selected ones.
1213 This uses the function `display-buffer' as a subroutine; see its
1214 documentation for additional customization information."
1216 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1217 (let ((pop-up-windows t
)
1218 same-window-buffer-names same-window-regexps
)
1219 (pop-to-buffer buffer-or-name t norecord
)))
1221 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord
)
1222 "Switch to buffer BUFFER-OR-NAME in another frame.
1223 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1224 nil. Return the buffer switched to.
1226 If called interactively, prompt for the buffer name using the
1227 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1228 determines whether to request confirmation before creating a new
1231 If BUFFER-OR-NAME is a string and does not identify an existing
1232 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1233 nil, switch to the buffer returned by `other-buffer'.
1235 Optional second arg NORECORD non-nil means do not put this
1236 buffer at the front of the list of recently selected ones.
1238 This uses the function `display-buffer' as a subroutine; see its
1239 documentation for additional customization information."
1241 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1242 (let ((pop-up-frames t
)
1243 same-window-buffer-names same-window-regexps
)
1244 (pop-to-buffer buffer-or-name t norecord
)))
1246 (defun display-buffer-other-frame (buffer)
1247 "Display buffer BUFFER in another frame.
1248 This uses the function `display-buffer' as a subroutine; see
1249 its documentation for additional customization information."
1250 (interactive "BDisplay buffer in other frame: ")
1251 (let ((pop-up-frames t
)
1252 same-window-buffer-names same-window-regexps
1253 (old-window (selected-window))
1255 (setq new-window
(display-buffer buffer t
))
1256 ;; This may have been here in order to prevent the new frame from hiding
1257 ;; the old frame. But it does more harm than good.
1258 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1259 ;;(lower-frame (window-frame new-window))
1261 ;; This may have been here in order to make sure the old-frame gets the
1262 ;; focus. But not only can it cause an annoying flicker, with some
1263 ;; window-managers it just makes the window invisible, with no easy
1264 ;; way to recover it. --Stef
1265 ;;(make-frame-invisible (window-frame old-window))
1266 ;;(make-frame-visible (window-frame old-window))
1269 (defvar find-file-default nil
1270 "Used within `find-file-read-args'.")
1272 (defmacro minibuffer-with-setup-hook
(fun &rest body
)
1273 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1274 BODY should use the minibuffer at most once.
1275 Recursive uses of the minibuffer will not be affected."
1276 (declare (indent 1) (debug t
))
1277 (let ((hook (make-symbol "setup-hook")))
1281 ;; Clear out this hook so it does not interfere
1282 ;; with any recursive minibuffer usage.
1283 (remove-hook 'minibuffer-setup-hook
,hook
)
1287 (add-hook 'minibuffer-setup-hook
,hook
)
1289 (remove-hook 'minibuffer-setup-hook
,hook
)))))
1291 (defun find-file-read-args (prompt mustmatch
)
1292 (list (let ((find-file-default
1293 (and buffer-file-name
1294 (abbreviate-file-name buffer-file-name
))))
1295 (minibuffer-with-setup-hook
1296 (lambda () (setq minibuffer-default find-file-default
))
1297 (read-file-name prompt nil default-directory mustmatch
)))
1300 (defun find-file (filename &optional wildcards
)
1301 "Edit file FILENAME.
1302 Switch to a buffer visiting file FILENAME,
1303 creating one if none already exists.
1304 Interactively, the default if you just type RET is the current directory,
1305 but the visited file name is available through the minibuffer history:
1306 type M-n to pull it into the minibuffer.
1308 You can visit files on remote machines by specifying something
1309 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1310 also visit local files as a different user by specifying
1311 /sudo::FILE for the file name.
1312 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1313 manual, for more about this.
1315 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1316 expand wildcards (if any) and visit multiple files. You can
1317 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1319 To visit a file without any kind of conversion and without
1320 automatically choosing a major mode, use \\[find-file-literally]."
1322 (find-file-read-args "Find file: "
1323 (confirm-nonexistent-file-or-buffer)))
1324 (let ((value (find-file-noselect filename nil nil wildcards
)))
1326 (mapcar 'switch-to-buffer
(nreverse value
))
1327 (switch-to-buffer value
))))
1329 (defun find-file-other-window (filename &optional wildcards
)
1330 "Edit file FILENAME, in another window.
1332 Like \\[find-file] (which see), but creates a new window or reuses
1333 an existing one. See the function `display-buffer'.
1335 Interactively, the default if you just type RET is the current directory,
1336 but the visited file name is available through the minibuffer history:
1337 type M-n to pull it into the minibuffer.
1339 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1340 expand wildcards (if any) and visit multiple files."
1342 (find-file-read-args "Find file in other window: "
1343 (confirm-nonexistent-file-or-buffer)))
1344 (let ((value (find-file-noselect filename nil nil wildcards
)))
1347 (setq value
(nreverse value
))
1348 (cons (switch-to-buffer-other-window (car value
))
1349 (mapcar 'switch-to-buffer
(cdr value
))))
1350 (switch-to-buffer-other-window value
))))
1352 (defun find-file-other-frame (filename &optional wildcards
)
1353 "Edit file FILENAME, in another frame.
1355 Like \\[find-file] (which see), but creates a new frame or reuses
1356 an existing one. See the function `display-buffer'.
1358 Interactively, the default if you just type RET is the current directory,
1359 but the visited file name is available through the minibuffer history:
1360 type M-n to pull it into the minibuffer.
1362 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1363 expand wildcards (if any) and visit multiple files."
1365 (find-file-read-args "Find file in other frame: "
1366 (confirm-nonexistent-file-or-buffer)))
1367 (let ((value (find-file-noselect filename nil nil wildcards
)))
1370 (setq value
(nreverse value
))
1371 (cons (switch-to-buffer-other-frame (car value
))
1372 (mapcar 'switch-to-buffer
(cdr value
))))
1373 (switch-to-buffer-other-frame value
))))
1375 (defun find-file-existing (filename)
1376 "Edit the existing file FILENAME.
1377 Like \\[find-file], but only allow a file that exists, and do not allow
1378 file names with wildcards."
1379 (interactive (nbutlast (find-file-read-args "Find existing file: " t
)))
1380 (if (and (not (interactive-p)) (not (file-exists-p filename
)))
1381 (error "%s does not exist" filename
)
1382 (find-file filename
)
1385 (defun find-file-read-only (filename &optional wildcards
)
1386 "Edit file FILENAME but don't allow changes.
1387 Like \\[find-file], but marks buffer as read-only.
1388 Use \\[toggle-read-only] to permit editing."
1390 (find-file-read-args "Find file read-only: "
1391 (confirm-nonexistent-file-or-buffer)))
1392 (unless (or (and wildcards find-file-wildcards
1393 (not (string-match "\\`/:" filename
))
1394 (string-match "[[*?]" filename
))
1395 (file-exists-p filename
))
1396 (error "%s does not exist" filename
))
1397 (let ((value (find-file filename wildcards
)))
1398 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1399 (if (listp value
) value
(list value
)))
1402 (defun find-file-read-only-other-window (filename &optional wildcards
)
1403 "Edit file FILENAME in another window but don't allow changes.
1404 Like \\[find-file-other-window], but marks buffer as read-only.
1405 Use \\[toggle-read-only] to permit editing."
1407 (find-file-read-args "Find file read-only other window: "
1408 (confirm-nonexistent-file-or-buffer)))
1409 (unless (or (and wildcards find-file-wildcards
1410 (not (string-match "\\`/:" filename
))
1411 (string-match "[[*?]" filename
))
1412 (file-exists-p filename
))
1413 (error "%s does not exist" filename
))
1414 (let ((value (find-file-other-window filename wildcards
)))
1415 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1416 (if (listp value
) value
(list value
)))
1419 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1420 "Edit file FILENAME in another frame but don't allow changes.
1421 Like \\[find-file-other-frame], but marks buffer as read-only.
1422 Use \\[toggle-read-only] to permit editing."
1424 (find-file-read-args "Find file read-only other frame: "
1425 (confirm-nonexistent-file-or-buffer)))
1426 (unless (or (and wildcards find-file-wildcards
1427 (not (string-match "\\`/:" filename
))
1428 (string-match "[[*?]" filename
))
1429 (file-exists-p filename
))
1430 (error "%s does not exist" filename
))
1431 (let ((value (find-file-other-frame filename wildcards
)))
1432 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1433 (if (listp value
) value
(list value
)))
1436 (defun find-alternate-file-other-window (filename &optional wildcards
)
1437 "Find file FILENAME as a replacement for the file in the next window.
1438 This command does not select that window.
1440 See \\[find-file] for the possible forms of the FILENAME argument.
1442 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1443 expand wildcards (if any) and replace the file with multiple files."
1445 (save-selected-window
1447 (let ((file buffer-file-name
)
1451 (setq file-name
(file-name-nondirectory file
)
1452 file-dir
(file-name-directory file
)))
1453 (list (read-file-name
1454 "Find alternate file: " file-dir nil
1455 (confirm-nonexistent-file-or-buffer) file-name
)
1458 (find-file-other-window filename wildcards
)
1459 (save-selected-window
1461 (find-alternate-file filename wildcards
))))
1463 (defun find-alternate-file (filename &optional wildcards
)
1464 "Find file FILENAME, select its buffer, kill previous buffer.
1465 If the current buffer now contains an empty file that you just visited
1466 \(presumably by mistake), use this command to visit the file you really want.
1468 See \\[find-file] for the possible forms of the FILENAME argument.
1470 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1471 expand wildcards (if any) and replace the file with multiple files.
1473 If the current buffer is an indirect buffer, or the base buffer
1474 for one or more indirect buffers, the other buffer(s) are not
1477 (let ((file buffer-file-name
)
1481 (setq file-name
(file-name-nondirectory file
)
1482 file-dir
(file-name-directory file
)))
1483 (list (read-file-name
1484 "Find alternate file: " file-dir nil
1485 (confirm-nonexistent-file-or-buffer) file-name
)
1487 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1489 (when (and (buffer-modified-p) buffer-file-name
)
1490 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1493 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1494 (error "Aborted"))))
1495 (let ((obuf (current-buffer))
1496 (ofile buffer-file-name
)
1497 (onum buffer-file-number
)
1498 (odir dired-directory
)
1499 (otrue buffer-file-truename
)
1500 (oname (buffer-name)))
1501 ;; Run `kill-buffer-hook' here. It needs to happen before
1502 ;; variables like `buffer-file-name' etc are set to nil below,
1503 ;; because some of the hooks that could be invoked
1504 ;; (e.g., `save-place-to-alist') depend on those variables.
1506 ;; Note that `kill-buffer-hook' is not what queries whether to
1507 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1508 ;; asks that itself. Thus, there's no need to temporarily do
1509 ;; `(set-buffer-modified-p nil)' before running this hook.
1510 (run-hooks 'kill-buffer-hook
)
1511 ;; Okay, now we can end-of-life the old buffer.
1512 (if (get-buffer " **lose**")
1513 (kill-buffer " **lose**"))
1514 (rename-buffer " **lose**")
1518 ;; This prevents us from finding the same buffer
1519 ;; if we specified the same file again.
1520 (setq buffer-file-name nil
)
1521 (setq buffer-file-number nil
)
1522 (setq buffer-file-truename nil
)
1523 ;; Likewise for dired buffers.
1524 (setq dired-directory nil
)
1525 (find-file filename wildcards
))
1526 (when (eq obuf
(current-buffer))
1527 ;; This executes if find-file gets an error
1528 ;; and does not really find anything.
1529 ;; We put things back as they were.
1530 ;; If find-file actually finds something, we kill obuf below.
1531 (setq buffer-file-name ofile
)
1532 (setq buffer-file-number onum
)
1533 (setq buffer-file-truename otrue
)
1534 (setq dired-directory odir
)
1536 (rename-buffer oname
)))
1537 (unless (eq (current-buffer) obuf
)
1538 (with-current-buffer obuf
1539 ;; We already ran these; don't run them again.
1540 (let (kill-buffer-query-functions kill-buffer-hook
)
1541 (kill-buffer obuf
))))))
1543 (defun create-file-buffer (filename)
1544 "Create a suitably named buffer for visiting FILENAME, and return it.
1545 FILENAME (sans directory) is used unchanged if that name is free;
1546 otherwise a string <2> or <3> or ... is appended to get an unused name.
1547 Spaces at the start of FILENAME (sans directory) are removed."
1548 (let ((lastname (file-name-nondirectory filename
)))
1549 (if (string= lastname
"")
1550 (setq lastname filename
))
1552 (string-match "^ *\\(.*\\)" lastname
)
1553 (generate-new-buffer (match-string 1 lastname
)))))
1555 (defun generate-new-buffer (name)
1556 "Create and return a buffer with a name based on NAME.
1557 Choose the buffer's name using `generate-new-buffer-name'."
1558 (get-buffer-create (generate-new-buffer-name name
)))
1560 (defcustom automount-dir-prefix
"^/tmp_mnt/"
1561 "Regexp to match the automounter prefix in a directory name."
1565 (defvar abbreviated-home-dir nil
1566 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1568 (defun abbreviate-file-name (filename)
1569 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1570 This also substitutes \"~\" for the user's home directory (unless the
1571 home directory is a root directory) and removes automounter prefixes
1572 \(see the variable `automount-dir-prefix')."
1573 ;; Get rid of the prefixes added by the automounter.
1575 (if (and automount-dir-prefix
1576 (string-match automount-dir-prefix filename
)
1577 (file-exists-p (file-name-directory
1578 (substring filename
(1- (match-end 0))))))
1579 (setq filename
(substring filename
(1- (match-end 0)))))
1580 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1581 ;; To fix this right, we need a `file-name-case-sensitive-p'
1582 ;; function, but we don't have that yet, so just guess.
1583 (let ((case-fold-search
1584 (memq system-type
'(ms-dos windows-nt darwin cygwin
))))
1585 ;; If any elt of directory-abbrev-alist matches this name,
1586 ;; abbreviate accordingly.
1587 (dolist (dir-abbrev directory-abbrev-alist
)
1588 (if (string-match (car dir-abbrev
) filename
)
1590 (concat (cdr dir-abbrev
)
1591 (substring filename
(match-end 0))))))
1592 ;; Compute and save the abbreviated homedir name.
1593 ;; We defer computing this until the first time it's needed, to
1594 ;; give time for directory-abbrev-alist to be set properly.
1595 ;; We include a slash at the end, to avoid spurious matches
1596 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1597 (or abbreviated-home-dir
1598 (setq abbreviated-home-dir
1599 (let ((abbreviated-home-dir "$foo"))
1600 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1603 ;; If FILENAME starts with the abbreviated homedir,
1604 ;; make it start with `~' instead.
1605 (if (and (string-match abbreviated-home-dir filename
)
1606 ;; If the home dir is just /, don't change it.
1607 (not (and (= (match-end 0) 1)
1608 (= (aref filename
0) ?
/)))
1609 ;; MS-DOS root directories can come with a drive letter;
1610 ;; Novell Netware allows drive letters beyond `Z:'.
1611 (not (and (or (eq system-type
'ms-dos
)
1612 (eq system-type
'cygwin
)
1613 (eq system-type
'windows-nt
))
1615 (string-match "^[a-zA-`]:/$" filename
)))))
1618 (match-string 1 filename
)
1619 (substring filename
(match-end 0)))))
1622 (defcustom find-file-not-true-dirname-list nil
1623 "List of logical names for which visiting shouldn't save the true dirname."
1624 :type
'(repeat (string :tag
"Name"))
1627 (defun find-buffer-visiting (filename &optional predicate
)
1628 "Return the buffer visiting file FILENAME (a string).
1629 This is like `get-file-buffer', except that it checks for any buffer
1630 visiting the same file, possibly under a different name.
1631 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1632 and others are ignored.
1633 If there is no such live buffer, return nil."
1634 (let ((predicate (or predicate
#'identity
))
1635 (truename (abbreviate-file-name (file-truename filename
))))
1636 (or (let ((buf (get-file-buffer filename
)))
1637 (when (and buf
(funcall predicate buf
)) buf
))
1638 (let ((list (buffer-list)) found
)
1639 (while (and (not found
) list
)
1641 (set-buffer (car list
))
1642 (if (and buffer-file-name
1643 (string= buffer-file-truename truename
)
1644 (funcall predicate
(current-buffer)))
1645 (setq found
(car list
))))
1646 (setq list
(cdr list
)))
1648 (let* ((attributes (file-attributes truename
))
1649 (number (nthcdr 10 attributes
))
1650 (list (buffer-list)) found
)
1651 (and buffer-file-numbers-unique
1652 (car-safe number
) ;Make sure the inode is not just nil.
1653 (while (and (not found
) list
)
1654 (with-current-buffer (car list
)
1655 (if (and buffer-file-name
1656 (equal buffer-file-number number
)
1657 ;; Verify this buffer's file number
1658 ;; still belongs to its file.
1659 (file-exists-p buffer-file-name
)
1660 (equal (file-attributes buffer-file-truename
)
1662 (funcall predicate
(current-buffer)))
1663 (setq found
(car list
))))
1664 (setq list
(cdr list
))))
1667 (defcustom find-file-wildcards t
1668 "Non-nil means file-visiting commands should handle wildcards.
1669 For example, if you specify `*.c', that would visit all the files
1670 whose names match the pattern."
1675 (defcustom find-file-suppress-same-file-warnings nil
1676 "Non-nil means suppress warning messages for symlinked files.
1677 When nil, Emacs prints a warning when visiting a file that is already
1678 visited, but with a different name. Setting this option to t
1679 suppresses this warning."
1684 (defcustom large-file-warning-threshold
10000000
1685 "Maximum size of file above which a confirmation is requested.
1686 When nil, never request confirmation."
1690 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1692 (defun abort-if-file-too-large (size op-type filename
)
1693 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1694 OP-TYPE specifies the file operation being performed (for message to user)."
1695 (when (and large-file-warning-threshold size
1696 (> size large-file-warning-threshold
)
1698 (format "File %s is large (%dMB), really %s? "
1699 (file-name-nondirectory filename
)
1700 (/ size
1048576) op-type
))))
1703 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1704 "Read file FILENAME into a buffer and return the buffer.
1705 If a buffer exists visiting FILENAME, return that one, but
1706 verify that the file has not changed since visited or saved.
1707 The buffer is not selected, just returned to the caller.
1708 Optional second arg NOWARN non-nil means suppress any warning messages.
1709 Optional third arg RAWFILE non-nil means the file is read literally.
1710 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1711 and visit all the matching files. When wildcards are actually
1712 used and expanded, return a list of buffers that are visiting
1715 (abbreviate-file-name
1716 (expand-file-name filename
)))
1717 (if (file-directory-p filename
)
1718 (or (and find-file-run-dired
1719 (run-hook-with-args-until-success
1720 'find-directory-functions
1721 (if find-file-visit-truename
1722 (abbreviate-file-name (file-truename filename
))
1724 (error "%s is a directory" filename
))
1727 (not (string-match "\\`/:" filename
))
1728 (string-match "[[*?]" filename
))
1729 (let ((files (condition-case nil
1730 (file-expand-wildcards filename t
)
1731 (error (list filename
))))
1732 (find-file-wildcards nil
))
1734 (find-file-noselect filename
)
1735 (mapcar #'find-file-noselect files
)))
1736 (let* ((buf (get-file-buffer filename
))
1737 (truename (abbreviate-file-name (file-truename filename
)))
1738 (attributes (file-attributes truename
))
1739 (number (nthcdr 10 attributes
))
1740 ;; Find any buffer for a file which has same truename.
1741 (other (and (not buf
) (find-buffer-visiting filename
))))
1742 ;; Let user know if there is a buffer with the same truename.
1746 find-file-suppress-same-file-warnings
1747 (string-equal filename
(buffer-file-name other
))
1748 (message "%s and %s are the same file"
1749 filename
(buffer-file-name other
)))
1750 ;; Optionally also find that buffer.
1751 (if (or find-file-existing-other-name find-file-visit-truename
)
1753 ;; Check to see if the file looks uncommonly large.
1754 (when (not (or buf nowarn
))
1755 (abort-if-file-too-large (nth 7 attributes
) "open" filename
))
1757 ;; We are using an existing buffer.
1760 (verify-visited-file-modtime buf
)
1761 (cond ((not (file-exists-p filename
))
1762 (setq nonexistent t
)
1763 (message "File %s no longer exists!" filename
))
1764 ;; Certain files should be reverted automatically
1765 ;; if they have changed on disk and not in the buffer.
1766 ((and (not (buffer-modified-p buf
))
1767 (let ((tail revert-without-query
)
1770 (if (string-match (car tail
) filename
)
1772 (setq tail
(cdr tail
)))
1774 (with-current-buffer buf
1775 (message "Reverting file %s..." filename
)
1777 (message "Reverting file %s...done" filename
)))
1779 (if (string= (file-name-nondirectory filename
)
1782 (if (buffer-modified-p buf
)
1783 "File %s changed on disk. Discard your edits? "
1784 "File %s changed on disk. Reread from disk? ")
1785 (file-name-nondirectory filename
))
1787 (if (buffer-modified-p buf
)
1788 "File %s changed on disk. Discard your edits in %s? "
1789 "File %s changed on disk. Reread from disk into %s? ")
1790 (file-name-nondirectory filename
)
1791 (buffer-name buf
))))
1792 (with-current-buffer buf
1793 (revert-buffer t t
)))))
1794 (with-current-buffer buf
1796 ;; Check if a formerly read-only file has become
1797 ;; writable and vice versa, but if the buffer agrees
1798 ;; with the new state of the file, that is ok too.
1799 (let ((read-only (not (file-writable-p buffer-file-name
))))
1800 (unless (or nonexistent
1801 (eq read-only buffer-file-read-only
)
1802 (eq read-only buffer-read-only
))
1805 (format "File %s is %s on disk. Change buffer mode? "
1807 (if read-only
"read-only" "writable"))))
1808 (y-or-n-p question
)))
1809 (setq buffer-read-only read-only
)))
1810 (setq buffer-file-read-only read-only
))
1812 (when (and (not (eq (not (null rawfile
))
1813 (not (null find-file-literally
))))
1815 ;; It is confusing to ask whether to visit
1816 ;; non-literally if they have the file in
1818 (not (eq major-mode
'hexl-mode
)))
1819 (if (buffer-modified-p)
1823 "The file %s is already visited normally,
1824 and you have edited the buffer. Now you have asked to visit it literally,
1825 meaning no coding system handling, format conversion, or local variables.
1826 Emacs can only visit a file in one way at a time.
1828 Do you want to save the file, and visit it literally instead? "
1829 "The file %s is already visited literally,
1830 meaning no coding system handling, format conversion, or local variables.
1831 You have edited the buffer. Now you have asked to visit the file normally,
1832 but Emacs can only visit a file in one way at a time.
1834 Do you want to save the file, and visit it normally instead? ")
1835 (file-name-nondirectory filename
)))
1838 (find-file-noselect-1 buf filename nowarn
1839 rawfile truename number
))
1844 Do you want to discard your changes, and visit the file literally now? "
1846 Do you want to discard your changes, and visit the file normally now? ")))
1847 (find-file-noselect-1 buf filename nowarn
1848 rawfile truename number
)
1849 (error (if rawfile
"File already visited non-literally"
1850 "File already visited literally"))))
1854 "The file %s is already visited normally.
1855 You have asked to visit it literally,
1856 meaning no coding system decoding, format conversion, or local variables.
1857 But Emacs can only visit a file in one way at a time.
1859 Do you want to revisit the file literally now? "
1860 "The file %s is already visited literally,
1861 meaning no coding system decoding, format conversion, or local variables.
1862 You have asked to visit it normally,
1863 but Emacs can only visit a file in one way at a time.
1865 Do you want to revisit the file normally now? ")
1866 (file-name-nondirectory filename
)))
1867 (find-file-noselect-1 buf filename nowarn
1868 rawfile truename number
)
1869 (error (if rawfile
"File already visited non-literally"
1870 "File already visited literally"))))))
1871 ;; Return the buffer we are using.
1873 ;; Create a new buffer.
1874 (setq buf
(create-file-buffer filename
))
1875 ;; find-file-noselect-1 may use a different buffer.
1876 (find-file-noselect-1 buf filename nowarn
1877 rawfile truename number
))))))
1879 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1881 (with-current-buffer buf
1882 (kill-local-variable 'find-file-literally
)
1883 ;; Needed in case we are re-visiting the file with a different
1884 ;; text representation.
1885 (kill-local-variable 'buffer-file-coding-system
)
1886 (kill-local-variable 'cursor-type
)
1887 (let ((inhibit-read-only t
))
1889 (and (default-value 'enable-multibyte-characters
)
1891 (set-buffer-multibyte t
))
1894 (let ((inhibit-read-only t
))
1895 (insert-file-contents-literally filename t
))
1897 (when (and (file-exists-p filename
)
1898 (not (file-readable-p filename
)))
1900 (signal 'file-error
(list "File is not readable"
1902 ;; Unconditionally set error
1905 (let ((inhibit-read-only t
))
1906 (insert-file-contents filename t
))
1908 (when (and (file-exists-p filename
)
1909 (not (file-readable-p filename
)))
1911 (signal 'file-error
(list "File is not readable"
1913 ;; Run find-file-not-found-functions until one returns non-nil.
1914 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1915 ;; If they fail too, set error.
1917 ;; Record the file's truename, and maybe use that as visited name.
1918 (if (equal filename buffer-file-name
)
1919 (setq buffer-file-truename truename
)
1920 (setq buffer-file-truename
1921 (abbreviate-file-name (file-truename buffer-file-name
))))
1922 (setq buffer-file-number number
)
1923 (if find-file-visit-truename
1924 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
1925 ;; Set buffer's default directory to that of the file.
1926 (setq default-directory
(file-name-directory buffer-file-name
))
1927 ;; Turn off backup files for certain file names. Since
1928 ;; this is a permanent local, the major mode won't eliminate it.
1929 (and backup-enable-predicate
1930 (not (funcall backup-enable-predicate buffer-file-name
))
1932 (make-local-variable 'backup-inhibited
)
1933 (setq backup-inhibited t
)))
1936 (set-buffer-multibyte nil
)
1937 (setq buffer-file-coding-system
'no-conversion
)
1938 (set-buffer-major-mode buf
)
1939 (make-local-variable 'find-file-literally
)
1940 (setq find-file-literally t
))
1941 (after-find-file error
(not nowarn
)))
1944 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
1945 "Like `insert-file-contents', but only reads in the file literally.
1946 A buffer may be modified in several ways after reading into the buffer,
1947 to Emacs features such as format decoding, character code
1948 conversion, `find-file-hook', automatic uncompression, etc.
1950 This function ensures that none of these modifications will take place."
1951 (let ((format-alist nil
)
1952 (after-insert-file-functions nil
)
1953 (coding-system-for-read 'no-conversion
)
1954 (coding-system-for-write 'no-conversion
)
1955 (find-buffer-file-type-function
1956 (if (fboundp 'find-buffer-file-type
)
1957 (symbol-function 'find-buffer-file-type
)
1959 (inhibit-file-name-handlers
1960 (append '(jka-compr-handler image-file-handler epa-file-handler
)
1961 inhibit-file-name-handlers
))
1962 (inhibit-file-name-operation 'insert-file-contents
))
1965 (fset 'find-buffer-file-type
(lambda (filename) t
))
1966 (insert-file-contents filename visit beg end replace
))
1967 (if find-buffer-file-type-function
1968 (fset 'find-buffer-file-type find-buffer-file-type-function
)
1969 (fmakunbound 'find-buffer-file-type
)))))
1971 (defun insert-file-1 (filename insert-func
)
1972 (if (file-directory-p filename
)
1973 (signal 'file-error
(list "Opening input file" "file is a directory"
1975 ;; Check whether the file is uncommonly large
1976 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert" filename
)
1977 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
1978 #'buffer-modified-p
))
1979 (tem (funcall insert-func filename
)))
1980 (push-mark (+ (point) (car (cdr tem
))))
1982 (message "File %s already visited and modified in buffer %s"
1983 filename
(buffer-name buffer
)))))
1985 (defun insert-file-literally (filename)
1986 "Insert contents of file FILENAME into buffer after point with no conversion.
1988 This function is meant for the user to run interactively.
1989 Don't call it from programs! Use `insert-file-contents-literally' instead.
1990 \(Its calling sequence is different; see its documentation)."
1991 (interactive "*fInsert file literally: ")
1992 (insert-file-1 filename
#'insert-file-contents-literally
))
1994 (defvar find-file-literally nil
1995 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1996 This is a permanent local.")
1997 (put 'find-file-literally
'permanent-local t
)
1999 (defun find-file-literally (filename)
2000 "Visit file FILENAME with no conversion of any kind.
2001 Format conversion and character code conversion are both disabled,
2002 and multibyte characters are disabled in the resulting buffer.
2003 The major mode used is Fundamental mode regardless of the file name,
2004 and local variable specifications in the file are ignored.
2005 Automatic uncompression and adding a newline at the end of the
2006 file due to `require-final-newline' is also disabled.
2008 You cannot absolutely rely on this function to result in
2009 visiting the file literally. If Emacs already has a buffer
2010 which is visiting the file, you get the existing buffer,
2011 regardless of whether it was created literally or not.
2013 In a Lisp program, if you want to be sure of accessing a file's
2014 contents literally, you should create a temporary buffer and then read
2015 the file contents into it using `insert-file-contents-literally'."
2016 (interactive "FFind file literally: ")
2017 (switch-to-buffer (find-file-noselect filename nil t
)))
2019 (defvar after-find-file-from-revert-buffer nil
)
2021 (defun after-find-file (&optional error warn noauto
2022 after-find-file-from-revert-buffer
2024 "Called after finding a file and by the default revert function.
2025 Sets buffer mode, parses local variables.
2026 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2027 error in reading the file. WARN non-nil means warn if there
2028 exists an auto-save file more recent than the visited file.
2029 NOAUTO means don't mess with auto-save mode.
2030 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2031 means this call was from `revert-buffer'.
2032 Fifth arg NOMODES non-nil means don't alter the file's modes.
2033 Finishes by calling the functions in `find-file-hook'
2034 unless NOMODES is non-nil."
2035 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
2042 ((and error
(file-attributes buffer-file-name
))
2043 (setq buffer-read-only t
)
2044 "File exists, but cannot be read")
2045 ((not buffer-read-only
)
2047 ;; No need to warn if buffer is auto-saved
2048 ;; under the name of the visited file.
2049 (not (and buffer-file-name
2050 auto-save-visited-file-name
))
2051 (file-newer-than-file-p (or buffer-auto-save-file-name
2052 (make-auto-save-file-name))
2054 (format "%s has auto save data; consider M-x recover-this-file"
2055 (file-name-nondirectory buffer-file-name
))
2056 (setq not-serious t
)
2057 (if error
"(New file)" nil
)))
2059 (setq not-serious t
)
2060 "Note: file is write protected")
2061 ((file-attributes (directory-file-name default-directory
))
2062 "File not found and directory write-protected")
2063 ((file-exists-p (file-name-directory buffer-file-name
))
2064 (setq buffer-read-only nil
))
2066 (setq buffer-read-only nil
)
2067 "Use M-x make-directory RET RET to create the directory and its parents"))))
2070 (or not-serious
(sit-for 1 t
))))
2071 (when (and auto-save-default
(not noauto
))
2072 (auto-save-mode t
)))
2073 ;; Make people do a little extra work (C-x C-q)
2074 ;; before altering a backup file.
2075 (when (backup-file-name-p buffer-file-name
)
2076 (setq buffer-read-only t
))
2077 ;; When a file is marked read-only,
2078 ;; make the buffer read-only even if root is looking at it.
2079 (when (and (file-modes (buffer-file-name))
2080 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
2081 (setq buffer-read-only t
))
2083 (when (and view-read-only view-mode
)
2084 (view-mode-disable))
2086 ;; If requested, add a newline at the end of the file.
2087 (and (memq require-final-newline
'(visit visit-save
))
2088 (> (point-max) (point-min))
2089 (/= (char-after (1- (point-max))) ?
\n)
2090 (not (and (eq selective-display t
)
2091 (= (char-after (1- (point-max))) ?
\r)))
2093 (goto-char (point-max))
2095 (when (and buffer-read-only
2097 (not (eq (get major-mode
'mode-class
) 'special
)))
2099 (run-hooks 'find-file-hook
)))
2101 (defmacro report-errors
(format &rest body
)
2102 "Eval BODY and turn any error into a FORMAT message.
2103 FORMAT can have a %s escape which will be replaced with the actual error.
2104 If `debug-on-error' is set, errors are not caught, so that you can
2106 Avoid using a large BODY since it is duplicated."
2107 (declare (debug t
) (indent 1))
2112 (error (message ,format
(prin1-to-string err
))))))
2114 (defun normal-mode (&optional find-file
)
2115 "Choose the major mode for this buffer automatically.
2116 Also sets up any specified local variables of the file.
2117 Uses the visited file name, the -*- line, and the local variables spec.
2119 This function is called automatically from `find-file'. In that case,
2120 we may set up the file-specified mode and local variables,
2121 depending on the value of `enable-local-variables'.
2122 In addition, if `local-enable-local-variables' is nil, we do
2123 not set local variables (though we do notice a mode specified with -*-.)
2125 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2126 or from Lisp without specifying the optional argument FIND-FILE;
2127 in that case, this function acts as if `enable-local-variables' were t."
2129 (funcall (or (default-value 'major-mode
) 'fundamental-mode
))
2130 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
2131 (report-errors "File mode specification error: %s"
2133 (report-errors "File local-variables error: %s"
2134 (hack-local-variables)))
2135 ;; Turn font lock off and on, to make sure it takes account of
2136 ;; whatever file local variables are relevant to it.
2137 (when (and font-lock-mode
2138 ;; Font-lock-mode (now in font-core.el) can be ON when
2139 ;; font-lock.el still hasn't been loaded.
2140 (boundp 'font-lock-keywords
)
2141 (eq (car font-lock-keywords
) t
))
2142 (setq font-lock-keywords
(cadr font-lock-keywords
))
2145 (if (fboundp 'ucs-set-table-for-input
) ; don't lose when building
2146 (ucs-set-table-for-input)))
2148 (defcustom auto-mode-case-fold nil
2149 "Non-nil means to try second pass through `auto-mode-alist'.
2150 This means that if the first case-sensitive search through the alist fails
2151 to find a matching major mode, a second case-insensitive search is made.
2152 On systems with case-insensitive file names, this variable is ignored,
2153 since only a single case-insensitive search through the alist is made."
2158 (defvar auto-mode-alist
2159 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2160 ;; c++-mode, java-mode and more) are added through autoload
2161 ;; directives in that file. That way is discouraged since it
2162 ;; spreads out the definition of the initial value.
2165 (cons (purecopy (car elt
)) (cdr elt
)))
2166 `(;; do this first, so that .html.pl is Polish html, not Perl
2167 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2168 ("\\.te?xt\\'" . text-mode
)
2169 ("\\.[tT]e[xX]\\'" . tex-mode
)
2170 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2171 ("\\.ltx\\'" . latex-mode
)
2172 ("\\.dtx\\'" . doctex-mode
)
2173 ("\\.org\\'" . org-mode
)
2174 ("\\.el\\'" . emacs-lisp-mode
)
2175 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2176 ("\\.l\\'" . lisp-mode
)
2177 ("\\.li?sp\\'" . lisp-mode
)
2178 ("\\.[fF]\\'" . fortran-mode
)
2179 ("\\.for\\'" . fortran-mode
)
2180 ("\\.p\\'" . pascal-mode
)
2181 ("\\.pas\\'" . pascal-mode
)
2182 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode
)
2183 ("\\.ad[abs]\\'" . ada-mode
)
2184 ("\\.ad[bs].dg\\'" . ada-mode
)
2185 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2186 ("Imakefile\\'" . makefile-imake-mode
)
2187 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2188 ("\\.makepp\\'" . makefile-makepp-mode
)
2189 ,@(if (memq system-type
'(berkeley-unix darwin
))
2190 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2191 ("GNUmakefile\\'" . makefile-gmake-mode
)
2192 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2193 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2194 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2195 ("\\.am\\'" . makefile-automake-mode
)
2196 ;; Less common extensions come here
2197 ;; so more common ones above are found faster.
2198 ("\\.texinfo\\'" . texinfo-mode
)
2199 ("\\.te?xi\\'" . texinfo-mode
)
2200 ("\\.[sS]\\'" . asm-mode
)
2201 ("\\.asm\\'" . asm-mode
)
2202 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2203 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2204 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2205 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2206 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2207 ("\\.bash\\'" . sh-mode
)
2208 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2209 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2210 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2211 ("\\.m?spec\\'" . sh-mode
)
2212 ("\\.m[mes]\\'" . nroff-mode
)
2213 ("\\.man\\'" . nroff-mode
)
2214 ("\\.sty\\'" . latex-mode
)
2215 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2216 ("\\.bbl\\'" . latex-mode
)
2217 ("\\.bib\\'" . bibtex-mode
)
2218 ("\\.sql\\'" . sql-mode
)
2219 ("\\.m[4c]\\'" . m4-mode
)
2220 ("\\.mf\\'" . metafont-mode
)
2221 ("\\.mp\\'" . metapost-mode
)
2222 ("\\.vhdl?\\'" . vhdl-mode
)
2223 ("\\.article\\'" . text-mode
)
2224 ("\\.letter\\'" . text-mode
)
2225 ("\\.i?tcl\\'" . tcl-mode
)
2226 ("\\.exp\\'" . tcl-mode
)
2227 ("\\.itk\\'" . tcl-mode
)
2228 ("\\.icn\\'" . icon-mode
)
2229 ("\\.sim\\'" . simula-mode
)
2230 ("\\.mss\\'" . scribe-mode
)
2231 ("\\.f9[05]\\'" . f90-mode
)
2232 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2233 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode
)
2234 ("\\.prolog\\'" . prolog-mode
)
2235 ("\\.tar\\'" . tar-mode
)
2236 ;; The list of archive file extensions should be in sync with
2237 ;; `auto-coding-alist' with `no-conversion' coding system.
2239 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2240 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode
)
2241 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode
) ;OpenOffice.org
2242 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode
) ; Debian/Opkg packages.
2243 ;; Mailer puts message to be edited in
2244 ;; /tmp/Re.... or Message
2245 ("\\`/tmp/Re" . text-mode
)
2246 ("/Message[0-9]*\\'" . text-mode
)
2247 ("\\.zone\\'" . zone-mode
)
2248 ;; some news reader is reported to use this
2249 ("\\`/tmp/fol/" . text-mode
)
2250 ("\\.oak\\'" . scheme-mode
)
2251 ("\\.sgml?\\'" . sgml-mode
)
2252 ("\\.x[ms]l\\'" . xml-mode
)
2253 ("\\.dtd\\'" . sgml-mode
)
2254 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2255 ("\\.js\\'" . js-mode
) ; javascript-mode would be better
2256 ("\\.[ds]?v\\'" . verilog-mode
)
2257 ;; .emacs or .gnus or .viper following a directory delimiter in
2258 ;; Unix, MSDOG or VMS syntax.
2259 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2260 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2261 ;; _emacs following a directory delimiter
2263 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2264 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2265 ("\\.ml\\'" . lisp-mode
)
2266 ;; Common Lisp ASDF package system.
2267 ("\\.asd\\'" . lisp-mode
)
2268 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2269 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2270 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2271 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2272 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2273 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode
)
2274 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2275 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode
)
2276 ("BROWSE\\'" . ebrowse-tree-mode
)
2277 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2278 ("#\\*mail\\*" . mail-mode
)
2279 ("\\.g\\'" . antlr-mode
)
2280 ("\\.ses\\'" . ses-mode
)
2281 ("\\.\\(soa\\|zone\\)\\'" . dns-mode
)
2282 ("\\.docbook\\'" . sgml-mode
)
2283 ("\\.com\\'" . dcl-mode
)
2284 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2285 ;; Windows candidates may be opened case sensitively on Unix
2286 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2287 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2288 ("\\.ppd\\'" . conf-ppd-mode
)
2289 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2290 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2291 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2292 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2293 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2294 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2295 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2296 ;; this has lower priority to avoid matching changelog.sgml etc.
2297 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2298 ;; either user's dot-files or under /etc or some such
2299 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2300 ;; alas not all ~/.*rc files are like this
2301 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2302 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2303 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2304 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2305 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2306 ;; this contains everything twice, with space and with colon :-(
2307 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2308 ;; Get rid of any trailing .n.m and try again.
2309 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2310 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2311 ;; Using mode nil rather than `ignore' would let the search continue
2312 ;; through this list (with the shortened name) rather than start over.
2313 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2314 ;; The following should come after the ChangeLog pattern
2315 ;; for the sake of ChangeLog.1, etc.
2316 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2317 ("\\.[1-9]\\'" . nroff-mode
)
2318 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)))
2319 "Alist of filename patterns vs corresponding major mode functions.
2320 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2321 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2322 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2323 mode function to use. FUNCTION will be called, unless it is nil.
2325 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2326 calling FUNCTION (if it's not nil), we delete the suffix that matched
2327 REGEXP and search the list again for another match.
2329 If the file name matches `inhibit-first-line-modes-regexps',
2330 then `auto-mode-alist' is not processed.
2332 The extensions whose FUNCTION is `archive-mode' should also
2333 appear in `auto-coding-alist' with `no-conversion' coding system.
2335 See also `interpreter-mode-alist', which detects executable script modes
2336 based on the interpreters they specify to run,
2337 and `magic-mode-alist', which determines modes based on file contents.")
2338 (put 'auto-mode-alist
'risky-local-variable t
)
2340 (defun conf-mode-maybe ()
2341 "Select Conf mode or XML mode according to start of file."
2345 (goto-char (point-min))
2346 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2350 (defvar interpreter-mode-alist
2351 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2352 ;; and pike-mode) are added through autoload directives in that
2353 ;; file. That way is discouraged since it spreads out the
2354 ;; definition of the initial value.
2357 (cons (purecopy (car l
)) (cdr l
)))
2358 '(("perl" . perl-mode
)
2359 ("perl5" . perl-mode
)
2360 ("miniperl" . perl-mode
)
2362 ("wishx" . tcl-mode
)
2364 ("tclsh" . tcl-mode
)
2365 ("scm" . scheme-mode
)
2385 ("tail" . text-mode
)
2386 ("more" . text-mode
)
2387 ("less" . text-mode
)
2389 ("make" . makefile-gmake-mode
) ; Debian uses this
2390 ("guile" . scheme-mode
)
2391 ("clisp" . lisp-mode
)))
2392 "Alist mapping interpreter names to major modes.
2393 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2394 Each element looks like (INTERPRETER . MODE).
2395 If INTERPRETER matches the name of the interpreter specified in the first line
2396 of a script, mode MODE is enabled.
2398 See also `auto-mode-alist'.")
2400 (defvar inhibit-first-line-modes-regexps
'("\\.tar\\'" "\\.tgz\\'")
2401 "List of regexps; if one matches a file name, don't look for `-*-'.")
2403 (defvar inhibit-first-line-modes-suffixes nil
2404 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2405 When checking `inhibit-first-line-modes-regexps', we first discard
2406 from the end of the file name anything that matches one of these regexps.")
2408 (defvar auto-mode-interpreter-regexp
2409 "#![ \t]?\\([^ \t\n]*\
2410 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2411 "Regexp matching interpreters, for file mode determination.
2412 This regular expression is matched against the first line of a file
2413 to determine the file's mode in `set-auto-mode'. If it matches, the file
2414 is assumed to be interpreted by the interpreter matched by the second group
2415 of the regular expression. The mode is then determined as the mode
2416 associated with that interpreter in `interpreter-mode-alist'.")
2418 (defvar magic-mode-alist nil
2419 "Alist of buffer beginnings vs. corresponding major mode functions.
2420 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2421 After visiting a file, if REGEXP matches the text at the beginning of the
2422 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2423 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2426 If FUNCTION is nil, then it is not called. (That is a way of saying
2427 \"allow `auto-mode-alist' to decide for these files.\")")
2428 (put 'magic-mode-alist
'risky-local-variable t
)
2430 (defvar magic-fallback-mode-alist
2431 `((image-type-auto-detected-p . image-mode
)
2432 ("\\(PK00\\)?[P]K\003\004" . archive-mode
) ; zip
2433 ;; The < comes before the groups (but the first) to reduce backtracking.
2434 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2435 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2436 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2437 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2438 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2440 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2441 "[Hh][Tt][Mm][Ll]"))
2443 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2444 ;; These two must come after html, because they are more general:
2445 ("<\\?xml " . xml-mode
)
2446 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2447 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2448 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2451 ("# xmcd " . conf-unix-mode
))
2452 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2453 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2454 After visiting a file, if REGEXP matches the text at the beginning of the
2455 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2456 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2457 have not specified a mode for this file.
2459 If FUNCTION is nil, then it is not called.")
2460 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2462 (defvar magic-mode-regexp-match-limit
4000
2463 "Upper limit on `magic-mode-alist' regexp matches.
2464 Also applies to `magic-fallback-mode-alist'.")
2466 (defun set-auto-mode (&optional keep-mode-if-same
)
2467 "Select major mode appropriate for current buffer.
2469 To find the right major mode, this function checks for a -*- mode tag,
2470 checks if it uses an interpreter listed in `interpreter-mode-alist',
2471 matches the buffer beginning against `magic-mode-alist',
2472 compares the filename against the entries in `auto-mode-alist',
2473 then matches the buffer beginning against `magic-fallback-mode-alist'.
2475 It does not check for the `mode:' local variable in the
2476 Local Variables section of the file; for that, use `hack-local-variables'.
2478 If `enable-local-variables' is nil, this function does not check for a
2481 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2482 set the major mode only if that would change it. In other words
2483 we don't actually set it to the same mode the buffer already has."
2484 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2485 (let (end done mode modes
)
2486 ;; Find a -*- mode tag
2488 (goto-char (point-min))
2489 (skip-chars-forward " \t\n")
2490 (and enable-local-variables
2491 (setq end
(set-auto-mode-1))
2492 (if (save-excursion (search-forward ":" end t
))
2493 ;; Find all specifications for the `mode:' variable
2494 ;; and execute them left to right.
2495 (while (let ((case-fold-search t
))
2496 (or (and (looking-at "mode:")
2497 (goto-char (match-end 0)))
2498 (re-search-forward "[ \t;]mode:" end t
)))
2499 (skip-chars-forward " \t")
2500 (let ((beg (point)))
2501 (if (search-forward ";" end t
)
2504 (skip-chars-backward " \t")
2505 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2507 ;; Simple -*-MODE-*- case.
2508 (push (intern (concat (downcase (buffer-substring (point) end
))
2511 ;; If we found modes to use, invoke them now, outside the save-excursion.
2514 (dolist (mode (nreverse modes
))
2515 (if (not (functionp mode
))
2516 (message "Ignoring unknown mode `%s'" mode
)
2518 (or (set-auto-mode-0 mode keep-mode-if-same
)
2519 ;; continuing would call minor modes again, toggling them off
2520 (throw 'nop nil
))))))
2521 ;; If we didn't, look for an interpreter specified in the first line.
2522 ;; As a special case, allow for things like "#!/bin/env perl", which
2523 ;; finds the interpreter anywhere in $PATH.
2525 (setq mode
(save-excursion
2526 (goto-char (point-min))
2527 (if (looking-at auto-mode-interpreter-regexp
)
2530 ;; Map interpreter name to a mode, signalling we're done at the
2532 done
(assoc (file-name-nondirectory mode
)
2533 interpreter-mode-alist
))
2534 ;; If we found an interpreter mode to use, invoke it now.
2536 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2537 ;; Next try matching the buffer beginning against magic-mode-alist.
2539 (if (setq done
(save-excursion
2540 (goto-char (point-min))
2542 (narrow-to-region (point-min)
2544 (+ (point-min) magic-mode-regexp-match-limit
)))
2545 (assoc-default nil magic-mode-alist
2549 (looking-at re
)))))))
2550 (set-auto-mode-0 done keep-mode-if-same
)))
2551 ;; Next compare the filename against the entries in auto-mode-alist.
2553 (if buffer-file-name
2554 (let ((name buffer-file-name
)
2555 (remote-id (file-remote-p buffer-file-name
)))
2556 ;; Remove remote file name identification.
2557 (when (and (stringp remote-id
)
2558 (string-match (regexp-quote remote-id
) name
))
2559 (setq name
(substring name
(match-end 0))))
2560 ;; Remove backup-suffixes from file name.
2561 (setq name
(file-name-sans-versions name
))
2563 ;; Find first matching alist entry.
2565 (if (memq system-type
'(windows-nt cygwin
))
2566 ;; System is case-insensitive.
2567 (let ((case-fold-search t
))
2568 (assoc-default name auto-mode-alist
2570 ;; System is case-sensitive.
2572 ;; First match case-sensitively.
2573 (let ((case-fold-search nil
))
2574 (assoc-default name auto-mode-alist
2576 ;; Fallback to case-insensitive match.
2577 (and auto-mode-case-fold
2578 (let ((case-fold-search t
))
2579 (assoc-default name auto-mode-alist
2584 (setq mode
(car mode
)
2585 name
(substring name
0 (match-beginning 0)))
2588 (set-auto-mode-0 mode keep-mode-if-same
)
2590 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2592 (if (setq done
(save-excursion
2593 (goto-char (point-min))
2595 (narrow-to-region (point-min)
2597 (+ (point-min) magic-mode-regexp-match-limit
)))
2598 (assoc-default nil magic-fallback-mode-alist
2602 (looking-at re
)))))))
2603 (set-auto-mode-0 done keep-mode-if-same
)))))
2605 ;; When `keep-mode-if-same' is set, we are working on behalf of
2606 ;; set-visited-file-name. In that case, if the major mode specified is the
2607 ;; same one we already have, don't actually reset it. We don't want to lose
2608 ;; minor modes such as Font Lock.
2609 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2610 "Apply MODE and return it.
2611 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2612 any aliases and compared to current major mode. If they are the
2613 same, do nothing and return nil."
2614 (unless (and keep-mode-if-same
2615 (eq (indirect-function mode
)
2616 (indirect-function major-mode
)))
2621 (defun set-auto-mode-1 ()
2622 "Find the -*- spec in the buffer.
2623 Call with point at the place to start searching from.
2624 If one is found, set point to the beginning
2625 and return the position of the end.
2626 Otherwise, return nil; point may be changed."
2629 ;; Don't look for -*- if this file name matches any
2630 ;; of the regexps in inhibit-first-line-modes-regexps.
2631 (let ((temp inhibit-first-line-modes-regexps
)
2632 (name (if buffer-file-name
2633 (file-name-sans-versions buffer-file-name
)
2635 (while (let ((sufs inhibit-first-line-modes-suffixes
))
2636 (while (and sufs
(not (string-match (car sufs
) name
)))
2637 (setq sufs
(cdr sufs
)))
2639 (setq name
(substring name
0 (match-beginning 0))))
2641 (not (string-match (car temp
) name
)))
2642 (setq temp
(cdr temp
)))
2645 (search-forward "-*-" (line-end-position
2646 ;; If the file begins with "#!"
2647 ;; (exec interpreter magic), look
2648 ;; for mode frobs in the first two
2649 ;; lines. You cannot necessarily
2650 ;; put them in the first line of
2651 ;; such a file without screwing up
2652 ;; the interpreter invocation.
2653 ;; The same holds for
2655 ;; in man pages (preprocessor
2656 ;; magic for the `man' program).
2657 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t
)
2659 (skip-chars-forward " \t")
2661 (search-forward "-*-" (line-end-position) t
))
2664 (skip-chars-backward " \t")
2669 ;;; Handling file local variables
2671 (defvar ignored-local-variables
2672 '(ignored-local-variables safe-local-variable-values
2673 file-local-variables-alist dir-local-variables-alist
)
2674 "Variables to be ignored in a file's local variable spec.")
2675 (put 'ignored-local-variables
'risky-local-variable t
)
2677 (defvar hack-local-variables-hook nil
2678 "Normal hook run after processing a file's local variables specs.
2679 Major modes can use this to examine user-specified local variables
2680 in order to initialize other data structure based on them.")
2682 (defcustom safe-local-variable-values nil
2683 "List variable-value pairs that are considered safe.
2684 Each element is a cons cell (VAR . VAL), where VAR is a variable
2685 symbol and VAL is a value that is considered safe."
2690 (defcustom safe-local-eval-forms
2691 '((add-hook 'write-file-functions
'time-stamp
)
2692 (add-hook 'before-save-hook
'time-stamp
))
2693 "Expressions that are considered safe in an `eval:' local variable.
2694 Add expressions to this list if you want Emacs to evaluate them, when
2695 they appear in an `eval' local variable specification, without first
2696 asking you for confirmation."
2700 :type
'(repeat sexp
))
2702 ;; Risky local variables:
2703 (mapc (lambda (var) (put var
'risky-local-variable t
))
2705 buffer-auto-save-file-name
2707 buffer-file-truename
2710 default-text-properties
2714 file-name-handler-alist
2723 minor-mode-map-alist
2724 minor-mode-overriding-map-alist
2727 overriding-local-map
2728 overriding-terminal-local-map
2732 unread-command-events
))
2734 ;; Safe local variables:
2736 ;; For variables defined by major modes, the safety declarations can go into
2737 ;; the major mode's file, since that will be loaded before file variables are
2740 ;; For variables defined by minor modes, put the safety declarations in the
2741 ;; file defining the minor mode after the defcustom/defvar using an autoload
2744 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2746 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2747 ;; minor mode file may not be loaded yet.
2749 ;; For variables defined in the C source code the declaration should go here:
2751 (mapc (lambda (pair)
2752 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2753 '((buffer-read-only . booleanp
) ;; C source code
2754 (default-directory . stringp
) ;; C source code
2755 (fill-column . integerp
) ;; C source code
2756 (indent-tabs-mode . booleanp
) ;; C source code
2757 (left-margin . integerp
) ;; C source code
2758 (no-update-autoloads . booleanp
)
2759 (tab-width . integerp
) ;; C source code
2760 (truncate-lines . booleanp
))) ;; C source code
2762 (put 'c-set-style
'safe-local-eval-function t
)
2764 (defvar file-local-variables-alist nil
2765 "Alist of file-local variable settings in the current buffer.
2766 Each element in this list has the form (VAR . VALUE), where VAR
2767 is a file-local variable (a symbol) and VALUE is the value
2768 specified. The actual value in the buffer may differ from VALUE,
2769 if it is changed by the major or minor modes, or by the user.")
2770 (make-variable-buffer-local 'file-local-variables-alist
)
2772 (defvar dir-local-variables-alist nil
2773 "Alist of directory-local variable settings in the current buffer.
2774 Each element in this list has the form (VAR . VALUE), where VAR
2775 is a directory-local variable (a symbol) and VALUE is the value
2776 specified in .dir-locals.el. The actual value in the buffer
2777 may differ from VALUE, if it is changed by the major or minor modes,
2779 (make-variable-buffer-local 'dir-local-variables-alist
)
2781 (defvar before-hack-local-variables-hook nil
2782 "Normal hook run before setting file-local variables.
2783 It is called after checking for unsafe/risky variables and
2784 setting `file-local-variables-alist', and before applying the
2785 variables stored in `file-local-variables-alist'. A hook
2786 function is allowed to change the contents of this alist.
2788 This hook is called only if there is at least one file-local
2791 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name
)
2792 "Get confirmation before setting up local variable values.
2793 ALL-VARS is the list of all variables to be set up.
2794 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2795 RISKY-VARS is the list of those that are marked as risky.
2796 DIR-NAME is a directory name if these settings come from
2797 directory-local variables, or nil otherwise."
2800 (let ((name (or dir-name
2801 (if buffer-file-name
2802 (file-name-nondirectory buffer-file-name
)
2803 (concat "buffer " (buffer-name)))))
2804 (offer-save (and (eq enable-local-variables t
) unsafe-vars
))
2806 (save-window-excursion
2807 (let ((buf (get-buffer-create "*Local Variables*")))
2809 (set (make-local-variable 'cursor-type
) nil
)
2812 (insert "The local variables list in " name
2813 "\ncontains values that may not be safe (*)"
2815 ", and variables that are risky (**)."
2818 (insert "The local variables list in " name
2819 "\ncontains variables that are risky (**).")
2820 (insert "A local variables list is specified in " name
".")))
2821 (insert "\n\nDo you want to apply it? You can type
2822 y -- to apply the local variables list.
2823 n -- to ignore the local variables list.")
2826 ! -- to apply the local variables list, and permanently mark these
2827 values (*) as safe (in the future, they will be set automatically.)\n\n")
2829 (dolist (elt all-vars
)
2830 (cond ((member elt unsafe-vars
)
2832 ((member elt risky-vars
)
2836 (princ (car elt
) buf
)
2838 ;; Make strings with embedded whitespace easier to read.
2839 (let ((print-escape-newlines t
))
2840 (prin1 (cdr elt
) buf
))
2843 (format "Please type %s%s: "
2844 (if offer-save
"y, n, or !" "y or n")
2845 (if (< (line-number-at-pos) (window-body-height))
2847 ", or C-v to scroll")))
2848 (goto-char (point-min))
2849 (let ((cursor-in-echo-area t
)
2850 (executing-kbd-macro executing-kbd-macro
)
2852 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2855 (message "%s" prompt
)
2856 (setq char
(read-event))
2858 (cond ((eq char ?\C-v
)
2861 (error (goto-char (point-min)))))
2862 ;; read-event returns -1 if we are in a kbd
2863 ;; macro and there are no more events in the
2864 ;; macro. In that case, attempt to get an
2865 ;; event interactively.
2866 ((and executing-kbd-macro
(= char -
1))
2867 (setq executing-kbd-macro nil
))
2868 (t (setq done
(memq (downcase char
) exit-chars
)))))))
2869 (setq char
(downcase char
))
2870 (when (and offer-save
(= char ?
!) unsafe-vars
)
2871 (dolist (elt unsafe-vars
)
2872 (add-to-list 'safe-local-variable-values elt
))
2873 ;; When this is called from desktop-restore-file-buffer,
2874 ;; coding-system-for-read may be non-nil. Reset it before
2875 ;; writing to .emacs.
2876 (if (or custom-file user-init-file
)
2877 (let ((coding-system-for-read nil
))
2878 (customize-save-variable
2879 'safe-local-variable-values
2880 safe-local-variable-values
))))
2886 (defun hack-local-variables-prop-line (&optional mode-only
)
2887 "Return local variables specified in the -*- line.
2888 Ignore any specification for `mode:' and `coding:';
2889 `set-auto-mode' should already have handled `mode:',
2890 `set-auto-coding' should already have handled `coding:'.
2892 If MODE-ONLY is non-nil, all we do is check whether the major
2893 mode is specified, returning t if it is specified. Otherwise,
2894 return an alist of elements (VAR . VAL), where VAR is a variable
2895 and VAL is the specified value."
2897 (goto-char (point-min))
2898 (let ((end (set-auto-mode-1))
2899 result mode-specified
)
2900 ;; Parse the -*- line into the RESULT alist.
2901 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2904 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2905 ;; Simple form: "-*- MODENAME -*-". Already handled.
2906 (setq mode-specified t
)
2909 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2910 ;; (last ";" is optional).
2911 (while (< (point) end
)
2912 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2913 (error "Malformed -*- line"))
2914 (goto-char (match-end 0))
2915 ;; There used to be a downcase here,
2916 ;; but the manual didn't say so,
2917 ;; and people want to set var names that aren't all lc.
2918 (let ((key (intern (match-string 1)))
2919 (val (save-restriction
2920 (narrow-to-region (point) end
)
2921 (let ((read-circle nil
))
2922 (read (current-buffer))))))
2923 ;; It is traditional to ignore
2924 ;; case when checking for `mode' in set-auto-mode,
2925 ;; so we must do that here as well.
2926 ;; That is inconsistent, but we're stuck with it.
2927 ;; The same can be said for `coding' in set-auto-coding.
2928 (or (and (equal (downcase (symbol-name key
)) "mode")
2929 (setq mode-specified t
))
2930 (equal (downcase (symbol-name key
)) "coding")
2932 (push (cons (if (eq key
'eval
)
2934 (indirect-variable key
))
2937 (skip-chars-forward " \t;")))))
2943 (defun hack-local-variables-filter (variables dir-name
)
2944 "Filter local variable settings, querying the user if necessary.
2945 VARIABLES is the alist of variable-value settings. This alist is
2946 filtered based on the values of `ignored-local-variables',
2947 `enable-local-eval', `enable-local-variables', and (if necessary)
2948 user interaction. The results are added to
2949 `file-local-variables-alist', without applying them.
2950 DIR-NAME is a directory name if these settings come from
2951 directory-local variables, or nil otherwise."
2952 ;; Find those variables that we may want to save to
2953 ;; `safe-local-variable-values'.
2954 (let (all-vars risky-vars unsafe-vars
)
2955 (dolist (elt variables
)
2956 (let ((var (car elt
))
2958 (cond ((memq var ignored-local-variables
)
2959 ;; Ignore any variable in `ignored-local-variables'.
2961 ;; Obey `enable-local-eval'.
2963 (when enable-local-eval
2965 (or (eq enable-local-eval t
)
2966 (hack-one-local-variable-eval-safep (eval (quote val
)))
2967 (push elt unsafe-vars
))))
2968 ;; Ignore duplicates in the present list.
2969 ((assq var all-vars
) nil
)
2970 ;; Accept known-safe variables.
2971 ((or (memq var
'(mode unibyte coding
))
2972 (safe-local-variable-p var val
))
2973 (push elt all-vars
))
2974 ;; The variable is either risky or unsafe:
2975 ((not (eq enable-local-variables
:safe
))
2977 (if (risky-local-variable-p var val
)
2978 (push elt risky-vars
)
2979 (push elt unsafe-vars
))))))
2981 ;; Query, unless all vars are safe or user wants no querying.
2982 (or (and (eq enable-local-variables t
)
2985 (memq enable-local-variables
'(:all
:safe
))
2986 (hack-local-variables-confirm all-vars unsafe-vars
2987 risky-vars dir-name
))
2988 (dolist (elt all-vars
)
2989 (unless (eq (car elt
) 'eval
)
2991 (setq dir-local-variables-alist
2992 (assq-delete-all (car elt
) dir-local-variables-alist
)))
2993 (setq file-local-variables-alist
2994 (assq-delete-all (car elt
) file-local-variables-alist
)))
2995 (push elt file-local-variables-alist
)))))
2997 (defun hack-local-variables (&optional mode-only
)
2998 "Parse and put into effect this buffer's local variables spec.
2999 If MODE-ONLY is non-nil, all we do is check whether the major mode
3000 is specified, returning t if it is specified."
3001 (let ((enable-local-variables
3002 (and local-enable-local-variables enable-local-variables
))
3005 (setq file-local-variables-alist nil
)
3006 (report-errors "Directory-local variables error: %s"
3007 (hack-dir-local-variables)))
3008 (when (or mode-only enable-local-variables
)
3009 (setq result
(hack-local-variables-prop-line mode-only
))
3010 ;; Look for "Local variables:" line in last page.
3012 (goto-char (point-max))
3013 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3015 (when (let ((case-fold-search t
))
3016 (search-forward "Local Variables:" nil t
))
3017 (skip-chars-forward " \t")
3018 ;; suffix is what comes after "local variables:" in its line.
3019 ;; prefix is what comes before "local variables:" in its line.
3022 (regexp-quote (buffer-substring (point)
3023 (line-end-position)))
3026 (concat "^" (regexp-quote
3027 (buffer-substring (line-beginning-position)
3028 (match-beginning 0)))))
3032 (let ((startpos (point))
3034 (thisbuf (current-buffer)))
3036 (unless (let ((case-fold-search t
))
3038 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
3040 ;; This used to be an error, but really all it means is
3041 ;; that this may simply not be a local-variables section,
3042 ;; so just ignore it.
3043 (message "Local variables list is not properly terminated"))
3045 (setq endpos
(point)))
3048 (insert-buffer-substring thisbuf startpos endpos
)
3049 (goto-char (point-min))
3050 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
3052 ;; Discard the prefix.
3053 (if (looking-at prefix
)
3054 (delete-region (point) (match-end 0))
3055 (error "Local variables entry is missing the prefix"))
3057 ;; Discard the suffix.
3058 (if (looking-back suffix
)
3059 (delete-region (match-beginning 0) (point))
3060 (error "Local variables entry is missing the suffix"))
3062 (goto-char (point-min))
3065 ;; Find the variable name; strip whitespace.
3066 (skip-chars-forward " \t")
3068 (skip-chars-forward "^:\n")
3069 (if (eolp) (error "Missing colon in local variables entry"))
3070 (skip-chars-backward " \t")
3071 (let* ((str (buffer-substring beg
(point)))
3072 (var (let ((read-circle nil
))
3075 ;; Read the variable value.
3076 (skip-chars-forward "^:")
3078 (let ((read-circle nil
))
3079 (setq val
(read (current-buffer))))
3083 (unless (eq var
'coding
)
3085 (push (cons (if (eq var
'eval
)
3087 (indirect-variable var
))
3090 (forward-line 1))))))))
3091 ;; Now we've read all the local variables.
3092 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3093 (cond (mode-only result
)
3094 ;; Otherwise, set the variables.
3095 (enable-local-variables
3096 (hack-local-variables-filter result nil
)
3097 (when file-local-variables-alist
3098 ;; Any 'evals must run in the Right sequence.
3099 (setq file-local-variables-alist
3100 (nreverse file-local-variables-alist
))
3101 (run-hooks 'before-hack-local-variables-hook
)
3102 (dolist (elt file-local-variables-alist
)
3103 (hack-one-local-variable (car elt
) (cdr elt
))))
3104 (run-hooks 'hack-local-variables-hook
)))))
3106 (defun safe-local-variable-p (sym val
)
3107 "Non-nil if SYM is safe as a file-local variable with value VAL.
3108 It is safe if any of these conditions are met:
3110 * There is a matching entry (SYM . VAL) in the
3111 `safe-local-variable-values' user option.
3113 * The `safe-local-variable' property of SYM is a function that
3114 evaluates to a non-nil value with VAL as an argument."
3115 (or (member (cons sym val
) safe-local-variable-values
)
3116 (let ((safep (get sym
'safe-local-variable
)))
3117 (and (functionp safep
) (funcall safep val
)))))
3119 (defun risky-local-variable-p (sym &optional ignored
)
3120 "Non-nil if SYM could be dangerous as a file-local variable.
3121 It is dangerous if either of these conditions are met:
3123 * Its `risky-local-variable' property is non-nil.
3125 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3126 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3127 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3128 \"map-alist\", or \"bindat-spec\"."
3129 ;; If this is an alias, check the base name.
3131 (setq sym
(indirect-variable sym
))
3133 (or (get sym
'risky-local-variable
)
3134 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3135 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3136 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3137 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
3139 (defun hack-one-local-variable-quotep (exp)
3140 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
3142 (defun hack-one-local-variable-constantp (exp)
3143 (or (and (not (symbolp exp
)) (not (consp exp
)))
3146 (hack-one-local-variable-quotep exp
)))
3148 (defun hack-one-local-variable-eval-safep (exp)
3149 "Return t if it is safe to eval EXP when it is found in a file."
3150 (or (not (consp exp
))
3151 ;; Detect certain `put' expressions.
3152 (and (eq (car exp
) 'put
)
3153 (hack-one-local-variable-quotep (nth 1 exp
))
3154 (hack-one-local-variable-quotep (nth 2 exp
))
3155 (let ((prop (nth 1 (nth 2 exp
)))
3157 (cond ((memq prop
'(lisp-indent-hook
3158 lisp-indent-function
3159 scheme-indent-function
))
3160 ;; Only allow safe values (not functions).
3162 (and (hack-one-local-variable-quotep val
)
3163 (eq (nth 1 val
) 'defun
))))
3164 ((eq prop
'edebug-form-spec
)
3165 ;; Only allow indirect form specs.
3166 ;; During bootstrapping, edebug-basic-spec might not be
3168 (and (fboundp 'edebug-basic-spec
)
3169 (hack-one-local-variable-quotep val
)
3170 (edebug-basic-spec (nth 1 val
)))))))
3171 ;; Allow expressions that the user requested.
3172 (member exp safe-local-eval-forms
)
3173 ;; Certain functions can be allowed with safe arguments
3174 ;; or can specify verification functions to try.
3175 (and (symbolp (car exp
))
3176 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
3179 (dolist (arg (cdr exp
))
3180 (unless (hack-one-local-variable-constantp arg
)
3187 (dolist (function prop
)
3188 (if (funcall function exp
)
3192 (defun hack-one-local-variable (var val
)
3193 "Set local variable VAR with value VAL.
3194 If VAR is `mode', call `VAL-mode' as a function unless it's
3195 already the major mode."
3196 (cond ((eq var
'mode
)
3197 (let ((mode (intern (concat (downcase (symbol-name val
))
3199 (unless (eq (indirect-function mode
)
3200 (indirect-function major-mode
))
3201 (if (memq mode minor-mode-list
)
3202 ;; A minor mode must be passed an argument.
3203 ;; Otherwise, if the user enables the minor mode in a
3204 ;; major mode hook, this would toggle it off.
3208 (save-excursion (eval val
)))
3210 ;; Make sure the string has no text properties.
3211 ;; Some text properties can get evaluated in various ways,
3212 ;; so it is risky to put them on with a local variable list.
3214 (set-text-properties 0 (length val
) nil val
))
3215 (set (make-local-variable var
) val
))))
3217 ;;; Handling directory-local variables, aka project settings.
3219 (defvar dir-locals-class-alist
'()
3220 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3222 (defvar dir-locals-directory-cache
'()
3223 "List of cached directory roots for directory-local variable classes.
3224 Each element in this list has the form (DIR CLASS MTIME).
3225 DIR is the name of the directory.
3226 CLASS is the name of a variable class (a symbol).
3227 MTIME is the recorded modification time of the directory-local
3228 variables file associated with this entry. This time is a list
3229 of two integers (the same format as `file-attributes'), and is
3230 used to test whether the cache entry is still valid.
3231 Alternatively, MTIME can be nil, which means the entry is always
3234 (defsubst dir-locals-get-class-variables
(class)
3235 "Return the variable list for CLASS."
3236 (cdr (assq class dir-locals-class-alist
)))
3238 (defun dir-locals-collect-mode-variables (mode-variables variables
)
3239 "Collect directory-local variables from MODE-VARIABLES.
3240 VARIABLES is the initial list of variables.
3241 Returns the new list."
3242 (dolist (pair mode-variables variables
)
3243 (let* ((variable (car pair
))
3245 (slot (assq variable variables
)))
3246 ;; If variables are specified more than once, only use the last. (Why?)
3247 ;; The pseudo-variables mode and eval are different (bug#3430).
3248 (if (and slot
(not (memq variable
'(mode eval
))))
3250 ;; Need a new cons in case we setcdr later.
3251 (push (cons variable value
) variables
)))))
3253 (defun dir-locals-collect-variables (class-variables root variables
)
3254 "Collect entries from CLASS-VARIABLES into VARIABLES.
3255 ROOT is the root directory of the project.
3256 Return the new variables list."
3257 (let* ((file-name (buffer-file-name))
3258 (sub-file-name (if file-name
3259 (substring file-name
(length root
)))))
3260 (dolist (entry class-variables variables
)
3261 (let ((key (car entry
)))
3264 ;; Don't include this in the previous condition, because we
3265 ;; want to filter all strings before the next condition.
3266 (when (and sub-file-name
3267 (>= (length sub-file-name
) (length key
))
3268 (string= key
(substring sub-file-name
0 (length key
))))
3269 (setq variables
(dir-locals-collect-variables
3270 (cdr entry
) root variables
))))
3272 (derived-mode-p key
))
3273 (setq variables
(dir-locals-collect-mode-variables
3274 (cdr entry
) variables
))))))))
3276 (defun dir-locals-set-directory-class (directory class
&optional mtime
)
3277 "Declare that the DIRECTORY root is an instance of CLASS.
3278 DIRECTORY is the name of a directory, a string.
3279 CLASS is the name of a project class, a symbol.
3280 MTIME is either the modification time of the directory-local
3281 variables file that defined this class, or nil.
3283 When a file beneath DIRECTORY is visited, the mode-specific
3284 variables from CLASS are applied to the buffer. The variables
3285 for a class are defined using `dir-locals-set-class-variables'."
3286 (setq directory
(file-name-as-directory (expand-file-name directory
)))
3287 (unless (assq class dir-locals-class-alist
)
3288 (error "No such class `%s'" (symbol-name class
)))
3289 (push (list directory class mtime
) dir-locals-directory-cache
))
3291 (defun dir-locals-set-class-variables (class variables
)
3292 "Map the type CLASS to a list of variable settings.
3293 CLASS is the project class, a symbol. VARIABLES is a list
3294 that declares directory-local variables for the class.
3295 An element in VARIABLES is either of the form:
3296 (MAJOR-MODE . ALIST)
3300 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3301 whose elements are of the form (VARIABLE . VALUE).
3303 In the second form, DIRECTORY is a directory name (a string), and
3304 LIST is a list of the form accepted by the function.
3306 When a file is visited, the file's class is found. A directory
3307 may be assigned a class using `dir-locals-set-directory-class'.
3308 Then variables are set in the file's buffer according to the
3309 class' LIST. The list is processed in order.
3311 * If the element is of the form (MAJOR-MODE . ALIST), and the
3312 buffer's major mode is derived from MAJOR-MODE (as determined
3313 by `derived-mode-p'), then all the variables in ALIST are
3314 applied. A MAJOR-MODE of nil may be used to match any buffer.
3315 `make-local-variable' is called for each variable before it is
3318 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3319 is an initial substring of the file's directory, then LIST is
3320 applied by recursively following these rules."
3321 (let ((elt (assq class dir-locals-class-alist
)))
3323 (setcdr elt variables
)
3324 (push (cons class variables
) dir-locals-class-alist
))))
3326 (defconst dir-locals-file
".dir-locals.el"
3327 "File that contains directory-local variables.
3328 It has to be constant to enforce uniform values
3329 across different environments and users.")
3331 (defun dir-locals-find-file (file)
3332 "Find the directory-local variables for FILE.
3333 This searches upward in the directory tree from FILE.
3334 If the directory root of FILE has been registered in
3335 `dir-locals-directory-cache' and the directory-local variables
3336 file has not been modified, return the matching entry in
3337 `dir-locals-directory-cache'.
3338 Otherwise, if a directory-local variables file is found, return
3340 Otherwise, return nil."
3341 (setq file
(expand-file-name file
))
3342 (let* ((dir-locals-file-name
3343 (if (eq system-type
'ms-dos
)
3344 (dosified-file-name dir-locals-file
)
3346 (locals-file (locate-dominating-file file dir-locals-file-name
))
3348 ;; `locate-dominating-file' may have abbreviated the name.
3350 (setq locals-file
(expand-file-name dir-locals-file-name locals-file
)))
3351 ;; Find the best cached value in `dir-locals-directory-cache'.
3352 (dolist (elt dir-locals-directory-cache
)
3353 (when (and (eq t
(compare-strings file nil
(length (car elt
))
3356 '(windows-nt cygwin ms-dos
))))
3357 (> (length (car elt
)) (length (car dir-elt
))))
3358 (setq dir-elt elt
)))
3359 (let ((use-cache (and dir-elt
3360 (or (null locals-file
)
3361 (<= (length (file-name-directory locals-file
))
3362 (length (car dir-elt
)))))))
3364 ;; Check the validity of the cache.
3365 (if (and (file-readable-p (car dir-elt
))
3366 (or (null (nth 2 dir-elt
))
3367 (equal (nth 2 dir-elt
)
3368 (nth 5 (file-attributes (car dir-elt
))))))
3369 ;; This cache entry is OK.
3371 ;; This cache entry is invalid; clear it.
3372 (setq dir-locals-directory-cache
3373 (delq dir-elt dir-locals-directory-cache
))
3377 (defun dir-locals-read-from-file (file)
3378 "Load a variables FILE and register a new class and instance.
3379 FILE is the name of the file holding the variables to apply.
3380 The new class name is the same as the directory in which FILE
3381 is found. Returns the new class name."
3383 (insert-file-contents file
)
3384 (let* ((dir-name (file-name-directory file
))
3385 (class-name (intern dir-name
))
3386 (variables (let ((read-circle nil
))
3387 (read (current-buffer)))))
3388 (dir-locals-set-class-variables class-name variables
)
3389 (dir-locals-set-directory-class dir-name class-name
3390 (nth 5 (file-attributes file
)))
3393 (defun hack-dir-local-variables ()
3394 "Read per-directory local variables for the current buffer.
3395 Store the directory-local variables in `dir-local-variables-alist'
3396 and `file-local-variables-alist', without applying them."
3397 (when (and enable-local-variables
3399 (not (file-remote-p (buffer-file-name))))
3400 ;; Find the variables file.
3401 (let ((variables-file (dir-locals-find-file (buffer-file-name)))
3405 ((stringp variables-file
)
3406 (setq dir-name
(file-name-directory (buffer-file-name)))
3407 (setq class
(dir-locals-read-from-file variables-file
)))
3408 ((consp variables-file
)
3409 (setq dir-name
(nth 0 variables-file
))
3410 (setq class
(nth 1 variables-file
))))
3413 (dir-locals-collect-variables
3414 (dir-locals-get-class-variables class
) dir-name nil
)))
3416 (dolist (elt variables
)
3417 (unless (eq (car elt
) 'eval
)
3418 (setq dir-local-variables-alist
3419 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3420 (push elt dir-local-variables-alist
))
3421 (hack-local-variables-filter variables dir-name
)))))))
3424 (defcustom change-major-mode-with-file-name t
3425 "Non-nil means \\[write-file] should set the major mode from the file name.
3426 However, the mode will not be changed if
3427 \(1) a local variables list or the `-*-' line specifies a major mode, or
3428 \(2) the current major mode is a \"special\" mode,
3429 \ not suitable for ordinary files, or
3430 \(3) the new file name does not particularly specify any mode."
3432 :group
'editing-basics
)
3434 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3435 "Change name of file visited in current buffer to FILENAME.
3436 This also renames the buffer to correspond to the new file.
3437 The next time the buffer is saved it will go in the newly specified file.
3438 FILENAME nil or an empty string means mark buffer as not visiting any file.
3439 Remember to delete the initial contents of the minibuffer
3440 if you wish to pass an empty string as the argument.
3442 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3443 confirmation in the case where another buffer is already visiting FILENAME.
3445 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3446 the old visited file has been renamed to the new name FILENAME."
3447 (interactive "FSet visited file name: ")
3448 (if (buffer-base-buffer)
3449 (error "An indirect buffer cannot visit a file"))
3453 (if (string-equal filename
"")
3455 (expand-file-name filename
))))
3458 (setq truename
(file-truename filename
))
3459 (if find-file-visit-truename
3460 (setq filename truename
))))
3462 (let ((new-name (file-name-nondirectory filename
)))
3463 (if (string= new-name
"")
3464 (error "Empty file name"))))
3465 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3466 (and buffer
(not (eq buffer
(current-buffer)))
3468 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3471 (or (equal filename buffer-file-name
)
3473 (and filename
(lock-buffer filename
))
3475 (setq buffer-file-name filename
)
3476 (if filename
; make buffer name reflect filename.
3477 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3478 (setq default-directory
(file-name-directory buffer-file-name
))
3479 ;; If new-name == old-name, renaming would add a spurious <2>
3480 ;; and it's considered as a feature in rename-buffer.
3481 (or (string= new-name
(buffer-name))
3482 (rename-buffer new-name t
))))
3483 (setq buffer-backed-up nil
)
3485 (clear-visited-file-modtime))
3486 ;; Abbreviate the file names of the buffer.
3489 (setq buffer-file-truename
(abbreviate-file-name truename
))
3490 (if find-file-visit-truename
3491 (setq buffer-file-name truename
))))
3492 (setq buffer-file-number
3494 (nthcdr 10 (file-attributes buffer-file-name
))
3496 ;; write-file-functions is normally used for things like ftp-find-file
3497 ;; that visit things that are not local files as if they were files.
3498 ;; Changing to visit an ordinary local file instead should flush the hook.
3499 (kill-local-variable 'write-file-functions
)
3500 (kill-local-variable 'local-write-file-hooks
)
3501 (kill-local-variable 'revert-buffer-function
)
3502 (kill-local-variable 'backup-inhibited
)
3503 ;; If buffer was read-only because of version control,
3504 ;; that reason is gone now, so make it writable.
3506 (setq buffer-read-only nil
))
3507 (kill-local-variable 'vc-mode
)
3508 ;; Turn off backup files for certain file names.
3509 ;; Since this is a permanent local, the major mode won't eliminate it.
3510 (and buffer-file-name
3511 backup-enable-predicate
3512 (not (funcall backup-enable-predicate buffer-file-name
))
3514 (make-local-variable 'backup-inhibited
)
3515 (setq backup-inhibited t
)))
3516 (let ((oauto buffer-auto-save-file-name
))
3517 ;; If auto-save was not already on, turn it on if appropriate.
3518 (if (not buffer-auto-save-file-name
)
3519 (and buffer-file-name auto-save-default
3521 ;; If auto save is on, start using a new name.
3522 ;; We deliberately don't rename or delete the old auto save
3523 ;; for the old visited file name. This is because perhaps
3524 ;; the user wants to save the new state and then compare with the
3525 ;; previous state from the auto save file.
3526 (setq buffer-auto-save-file-name
3527 (make-auto-save-file-name)))
3528 ;; Rename the old auto save file if any.
3529 (and oauto buffer-auto-save-file-name
3530 (file-exists-p oauto
)
3531 (rename-file oauto buffer-auto-save-file-name t
)))
3532 (and buffer-file-name
3533 (not along-with-file
)
3534 (set-buffer-modified-p t
))
3535 ;; Update the major mode, if the file name determines it.
3537 ;; Don't change the mode if it is special.
3538 (or (not change-major-mode-with-file-name
)
3539 (get major-mode
'mode-class
)
3540 ;; Don't change the mode if the local variable list specifies it.
3541 (hack-local-variables t
)
3545 (defun write-file (filename &optional confirm
)
3546 "Write current buffer into file FILENAME.
3547 This makes the buffer visit that file, and marks it as not modified.
3549 If you specify just a directory name as FILENAME, that means to use
3550 the default file name but in that directory. You can also yank
3551 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3553 If the buffer is not already visiting a file, the default file name
3554 for the output file is the buffer name.
3556 If optional second arg CONFIRM is non-nil, this function
3557 asks for confirmation before overwriting an existing file.
3558 Interactively, confirmation is required unless you supply a prefix argument."
3559 ;; (interactive "FWrite file: ")
3561 (list (if buffer-file-name
3562 (read-file-name "Write file: "
3564 (read-file-name "Write file: " default-directory
3566 (file-name-nondirectory (buffer-name))
3569 (not current-prefix-arg
)))
3570 (or (null filename
) (string-equal filename
"")
3572 ;; If arg is just a directory,
3573 ;; use the default file name, but in that directory.
3574 (if (file-directory-p filename
)
3575 (setq filename
(concat (file-name-as-directory filename
)
3576 (file-name-nondirectory
3577 (or buffer-file-name
(buffer-name))))))
3579 (file-exists-p filename
)
3580 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3581 (error "Canceled")))
3582 (set-visited-file-name filename
(not confirm
))))
3583 (set-buffer-modified-p t
)
3584 ;; Make buffer writable if file is writable.
3585 (and buffer-file-name
3586 (file-writable-p buffer-file-name
)
3587 (setq buffer-read-only nil
))
3589 ;; It's likely that the VC status at the new location is different from
3590 ;; the one at the old location.
3591 (vc-find-file-hook))
3593 (defun backup-buffer ()
3594 "Make a backup of the disk file visited by the current buffer, if appropriate.
3595 This is normally done before saving the buffer the first time.
3597 A backup may be done by renaming or by copying; see documentation of
3598 variable `make-backup-files'. If it's done by renaming, then the file is
3599 no longer accessible under its old name.
3601 The value is non-nil after a backup was made by renaming.
3602 It has the form (MODES . BACKUPNAME).
3603 MODES is the result of `file-modes' on the original
3604 file; this means that the caller, after saving the buffer, should change
3605 the modes of the new file to agree with the old modes.
3606 BACKUPNAME is the backup file name, which is the old file renamed."
3607 (if (and make-backup-files
(not backup-inhibited
)
3608 (not buffer-backed-up
)
3609 (file-exists-p buffer-file-name
)
3610 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3612 (let ((real-file-name buffer-file-name
)
3613 backup-info backupname targets setmodes
)
3614 ;; If specified name is a symbolic link, chase it to the target.
3615 ;; Thus we make the backups in the directory where the real file is.
3616 (setq real-file-name
(file-chase-links real-file-name
))
3617 (setq backup-info
(find-backup-file-name real-file-name
)
3618 backupname
(car backup-info
)
3619 targets
(cdr backup-info
))
3620 ;; (if (file-directory-p buffer-file-name)
3621 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3624 (let ((delete-old-versions
3625 ;; If have old versions to maybe delete,
3626 ;; ask the user to confirm now, before doing anything.
3627 ;; But don't actually delete til later.
3629 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3630 (or delete-old-versions
3631 (y-or-n-p (format "Delete excess backup versions of %s? "
3633 (modes (file-modes buffer-file-name
)))
3634 ;; Actually write the back up file.
3636 (if (or file-precious-flag
3637 ; (file-symlink-p buffer-file-name)
3639 ;; Don't rename a suid or sgid file.
3640 (and modes
(< 0 (logand modes
#o6000
)))
3641 (not (file-writable-p (file-name-directory real-file-name
)))
3642 (and backup-by-copying-when-linked
3643 (> (file-nlinks real-file-name
) 1))
3644 (and (or backup-by-copying-when-mismatch
3645 (integerp backup-by-copying-when-privileged-mismatch
))
3646 (let ((attr (file-attributes real-file-name
)))
3647 (and (or backup-by-copying-when-mismatch
3648 (and (integerp (nth 2 attr
))
3649 (integerp backup-by-copying-when-privileged-mismatch
)
3650 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3652 (not (file-ownership-preserved-p real-file-name
)))))))
3653 (backup-buffer-copy real-file-name backupname modes
)
3654 ;; rename-file should delete old backup.
3655 (rename-file real-file-name backupname t
)
3656 (setq setmodes
(cons modes backupname
)))
3658 ;; If trouble writing the backup, write it in ~.
3659 (setq backupname
(expand-file-name
3660 (convert-standard-filename
3662 (message "Cannot write backup file; backing up in %s"
3665 (backup-buffer-copy real-file-name backupname modes
)))
3666 (setq buffer-backed-up t
)
3667 ;; Now delete the old versions, if desired.
3668 (if delete-old-versions
3671 (delete-file (car targets
))
3673 (setq targets
(cdr targets
))))
3675 (file-error nil
))))))
3677 (defun backup-buffer-copy (from-name to-name modes
)
3678 (let ((umask (default-file-modes)))
3681 ;; Create temp files with strict access rights. It's easy to
3682 ;; loosen them later, whereas it's impossible to close the
3683 ;; time-window of loose permissions otherwise.
3684 (set-default-file-modes ?
\700)
3685 (when (condition-case nil
3686 ;; Try to overwrite old backup first.
3687 (copy-file from-name to-name t t t
)
3689 (while (condition-case nil
3691 (when (file-exists-p to-name
)
3692 (delete-file to-name
))
3693 (copy-file from-name to-name nil t t
)
3695 (file-already-exists t
))
3696 ;; The file was somehow created by someone else between
3697 ;; `delete-file' and `copy-file', so let's try again.
3698 ;; rms says "I think there is also a possible race
3699 ;; condition for making backup files" (emacs-devel 20070821).
3702 (set-default-file-modes umask
)))
3704 (set-file-modes to-name
(logand modes
#o1777
))))
3706 (defun file-name-sans-versions (name &optional keep-backup-version
)
3707 "Return file NAME sans backup versions or strings.
3708 This is a separate procedure so your site-init or startup file can
3710 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3711 we do not remove backup version numbers, only true file version numbers."
3712 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
3714 (funcall handler
'file-name-sans-versions name keep-backup-version
)
3716 (if keep-backup-version
3718 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name
)
3719 (string-match "~\\'" name
)
3722 (defun file-ownership-preserved-p (file)
3723 "Return t if deleting FILE and rewriting it would preserve the owner."
3724 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
3726 (funcall handler
'file-ownership-preserved-p file
)
3727 (let ((attributes (file-attributes file
)))
3728 ;; Return t if the file doesn't exist, since it's true that no
3729 ;; information would be lost by an (attempted) delete and create.
3730 (or (null attributes
)
3731 (= (nth 2 attributes
) (user-uid)))))))
3733 (defun file-name-sans-extension (filename)
3734 "Return FILENAME sans final \"extension\".
3735 The extension, in a file name, is the part that follows the last `.',
3736 except that a leading `.', if any, doesn't count."
3738 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
3740 (if (and (string-match "\\.[^.]*\\'" file
)
3741 (not (eq 0 (match-beginning 0))))
3742 (if (setq directory
(file-name-directory filename
))
3743 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3744 ;; we don't want to expand it.
3745 (concat directory
(substring file
0 (match-beginning 0)))
3746 (substring file
0 (match-beginning 0)))
3749 (defun file-name-extension (filename &optional period
)
3750 "Return FILENAME's final \"extension\".
3751 The extension, in a file name, is the part that follows the last `.',
3752 excluding version numbers and backup suffixes,
3753 except that a leading `.', if any, doesn't count.
3754 Return nil for extensionless file names such as `foo'.
3755 Return the empty string for file names such as `foo.'.
3757 If PERIOD is non-nil, then the returned value includes the period
3758 that delimits the extension, and if FILENAME has no extension,
3761 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
3762 (if (and (string-match "\\.[^.]*\\'" file
)
3763 (not (eq 0 (match-beginning 0))))
3764 (substring file
(+ (match-beginning 0) (if period
0 1)))
3768 (defcustom make-backup-file-name-function nil
3769 "A function to use instead of the default `make-backup-file-name'.
3770 A value of nil gives the default `make-backup-file-name' behavior.
3772 This could be buffer-local to do something special for specific
3773 files. If you define it, you may need to change `backup-file-name-p'
3774 and `file-name-sans-versions' too.
3776 See also `backup-directory-alist'."
3778 :type
'(choice (const :tag
"Default" nil
)
3779 (function :tag
"Your function")))
3781 (defcustom backup-directory-alist nil
3782 "Alist of filename patterns and backup directory names.
3783 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3784 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3785 relative or absolute. If it is absolute, so that all matching files
3786 are backed up into the same directory, the file names in this
3787 directory will be the full name of the file backed up with all
3788 directory separators changed to `!' to prevent clashes. This will not
3789 work correctly if your filesystem truncates the resulting name.
3791 For the common case of all backups going into one directory, the alist
3792 should contain a single element pairing \".\" with the appropriate
3795 If this variable is nil, or it fails to match a filename, the backup
3796 is made in the original file's directory.
3798 On MS-DOS filesystems without long names this variable is always
3801 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
3802 (directory :tag
"Backup directory name"))))
3804 (defun normal-backup-enable-predicate (name)
3805 "Default `backup-enable-predicate' function.
3806 Checks for files in `temporary-file-directory',
3807 `small-temporary-file-directory', and /tmp."
3808 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
3810 ;; Directory is under temporary-file-directory.
3811 (and (not (eq comp t
))
3812 (< comp
(- (length temporary-file-directory
)))))
3813 (let ((comp (compare-strings "/tmp" 0 nil
3815 ;; Directory is under /tmp.
3816 (and (not (eq comp t
))
3817 (< comp
(- (length "/tmp")))))
3818 (if small-temporary-file-directory
3819 (let ((comp (compare-strings small-temporary-file-directory
3822 ;; Directory is under small-temporary-file-directory.
3823 (and (not (eq comp t
))
3824 (< comp
(- (length small-temporary-file-directory
)))))))))
3826 (defun make-backup-file-name (file)
3827 "Create the non-numeric backup file name for FILE.
3828 Normally this will just be the file's name with `~' appended.
3829 Customization hooks are provided as follows.
3831 If the variable `make-backup-file-name-function' is non-nil, its value
3832 should be a function which will be called with FILE as its argument;
3833 the resulting name is used.
3835 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3836 the documentation of that variable. If the directory for the backup
3837 doesn't exist, it is created."
3838 (if make-backup-file-name-function
3839 (funcall make-backup-file-name-function file
)
3840 (if (and (eq system-type
'ms-dos
)
3841 (not (msdos-long-file-names)))
3842 (let ((fn (file-name-nondirectory file
)))
3843 (concat (file-name-directory file
)
3844 (or (and (string-match "\\`[^.]+\\'" fn
)
3845 (concat (match-string 0 fn
) ".~"))
3846 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
3847 (concat (match-string 0 fn
) "~")))))
3848 (concat (make-backup-file-name-1 file
) "~"))))
3850 (defun make-backup-file-name-1 (file)
3851 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3852 (let ((alist backup-directory-alist
)
3853 elt backup-directory abs-backup-directory
)
3855 (setq elt
(pop alist
))
3856 (if (string-match (car elt
) file
)
3857 (setq backup-directory
(cdr elt
)
3859 ;; If backup-directory is relative, it should be relative to the
3860 ;; file's directory. By expanding explicitly here, we avoid
3861 ;; depending on default-directory.
3862 (if backup-directory
3863 (setq abs-backup-directory
3864 (expand-file-name backup-directory
3865 (file-name-directory file
))))
3866 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
3868 (make-directory abs-backup-directory
'parents
)
3869 (file-error (setq backup-directory nil
3870 abs-backup-directory nil
))))
3871 (if (null backup-directory
)
3873 (if (file-name-absolute-p backup-directory
)
3875 (when (memq system-type
'(windows-nt ms-dos cygwin
))
3876 ;; Normalize DOSish file names: downcase the drive
3877 ;; letter, if any, and replace the leading "x:" with
3879 (or (file-name-absolute-p file
)
3880 (setq file
(expand-file-name file
))) ; make defaults explicit
3881 ;; Replace any invalid file-name characters (for the
3882 ;; case of backing up remote files).
3883 (setq file
(expand-file-name (convert-standard-filename file
)))
3884 (if (eq (aref file
1) ?
:)
3885 (setq file
(concat "/"
3887 (char-to-string (downcase (aref file
0)))
3888 (if (eq (aref file
2) ?
/)
3891 (substring file
2)))))
3892 ;; Make the name unique by substituting directory
3893 ;; separators. It may not really be worth bothering about
3894 ;; doubling `!'s in the original name...
3896 (subst-char-in-string
3898 (replace-regexp-in-string "!" "!!" file
))
3900 (expand-file-name (file-name-nondirectory file
)
3901 (file-name-as-directory abs-backup-directory
))))))
3903 (defun backup-file-name-p (file)
3904 "Return non-nil if FILE is a backup file name (numeric or not).
3905 This is a separate function so you can redefine it for customization.
3906 You may need to redefine `file-name-sans-versions' as well."
3907 (string-match "~\\'" file
))
3909 (defvar backup-extract-version-start
)
3911 ;; This is used in various files.
3912 ;; The usage of backup-extract-version-start is not very clean,
3913 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3914 (defun backup-extract-version (fn)
3915 "Given the name of a numeric backup file, FN, return the backup number.
3916 Uses the free variable `backup-extract-version-start', whose value should be
3917 the index in the name where the version number begins."
3918 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start
)
3919 (= (match-beginning 0) backup-extract-version-start
))
3920 (string-to-number (substring fn backup-extract-version-start -
1))
3923 (defun find-backup-file-name (fn)
3924 "Find a file name for a backup file FN, and suggestions for deletions.
3925 Value is a list whose car is the name for the backup file
3926 and whose cdr is a list of old versions to consider deleting now.
3927 If the value is nil, don't make a backup.
3928 Uses `backup-directory-alist' in the same way as does
3929 `make-backup-file-name'."
3930 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
3931 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3933 (funcall handler
'find-backup-file-name fn
)
3934 (if (or (eq version-control
'never
)
3935 ;; We don't support numbered backups on plain MS-DOS
3936 ;; when long file names are unavailable.
3937 (and (eq system-type
'ms-dos
)
3938 (not (msdos-long-file-names))))
3939 (list (make-backup-file-name fn
))
3940 (let* ((basic-name (make-backup-file-name-1 fn
))
3941 (base-versions (concat (file-name-nondirectory basic-name
)
3943 (backup-extract-version-start (length base-versions
))
3945 (number-to-delete 0)
3946 possibilities deserve-versions-p versions
)
3948 (setq possibilities
(file-name-all-completions
3950 (file-name-directory basic-name
))
3951 versions
(sort (mapcar #'backup-extract-version
3954 high-water-mark
(apply 'max
0 versions
)
3955 deserve-versions-p
(or version-control
3956 (> high-water-mark
0))
3957 number-to-delete
(- (length versions
)
3961 (file-error (setq possibilities nil
)))
3962 (if (not deserve-versions-p
)
3963 (list (make-backup-file-name fn
))
3964 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
3965 (if (and (> number-to-delete
0)
3966 ;; Delete nothing if there is overflow
3967 ;; in the number of versions to keep.
3968 (>= (+ kept-new-versions kept-old-versions -
1) 0))
3970 (format "%s.~%d~" basic-name n
))
3971 (let ((v (nthcdr kept-old-versions versions
)))
3972 (rplacd (nthcdr (1- number-to-delete
) v
) ())
3975 (defun file-nlinks (filename)
3976 "Return number of names file FILENAME has."
3977 (car (cdr (file-attributes filename
))))
3979 ;; (defun file-relative-name (filename &optional directory)
3980 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3981 ;; This function returns a relative file name which is equivalent to FILENAME
3982 ;; when used with that default directory as the default.
3983 ;; If this is impossible (which can happen on MSDOS and Windows
3984 ;; when the file name and directory use different drive names)
3985 ;; then it returns FILENAME."
3987 ;; (let ((fname (expand-file-name filename)))
3988 ;; (setq directory (file-name-as-directory
3989 ;; (expand-file-name (or directory default-directory))))
3990 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3991 ;; ;; drive names, they can't be relative, so return the absolute name.
3992 ;; (if (and (or (eq system-type 'ms-dos)
3993 ;; (eq system-type 'cygwin)
3994 ;; (eq system-type 'windows-nt))
3995 ;; (not (string-equal (substring fname 0 2)
3996 ;; (substring directory 0 2))))
3998 ;; (let ((ancestor ".")
3999 ;; (fname-dir (file-name-as-directory fname)))
4000 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4001 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4002 ;; (setq directory (file-name-directory (substring directory 0 -1))
4003 ;; ancestor (if (equal ancestor ".")
4005 ;; (concat "../" ancestor))))
4006 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4007 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4008 ;; ;; We matched within FNAME's directory part.
4009 ;; ;; Add the rest of FNAME onto ANCESTOR.
4010 ;; (let ((rest (substring fname (match-end 0))))
4011 ;; (if (and (equal ancestor ".")
4012 ;; (not (equal rest "")))
4013 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4015 ;; (concat (file-name-as-directory ancestor) rest)))
4016 ;; ;; We matched FNAME's directory equivalent.
4019 (defun file-relative-name (filename &optional directory
)
4020 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4021 This function returns a relative file name which is equivalent to FILENAME
4022 when used with that default directory as the default.
4023 If FILENAME and DIRECTORY lie on different machines or on different drives
4024 on a DOS/Windows machine, it returns FILENAME in expanded form."
4027 (file-name-as-directory (expand-file-name (or directory
4028 default-directory
))))
4029 (setq filename
(expand-file-name filename
))
4030 (let ((fremote (file-remote-p filename
))
4031 (dremote (file-remote-p directory
)))
4032 (if ;; Conditions for separate trees
4034 ;; Test for different drives on DOS/Windows
4036 ;; Should `cygwin' really be included here? --stef
4037 (memq system-type
'(ms-dos cygwin windows-nt
))
4038 (not (eq t
(compare-strings filename
0 2 directory
0 2))))
4039 ;; Test for different remote file system identification
4040 (not (equal fremote dremote
)))
4042 (let ((ancestor ".")
4043 (filename-dir (file-name-as-directory filename
)))
4046 (eq t
(compare-strings filename-dir nil
(length directory
)
4047 directory nil nil case-fold-search
))
4048 (eq t
(compare-strings filename nil
(length directory
)
4049 directory nil nil case-fold-search
))))
4050 (setq directory
(file-name-directory (substring directory
0 -
1))
4051 ancestor
(if (equal ancestor
".")
4053 (concat "../" ancestor
))))
4054 ;; Now ancestor is empty, or .., or ../.., etc.
4055 (if (eq t
(compare-strings filename nil
(length directory
)
4056 directory nil nil case-fold-search
))
4057 ;; We matched within FILENAME's directory part.
4058 ;; Add the rest of FILENAME onto ANCESTOR.
4059 (let ((rest (substring filename
(length directory
))))
4060 (if (and (equal ancestor
".") (not (equal rest
"")))
4061 ;; But don't bother with ANCESTOR if it would give us `./'.
4063 (concat (file-name-as-directory ancestor
) rest
)))
4064 ;; We matched FILENAME's directory equivalent.
4067 (defun save-buffer (&optional args
)
4068 "Save current buffer in visited file if modified.
4069 Variations are described below.
4071 By default, makes the previous version into a backup file
4072 if previously requested or if this is the first save.
4073 Prefixed with one \\[universal-argument], marks this version
4074 to become a backup when the next save is done.
4075 Prefixed with two \\[universal-argument]'s,
4076 unconditionally makes the previous version into a backup file.
4077 Prefixed with three \\[universal-argument]'s, marks this version
4078 to become a backup when the next save is done,
4079 and unconditionally makes the previous version into a backup file.
4081 With a numeric argument of 0, never make the previous version
4084 If a file's name is FOO, the names of its numbered backup versions are
4085 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4086 Numeric backups (rather than FOO~) will be made if value of
4087 `version-control' is not the atom `never' and either there are already
4088 numeric versions of the file being backed up, or `version-control' is
4090 We don't want excessive versions piling up, so there are variables
4091 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4092 and `kept-new-versions', which tells how many newest versions to keep.
4093 Defaults are 2 old versions and 2 new.
4094 `dired-kept-versions' controls dired's clean-directory (.) command.
4095 If `delete-old-versions' is nil, system will query user
4096 before trimming versions. Otherwise it does it silently.
4098 If `vc-make-backup-files' is nil, which is the default,
4099 no backup files are made for files managed by version control.
4100 (This is because the version control system itself records previous versions.)
4102 See the subroutine `basic-save-buffer' for more information."
4104 (let ((modp (buffer-modified-p))
4105 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
4106 (memq args
'(16 64)))))
4107 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
4108 ;; We used to display the message below only for files > 50KB, but
4109 ;; then Rmail-mbox never displays it due to buffer swapping. If
4110 ;; the test is ever re-introduced, be sure to handle saving of
4112 (if (and modp
(buffer-file-name))
4113 (message "Saving file %s..." (buffer-file-name)))
4115 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
4117 (defun delete-auto-save-file-if-necessary (&optional force
)
4118 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4119 Normally delete only if the file was written by this Emacs since
4120 the last real save, but optional arg FORCE non-nil means delete anyway."
4121 (and buffer-auto-save-file-name delete-auto-save-files
4122 (not (string= buffer-file-name buffer-auto-save-file-name
))
4123 (or force
(recent-auto-save-p))
4126 (delete-file buffer-auto-save-file-name
)
4128 (set-buffer-auto-saved))))
4130 (defvar auto-save-hook nil
4131 "Normal hook run just before auto-saving.")
4133 (defcustom before-save-hook nil
4134 "Normal hook that is run before a buffer is saved to its file."
4135 :options
'(copyright-update time-stamp
)
4139 (defcustom after-save-hook nil
4140 "Normal hook that is run after a buffer is saved to its file."
4141 :options
'(executable-make-buffer-file-executable-if-script-p)
4145 (defvar save-buffer-coding-system nil
4146 "If non-nil, use this coding system for saving the buffer.
4147 More precisely, use this coding system in place of the
4148 value of `buffer-file-coding-system', when saving the buffer.
4149 Calling `write-region' for any purpose other than saving the buffer
4150 will still use `buffer-file-coding-system'; this variable has no effect
4153 (make-variable-buffer-local 'save-buffer-coding-system
)
4154 (put 'save-buffer-coding-system
'permanent-local t
)
4156 (defun basic-save-buffer ()
4157 "Save the current buffer in its visited file, if it has been modified.
4158 The hooks `write-contents-functions' and `write-file-functions' get a chance
4159 to do the job of saving; if they do not, then the buffer is saved in
4160 the visited file in the usual way.
4161 Before and after saving the buffer, this function runs
4162 `before-save-hook' and `after-save-hook', respectively."
4164 (save-current-buffer
4165 ;; In an indirect buffer, save its base buffer instead.
4166 (if (buffer-base-buffer)
4167 (set-buffer (buffer-base-buffer)))
4168 (if (buffer-modified-p)
4169 (let ((recent-save (recent-auto-save-p))
4171 ;; If buffer has no file name, ask user for one.
4172 (or buffer-file-name
4175 (read-file-name "File to save in: ") nil
)))
4176 (if (file-exists-p filename
)
4177 (if (file-directory-p filename
)
4178 ;; Signal an error if the user specified the name of an
4179 ;; existing directory.
4180 (error "%s is a directory" filename
)
4181 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4183 (error "Canceled")))
4184 ;; Signal an error if the specified name refers to a
4185 ;; non-existing directory.
4186 (let ((dir (file-name-directory filename
)))
4187 (unless (file-directory-p dir
)
4188 (if (file-exists-p dir
)
4189 (error "%s is not a directory" dir
)
4190 (error "%s: no such directory" dir
)))))
4191 (set-visited-file-name filename
)))
4192 (or (verify-visited-file-modtime (current-buffer))
4193 (not (file-exists-p buffer-file-name
))
4195 (format "%s has changed since visited or saved. Save anyway? "
4196 (file-name-nondirectory buffer-file-name
)))
4197 (error "Save not confirmed"))
4201 (and (> (point-max) (point-min))
4202 (not find-file-literally
)
4203 (/= (char-after (1- (point-max))) ?
\n)
4204 (not (and (eq selective-display t
)
4205 (= (char-after (1- (point-max))) ?
\r)))
4206 (or (eq require-final-newline t
)
4207 (eq require-final-newline
'visit-save
)
4208 (and require-final-newline
4210 (format "Buffer %s does not end in newline. Add one? "
4213 (goto-char (point-max))
4215 ;; Support VC version backups.
4217 (run-hooks 'before-save-hook
)
4218 (or (run-hook-with-args-until-success 'write-contents-functions
)
4219 (run-hook-with-args-until-success 'local-write-file-hooks
)
4220 (run-hook-with-args-until-success 'write-file-functions
)
4221 ;; If a hook returned t, file is already "written".
4222 ;; Otherwise, write it the usual way now.
4223 (setq setmodes
(basic-save-buffer-1)))
4224 ;; Now we have saved the current buffer. Let's make sure
4225 ;; that buffer-file-coding-system is fixed to what
4226 ;; actually used for saving by binding it locally.
4227 (if save-buffer-coding-system
4228 (setq save-buffer-coding-system last-coding-system-used
)
4229 (setq buffer-file-coding-system last-coding-system-used
))
4230 (setq buffer-file-number
4231 (nthcdr 10 (file-attributes buffer-file-name
)))
4234 (set-file-modes buffer-file-name
(car setmodes
))
4236 ;; If the auto-save file was recent before this command,
4238 (delete-auto-save-file-if-necessary recent-save
)
4239 ;; Support VC `implicit' locking.
4241 (run-hooks 'after-save-hook
))
4242 (message "(No changes need to be saved)"))))
4244 ;; This does the "real job" of writing a buffer into its visited file
4245 ;; and making a backup file. This is what is normally done
4246 ;; but inhibited if one of write-file-functions returns non-nil.
4247 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4248 (defun basic-save-buffer-1 ()
4250 (if save-buffer-coding-system
4251 (let ((coding-system-for-write save-buffer-coding-system
))
4252 (basic-save-buffer-2))
4253 (basic-save-buffer-2))
4254 (if buffer-file-coding-system-explicit
4255 (setcar buffer-file-coding-system-explicit last-coding-system-used
)
4256 (setq buffer-file-coding-system-explicit
4257 (cons last-coding-system-used nil
)))))
4259 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4260 (defun basic-save-buffer-2 ()
4261 (let (tempsetmodes setmodes
)
4262 (if (not (file-writable-p buffer-file-name
))
4263 (let ((dir (file-name-directory buffer-file-name
)))
4264 (if (not (file-directory-p dir
))
4265 (if (file-exists-p dir
)
4266 (error "%s is not a directory" dir
)
4267 (error "%s: no such directory" dir
))
4268 (if (not (file-exists-p buffer-file-name
))
4269 (error "Directory %s write-protected" dir
)
4271 (format "File %s is write-protected; try to save anyway? "
4272 (file-name-nondirectory
4274 (setq tempsetmodes t
)
4275 (error "Attempt to save to a file which you aren't allowed to write"))))))
4276 (or buffer-backed-up
4277 (setq setmodes
(backup-buffer)))
4278 (let* ((dir (file-name-directory buffer-file-name
))
4279 (dir-writable (file-writable-p dir
)))
4280 (if (or (and file-precious-flag dir-writable
)
4281 (and break-hardlink-on-save
4282 (> (file-nlinks buffer-file-name
) 1)
4284 (error (concat (format
4285 "Directory %s write-protected; " dir
)
4286 "cannot break hardlink when saving")))))
4287 ;; Write temp name, then rename it.
4288 ;; This requires write access to the containing dir,
4289 ;; which is why we don't try it if we don't have that access.
4290 (let ((realname buffer-file-name
)
4292 (umask (default-file-modes))
4293 (old-modtime (visited-file-modtime)))
4294 ;; Create temp files with strict access rights. It's easy to
4295 ;; loosen them later, whereas it's impossible to close the
4296 ;; time-window of loose permissions otherwise.
4299 (clear-visited-file-modtime)
4300 (set-default-file-modes ?
\700)
4301 ;; Try various temporary names.
4302 ;; This code follows the example of make-temp-file,
4303 ;; but it calls write-region in the appropriate way
4304 ;; for saving the buffer.
4305 (while (condition-case ()
4309 (expand-file-name "tmp" dir
)))
4310 ;; Pass in nil&nil rather than point-min&max
4311 ;; cause we're saving the whole buffer.
4312 ;; write-region-annotate-functions may use it.
4313 (write-region nil nil
4314 tempname nil realname
4315 buffer-file-truename
'excl
)
4317 (file-already-exists t
))
4318 ;; The file was somehow created by someone else between
4319 ;; `make-temp-name' and `write-region', let's try again.
4323 (set-default-file-modes umask
)
4324 ;; If we failed, restore the buffer's modtime.
4326 (set-visited-file-modtime old-modtime
)))
4327 ;; Since we have created an entirely new file,
4328 ;; make sure it gets the right permission bits set.
4329 (setq setmodes
(or setmodes
4330 (cons (or (file-modes buffer-file-name
)
4331 (logand ?
\666 umask
))
4333 ;; We succeeded in writing the temp file,
4335 (rename-file tempname buffer-file-name t
))
4336 ;; If file not writable, see if we can make it writable
4337 ;; temporarily while we write it.
4338 ;; But no need to do so if we have just backed it up
4339 ;; (setmodes is set) because that says we're superseding.
4340 (cond ((and tempsetmodes
(not setmodes
))
4341 ;; Change the mode back, after writing.
4342 (setq setmodes
(cons (file-modes buffer-file-name
) buffer-file-name
))
4343 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))))
4347 ;; Pass in nil&nil rather than point-min&max to indicate
4348 ;; we're saving the buffer rather than just a region.
4349 ;; write-region-annotate-functions may make us of it.
4350 (write-region nil nil
4351 buffer-file-name nil t buffer-file-truename
)
4353 ;; If we get an error writing the new file, and we made
4354 ;; the backup by renaming, undo the backing-up.
4355 (and setmodes
(not success
)
4357 (rename-file (cdr setmodes
) buffer-file-name t
)
4358 (setq buffer-backed-up nil
)))))))
4361 (defun diff-buffer-with-file (&optional buffer
)
4362 "View the differences between BUFFER and its associated file.
4363 This requires the external program `diff' to be in your `exec-path'."
4364 (interactive "bBuffer: ")
4365 (with-current-buffer (get-buffer (or buffer
(current-buffer)))
4366 (if (and buffer-file-name
4367 (file-exists-p buffer-file-name
))
4368 (let ((tempfile (make-temp-file "buffer-content-")))
4371 (write-region nil nil tempfile nil
'nomessage
)
4372 (diff buffer-file-name tempfile nil t
)
4374 (when (file-exists-p tempfile
)
4375 (delete-file tempfile
))))
4376 (message "Buffer %s has no associated file on disc" (buffer-name))
4377 ;; Display that message for 1 second so that user can read it
4378 ;; in the minibuffer.
4380 ;; return always nil, so that save-buffers-kill-emacs will not move
4381 ;; over to the next unsaved buffer when calling `d'.
4384 (defvar save-some-buffers-action-alist
4387 (if (not enable-recursive-minibuffers
)
4388 (progn (display-buffer buf
)
4389 (setq other-window-scroll-buffer buf
))
4390 (view-buffer buf
(lambda (_) (exit-recursive-edit)))
4392 ;; Return nil to ask about BUF again.
4396 (if (null (buffer-file-name buf
))
4397 (message "Not applicable: no file")
4398 (save-window-excursion (diff-buffer-with-file buf
))
4399 (if (not enable-recursive-minibuffers
)
4400 (progn (display-buffer (get-buffer-create "*Diff*"))
4401 (setq other-window-scroll-buffer
"*Diff*"))
4402 (view-buffer (get-buffer-create "*Diff*")
4403 (lambda (_) (exit-recursive-edit)))
4405 ;; Return nil to ask about BUF again.
4407 "view changes in this buffer"))
4408 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4409 (put 'save-some-buffers-action-alist
'risky-local-variable t
)
4411 (defvar buffer-save-without-query nil
4412 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4413 (make-variable-buffer-local 'buffer-save-without-query
)
4415 (defun save-some-buffers (&optional arg pred
)
4416 "Save some modified file-visiting buffers. Asks user about each one.
4417 You can answer `y' to save, `n' not to save, `C-r' to look at the
4418 buffer in question with `view-buffer' before deciding or `d' to
4419 view the differences using `diff-buffer-with-file'.
4421 Optional argument (the prefix) non-nil means save all with no questions.
4422 Optional second argument PRED determines which buffers are considered:
4423 If PRED is nil, all the file-visiting buffers are considered.
4424 If PRED is t, then certain non-file buffers will also be considered.
4425 If PRED is a zero-argument function, it indicates for each buffer whether
4426 to consider it or not when called with that buffer current.
4428 See `save-some-buffers-action-alist' if you want to
4429 change the additional actions you can take on files."
4431 (save-window-excursion
4432 (let* (queried some-automatic
4433 files-done abbrevs-done
)
4434 (dolist (buffer (buffer-list))
4435 ;; First save any buffers that we're supposed to save unconditionally.
4436 ;; That way the following code won't ask about them.
4437 (with-current-buffer buffer
4438 (when (and buffer-save-without-query
(buffer-modified-p))
4439 (setq some-automatic t
)
4441 ;; Ask about those buffers that merit it,
4442 ;; and record the number thus saved.
4446 ;; Note that killing some buffers may kill others via
4447 ;; hooks (e.g. Rmail and its viewing buffer).
4448 (and (buffer-live-p buffer
)
4449 (buffer-modified-p buffer
)
4450 (not (buffer-base-buffer buffer
))
4452 (buffer-file-name buffer
)
4456 (and buffer-offer-save
(> (buffer-size) 0)))))
4457 (or (not (functionp pred
))
4458 (with-current-buffer buffer
(funcall pred
)))
4462 (if (buffer-file-name buffer
)
4463 (format "Save file %s? "
4464 (buffer-file-name buffer
))
4465 (format "Save buffer %s? "
4466 (buffer-name buffer
))))))
4468 (with-current-buffer buffer
4471 '("buffer" "buffers" "save")
4472 save-some-buffers-action-alist
))
4473 ;; Maybe to save abbrevs, and record whether
4474 ;; we either saved them or asked to.
4475 (and save-abbrevs abbrevs-changed
4478 (eq save-abbrevs
'silently
)
4479 (y-or-n-p (format "Save abbrevs in %s? "
4481 (write-abbrev-file nil
))
4482 ;; Don't keep bothering user if he says no.
4483 (setq abbrevs-changed nil
)
4484 (setq abbrevs-done t
)))
4485 (or queried
(> files-done
0) abbrevs-done
4486 (message (if some-automatic
4487 "(Some special files were saved without asking)"
4488 "(No files need saving)"))))))
4490 (defun not-modified (&optional arg
)
4491 "Mark current buffer as unmodified, not needing to be saved.
4492 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4494 It is not a good idea to use this function in Lisp programs, because it
4495 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4497 (message (if arg
"Modification-flag set"
4498 "Modification-flag cleared"))
4499 (set-buffer-modified-p arg
))
4501 (defun toggle-read-only (&optional arg
)
4502 "Change whether this buffer is read-only.
4503 With prefix argument ARG, make the buffer read-only if ARG is
4504 positive, otherwise make it writable. If buffer is read-only
4505 and `view-read-only' is non-nil, enter view mode."
4508 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4509 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4513 ((and buffer-read-only view-mode
)
4514 (View-exit-and-edit)
4515 (make-local-variable 'view-read-only
)
4516 (setq view-read-only t
)) ; Must leave view mode.
4517 ((and (not buffer-read-only
) view-read-only
4518 ;; If view-mode is already active, `view-mode-enter' is a nop.
4520 (not (eq (get major-mode
'mode-class
) 'special
)))
4522 (t (setq buffer-read-only
(not buffer-read-only
))
4523 (force-mode-line-update)))
4524 (if (vc-backend buffer-file-name
)
4525 (message "%s" (substitute-command-keys
4526 (concat "File is under version-control; "
4527 "use \\[vc-next-action] to check in/out"))))))
4529 (defun insert-file (filename)
4530 "Insert contents of file FILENAME into buffer after point.
4531 Set mark after the inserted text.
4533 This function is meant for the user to run interactively.
4534 Don't call it from programs! Use `insert-file-contents' instead.
4535 \(Its calling sequence is different; see its documentation)."
4536 (interactive "*fInsert file: ")
4537 (insert-file-1 filename
#'insert-file-contents
))
4539 (defun append-to-file (start end filename
)
4540 "Append the contents of the region to the end of file FILENAME.
4541 When called from a function, expects three arguments,
4542 START, END and FILENAME. START and END are normally buffer positions
4543 specifying the part of the buffer to write.
4544 If START is nil, that means to use the entire buffer contents.
4545 If START is a string, then output that string to the file
4546 instead of any buffer contents; END is ignored.
4548 This does character code conversion and applies annotations
4549 like `write-region' does."
4550 (interactive "r\nFAppend to file: ")
4551 (write-region start end filename t
))
4553 (defun file-newest-backup (filename)
4554 "Return most recent backup file for FILENAME or nil if no backups exist."
4555 ;; `make-backup-file-name' will get us the right directory for
4556 ;; ordinary or numeric backups. It might create a directory for
4557 ;; backups as a side-effect, according to `backup-directory-alist'.
4558 (let* ((filename (file-name-sans-versions
4559 (make-backup-file-name (expand-file-name filename
))))
4560 (file (file-name-nondirectory filename
))
4561 (dir (file-name-directory filename
))
4562 (comp (file-name-all-completions file dir
))
4566 (setq tem
(pop comp
))
4567 (cond ((and (backup-file-name-p tem
)
4568 (string= (file-name-sans-versions tem
) file
))
4569 (setq tem
(concat dir tem
))
4570 (if (or (null newest
)
4571 (file-newer-than-file-p tem newest
))
4572 (setq newest tem
)))))
4575 (defun rename-uniquely ()
4576 "Rename current buffer to a similar name not already taken.
4577 This function is useful for creating multiple shell process buffers
4578 or multiple mail buffers, etc."
4581 (let ((base-name (buffer-name)))
4582 (and (string-match "<[0-9]+>\\'" base-name
)
4583 (not (and buffer-file-name
4585 (file-name-nondirectory buffer-file-name
))))
4586 ;; If the existing buffer name has a <NNN>,
4587 ;; which isn't part of the file name (if any),
4588 ;; then get rid of that.
4589 (setq base-name
(substring base-name
0 (match-beginning 0))))
4590 (rename-buffer (generate-new-buffer-name base-name
))
4591 (force-mode-line-update))))
4593 (defun make-directory (dir &optional parents
)
4594 "Create the directory DIR and any nonexistent parent dirs.
4595 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4597 Interactively, the default choice of directory to create
4598 is the current default directory for file names.
4599 That is useful when you have visited a file in a nonexistent directory.
4601 Noninteractively, the second (optional) argument PARENTS says whether
4602 to create parent directories if they don't exist. Interactively,
4603 this happens by default."
4605 (list (read-file-name "Make directory: " default-directory default-directory
4608 ;; If default-directory is a remote directory,
4609 ;; make sure we find its make-directory handler.
4610 (setq dir
(expand-file-name dir
))
4611 (let ((handler (find-file-name-handler dir
'make-directory
)))
4613 (funcall handler
'make-directory dir parents
)
4615 (make-directory-internal dir
)
4616 (let ((dir (directory-file-name (expand-file-name dir
)))
4618 (while (and (not (file-exists-p dir
))
4619 ;; If directory is its own parent, then we can't
4620 ;; keep looping forever
4622 (directory-file-name
4623 (file-name-directory dir
)))))
4624 (setq create-list
(cons dir create-list
)
4625 dir
(directory-file-name (file-name-directory dir
))))
4627 (make-directory-internal (car create-list
))
4628 (setq create-list
(cdr create-list
))))))))
4630 (put 'revert-buffer-function
'permanent-local t
)
4631 (defvar revert-buffer-function nil
4632 "Function to use to revert this buffer, or nil to do the default.
4633 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4634 which are the arguments that `revert-buffer' received.")
4636 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
4637 (defvar revert-buffer-insert-file-contents-function nil
4638 "Function to use to insert contents when reverting this buffer.
4639 Gets two args, first the nominal file name to use,
4640 and second, t if reading the auto-save file.
4642 The function you specify is responsible for updating (or preserving) point.")
4644 (defvar buffer-stale-function nil
4645 "Function to check whether a non-file buffer needs reverting.
4646 This should be a function with one optional argument NOCONFIRM.
4647 Auto Revert Mode passes t for NOCONFIRM. The function should return
4648 non-nil if the buffer should be reverted. A return value of
4649 `fast' means that the need for reverting was not checked, but
4650 that reverting the buffer is fast. The buffer is current when
4651 this function is called.
4653 The idea behind the NOCONFIRM argument is that it should be
4654 non-nil if the buffer is going to be reverted without asking the
4655 user. In such situations, one has to be careful with potentially
4656 time consuming operations.
4658 For more information on how this variable is used by Auto Revert mode,
4659 see Info node `(emacs)Supporting additional buffers'.")
4661 (defvar before-revert-hook nil
4662 "Normal hook for `revert-buffer' to run before reverting.
4663 If `revert-buffer-function' is used to override the normal revert
4664 mechanism, this hook is not used.")
4666 (defvar after-revert-hook nil
4667 "Normal hook for `revert-buffer' to run after reverting.
4668 Note that the hook value that it runs is the value that was in effect
4669 before reverting; that makes a difference if you have buffer-local
4672 If `revert-buffer-function' is used to override the normal revert
4673 mechanism, this hook is not used.")
4675 (defvar revert-buffer-internal-hook
)
4677 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
4678 "Replace current buffer text with the text of the visited file on disk.
4679 This undoes all changes since the file was visited or saved.
4680 With a prefix argument, offer to revert from latest auto-save file, if
4681 that is more recent than the visited file.
4683 This command also implements an interface for special buffers
4684 that contain text which doesn't come from a file, but reflects
4685 some other data instead (e.g. Dired buffers, `buffer-list'
4686 buffers). This is done via the variable `revert-buffer-function'.
4687 In these cases, it should reconstruct the buffer contents from the
4690 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4691 to revert from the auto-save file when this is nil. Note that the
4692 sense of this argument is the reverse of the prefix argument, for the
4693 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4696 Optional second argument NOCONFIRM means don't ask for confirmation
4697 at all. \(The variable `revert-without-query' offers another way to
4698 revert buffers without querying for confirmation.)
4700 Optional third argument PRESERVE-MODES non-nil means don't alter
4701 the files modes. Normally we reinitialize them using `normal-mode'.
4703 If the value of `revert-buffer-function' is non-nil, it is called to
4704 do all the work for this command. Otherwise, the hooks
4705 `before-revert-hook' and `after-revert-hook' are run at the beginning
4706 and the end, and if `revert-buffer-insert-file-contents-function' is
4707 non-nil, it is called instead of rereading visited file contents."
4709 ;; I admit it's odd to reverse the sense of the prefix argument, but
4710 ;; there is a lot of code out there which assumes that the first
4711 ;; argument should be t to avoid consulting the auto-save file, and
4712 ;; there's no straightforward way to encourage authors to notice a
4713 ;; reversal of the argument sense. So I'm just changing the user
4714 ;; interface, but leaving the programmatic interface the same.
4715 (interactive (list (not current-prefix-arg
)))
4716 (if revert-buffer-function
4717 (funcall revert-buffer-function ignore-auto noconfirm
)
4718 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4720 (let* ((auto-save-p (and (not ignore-auto
)
4721 (recent-auto-save-p)
4722 buffer-auto-save-file-name
4723 (file-readable-p buffer-auto-save-file-name
)
4725 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4726 (file-name (if auto-save-p
4727 buffer-auto-save-file-name
4729 (cond ((null file-name
)
4730 (error "Buffer does not seem to be associated with any file"))
4732 (and (not (buffer-modified-p))
4734 (dolist (regexp revert-without-query
)
4735 (when (string-match regexp file-name
)
4736 (throw 'found t
)))))
4737 (yes-or-no-p (format "Revert buffer from file %s? "
4739 (run-hooks 'before-revert-hook
)
4740 ;; If file was backed up but has changed since,
4741 ;; we shd make another backup.
4742 (and (not auto-save-p
)
4743 (not (verify-visited-file-modtime (current-buffer)))
4744 (setq buffer-backed-up nil
))
4745 ;; Effectively copy the after-revert-hook status,
4746 ;; since after-find-file will clobber it.
4747 (let ((global-hook (default-value 'after-revert-hook
))
4748 (local-hook (when (local-variable-p 'after-revert-hook
)
4750 (inhibit-read-only t
))
4752 (revert-buffer-insert-file-contents-function
4753 (unless (eq buffer-undo-list t
)
4754 ;; Get rid of all undo records for this buffer.
4755 (setq buffer-undo-list nil
))
4756 ;; Don't make undo records for the reversion.
4757 (let ((buffer-undo-list t
))
4758 (funcall revert-buffer-insert-file-contents-function
4759 file-name auto-save-p
)))
4760 ((not (file-exists-p file-name
))
4761 (error (if buffer-file-number
4762 "File %s no longer exists!"
4763 "Cannot revert nonexistent file %s")
4765 ((not (file-readable-p file-name
))
4766 (error (if buffer-file-number
4767 "File %s no longer readable!"
4768 "Cannot revert unreadable file %s")
4771 ;; Bind buffer-file-name to nil
4772 ;; so that we don't try to lock the file.
4773 (let ((buffer-file-name nil
))
4777 (let ((coding-system-for-read
4778 ;; Auto-saved file should be read by Emacs'
4780 (if auto-save-p
'auto-save-coding
4781 (or coding-system-for-read
4783 buffer-file-coding-system-explicit
4784 (car buffer-file-coding-system-explicit
))))))
4785 (if (and (not enable-multibyte-characters
)
4786 coding-system-for-read
4787 (not (memq (coding-system-base
4788 coding-system-for-read
)
4789 '(no-conversion raw-text
))))
4790 ;; As a coding system suitable for multibyte
4791 ;; buffer is specified, make the current
4792 ;; buffer multibyte.
4793 (set-buffer-multibyte t
))
4795 ;; This force after-insert-file-set-coding
4796 ;; (called from insert-file-contents) to set
4797 ;; buffer-file-coding-system to a proper value.
4798 (kill-local-variable 'buffer-file-coding-system
)
4800 ;; Note that this preserves point in an intelligent way.
4802 (let ((buffer-file-format buffer-file-format
))
4803 (insert-file-contents file-name
(not auto-save-p
)
4805 (insert-file-contents file-name
(not auto-save-p
)
4807 ;; Recompute the truename in case changes in symlinks
4808 ;; have changed the truename.
4809 (setq buffer-file-truename
4810 (abbreviate-file-name (file-truename buffer-file-name
)))
4811 (after-find-file nil nil t t preserve-modes
)
4812 ;; Run after-revert-hook as it was before we reverted.
4813 (setq-default revert-buffer-internal-hook global-hook
)
4815 (set (make-local-variable 'revert-buffer-internal-hook
)
4817 (kill-local-variable 'revert-buffer-internal-hook
))
4818 (run-hooks 'revert-buffer-internal-hook
))
4821 (defun recover-this-file ()
4822 "Recover the visited file--get contents from its last auto-save file."
4824 (recover-file buffer-file-name
))
4826 (defun recover-file (file)
4827 "Visit file FILE, but get contents from its last auto-save file."
4828 ;; Actually putting the file name in the minibuffer should be used
4830 ;; Not just because users often use the default.
4831 (interactive "FRecover file: ")
4832 (setq file
(expand-file-name file
))
4833 (if (auto-save-file-name-p (file-name-nondirectory file
))
4834 (error "%s is an auto-save file" (abbreviate-file-name file
)))
4835 (let ((file-name (let ((buffer-file-name file
))
4836 (make-auto-save-file-name))))
4837 (cond ((if (file-exists-p file
)
4838 (not (file-newer-than-file-p file-name file
))
4839 (not (file-exists-p file-name
)))
4840 (error "Auto-save file %s not current"
4841 (abbreviate-file-name file-name
)))
4842 ((save-window-excursion
4843 (with-output-to-temp-buffer "*Directory*"
4844 (buffer-disable-undo standard-output
)
4846 (let ((switches dired-listing-switches
))
4847 (if (file-symlink-p file
)
4848 (setq switches
(concat switches
"L")))
4849 (set-buffer standard-output
)
4850 ;; Use insert-directory-safely, not insert-directory,
4851 ;; because these files might not exist. In particular,
4852 ;; FILE might not exist if the auto-save file was for
4853 ;; a buffer that didn't visit a file, such as "*mail*".
4854 ;; The code in v20.x called `ls' directly, so we need
4855 ;; to emulate what `ls' did in that case.
4856 (insert-directory-safely file switches
)
4857 (insert-directory-safely file-name switches
))))
4858 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
4859 (switch-to-buffer (find-file-noselect file t
))
4860 (let ((inhibit-read-only t
)
4861 ;; Keep the current buffer-file-coding-system.
4862 (coding-system buffer-file-coding-system
)
4863 ;; Auto-saved file should be read with special coding.
4864 (coding-system-for-read 'auto-save-coding
))
4866 (insert-file-contents file-name nil
)
4867 (set-buffer-file-coding-system coding-system
))
4868 (after-find-file nil nil t
))
4869 (t (error "Recover-file cancelled")))))
4871 (defun recover-session ()
4872 "Recover auto save files from a previous Emacs session.
4873 This command first displays a Dired buffer showing you the
4874 previous sessions that you could recover from.
4875 To choose one, move point to the proper line and then type C-c C-c.
4876 Then you'll be asked about a number of files to recover."
4878 (if (null auto-save-list-file-prefix
)
4879 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4880 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
4881 (unless (file-directory-p dir
)
4882 (make-directory dir t
))
4883 (unless (directory-files dir nil
4884 (concat "\\`" (regexp-quote
4885 (file-name-nondirectory
4886 auto-save-list-file-prefix
)))
4888 (error "No previous sessions to recover")))
4889 (let ((ls-lisp-support-shell-wildcards t
))
4890 (dired (concat auto-save-list-file-prefix
"*")
4891 (concat dired-listing-switches
"t")))
4893 (goto-char (point-min))
4894 (or (looking-at " Move to the session you want to recover,")
4895 (let ((inhibit-read-only t
))
4896 ;; Each line starts with a space
4897 ;; so that Font Lock mode won't highlight the first character.
4898 (insert " Move to the session you want to recover,\n"
4899 " then type C-c C-c to select it.\n\n"
4900 " You can also delete some of these files;\n"
4901 " type d on a line to mark that file for deletion.\n\n"))))
4902 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4903 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
4905 (defun recover-session-finish ()
4906 "Choose one saved session to recover auto-save files from.
4907 This command is used in the special Dired buffer created by
4908 \\[recover-session]."
4910 ;; Get the name of the session file to recover from.
4911 (let ((file (dired-get-filename))
4913 (buffer (get-buffer-create " *recover*")))
4915 (dired-do-flagged-delete t
)
4918 ;; Read in the auto-save-list file.
4921 (insert-file-contents file
)
4922 ;; Loop thru the text of that file
4923 ;; and get out the names of the files to recover.
4925 (let (thisfile autofile
)
4927 ;; This is a pair of lines for a non-file-visiting buffer.
4928 ;; Get the auto-save file name and manufacture
4929 ;; a "visited file name" from that.
4932 ;; If there is no auto-save file name, the
4933 ;; auto-save-list file is probably corrupted.
4936 (buffer-substring-no-properties
4938 (line-end-position)))
4942 (file-name-nondirectory autofile
)
4944 (file-name-directory autofile
))))
4946 ;; This pair of lines is a file-visiting
4947 ;; buffer. Use the visited file name.
4950 (buffer-substring-no-properties
4951 (point) (progn (end-of-line) (point))))
4954 (buffer-substring-no-properties
4955 (point) (progn (end-of-line) (point))))
4957 ;; Ignore a file if its auto-save file does not exist now.
4958 (if (and autofile
(file-exists-p autofile
))
4959 (setq files
(cons thisfile files
)))))
4960 (setq files
(nreverse files
))
4961 ;; The file contains a pair of line for each auto-saved buffer.
4962 ;; The first line of the pair contains the visited file name
4963 ;; or is empty if the buffer was not visiting a file.
4964 ;; The second line is the auto-save file name.
4966 (map-y-or-n-p "Recover %s? "
4969 (save-excursion (recover-file file
))
4971 "Failed to recover `%s'" file
)))
4973 '("file" "files" "recover"))
4974 (message "No files can be recovered from this session now")))
4975 (kill-buffer buffer
))))
4977 (defun kill-buffer-ask (buffer)
4978 "Kill BUFFER if confirmed."
4980 (format "Buffer %s %s. Kill? " (buffer-name buffer
)
4981 (if (buffer-modified-p buffer
)
4982 "HAS BEEN EDITED" "is unmodified")))
4983 (kill-buffer buffer
)))
4985 (defun kill-some-buffers (&optional list
)
4986 "Kill some buffers. Asks the user whether to kill each one of them.
4987 Non-interactively, if optional argument LIST is non-nil, it
4988 specifies the list of buffers to kill, asking for approval for each one."
4991 (setq list
(buffer-list)))
4993 (let* ((buffer (car list
))
4994 (name (buffer-name buffer
)))
4995 (and name
; Can be nil for an indirect buffer
4996 ; if we killed the base buffer.
4997 (not (string-equal name
""))
4998 (/= (aref name
0) ?\s
)
4999 (kill-buffer-ask buffer
)))
5000 (setq list
(cdr list
))))
5002 (defun kill-matching-buffers (regexp &optional internal-too
)
5003 "Kill buffers whose name matches the specified REGEXP.
5004 The optional second argument indicates whether to kill internal buffers too."
5005 (interactive "sKill buffers matching this regular expression: \nP")
5006 (dolist (buffer (buffer-list))
5007 (let ((name (buffer-name buffer
)))
5008 (when (and name
(not (string-equal name
""))
5009 (or internal-too
(/= (aref name
0) ?\s
))
5010 (string-match regexp name
))
5011 (kill-buffer-ask buffer
)))))
5014 (defun auto-save-mode (arg)
5015 "Toggle auto-saving of contents of current buffer.
5016 With prefix argument ARG, turn auto-saving on if positive, else off."
5018 (setq buffer-auto-save-file-name
5020 (or (not buffer-auto-save-file-name
)
5021 ;; If auto-save is off because buffer has shrunk,
5022 ;; then toggling should turn it on.
5023 (< buffer-saved-size
0))
5024 (or (eq arg t
) (listp arg
) (and (integerp arg
) (> arg
0))))
5025 (if (and buffer-file-name auto-save-visited-file-name
5026 (not buffer-read-only
))
5028 (make-auto-save-file-name))))
5029 ;; If -1 was stored here, to temporarily turn off saving,
5031 (and (< buffer-saved-size
0)
5032 (setq buffer-saved-size
0))
5034 (message "Auto-save %s (in this buffer)"
5035 (if buffer-auto-save-file-name
"on" "off")))
5036 buffer-auto-save-file-name
)
5038 (defun rename-auto-save-file ()
5039 "Adjust current buffer's auto save file name for current conditions.
5040 Also rename any existing auto save file, if it was made in this session."
5041 (let ((osave buffer-auto-save-file-name
))
5042 (setq buffer-auto-save-file-name
5043 (make-auto-save-file-name))
5044 (if (and osave buffer-auto-save-file-name
5045 (not (string= buffer-auto-save-file-name buffer-file-name
))
5046 (not (string= buffer-auto-save-file-name osave
))
5047 (file-exists-p osave
)
5048 (recent-auto-save-p))
5049 (rename-file osave buffer-auto-save-file-name t
))))
5051 (defun make-auto-save-file-name ()
5052 "Return file name to use for auto-saves of current buffer.
5053 Does not consider `auto-save-visited-file-name' as that variable is checked
5054 before calling this function. You can redefine this for customization.
5055 See also `auto-save-file-name-p'."
5056 (if buffer-file-name
5057 (let ((handler (find-file-name-handler buffer-file-name
5058 'make-auto-save-file-name
)))
5060 (funcall handler
'make-auto-save-file-name
)
5061 (let ((list auto-save-file-name-transforms
)
5062 (filename buffer-file-name
)
5064 ;; Apply user-specified translations
5065 ;; to the file name.
5066 (while (and list
(not result
))
5067 (if (string-match (car (car list
)) filename
)
5068 (setq result
(replace-match (cadr (car list
)) t nil
5070 uniq
(car (cddr (car list
)))))
5071 (setq list
(cdr list
)))
5074 (setq filename
(concat
5075 (file-name-directory result
)
5076 (subst-char-in-string
5078 (replace-regexp-in-string "!" "!!"
5080 (setq filename result
)))
5082 (if (and (eq system-type
'ms-dos
)
5083 (not (msdos-long-file-names)))
5084 ;; We truncate the file name to DOS 8+3 limits
5085 ;; before doing anything else, because the regexp
5086 ;; passed to string-match below cannot handle
5087 ;; extensions longer than 3 characters, multiple
5088 ;; dots, and other atrocities.
5089 (let ((fn (dos-8+3-filename
5090 (file-name-nondirectory buffer-file-name
))))
5092 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5094 (concat (file-name-directory buffer-file-name
)
5095 "#" (match-string 1 fn
)
5096 "." (match-string 3 fn
) "#"))
5097 (concat (file-name-directory filename
)
5099 (file-name-nondirectory filename
)
5101 ;; Make sure auto-save file names don't contain characters
5102 ;; invalid for the underlying filesystem.
5103 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5104 ;; Don't modify remote (ange-ftp) filenames
5105 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
5106 (convert-standard-filename result
)
5109 ;; Deal with buffers that don't have any associated files. (Mail
5110 ;; mode tends to create a good number of these.)
5112 (let ((buffer-name (buffer-name))
5115 ;; Restrict the characters used in the file name to those which
5116 ;; are known to be safe on all filesystems, url-encoding the
5118 ;; We do this on all platforms, because even if we are not
5119 ;; running on DOS/Windows, the current directory may be on a
5120 ;; mounted VFAT filesystem, such as a USB memory stick.
5121 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
5122 (let* ((character (aref buffer-name
(match-beginning 0)))
5124 ;; For multibyte characters, this will produce more than
5125 ;; 2 hex digits, so is not true URL encoding.
5126 (format "%%%02X" character
)))
5127 (setq buffer-name
(replace-match replacement t t buffer-name
))
5128 (setq limit
(1+ (match-end 0)))))
5129 ;; Generate the file name.
5134 (format "#%s#" buffer-name
)
5135 ;; Try a few alternative directories, to get one we can
5138 ((file-writable-p default-directory
) default-directory
)
5139 ((file-writable-p "/var/tmp/") "/var/tmp/")
5141 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5142 ;; Don't modify remote (ange-ftp) filenames
5143 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
5144 ;; The call to convert-standard-filename is in case
5145 ;; buffer-name includes characters not allowed by the
5146 ;; DOS/Windows filesystems. make-temp-file writes to the
5147 ;; file it creates, so we must fix the file name _before_
5148 ;; make-temp-file is called.
5149 (convert-standard-filename fname
)
5152 ;; make-temp-file creates the file,
5153 ;; but we don't want it to exist until we do an auto-save.
5155 (delete-file file-name
)
5159 (defun auto-save-file-name-p (filename)
5160 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5161 FILENAME should lack slashes. You can redefine this for customization."
5162 (string-match "^#.*#$" filename
))
5164 (defun wildcard-to-regexp (wildcard)
5165 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5166 The generated regexp will match a filename only if the filename
5167 matches that wildcard according to shell rules. Only wildcards known
5168 by `sh' are supported."
5169 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
5170 ;; Copy the initial run of non-special characters.
5171 (result (substring wildcard
0 i
))
5172 (len (length wildcard
)))
5173 ;; If no special characters, we're almost done.
5176 (let ((ch (aref wildcard i
))
5184 (eq (aref wildcard
(1+ i
)) ?\
]))
5186 ((eq ch ?\
[) ; [...] maps to regexp char class
5191 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
5194 (if (eq (aref wildcard i
) ?\
])
5199 ((eq (aref wildcard i
) ?^
)
5200 ;; Found "[^". Insert a `\0' character
5201 ;; (which cannot happen in a filename)
5202 ;; into the character class, so that `^'
5203 ;; is not the first character after `[',
5204 ;; and thus non-special in a regexp.
5208 ((eq (aref wildcard i
) ?\
])
5209 ;; I don't think `]' can appear in a
5210 ;; character class in a wildcard, but
5211 ;; let's be general here.
5216 (prog1 ; copy everything upto next `]'.
5219 (setq j
(string-match
5221 (setq i
(if j
(1- j
) (1- len
)))))))
5223 ((eq ch ?
*) "[^\000]*")
5227 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
5228 ((eq ch ??
) "[^\000]")
5229 (t (char-to-string ch
)))))
5231 ;; Shell wildcards should match the entire filename,
5232 ;; not its part. Make the regexp say so.
5233 (concat "\\`" result
"\\'")))
5235 (defcustom list-directory-brief-switches
5237 "Switches for `list-directory' to pass to `ls' for brief listing."
5241 (defcustom list-directory-verbose-switches
5243 "Switches for `list-directory' to pass to `ls' for verbose listing."
5247 (defun file-expand-wildcards (pattern &optional full
)
5248 "Expand wildcard pattern PATTERN.
5249 This returns a list of file names which match the pattern.
5251 If PATTERN is written as an absolute file name,
5252 the values are absolute also.
5254 If PATTERN is written as a relative file name, it is interpreted
5255 relative to the current default directory, `default-directory'.
5256 The file names returned are normally also relative to the current
5257 default directory. However, if FULL is non-nil, they are absolute."
5259 (let* ((nondir (file-name-nondirectory pattern
))
5260 (dirpart (file-name-directory pattern
))
5261 ;; A list of all dirs that DIRPART specifies.
5262 ;; This can be more than one dir
5263 ;; if DIRPART contains wildcards.
5264 (dirs (if (and dirpart
(string-match "[[*?]" dirpart
))
5265 (mapcar 'file-name-as-directory
5266 (file-expand-wildcards (directory-file-name dirpart
)))
5270 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
5271 (file-directory-p (directory-file-name (car dirs
))))
5272 (let ((this-dir-contents
5273 ;; Filter out "." and ".."
5275 (mapcar #'(lambda (name)
5276 (unless (string-match "\\`\\.\\.?\\'"
5277 (file-name-nondirectory name
))
5279 (directory-files (or (car dirs
) ".") full
5280 (wildcard-to-regexp nondir
))))))
5283 (if (and (car dirs
) (not full
))
5284 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
5288 (setq dirs
(cdr dirs
)))
5291 (defun list-directory (dirname &optional verbose
)
5292 "Display a list of files in or matching DIRNAME, a la `ls'.
5293 DIRNAME is globbed by the shell if necessary.
5294 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5295 Actions controlled by variables `list-directory-brief-switches'
5296 and `list-directory-verbose-switches'."
5297 (interactive (let ((pfx current-prefix-arg
))
5298 (list (read-file-name (if pfx
"List directory (verbose): "
5299 "List directory (brief): ")
5300 nil default-directory nil
)
5302 (let ((switches (if verbose list-directory-verbose-switches
5303 list-directory-brief-switches
))
5305 (or dirname
(setq dirname default-directory
))
5306 (setq dirname
(expand-file-name dirname
))
5307 (with-output-to-temp-buffer "*Directory*"
5308 (setq buffer standard-output
)
5309 (buffer-disable-undo standard-output
)
5310 (princ "Directory ")
5314 (set-buffer "*Directory*")
5315 (let ((wildcard (not (file-directory-p dirname
))))
5316 (insert-directory dirname switches wildcard
(not wildcard
)))))
5317 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5318 (with-current-buffer buffer
5319 (setq default-directory
5320 (if (file-directory-p dirname
)
5321 (file-name-as-directory dirname
)
5322 (file-name-directory dirname
))))))
5324 (defun shell-quote-wildcard-pattern (pattern)
5325 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5327 PATTERN is assumed to represent a file-name wildcard suitable for the
5328 underlying filesystem. For Unix and GNU/Linux, each character from the
5329 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5330 the parts of the pattern which don't include wildcard characters are
5331 quoted with double quotes.
5333 This function leaves alone existing quote characters (\\ on Unix and \"
5334 on Windows), so PATTERN can use them to quote wildcard characters that
5335 need to be passed verbatim to shell commands."
5338 ((memq system-type
'(ms-dos windows-nt cygwin
))
5339 ;; DOS/Windows don't allow `"' in file names. So if the
5340 ;; argument has quotes, we can safely assume it is already
5341 ;; quoted by the caller.
5342 (if (or (string-match "[\"]" pattern
)
5343 ;; We quote [&()#$'] in case their shell is a port of a
5344 ;; Unixy shell. We quote [,=+] because stock DOS and
5345 ;; Windows shells require that in some cases, such as
5346 ;; passing arguments to batch files that use positional
5347 ;; arguments like %1.
5348 (not (string-match "[ \t;&()#$',=+]" pattern
)))
5353 (while (string-match "[*?]+" pattern beg
)
5354 (setq end
(match-beginning 0)
5355 result
(concat result
(substring pattern beg end
)
5357 (substring pattern end
(match-end 0))
5360 (concat result
(substring pattern beg
) "\""))))
5363 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
5365 (concat (substring pattern
0 (match-beginning 0))
5367 (substring pattern
(match-beginning 0)))
5368 beg
(1+ (match-end 0)))))
5372 (defvar insert-directory-program
"ls"
5373 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5375 (defcustom directory-free-space-program
"df"
5376 "Program to get the amount of free space on a file system.
5377 We assume the output has the format of `df'.
5378 The value of this variable must be just a command name or file name;
5379 if you want to specify options, use `directory-free-space-args'.
5381 A value of nil disables this feature.
5383 If the function `file-system-info' is defined, it is always used in
5384 preference to the program given by this variable."
5385 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
5388 (defcustom directory-free-space-args
5389 (if (eq system-type
'darwin
) "-k" "-Pk")
5390 "Options to use when running `directory-free-space-program'."
5394 (defun get-free-disk-space (dir)
5395 "Return the amount of free space on directory DIR's file system.
5396 The result is a string that gives the number of free 1KB blocks,
5397 or nil if the system call or the program which retrieve the information
5398 fail. It returns also nil when DIR is a remote directory.
5400 This function calls `file-system-info' if it is available, or invokes the
5401 program specified by `directory-free-space-program' if that is non-nil."
5402 (unless (file-remote-p dir
)
5403 ;; Try to find the number of free blocks. Non-Posix systems don't
5404 ;; always have df, but might have an equivalent system call.
5405 (if (fboundp 'file-system-info
)
5406 (let ((fsinfo (file-system-info dir
)))
5408 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
5409 (setq dir
(expand-file-name dir
))
5412 (when (and directory-free-space-program
5413 ;; Avoid failure if the default directory does
5414 ;; not exist (Bug#2631, Bug#3911).
5415 (let ((default-directory "/"))
5416 (eq (call-process directory-free-space-program
5418 directory-free-space-args
5421 ;; Usual format is a header line followed by a line of
5423 (goto-char (point-min))
5427 ;; Move to the end of the "available blocks" number.
5428 (skip-chars-forward "^ \t")
5430 ;; Copy it into AVAILABLE.
5431 (let ((end (point)))
5433 (buffer-substring (point) end
))))))))))
5435 ;; The following expression replaces `dired-move-to-filename-regexp'.
5436 (defvar directory-listing-before-filename-regexp
5437 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5438 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5439 ;; In some locales, month abbreviations are as short as 2 letters,
5440 ;; and they can be followed by ".".
5441 ;; In Breton, a month name can include a quote character.
5442 (month (concat l-or-quote l-or-quote
"+\\.?"))
5444 (yyyy "[0-9][0-9][0-9][0-9]")
5446 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5447 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5448 (zone "[-+][0-2][0-9][0-5][0-9]")
5449 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5450 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5451 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5452 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5453 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5455 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5456 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5457 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5458 ;; omits the Kanji characters after month and day-of-month.
5459 ;; On Mac OS X 10.3, the date format in East Asian locales is
5460 ;; day-of-month digits followed by month digits.
5463 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5464 "\\|" dd s mm s
"+" "\\)"
5465 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5466 ;; The "[0-9]" below requires the previous column to end in a digit.
5467 ;; This avoids recognizing `1 may 1997' as a date in the line:
5468 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5470 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5471 ;; The ".*" below finds the last match if there are multiple matches.
5472 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5473 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5475 ;; vc dired listings provide the state or blanks between file
5476 ;; permissions and date. The state is always surrounded by
5478 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5479 ;; This is not supported yet.
5480 (concat ".*[0-9][BkKMGTPEZY]?" s
5481 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\|" iso
"\\)"
5483 "Regular expression to match up to the file name in a directory listing.
5484 The default value is designed to recognize dates and times
5485 regardless of the language.")
5487 (defvar insert-directory-ls-version
'unknown
)
5490 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5491 ;; FULL-DIRECTORY-P is nil.
5492 ;; The single line of output must display FILE's name as it was
5493 ;; given, namely, an absolute path name.
5494 ;; - must insert exactly one line for each file if WILDCARD or
5495 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5496 ;; before the file lines, plus optional text after the file lines.
5497 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5499 ;; File lines should display the basename.
5500 ;; - must be consistent with
5501 ;; - functions dired-move-to-filename, (these two define what a file line is)
5502 ;; dired-move-to-end-of-filename,
5503 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5504 ;; dired-insert-headerline
5505 ;; dired-after-subdir-garbage (defines what a "total" line is)
5506 ;; - variable dired-subdir-regexp
5507 ;; - may be passed "--dired" as the first argument in SWITCHES.
5508 ;; Filename handlers might have to remove this switch if their
5509 ;; "ls" command does not support it.
5510 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
5511 "Insert directory listing for FILE, formatted according to SWITCHES.
5512 Leaves point after the inserted text.
5513 SWITCHES may be a string of options, or a list of strings
5514 representing individual options.
5515 Optional third arg WILDCARD means treat FILE as shell wildcard.
5516 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5517 switches do not contain `d', so that a full listing is expected.
5519 This works by running a directory listing program
5520 whose name is in the variable `insert-directory-program'.
5521 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5523 When SWITCHES contains the long `--dired' option, this function
5524 treats it specially, for the sake of dired. However, the
5525 normally equivalent short `-D' option is just passed on to
5526 `insert-directory-program', as any other option."
5527 ;; We need the directory in order to find the right handler.
5528 (let ((handler (find-file-name-handler (expand-file-name file
)
5529 'insert-directory
)))
5531 (funcall handler
'insert-directory file switches
5532 wildcard full-directory-p
)
5533 (let (result (beg (point)))
5535 ;; Read the actual directory using `insert-directory-program'.
5536 ;; RESULT gets the status code.
5537 (let* (;; We at first read by no-conversion, then after
5538 ;; putting text property `dired-filename, decode one
5539 ;; bunch by one to preserve that property.
5540 (coding-system-for-read 'no-conversion
)
5541 ;; This is to control encoding the arguments in call-process.
5542 (coding-system-for-write
5543 (and enable-multibyte-characters
5544 (or file-name-coding-system
5545 default-file-name-coding-system
))))
5548 ;; Run ls in the directory part of the file pattern
5549 ;; using the last component as argument.
5550 (let ((default-directory
5551 (if (file-name-absolute-p file
)
5552 (file-name-directory file
)
5553 (file-name-directory (expand-file-name file
))))
5554 (pattern (file-name-nondirectory file
)))
5556 shell-file-name nil t nil
5558 (concat (if (memq system-type
'(ms-dos windows-nt
))
5560 "\\") ; Disregard Unix shell aliases!
5561 insert-directory-program
5563 (if (stringp switches
)
5565 (mapconcat 'identity switches
" "))
5567 ;; Quote some characters that have
5568 ;; special meanings in shells; but
5569 ;; don't quote the wildcards--we want
5570 ;; them to be special. We also
5571 ;; currently don't quote the quoting
5572 ;; characters in case people want to
5573 ;; use them explicitly to quote
5574 ;; wildcard characters.
5575 (shell-quote-wildcard-pattern pattern
))))
5576 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5577 ;; directory if FILE is a symbolic link.
5578 (apply 'call-process
5579 insert-directory-program nil t nil
5581 (if (listp switches
) switches
5582 (unless (equal switches
"")
5583 ;; Split the switches at any spaces so we can
5584 ;; pass separate options as separate args.
5585 (split-string switches
)))
5586 ;; Avoid lossage if FILE starts with `-'.
5589 (if (string-match "\\`~" file
)
5590 (setq file
(expand-file-name file
)))
5592 (if full-directory-p
5593 (concat (file-name-as-directory file
) ".")
5596 ;; If we got "//DIRED//" in the output, it means we got a real
5597 ;; directory listing, even if `ls' returned nonzero.
5598 ;; So ignore any errors.
5599 (when (if (stringp switches
)
5600 (string-match "--dired\\>" switches
)
5601 (member "--dired" switches
))
5604 (when (looking-at "//SUBDIRED//")
5606 (if (looking-at "//DIRED//")
5609 (when (and (not (eq 0 result
))
5610 (eq insert-directory-ls-version
'unknown
))
5611 ;; The first time ls returns an error,
5612 ;; find the version numbers of ls,
5613 ;; and set insert-directory-ls-version
5614 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5615 ;; is equal or if the info cannot be obtained.
5616 ;; (That can mean it isn't GNU ls.)
5619 (call-process "ls" nil t nil
"--version")
5621 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
5622 (let* ((version (match-string 1 version-out
))
5623 (split (split-string version
"[.]"))
5624 (numbers (mapcar 'string-to-number split
))
5627 (while (and (not comparison
) (or numbers min
))
5629 (setq comparison
'>))
5631 (setq comparison
'<))
5632 ((> (car numbers
) (car min
))
5633 (setq comparison
'>))
5634 ((< (car numbers
) (car min
))
5635 (setq comparison
'<))
5637 (setq numbers
(cdr numbers
)
5639 (setq insert-directory-ls-version
(or comparison
'=)))
5640 (setq insert-directory-ls-version nil
))))
5642 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5643 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
5646 ;; If `insert-directory-program' failed, signal an error.
5647 (unless (eq 0 result
)
5648 ;; Delete the error message it may have output.
5649 (delete-region beg
(point))
5650 ;; On non-Posix systems, we cannot open a directory, so
5651 ;; don't even try, because that will always result in
5652 ;; the ubiquitous "Access denied". Instead, show the
5653 ;; command line so the user can try to guess what went wrong.
5654 (if (and (file-directory-p file
)
5655 (memq system-type
'(ms-dos windows-nt
)))
5657 "Reading directory: \"%s %s -- %s\" exited with status %s"
5658 insert-directory-program
5659 (if (listp switches
) (concat switches
) switches
)
5661 ;; Unix. Access the file to get a suitable error.
5662 (access-file file
"Reading directory")
5663 (error "Listing directory failed but `access-file' worked")))
5665 (when (if (stringp switches
)
5666 (string-match "--dired\\>" switches
)
5667 (member "--dired" switches
))
5668 ;; The following overshoots by one line for an empty
5669 ;; directory listed with "--dired", but without "-a"
5670 ;; switch, where the ls output contains a
5671 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5672 ;; We take care of that case later.
5674 (when (looking-at "//SUBDIRED//")
5675 (delete-region (point) (progn (forward-line 1) (point)))
5677 (if (looking-at "//DIRED//")
5678 (let ((end (line-end-position))
5681 ;; Find all the lines that are error messages,
5682 ;; and record the bounds of each one.
5684 (while (< (point) linebeg
)
5685 (or (eql (following-char) ?\s
)
5686 (push (list (point) (line-end-position)) error-lines
))
5688 (setq error-lines
(nreverse error-lines
))
5689 ;; Now read the numeric positions of file names.
5693 (while (< (point) end
)
5694 (let ((start (insert-directory-adj-pos
5695 (+ beg
(read (current-buffer)))
5697 (end (insert-directory-adj-pos
5698 (+ beg
(read (current-buffer)))
5700 (if (memq (char-after end
) '(?
\n ?\s
))
5701 ;; End is followed by \n or by " -> ".
5702 (put-text-property start end
'dired-filename t
)
5703 ;; It seems that we can't trust ls's output as to
5704 ;; byte positions of filenames.
5705 (put-text-property beg
(point) 'dired-filename nil
)
5709 (delete-region (point) (progn (forward-line 1) (point))))
5710 ;; Take care of the case where the ls output contains a
5711 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5712 ;; and we went one line too far back (see above).
5714 (if (looking-at "//DIRED-OPTIONS//")
5715 (delete-region (point) (progn (forward-line 1) (point)))))
5717 ;; Now decode what read if necessary.
5718 (let ((coding (or coding-system-for-read
5719 file-name-coding-system
5720 default-file-name-coding-system
5724 (when (and enable-multibyte-characters
5725 (not (memq (coding-system-base coding
)
5726 '(raw-text no-conversion
))))
5727 ;; If no coding system is specified or detection is
5728 ;; requested, detect the coding.
5729 (if (eq (coding-system-base coding
) 'undecided
)
5730 (setq coding
(detect-coding-region beg
(point) t
)))
5731 (if (not (eq (coding-system-base coding
) 'undecided
))
5734 (coding-system-change-eol-conversion coding
'unix
))
5735 (narrow-to-region beg
(point))
5736 (goto-char (point-min))
5739 val
(get-text-property (point) 'dired-filename
))
5740 (goto-char (next-single-property-change
5741 (point) 'dired-filename nil
(point-max)))
5742 ;; Force no eol conversion on a file name, so
5743 ;; that CR is preserved.
5744 (decode-coding-region pos
(point)
5745 (if val coding-no-eol coding
))
5747 (put-text-property pos
(point)
5748 'dired-filename t
)))))))
5750 (if full-directory-p
5751 ;; Try to insert the amount of free space.
5754 ;; First find the line to put it on.
5755 (when (re-search-forward "^ *\\(total\\)" nil t
)
5756 (let ((available (get-free-disk-space ".")))
5758 ;; Replace "total" with "used", to avoid confusion.
5759 (replace-match "total used in directory" nil nil nil
1)
5761 (insert " available " available
))))))))))
5763 (defun insert-directory-adj-pos (pos error-lines
)
5764 "Convert `ls --dired' file name position value POS to a buffer position.
5765 File name position values returned in ls --dired output
5766 count only stdout; they don't count the error messages sent to stderr.
5767 So this function converts to them to real buffer positions.
5768 ERROR-LINES is a list of buffer positions of error message lines,
5769 of the form (START END)."
5770 (while (and error-lines
(< (caar error-lines
) pos
))
5771 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
5775 (defun insert-directory-safely (file switches
5776 &optional wildcard full-directory-p
)
5777 "Insert directory listing for FILE, formatted according to SWITCHES.
5779 Like `insert-directory', but if FILE does not exist, it inserts a
5780 message to that effect instead of signaling an error."
5781 (if (file-exists-p file
)
5782 (insert-directory file switches wildcard full-directory-p
)
5783 ;; Simulate the message printed by `ls'.
5784 (insert (format "%s: No such file or directory\n" file
))))
5786 (defvar kill-emacs-query-functions nil
5787 "Functions to call with no arguments to query about killing Emacs.
5788 If any of these functions returns nil, killing Emacs is cancelled.
5789 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5790 the low level primitive, does not. See also `kill-emacs-hook'.")
5792 (defcustom confirm-kill-emacs nil
5793 "How to ask for confirmation when leaving Emacs.
5794 If nil, the default, don't ask at all. If the value is non-nil, it should
5795 be a predicate function such as `yes-or-no-p'."
5796 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
5797 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
5798 (const :tag
"Don't confirm" nil
))
5802 (defun save-buffers-kill-emacs (&optional arg
)
5803 "Offer to save each buffer, then kill this Emacs process.
5804 With prefix ARG, silently save all file-visiting buffers, then kill."
5806 (save-some-buffers arg t
)
5807 (and (or (not (memq t
(mapcar (function
5808 (lambda (buf) (and (buffer-file-name buf
)
5809 (buffer-modified-p buf
))))
5811 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5812 (or (not (fboundp 'process-list
))
5813 ;; process-list is not defined on MSDOS.
5814 (let ((processes (process-list))
5817 (and (memq (process-status (car processes
)) '(run stop open listen
))
5818 (process-query-on-exit-flag (car processes
))
5820 (setq processes
(cdr processes
)))
5823 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5824 ;; Query the user for other things, perhaps.
5825 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
5826 (or (null confirm-kill-emacs
)
5827 (funcall confirm-kill-emacs
"Really exit Emacs? "))
5830 (defun save-buffers-kill-terminal (&optional arg
)
5831 "Offer to save each buffer, then kill the current connection.
5832 If the current frame has no client, kill Emacs itself.
5834 With prefix ARG, silently save all file-visiting buffers, then kill.
5836 If emacsclient was started with a list of filenames to edit, then
5837 only these files will be asked to be saved."
5839 (if (frame-parameter (selected-frame) 'client
)
5840 (server-save-buffers-kill-terminal arg
)
5841 (save-buffers-kill-emacs arg
)))
5843 ;; We use /: as a prefix to "quote" a file name
5844 ;; so that magic file name handlers will not apply to it.
5846 (setq file-name-handler-alist
5847 (cons '("\\`/:" . file-name-non-special
)
5848 file-name-handler-alist
))
5850 ;; We depend on being the last handler on the list,
5851 ;; so that anything else which does need handling
5852 ;; has been handled already.
5853 ;; So it is safe for us to inhibit *all* magic file name handlers.
5855 (defun file-name-non-special (operation &rest arguments
)
5856 (let ((file-name-handler-alist nil
)
5858 (if (eq operation
'insert-directory
)
5859 (directory-file-name
5861 (unhandled-file-name-directory default-directory
)))
5863 ;; Get a list of the indices of the args which are file names.
5865 (cdr (or (assq operation
5866 ;; The first six are special because they
5867 ;; return a file name. We want to include the /:
5868 ;; in the return value.
5869 ;; So just avoid stripping it in the first place.
5870 '((expand-file-name . nil
)
5871 (file-name-directory . nil
)
5872 (file-name-as-directory . nil
)
5873 (directory-file-name . nil
)
5874 (file-name-sans-versions . nil
)
5875 (find-backup-file-name . nil
)
5876 ;; `identity' means just return the first arg
5877 ;; not stripped of its quoting.
5878 (substitute-in-file-name identity
)
5879 ;; `add' means add "/:" to the result.
5880 (file-truename add
0)
5881 ;; `quote' means add "/:" to buffer-file-name.
5882 (insert-file-contents quote
0)
5883 ;; `unquote-then-quote' means set buffer-file-name
5884 ;; temporarily to unquoted filename.
5885 (verify-visited-file-modtime unquote-then-quote
)
5886 ;; List the arguments which are filenames.
5887 (file-name-completion 1)
5888 (file-name-all-completions 1)
5892 (make-symbolic-link 0 1)
5893 (add-name-to-file 0 1)))
5894 ;; For all other operations, treat the first argument only
5895 ;; as the file name.
5898 ;; Copy ARGUMENTS so we can replace elements in it.
5899 (arguments (copy-sequence arguments
)))
5900 (if (symbolp (car file-arg-indices
))
5901 (setq method
(pop file-arg-indices
)))
5902 ;; Strip off the /: from the file names that have it.
5904 (while (consp file-arg-indices
)
5905 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
5907 (string-match "\\`/:" (car pair
))
5909 (if (= (length (car pair
)) 2)
5911 (substring (car pair
) 2)))))
5912 (setq file-arg-indices
(cdr file-arg-indices
))))
5913 (cond ((eq method
'identity
)
5916 (concat "/:" (apply operation arguments
)))
5919 (apply operation arguments
)
5920 (setq buffer-file-name
(concat "/:" buffer-file-name
))))
5921 ((eq method
'unquote-then-quote
)
5923 (setq buffer-file-name
(substring buffer-file-name
2))
5924 (setq res
(apply operation arguments
))
5925 (setq buffer-file-name
(concat "/:" buffer-file-name
))
5928 (apply operation arguments
)))))
5930 ;; Symbolic modes and read-file-modes.
5932 (defun file-modes-char-to-who (char)
5933 "Convert CHAR to a numeric bit-mask for extracting mode bits.
5934 CHAR is in [ugoa] and represents the category of users (Owner, Group,
5935 Others, or All) for whom to produce the mask.
5936 The bit-mask that is returned extracts from mode bits the access rights
5937 for the specified category of users."
5938 (cond ((= char ?u
) #o4700
)
5939 ((= char ?g
) #o2070
)
5940 ((= char ?o
) #o1007
)
5941 ((= char ?a
) #o7777
)
5942 (t (error "%c: bad `who' character" char
))))
5944 (defun file-modes-char-to-right (char &optional from
)
5945 "Convert CHAR to a numeric value of mode bits.
5946 CHAR is in [rwxXstugo] and represents symbolic access permissions.
5947 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
5948 (or from
(setq from
0))
5949 (cond ((= char ?r
) #o0444
)
5950 ((= char ?w
) #o0222
)
5951 ((= char ?x
) #o0111
)
5952 ((= char ?s
) #o1000
)
5953 ((= char ?t
) #o6000
)
5954 ;; Rights relative to the previous file modes.
5955 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
5956 ((= char ?u
) (let ((uright (logand #o4700 from
)))
5957 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
5958 ((= char ?g
) (let ((gright (logand #o2070 from
)))
5959 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
5960 ((= char ?o
) (let ((oright (logand #o1007 from
)))
5961 (+ oright
(* oright
#o10
) (* oright
#o100
))))
5962 (t (error "%c: bad right character" char
))))
5964 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
5965 "Convert a symbolic mode string specification to an equivalent number.
5966 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
5967 WHO-MASK is the bit-mask specifying the category of users to which to
5968 apply the access permissions. See `file-modes-char-to-who'.
5969 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5970 RIGHTS request to add, remove, or set permissions based on existing ones,
5972 (let* ((num-rights (or from
0))
5973 (list-rights (string-to-list rights
))
5974 (op (pop list-rights
)))
5975 (while (memq op
'(?
+ ?- ?
=))
5978 (while (memq (setq char-right
(pop list-rights
))
5979 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
5982 (file-modes-char-to-right char-right num-rights
))))
5983 (setq num-right
(logand who-mask num-right
)
5985 (cond ((= op ?
+) (logior num-rights num-right
))
5986 ((= op ?-
) (logand num-rights
(lognot num-right
)))
5987 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
5991 (defun file-modes-symbolic-to-number (modes &optional from
)
5992 "Convert symbolic file modes to numeric file modes.
5993 MODES is the string to convert, it should match
5994 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
5995 See (info \"(coreutils)File permissions\") for more information on this
5997 FROM (or 0 if nil) gives the mode bits on which to base permissions if
5998 MODES request to add, remove, or set permissions based on existing ones,
6001 (let ((case-fold-search nil
)
6002 (num-modes (or from
0)))
6003 (while (/= (string-to-char modes
) 0)
6004 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes
)
6005 (let ((num-who (apply 'logior
0
6006 (mapcar 'file-modes-char-to-who
6007 (match-string 1 modes
)))))
6009 (setq num-who
(default-file-modes)))
6011 (file-modes-rights-to-number (substring modes
(match-end 1))
6013 modes
(substring modes
(match-end 3))))
6014 (error "Parse error in modes near `%s'" (substring modes
0))))
6017 (defun read-file-modes (&optional prompt orig-file
)
6018 "Read file modes in octal or symbolic notation and return its numeric value.
6019 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6020 ORIG-FILE is the name of a file on whose mode bits to base returned
6021 permissions if what user types requests to add, remove, or set permissions
6022 based on existing mode bits, as in \"og+rX-w\"."
6023 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
6024 (error "File not found")))
6025 (modestr (and (stringp orig-file
)
6026 (nth 8 (file-attributes orig-file
))))
6028 (and (stringp modestr
)
6029 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
6030 (replace-regexp-in-string
6032 (format "u=%s,g=%s,o=%s"
6033 (match-string 1 modestr
)
6034 (match-string 2 modestr
)
6035 (match-string 3 modestr
)))))
6036 (value (read-string (or prompt
"File modes (octal or symbolic): ")
6039 (if (string-match "^[0-7]+" value
)
6040 (string-to-number value
8)
6041 (file-modes-symbolic-to-number value modes
)))))
6044 ;; Trashcan handling.
6045 (defcustom trash-directory nil
6046 "Directory for `move-file-to-trash' to move files and directories to.
6047 This directory is only used when the function `system-move-file-to-trash'
6049 Relative paths are interpreted relative to `default-directory'.
6050 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6051 :type
'(choice (const nil
) directory
)
6055 (defvar trash--hexify-table
)
6057 (declare-function system-move-file-to-trash
"w32fns.c" (filename))
6059 (defun move-file-to-trash (filename)
6060 "Move the file (or directory) named FILENAME to the trash.
6061 When `delete-by-moving-to-trash' is non-nil, this function is
6062 called by `delete-file' and `delete-directory' instead of
6063 deleting files outright.
6065 If the function `system-move-file-to-trash' is defined, call it
6066 with FILENAME as an argument.
6067 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6069 Otherwise, trash FILENAME using the freedesktop.org conventions,
6070 like the GNOME, KDE and XFCE desktop environments. Emacs only
6071 moves files to \"home trash\", ignoring per-volume trashcans."
6072 (interactive "fMove file to trash: ")
6073 (cond (trash-directory
6074 ;; If `trash-directory' is non-nil, move the file there.
6075 (let* ((trash-dir (expand-file-name trash-directory
))
6076 (fn (directory-file-name (expand-file-name filename
)))
6077 (new-fn (expand-file-name (file-name-nondirectory fn
)
6079 ;; We can't trash a parent directory of trash-directory.
6080 (if (string-match fn trash-dir
)
6081 (error "Trash directory `%s' is a subdirectory of `%s'"
6082 trash-dir filename
))
6083 (unless (file-directory-p trash-dir
)
6084 (make-directory trash-dir t
))
6085 ;; Ensure that the trashed file-name is unique.
6086 (if (file-exists-p new-fn
)
6087 (let ((version-control t
)
6088 (backup-directory-alist nil
))
6089 (setq new-fn
(car (find-backup-file-name new-fn
)))))
6090 (let (delete-by-moving-to-trash)
6091 (rename-file fn new-fn
))))
6092 ;; If `system-move-file-to-trash' is defined, use it.
6093 ((fboundp 'system-move-file-to-trash
)
6094 (system-move-file-to-trash filename
))
6095 ;; Otherwise, use the freedesktop.org method, as specified at
6096 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6098 (let* ((xdg-data-dir
6099 (directory-file-name
6100 (expand-file-name "Trash"
6101 (or (getenv "XDG_DATA_HOME")
6102 "~/.local/share"))))
6103 (trash-files-dir (expand-file-name "files" xdg-data-dir
))
6104 (trash-info-dir (expand-file-name "info" xdg-data-dir
))
6105 (fn (directory-file-name (expand-file-name filename
))))
6107 ;; Check if we have permissions to delete.
6108 (unless (file-writable-p (directory-file-name
6109 (file-name-directory fn
)))
6110 (error "Cannot move %s to trash: Permission denied" filename
))
6111 ;; The trashed file cannot be the trash dir or its parent.
6112 (if (string-match fn trash-files-dir
)
6113 (error "The trash directory %s is a subdirectory of %s"
6114 trash-files-dir filename
))
6115 (if (string-match fn trash-info-dir
)
6116 (error "The trash directory %s is a subdirectory of %s"
6117 trash-info-dir filename
))
6119 ;; Ensure that the trash directory exists; otherwise, create it.
6120 (let ((saved-default-file-modes (default-file-modes)))
6121 (set-default-file-modes ?
\700)
6122 (unless (file-exists-p trash-files-dir
)
6123 (make-directory trash-files-dir t
))
6124 (unless (file-exists-p trash-info-dir
)
6125 (make-directory trash-info-dir t
))
6126 (set-default-file-modes saved-default-file-modes
))
6128 ;; Try to move to trash with .trashinfo undo information
6131 (set-buffer-file-coding-system 'utf-8-unix
)
6132 (insert "[Trash Info]\nPath=")
6133 ;; Perform url-encoding on FN. For compatibility with
6134 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6135 ;; for path separators.
6136 (unless (boundp 'trash--hexify-table
)
6137 (setq trash--hexify-table
(make-vector 256 nil
))
6138 (let ((unreserved-chars
6139 (list ?
/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6140 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6141 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6142 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?
0 ?
1 ?
2
6143 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9 ?- ?_ ?. ?
! ?~ ?
* ?
'
6146 (aset trash--hexify-table byte
6147 (if (memq byte unreserved-chars
)
6148 (char-to-string byte
)
6149 (format "%%%02x" byte
))))))
6150 (mapc (lambda (byte)
6151 (insert (aref trash--hexify-table byte
)))
6152 (if (multibyte-string-p fn
)
6153 (encode-coding-string fn
'utf-8
)
6155 (insert "\nDeletionDate="
6156 (format-time-string "%Y-%m-%dT%T")
6159 ;; Attempt to make .trashinfo file, trying up to 5
6160 ;; times. The .trashinfo file is opened with O_EXCL,
6161 ;; as per trash-spec 0.7, even if that can be a problem
6162 ;; on old NFS versions...
6164 (base-fn (expand-file-name
6165 (file-name-nondirectory fn
)
6170 (setq info-fn
(expand-file-name
6171 (concat (file-name-nondirectory new-fn
)
6174 (unless (condition-case nil
6176 (write-region nil nil info-fn nil
6177 'quiet info-fn
'excl
)
6178 (setq tries
0 success t
))
6179 (file-already-exists nil
))
6180 (setq tries
(1- tries
))
6181 ;; Uniqify new-fn. (Some file managers do not
6182 ;; like Emacs-style backup file names---e.g. bug
6183 ;; 170956 in Konqueror bug tracker.)
6184 (setq new-fn
(make-temp-name (concat base-fn
"_")))))
6186 (error "Cannot move %s to trash: Lock failed" filename
))
6188 ;; Finally, try to move the file to the trashcan.
6189 (let ((delete-by-moving-to-trash nil
))
6190 (rename-file fn new-fn
)))))))))
6193 (define-key ctl-x-map
"\C-f" 'find-file
)
6194 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
6195 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
6196 (define-key ctl-x-map
"\C-s" 'save-buffer
)
6197 (define-key ctl-x-map
"s" 'save-some-buffers
)
6198 (define-key ctl-x-map
"\C-w" 'write-file
)
6199 (define-key ctl-x-map
"i" 'insert-file
)
6200 (define-key esc-map
"~" 'not-modified
)
6201 (define-key ctl-x-map
"\C-d" 'list-directory
)
6202 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
6203 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
6205 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
6206 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
6207 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
6208 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
6209 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
6211 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
6212 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
6213 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
6214 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
6215 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
6217 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6218 ;;; files.el ends here