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, 2006,
5 ;; 2007, 2008, 2009, 2010 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 (purecopy "/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)))
226 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
227 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
228 "[\000-\037]\\|" ; control characters
229 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
230 "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot
231 ((memq system-type '(ms-dos windows-nt cygwin))
233 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
234 "[|<>\"?*\000-\037]"))) ; invalid characters
235 (t (purecopy "[\000]")))
236 "Regexp recognizing file names which aren't allowed by the filesystem.")
238 (defcustom file-precious-flag nil
239 "Non-nil means protect against I/O errors while saving files.
240 Some modes set this non-nil in particular buffers.
242 This feature works by writing the new contents into a temporary file
243 and then renaming the temporary file to replace the original.
244 In this way, any I/O error in writing leaves the original untouched,
245 and there is never any instant where the file is nonexistent.
247 Note that this feature forces backups to be made by copying.
248 Yet, at the same time, saving a precious file
249 breaks any hard links between it and other files.
251 This feature is advisory: for example, if the directory in which the
252 file is being saved is not writable, Emacs may ignore a non-nil value
253 of `file-precious-flag' and write directly into the file.
255 See also: `break-hardlink-on-save'."
259 (defcustom break-hardlink-on-save nil
260 "Non-nil means when saving a file that exists under several names
261 \(i.e., has multiple hardlinks), break the hardlink associated with
262 `buffer-file-name' and write to a new file, so that the other
263 instances of the file are not affected by the save.
265 If `buffer-file-name' refers to a symlink, do not break the symlink.
267 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
268 For example, if the directory in which a file is being saved is not
269 itself writable, then error instead of saving in some
270 hardlink-nonbreaking way.
272 See also `backup-by-copying' and `backup-by-copying-when-linked'."
277 (defcustom version-control nil
278 "Control use of version numbers for backup files.
279 When t, make numeric backup versions unconditionally.
280 When nil, make them for files that have some already.
281 The value `never' means do not make them."
282 :type '(choice (const :tag "Never" never)
283 (const :tag "If existing" nil)
284 (other :tag "Always" t))
287 (put 'version-control 'safe-local-variable
288 '(lambda (x) (or (booleanp x) (equal x 'never))))
290 (defcustom dired-kept-versions 2
291 "When cleaning directory, number of versions to keep."
296 (defcustom delete-old-versions nil
297 "If t, delete excess backup versions silently.
298 If nil, ask confirmation. Any other value prevents any trimming."
299 :type '(choice (const :tag "Delete" t)
300 (const :tag "Ask" nil)
301 (other :tag "Leave" other))
304 (defcustom kept-old-versions 2
305 "Number of oldest versions to keep when a new numbered backup is made."
308 (put 'kept-old-versions 'safe-local-variable 'integerp)
310 (defcustom kept-new-versions 2
311 "Number of newest versions to keep when a new numbered backup is made.
312 Includes the new backup. Must be > 0"
315 (put 'kept-new-versions 'safe-local-variable 'integerp)
317 (defcustom require-final-newline nil
318 "Whether to add a newline automatically at the end of the file.
320 A value of t means do this only when the file is about to be saved.
321 A value of `visit' means do this right after the file is visited.
322 A value of `visit-save' means do it at both of those times.
323 Any other non-nil value means ask user whether to add a newline, when saving.
324 A value of nil means don't add newlines.
326 Certain major modes set this locally to the value obtained
327 from `mode-require-final-newline'."
328 :type '(choice (const :tag "When visiting" visit)
329 (const :tag "When saving" t)
330 (const :tag "When visiting or saving" visit-save)
331 (const :tag "Don't add newlines" nil)
332 (other :tag "Ask each time" ask))
333 :group 'editing-basics)
335 (defcustom mode-require-final-newline t
336 "Whether to add a newline at end of file, in certain major modes.
337 Those modes set `require-final-newline' to this value when you enable them.
338 They do so because they are often used for files that are supposed
339 to end in newlines, and the question is how to arrange that.
341 A value of t means do this only when the file is about to be saved.
342 A value of `visit' means do this right after the file is visited.
343 A value of `visit-save' means do it at both of those times.
344 Any other non-nil value means ask user whether to add a newline, when saving.
346 A value of nil means do not add newlines. That is a risky choice in this
347 variable since this value is used for modes for files that ought to have
348 final newlines. So if you set this to nil, you must explicitly check and
349 add a final newline, whenever you save a file that really needs one."
350 :type '(choice (const :tag "When visiting" visit)
351 (const :tag "When saving" t)
352 (const :tag "When visiting or saving" visit-save)
353 (const :tag "Don't add newlines" nil)
354 (other :tag "Ask each time" ask))
355 :group 'editing-basics
358 (defcustom auto-save-default t
359 "Non-nil says by default do auto-saving of every file-visiting buffer."
363 (defcustom auto-save-file-name-transforms
364 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
365 ;; Don't put "\\2" inside expand-file-name, since it will be
366 ;; transformed to "/2" on DOS/Windows.
367 ,(concat temporary-file-directory "\\2") t))
368 "Transforms to apply to buffer file name before making auto-save file name.
369 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
370 REGEXP is a regular expression to match against the file name.
371 If it matches, `replace-match' is used to replace the
372 matching part with REPLACEMENT.
373 If the optional element UNIQUIFY is non-nil, the auto-save file name is
374 constructed by taking the directory part of the replaced file-name,
375 concatenated with the buffer file name with all directory separators
376 changed to `!' to prevent clashes. This will not work
377 correctly if your filesystem truncates the resulting name.
379 All the transforms in the list are tried, in the order they are listed.
380 When one transform applies, its result is final;
381 no further transforms are tried.
383 The default value is set up to put the auto-save file into the
384 temporary directory (see the variable `temporary-file-directory') for
385 editing a remote file.
387 On MS-DOS filesystems without long names this variable is always
390 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
391 (boolean :tag "Uniquify")))
392 :initialize 'custom-initialize-delay
395 (defcustom save-abbrevs t
396 "Non-nil means save word abbrevs too when files are saved.
397 If `silently', don't ask the user before saving."
398 :type '(choice (const t) (const nil) (const silently))
401 (defcustom find-file-run-dired t
402 "Non-nil means allow `find-file' to visit directories.
403 To visit the directory, `find-file' runs `find-directory-functions'."
407 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
408 "List of functions to try in sequence to visit a directory.
409 Each function is called with the directory name as the sole argument
410 and should return either a buffer or nil."
411 :type '(hook :options (cvs-dired-noselect dired-noselect))
414 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
415 (defcustom file-name-at-point-functions '(ffap-guess-file-name-at-point)
416 "List of functions to try in sequence to get a file name at point.
417 Each function should return either nil or a file name found at the
418 location of point in the current buffer."
419 :type '(hook :options (ffap-guess-file-name-at-point))
422 ;;;It is not useful to make this a local variable.
423 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
424 (defvar find-file-not-found-functions nil
425 "List of functions to be called for `find-file' on nonexistent file.
426 These functions are called as soon as the error is detected.
427 Variable `buffer-file-name' is already set up.
428 The functions are called in the order given until one of them returns non-nil.")
429 (define-obsolete-variable-alias 'find-file-not-found-hooks
430 'find-file-not-found-functions "22.1")
432 ;;;It is not useful to make this a local variable.
433 ;;;(put 'find-file-hooks 'permanent-local t)
434 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
435 (defcustom find-file-hook nil
436 "List of functions to be called after a buffer is loaded from a file.
437 The buffer's local variables (if any) will have been processed before the
438 functions are called."
441 :options '(auto-insert)
444 (defvar write-file-functions nil
445 "List of functions to be called before writing out a buffer to a file.
446 If one of them returns non-nil, the file is considered already written
447 and the rest are not called.
448 These hooks are considered to pertain to the visited file.
449 So any buffer-local binding of this variable is discarded if you change
450 the visited file name with \\[set-visited-file-name], but not when you
451 change the major mode.
453 This hook is not run if any of the functions in
454 `write-contents-functions' returns non-nil. Both hooks pertain
455 to how to save a buffer to file, for instance, choosing a suitable
456 coding system and setting mode bits. (See Info
457 node `(elisp)Saving Buffers'.) To perform various checks or
458 updates before the buffer is saved, use `before-save-hook'.")
459 (put 'write-file-functions 'permanent-local t)
460 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
462 (defvar local-write-file-hooks nil)
463 (make-variable-buffer-local 'local-write-file-hooks)
464 (put 'local-write-file-hooks 'permanent-local t)
465 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
467 (defvar write-contents-functions nil
468 "List of functions to be called before writing out a buffer to a file.
469 If one of them returns non-nil, the file is considered already written
470 and the rest are not called and neither are the functions in
471 `write-file-functions'.
473 This variable is meant to be used for hooks that pertain to the
474 buffer's contents, not to the particular visited file; thus,
475 `set-visited-file-name' does not clear this variable; but changing the
476 major mode does clear it.
478 For hooks that _do_ pertain to the particular visited file, use
479 `write-file-functions'. Both this variable and
480 `write-file-functions' relate to how a buffer is saved to file.
481 To perform various checks or updates before the buffer is saved,
482 use `before-save-hook'.")
483 (make-variable-buffer-local 'write-contents-functions)
484 (define-obsolete-variable-alias 'write-contents-hooks
485 'write-contents-functions "22.1")
487 (defcustom enable-local-variables t
488 "Control use of local variables in files you visit.
489 The value can be t, nil, :safe, :all, or something else.
491 A value of t means file local variables specifications are obeyed
492 if all the specified variable values are safe; if any values are
493 not safe, Emacs queries you, once, whether to set them all.
494 \(When you say yes to certain values, they are remembered as safe.)
496 :safe means set the safe variables, and ignore the rest.
497 :all means set all variables, whether safe or not.
498 (Don't set it permanently to :all.)
499 A value of nil means always ignore the file local variables.
501 Any other value means always query you once whether to set them all.
502 \(When you say yes to certain values, they are remembered as safe, but
503 this has no effect when `enable-local-variables' is \"something else\".)
505 This variable also controls use of major modes specified in
508 The command \\[normal-mode], when used interactively,
509 always obeys file local variable specifications and the -*- line,
510 and ignores this variable."
512 :type '(choice (const :tag "Query Unsafe" t)
513 (const :tag "Safe Only" :safe)
514 (const :tag "Do all" :all)
515 (const :tag "Ignore" nil)
516 (other :tag "Query" other))
519 (defvar local-enable-local-variables t
520 "Like `enable-local-variables' but meant for buffer-local bindings.
521 The meaningful values are nil and non-nil. The default is non-nil.
522 If a major mode sets this to nil, buffer-locally, then any local
523 variables list in the file will be ignored.
525 This variable does not affect the use of major modes
526 specified in a -*- line.")
528 (defcustom enable-local-eval 'maybe
529 "Control processing of the \"variable\" `eval' in a file's local variables.
530 The value can be t, nil or something else.
531 A value of t means obey `eval' variables.
532 A value of nil means ignore them; anything else means query."
534 :type '(choice (const :tag "Obey" t)
535 (const :tag "Ignore" nil)
536 (other :tag "Query" other))
539 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
540 (or (fboundp 'lock-buffer)
541 (defalias 'lock-buffer 'ignore))
542 (or (fboundp 'unlock-buffer)
543 (defalias 'unlock-buffer 'ignore))
544 (or (fboundp 'file-locked-p)
545 (defalias 'file-locked-p 'ignore))
547 (defcustom view-read-only nil
548 "Non-nil means buffers visiting files read-only do so in view mode.
549 In fact, this means that all read-only buffers normally have
550 View mode enabled, including buffers that are read-only because
551 you visit a file you cannot alter, and buffers you make read-only
552 using \\[toggle-read-only]."
556 (defvar file-name-history nil
557 "History list of file names entered in the minibuffer.
559 Maximum length of the history list is determined by the value
560 of `history-length', which see.")
562 (put 'ange-ftp-completion-hook-function 'safe-magic t)
563 (defun ange-ftp-completion-hook-function (op &rest args)
564 "Provides support for ange-ftp host name completion.
565 Runs the usual ange-ftp hook, but only for completion operations."
566 ;; Having this here avoids the need to load ange-ftp when it's not
568 (if (memq op '(file-name-completion file-name-all-completions))
569 (apply 'ange-ftp-hook-function op args)
570 (let ((inhibit-file-name-handlers
571 (cons 'ange-ftp-completion-hook-function
572 (and (eq inhibit-file-name-operation op)
573 inhibit-file-name-handlers)))
574 (inhibit-file-name-operation op))
577 (declare-function dos-convert-standard-filename "dos-fns.el" (filename))
578 (declare-function w32-convert-standard-filename "w32-fns.el" (filename))
580 (defun convert-standard-filename (filename)
581 "Convert a standard file's name to something suitable for the OS.
582 This means to guarantee valid names and perhaps to canonicalize
585 FILENAME should be an absolute file name since the conversion rules
586 sometimes vary depending on the position in the file name. E.g. c:/foo
587 is a valid DOS file name, but c:/bar/c:/foo is not.
589 This function's standard definition is trivial; it just returns
590 the argument. However, on Windows and DOS, replace invalid
591 characters. On DOS, make sure to obey the 8.3 limitations.
592 In the native Windows build, turn Cygwin names into native names,
593 and also turn slashes into backslashes if the shell requires it (see
594 `w32-shell-dos-semantics').
596 See Info node `(elisp)Standard File Names' for more details."
598 ((eq system-type 'cygwin)
599 (let ((name (copy-sequence filename))
601 ;; Replace invalid filename characters with !
602 (while (string-match "[?*:<>|\"\000-\037]" name start)
603 (aset name (match-beginning 0) ?!)
604 (setq start (match-end 0)))
606 ((eq system-type 'windows-nt)
607 (w32-convert-standard-filename filename))
608 ((eq system-type 'ms-dos)
609 (dos-convert-standard-filename filename))
612 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
613 "Read directory name, prompting with PROMPT and completing in directory DIR.
614 Value is not expanded---you must call `expand-file-name' yourself.
615 Default name to DEFAULT-DIRNAME if user exits with the same
616 non-empty string that was inserted by this function.
617 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
618 or just DIR if INITIAL is nil.)
619 If the user exits with an empty minibuffer, this function returns
620 an empty string. (This can only happen if the user erased the
621 pre-inserted contents or if `insert-default-directory' is nil.)
622 Fourth arg MUSTMATCH non-nil means require existing directory's name.
623 Non-nil and non-t means also require confirmation after completion.
624 Fifth arg INITIAL specifies text to start with.
625 DIR should be an absolute directory name. It defaults to
626 the value of `default-directory'."
628 (setq dir default-directory))
629 (read-file-name prompt dir (or default-dirname
630 (if initial (expand-file-name initial dir)
637 "Show the current default directory."
639 (message "Directory %s" default-directory))
642 "Value of the CDPATH environment variable, as a list.
643 Not actually set up until the first time you use it.")
645 (defun parse-colon-path (cd-path)
646 "Explode a search path into a list of directory names.
647 Directories are separated by occurrences of `path-separator'
648 \(which is colon in GNU and GNU-like systems)."
649 ;; We could use split-string here.
651 (let (cd-list (cd-start 0) cd-colon)
652 (setq cd-path (concat cd-path path-separator))
653 (while (setq cd-colon (string-match path-separator cd-path cd-start))
656 (list (if (= cd-start cd-colon)
658 (substitute-in-file-name
659 (file-name-as-directory
660 (substring cd-path cd-start cd-colon)))))))
661 (setq cd-start (+ cd-colon 1)))
664 (defun cd-absolute (dir)
665 "Change current directory to given absolute file name DIR."
666 ;; Put the name into directory syntax now,
667 ;; because otherwise expand-file-name may give some bad results.
668 (setq dir (file-name-as-directory dir))
669 ;; We used to additionally call abbreviate-file-name here, for an
670 ;; unknown reason. Problem is that most buffers are setup
671 ;; without going through cd-absolute and don't call
672 ;; abbreviate-file-name on their default-directory, so the few that
673 ;; do end up using a superficially different directory.
674 (setq dir (expand-file-name dir))
675 (if (not (file-directory-p dir))
676 (if (file-exists-p dir)
677 (error "%s is not a directory" dir)
678 (error "%s: no such directory" dir))
679 (unless (file-executable-p dir)
680 (error "Cannot cd to %s: Permission denied" dir))
681 (setq default-directory dir)
682 (setq list-buffers-directory dir)))
685 "Make DIR become the current buffer's default directory.
686 If your environment includes a `CDPATH' variable, try each one of
687 that list of directories (separated by occurrences of
688 `path-separator') when resolving a relative directory name.
689 The path separator is colon in GNU and GNU-like systems."
691 (list (read-directory-name "Change default directory: "
692 default-directory default-directory
693 (and (member cd-path '(nil ("./")))
694 (null (getenv "CDPATH"))))))
695 (if (file-name-absolute-p dir)
696 (cd-absolute (expand-file-name dir))
698 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
699 (setq cd-path (or trypath (list "./")))))
700 (if (not (catch 'found
702 (function (lambda (x)
703 (let ((f (expand-file-name (concat x dir))))
704 (if (file-directory-p f)
707 (throw 'found t))))))
710 (error "No such directory found via CDPATH environment variable"))))
712 (defun load-file (file)
713 "Load the Lisp file named FILE."
714 ;; This is a case where .elc makes a lot of sense.
715 (interactive (list (let ((completion-ignored-extensions
716 (remove ".elc" completion-ignored-extensions)))
717 (read-file-name "Load file: "))))
718 (load (expand-file-name file) nil nil t))
720 (defun locate-file (filename path &optional suffixes predicate)
721 "Search for FILENAME through PATH.
722 If found, return the absolute file name of FILENAME, with its suffixes;
723 otherwise return nil.
724 PATH should be a list of directories to look in, like the lists in
725 `exec-path' or `load-path'.
726 If SUFFIXES is non-nil, it should be a list of suffixes to append to
727 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
728 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
729 If non-nil, PREDICATE is used instead of `file-readable-p'.
730 PREDICATE can also be an integer to pass to the `access' system call,
731 in which case file-name handlers are ignored. This usage is deprecated.
733 For compatibility, PREDICATE can also be one of the symbols
734 `executable', `readable', `writable', or `exists', or a list of
735 one or more of those symbols."
736 (if (and predicate (symbolp predicate) (not (functionp predicate)))
737 (setq predicate (list predicate)))
738 (when (and (consp predicate) (not (functionp predicate)))
740 (logior (if (memq 'executable predicate) 1 0)
741 (if (memq 'writable predicate) 2 0)
742 (if (memq 'readable predicate) 4 0))))
743 (locate-file-internal filename path suffixes predicate))
745 (defun locate-file-completion-table (dirs suffixes string pred action)
746 "Do completion for file names passed to `locate-file'."
748 ((file-name-absolute-p string)
749 ;; FIXME: maybe we should use completion-file-name-table instead,
750 ;; tho at least for `load', the arg is passed through
751 ;; substitute-in-file-name for historical reasons.
752 (read-file-name-internal string pred action))
753 ((eq (car-safe action) 'boundaries)
754 (let ((suffix (cdr action)))
756 (length (file-name-directory string))
757 (let ((x (file-name-directory suffix)))
758 (if x (1- (length x)) (length suffix))))))
761 (suffix (concat (regexp-opt suffixes t) "\\'"))
762 (string-dir (file-name-directory string))
763 (string-file (file-name-nondirectory string)))
766 (setq dir default-directory))
767 (if string-dir (setq dir (expand-file-name string-dir dir)))
768 (when (file-directory-p dir)
769 (dolist (file (file-name-all-completions
772 (when (string-match suffix file)
773 (setq file (substring file 0 (match-beginning 0)))
774 (push file names)))))
775 (completion-table-with-context
776 string-dir names string-file pred action)))))
778 (defun locate-file-completion (string path-and-suffixes action)
779 "Do completion for file names passed to `locate-file'.
780 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
781 (locate-file-completion-table (car path-and-suffixes)
782 (cdr path-and-suffixes)
784 (make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
786 (defvar locate-dominating-stop-dir-regexp
787 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
788 "Regexp of directory names which stop the search in `locate-dominating-file'.
789 Any directory whose name matches this regexp will be treated like
790 a kind of root directory by `locate-dominating-file' which will stop its search
791 when it bumps into it.
792 The default regexp prevents fruitless and time-consuming attempts to find
793 special files in directories in which filenames are interpreted as hostnames,
794 or mount points potentially requiring authentication as a different user.")
796 ;; (defun locate-dominating-files (file regexp)
797 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
798 ;; Stop at the first parent where a matching file is found and return the list
799 ;; of files that that match in this directory."
801 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
802 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
804 ;; ;; Abbreviate, so as to stop when we cross ~/.
805 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
808 ;; ;; As a heuristic, we stop looking up the hierarchy of
809 ;; ;; directories as soon as we find a directory belonging to
810 ;; ;; another user. This should save us from looking in
811 ;; ;; things like /net and /afs. This assumes that all the
812 ;; ;; files inside a project belong to the same user.
813 ;; (let ((prev-user user))
814 ;; (setq user (nth 2 (file-attributes dir)))
815 ;; (or (null prev-user) (equal user prev-user))))
816 ;; (if (setq files (condition-case nil
817 ;; (directory-files dir 'full regexp 'nosort)
819 ;; (throw 'found files)
821 ;; (setq dir (file-name-directory
822 ;; (directory-file-name dir))))
826 (defun locate-dominating-file (file name)
827 "Look up the directory hierarchy from FILE for a file named NAME.
828 Stop at the first parent directory containing a file NAME,
829 and return the directory. Return nil if not found."
830 ;; We used to use the above locate-dominating-files code, but the
831 ;; directory-files call is very costly, so we're much better off doing
832 ;; multiple calls using the code in here.
834 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
835 ;; `name' in /home or in /.
836 (setq file (abbreviate-file-name file))
839 ;; `user' is not initialized outside the loop because
840 ;; `file' may not exist, so we may have to walk up part of the
841 ;; hierarchy before we find the "initial UID".
846 ;; FIXME: Disabled this heuristic because it is sometimes
848 ;; As a heuristic, we stop looking up the hierarchy of
849 ;; directories as soon as we find a directory belonging
850 ;; to another user. This should save us from looking in
851 ;; things like /net and /afs. This assumes that all the
852 ;; files inside a project belong to the same user.
853 ;; (let ((prev-user user))
854 ;; (setq user (nth 2 (file-attributes file)))
855 ;; (and prev-user (not (equal user prev-user))))
856 (string-match locate-dominating-stop-dir-regexp file)))
857 (setq try (file-exists-p (expand-file-name name file)))
858 (cond (try (setq root file))
859 ((equal file (setq prev-file file
860 file (file-name-directory
861 (directory-file-name file))))
866 (defun executable-find (command)
867 "Search for COMMAND in `exec-path' and return the absolute file name.
868 Return nil if COMMAND is not found anywhere in `exec-path'."
869 ;; Use 1 rather than file-executable-p to better match the behavior of
871 (locate-file command exec-path exec-suffixes 1))
873 (defun load-library (library)
874 "Load the Emacs Lisp library named LIBRARY.
875 This is an interface to the function `load'. LIBRARY is searched
876 for in `load-path', both with and without `load-suffixes' (as
877 well as `load-file-rep-suffixes').
879 See Info node `(emacs)Lisp Libraries' for more details.
880 See `load-file' for a different interface to `load'."
882 (list (completing-read "Load library: "
883 (apply-partially 'locate-file-completion-table
885 (get-load-suffixes)))))
888 (defun file-remote-p (file &optional identification connected)
889 "Test whether FILE specifies a location on a remote system.
890 Returns nil or a string identifying the remote connection (ideally
891 a prefix of FILE). For example, the remote identification for filename
892 \"/user@host:/foo\" could be \"/user@host:\".
893 A file is considered \"remote\" if accessing it is likely to be slower or
894 less reliable than accessing local files.
895 Furthermore, relative file names do not work across remote connections.
897 IDENTIFICATION specifies which part of the identification shall
898 be returned as string. IDENTIFICATION can be the symbol
899 `method', `user', `host' or `localname'; any other value is
900 handled like nil and means to return the complete identification
903 If CONNECTED is non-nil, the function returns an identification only
904 if FILE is located on a remote system, and a connection is established
905 to that remote system.
907 `file-remote-p' will never open a connection on its own."
908 (let ((handler (find-file-name-handler file 'file-remote-p)))
910 (funcall handler 'file-remote-p file identification connected)
913 (defun file-local-copy (file)
914 "Copy the file FILE into a temporary file on this machine.
915 Returns the name of the local copy, or nil, if FILE is directly
917 ;; This formerly had an optional BUFFER argument that wasn't used by
919 (let ((handler (find-file-name-handler file 'file-local-copy)))
921 (funcall handler 'file-local-copy file)
924 (defun file-truename (filename &optional counter prev-dirs)
925 "Return the truename of FILENAME, which should be absolute.
926 The truename of a file name is found by chasing symbolic links
927 both at the level of the file and at the level of the directories
928 containing it, until no links are left at any level.
930 \(fn FILENAME)" ;; Don't document the optional arguments.
931 ;; COUNTER and PREV-DIRS are only used in recursive calls.
932 ;; COUNTER can be a cons cell whose car is the count of how many
933 ;; more links to chase before getting an error.
934 ;; PREV-DIRS can be a cons cell whose car is an alist
935 ;; of truenames we've just recently computed.
936 (cond ((or (string= filename "") (string= filename "~"))
937 (setq filename (expand-file-name filename))
938 (if (string= filename "")
939 (setq filename "/")))
940 ((and (string= (substring filename 0 1) "~")
941 (string-match "~[^/]*/?" filename))
943 (substring filename 0 (match-end 0)))
944 (rest (substring filename (match-end 0))))
945 (setq filename (concat (expand-file-name first-part) rest)))))
947 (or counter (setq counter (list 100)))
949 ;; For speed, remove the ange-ftp completion handler from the list.
950 ;; We know it's not needed here.
951 ;; For even more speed, do this only on the outermost call.
952 (file-name-handler-alist
953 (if prev-dirs file-name-handler-alist
954 (let ((tem (copy-sequence file-name-handler-alist)))
955 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
956 (or prev-dirs (setq prev-dirs (list nil)))
958 ;; andrewi@harlequin.co.uk - none of the following code (except for
959 ;; invoking the file-name handler) currently applies on Windows
960 ;; (ie. there are no native symlinks), but there is an issue with
961 ;; case differences being ignored by the OS, and short "8.3 DOS"
962 ;; name aliases existing for all files. (The short names are not
963 ;; reported by directory-files, but can be used to refer to files.)
964 ;; It seems appropriate for file-truename to resolve these issues in
965 ;; the most natural way, which on Windows is to call the function
966 ;; `w32-long-file-name' - this returns the exact name of a file as
967 ;; it is stored on disk (expanding short name aliases with the full
968 ;; name in the process).
969 (if (eq system-type 'windows-nt)
970 (let ((handler (find-file-name-handler filename 'file-truename)))
971 ;; For file name that has a special handler, call handler.
972 ;; This is so that ange-ftp can save time by doing a no-op.
974 (setq filename (funcall handler 'file-truename filename))
975 ;; If filename contains a wildcard, newname will be the old name.
976 (unless (string-match "[[*?]" filename)
977 ;; If filename exists, use the long name. If it doesn't exist,
978 ;; drill down until we find a directory that exists, and use
979 ;; the long name of that, with the extra non-existent path
980 ;; components concatenated.
981 (let ((longname (w32-long-file-name filename))
984 (setq filename longname)
985 ;; Include the preceding directory separator in the missing
986 ;; part so subsequent recursion on the rest works.
987 (setq missing (concat "/" (file-name-nondirectory filename)))
988 (let ((length (length missing)))
990 (if (> length (length filename))
992 (substring filename 0 (- length)))))
993 (setq filename (concat (file-truename rest) missing))))))
996 ;; If this file directly leads to a link, process that iteratively
997 ;; so that we don't use lots of stack.
999 (setcar counter (1- (car counter)))
1000 (if (< (car counter) 0)
1001 (error "Apparent cycle of symbolic links for %s" filename))
1002 (let ((handler (find-file-name-handler filename 'file-truename)))
1003 ;; For file name that has a special handler, call handler.
1004 ;; This is so that ange-ftp can save time by doing a no-op.
1006 (setq filename (funcall handler 'file-truename filename)
1008 (let ((dir (or (file-name-directory filename) default-directory))
1010 ;; Get the truename of the directory.
1011 (setq dirfile (directory-file-name dir))
1012 ;; If these are equal, we have the (or a) root directory.
1013 (or (string= dir dirfile)
1014 ;; If this is the same dir we last got the truename for,
1015 ;; save time--don't recalculate.
1016 (if (assoc dir (car prev-dirs))
1017 (setq dir (cdr (assoc dir (car prev-dirs))))
1019 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
1020 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
1022 (if (equal ".." (file-name-nondirectory filename))
1024 (directory-file-name (file-name-directory (directory-file-name dir)))
1026 (if (equal "." (file-name-nondirectory filename))
1027 (setq filename (directory-file-name dir)
1029 ;; Put it back on the file name.
1030 (setq filename (concat dir (file-name-nondirectory filename)))
1031 ;; Is the file name the name of a link?
1032 (setq target (file-symlink-p filename))
1034 ;; Yes => chase that link, then start all over
1035 ;; since the link may point to a directory name that uses links.
1036 ;; We can't safely use expand-file-name here
1037 ;; since target might look like foo/../bar where foo
1038 ;; is itself a link. Instead, we handle . and .. above.
1040 (if (file-name-absolute-p target)
1042 (concat dir target))
1045 (setq done t))))))))
1048 (defun file-chase-links (filename &optional limit)
1049 "Chase links in FILENAME until a name that is not a link.
1050 Unlike `file-truename', this does not check whether a parent
1051 directory name is a symbolic link.
1052 If the optional argument LIMIT is a number,
1053 it means chase no more than that many links and then stop."
1054 (let (tem (newname filename)
1056 (while (and (or (null limit) (< count limit))
1057 (setq tem (file-symlink-p newname)))
1059 (if (and (null limit) (= count 100))
1060 (error "Apparent cycle of symbolic links for %s" filename))
1061 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1062 (while (string-match "//+" tem)
1063 (setq tem (replace-match "/" nil nil tem)))
1064 ;; Handle `..' by hand, since it needs to work in the
1065 ;; target of any directory symlink.
1066 ;; This code is not quite complete; it does not handle
1067 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1068 (while (string-match "\\`\\.\\./" tem)
1069 (setq tem (substring tem 3))
1070 (setq newname (expand-file-name newname))
1071 ;; Chase links in the default dir of the symlink.
1074 (directory-file-name (file-name-directory newname))))
1075 ;; Now find the parent of that dir.
1076 (setq newname (file-name-directory newname)))
1077 (setq newname (expand-file-name tem (file-name-directory newname)))
1078 (setq count (1+ count))))
1081 (defun make-temp-file (prefix &optional dir-flag suffix)
1082 "Create a temporary file.
1083 The returned file name (created by appending some random characters at the end
1084 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1085 is guaranteed to point to a newly created empty file.
1086 You can then use `write-region' to write new data into the file.
1088 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1090 If SUFFIX is non-nil, add that at the end of the file name."
1091 (let ((umask (default-file-modes))
1095 ;; Create temp files with strict access rights. It's easy to
1096 ;; loosen them later, whereas it's impossible to close the
1097 ;; time-window of loose permissions otherwise.
1098 (set-default-file-modes ?\700)
1099 (while (condition-case ()
1103 (if (zerop (length prefix))
1104 (file-name-as-directory
1105 temporary-file-directory)
1106 (expand-file-name prefix
1107 temporary-file-directory))))
1109 (setq file (concat file suffix)))
1111 (make-directory file)
1112 (write-region "" nil file nil 'silent nil 'excl))
1114 (file-already-exists t))
1115 ;; the file was somehow created by someone else between
1116 ;; `make-temp-name' and `write-region', let's try again.
1120 (set-default-file-modes umask))))
1122 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1123 "Change the encoding of FILE's name from CODING to NEW-CODING.
1124 The value is a new name of FILE.
1125 Signals a `file-already-exists' error if a file of the new name
1126 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1127 is non-nil. A number as fourth arg means request confirmation if
1128 the new name already exists. This is what happens in interactive
1131 (let ((default-coding (or file-name-coding-system
1132 default-file-name-coding-system))
1133 (filename (read-file-name "Recode filename: " nil nil t))
1134 from-coding to-coding)
1135 (if (and default-coding
1136 ;; We provide the default coding only when it seems that
1137 ;; the filename is correctly decoded by the default
1139 (let ((charsets (find-charset-string filename)))
1140 (and (not (memq 'eight-bit-control charsets))
1141 (not (memq 'eight-bit-graphic charsets)))))
1142 (setq from-coding (read-coding-system
1143 (format "Recode filename %s from (default %s): "
1144 filename default-coding)
1146 (setq from-coding (read-coding-system
1147 (format "Recode filename %s from: " filename))))
1149 ;; We provide the default coding only when a user is going to
1150 ;; change the encoding not from the default coding.
1151 (if (eq from-coding default-coding)
1152 (setq to-coding (read-coding-system
1153 (format "Recode filename %s from %s to: "
1154 filename from-coding)))
1155 (setq to-coding (read-coding-system
1156 (format "Recode filename %s from %s to (default %s): "
1157 filename from-coding default-coding)
1159 (list filename from-coding to-coding)))
1161 (let* ((default-coding (or file-name-coding-system
1162 default-file-name-coding-system))
1163 ;; FILE should have been decoded by DEFAULT-CODING.
1164 (encoded (encode-coding-string file default-coding))
1165 (newname (decode-coding-string encoded coding))
1166 (new-encoded (encode-coding-string newname new-coding))
1167 ;; Suppress further encoding.
1168 (file-name-coding-system nil)
1169 (default-file-name-coding-system nil)
1170 (locale-coding-system nil))
1171 (rename-file encoded new-encoded ok-if-already-exists)
1174 (defcustom confirm-nonexistent-file-or-buffer 'after-completion
1175 "Whether confirmation is requested before visiting a new file or buffer.
1176 If nil, confirmation is not requested.
1177 If the value is `after-completion', confirmation is only
1178 requested if the user called `minibuffer-complete' right before
1179 `minibuffer-complete-and-exit'.
1180 Any other non-nil value means to request confirmation.
1182 This affects commands like `switch-to-buffer' and `find-file'."
1185 :type '(choice (const :tag "After completion" after-completion)
1186 (const :tag "Never" nil)
1187 (other :tag "Always" t)))
1189 (defun confirm-nonexistent-file-or-buffer ()
1190 "Whether to request confirmation before visiting a new file or buffer.
1191 The variable `confirm-nonexistent-file-or-buffer' determines the
1192 return value, which may be passed as the REQUIRE-MATCH arg to
1193 `read-buffer' or `find-file-read-args'."
1194 (cond ((eq confirm-nonexistent-file-or-buffer 'after-completion)
1195 'confirm-after-completion)
1196 (confirm-nonexistent-file-or-buffer
1200 (defun read-buffer-to-switch (prompt)
1201 "Read the name of a buffer to switch to and return as a string.
1202 It is intended for `switch-to-buffer' family of commands since they
1203 need to omit the name of current buffer from the list of completions
1204 and default values."
1205 (let ((rbts-completion-table (internal-complete-buffer-except)))
1206 (minibuffer-with-setup-hook
1208 (setq minibuffer-completion-table rbts-completion-table)
1209 ;; Since rbts-completion-table is built dynamically, we
1210 ;; can't just add it to the default value of
1211 ;; icomplete-with-completion-tables, so we add it
1213 (if (and (boundp 'icomplete-with-completion-tables)
1214 (listp icomplete-with-completion-tables))
1215 (set (make-local-variable 'icomplete-with-completion-tables)
1216 (cons rbts-completion-table
1217 icomplete-with-completion-tables))))
1218 (read-buffer prompt (other-buffer (current-buffer))
1219 (confirm-nonexistent-file-or-buffer)))))
1221 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord)
1222 "Select the buffer specified by BUFFER-OR-NAME in another window.
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 argument 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 window: ")))
1242 (let ((pop-up-windows t)
1243 same-window-buffer-names same-window-regexps)
1244 (pop-to-buffer buffer-or-name t norecord)))
1246 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord)
1247 "Switch to buffer BUFFER-OR-NAME in another frame.
1248 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1249 nil. Return the buffer switched to.
1251 If called interactively, prompt for the buffer name using the
1252 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1253 determines whether to request confirmation before creating a new
1256 If BUFFER-OR-NAME is a string and does not identify an existing
1257 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1258 nil, switch to the buffer returned by `other-buffer'.
1260 Optional second arg NORECORD non-nil means do not put this
1261 buffer at the front of the list of recently selected ones.
1263 This uses the function `display-buffer' as a subroutine; see its
1264 documentation for additional customization information."
1266 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1267 (let ((pop-up-frames t)
1268 same-window-buffer-names same-window-regexps)
1269 (pop-to-buffer buffer-or-name t norecord)))
1271 (defun display-buffer-other-frame (buffer)
1272 "Display buffer BUFFER in another frame.
1273 This uses the function `display-buffer' as a subroutine; see
1274 its documentation for additional customization information."
1275 (interactive "BDisplay buffer in other frame: ")
1276 (let ((pop-up-frames t)
1277 same-window-buffer-names same-window-regexps
1278 (old-window (selected-window))
1280 (setq new-window (display-buffer buffer t))
1281 ;; This may have been here in order to prevent the new frame from hiding
1282 ;; the old frame. But it does more harm than good.
1283 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1284 ;;(lower-frame (window-frame new-window))
1286 ;; This may have been here in order to make sure the old-frame gets the
1287 ;; focus. But not only can it cause an annoying flicker, with some
1288 ;; window-managers it just makes the window invisible, with no easy
1289 ;; way to recover it. --Stef
1290 ;;(make-frame-invisible (window-frame old-window))
1291 ;;(make-frame-visible (window-frame old-window))
1294 (defmacro minibuffer-with-setup-hook (fun &rest body)
1295 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1296 BODY should use the minibuffer at most once.
1297 Recursive uses of the minibuffer are unaffected (FUN is not
1298 called additional times).
1300 This macro actually adds an auxiliary function that calls FUN,
1301 rather than FUN itself, to `minibuffer-setup-hook'."
1302 (declare (indent 1) (debug t))
1303 (let ((hook (make-symbol "setup-hook")))
1307 ;; Clear out this hook so it does not interfere
1308 ;; with any recursive minibuffer usage.
1309 (remove-hook 'minibuffer-setup-hook ,hook)
1313 (add-hook 'minibuffer-setup-hook ,hook)
1315 (remove-hook 'minibuffer-setup-hook ,hook)))))
1317 (defun find-file-read-args (prompt mustmatch)
1318 (list (read-file-name prompt nil default-directory mustmatch)
1321 (defun find-file (filename &optional wildcards)
1322 "Edit file FILENAME.
1323 Switch to a buffer visiting file FILENAME,
1324 creating one if none already exists.
1325 Interactively, the default if you just type RET is the current directory,
1326 but the visited file name is available through the minibuffer history:
1327 type M-n to pull it into the minibuffer.
1329 You can visit files on remote machines by specifying something
1330 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1331 also visit local files as a different user by specifying
1332 /sudo::FILE for the file name.
1333 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1334 manual, for more about this.
1336 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1337 expand wildcards (if any) and visit multiple files. You can
1338 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1340 To visit a file without any kind of conversion and without
1341 automatically choosing a major mode, use \\[find-file-literally]."
1343 (find-file-read-args "Find file: "
1344 (confirm-nonexistent-file-or-buffer)))
1345 (let ((value (find-file-noselect filename nil nil wildcards)))
1347 (mapcar 'switch-to-buffer (nreverse value))
1348 (switch-to-buffer value))))
1350 (defun find-file-other-window (filename &optional wildcards)
1351 "Edit file FILENAME, in another window.
1353 Like \\[find-file] (which see), but creates a new window or reuses
1354 an existing one. See the function `display-buffer'.
1356 Interactively, the default if you just type RET is the current directory,
1357 but the visited file name is available through the minibuffer history:
1358 type M-n to pull it into the minibuffer.
1360 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1361 expand wildcards (if any) and visit multiple files."
1363 (find-file-read-args "Find file in other window: "
1364 (confirm-nonexistent-file-or-buffer)))
1365 (let ((value (find-file-noselect filename nil nil wildcards)))
1368 (setq value (nreverse value))
1369 (cons (switch-to-buffer-other-window (car value))
1370 (mapcar 'switch-to-buffer (cdr value))))
1371 (switch-to-buffer-other-window value))))
1373 (defun find-file-other-frame (filename &optional wildcards)
1374 "Edit file FILENAME, in another frame.
1376 Like \\[find-file] (which see), but creates a new frame or reuses
1377 an existing one. See the function `display-buffer'.
1379 Interactively, the default if you just type RET is the current directory,
1380 but the visited file name is available through the minibuffer history:
1381 type M-n to pull it into the minibuffer.
1383 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1384 expand wildcards (if any) and visit multiple files."
1386 (find-file-read-args "Find file in other frame: "
1387 (confirm-nonexistent-file-or-buffer)))
1388 (let ((value (find-file-noselect filename nil nil wildcards)))
1391 (setq value (nreverse value))
1392 (cons (switch-to-buffer-other-frame (car value))
1393 (mapcar 'switch-to-buffer (cdr value))))
1394 (switch-to-buffer-other-frame value))))
1396 (defun find-file-existing (filename)
1397 "Edit the existing file FILENAME.
1398 Like \\[find-file], but only allow a file that exists, and do not allow
1399 file names with wildcards."
1400 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1401 (if (and (not (called-interactively-p 'interactive))
1402 (not (file-exists-p filename)))
1403 (error "%s does not exist" filename)
1404 (find-file filename)
1407 (defun find-file-read-only (filename &optional wildcards)
1408 "Edit file FILENAME but don't allow changes.
1409 Like \\[find-file], but marks buffer as read-only.
1410 Use \\[toggle-read-only] to permit editing."
1412 (find-file-read-args "Find file read-only: "
1413 (confirm-nonexistent-file-or-buffer)))
1414 (unless (or (and wildcards find-file-wildcards
1415 (not (string-match "\\`/:" filename))
1416 (string-match "[[*?]" filename))
1417 (file-exists-p filename))
1418 (error "%s does not exist" filename))
1419 (let ((value (find-file filename wildcards)))
1420 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1421 (if (listp value) value (list value)))
1424 (defun find-file-read-only-other-window (filename &optional wildcards)
1425 "Edit file FILENAME in another window but don't allow changes.
1426 Like \\[find-file-other-window], but marks buffer as read-only.
1427 Use \\[toggle-read-only] to permit editing."
1429 (find-file-read-args "Find file read-only other window: "
1430 (confirm-nonexistent-file-or-buffer)))
1431 (unless (or (and wildcards find-file-wildcards
1432 (not (string-match "\\`/:" filename))
1433 (string-match "[[*?]" filename))
1434 (file-exists-p filename))
1435 (error "%s does not exist" filename))
1436 (let ((value (find-file-other-window filename wildcards)))
1437 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1438 (if (listp value) value (list value)))
1441 (defun find-file-read-only-other-frame (filename &optional wildcards)
1442 "Edit file FILENAME in another frame but don't allow changes.
1443 Like \\[find-file-other-frame], but marks buffer as read-only.
1444 Use \\[toggle-read-only] to permit editing."
1446 (find-file-read-args "Find file read-only other frame: "
1447 (confirm-nonexistent-file-or-buffer)))
1448 (unless (or (and wildcards find-file-wildcards
1449 (not (string-match "\\`/:" filename))
1450 (string-match "[[*?]" filename))
1451 (file-exists-p filename))
1452 (error "%s does not exist" filename))
1453 (let ((value (find-file-other-frame filename wildcards)))
1454 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1455 (if (listp value) value (list value)))
1458 (defun find-alternate-file-other-window (filename &optional wildcards)
1459 "Find file FILENAME as a replacement for the file in the next window.
1460 This command does not select that window.
1462 See \\[find-file] for the possible forms of the FILENAME argument.
1464 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1465 expand wildcards (if any) and replace the file with multiple files."
1467 (save-selected-window
1469 (let ((file buffer-file-name)
1473 (setq file-name (file-name-nondirectory file)
1474 file-dir (file-name-directory file)))
1475 (list (read-file-name
1476 "Find alternate file: " file-dir nil
1477 (confirm-nonexistent-file-or-buffer) file-name)
1480 (find-file-other-window filename wildcards)
1481 (save-selected-window
1483 (find-alternate-file filename wildcards))))
1485 (defun find-alternate-file (filename &optional wildcards)
1486 "Find file FILENAME, select its buffer, kill previous buffer.
1487 If the current buffer now contains an empty file that you just visited
1488 \(presumably by mistake), use this command to visit the file you really want.
1490 See \\[find-file] for the possible forms of the FILENAME argument.
1492 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1493 expand wildcards (if any) and replace the file with multiple files.
1495 If the current buffer is an indirect buffer, or the base buffer
1496 for one or more indirect buffers, the other buffer(s) are not
1499 (let ((file buffer-file-name)
1503 (setq file-name (file-name-nondirectory file)
1504 file-dir (file-name-directory file)))
1505 (list (read-file-name
1506 "Find alternate file: " file-dir nil
1507 (confirm-nonexistent-file-or-buffer) file-name)
1509 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1511 (when (and (buffer-modified-p) buffer-file-name)
1512 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1515 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1516 (error "Aborted"))))
1517 (let ((obuf (current-buffer))
1518 (ofile buffer-file-name)
1519 (onum buffer-file-number)
1520 (odir dired-directory)
1521 (otrue buffer-file-truename)
1522 (oname (buffer-name)))
1523 ;; Run `kill-buffer-hook' here. It needs to happen before
1524 ;; variables like `buffer-file-name' etc are set to nil below,
1525 ;; because some of the hooks that could be invoked
1526 ;; (e.g., `save-place-to-alist') depend on those variables.
1528 ;; Note that `kill-buffer-hook' is not what queries whether to
1529 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1530 ;; asks that itself. Thus, there's no need to temporarily do
1531 ;; `(set-buffer-modified-p nil)' before running this hook.
1532 (run-hooks 'kill-buffer-hook)
1533 ;; Okay, now we can end-of-life the old buffer.
1534 (if (get-buffer " **lose**")
1535 (kill-buffer " **lose**"))
1536 (rename-buffer " **lose**")
1540 ;; This prevents us from finding the same buffer
1541 ;; if we specified the same file again.
1542 (setq buffer-file-name nil)
1543 (setq buffer-file-number nil)
1544 (setq buffer-file-truename nil)
1545 ;; Likewise for dired buffers.
1546 (setq dired-directory nil)
1547 (find-file filename wildcards))
1548 (when (eq obuf (current-buffer))
1549 ;; This executes if find-file gets an error
1550 ;; and does not really find anything.
1551 ;; We put things back as they were.
1552 ;; If find-file actually finds something, we kill obuf below.
1553 (setq buffer-file-name ofile)
1554 (setq buffer-file-number onum)
1555 (setq buffer-file-truename otrue)
1556 (setq dired-directory odir)
1558 (rename-buffer oname)))
1559 (unless (eq (current-buffer) obuf)
1560 (with-current-buffer obuf
1561 ;; We already ran these; don't run them again.
1562 (let (kill-buffer-query-functions kill-buffer-hook)
1563 (kill-buffer obuf))))))
1565 (defun create-file-buffer (filename)
1566 "Create a suitably named buffer for visiting FILENAME, and return it.
1567 FILENAME (sans directory) is used unchanged if that name is free;
1568 otherwise a string <2> or <3> or ... is appended to get an unused name.
1569 Spaces at the start of FILENAME (sans directory) are removed."
1570 (let ((lastname (file-name-nondirectory filename)))
1571 (if (string= lastname "")
1572 (setq lastname filename))
1574 (string-match "^ *\\(.*\\)" lastname)
1575 (generate-new-buffer (match-string 1 lastname)))))
1577 (defun generate-new-buffer (name)
1578 "Create and return a buffer with a name based on NAME.
1579 Choose the buffer's name using `generate-new-buffer-name'."
1580 (get-buffer-create (generate-new-buffer-name name)))
1582 (defcustom automount-dir-prefix (purecopy "^/tmp_mnt/")
1583 "Regexp to match the automounter prefix in a directory name."
1587 (defvar abbreviated-home-dir nil
1588 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1590 (defun abbreviate-file-name (filename)
1591 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1592 This also substitutes \"~\" for the user's home directory (unless the
1593 home directory is a root directory) and removes automounter prefixes
1594 \(see the variable `automount-dir-prefix')."
1595 ;; Get rid of the prefixes added by the automounter.
1597 (if (and automount-dir-prefix
1598 (string-match automount-dir-prefix filename)
1599 (file-exists-p (file-name-directory
1600 (substring filename (1- (match-end 0))))))
1601 (setq filename (substring filename (1- (match-end 0)))))
1602 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1603 ;; To fix this right, we need a `file-name-case-sensitive-p'
1604 ;; function, but we don't have that yet, so just guess.
1605 (let ((case-fold-search
1606 (memq system-type '(ms-dos windows-nt darwin cygwin))))
1607 ;; If any elt of directory-abbrev-alist matches this name,
1608 ;; abbreviate accordingly.
1609 (dolist (dir-abbrev directory-abbrev-alist)
1610 (if (string-match (car dir-abbrev) filename)
1612 (concat (cdr dir-abbrev)
1613 (substring filename (match-end 0))))))
1614 ;; Compute and save the abbreviated homedir name.
1615 ;; We defer computing this until the first time it's needed, to
1616 ;; give time for directory-abbrev-alist to be set properly.
1617 ;; We include a slash at the end, to avoid spurious matches
1618 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1619 (or abbreviated-home-dir
1620 (setq abbreviated-home-dir
1621 (let ((abbreviated-home-dir "$foo"))
1622 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1625 ;; If FILENAME starts with the abbreviated homedir,
1626 ;; make it start with `~' instead.
1627 (if (and (string-match abbreviated-home-dir filename)
1628 ;; If the home dir is just /, don't change it.
1629 (not (and (= (match-end 0) 1)
1630 (= (aref filename 0) ?/)))
1631 ;; MS-DOS root directories can come with a drive letter;
1632 ;; Novell Netware allows drive letters beyond `Z:'.
1633 (not (and (memq system-type '(ms-dos windows-nt cygwin))
1635 (string-match "^[a-zA-`]:/$" filename)))))
1638 (match-string 1 filename)
1639 (substring filename (match-end 0)))))
1642 (defcustom find-file-not-true-dirname-list nil
1643 "List of logical names for which visiting shouldn't save the true dirname."
1644 :type '(repeat (string :tag "Name"))
1647 (defun find-buffer-visiting (filename &optional predicate)
1648 "Return the buffer visiting file FILENAME (a string).
1649 This is like `get-file-buffer', except that it checks for any buffer
1650 visiting the same file, possibly under a different name.
1651 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1652 and others are ignored.
1653 If there is no such live buffer, return nil."
1654 (let ((predicate (or predicate #'identity))
1655 (truename (abbreviate-file-name (file-truename filename))))
1656 (or (let ((buf (get-file-buffer filename)))
1657 (when (and buf (funcall predicate buf)) buf))
1658 (let ((list (buffer-list)) found)
1659 (while (and (not found) list)
1660 (with-current-buffer (car list)
1661 (if (and buffer-file-name
1662 (string= buffer-file-truename truename)
1663 (funcall predicate (current-buffer)))
1664 (setq found (car list))))
1665 (setq list (cdr list)))
1667 (let* ((attributes (file-attributes truename))
1668 (number (nthcdr 10 attributes))
1669 (list (buffer-list)) found)
1670 (and buffer-file-numbers-unique
1671 (car-safe number) ;Make sure the inode is not just nil.
1672 (while (and (not found) list)
1673 (with-current-buffer (car list)
1674 (if (and buffer-file-name
1675 (equal buffer-file-number number)
1676 ;; Verify this buffer's file number
1677 ;; still belongs to its file.
1678 (file-exists-p buffer-file-name)
1679 (equal (file-attributes buffer-file-truename)
1681 (funcall predicate (current-buffer)))
1682 (setq found (car list))))
1683 (setq list (cdr list))))
1686 (defcustom find-file-wildcards t
1687 "Non-nil means file-visiting commands should handle wildcards.
1688 For example, if you specify `*.c', that would visit all the files
1689 whose names match the pattern."
1694 (defcustom find-file-suppress-same-file-warnings nil
1695 "Non-nil means suppress warning messages for symlinked files.
1696 When nil, Emacs prints a warning when visiting a file that is already
1697 visited, but with a different name. Setting this option to t
1698 suppresses this warning."
1703 (defcustom large-file-warning-threshold 10000000
1704 "Maximum size of file above which a confirmation is requested.
1705 When nil, never request confirmation."
1709 :type '(choice integer (const :tag "Never request confirmation" nil)))
1711 (defun abort-if-file-too-large (size op-type filename)
1712 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1713 OP-TYPE specifies the file operation being performed (for message to user)."
1714 (when (and large-file-warning-threshold size
1715 (> size large-file-warning-threshold)
1717 (format "File %s is large (%dMB), really %s? "
1718 (file-name-nondirectory filename)
1719 (/ size 1048576) op-type))))
1722 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1723 "Read file FILENAME into a buffer and return the buffer.
1724 If a buffer exists visiting FILENAME, return that one, but
1725 verify that the file has not changed since visited or saved.
1726 The buffer is not selected, just returned to the caller.
1727 Optional second arg NOWARN non-nil means suppress any warning messages.
1728 Optional third arg RAWFILE non-nil means the file is read literally.
1729 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1730 and visit all the matching files. When wildcards are actually
1731 used and expanded, return a list of buffers that are visiting
1734 (abbreviate-file-name
1735 (expand-file-name filename)))
1736 (if (file-directory-p filename)
1737 (or (and find-file-run-dired
1738 (run-hook-with-args-until-success
1739 'find-directory-functions
1740 (if find-file-visit-truename
1741 (abbreviate-file-name (file-truename filename))
1743 (error "%s is a directory" filename))
1746 (not (string-match "\\`/:" filename))
1747 (string-match "[[*?]" filename))
1748 (let ((files (condition-case nil
1749 (file-expand-wildcards filename t)
1750 (error (list filename))))
1751 (find-file-wildcards nil))
1753 (find-file-noselect filename)
1754 (mapcar #'find-file-noselect files)))
1755 (let* ((buf (get-file-buffer filename))
1756 (truename (abbreviate-file-name (file-truename filename)))
1757 (attributes (file-attributes truename))
1758 (number (nthcdr 10 attributes))
1759 ;; Find any buffer for a file which has same truename.
1760 (other (and (not buf) (find-buffer-visiting filename))))
1761 ;; Let user know if there is a buffer with the same truename.
1765 find-file-suppress-same-file-warnings
1766 (string-equal filename (buffer-file-name other))
1767 (message "%s and %s are the same file"
1768 filename (buffer-file-name other)))
1769 ;; Optionally also find that buffer.
1770 (if (or find-file-existing-other-name find-file-visit-truename)
1772 ;; Check to see if the file looks uncommonly large.
1773 (when (not (or buf nowarn))
1774 (abort-if-file-too-large (nth 7 attributes) "open" filename))
1776 ;; We are using an existing buffer.
1779 (verify-visited-file-modtime buf)
1780 (cond ((not (file-exists-p filename))
1781 (setq nonexistent t)
1782 (message "File %s no longer exists!" filename))
1783 ;; Certain files should be reverted automatically
1784 ;; if they have changed on disk and not in the buffer.
1785 ((and (not (buffer-modified-p buf))
1786 (let ((tail revert-without-query)
1789 (if (string-match (car tail) filename)
1791 (setq tail (cdr tail)))
1793 (with-current-buffer buf
1794 (message "Reverting file %s..." filename)
1796 (message "Reverting file %s...done" filename)))
1798 (if (string= (file-name-nondirectory filename)
1801 (if (buffer-modified-p buf)
1802 "File %s changed on disk. Discard your edits? "
1803 "File %s changed on disk. Reread from disk? ")
1804 (file-name-nondirectory filename))
1806 (if (buffer-modified-p buf)
1807 "File %s changed on disk. Discard your edits in %s? "
1808 "File %s changed on disk. Reread from disk into %s? ")
1809 (file-name-nondirectory filename)
1810 (buffer-name buf))))
1811 (with-current-buffer buf
1812 (revert-buffer t t)))))
1813 (with-current-buffer buf
1815 ;; Check if a formerly read-only file has become
1816 ;; writable and vice versa, but if the buffer agrees
1817 ;; with the new state of the file, that is ok too.
1818 (let ((read-only (not (file-writable-p buffer-file-name))))
1819 (unless (or nonexistent
1820 (eq read-only buffer-file-read-only)
1821 (eq read-only buffer-read-only))
1824 (format "File %s is %s on disk. Change buffer mode? "
1826 (if read-only "read-only" "writable"))))
1827 (y-or-n-p question)))
1828 (setq buffer-read-only read-only)))
1829 (setq buffer-file-read-only read-only))
1831 (when (and (not (eq (not (null rawfile))
1832 (not (null find-file-literally))))
1834 ;; It is confusing to ask whether to visit
1835 ;; non-literally if they have the file in
1837 (not (eq major-mode 'hexl-mode)))
1838 (if (buffer-modified-p)
1842 "The file %s is already visited normally,
1843 and you have edited the buffer. Now you have asked to visit it literally,
1844 meaning no coding system handling, format conversion, or local variables.
1845 Emacs can only visit a file in one way at a time.
1847 Do you want to save the file, and visit it literally instead? "
1848 "The file %s is already visited literally,
1849 meaning no coding system handling, format conversion, or local variables.
1850 You have edited the buffer. Now you have asked to visit the file normally,
1851 but Emacs can only visit a file in one way at a time.
1853 Do you want to save the file, and visit it normally instead? ")
1854 (file-name-nondirectory filename)))
1857 (find-file-noselect-1 buf filename nowarn
1858 rawfile truename number))
1863 Do you want to discard your changes, and visit the file literally now? "
1865 Do you want to discard your changes, and visit the file normally now? ")))
1866 (find-file-noselect-1 buf filename nowarn
1867 rawfile truename number)
1868 (error (if rawfile "File already visited non-literally"
1869 "File already visited literally"))))
1873 "The file %s is already visited normally.
1874 You have asked to visit it literally,
1875 meaning no coding system decoding, format conversion, or local variables.
1876 But Emacs can only visit a file in one way at a time.
1878 Do you want to revisit the file literally now? "
1879 "The file %s is already visited literally,
1880 meaning no coding system decoding, format conversion, or local variables.
1881 You have asked to visit it normally,
1882 but Emacs can only visit a file in one way at a time.
1884 Do you want to revisit the file normally now? ")
1885 (file-name-nondirectory filename)))
1886 (find-file-noselect-1 buf filename nowarn
1887 rawfile truename number)
1888 (error (if rawfile "File already visited non-literally"
1889 "File already visited literally"))))))
1890 ;; Return the buffer we are using.
1892 ;; Create a new buffer.
1893 (setq buf (create-file-buffer filename))
1894 ;; find-file-noselect-1 may use a different buffer.
1895 (find-file-noselect-1 buf filename nowarn
1896 rawfile truename number))))))
1898 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1900 (with-current-buffer buf
1901 (kill-local-variable 'find-file-literally)
1902 ;; Needed in case we are re-visiting the file with a different
1903 ;; text representation.
1904 (kill-local-variable 'buffer-file-coding-system)
1905 (kill-local-variable 'cursor-type)
1906 (let ((inhibit-read-only t))
1908 (and (default-value 'enable-multibyte-characters)
1910 (set-buffer-multibyte t))
1913 (let ((inhibit-read-only t))
1914 (insert-file-contents-literally filename t))
1916 (when (and (file-exists-p filename)
1917 (not (file-readable-p filename)))
1919 (signal 'file-error (list "File is not readable"
1921 ;; Unconditionally set error
1924 (let ((inhibit-read-only t))
1925 (insert-file-contents filename t))
1927 (when (and (file-exists-p filename)
1928 (not (file-readable-p filename)))
1930 (signal 'file-error (list "File is not readable"
1932 ;; Run find-file-not-found-functions until one returns non-nil.
1933 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1934 ;; If they fail too, set error.
1936 ;; Record the file's truename, and maybe use that as visited name.
1937 (if (equal filename buffer-file-name)
1938 (setq buffer-file-truename truename)
1939 (setq buffer-file-truename
1940 (abbreviate-file-name (file-truename buffer-file-name))))
1941 (setq buffer-file-number number)
1942 (if find-file-visit-truename
1943 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1944 ;; Set buffer's default directory to that of the file.
1945 (setq default-directory (file-name-directory buffer-file-name))
1946 ;; Turn off backup files for certain file names. Since
1947 ;; this is a permanent local, the major mode won't eliminate it.
1948 (and backup-enable-predicate
1949 (not (funcall backup-enable-predicate buffer-file-name))
1951 (make-local-variable 'backup-inhibited)
1952 (setq backup-inhibited t)))
1955 (set-buffer-multibyte nil)
1956 (setq buffer-file-coding-system 'no-conversion)
1957 (set-buffer-major-mode buf)
1958 (make-local-variable 'find-file-literally)
1959 (setq find-file-literally t))
1960 (after-find-file error (not nowarn)))
1963 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1964 "Like `insert-file-contents', but only reads in the file literally.
1965 A buffer may be modified in several ways after reading into the buffer,
1966 to Emacs features such as format decoding, character code
1967 conversion, `find-file-hook', automatic uncompression, etc.
1969 This function ensures that none of these modifications will take place."
1970 (let ((format-alist nil)
1971 (after-insert-file-functions nil)
1972 (coding-system-for-read 'no-conversion)
1973 (coding-system-for-write 'no-conversion)
1974 (find-buffer-file-type-function
1975 (if (fboundp 'find-buffer-file-type)
1976 (symbol-function 'find-buffer-file-type)
1978 (inhibit-file-name-handlers
1979 (append '(jka-compr-handler image-file-handler epa-file-handler)
1980 inhibit-file-name-handlers))
1981 (inhibit-file-name-operation 'insert-file-contents))
1984 (fset 'find-buffer-file-type (lambda (filename) t))
1985 (insert-file-contents filename visit beg end replace))
1986 (if find-buffer-file-type-function
1987 (fset 'find-buffer-file-type find-buffer-file-type-function)
1988 (fmakunbound 'find-buffer-file-type)))))
1990 (defun insert-file-1 (filename insert-func)
1991 (if (file-directory-p filename)
1992 (signal 'file-error (list "Opening input file" "file is a directory"
1994 ;; Check whether the file is uncommonly large
1995 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert" filename)
1996 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1997 #'buffer-modified-p))
1998 (tem (funcall insert-func filename)))
1999 (push-mark (+ (point) (car (cdr tem))))
2001 (message "File %s already visited and modified in buffer %s"
2002 filename (buffer-name buffer)))))
2004 (defun insert-file-literally (filename)
2005 "Insert contents of file FILENAME into buffer after point with no conversion.
2007 This function is meant for the user to run interactively.
2008 Don't call it from programs! Use `insert-file-contents-literally' instead.
2009 \(Its calling sequence is different; see its documentation)."
2010 (interactive "*fInsert file literally: ")
2011 (insert-file-1 filename #'insert-file-contents-literally))
2013 (defvar find-file-literally nil
2014 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2015 This is a permanent local.")
2016 (put 'find-file-literally 'permanent-local t)
2018 (defun find-file-literally (filename)
2019 "Visit file FILENAME with no conversion of any kind.
2020 Format conversion and character code conversion are both disabled,
2021 and multibyte characters are disabled in the resulting buffer.
2022 The major mode used is Fundamental mode regardless of the file name,
2023 and local variable specifications in the file are ignored.
2024 Automatic uncompression and adding a newline at the end of the
2025 file due to `require-final-newline' is also disabled.
2027 You cannot absolutely rely on this function to result in
2028 visiting the file literally. If Emacs already has a buffer
2029 which is visiting the file, you get the existing buffer,
2030 regardless of whether it was created literally or not.
2032 In a Lisp program, if you want to be sure of accessing a file's
2033 contents literally, you should create a temporary buffer and then read
2034 the file contents into it using `insert-file-contents-literally'."
2036 (list (read-file-name
2037 "Find file literally: " nil default-directory
2038 (confirm-nonexistent-file-or-buffer))))
2039 (switch-to-buffer (find-file-noselect filename nil t)))
2041 (defvar after-find-file-from-revert-buffer nil)
2043 (defun after-find-file (&optional error warn noauto
2044 after-find-file-from-revert-buffer
2046 "Called after finding a file and by the default revert function.
2047 Sets buffer mode, parses local variables.
2048 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2049 error in reading the file. WARN non-nil means warn if there
2050 exists an auto-save file more recent than the visited file.
2051 NOAUTO means don't mess with auto-save mode.
2052 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2053 means this call was from `revert-buffer'.
2054 Fifth arg NOMODES non-nil means don't alter the file's modes.
2055 Finishes by calling the functions in `find-file-hook'
2056 unless NOMODES is non-nil."
2057 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
2064 ((and error (file-attributes buffer-file-name))
2065 (setq buffer-read-only t)
2066 "File exists, but cannot be read")
2067 ((not buffer-read-only)
2069 ;; No need to warn if buffer is auto-saved
2070 ;; under the name of the visited file.
2071 (not (and buffer-file-name
2072 auto-save-visited-file-name))
2073 (file-newer-than-file-p (or buffer-auto-save-file-name
2074 (make-auto-save-file-name))
2076 (format "%s has auto save data; consider M-x recover-this-file"
2077 (file-name-nondirectory buffer-file-name))
2078 (setq not-serious t)
2079 (if error "(New file)" nil)))
2081 (setq not-serious t)
2082 "Note: file is write protected")
2083 ((file-attributes (directory-file-name default-directory))
2084 "File not found and directory write-protected")
2085 ((file-exists-p (file-name-directory buffer-file-name))
2086 (setq buffer-read-only nil))
2088 (setq buffer-read-only nil)
2089 "Use M-x make-directory RET RET to create the directory and its parents"))))
2092 (or not-serious (sit-for 1 t))))
2093 (when (and auto-save-default (not noauto))
2094 (auto-save-mode t)))
2095 ;; Make people do a little extra work (C-x C-q)
2096 ;; before altering a backup file.
2097 (when (backup-file-name-p buffer-file-name)
2098 (setq buffer-read-only t))
2099 ;; When a file is marked read-only,
2100 ;; make the buffer read-only even if root is looking at it.
2101 (when (and (file-modes (buffer-file-name))
2102 (zerop (logand (file-modes (buffer-file-name)) #o222)))
2103 (setq buffer-read-only t))
2105 (when (and view-read-only view-mode)
2106 (view-mode-disable))
2108 ;; If requested, add a newline at the end of the file.
2109 (and (memq require-final-newline '(visit visit-save))
2110 (> (point-max) (point-min))
2111 (/= (char-after (1- (point-max))) ?\n)
2112 (not (and (eq selective-display t)
2113 (= (char-after (1- (point-max))) ?\r)))
2115 (goto-char (point-max))
2117 (when (and buffer-read-only
2119 (not (eq (get major-mode 'mode-class) 'special)))
2121 (run-hooks 'find-file-hook)))
2123 (defmacro report-errors (format &rest body)
2124 "Eval BODY and turn any error into a FORMAT message.
2125 FORMAT can have a %s escape which will be replaced with the actual error.
2126 If `debug-on-error' is set, errors are not caught, so that you can
2128 Avoid using a large BODY since it is duplicated."
2129 (declare (debug t) (indent 1))
2134 (error (message ,format (prin1-to-string err))))))
2136 (defun normal-mode (&optional find-file)
2137 "Choose the major mode for this buffer automatically.
2138 Also sets up any specified local variables of the file.
2139 Uses the visited file name, the -*- line, and the local variables spec.
2141 This function is called automatically from `find-file'. In that case,
2142 we may set up the file-specified mode and local variables,
2143 depending on the value of `enable-local-variables'.
2144 In addition, if `local-enable-local-variables' is nil, we do
2145 not set local variables (though we do notice a mode specified with -*-.)
2147 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2148 or from Lisp without specifying the optional argument FIND-FILE;
2149 in that case, this function acts as if `enable-local-variables' were t."
2151 (funcall (or (default-value 'major-mode) 'fundamental-mode))
2152 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
2153 (report-errors "File mode specification error: %s"
2155 (report-errors "File local-variables error: %s"
2156 (hack-local-variables)))
2157 ;; Turn font lock off and on, to make sure it takes account of
2158 ;; whatever file local variables are relevant to it.
2159 (when (and font-lock-mode
2160 ;; Font-lock-mode (now in font-core.el) can be ON when
2161 ;; font-lock.el still hasn't been loaded.
2162 (boundp 'font-lock-keywords)
2163 (eq (car font-lock-keywords) t))
2164 (setq font-lock-keywords (cadr font-lock-keywords))
2167 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2168 (ucs-set-table-for-input)))
2170 (defcustom auto-mode-case-fold t
2171 "Non-nil means to try second pass through `auto-mode-alist'.
2172 This means that if the first case-sensitive search through the alist fails
2173 to find a matching major mode, a second case-insensitive search is made.
2174 On systems with case-insensitive file names, this variable is ignored,
2175 since only a single case-insensitive search through the alist is made."
2180 (defvar auto-mode-alist
2181 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2182 ;; c++-mode, java-mode and more) are added through autoload
2183 ;; directives in that file. That way is discouraged since it
2184 ;; spreads out the definition of the initial value.
2187 (cons (purecopy (car elt)) (cdr elt)))
2188 `(;; do this first, so that .html.pl is Polish html, not Perl
2189 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2190 ("\\.te?xt\\'" . text-mode)
2191 ("\\.[tT]e[xX]\\'" . tex-mode)
2192 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2193 ("\\.ltx\\'" . latex-mode)
2194 ("\\.dtx\\'" . doctex-mode)
2195 ("\\.org\\'" . org-mode)
2196 ("\\.el\\'" . emacs-lisp-mode)
2197 ("Project\\.ede\\'" . emacs-lisp-mode)
2198 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2199 ("\\.l\\'" . lisp-mode)
2200 ("\\.li?sp\\'" . lisp-mode)
2201 ("\\.[fF]\\'" . fortran-mode)
2202 ("\\.for\\'" . fortran-mode)
2203 ("\\.p\\'" . pascal-mode)
2204 ("\\.pas\\'" . pascal-mode)
2205 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode)
2206 ("\\.ad[abs]\\'" . ada-mode)
2207 ("\\.ad[bs].dg\\'" . ada-mode)
2208 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2209 ("Imakefile\\'" . makefile-imake-mode)
2210 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2211 ("\\.makepp\\'" . makefile-makepp-mode)
2212 ,@(if (memq system-type '(berkeley-unix darwin))
2213 '(("\\.mk\\'" . makefile-bsdmake-mode)
2214 ("GNUmakefile\\'" . makefile-gmake-mode)
2215 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2216 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2217 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2218 ("\\.am\\'" . makefile-automake-mode)
2219 ;; Less common extensions come here
2220 ;; so more common ones above are found faster.
2221 ("\\.texinfo\\'" . texinfo-mode)
2222 ("\\.te?xi\\'" . texinfo-mode)
2223 ("\\.[sS]\\'" . asm-mode)
2224 ("\\.asm\\'" . asm-mode)
2225 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2226 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2227 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2228 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2229 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2230 ("\\.bash\\'" . sh-mode)
2231 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2232 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2233 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2234 ("\\.m?spec\\'" . sh-mode)
2235 ("\\.m[mes]\\'" . nroff-mode)
2236 ("\\.man\\'" . nroff-mode)
2237 ("\\.sty\\'" . latex-mode)
2238 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2239 ("\\.bbl\\'" . latex-mode)
2240 ("\\.bib\\'" . bibtex-mode)
2241 ("\\.sql\\'" . sql-mode)
2242 ("\\.m[4c]\\'" . m4-mode)
2243 ("\\.mf\\'" . metafont-mode)
2244 ("\\.mp\\'" . metapost-mode)
2245 ("\\.vhdl?\\'" . vhdl-mode)
2246 ("\\.article\\'" . text-mode)
2247 ("\\.letter\\'" . text-mode)
2248 ("\\.i?tcl\\'" . tcl-mode)
2249 ("\\.exp\\'" . tcl-mode)
2250 ("\\.itk\\'" . tcl-mode)
2251 ("\\.icn\\'" . icon-mode)
2252 ("\\.sim\\'" . simula-mode)
2253 ("\\.mss\\'" . scribe-mode)
2254 ("\\.f9[05]\\'" . f90-mode)
2255 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2256 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode)
2257 ("\\.srt\\'" . srecode-template-mode)
2258 ("\\.prolog\\'" . prolog-mode)
2259 ("\\.tar\\'" . tar-mode)
2260 ;; The list of archive file extensions should be in sync with
2261 ;; `auto-coding-alist' with `no-conversion' coding system.
2263 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2264 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode)
2265 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode) ;OpenOffice.org
2266 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode) ; Debian/Opkg packages.
2267 ;; Mailer puts message to be edited in
2268 ;; /tmp/Re.... or Message
2269 ("\\`/tmp/Re" . text-mode)
2270 ("/Message[0-9]*\\'" . text-mode)
2271 ;; some news reader is reported to use this
2272 ("\\`/tmp/fol/" . text-mode)
2273 ("\\.oak\\'" . scheme-mode)
2274 ("\\.sgml?\\'" . sgml-mode)
2275 ("\\.x[ms]l\\'" . xml-mode)
2276 ("\\.dtd\\'" . sgml-mode)
2277 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2278 ("\\.js\\'" . js-mode) ; javascript-mode would be better
2279 ("\\.[ds]?vh?\\'" . verilog-mode)
2280 ;; .emacs or .gnus or .viper following a directory delimiter in
2281 ;; Unix, MSDOG or VMS syntax.
2282 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2283 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2284 ;; _emacs following a directory delimiter
2286 ("[:/]_emacs\\'" . emacs-lisp-mode)
2287 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2288 ("\\.ml\\'" . lisp-mode)
2289 ;; Common Lisp ASDF package system.
2290 ("\\.asd\\'" . lisp-mode)
2291 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2292 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2293 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2294 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2295 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2296 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2297 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2298 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode)
2299 ("BROWSE\\'" . ebrowse-tree-mode)
2300 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2301 ("#\\*mail\\*" . mail-mode)
2302 ("\\.g\\'" . antlr-mode)
2303 ("\\.ses\\'" . ses-mode)
2304 ("\\.docbook\\'" . sgml-mode)
2305 ("\\.com\\'" . dcl-mode)
2306 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2307 ;; Windows candidates may be opened case sensitively on Unix
2308 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2309 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2310 ("\\.ppd\\'" . conf-ppd-mode)
2311 ("java.+\\.conf\\'" . conf-javaprop-mode)
2312 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2313 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2314 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2315 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2316 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2317 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2318 ;; this has lower priority to avoid matching changelog.sgml etc.
2319 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2320 ;; either user's dot-files or under /etc or some such
2321 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2322 ;; alas not all ~/.*rc files are like this
2323 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2324 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2325 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2326 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2327 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2328 ;; this contains everything twice, with space and with colon :-(
2329 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2330 ;; Get rid of any trailing .n.m and try again.
2331 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2332 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2333 ;; Using mode nil rather than `ignore' would let the search continue
2334 ;; through this list (with the shortened name) rather than start over.
2335 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2336 ;; The following should come after the ChangeLog pattern
2337 ;; for the sake of ChangeLog.1, etc.
2338 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2339 ("\\.[1-9]\\'" . nroff-mode)
2340 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2341 "Alist of filename patterns vs corresponding major mode functions.
2342 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2343 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2344 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2345 mode function to use. FUNCTION will be called, unless it is nil.
2347 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2348 calling FUNCTION (if it's not nil), we delete the suffix that matched
2349 REGEXP and search the list again for another match.
2351 If the file name matches `inhibit-first-line-modes-regexps',
2352 then `auto-mode-alist' is not processed.
2354 The extensions whose FUNCTION is `archive-mode' should also
2355 appear in `auto-coding-alist' with `no-conversion' coding system.
2357 See also `interpreter-mode-alist', which detects executable script modes
2358 based on the interpreters they specify to run,
2359 and `magic-mode-alist', which determines modes based on file contents.")
2360 (put 'auto-mode-alist 'risky-local-variable t)
2362 (defun conf-mode-maybe ()
2363 "Select Conf mode or XML mode according to start of file."
2367 (goto-char (point-min))
2368 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2372 (defvar interpreter-mode-alist
2373 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2374 ;; and pike-mode) are added through autoload directives in that
2375 ;; file. That way is discouraged since it spreads out the
2376 ;; definition of the initial value.
2379 (cons (purecopy (car l)) (cdr l)))
2380 '(("perl" . perl-mode)
2381 ("perl5" . perl-mode)
2382 ("miniperl" . perl-mode)
2384 ("wishx" . tcl-mode)
2386 ("tclsh" . tcl-mode)
2387 ("scm" . scheme-mode)
2407 ("tail" . text-mode)
2408 ("more" . text-mode)
2409 ("less" . text-mode)
2411 ("make" . makefile-gmake-mode) ; Debian uses this
2412 ("guile" . scheme-mode)
2413 ("clisp" . lisp-mode)
2414 ("emacs" . emacs-lisp-mode)))
2415 "Alist mapping interpreter names to major modes.
2416 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2417 Each element looks like (INTERPRETER . MODE).
2418 If INTERPRETER matches the name of the interpreter specified in the first line
2419 of a script, mode MODE is enabled.
2421 See also `auto-mode-alist'.")
2423 (defvar inhibit-first-line-modes-regexps (mapcar 'purecopy '("\\.tar\\'" "\\.tgz\\'"))
2424 "List of regexps; if one matches a file name, don't look for `-*-'.")
2426 (defvar inhibit-first-line-modes-suffixes nil
2427 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2428 When checking `inhibit-first-line-modes-regexps', we first discard
2429 from the end of the file name anything that matches one of these regexps.")
2431 (defvar auto-mode-interpreter-regexp
2432 (purecopy "#![ \t]?\\([^ \t\n]*\
2433 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2434 "Regexp matching interpreters, for file mode determination.
2435 This regular expression is matched against the first line of a file
2436 to determine the file's mode in `set-auto-mode'. If it matches, the file
2437 is assumed to be interpreted by the interpreter matched by the second group
2438 of the regular expression. The mode is then determined as the mode
2439 associated with that interpreter in `interpreter-mode-alist'.")
2441 (defvar magic-mode-alist nil
2442 "Alist of buffer beginnings vs. corresponding major mode functions.
2443 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2444 After visiting a file, if REGEXP matches the text at the beginning of the
2445 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2446 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2449 If FUNCTION is nil, then it is not called. (That is a way of saying
2450 \"allow `auto-mode-alist' to decide for these files.\")")
2451 (put 'magic-mode-alist 'risky-local-variable t)
2453 (defvar magic-fallback-mode-alist
2455 `((image-type-auto-detected-p . image-mode)
2456 ("\\(PK00\\)?[P]K\003\004" . archive-mode) ; zip
2457 ;; The < comes before the groups (but the first) to reduce backtracking.
2458 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2459 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2460 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2461 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2462 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2464 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2465 "[Hh][Tt][Mm][Ll]"))
2467 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2468 ;; These two must come after html, because they are more general:
2469 ("<\\?xml " . xml-mode)
2470 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2471 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2472 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2475 ("# xmcd " . conf-unix-mode)))
2476 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2477 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2478 After visiting a file, if REGEXP matches the text at the beginning of the
2479 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2480 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2481 have not specified a mode for this file.
2483 If FUNCTION is nil, then it is not called.")
2484 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2486 (defvar magic-mode-regexp-match-limit 4000
2487 "Upper limit on `magic-mode-alist' regexp matches.
2488 Also applies to `magic-fallback-mode-alist'.")
2490 (defun set-auto-mode (&optional keep-mode-if-same)
2491 "Select major mode appropriate for current buffer.
2493 To find the right major mode, this function checks for a -*- mode tag,
2494 checks if it uses an interpreter listed in `interpreter-mode-alist',
2495 matches the buffer beginning against `magic-mode-alist',
2496 compares the filename against the entries in `auto-mode-alist',
2497 then matches the buffer beginning against `magic-fallback-mode-alist'.
2499 It does not check for the `mode:' local variable in the
2500 Local Variables section of the file; for that, use `hack-local-variables'.
2502 If `enable-local-variables' is nil, this function does not check for a
2505 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2506 set the major mode only if that would change it. In other words
2507 we don't actually set it to the same mode the buffer already has."
2508 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2509 (let (end done mode modes)
2510 ;; Find a -*- mode tag
2512 (goto-char (point-min))
2513 (skip-chars-forward " \t\n")
2514 (and enable-local-variables
2515 (setq end (set-auto-mode-1))
2516 (if (save-excursion (search-forward ":" end t))
2517 ;; Find all specifications for the `mode:' variable
2518 ;; and execute them left to right.
2519 (while (let ((case-fold-search t))
2520 (or (and (looking-at "mode:")
2521 (goto-char (match-end 0)))
2522 (re-search-forward "[ \t;]mode:" end t)))
2523 (skip-chars-forward " \t")
2524 (let ((beg (point)))
2525 (if (search-forward ";" end t)
2528 (skip-chars-backward " \t")
2529 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2531 ;; Simple -*-MODE-*- case.
2532 (push (intern (concat (downcase (buffer-substring (point) end))
2535 ;; If we found modes to use, invoke them now, outside the save-excursion.
2538 (dolist (mode (nreverse modes))
2539 (if (not (functionp mode))
2540 (message "Ignoring unknown mode `%s'" mode)
2542 (or (set-auto-mode-0 mode keep-mode-if-same)
2543 ;; continuing would call minor modes again, toggling them off
2544 (throw 'nop nil))))))
2545 ;; If we didn't, look for an interpreter specified in the first line.
2546 ;; As a special case, allow for things like "#!/bin/env perl", which
2547 ;; finds the interpreter anywhere in $PATH.
2549 (setq mode (save-excursion
2550 (goto-char (point-min))
2551 (if (looking-at auto-mode-interpreter-regexp)
2554 ;; Map interpreter name to a mode, signalling we're done at the
2556 done (assoc (file-name-nondirectory mode)
2557 interpreter-mode-alist))
2558 ;; If we found an interpreter mode to use, invoke it now.
2560 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2561 ;; Next try matching the buffer beginning against magic-mode-alist.
2563 (if (setq done (save-excursion
2564 (goto-char (point-min))
2566 (narrow-to-region (point-min)
2568 (+ (point-min) magic-mode-regexp-match-limit)))
2569 (assoc-default nil magic-mode-alist
2573 (looking-at re)))))))
2574 (set-auto-mode-0 done keep-mode-if-same)))
2575 ;; Next compare the filename against the entries in auto-mode-alist.
2577 (if buffer-file-name
2578 (let ((name buffer-file-name)
2579 (remote-id (file-remote-p buffer-file-name)))
2580 ;; Remove remote file name identification.
2581 (when (and (stringp remote-id)
2582 (string-match (regexp-quote remote-id) name))
2583 (setq name (substring name (match-end 0))))
2584 ;; Remove backup-suffixes from file name.
2585 (setq name (file-name-sans-versions name))
2587 ;; Find first matching alist entry.
2589 (if (memq system-type '(windows-nt cygwin))
2590 ;; System is case-insensitive.
2591 (let ((case-fold-search t))
2592 (assoc-default name auto-mode-alist
2594 ;; System is case-sensitive.
2596 ;; First match case-sensitively.
2597 (let ((case-fold-search nil))
2598 (assoc-default name auto-mode-alist
2600 ;; Fallback to case-insensitive match.
2601 (and auto-mode-case-fold
2602 (let ((case-fold-search t))
2603 (assoc-default name auto-mode-alist
2608 (setq mode (car mode)
2609 name (substring name 0 (match-beginning 0)))
2612 (set-auto-mode-0 mode keep-mode-if-same)
2614 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2616 (if (setq done (save-excursion
2617 (goto-char (point-min))
2619 (narrow-to-region (point-min)
2621 (+ (point-min) magic-mode-regexp-match-limit)))
2622 (assoc-default nil magic-fallback-mode-alist
2626 (looking-at re)))))))
2627 (set-auto-mode-0 done keep-mode-if-same)))))
2629 ;; When `keep-mode-if-same' is set, we are working on behalf of
2630 ;; set-visited-file-name. In that case, if the major mode specified is the
2631 ;; same one we already have, don't actually reset it. We don't want to lose
2632 ;; minor modes such as Font Lock.
2633 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2634 "Apply MODE and return it.
2635 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2636 any aliases and compared to current major mode. If they are the
2637 same, do nothing and return nil."
2638 (unless (and keep-mode-if-same
2639 (eq (indirect-function mode)
2640 (indirect-function major-mode)))
2645 (defun set-auto-mode-1 ()
2646 "Find the -*- spec in the buffer.
2647 Call with point at the place to start searching from.
2648 If one is found, set point to the beginning
2649 and return the position of the end.
2650 Otherwise, return nil; point may be changed."
2653 ;; Don't look for -*- if this file name matches any
2654 ;; of the regexps in inhibit-first-line-modes-regexps.
2655 (let ((temp inhibit-first-line-modes-regexps)
2656 (name (if buffer-file-name
2657 (file-name-sans-versions buffer-file-name)
2659 (while (let ((sufs inhibit-first-line-modes-suffixes))
2660 (while (and sufs (not (string-match (car sufs) name)))
2661 (setq sufs (cdr sufs)))
2663 (setq name (substring name 0 (match-beginning 0))))
2665 (not (string-match (car temp) name)))
2666 (setq temp (cdr temp)))
2669 (search-forward "-*-" (line-end-position
2670 ;; If the file begins with "#!"
2671 ;; (exec interpreter magic), look
2672 ;; for mode frobs in the first two
2673 ;; lines. You cannot necessarily
2674 ;; put them in the first line of
2675 ;; such a file without screwing up
2676 ;; the interpreter invocation.
2677 ;; The same holds for
2679 ;; in man pages (preprocessor
2680 ;; magic for the `man' program).
2681 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2683 (skip-chars-forward " \t")
2685 (search-forward "-*-" (line-end-position) t))
2688 (skip-chars-backward " \t")
2693 ;;; Handling file local variables
2695 (defvar ignored-local-variables
2696 '(ignored-local-variables safe-local-variable-values
2697 file-local-variables-alist dir-local-variables-alist)
2698 "Variables to be ignored in a file's local variable spec.")
2699 (put 'ignored-local-variables 'risky-local-variable t)
2701 (defvar hack-local-variables-hook nil
2702 "Normal hook run after processing a file's local variables specs.
2703 Major modes can use this to examine user-specified local variables
2704 in order to initialize other data structure based on them.")
2706 (defcustom safe-local-variable-values nil
2707 "List variable-value pairs that are considered safe.
2708 Each element is a cons cell (VAR . VAL), where VAR is a variable
2709 symbol and VAL is a value that is considered safe."
2714 (defcustom safe-local-eval-forms
2715 '((add-hook 'write-file-functions 'time-stamp)
2716 (add-hook 'before-save-hook 'time-stamp))
2717 "Expressions that are considered safe in an `eval:' local variable.
2718 Add expressions to this list if you want Emacs to evaluate them, when
2719 they appear in an `eval' local variable specification, without first
2720 asking you for confirmation."
2724 :type '(repeat sexp))
2726 ;; Risky local variables:
2727 (mapc (lambda (var) (put var 'risky-local-variable t))
2729 buffer-auto-save-file-name
2731 buffer-file-truename
2734 default-text-properties
2738 file-name-handler-alist
2747 minor-mode-map-alist
2748 minor-mode-overriding-map-alist
2751 overriding-local-map
2752 overriding-terminal-local-map
2756 unread-command-events))
2758 ;; Safe local variables:
2760 ;; For variables defined by major modes, the safety declarations can go into
2761 ;; the major mode's file, since that will be loaded before file variables are
2764 ;; For variables defined by minor modes, put the safety declarations in the
2765 ;; file defining the minor mode after the defcustom/defvar using an autoload
2768 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2770 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2771 ;; minor mode file may not be loaded yet.
2773 ;; For variables defined in the C source code the declaration should go here:
2775 (mapc (lambda (pair)
2776 (put (car pair) 'safe-local-variable (cdr pair)))
2777 '((buffer-read-only . booleanp) ;; C source code
2778 (default-directory . stringp) ;; C source code
2779 (fill-column . integerp) ;; C source code
2780 (indent-tabs-mode . booleanp) ;; C source code
2781 (left-margin . integerp) ;; C source code
2782 (no-update-autoloads . booleanp)
2783 (tab-width . integerp) ;; C source code
2784 (truncate-lines . booleanp) ;; C source code
2785 (bidi-display-reordering . booleanp))) ;; C source code
2787 (put 'c-set-style 'safe-local-eval-function t)
2789 (defvar file-local-variables-alist nil
2790 "Alist of file-local variable settings in the current buffer.
2791 Each element in this list has the form (VAR . VALUE), where VAR
2792 is a file-local variable (a symbol) and VALUE is the value
2793 specified. The actual value in the buffer may differ from VALUE,
2794 if it is changed by the major or minor modes, or by the user.")
2795 (make-variable-buffer-local 'file-local-variables-alist)
2797 (defvar dir-local-variables-alist nil
2798 "Alist of directory-local variable settings in the current buffer.
2799 Each element in this list has the form (VAR . VALUE), where VAR
2800 is a directory-local variable (a symbol) and VALUE is the value
2801 specified in .dir-locals.el. The actual value in the buffer
2802 may differ from VALUE, if it is changed by the major or minor modes,
2804 (make-variable-buffer-local 'dir-local-variables-alist)
2806 (defvar before-hack-local-variables-hook nil
2807 "Normal hook run before setting file-local variables.
2808 It is called after checking for unsafe/risky variables and
2809 setting `file-local-variables-alist', and before applying the
2810 variables stored in `file-local-variables-alist'. A hook
2811 function is allowed to change the contents of this alist.
2813 This hook is called only if there is at least one file-local
2816 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name)
2817 "Get confirmation before setting up local variable values.
2818 ALL-VARS is the list of all variables to be set up.
2819 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2820 RISKY-VARS is the list of those that are marked as risky.
2821 DIR-NAME is a directory name if these settings come from
2822 directory-local variables, or nil otherwise."
2825 (let ((name (or dir-name
2826 (if buffer-file-name
2827 (file-name-nondirectory buffer-file-name)
2828 (concat "buffer " (buffer-name)))))
2829 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2831 (save-window-excursion
2832 (let ((buf (get-buffer-create "*Local Variables*")))
2834 (set (make-local-variable 'cursor-type) nil)
2837 (insert "The local variables list in " name
2838 "\ncontains values that may not be safe (*)"
2840 ", and variables that are risky (**)."
2843 (insert "The local variables list in " name
2844 "\ncontains variables that are risky (**).")
2845 (insert "A local variables list is specified in " name ".")))
2846 (insert "\n\nDo you want to apply it? You can type
2847 y -- to apply the local variables list.
2848 n -- to ignore the local variables list.")
2851 ! -- to apply the local variables list, and permanently mark these
2852 values (*) as safe (in the future, they will be set automatically.)\n\n")
2854 (dolist (elt all-vars)
2855 (cond ((member elt unsafe-vars)
2857 ((member elt risky-vars)
2861 (princ (car elt) buf)
2863 ;; Make strings with embedded whitespace easier to read.
2864 (let ((print-escape-newlines t))
2865 (prin1 (cdr elt) buf))
2868 (format "Please type %s%s: "
2869 (if offer-save "y, n, or !" "y or n")
2870 (if (< (line-number-at-pos) (window-body-height))
2872 ", or C-v to scroll")))
2873 (goto-char (point-min))
2874 (let ((cursor-in-echo-area t)
2875 (executing-kbd-macro executing-kbd-macro)
2877 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2880 (message "%s" prompt)
2881 (setq char (read-event))
2883 (cond ((eq char ?\C-v)
2886 (error (goto-char (point-min)))))
2887 ;; read-event returns -1 if we are in a kbd
2888 ;; macro and there are no more events in the
2889 ;; macro. In that case, attempt to get an
2890 ;; event interactively.
2891 ((and executing-kbd-macro (= char -1))
2892 (setq executing-kbd-macro nil))
2893 (t (setq done (memq (downcase char) exit-chars)))))))
2894 (setq char (downcase char))
2895 (when (and offer-save (= char ?!) unsafe-vars)
2896 (dolist (elt unsafe-vars)
2897 (add-to-list 'safe-local-variable-values elt))
2898 ;; When this is called from desktop-restore-file-buffer,
2899 ;; coding-system-for-read may be non-nil. Reset it before
2900 ;; writing to .emacs.
2901 (if (or custom-file user-init-file)
2902 (let ((coding-system-for-read nil))
2903 (customize-save-variable
2904 'safe-local-variable-values
2905 safe-local-variable-values))))
2911 (defun hack-local-variables-prop-line (&optional mode-only)
2912 "Return local variables specified in the -*- line.
2913 Ignore any specification for `mode:' and `coding:';
2914 `set-auto-mode' should already have handled `mode:',
2915 `set-auto-coding' should already have handled `coding:'.
2917 If MODE-ONLY is non-nil, all we do is check whether the major
2918 mode is specified, returning t if it is specified. Otherwise,
2919 return an alist of elements (VAR . VAL), where VAR is a variable
2920 and VAL is the specified value."
2922 (goto-char (point-min))
2923 (let ((end (set-auto-mode-1))
2924 result mode-specified)
2925 ;; Parse the -*- line into the RESULT alist.
2926 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2929 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2930 ;; Simple form: "-*- MODENAME -*-". Already handled.
2931 (setq mode-specified t)
2934 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2935 ;; (last ";" is optional).
2936 (while (< (point) end)
2937 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2938 (error "Malformed -*- line"))
2939 (goto-char (match-end 0))
2940 ;; There used to be a downcase here,
2941 ;; but the manual didn't say so,
2942 ;; and people want to set var names that aren't all lc.
2943 (let ((key (intern (match-string 1)))
2944 (val (save-restriction
2945 (narrow-to-region (point) end)
2946 (let ((read-circle nil))
2947 (read (current-buffer))))))
2948 ;; It is traditional to ignore
2949 ;; case when checking for `mode' in set-auto-mode,
2950 ;; so we must do that here as well.
2951 ;; That is inconsistent, but we're stuck with it.
2952 ;; The same can be said for `coding' in set-auto-coding.
2953 (or (and (equal (downcase (symbol-name key)) "mode")
2954 (setq mode-specified t))
2955 (equal (downcase (symbol-name key)) "coding")
2957 (push (cons (if (eq key 'eval)
2959 (indirect-variable key))
2962 (skip-chars-forward " \t;")))))
2968 (defun hack-local-variables-filter (variables dir-name)
2969 "Filter local variable settings, querying the user if necessary.
2970 VARIABLES is the alist of variable-value settings. This alist is
2971 filtered based on the values of `ignored-local-variables',
2972 `enable-local-eval', `enable-local-variables', and (if necessary)
2973 user interaction. The results are added to
2974 `file-local-variables-alist', without applying them.
2975 DIR-NAME is a directory name if these settings come from
2976 directory-local variables, or nil otherwise."
2977 ;; Find those variables that we may want to save to
2978 ;; `safe-local-variable-values'.
2979 (let (all-vars risky-vars unsafe-vars)
2980 (dolist (elt variables)
2981 (let ((var (car elt))
2983 (cond ((memq var ignored-local-variables)
2984 ;; Ignore any variable in `ignored-local-variables'.
2986 ;; Obey `enable-local-eval'.
2988 (when enable-local-eval
2990 (or (eq enable-local-eval t)
2991 (hack-one-local-variable-eval-safep (eval (quote val)))
2992 (safe-local-variable-p var val)
2993 (push elt unsafe-vars))))
2994 ;; Ignore duplicates (except `mode') in the present list.
2995 ((and (assq var all-vars) (not (eq var 'mode))) nil)
2996 ;; Accept known-safe variables.
2997 ((or (memq var '(mode unibyte coding))
2998 (safe-local-variable-p var val))
2999 (push elt all-vars))
3000 ;; The variable is either risky or unsafe:
3001 ((not (eq enable-local-variables :safe))
3003 (if (risky-local-variable-p var val)
3004 (push elt risky-vars)
3005 (push elt unsafe-vars))))))
3007 ;; Query, unless all vars are safe or user wants no querying.
3008 (or (and (eq enable-local-variables t)
3011 (memq enable-local-variables '(:all :safe))
3012 (hack-local-variables-confirm all-vars unsafe-vars
3013 risky-vars dir-name))
3014 (dolist (elt all-vars)
3015 (unless (memq (car elt) '(eval mode))
3017 (setq dir-local-variables-alist
3018 (assq-delete-all (car elt) dir-local-variables-alist)))
3019 (setq file-local-variables-alist
3020 (assq-delete-all (car elt) file-local-variables-alist)))
3021 (push elt file-local-variables-alist)))))
3023 (defun hack-local-variables (&optional mode-only)
3024 "Parse and put into effect this buffer's local variables spec.
3025 If MODE-ONLY is non-nil, all we do is check whether the major mode
3026 is specified, returning t if it is specified."
3027 (let ((enable-local-variables
3028 (and local-enable-local-variables enable-local-variables))
3031 (setq file-local-variables-alist nil)
3032 (report-errors "Directory-local variables error: %s"
3033 (hack-dir-local-variables)))
3034 (when (or mode-only enable-local-variables)
3035 (setq result (hack-local-variables-prop-line mode-only))
3036 ;; Look for "Local variables:" line in last page.
3038 (goto-char (point-max))
3039 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3041 (when (let ((case-fold-search t))
3042 (search-forward "Local Variables:" nil t))
3043 (skip-chars-forward " \t")
3044 ;; suffix is what comes after "local variables:" in its line.
3045 ;; prefix is what comes before "local variables:" in its line.
3048 (regexp-quote (buffer-substring (point)
3049 (line-end-position)))
3052 (concat "^" (regexp-quote
3053 (buffer-substring (line-beginning-position)
3054 (match-beginning 0)))))
3058 (let ((startpos (point))
3060 (thisbuf (current-buffer)))
3062 (unless (let ((case-fold-search t))
3064 (concat prefix "[ \t]*End:[ \t]*" suffix)
3066 ;; This used to be an error, but really all it means is
3067 ;; that this may simply not be a local-variables section,
3068 ;; so just ignore it.
3069 (message "Local variables list is not properly terminated"))
3071 (setq endpos (point)))
3074 (insert-buffer-substring thisbuf startpos endpos)
3075 (goto-char (point-min))
3076 (subst-char-in-region (point) (point-max) ?\^m ?\n)
3078 ;; Discard the prefix.
3079 (if (looking-at prefix)
3080 (delete-region (point) (match-end 0))
3081 (error "Local variables entry is missing the prefix"))
3083 ;; Discard the suffix.
3084 (if (looking-back suffix)
3085 (delete-region (match-beginning 0) (point))
3086 (error "Local variables entry is missing the suffix"))
3088 (goto-char (point-min))
3091 ;; Find the variable name; strip whitespace.
3092 (skip-chars-forward " \t")
3094 (skip-chars-forward "^:\n")
3095 (if (eolp) (error "Missing colon in local variables entry"))
3096 (skip-chars-backward " \t")
3097 (let* ((str (buffer-substring beg (point)))
3098 (var (let ((read-circle nil))
3101 ;; Read the variable value.
3102 (skip-chars-forward "^:")
3104 (let ((read-circle nil))
3105 (setq val (read (current-buffer))))
3109 (unless (eq var 'coding)
3111 (push (cons (if (eq var 'eval)
3113 (indirect-variable var))
3116 (forward-line 1))))))))
3117 ;; Now we've read all the local variables.
3118 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3119 (cond (mode-only result)
3120 ;; Otherwise, set the variables.
3121 (enable-local-variables
3122 (hack-local-variables-filter result nil)
3123 (hack-local-variables-apply)))))
3125 (defun hack-local-variables-apply ()
3126 (when file-local-variables-alist
3127 ;; Any 'evals must run in the Right sequence.
3128 (setq file-local-variables-alist
3129 (nreverse file-local-variables-alist))
3130 (run-hooks 'before-hack-local-variables-hook)
3131 (dolist (elt file-local-variables-alist)
3132 (hack-one-local-variable (car elt) (cdr elt))))
3133 (run-hooks 'hack-local-variables-hook))
3135 (defun safe-local-variable-p (sym val)
3136 "Non-nil if SYM is safe as a file-local variable with value VAL.
3137 It is safe if any of these conditions are met:
3139 * There is a matching entry (SYM . VAL) in the
3140 `safe-local-variable-values' user option.
3142 * The `safe-local-variable' property of SYM is a function that
3143 evaluates to a non-nil value with VAL as an argument."
3144 (or (member (cons sym val) safe-local-variable-values)
3145 (let ((safep (get sym 'safe-local-variable)))
3146 (and (functionp safep) (funcall safep val)))))
3148 (defun risky-local-variable-p (sym &optional ignored)
3149 "Non-nil if SYM could be dangerous as a file-local variable.
3150 It is dangerous if either of these conditions are met:
3152 * Its `risky-local-variable' property is non-nil.
3154 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3155 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3156 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3157 \"map-alist\", or \"bindat-spec\"."
3158 ;; If this is an alias, check the base name.
3160 (setq sym (indirect-variable sym))
3162 (or (get sym 'risky-local-variable)
3163 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3164 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3165 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3166 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
3168 (defun hack-one-local-variable-quotep (exp)
3169 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
3171 (defun hack-one-local-variable-constantp (exp)
3172 (or (and (not (symbolp exp)) (not (consp exp)))
3175 (hack-one-local-variable-quotep exp)))
3177 (defun hack-one-local-variable-eval-safep (exp)
3178 "Return t if it is safe to eval EXP when it is found in a file."
3179 (or (not (consp exp))
3180 ;; Detect certain `put' expressions.
3181 (and (eq (car exp) 'put)
3182 (hack-one-local-variable-quotep (nth 1 exp))
3183 (hack-one-local-variable-quotep (nth 2 exp))
3184 (let ((prop (nth 1 (nth 2 exp)))
3186 (cond ((memq prop '(lisp-indent-hook
3187 lisp-indent-function
3188 scheme-indent-function))
3189 ;; Only allow safe values (not functions).
3191 (and (hack-one-local-variable-quotep val)
3192 (eq (nth 1 val) 'defun))))
3193 ((eq prop 'edebug-form-spec)
3194 ;; Only allow indirect form specs.
3195 ;; During bootstrapping, edebug-basic-spec might not be
3197 (and (fboundp 'edebug-basic-spec)
3198 (hack-one-local-variable-quotep val)
3199 (edebug-basic-spec (nth 1 val)))))))
3200 ;; Allow expressions that the user requested.
3201 (member exp safe-local-eval-forms)
3202 ;; Certain functions can be allowed with safe arguments
3203 ;; or can specify verification functions to try.
3204 (and (symbolp (car exp))
3205 (let ((prop (get (car exp) 'safe-local-eval-function)))
3208 (dolist (arg (cdr exp))
3209 (unless (hack-one-local-variable-constantp arg)
3216 (dolist (function prop)
3217 (if (funcall function exp)
3221 (defun hack-one-local-variable (var val)
3222 "Set local variable VAR with value VAL.
3223 If VAR is `mode', call `VAL-mode' as a function unless it's
3224 already the major mode."
3225 (cond ((eq var 'mode)
3226 (let ((mode (intern (concat (downcase (symbol-name val))
3228 (unless (eq (indirect-function mode)
3229 (indirect-function major-mode))
3230 (if (memq mode minor-mode-list)
3231 ;; A minor mode must be passed an argument.
3232 ;; Otherwise, if the user enables the minor mode in a
3233 ;; major mode hook, this would toggle it off.
3237 (save-excursion (eval val)))
3239 ;; Make sure the string has no text properties.
3240 ;; Some text properties can get evaluated in various ways,
3241 ;; so it is risky to put them on with a local variable list.
3243 (set-text-properties 0 (length val) nil val))
3244 (set (make-local-variable var) val))))
3246 ;;; Handling directory-local variables, aka project settings.
3248 (defvar dir-locals-class-alist '()
3249 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3251 (defvar dir-locals-directory-cache '()
3252 "List of cached directory roots for directory-local variable classes.
3253 Each element in this list has the form (DIR CLASS MTIME).
3254 DIR is the name of the directory.
3255 CLASS is the name of a variable class (a symbol).
3256 MTIME is the recorded modification time of the directory-local
3257 variables file associated with this entry. This time is a list
3258 of two integers (the same format as `file-attributes'), and is
3259 used to test whether the cache entry is still valid.
3260 Alternatively, MTIME can be nil, which means the entry is always
3263 (defsubst dir-locals-get-class-variables (class)
3264 "Return the variable list for CLASS."
3265 (cdr (assq class dir-locals-class-alist)))
3267 (defun dir-locals-collect-mode-variables (mode-variables variables)
3268 "Collect directory-local variables from MODE-VARIABLES.
3269 VARIABLES is the initial list of variables.
3270 Returns the new list."
3271 (dolist (pair mode-variables variables)
3272 (let* ((variable (car pair))
3274 (slot (assq variable variables)))
3275 ;; If variables are specified more than once, only use the last. (Why?)
3276 ;; The pseudo-variables mode and eval are different (bug#3430).
3277 (if (and slot (not (memq variable '(mode eval))))
3279 ;; Need a new cons in case we setcdr later.
3280 (push (cons variable value) variables)))))
3282 (defun dir-locals-collect-variables (class-variables root variables)
3283 "Collect entries from CLASS-VARIABLES into VARIABLES.
3284 ROOT is the root directory of the project.
3285 Return the new variables list."
3286 (let* ((file-name (buffer-file-name))
3287 (sub-file-name (if file-name
3288 (substring file-name (length root)))))
3289 (dolist (entry class-variables variables)
3290 (let ((key (car entry)))
3293 ;; Don't include this in the previous condition, because we
3294 ;; want to filter all strings before the next condition.
3295 (when (and sub-file-name
3296 (>= (length sub-file-name) (length key))
3297 (string= key (substring sub-file-name 0 (length key))))
3298 (setq variables (dir-locals-collect-variables
3299 (cdr entry) root variables))))
3301 (derived-mode-p key))
3302 (setq variables (dir-locals-collect-mode-variables
3303 (cdr entry) variables))))))))
3305 (defun dir-locals-set-directory-class (directory class &optional mtime)
3306 "Declare that the DIRECTORY root is an instance of CLASS.
3307 DIRECTORY is the name of a directory, a string.
3308 CLASS is the name of a project class, a symbol.
3309 MTIME is either the modification time of the directory-local
3310 variables file that defined this class, or nil.
3312 When a file beneath DIRECTORY is visited, the mode-specific
3313 variables from CLASS are applied to the buffer. The variables
3314 for a class are defined using `dir-locals-set-class-variables'."
3315 (setq directory (file-name-as-directory (expand-file-name directory)))
3316 (unless (assq class dir-locals-class-alist)
3317 (error "No such class `%s'" (symbol-name class)))
3318 (push (list directory class mtime) dir-locals-directory-cache))
3320 (defun dir-locals-set-class-variables (class variables)
3321 "Map the type CLASS to a list of variable settings.
3322 CLASS is the project class, a symbol. VARIABLES is a list
3323 that declares directory-local variables for the class.
3324 An element in VARIABLES is either of the form:
3325 (MAJOR-MODE . ALIST)
3329 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3330 whose elements are of the form (VARIABLE . VALUE).
3332 In the second form, DIRECTORY is a directory name (a string), and
3333 LIST is a list of the form accepted by the function.
3335 When a file is visited, the file's class is found. A directory
3336 may be assigned a class using `dir-locals-set-directory-class'.
3337 Then variables are set in the file's buffer according to the
3338 class' LIST. The list is processed in order.
3340 * If the element is of the form (MAJOR-MODE . ALIST), and the
3341 buffer's major mode is derived from MAJOR-MODE (as determined
3342 by `derived-mode-p'), then all the variables in ALIST are
3343 applied. A MAJOR-MODE of nil may be used to match any buffer.
3344 `make-local-variable' is called for each variable before it is
3347 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3348 is an initial substring of the file's directory, then LIST is
3349 applied by recursively following these rules."
3350 (let ((elt (assq class dir-locals-class-alist)))
3352 (setcdr elt variables)
3353 (push (cons class variables) dir-locals-class-alist))))
3355 (defconst dir-locals-file ".dir-locals.el"
3356 "File that contains directory-local variables.
3357 It has to be constant to enforce uniform values
3358 across different environments and users.")
3360 (defun dir-locals-find-file (file)
3361 "Find the directory-local variables for FILE.
3362 This searches upward in the directory tree from FILE.
3363 If the directory root of FILE has been registered in
3364 `dir-locals-directory-cache' and the directory-local variables
3365 file has not been modified, return the matching entry in
3366 `dir-locals-directory-cache'.
3367 Otherwise, if a directory-local variables file is found, return
3369 Otherwise, return nil."
3370 (setq file (expand-file-name file))
3371 (let* ((dir-locals-file-name
3372 (if (eq system-type 'ms-dos)
3373 (dosified-file-name dir-locals-file)
3375 (locals-file (locate-dominating-file file dir-locals-file-name))
3377 ;; `locate-dominating-file' may have abbreviated the name.
3379 (setq locals-file (expand-file-name dir-locals-file-name locals-file)))
3380 ;; Find the best cached value in `dir-locals-directory-cache'.
3381 (dolist (elt dir-locals-directory-cache)
3382 (when (and (eq t (compare-strings file nil (length (car elt))
3385 '(windows-nt cygwin ms-dos))))
3386 (> (length (car elt)) (length (car dir-elt))))
3387 (setq dir-elt elt)))
3388 (let ((use-cache (and dir-elt
3389 (or (null locals-file)
3390 (<= (length (file-name-directory locals-file))
3391 (length (car dir-elt)))))))
3393 ;; Check the validity of the cache.
3394 (if (and (file-readable-p (car dir-elt))
3395 (or (null (nth 2 dir-elt))
3396 (equal (nth 2 dir-elt)
3397 (nth 5 (file-attributes (car dir-elt))))))
3398 ;; This cache entry is OK.
3400 ;; This cache entry is invalid; clear it.
3401 (setq dir-locals-directory-cache
3402 (delq dir-elt dir-locals-directory-cache))
3406 (defun dir-locals-read-from-file (file)
3407 "Load a variables FILE and register a new class and instance.
3408 FILE is the name of the file holding the variables to apply.
3409 The new class name is the same as the directory in which FILE
3410 is found. Returns the new class name."
3412 (insert-file-contents file)
3413 (let* ((dir-name (file-name-directory file))
3414 (class-name (intern dir-name))
3415 (variables (let ((read-circle nil))
3416 (read (current-buffer)))))
3417 (dir-locals-set-class-variables class-name variables)
3418 (dir-locals-set-directory-class dir-name class-name
3419 (nth 5 (file-attributes file)))
3422 (defun hack-dir-local-variables ()
3423 "Read per-directory local variables for the current buffer.
3424 Store the directory-local variables in `dir-local-variables-alist'
3425 and `file-local-variables-alist', without applying them."
3426 (when (and enable-local-variables
3427 (not (file-remote-p (or (buffer-file-name) default-directory))))
3428 ;; Find the variables file.
3429 (let ((variables-file (dir-locals-find-file (or (buffer-file-name) default-directory)))
3433 ((stringp variables-file)
3434 (setq dir-name (if (buffer-file-name) (file-name-directory (buffer-file-name)) default-directory))
3435 (setq class (dir-locals-read-from-file variables-file)))
3436 ((consp variables-file)
3437 (setq dir-name (nth 0 variables-file))
3438 (setq class (nth 1 variables-file))))
3441 (dir-locals-collect-variables
3442 (dir-locals-get-class-variables class) dir-name nil)))
3444 (dolist (elt variables)
3445 (unless (memq (car elt) '(eval mode))
3446 (setq dir-local-variables-alist
3447 (assq-delete-all (car elt) dir-local-variables-alist)))
3448 (push elt dir-local-variables-alist))
3449 (hack-local-variables-filter variables dir-name)))))))
3451 (defun hack-dir-local-variables-non-file-buffer ()
3452 (hack-dir-local-variables)
3453 (hack-local-variables-apply))
3456 (defcustom change-major-mode-with-file-name t
3457 "Non-nil means \\[write-file] should set the major mode from the file name.
3458 However, the mode will not be changed if
3459 \(1) a local variables list or the `-*-' line specifies a major mode, or
3460 \(2) the current major mode is a \"special\" mode,
3461 \ not suitable for ordinary files, or
3462 \(3) the new file name does not particularly specify any mode."
3464 :group 'editing-basics)
3466 (defun set-visited-file-name (filename &optional no-query along-with-file)
3467 "Change name of file visited in current buffer to FILENAME.
3468 This also renames the buffer to correspond to the new file.
3469 The next time the buffer is saved it will go in the newly specified file.
3470 FILENAME nil or an empty string means mark buffer as not visiting any file.
3471 Remember to delete the initial contents of the minibuffer
3472 if you wish to pass an empty string as the argument.
3474 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3475 confirmation in the case where another buffer is already visiting FILENAME.
3477 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3478 the old visited file has been renamed to the new name FILENAME."
3479 (interactive "FSet visited file name: ")
3480 (if (buffer-base-buffer)
3481 (error "An indirect buffer cannot visit a file"))
3485 (if (string-equal filename "")
3487 (expand-file-name filename))))
3490 (setq truename (file-truename filename))
3491 (if find-file-visit-truename
3492 (setq filename truename))))
3494 (let ((new-name (file-name-nondirectory filename)))
3495 (if (string= new-name "")
3496 (error "Empty file name"))))
3497 (let ((buffer (and filename (find-buffer-visiting filename))))
3498 (and buffer (not (eq buffer (current-buffer)))
3500 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3503 (or (equal filename buffer-file-name)
3505 (and filename (lock-buffer filename))
3507 (setq buffer-file-name filename)
3508 (if filename ; make buffer name reflect filename.
3509 (let ((new-name (file-name-nondirectory buffer-file-name)))
3510 (setq default-directory (file-name-directory buffer-file-name))
3511 ;; If new-name == old-name, renaming would add a spurious <2>
3512 ;; and it's considered as a feature in rename-buffer.
3513 (or (string= new-name (buffer-name))
3514 (rename-buffer new-name t))))
3515 (setq buffer-backed-up nil)
3517 (clear-visited-file-modtime))
3518 ;; Abbreviate the file names of the buffer.
3521 (setq buffer-file-truename (abbreviate-file-name truename))
3522 (if find-file-visit-truename
3523 (setq buffer-file-name truename))))
3524 (setq buffer-file-number
3526 (nthcdr 10 (file-attributes buffer-file-name))
3528 ;; write-file-functions is normally used for things like ftp-find-file
3529 ;; that visit things that are not local files as if they were files.
3530 ;; Changing to visit an ordinary local file instead should flush the hook.
3531 (kill-local-variable 'write-file-functions)
3532 (kill-local-variable 'local-write-file-hooks)
3533 (kill-local-variable 'revert-buffer-function)
3534 (kill-local-variable 'backup-inhibited)
3535 ;; If buffer was read-only because of version control,
3536 ;; that reason is gone now, so make it writable.
3538 (setq buffer-read-only nil))
3539 (kill-local-variable 'vc-mode)
3540 ;; Turn off backup files for certain file names.
3541 ;; Since this is a permanent local, the major mode won't eliminate it.
3542 (and buffer-file-name
3543 backup-enable-predicate
3544 (not (funcall backup-enable-predicate buffer-file-name))
3546 (make-local-variable 'backup-inhibited)
3547 (setq backup-inhibited t)))
3548 (let ((oauto buffer-auto-save-file-name))
3549 ;; If auto-save was not already on, turn it on if appropriate.
3550 (if (not buffer-auto-save-file-name)
3551 (and buffer-file-name auto-save-default
3553 ;; If auto save is on, start using a new name.
3554 ;; We deliberately don't rename or delete the old auto save
3555 ;; for the old visited file name. This is because perhaps
3556 ;; the user wants to save the new state and then compare with the
3557 ;; previous state from the auto save file.
3558 (setq buffer-auto-save-file-name
3559 (make-auto-save-file-name)))
3560 ;; Rename the old auto save file if any.
3561 (and oauto buffer-auto-save-file-name
3562 (file-exists-p oauto)
3563 (rename-file oauto buffer-auto-save-file-name t)))
3564 (and buffer-file-name
3565 (not along-with-file)
3566 (set-buffer-modified-p t))
3567 ;; Update the major mode, if the file name determines it.
3569 ;; Don't change the mode if it is special.
3570 (or (not change-major-mode-with-file-name)
3571 (get major-mode 'mode-class)
3572 ;; Don't change the mode if the local variable list specifies it.
3573 (hack-local-variables t)
3577 (defun write-file (filename &optional confirm)
3578 "Write current buffer into file FILENAME.
3579 This makes the buffer visit that file, and marks it as not modified.
3581 If you specify just a directory name as FILENAME, that means to use
3582 the default file name but in that directory. You can also yank
3583 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3585 If the buffer is not already visiting a file, the default file name
3586 for the output file is the buffer name.
3588 If optional second arg CONFIRM is non-nil, this function
3589 asks for confirmation before overwriting an existing file.
3590 Interactively, confirmation is required unless you supply a prefix argument."
3591 ;; (interactive "FWrite file: ")
3593 (list (if buffer-file-name
3594 (read-file-name "Write file: "
3596 (read-file-name "Write file: " default-directory
3598 (file-name-nondirectory (buffer-name))
3601 (not current-prefix-arg)))
3602 (or (null filename) (string-equal filename "")
3604 ;; If arg is just a directory,
3605 ;; use the default file name, but in that directory.
3606 (if (file-directory-p filename)
3607 (setq filename (concat (file-name-as-directory filename)
3608 (file-name-nondirectory
3609 (or buffer-file-name (buffer-name))))))
3611 (file-exists-p filename)
3612 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3613 (error "Canceled")))
3614 (set-visited-file-name filename (not confirm))))
3615 (set-buffer-modified-p t)
3616 ;; Make buffer writable if file is writable.
3617 (and buffer-file-name
3618 (file-writable-p buffer-file-name)
3619 (setq buffer-read-only nil))
3621 ;; It's likely that the VC status at the new location is different from
3622 ;; the one at the old location.
3623 (vc-find-file-hook))
3625 (defun backup-buffer ()
3626 "Make a backup of the disk file visited by the current buffer, if appropriate.
3627 This is normally done before saving the buffer the first time.
3629 A backup may be done by renaming or by copying; see documentation of
3630 variable `make-backup-files'. If it's done by renaming, then the file is
3631 no longer accessible under its old name.
3633 The value is non-nil after a backup was made by renaming.
3634 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3635 MODES is the result of `file-modes' on the original
3636 file; this means that the caller, after saving the buffer, should change
3637 the modes of the new file to agree with the old modes.
3638 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3639 file; this means that the caller, after saving the buffer, should change
3640 the SELinux context of the new file to agree with the old context.
3641 BACKUPNAME is the backup file name, which is the old file renamed."
3642 (if (and make-backup-files (not backup-inhibited)
3643 (not buffer-backed-up)
3644 (file-exists-p buffer-file-name)
3645 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3647 (let ((real-file-name buffer-file-name)
3648 backup-info backupname targets setmodes)
3649 ;; If specified name is a symbolic link, chase it to the target.
3650 ;; Thus we make the backups in the directory where the real file is.
3651 (setq real-file-name (file-chase-links real-file-name))
3652 (setq backup-info (find-backup-file-name real-file-name)
3653 backupname (car backup-info)
3654 targets (cdr backup-info))
3655 ;; (if (file-directory-p buffer-file-name)
3656 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3659 (let ((delete-old-versions
3660 ;; If have old versions to maybe delete,
3661 ;; ask the user to confirm now, before doing anything.
3662 ;; But don't actually delete til later.
3664 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3665 (or delete-old-versions
3666 (y-or-n-p (format "Delete excess backup versions of %s? "
3668 (modes (file-modes buffer-file-name))
3669 (context (file-selinux-context buffer-file-name)))
3670 ;; Actually write the back up file.
3672 (if (or file-precious-flag
3673 ; (file-symlink-p buffer-file-name)
3675 ;; Don't rename a suid or sgid file.
3676 (and modes (< 0 (logand modes #o6000)))
3677 (not (file-writable-p (file-name-directory real-file-name)))
3678 (and backup-by-copying-when-linked
3679 (> (file-nlinks real-file-name) 1))
3680 (and (or backup-by-copying-when-mismatch
3681 (integerp backup-by-copying-when-privileged-mismatch))
3682 (let ((attr (file-attributes real-file-name)))
3683 (and (or backup-by-copying-when-mismatch
3684 (and (integerp (nth 2 attr))
3685 (integerp backup-by-copying-when-privileged-mismatch)
3686 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3688 (not (file-ownership-preserved-p real-file-name)))))))
3689 (backup-buffer-copy real-file-name backupname modes context)
3690 ;; rename-file should delete old backup.
3691 (rename-file real-file-name backupname t)
3692 (setq setmodes (list modes context backupname)))
3694 ;; If trouble writing the backup, write it in ~.
3695 (setq backupname (expand-file-name
3696 (convert-standard-filename
3698 (message "Cannot write backup file; backing up in %s"
3701 (backup-buffer-copy real-file-name backupname modes context)))
3702 (setq buffer-backed-up t)
3703 ;; Now delete the old versions, if desired.
3704 (if delete-old-versions
3707 (delete-file (car targets))
3709 (setq targets (cdr targets))))
3711 (file-error nil))))))
3713 (defun backup-buffer-copy (from-name to-name modes context)
3714 (let ((umask (default-file-modes)))
3717 ;; Create temp files with strict access rights. It's easy to
3718 ;; loosen them later, whereas it's impossible to close the
3719 ;; time-window of loose permissions otherwise.
3720 (set-default-file-modes ?\700)
3721 (when (condition-case nil
3722 ;; Try to overwrite old backup first.
3723 (copy-file from-name to-name t t t)
3725 (while (condition-case nil
3727 (when (file-exists-p to-name)
3728 (delete-file to-name))
3729 (copy-file from-name to-name nil t t)
3731 (file-already-exists t))
3732 ;; The file was somehow created by someone else between
3733 ;; `delete-file' and `copy-file', so let's try again.
3734 ;; rms says "I think there is also a possible race
3735 ;; condition for making backup files" (emacs-devel 20070821).
3738 (set-default-file-modes umask)))
3740 (set-file-modes to-name (logand modes #o1777)))
3742 (set-file-selinux-context to-name context)))
3744 (defun file-name-sans-versions (name &optional keep-backup-version)
3745 "Return file NAME sans backup versions or strings.
3746 This is a separate procedure so your site-init or startup file can
3748 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3749 we do not remove backup version numbers, only true file version numbers."
3750 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3752 (funcall handler 'file-name-sans-versions name keep-backup-version)
3754 (if keep-backup-version
3756 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3757 (string-match "~\\'" name)
3760 (defun file-ownership-preserved-p (file)
3761 "Return t if deleting FILE and rewriting it would preserve the owner."
3762 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3764 (funcall handler 'file-ownership-preserved-p file)
3765 (let ((attributes (file-attributes file)))
3766 ;; Return t if the file doesn't exist, since it's true that no
3767 ;; information would be lost by an (attempted) delete and create.
3768 (or (null attributes)
3769 (= (nth 2 attributes) (user-uid)))))))
3771 (defun file-name-sans-extension (filename)
3772 "Return FILENAME sans final \"extension\".
3773 The extension, in a file name, is the part that follows the last `.',
3774 except that a leading `.', if any, doesn't count."
3776 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3778 (if (and (string-match "\\.[^.]*\\'" file)
3779 (not (eq 0 (match-beginning 0))))
3780 (if (setq directory (file-name-directory filename))
3781 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3782 ;; we don't want to expand it.
3783 (concat directory (substring file 0 (match-beginning 0)))
3784 (substring file 0 (match-beginning 0)))
3787 (defun file-name-extension (filename &optional period)
3788 "Return FILENAME's final \"extension\".
3789 The extension, in a file name, is the part that follows the last `.',
3790 excluding version numbers and backup suffixes,
3791 except that a leading `.', if any, doesn't count.
3792 Return nil for extensionless file names such as `foo'.
3793 Return the empty string for file names such as `foo.'.
3795 If PERIOD is non-nil, then the returned value includes the period
3796 that delimits the extension, and if FILENAME has no extension,
3799 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3800 (if (and (string-match "\\.[^.]*\\'" file)
3801 (not (eq 0 (match-beginning 0))))
3802 (substring file (+ (match-beginning 0) (if period 0 1)))
3806 (defcustom make-backup-file-name-function nil
3807 "A function to use instead of the default `make-backup-file-name'.
3808 A value of nil gives the default `make-backup-file-name' behavior.
3810 This could be buffer-local to do something special for specific
3811 files. If you define it, you may need to change `backup-file-name-p'
3812 and `file-name-sans-versions' too.
3814 See also `backup-directory-alist'."
3816 :type '(choice (const :tag "Default" nil)
3817 (function :tag "Your function")))
3819 (defcustom backup-directory-alist nil
3820 "Alist of filename patterns and backup directory names.
3821 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3822 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3823 relative or absolute. If it is absolute, so that all matching files
3824 are backed up into the same directory, the file names in this
3825 directory will be the full name of the file backed up with all
3826 directory separators changed to `!' to prevent clashes. This will not
3827 work correctly if your filesystem truncates the resulting name.
3829 For the common case of all backups going into one directory, the alist
3830 should contain a single element pairing \".\" with the appropriate
3833 If this variable is nil, or it fails to match a filename, the backup
3834 is made in the original file's directory.
3836 On MS-DOS filesystems without long names this variable is always
3839 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3840 (directory :tag "Backup directory name"))))
3842 (defun normal-backup-enable-predicate (name)
3843 "Default `backup-enable-predicate' function.
3844 Checks for files in `temporary-file-directory',
3845 `small-temporary-file-directory', and /tmp."
3846 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3848 ;; Directory is under temporary-file-directory.
3849 (and (not (eq comp t))
3850 (< comp (- (length temporary-file-directory)))))
3851 (let ((comp (compare-strings "/tmp" 0 nil
3853 ;; Directory is under /tmp.
3854 (and (not (eq comp t))
3855 (< comp (- (length "/tmp")))))
3856 (if small-temporary-file-directory
3857 (let ((comp (compare-strings small-temporary-file-directory
3860 ;; Directory is under small-temporary-file-directory.
3861 (and (not (eq comp t))
3862 (< comp (- (length small-temporary-file-directory)))))))))
3864 (defun make-backup-file-name (file)
3865 "Create the non-numeric backup file name for FILE.
3866 Normally this will just be the file's name with `~' appended.
3867 Customization hooks are provided as follows.
3869 If the variable `make-backup-file-name-function' is non-nil, its value
3870 should be a function which will be called with FILE as its argument;
3871 the resulting name is used.
3873 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3874 the documentation of that variable. If the directory for the backup
3875 doesn't exist, it is created."
3876 (if make-backup-file-name-function
3877 (funcall make-backup-file-name-function file)
3878 (if (and (eq system-type 'ms-dos)
3879 (not (msdos-long-file-names)))
3880 (let ((fn (file-name-nondirectory file)))
3881 (concat (file-name-directory file)
3882 (or (and (string-match "\\`[^.]+\\'" fn)
3883 (concat (match-string 0 fn) ".~"))
3884 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3885 (concat (match-string 0 fn) "~")))))
3886 (concat (make-backup-file-name-1 file) "~"))))
3888 (defun make-backup-file-name-1 (file)
3889 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3890 (let ((alist backup-directory-alist)
3891 elt backup-directory abs-backup-directory)
3893 (setq elt (pop alist))
3894 (if (string-match (car elt) file)
3895 (setq backup-directory (cdr elt)
3897 ;; If backup-directory is relative, it should be relative to the
3898 ;; file's directory. By expanding explicitly here, we avoid
3899 ;; depending on default-directory.
3900 (if backup-directory
3901 (setq abs-backup-directory
3902 (expand-file-name backup-directory
3903 (file-name-directory file))))
3904 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3906 (make-directory abs-backup-directory 'parents)
3907 (file-error (setq backup-directory nil
3908 abs-backup-directory nil))))
3909 (if (null backup-directory)
3911 (if (file-name-absolute-p backup-directory)
3913 (when (memq system-type '(windows-nt ms-dos cygwin))
3914 ;; Normalize DOSish file names: downcase the drive
3915 ;; letter, if any, and replace the leading "x:" with
3917 (or (file-name-absolute-p file)
3918 (setq file (expand-file-name file))) ; make defaults explicit
3919 ;; Replace any invalid file-name characters (for the
3920 ;; case of backing up remote files).
3921 (setq file (expand-file-name (convert-standard-filename file)))
3922 (if (eq (aref file 1) ?:)
3923 (setq file (concat "/"
3925 (char-to-string (downcase (aref file 0)))
3926 (if (eq (aref file 2) ?/)
3929 (substring file 2)))))
3930 ;; Make the name unique by substituting directory
3931 ;; separators. It may not really be worth bothering about
3932 ;; doubling `!'s in the original name...
3934 (subst-char-in-string
3936 (replace-regexp-in-string "!" "!!" file))
3938 (expand-file-name (file-name-nondirectory file)
3939 (file-name-as-directory abs-backup-directory))))))
3941 (defun backup-file-name-p (file)
3942 "Return non-nil if FILE is a backup file name (numeric or not).
3943 This is a separate function so you can redefine it for customization.
3944 You may need to redefine `file-name-sans-versions' as well."
3945 (string-match "~\\'" file))
3947 (defvar backup-extract-version-start)
3949 ;; This is used in various files.
3950 ;; The usage of backup-extract-version-start is not very clean,
3951 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3952 (defun backup-extract-version (fn)
3953 "Given the name of a numeric backup file, FN, return the backup number.
3954 Uses the free variable `backup-extract-version-start', whose value should be
3955 the index in the name where the version number begins."
3956 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
3957 (= (match-beginning 0) backup-extract-version-start))
3958 (string-to-number (substring fn backup-extract-version-start -1))
3961 (defun find-backup-file-name (fn)
3962 "Find a file name for a backup file FN, and suggestions for deletions.
3963 Value is a list whose car is the name for the backup file
3964 and whose cdr is a list of old versions to consider deleting now.
3965 If the value is nil, don't make a backup.
3966 Uses `backup-directory-alist' in the same way as does
3967 `make-backup-file-name'."
3968 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3969 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3971 (funcall handler 'find-backup-file-name fn)
3972 (if (or (eq version-control 'never)
3973 ;; We don't support numbered backups on plain MS-DOS
3974 ;; when long file names are unavailable.
3975 (and (eq system-type 'ms-dos)
3976 (not (msdos-long-file-names))))
3977 (list (make-backup-file-name fn))
3978 (let* ((basic-name (make-backup-file-name-1 fn))
3979 (base-versions (concat (file-name-nondirectory basic-name)
3981 (backup-extract-version-start (length base-versions))
3983 (number-to-delete 0)
3984 possibilities deserve-versions-p versions)
3986 (setq possibilities (file-name-all-completions
3988 (file-name-directory basic-name))
3989 versions (sort (mapcar #'backup-extract-version
3992 high-water-mark (apply 'max 0 versions)
3993 deserve-versions-p (or version-control
3994 (> high-water-mark 0))
3995 number-to-delete (- (length versions)
3999 (file-error (setq possibilities nil)))
4000 (if (not deserve-versions-p)
4001 (list (make-backup-file-name fn))
4002 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
4003 (if (and (> number-to-delete 0)
4004 ;; Delete nothing if there is overflow
4005 ;; in the number of versions to keep.
4006 (>= (+ kept-new-versions kept-old-versions -1) 0))
4008 (format "%s.~%d~" basic-name n))
4009 (let ((v (nthcdr kept-old-versions versions)))
4010 (rplacd (nthcdr (1- number-to-delete) v) ())
4013 (defun file-nlinks (filename)
4014 "Return number of names file FILENAME has."
4015 (car (cdr (file-attributes filename))))
4017 ;; (defun file-relative-name (filename &optional directory)
4018 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4019 ;; This function returns a relative file name which is equivalent to FILENAME
4020 ;; when used with that default directory as the default.
4021 ;; If this is impossible (which can happen on MSDOS and Windows
4022 ;; when the file name and directory use different drive names)
4023 ;; then it returns FILENAME."
4025 ;; (let ((fname (expand-file-name filename)))
4026 ;; (setq directory (file-name-as-directory
4027 ;; (expand-file-name (or directory default-directory))))
4028 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4029 ;; ;; drive names, they can't be relative, so return the absolute name.
4030 ;; (if (and (or (eq system-type 'ms-dos)
4031 ;; (eq system-type 'cygwin)
4032 ;; (eq system-type 'windows-nt))
4033 ;; (not (string-equal (substring fname 0 2)
4034 ;; (substring directory 0 2))))
4036 ;; (let ((ancestor ".")
4037 ;; (fname-dir (file-name-as-directory fname)))
4038 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4039 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4040 ;; (setq directory (file-name-directory (substring directory 0 -1))
4041 ;; ancestor (if (equal ancestor ".")
4043 ;; (concat "../" ancestor))))
4044 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4045 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4046 ;; ;; We matched within FNAME's directory part.
4047 ;; ;; Add the rest of FNAME onto ANCESTOR.
4048 ;; (let ((rest (substring fname (match-end 0))))
4049 ;; (if (and (equal ancestor ".")
4050 ;; (not (equal rest "")))
4051 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4053 ;; (concat (file-name-as-directory ancestor) rest)))
4054 ;; ;; We matched FNAME's directory equivalent.
4057 (defun file-relative-name (filename &optional directory)
4058 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4059 This function returns a relative file name which is equivalent to FILENAME
4060 when used with that default directory as the default.
4061 If FILENAME and DIRECTORY lie on different machines or on different drives
4062 on a DOS/Windows machine, it returns FILENAME in expanded form."
4065 (file-name-as-directory (expand-file-name (or directory
4066 default-directory))))
4067 (setq filename (expand-file-name filename))
4068 (let ((fremote (file-remote-p filename))
4069 (dremote (file-remote-p directory)))
4070 (if ;; Conditions for separate trees
4072 ;; Test for different drives on DOS/Windows
4074 ;; Should `cygwin' really be included here? --stef
4075 (memq system-type '(ms-dos cygwin windows-nt))
4076 (not (eq t (compare-strings filename 0 2 directory 0 2))))
4077 ;; Test for different remote file system identification
4078 (not (equal fremote dremote)))
4080 (let ((ancestor ".")
4081 (filename-dir (file-name-as-directory filename)))
4084 (eq t (compare-strings filename-dir nil (length directory)
4085 directory nil nil case-fold-search))
4086 (eq t (compare-strings filename nil (length directory)
4087 directory nil nil case-fold-search))))
4088 (setq directory (file-name-directory (substring directory 0 -1))
4089 ancestor (if (equal ancestor ".")
4091 (concat "../" ancestor))))
4092 ;; Now ancestor is empty, or .., or ../.., etc.
4093 (if (eq t (compare-strings filename nil (length directory)
4094 directory nil nil case-fold-search))
4095 ;; We matched within FILENAME's directory part.
4096 ;; Add the rest of FILENAME onto ANCESTOR.
4097 (let ((rest (substring filename (length directory))))
4098 (if (and (equal ancestor ".") (not (equal rest "")))
4099 ;; But don't bother with ANCESTOR if it would give us `./'.
4101 (concat (file-name-as-directory ancestor) rest)))
4102 ;; We matched FILENAME's directory equivalent.
4105 (defun save-buffer (&optional args)
4106 "Save current buffer in visited file if modified.
4107 Variations are described below.
4109 By default, makes the previous version into a backup file
4110 if previously requested or if this is the first save.
4111 Prefixed with one \\[universal-argument], marks this version
4112 to become a backup when the next save is done.
4113 Prefixed with two \\[universal-argument]'s,
4114 unconditionally makes the previous version into a backup file.
4115 Prefixed with three \\[universal-argument]'s, marks this version
4116 to become a backup when the next save is done,
4117 and unconditionally makes the previous version into a backup file.
4119 With a numeric argument of 0, never make the previous version
4122 If a file's name is FOO, the names of its numbered backup versions are
4123 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4124 Numeric backups (rather than FOO~) will be made if value of
4125 `version-control' is not the atom `never' and either there are already
4126 numeric versions of the file being backed up, or `version-control' is
4128 We don't want excessive versions piling up, so there are variables
4129 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4130 and `kept-new-versions', which tells how many newest versions to keep.
4131 Defaults are 2 old versions and 2 new.
4132 `dired-kept-versions' controls dired's clean-directory (.) command.
4133 If `delete-old-versions' is nil, system will query user
4134 before trimming versions. Otherwise it does it silently.
4136 If `vc-make-backup-files' is nil, which is the default,
4137 no backup files are made for files managed by version control.
4138 (This is because the version control system itself records previous versions.)
4140 See the subroutine `basic-save-buffer' for more information."
4142 (let ((modp (buffer-modified-p))
4143 (make-backup-files (or (and make-backup-files (not (eq args 0)))
4144 (memq args '(16 64)))))
4145 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
4146 ;; We used to display the message below only for files > 50KB, but
4147 ;; then Rmail-mbox never displays it due to buffer swapping. If
4148 ;; the test is ever re-introduced, be sure to handle saving of
4150 (if (and modp (buffer-file-name))
4151 (message "Saving file %s..." (buffer-file-name)))
4153 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
4155 (defun delete-auto-save-file-if-necessary (&optional force)
4156 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4157 Normally delete only if the file was written by this Emacs since
4158 the last real save, but optional arg FORCE non-nil means delete anyway."
4159 (and buffer-auto-save-file-name delete-auto-save-files
4160 (not (string= buffer-file-name buffer-auto-save-file-name))
4161 (or force (recent-auto-save-p))
4164 (delete-file buffer-auto-save-file-name)
4166 (set-buffer-auto-saved))))
4168 (defvar auto-save-hook nil
4169 "Normal hook run just before auto-saving.")
4171 (defcustom before-save-hook nil
4172 "Normal hook that is run before a buffer is saved to its file."
4173 :options '(copyright-update time-stamp)
4177 (defcustom after-save-hook nil
4178 "Normal hook that is run after a buffer is saved to its file."
4179 :options '(executable-make-buffer-file-executable-if-script-p)
4183 (defvar save-buffer-coding-system nil
4184 "If non-nil, use this coding system for saving the buffer.
4185 More precisely, use this coding system in place of the
4186 value of `buffer-file-coding-system', when saving the buffer.
4187 Calling `write-region' for any purpose other than saving the buffer
4188 will still use `buffer-file-coding-system'; this variable has no effect
4191 (make-variable-buffer-local 'save-buffer-coding-system)
4192 (put 'save-buffer-coding-system 'permanent-local t)
4194 (defun basic-save-buffer ()
4195 "Save the current buffer in its visited file, if it has been modified.
4196 The hooks `write-contents-functions' and `write-file-functions' get a chance
4197 to do the job of saving; if they do not, then the buffer is saved in
4198 the visited file in the usual way.
4199 Before and after saving the buffer, this function runs
4200 `before-save-hook' and `after-save-hook', respectively."
4202 (save-current-buffer
4203 ;; In an indirect buffer, save its base buffer instead.
4204 (if (buffer-base-buffer)
4205 (set-buffer (buffer-base-buffer)))
4206 (if (buffer-modified-p)
4207 (let ((recent-save (recent-auto-save-p))
4209 ;; If buffer has no file name, ask user for one.
4210 (or buffer-file-name
4213 (read-file-name "File to save in: ") nil)))
4214 (if (file-exists-p filename)
4215 (if (file-directory-p filename)
4216 ;; Signal an error if the user specified the name of an
4217 ;; existing directory.
4218 (error "%s is a directory" filename)
4219 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4221 (error "Canceled")))
4222 ;; Signal an error if the specified name refers to a
4223 ;; non-existing directory.
4224 (let ((dir (file-name-directory filename)))
4225 (unless (file-directory-p dir)
4226 (if (file-exists-p dir)
4227 (error "%s is not a directory" dir)
4228 (error "%s: no such directory" dir)))))
4229 (set-visited-file-name filename)))
4230 (or (verify-visited-file-modtime (current-buffer))
4231 (not (file-exists-p buffer-file-name))
4233 (format "%s has changed since visited or saved. Save anyway? "
4234 (file-name-nondirectory buffer-file-name)))
4235 (error "Save not confirmed"))
4239 (and (> (point-max) (point-min))
4240 (not find-file-literally)
4241 (/= (char-after (1- (point-max))) ?\n)
4242 (not (and (eq selective-display t)
4243 (= (char-after (1- (point-max))) ?\r)))
4244 (or (eq require-final-newline t)
4245 (eq require-final-newline 'visit-save)
4246 (and require-final-newline
4248 (format "Buffer %s does not end in newline. Add one? "
4251 (goto-char (point-max))
4253 ;; Support VC version backups.
4255 (run-hooks 'before-save-hook)
4256 (or (run-hook-with-args-until-success 'write-contents-functions)
4257 (run-hook-with-args-until-success 'local-write-file-hooks)
4258 (run-hook-with-args-until-success 'write-file-functions)
4259 ;; If a hook returned t, file is already "written".
4260 ;; Otherwise, write it the usual way now.
4261 (setq setmodes (basic-save-buffer-1)))
4262 ;; Now we have saved the current buffer. Let's make sure
4263 ;; that buffer-file-coding-system is fixed to what
4264 ;; actually used for saving by binding it locally.
4265 (if save-buffer-coding-system
4266 (setq save-buffer-coding-system last-coding-system-used)
4267 (setq buffer-file-coding-system last-coding-system-used))
4268 (setq buffer-file-number
4269 (nthcdr 10 (file-attributes buffer-file-name)))
4273 (set-file-modes buffer-file-name (car setmodes))
4274 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))
4276 ;; If the auto-save file was recent before this command,
4278 (delete-auto-save-file-if-necessary recent-save)
4279 ;; Support VC `implicit' locking.
4281 (run-hooks 'after-save-hook))
4282 (message "(No changes need to be saved)"))))
4284 ;; This does the "real job" of writing a buffer into its visited file
4285 ;; and making a backup file. This is what is normally done
4286 ;; but inhibited if one of write-file-functions returns non-nil.
4287 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4288 (defun basic-save-buffer-1 ()
4290 (if save-buffer-coding-system
4291 (let ((coding-system-for-write save-buffer-coding-system))
4292 (basic-save-buffer-2))
4293 (basic-save-buffer-2))
4294 (if buffer-file-coding-system-explicit
4295 (setcar buffer-file-coding-system-explicit last-coding-system-used)
4296 (setq buffer-file-coding-system-explicit
4297 (cons last-coding-system-used nil)))))
4299 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4300 (defun basic-save-buffer-2 ()
4301 (let (tempsetmodes setmodes)
4302 (if (not (file-writable-p buffer-file-name))
4303 (let ((dir (file-name-directory buffer-file-name)))
4304 (if (not (file-directory-p dir))
4305 (if (file-exists-p dir)
4306 (error "%s is not a directory" dir)
4307 (error "%s: no such directory" dir))
4308 (if (not (file-exists-p buffer-file-name))
4309 (error "Directory %s write-protected" dir)
4311 (format "File %s is write-protected; try to save anyway? "
4312 (file-name-nondirectory
4314 (setq tempsetmodes t)
4315 (error "Attempt to save to a file which you aren't allowed to write"))))))
4316 (or buffer-backed-up
4317 (setq setmodes (backup-buffer)))
4318 (let* ((dir (file-name-directory buffer-file-name))
4319 (dir-writable (file-writable-p dir)))
4320 (if (or (and file-precious-flag dir-writable)
4321 (and break-hardlink-on-save
4322 (> (file-nlinks buffer-file-name) 1)
4324 (error (concat (format
4325 "Directory %s write-protected; " dir)
4326 "cannot break hardlink when saving")))))
4327 ;; Write temp name, then rename it.
4328 ;; This requires write access to the containing dir,
4329 ;; which is why we don't try it if we don't have that access.
4330 (let ((realname buffer-file-name)
4332 (umask (default-file-modes))
4333 (old-modtime (visited-file-modtime)))
4334 ;; Create temp files with strict access rights. It's easy to
4335 ;; loosen them later, whereas it's impossible to close the
4336 ;; time-window of loose permissions otherwise.
4339 (clear-visited-file-modtime)
4340 (set-default-file-modes ?\700)
4341 ;; Try various temporary names.
4342 ;; This code follows the example of make-temp-file,
4343 ;; but it calls write-region in the appropriate way
4344 ;; for saving the buffer.
4345 (while (condition-case ()
4349 (expand-file-name "tmp" dir)))
4350 ;; Pass in nil&nil rather than point-min&max
4351 ;; cause we're saving the whole buffer.
4352 ;; write-region-annotate-functions may use it.
4353 (write-region nil nil
4354 tempname nil realname
4355 buffer-file-truename 'excl)
4357 (file-already-exists t))
4358 ;; The file was somehow created by someone else between
4359 ;; `make-temp-name' and `write-region', let's try again.
4363 (set-default-file-modes umask)
4364 ;; If we failed, restore the buffer's modtime.
4366 (set-visited-file-modtime old-modtime)))
4367 ;; Since we have created an entirely new file,
4368 ;; make sure it gets the right permission bits set.
4369 (setq setmodes (or setmodes
4370 (list (or (file-modes buffer-file-name)
4371 (logand ?\666 umask))
4372 (file-selinux-context buffer-file-name)
4374 ;; We succeeded in writing the temp file,
4376 (rename-file tempname buffer-file-name t))
4377 ;; If file not writable, see if we can make it writable
4378 ;; temporarily while we write it.
4379 ;; But no need to do so if we have just backed it up
4380 ;; (setmodes is set) because that says we're superseding.
4381 (cond ((and tempsetmodes (not setmodes))
4382 ;; Change the mode back, after writing.
4383 (setq setmodes (list (file-modes buffer-file-name)
4384 (file-selinux-context buffer-file-name)
4386 (set-file-modes buffer-file-name (logior (car setmodes) 128))
4387 (set-file-selinux-context buffer-file-name (nth 1 setmodes)))))
4391 ;; Pass in nil&nil rather than point-min&max to indicate
4392 ;; we're saving the buffer rather than just a region.
4393 ;; write-region-annotate-functions may make us of it.
4394 (write-region nil nil
4395 buffer-file-name nil t buffer-file-truename)
4397 ;; If we get an error writing the new file, and we made
4398 ;; the backup by renaming, undo the backing-up.
4399 (and setmodes (not success)
4401 (rename-file (nth 2 setmodes) buffer-file-name t)
4402 (setq buffer-backed-up nil))))))
4405 (defun diff-buffer-with-file (&optional buffer)
4406 "View the differences between BUFFER and its associated file.
4407 This requires the external program `diff' to be in your `exec-path'."
4408 (interactive "bBuffer: ")
4409 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4410 (if (and buffer-file-name
4411 (file-exists-p buffer-file-name))
4412 (let ((tempfile (make-temp-file "buffer-content-")))
4415 (write-region nil nil tempfile nil 'nomessage)
4416 (diff buffer-file-name tempfile nil t)
4418 (when (file-exists-p tempfile)
4419 (delete-file tempfile))))
4420 (message "Buffer %s has no associated file on disc" (buffer-name))
4421 ;; Display that message for 1 second so that user can read it
4422 ;; in the minibuffer.
4424 ;; return always nil, so that save-buffers-kill-emacs will not move
4425 ;; over to the next unsaved buffer when calling `d'.
4428 (defvar save-some-buffers-action-alist
4431 (if (not enable-recursive-minibuffers)
4432 (progn (display-buffer buf)
4433 (setq other-window-scroll-buffer buf))
4434 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4436 ;; Return nil to ask about BUF again.
4438 ,(purecopy "view this buffer"))
4440 (if (null (buffer-file-name buf))
4441 (message "Not applicable: no file")
4442 (save-window-excursion (diff-buffer-with-file buf))
4443 (if (not enable-recursive-minibuffers)
4444 (progn (display-buffer (get-buffer-create "*Diff*"))
4445 (setq other-window-scroll-buffer "*Diff*"))
4446 (view-buffer (get-buffer-create "*Diff*")
4447 (lambda (_) (exit-recursive-edit)))
4449 ;; Return nil to ask about BUF again.
4451 ,(purecopy "view changes in this buffer")))
4452 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4453 (put 'save-some-buffers-action-alist 'risky-local-variable t)
4455 (defvar buffer-save-without-query nil
4456 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4457 (make-variable-buffer-local 'buffer-save-without-query)
4459 (defun save-some-buffers (&optional arg pred)
4460 "Save some modified file-visiting buffers. Asks user about each one.
4461 You can answer `y' to save, `n' not to save, `C-r' to look at the
4462 buffer in question with `view-buffer' before deciding or `d' to
4463 view the differences using `diff-buffer-with-file'.
4465 Optional argument (the prefix) non-nil means save all with no questions.
4466 Optional second argument PRED determines which buffers are considered:
4467 If PRED is nil, all the file-visiting buffers are considered.
4468 If PRED is t, then certain non-file buffers will also be considered.
4469 If PRED is a zero-argument function, it indicates for each buffer whether
4470 to consider it or not when called with that buffer current.
4472 See `save-some-buffers-action-alist' if you want to
4473 change the additional actions you can take on files."
4475 (save-window-excursion
4476 (let* (queried some-automatic
4477 files-done abbrevs-done)
4478 (dolist (buffer (buffer-list))
4479 ;; First save any buffers that we're supposed to save unconditionally.
4480 ;; That way the following code won't ask about them.
4481 (with-current-buffer buffer
4482 (when (and buffer-save-without-query (buffer-modified-p))
4483 (setq some-automatic t)
4485 ;; Ask about those buffers that merit it,
4486 ;; and record the number thus saved.
4490 ;; Note that killing some buffers may kill others via
4491 ;; hooks (e.g. Rmail and its viewing buffer).
4492 (and (buffer-live-p buffer)
4493 (buffer-modified-p buffer)
4494 (not (buffer-base-buffer buffer))
4496 (buffer-file-name buffer)
4500 (and buffer-offer-save (> (buffer-size) 0)))))
4501 (or (not (functionp pred))
4502 (with-current-buffer buffer (funcall pred)))
4506 (if (buffer-file-name buffer)
4507 (format "Save file %s? "
4508 (buffer-file-name buffer))
4509 (format "Save buffer %s? "
4510 (buffer-name buffer))))))
4512 (with-current-buffer buffer
4515 '("buffer" "buffers" "save")
4516 save-some-buffers-action-alist))
4517 ;; Maybe to save abbrevs, and record whether
4518 ;; we either saved them or asked to.
4519 (and save-abbrevs abbrevs-changed
4522 (eq save-abbrevs 'silently)
4523 (y-or-n-p (format "Save abbrevs in %s? "
4525 (write-abbrev-file nil))
4526 ;; Don't keep bothering user if he says no.
4527 (setq abbrevs-changed nil)
4528 (setq abbrevs-done t)))
4529 (or queried (> files-done 0) abbrevs-done
4530 (message (if some-automatic
4531 "(Some special files were saved without asking)"
4532 "(No files need saving)"))))))
4534 (defun not-modified (&optional arg)
4535 "Mark current buffer as unmodified, not needing to be saved.
4536 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4538 It is not a good idea to use this function in Lisp programs, because it
4539 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4541 (message (if arg "Modification-flag set"
4542 "Modification-flag cleared"))
4543 (set-buffer-modified-p arg))
4545 (defun toggle-read-only (&optional arg)
4546 "Change whether this buffer is read-only.
4547 With prefix argument ARG, make the buffer read-only if ARG is
4548 positive, otherwise make it writable. If buffer is read-only
4549 and `view-read-only' is non-nil, enter view mode."
4552 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4553 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4557 ((and buffer-read-only view-mode)
4558 (View-exit-and-edit)
4559 (make-local-variable 'view-read-only)
4560 (setq view-read-only t)) ; Must leave view mode.
4561 ((and (not buffer-read-only) view-read-only
4562 ;; If view-mode is already active, `view-mode-enter' is a nop.
4564 (not (eq (get major-mode 'mode-class) 'special)))
4566 (t (setq buffer-read-only (not buffer-read-only))
4567 (force-mode-line-update)))
4568 (if (vc-backend buffer-file-name)
4569 (message "%s" (substitute-command-keys
4570 (concat "File is under version-control; "
4571 "use \\[vc-next-action] to check in/out"))))))
4573 (defun insert-file (filename)
4574 "Insert contents of file FILENAME into buffer after point.
4575 Set mark after the inserted text.
4577 This function is meant for the user to run interactively.
4578 Don't call it from programs! Use `insert-file-contents' instead.
4579 \(Its calling sequence is different; see its documentation)."
4580 (interactive "*fInsert file: ")
4581 (insert-file-1 filename #'insert-file-contents))
4583 (defun append-to-file (start end filename)
4584 "Append the contents of the region to the end of file FILENAME.
4585 When called from a function, expects three arguments,
4586 START, END and FILENAME. START and END are normally buffer positions
4587 specifying the part of the buffer to write.
4588 If START is nil, that means to use the entire buffer contents.
4589 If START is a string, then output that string to the file
4590 instead of any buffer contents; END is ignored.
4592 This does character code conversion and applies annotations
4593 like `write-region' does."
4594 (interactive "r\nFAppend to file: ")
4595 (write-region start end filename t))
4597 (defun file-newest-backup (filename)
4598 "Return most recent backup file for FILENAME or nil if no backups exist."
4599 ;; `make-backup-file-name' will get us the right directory for
4600 ;; ordinary or numeric backups. It might create a directory for
4601 ;; backups as a side-effect, according to `backup-directory-alist'.
4602 (let* ((filename (file-name-sans-versions
4603 (make-backup-file-name (expand-file-name filename))))
4604 (file (file-name-nondirectory filename))
4605 (dir (file-name-directory filename))
4606 (comp (file-name-all-completions file dir))
4610 (setq tem (pop comp))
4611 (cond ((and (backup-file-name-p tem)
4612 (string= (file-name-sans-versions tem) file))
4613 (setq tem (concat dir tem))
4614 (if (or (null newest)
4615 (file-newer-than-file-p tem newest))
4616 (setq newest tem)))))
4619 (defun rename-uniquely ()
4620 "Rename current buffer to a similar name not already taken.
4621 This function is useful for creating multiple shell process buffers
4622 or multiple mail buffers, etc."
4625 (let ((base-name (buffer-name)))
4626 (and (string-match "<[0-9]+>\\'" base-name)
4627 (not (and buffer-file-name
4629 (file-name-nondirectory buffer-file-name))))
4630 ;; If the existing buffer name has a <NNN>,
4631 ;; which isn't part of the file name (if any),
4632 ;; then get rid of that.
4633 (setq base-name (substring base-name 0 (match-beginning 0))))
4634 (rename-buffer (generate-new-buffer-name base-name))
4635 (force-mode-line-update))))
4637 (defun make-directory (dir &optional parents)
4638 "Create the directory DIR and any nonexistent parent dirs.
4639 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4641 Interactively, the default choice of directory to create
4642 is the current default directory for file names.
4643 That is useful when you have visited a file in a nonexistent directory.
4645 Noninteractively, the second (optional) argument PARENTS says whether
4646 to create parent directories if they don't exist. Interactively,
4647 this happens by default."
4649 (list (read-file-name "Make directory: " default-directory default-directory
4652 ;; If default-directory is a remote directory,
4653 ;; make sure we find its make-directory handler.
4654 (setq dir (expand-file-name dir))
4655 (let ((handler (find-file-name-handler dir 'make-directory)))
4657 (funcall handler 'make-directory dir parents)
4659 (make-directory-internal dir)
4660 (let ((dir (directory-file-name (expand-file-name dir)))
4662 (while (and (not (file-exists-p dir))
4663 ;; If directory is its own parent, then we can't
4664 ;; keep looping forever
4666 (directory-file-name
4667 (file-name-directory dir)))))
4668 (setq create-list (cons dir create-list)
4669 dir (directory-file-name (file-name-directory dir))))
4671 (make-directory-internal (car create-list))
4672 (setq create-list (cdr create-list))))))))
4674 (defconst directory-files-no-dot-files-regexp
4675 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4676 "Regexp matching any file name except \".\" and \"..\".")
4678 (defun delete-directory (directory &optional recursive trash)
4679 "Delete the directory named DIRECTORY. Does not follow symlinks.
4680 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4681 TRASH non-nil means to trash the directory instead, provided
4682 `delete-by-moving-to-trash' is non-nil.
4684 When called interactively, TRASH is t if no prefix argument is
4685 given. With a prefix argument, TRASH is nil."
4687 (let* ((trashing (and delete-by-moving-to-trash
4688 (null current-prefix-arg)))
4689 (dir (expand-file-name
4692 "Move directory to trash: "
4693 "Delete directory: ")
4694 default-directory default-directory nil nil))))
4696 (if (directory-files dir nil directory-files-no-dot-files-regexp)
4698 (format "Directory `%s' is not empty, really %s? "
4699 dir (if trashing "trash" "delete")))
4701 (null current-prefix-arg))))
4702 ;; If default-directory is a remote directory, make sure we find its
4703 ;; delete-directory handler.
4704 (setq directory (directory-file-name (expand-file-name directory)))
4705 (let ((handler (find-file-name-handler directory 'delete-directory)))
4708 (funcall handler 'delete-directory directory recursive))
4709 ((and delete-by-moving-to-trash trash)
4710 ;; Only move non-empty dir to trash if recursive deletion was
4711 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4712 ;; case, where the operation fails in delete-directory-internal.
4713 ;; As `move-file-to-trash' trashes directories (empty or
4714 ;; otherwise) as a unit, we do not need to recurse here.
4715 (if (and (not recursive)
4716 ;; Check if directory is empty apart from "." and "..".
4718 directory 'full directory-files-no-dot-files-regexp))
4719 (error "Directory is not empty, not moving to trash")
4720 (move-file-to-trash directory)))
4721 ;; Otherwise, call outselves recursively if needed.
4723 (if (and recursive (not (file-symlink-p directory)))
4724 (mapc (lambda (file)
4725 ;; This test is equivalent to
4726 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4727 ;; but more efficient
4728 (if (eq t (car (file-attributes file)))
4729 (delete-directory file recursive nil)
4730 (delete-file file nil)))
4731 ;; We do not want to delete "." and "..".
4733 directory 'full directory-files-no-dot-files-regexp)))
4734 (delete-directory-internal directory)))))
4736 (defun copy-directory (directory newname &optional keep-time parents)
4737 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4738 If NEWNAME names an existing directory, copy DIRECTORY as subdirectory there.
4740 This function always sets the file modes of the output files to match
4741 the corresponding input file.
4743 The third arg KEEP-TIME non-nil means give the output files the same
4744 last-modified time as the old ones. (This works on only some systems.)
4746 A prefix arg makes KEEP-TIME non-nil.
4748 Noninteractively, the last argument PARENTS says whether to
4749 create parent directories if they don't exist. Interactively,
4750 this happens by default."
4752 (let ((dir (read-directory-name
4753 "Copy directory: " default-directory default-directory t nil)))
4756 (format "Copy directory %s to: " dir)
4757 default-directory default-directory nil nil)
4758 current-prefix-arg t)))
4759 ;; If default-directory is a remote directory, make sure we find its
4760 ;; copy-directory handler.
4761 (let ((handler (or (find-file-name-handler directory 'copy-directory)
4762 (find-file-name-handler newname 'copy-directory))))
4764 (funcall handler 'copy-directory directory newname keep-time parents)
4766 ;; Compute target name.
4767 (setq directory (directory-file-name (expand-file-name directory))
4768 newname (directory-file-name (expand-file-name newname)))
4769 (if (not (file-directory-p newname)) (make-directory newname parents))
4771 ;; Copy recursively.
4774 (let ((target (expand-file-name
4775 (file-name-nondirectory file) newname))
4776 (attrs (file-attributes file)))
4777 (cond ((file-directory-p file)
4778 (copy-directory file target keep-time parents))
4779 ((stringp (car attrs)) ; Symbolic link
4780 (make-symbolic-link (car attrs) target t))
4782 (copy-file file target t keep-time)))))
4783 ;; We do not want to copy "." and "..".
4784 (directory-files directory 'full directory-files-no-dot-files-regexp))
4786 ;; Set directory attributes.
4787 (set-file-modes newname (file-modes directory))
4789 (set-file-times newname (nth 5 (file-attributes directory)))))))
4791 (put 'revert-buffer-function 'permanent-local t)
4792 (defvar revert-buffer-function nil
4793 "Function to use to revert this buffer, or nil to do the default.
4794 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4795 which are the arguments that `revert-buffer' received.")
4797 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4798 (defvar revert-buffer-insert-file-contents-function nil
4799 "Function to use to insert contents when reverting this buffer.
4800 Gets two args, first the nominal file name to use,
4801 and second, t if reading the auto-save file.
4803 The function you specify is responsible for updating (or preserving) point.")
4805 (defvar buffer-stale-function nil
4806 "Function to check whether a non-file buffer needs reverting.
4807 This should be a function with one optional argument NOCONFIRM.
4808 Auto Revert Mode passes t for NOCONFIRM. The function should return
4809 non-nil if the buffer should be reverted. A return value of
4810 `fast' means that the need for reverting was not checked, but
4811 that reverting the buffer is fast. The buffer is current when
4812 this function is called.
4814 The idea behind the NOCONFIRM argument is that it should be
4815 non-nil if the buffer is going to be reverted without asking the
4816 user. In such situations, one has to be careful with potentially
4817 time consuming operations.
4819 For more information on how this variable is used by Auto Revert mode,
4820 see Info node `(emacs)Supporting additional buffers'.")
4822 (defvar before-revert-hook nil
4823 "Normal hook for `revert-buffer' to run before reverting.
4824 If `revert-buffer-function' is used to override the normal revert
4825 mechanism, this hook is not used.")
4827 (defvar after-revert-hook nil
4828 "Normal hook for `revert-buffer' to run after reverting.
4829 Note that the hook value that it runs is the value that was in effect
4830 before reverting; that makes a difference if you have buffer-local
4833 If `revert-buffer-function' is used to override the normal revert
4834 mechanism, this hook is not used.")
4836 (defvar revert-buffer-internal-hook)
4838 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4839 "Replace current buffer text with the text of the visited file on disk.
4840 This undoes all changes since the file was visited or saved.
4841 With a prefix argument, offer to revert from latest auto-save file, if
4842 that is more recent than the visited file.
4844 This command also implements an interface for special buffers
4845 that contain text which doesn't come from a file, but reflects
4846 some other data instead (e.g. Dired buffers, `buffer-list'
4847 buffers). This is done via the variable `revert-buffer-function'.
4848 In these cases, it should reconstruct the buffer contents from the
4851 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4852 to revert from the auto-save file when this is nil. Note that the
4853 sense of this argument is the reverse of the prefix argument, for the
4854 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4857 Optional second argument NOCONFIRM means don't ask for confirmation
4858 at all. \(The variable `revert-without-query' offers another way to
4859 revert buffers without querying for confirmation.)
4861 Optional third argument PRESERVE-MODES non-nil means don't alter
4862 the files modes. Normally we reinitialize them using `normal-mode'.
4864 If the value of `revert-buffer-function' is non-nil, it is called to
4865 do all the work for this command. Otherwise, the hooks
4866 `before-revert-hook' and `after-revert-hook' are run at the beginning
4867 and the end, and if `revert-buffer-insert-file-contents-function' is
4868 non-nil, it is called instead of rereading visited file contents."
4870 ;; I admit it's odd to reverse the sense of the prefix argument, but
4871 ;; there is a lot of code out there which assumes that the first
4872 ;; argument should be t to avoid consulting the auto-save file, and
4873 ;; there's no straightforward way to encourage authors to notice a
4874 ;; reversal of the argument sense. So I'm just changing the user
4875 ;; interface, but leaving the programmatic interface the same.
4876 (interactive (list (not current-prefix-arg)))
4877 (if revert-buffer-function
4878 (funcall revert-buffer-function ignore-auto noconfirm)
4879 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4881 (let* ((auto-save-p (and (not ignore-auto)
4882 (recent-auto-save-p)
4883 buffer-auto-save-file-name
4884 (file-readable-p buffer-auto-save-file-name)
4886 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4887 (file-name (if auto-save-p
4888 buffer-auto-save-file-name
4890 (cond ((null file-name)
4891 (error "Buffer does not seem to be associated with any file"))
4893 (and (not (buffer-modified-p))
4895 (dolist (regexp revert-without-query)
4896 (when (string-match regexp file-name)
4897 (throw 'found t)))))
4898 (yes-or-no-p (format "Revert buffer from file %s? "
4900 (run-hooks 'before-revert-hook)
4901 ;; If file was backed up but has changed since,
4902 ;; we should make another backup.
4903 (and (not auto-save-p)
4904 (not (verify-visited-file-modtime (current-buffer)))
4905 (setq buffer-backed-up nil))
4906 ;; Effectively copy the after-revert-hook status,
4907 ;; since after-find-file will clobber it.
4908 (let ((global-hook (default-value 'after-revert-hook))
4909 (local-hook (when (local-variable-p 'after-revert-hook)
4911 (inhibit-read-only t))
4913 (revert-buffer-insert-file-contents-function
4914 (unless (eq buffer-undo-list t)
4915 ;; Get rid of all undo records for this buffer.
4916 (setq buffer-undo-list nil))
4917 ;; Don't make undo records for the reversion.
4918 (let ((buffer-undo-list t))
4919 (funcall revert-buffer-insert-file-contents-function
4920 file-name auto-save-p)))
4921 ((not (file-exists-p file-name))
4922 (error (if buffer-file-number
4923 "File %s no longer exists!"
4924 "Cannot revert nonexistent file %s")
4926 ((not (file-readable-p file-name))
4927 (error (if buffer-file-number
4928 "File %s no longer readable!"
4929 "Cannot revert unreadable file %s")
4932 ;; Bind buffer-file-name to nil
4933 ;; so that we don't try to lock the file.
4934 (let ((buffer-file-name nil))
4938 (let ((coding-system-for-read
4939 ;; Auto-saved file should be read by Emacs'
4941 (if auto-save-p 'auto-save-coding
4942 (or coding-system-for-read
4944 buffer-file-coding-system-explicit
4945 (car buffer-file-coding-system-explicit))))))
4946 (if (and (not enable-multibyte-characters)
4947 coding-system-for-read
4948 (not (memq (coding-system-base
4949 coding-system-for-read)
4950 '(no-conversion raw-text))))
4951 ;; As a coding system suitable for multibyte
4952 ;; buffer is specified, make the current
4953 ;; buffer multibyte.
4954 (set-buffer-multibyte t))
4956 ;; This force after-insert-file-set-coding
4957 ;; (called from insert-file-contents) to set
4958 ;; buffer-file-coding-system to a proper value.
4959 (kill-local-variable 'buffer-file-coding-system)
4961 ;; Note that this preserves point in an intelligent way.
4963 (let ((buffer-file-format buffer-file-format))
4964 (insert-file-contents file-name (not auto-save-p)
4966 (insert-file-contents file-name (not auto-save-p)
4968 ;; Recompute the truename in case changes in symlinks
4969 ;; have changed the truename.
4970 (setq buffer-file-truename
4971 (abbreviate-file-name (file-truename buffer-file-name)))
4972 (after-find-file nil nil t t preserve-modes)
4973 ;; Run after-revert-hook as it was before we reverted.
4974 (setq-default revert-buffer-internal-hook global-hook)
4976 (set (make-local-variable 'revert-buffer-internal-hook)
4978 (kill-local-variable 'revert-buffer-internal-hook))
4979 (run-hooks 'revert-buffer-internal-hook))
4982 (defun recover-this-file ()
4983 "Recover the visited file--get contents from its last auto-save file."
4985 (recover-file buffer-file-name))
4987 (defun recover-file (file)
4988 "Visit file FILE, but get contents from its last auto-save file."
4989 ;; Actually putting the file name in the minibuffer should be used
4991 ;; Not just because users often use the default.
4992 (interactive "FRecover file: ")
4993 (setq file (expand-file-name file))
4994 (if (auto-save-file-name-p (file-name-nondirectory file))
4995 (error "%s is an auto-save file" (abbreviate-file-name file)))
4996 (let ((file-name (let ((buffer-file-name file))
4997 (make-auto-save-file-name))))
4998 (cond ((if (file-exists-p file)
4999 (not (file-newer-than-file-p file-name file))
5000 (not (file-exists-p file-name)))
5001 (error "Auto-save file %s not current"
5002 (abbreviate-file-name file-name)))
5003 ((save-window-excursion
5004 (with-output-to-temp-buffer "*Directory*"
5005 (buffer-disable-undo standard-output)
5007 (let ((switches dired-listing-switches))
5008 (if (file-symlink-p file)
5009 (setq switches (concat switches "L")))
5010 (set-buffer standard-output)
5011 ;; Use insert-directory-safely, not insert-directory,
5012 ;; because these files might not exist. In particular,
5013 ;; FILE might not exist if the auto-save file was for
5014 ;; a buffer that didn't visit a file, such as "*mail*".
5015 ;; The code in v20.x called `ls' directly, so we need
5016 ;; to emulate what `ls' did in that case.
5017 (insert-directory-safely file switches)
5018 (insert-directory-safely file-name switches))))
5019 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
5020 (switch-to-buffer (find-file-noselect file t))
5021 (let ((inhibit-read-only t)
5022 ;; Keep the current buffer-file-coding-system.
5023 (coding-system buffer-file-coding-system)
5024 ;; Auto-saved file should be read with special coding.
5025 (coding-system-for-read 'auto-save-coding))
5027 (insert-file-contents file-name nil)
5028 (set-buffer-file-coding-system coding-system))
5029 (after-find-file nil nil t))
5030 (t (error "Recover-file cancelled")))))
5032 (defun recover-session ()
5033 "Recover auto save files from a previous Emacs session.
5034 This command first displays a Dired buffer showing you the
5035 previous sessions that you could recover from.
5036 To choose one, move point to the proper line and then type C-c C-c.
5037 Then you'll be asked about a number of files to recover."
5039 (if (null auto-save-list-file-prefix)
5040 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5041 (let ((dir (file-name-directory auto-save-list-file-prefix)))
5042 (unless (file-directory-p dir)
5043 (make-directory dir t))
5044 (unless (directory-files dir nil
5045 (concat "\\`" (regexp-quote
5046 (file-name-nondirectory
5047 auto-save-list-file-prefix)))
5049 (error "No previous sessions to recover")))
5050 (let ((ls-lisp-support-shell-wildcards t))
5051 (dired (concat auto-save-list-file-prefix "*")
5052 (concat dired-listing-switches "t")))
5054 (goto-char (point-min))
5055 (or (looking-at " Move to the session you want to recover,")
5056 (let ((inhibit-read-only t))
5057 ;; Each line starts with a space
5058 ;; so that Font Lock mode won't highlight the first character.
5059 (insert " Move to the session you want to recover,\n"
5060 " then type C-c C-c to select it.\n\n"
5061 " You can also delete some of these files;\n"
5062 " type d on a line to mark that file for deletion.\n\n"))))
5063 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5064 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
5066 (defun recover-session-finish ()
5067 "Choose one saved session to recover auto-save files from.
5068 This command is used in the special Dired buffer created by
5069 \\[recover-session]."
5071 ;; Get the name of the session file to recover from.
5072 (let ((file (dired-get-filename))
5074 (buffer (get-buffer-create " *recover*")))
5076 (dired-do-flagged-delete t)
5078 (with-current-buffer buffer
5079 ;; Read in the auto-save-list file.
5081 (insert-file-contents file)
5082 ;; Loop thru the text of that file
5083 ;; and get out the names of the files to recover.
5085 (let (thisfile autofile)
5087 ;; This is a pair of lines for a non-file-visiting buffer.
5088 ;; Get the auto-save file name and manufacture
5089 ;; a "visited file name" from that.
5092 ;; If there is no auto-save file name, the
5093 ;; auto-save-list file is probably corrupted.
5096 (buffer-substring-no-properties
5098 (line-end-position)))
5102 (file-name-nondirectory autofile)
5104 (file-name-directory autofile))))
5106 ;; This pair of lines is a file-visiting
5107 ;; buffer. Use the visited file name.
5110 (buffer-substring-no-properties
5111 (point) (progn (end-of-line) (point))))
5114 (buffer-substring-no-properties
5115 (point) (progn (end-of-line) (point))))
5117 ;; Ignore a file if its auto-save file does not exist now.
5118 (if (and autofile (file-exists-p autofile))
5119 (setq files (cons thisfile files)))))
5120 (setq files (nreverse files))
5121 ;; The file contains a pair of line for each auto-saved buffer.
5122 ;; The first line of the pair contains the visited file name
5123 ;; or is empty if the buffer was not visiting a file.
5124 ;; The second line is the auto-save file name.
5126 (map-y-or-n-p "Recover %s? "
5129 (save-excursion (recover-file file))
5131 "Failed to recover `%s'" file)))
5133 '("file" "files" "recover"))
5134 (message "No files can be recovered from this session now")))
5135 (kill-buffer buffer))))
5137 (defun kill-buffer-ask (buffer)
5138 "Kill BUFFER if confirmed."
5140 (format "Buffer %s %s. Kill? " (buffer-name buffer)
5141 (if (buffer-modified-p buffer)
5142 "HAS BEEN EDITED" "is unmodified")))
5143 (kill-buffer buffer)))
5145 (defun kill-some-buffers (&optional list)
5146 "Kill some buffers. Asks the user whether to kill each one of them.
5147 Non-interactively, if optional argument LIST is non-nil, it
5148 specifies the list of buffers to kill, asking for approval for each one."
5151 (setq list (buffer-list)))
5153 (let* ((buffer (car list))
5154 (name (buffer-name buffer)))
5155 (and name ; Can be nil for an indirect buffer
5156 ; if we killed the base buffer.
5157 (not (string-equal name ""))
5158 (/= (aref name 0) ?\s)
5159 (kill-buffer-ask buffer)))
5160 (setq list (cdr list))))
5162 (defun kill-matching-buffers (regexp &optional internal-too)
5163 "Kill buffers whose name matches the specified REGEXP.
5164 The optional second argument indicates whether to kill internal buffers too."
5165 (interactive "sKill buffers matching this regular expression: \nP")
5166 (dolist (buffer (buffer-list))
5167 (let ((name (buffer-name buffer)))
5168 (when (and name (not (string-equal name ""))
5169 (or internal-too (/= (aref name 0) ?\s))
5170 (string-match regexp name))
5171 (kill-buffer-ask buffer)))))
5174 (defun rename-auto-save-file ()
5175 "Adjust current buffer's auto save file name for current conditions.
5176 Also rename any existing auto save file, if it was made in this session."
5177 (let ((osave buffer-auto-save-file-name))
5178 (setq buffer-auto-save-file-name
5179 (make-auto-save-file-name))
5180 (if (and osave buffer-auto-save-file-name
5181 (not (string= buffer-auto-save-file-name buffer-file-name))
5182 (not (string= buffer-auto-save-file-name osave))
5183 (file-exists-p osave)
5184 (recent-auto-save-p))
5185 (rename-file osave buffer-auto-save-file-name t))))
5187 (defun make-auto-save-file-name ()
5188 "Return file name to use for auto-saves of current buffer.
5189 Does not consider `auto-save-visited-file-name' as that variable is checked
5190 before calling this function. You can redefine this for customization.
5191 See also `auto-save-file-name-p'."
5192 (if buffer-file-name
5193 (let ((handler (find-file-name-handler buffer-file-name
5194 'make-auto-save-file-name)))
5196 (funcall handler 'make-auto-save-file-name)
5197 (let ((list auto-save-file-name-transforms)
5198 (filename buffer-file-name)
5200 ;; Apply user-specified translations
5201 ;; to the file name.
5202 (while (and list (not result))
5203 (if (string-match (car (car list)) filename)
5204 (setq result (replace-match (cadr (car list)) t nil
5206 uniq (car (cddr (car list)))))
5207 (setq list (cdr list)))
5210 (setq filename (concat
5211 (file-name-directory result)
5212 (subst-char-in-string
5214 (replace-regexp-in-string "!" "!!"
5216 (setq filename result)))
5218 (if (and (eq system-type 'ms-dos)
5219 (not (msdos-long-file-names)))
5220 ;; We truncate the file name to DOS 8+3 limits
5221 ;; before doing anything else, because the regexp
5222 ;; passed to string-match below cannot handle
5223 ;; extensions longer than 3 characters, multiple
5224 ;; dots, and other atrocities.
5225 (let ((fn (dos-8+3-filename
5226 (file-name-nondirectory buffer-file-name))))
5228 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5230 (concat (file-name-directory buffer-file-name)
5231 "#" (match-string 1 fn)
5232 "." (match-string 3 fn) "#"))
5233 (concat (file-name-directory filename)
5235 (file-name-nondirectory filename)
5237 ;; Make sure auto-save file names don't contain characters
5238 ;; invalid for the underlying filesystem.
5239 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5240 ;; Don't modify remote (ange-ftp) filenames
5241 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
5242 (convert-standard-filename result)
5245 ;; Deal with buffers that don't have any associated files. (Mail
5246 ;; mode tends to create a good number of these.)
5248 (let ((buffer-name (buffer-name))
5251 ;; Restrict the characters used in the file name to those which
5252 ;; are known to be safe on all filesystems, url-encoding the
5254 ;; We do this on all platforms, because even if we are not
5255 ;; running on DOS/Windows, the current directory may be on a
5256 ;; mounted VFAT filesystem, such as a USB memory stick.
5257 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
5258 (let* ((character (aref buffer-name (match-beginning 0)))
5260 ;; For multibyte characters, this will produce more than
5261 ;; 2 hex digits, so is not true URL encoding.
5262 (format "%%%02X" character)))
5263 (setq buffer-name (replace-match replacement t t buffer-name))
5264 (setq limit (1+ (match-end 0)))))
5265 ;; Generate the file name.
5270 (format "#%s#" buffer-name)
5271 ;; Try a few alternative directories, to get one we can
5274 ((file-writable-p default-directory) default-directory)
5275 ((file-writable-p "/var/tmp/") "/var/tmp/")
5277 (if (and (memq system-type '(ms-dos windows-nt cygwin))
5278 ;; Don't modify remote (ange-ftp) filenames
5279 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
5280 ;; The call to convert-standard-filename is in case
5281 ;; buffer-name includes characters not allowed by the
5282 ;; DOS/Windows filesystems. make-temp-file writes to the
5283 ;; file it creates, so we must fix the file name _before_
5284 ;; make-temp-file is called.
5285 (convert-standard-filename fname)
5288 ;; make-temp-file creates the file,
5289 ;; but we don't want it to exist until we do an auto-save.
5291 (delete-file file-name)
5295 (defun auto-save-file-name-p (filename)
5296 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5297 FILENAME should lack slashes. You can redefine this for customization."
5298 (string-match "^#.*#$" filename))
5300 (defun wildcard-to-regexp (wildcard)
5301 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5302 The generated regexp will match a filename only if the filename
5303 matches that wildcard according to shell rules. Only wildcards known
5304 by `sh' are supported."
5305 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
5306 ;; Copy the initial run of non-special characters.
5307 (result (substring wildcard 0 i))
5308 (len (length wildcard)))
5309 ;; If no special characters, we're almost done.
5312 (let ((ch (aref wildcard i))
5320 (eq (aref wildcard (1+ i)) ?\]))
5322 ((eq ch ?\[) ; [...] maps to regexp char class
5327 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
5330 (if (eq (aref wildcard i) ?\])
5335 ((eq (aref wildcard i) ?^)
5336 ;; Found "[^". Insert a `\0' character
5337 ;; (which cannot happen in a filename)
5338 ;; into the character class, so that `^'
5339 ;; is not the first character after `[',
5340 ;; and thus non-special in a regexp.
5344 ((eq (aref wildcard i) ?\])
5345 ;; I don't think `]' can appear in a
5346 ;; character class in a wildcard, but
5347 ;; let's be general here.
5352 (prog1 ; copy everything upto next `]'.
5355 (setq j (string-match
5357 (setq i (if j (1- j) (1- len)))))))
5359 ((eq ch ?*) "[^\000]*")
5363 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5364 ((eq ch ??) "[^\000]")
5365 (t (char-to-string ch)))))
5367 ;; Shell wildcards should match the entire filename,
5368 ;; not its part. Make the regexp say so.
5369 (concat "\\`" result "\\'")))
5371 (defcustom list-directory-brief-switches
5373 "Switches for `list-directory' to pass to `ls' for brief listing."
5377 (defcustom list-directory-verbose-switches
5379 "Switches for `list-directory' to pass to `ls' for verbose listing."
5383 (defun file-expand-wildcards (pattern &optional full)
5384 "Expand wildcard pattern PATTERN.
5385 This returns a list of file names which match the pattern.
5387 If PATTERN is written as an absolute file name,
5388 the values are absolute also.
5390 If PATTERN is written as a relative file name, it is interpreted
5391 relative to the current default directory, `default-directory'.
5392 The file names returned are normally also relative to the current
5393 default directory. However, if FULL is non-nil, they are absolute."
5395 (let* ((nondir (file-name-nondirectory pattern))
5396 (dirpart (file-name-directory pattern))
5397 ;; A list of all dirs that DIRPART specifies.
5398 ;; This can be more than one dir
5399 ;; if DIRPART contains wildcards.
5400 (dirs (if (and dirpart
5401 (string-match "[[*?]"
5402 (or (file-remote-p dirpart 'localname)
5404 (mapcar 'file-name-as-directory
5405 (file-expand-wildcards (directory-file-name dirpart)))
5409 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5410 (file-directory-p (directory-file-name (car dirs))))
5411 (let ((this-dir-contents
5412 ;; Filter out "." and ".."
5414 (mapcar #'(lambda (name)
5415 (unless (string-match "\\`\\.\\.?\\'"
5416 (file-name-nondirectory name))
5418 (directory-files (or (car dirs) ".") full
5419 (wildcard-to-regexp nondir))))))
5422 (if (and (car dirs) (not full))
5423 (mapcar (function (lambda (name) (concat (car dirs) name)))
5427 (setq dirs (cdr dirs)))
5430 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5431 (provide 'files '(remote-wildcards))
5433 (defun list-directory (dirname &optional verbose)
5434 "Display a list of files in or matching DIRNAME, a la `ls'.
5435 DIRNAME is globbed by the shell if necessary.
5436 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5437 Actions controlled by variables `list-directory-brief-switches'
5438 and `list-directory-verbose-switches'."
5439 (interactive (let ((pfx current-prefix-arg))
5440 (list (read-file-name (if pfx "List directory (verbose): "
5441 "List directory (brief): ")
5442 nil default-directory nil)
5444 (let ((switches (if verbose list-directory-verbose-switches
5445 list-directory-brief-switches))
5447 (or dirname (setq dirname default-directory))
5448 (setq dirname (expand-file-name dirname))
5449 (with-output-to-temp-buffer "*Directory*"
5450 (setq buffer standard-output)
5451 (buffer-disable-undo standard-output)
5452 (princ "Directory ")
5455 (with-current-buffer "*Directory*"
5456 (let ((wildcard (not (file-directory-p dirname))))
5457 (insert-directory dirname switches wildcard (not wildcard)))))
5458 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5459 (with-current-buffer buffer
5460 (setq default-directory
5461 (if (file-directory-p dirname)
5462 (file-name-as-directory dirname)
5463 (file-name-directory dirname))))))
5465 (defun shell-quote-wildcard-pattern (pattern)
5466 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5468 PATTERN is assumed to represent a file-name wildcard suitable for the
5469 underlying filesystem. For Unix and GNU/Linux, each character from the
5470 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5471 the parts of the pattern which don't include wildcard characters are
5472 quoted with double quotes.
5474 This function leaves alone existing quote characters (\\ on Unix and \"
5475 on Windows), so PATTERN can use them to quote wildcard characters that
5476 need to be passed verbatim to shell commands."
5479 ((memq system-type '(ms-dos windows-nt cygwin))
5480 ;; DOS/Windows don't allow `"' in file names. So if the
5481 ;; argument has quotes, we can safely assume it is already
5482 ;; quoted by the caller.
5483 (if (or (string-match "[\"]" pattern)
5484 ;; We quote [&()#$'] in case their shell is a port of a
5485 ;; Unixy shell. We quote [,=+] because stock DOS and
5486 ;; Windows shells require that in some cases, such as
5487 ;; passing arguments to batch files that use positional
5488 ;; arguments like %1.
5489 (not (string-match "[ \t;&()#$',=+]" pattern)))
5494 (while (string-match "[*?]+" pattern beg)
5495 (setq end (match-beginning 0)
5496 result (concat result (substring pattern beg end)
5498 (substring pattern end (match-end 0))
5501 (concat result (substring pattern beg) "\""))))
5504 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5506 (concat (substring pattern 0 (match-beginning 0))
5508 (substring pattern (match-beginning 0)))
5509 beg (1+ (match-end 0)))))
5513 (defvar insert-directory-program (purecopy "ls")
5514 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5516 (defcustom directory-free-space-program (purecopy "df")
5517 "Program to get the amount of free space on a file system.
5518 We assume the output has the format of `df'.
5519 The value of this variable must be just a command name or file name;
5520 if you want to specify options, use `directory-free-space-args'.
5522 A value of nil disables this feature.
5524 If the function `file-system-info' is defined, it is always used in
5525 preference to the program given by this variable."
5526 :type '(choice (string :tag "Program") (const :tag "None" nil))
5529 (defcustom directory-free-space-args
5530 (purecopy (if (eq system-type 'darwin) "-k" "-Pk"))
5531 "Options to use when running `directory-free-space-program'."
5535 (defun get-free-disk-space (dir)
5536 "Return the amount of free space on directory DIR's file system.
5537 The result is a string that gives the number of free 1KB blocks,
5538 or nil if the system call or the program which retrieve the information
5539 fail. It returns also nil when DIR is a remote directory.
5541 This function calls `file-system-info' if it is available, or invokes the
5542 program specified by `directory-free-space-program' if that is non-nil."
5543 (unless (file-remote-p dir)
5544 ;; Try to find the number of free blocks. Non-Posix systems don't
5545 ;; always have df, but might have an equivalent system call.
5546 (if (fboundp 'file-system-info)
5547 (let ((fsinfo (file-system-info dir)))
5549 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5550 (setq dir (expand-file-name dir))
5553 (when (and directory-free-space-program
5554 ;; Avoid failure if the default directory does
5555 ;; not exist (Bug#2631, Bug#3911).
5556 (let ((default-directory "/"))
5557 (eq (call-process directory-free-space-program
5559 directory-free-space-args
5562 ;; Usual format is a header line followed by a line of
5564 (goto-char (point-min))
5568 ;; Move to the end of the "available blocks" number.
5569 (skip-chars-forward "^ \t")
5571 ;; Copy it into AVAILABLE.
5572 (let ((end (point)))
5574 (buffer-substring (point) end))))))))))
5576 ;; The following expression replaces `dired-move-to-filename-regexp'.
5577 (defvar directory-listing-before-filename-regexp
5578 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5579 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5580 ;; In some locales, month abbreviations are as short as 2 letters,
5581 ;; and they can be followed by ".".
5582 ;; In Breton, a month name can include a quote character.
5583 (month (concat l-or-quote l-or-quote "+\\.?"))
5585 (yyyy "[0-9][0-9][0-9][0-9]")
5587 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5588 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5589 (zone "[-+][0-2][0-9][0-5][0-9]")
5590 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5591 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5592 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5593 "\\|" yyyy "-" iso-mm-dd "\\)"))
5594 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5596 "\\(" HH:MM "\\|" yyyy "\\)"))
5597 (western-comma (concat month s "+" dd "," s "+" yyyy))
5598 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5599 ;; omits the Kanji characters after month and day-of-month.
5600 ;; On Mac OS X 10.3, the date format in East Asian locales is
5601 ;; day-of-month digits followed by month digits.
5604 (concat "\\(" mm l "?" s dd l "?" s "+"
5605 "\\|" dd s mm s "+" "\\)"
5606 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5607 ;; The "[0-9]" below requires the previous column to end in a digit.
5608 ;; This avoids recognizing `1 may 1997' as a date in the line:
5609 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5611 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5613 ;; For non-iso date formats, we add the ".*" in order to find
5614 ;; the last possible match. This avoids recognizing
5615 ;; `jservice 10 1024' as a date in the line:
5616 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5618 ;; vc dired listings provide the state or blanks between file
5619 ;; permissions and date. The state is always surrounded by
5621 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5622 ;; This is not supported yet.
5623 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5624 "\\|.*[0-9][BkKMGTPEZY]? "
5625 "\\(" western "\\|" western-comma "\\|" east-asian "\\)"
5627 "Regular expression to match up to the file name in a directory listing.
5628 The default value is designed to recognize dates and times
5629 regardless of the language.")
5631 (defvar insert-directory-ls-version 'unknown)
5634 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5635 ;; FULL-DIRECTORY-P is nil.
5636 ;; The single line of output must display FILE's name as it was
5637 ;; given, namely, an absolute path name.
5638 ;; - must insert exactly one line for each file if WILDCARD or
5639 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5640 ;; before the file lines, plus optional text after the file lines.
5641 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5643 ;; File lines should display the basename.
5644 ;; - must be consistent with
5645 ;; - functions dired-move-to-filename, (these two define what a file line is)
5646 ;; dired-move-to-end-of-filename,
5647 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5648 ;; dired-insert-headerline
5649 ;; dired-after-subdir-garbage (defines what a "total" line is)
5650 ;; - variable dired-subdir-regexp
5651 ;; - may be passed "--dired" as the first argument in SWITCHES.
5652 ;; Filename handlers might have to remove this switch if their
5653 ;; "ls" command does not support it.
5654 (defun insert-directory (file switches &optional wildcard full-directory-p)
5655 "Insert directory listing for FILE, formatted according to SWITCHES.
5656 Leaves point after the inserted text.
5657 SWITCHES may be a string of options, or a list of strings
5658 representing individual options.
5659 Optional third arg WILDCARD means treat FILE as shell wildcard.
5660 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5661 switches do not contain `d', so that a full listing is expected.
5663 This works by running a directory listing program
5664 whose name is in the variable `insert-directory-program'.
5665 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5667 When SWITCHES contains the long `--dired' option, this function
5668 treats it specially, for the sake of dired. However, the
5669 normally equivalent short `-D' option is just passed on to
5670 `insert-directory-program', as any other option."
5671 ;; We need the directory in order to find the right handler.
5672 (let ((handler (find-file-name-handler (expand-file-name file)
5673 'insert-directory)))
5675 (funcall handler 'insert-directory file switches
5676 wildcard full-directory-p)
5677 (let (result (beg (point)))
5679 ;; Read the actual directory using `insert-directory-program'.
5680 ;; RESULT gets the status code.
5681 (let* (;; We at first read by no-conversion, then after
5682 ;; putting text property `dired-filename, decode one
5683 ;; bunch by one to preserve that property.
5684 (coding-system-for-read 'no-conversion)
5685 ;; This is to control encoding the arguments in call-process.
5686 (coding-system-for-write
5687 (and enable-multibyte-characters
5688 (or file-name-coding-system
5689 default-file-name-coding-system))))
5692 ;; Run ls in the directory part of the file pattern
5693 ;; using the last component as argument.
5694 (let ((default-directory
5695 (if (file-name-absolute-p file)
5696 (file-name-directory file)
5697 (file-name-directory (expand-file-name file))))
5698 (pattern (file-name-nondirectory file)))
5700 shell-file-name nil t nil
5702 (concat (if (memq system-type '(ms-dos windows-nt))
5704 "\\") ; Disregard Unix shell aliases!
5705 insert-directory-program
5707 (if (stringp switches)
5709 (mapconcat 'identity switches " "))
5711 ;; Quote some characters that have
5712 ;; special meanings in shells; but
5713 ;; don't quote the wildcards--we want
5714 ;; them to be special. We also
5715 ;; currently don't quote the quoting
5716 ;; characters in case people want to
5717 ;; use them explicitly to quote
5718 ;; wildcard characters.
5719 (shell-quote-wildcard-pattern pattern))))
5720 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5721 ;; directory if FILE is a symbolic link.
5722 (unless full-directory-p
5724 (if (stringp switches)
5725 (concat switches " -d")
5726 (add-to-list 'switches "-d" 'append))))
5727 (apply 'call-process
5728 insert-directory-program nil t nil
5730 (if (listp switches) switches
5731 (unless (equal switches "")
5732 ;; Split the switches at any spaces so we can
5733 ;; pass separate options as separate args.
5734 (split-string switches)))
5735 ;; Avoid lossage if FILE starts with `-'.
5738 (if (string-match "\\`~" file)
5739 (setq file (expand-file-name file)))
5741 (if full-directory-p
5742 (concat (file-name-as-directory file) ".")
5745 ;; If we got "//DIRED//" in the output, it means we got a real
5746 ;; directory listing, even if `ls' returned nonzero.
5747 ;; So ignore any errors.
5748 (when (if (stringp switches)
5749 (string-match "--dired\\>" switches)
5750 (member "--dired" switches))
5753 (when (looking-at "//SUBDIRED//")
5755 (if (looking-at "//DIRED//")
5758 (when (and (not (eq 0 result))
5759 (eq insert-directory-ls-version 'unknown))
5760 ;; The first time ls returns an error,
5761 ;; find the version numbers of ls,
5762 ;; and set insert-directory-ls-version
5763 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5764 ;; is equal or if the info cannot be obtained.
5765 ;; (That can mean it isn't GNU ls.)
5768 (call-process "ls" nil t nil "--version")
5770 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5771 (let* ((version (match-string 1 version-out))
5772 (split (split-string version "[.]"))
5773 (numbers (mapcar 'string-to-number split))
5776 (while (and (not comparison) (or numbers min))
5778 (setq comparison '>))
5780 (setq comparison '<))
5781 ((> (car numbers) (car min))
5782 (setq comparison '>))
5783 ((< (car numbers) (car min))
5784 (setq comparison '<))
5786 (setq numbers (cdr numbers)
5788 (setq insert-directory-ls-version (or comparison '=)))
5789 (setq insert-directory-ls-version nil))))
5791 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5792 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5795 ;; If `insert-directory-program' failed, signal an error.
5796 (unless (eq 0 result)
5797 ;; Delete the error message it may have output.
5798 (delete-region beg (point))
5799 ;; On non-Posix systems, we cannot open a directory, so
5800 ;; don't even try, because that will always result in
5801 ;; the ubiquitous "Access denied". Instead, show the
5802 ;; command line so the user can try to guess what went wrong.
5803 (if (and (file-directory-p file)
5804 (memq system-type '(ms-dos windows-nt)))
5806 "Reading directory: \"%s %s -- %s\" exited with status %s"
5807 insert-directory-program
5808 (if (listp switches) (concat switches) switches)
5810 ;; Unix. Access the file to get a suitable error.
5811 (access-file file "Reading directory")
5812 (error "Listing directory failed but `access-file' worked")))
5814 (when (if (stringp switches)
5815 (string-match "--dired\\>" switches)
5816 (member "--dired" switches))
5817 ;; The following overshoots by one line for an empty
5818 ;; directory listed with "--dired", but without "-a"
5819 ;; switch, where the ls output contains a
5820 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5821 ;; We take care of that case later.
5823 (when (looking-at "//SUBDIRED//")
5824 (delete-region (point) (progn (forward-line 1) (point)))
5826 (if (looking-at "//DIRED//")
5827 (let ((end (line-end-position))
5830 ;; Find all the lines that are error messages,
5831 ;; and record the bounds of each one.
5833 (while (< (point) linebeg)
5834 (or (eql (following-char) ?\s)
5835 (push (list (point) (line-end-position)) error-lines))
5837 (setq error-lines (nreverse error-lines))
5838 ;; Now read the numeric positions of file names.
5842 (while (< (point) end)
5843 (let ((start (insert-directory-adj-pos
5844 (+ beg (read (current-buffer)))
5846 (end (insert-directory-adj-pos
5847 (+ beg (read (current-buffer)))
5849 (if (memq (char-after end) '(?\n ?\s))
5850 ;; End is followed by \n or by " -> ".
5851 (put-text-property start end 'dired-filename t)
5852 ;; It seems that we can't trust ls's output as to
5853 ;; byte positions of filenames.
5854 (put-text-property beg (point) 'dired-filename nil)
5858 (delete-region (point) (progn (forward-line 1) (point))))
5859 ;; Take care of the case where the ls output contains a
5860 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5861 ;; and we went one line too far back (see above).
5863 (if (looking-at "//DIRED-OPTIONS//")
5864 (delete-region (point) (progn (forward-line 1) (point)))))
5866 ;; Now decode what read if necessary.
5867 (let ((coding (or coding-system-for-read
5868 file-name-coding-system
5869 default-file-name-coding-system
5873 (when (and enable-multibyte-characters
5874 (not (memq (coding-system-base coding)
5875 '(raw-text no-conversion))))
5876 ;; If no coding system is specified or detection is
5877 ;; requested, detect the coding.
5878 (if (eq (coding-system-base coding) 'undecided)
5879 (setq coding (detect-coding-region beg (point) t)))
5880 (if (not (eq (coding-system-base coding) 'undecided))
5883 (coding-system-change-eol-conversion coding 'unix))
5884 (narrow-to-region beg (point))
5885 (goto-char (point-min))
5888 val (get-text-property (point) 'dired-filename))
5889 (goto-char (next-single-property-change
5890 (point) 'dired-filename nil (point-max)))
5891 ;; Force no eol conversion on a file name, so
5892 ;; that CR is preserved.
5893 (decode-coding-region pos (point)
5894 (if val coding-no-eol coding))
5896 (put-text-property pos (point)
5897 'dired-filename t)))))))
5899 (if full-directory-p
5900 ;; Try to insert the amount of free space.
5903 ;; First find the line to put it on.
5904 (when (re-search-forward "^ *\\(total\\)" nil t)
5905 (let ((available (get-free-disk-space ".")))
5907 ;; Replace "total" with "used", to avoid confusion.
5908 (replace-match "total used in directory" nil nil nil 1)
5910 (insert " available " available))))))))))
5912 (defun insert-directory-adj-pos (pos error-lines)
5913 "Convert `ls --dired' file name position value POS to a buffer position.
5914 File name position values returned in ls --dired output
5915 count only stdout; they don't count the error messages sent to stderr.
5916 So this function converts to them to real buffer positions.
5917 ERROR-LINES is a list of buffer positions of error message lines,
5918 of the form (START END)."
5919 (while (and error-lines (< (caar error-lines) pos))
5920 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5924 (defun insert-directory-safely (file switches
5925 &optional wildcard full-directory-p)
5926 "Insert directory listing for FILE, formatted according to SWITCHES.
5928 Like `insert-directory', but if FILE does not exist, it inserts a
5929 message to that effect instead of signaling an error."
5930 (if (file-exists-p file)
5931 (insert-directory file switches wildcard full-directory-p)
5932 ;; Simulate the message printed by `ls'.
5933 (insert (format "%s: No such file or directory\n" file))))
5935 (defvar kill-emacs-query-functions nil
5936 "Functions to call with no arguments to query about killing Emacs.
5937 If any of these functions returns nil, killing Emacs is cancelled.
5938 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5939 the low level primitive, does not. See also `kill-emacs-hook'.")
5941 (defcustom confirm-kill-emacs nil
5942 "How to ask for confirmation when leaving Emacs.
5943 If nil, the default, don't ask at all. If the value is non-nil, it should
5944 be a predicate function such as `yes-or-no-p'."
5945 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5946 (const :tag "Ask with y-or-n-p" y-or-n-p)
5947 (const :tag "Don't confirm" nil))
5951 (defun save-buffers-kill-emacs (&optional arg)
5952 "Offer to save each buffer, then kill this Emacs process.
5953 With prefix ARG, silently save all file-visiting buffers, then kill."
5955 (save-some-buffers arg t)
5956 (and (or (not (memq t (mapcar (function
5957 (lambda (buf) (and (buffer-file-name buf)
5958 (buffer-modified-p buf))))
5960 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5961 (or (not (fboundp 'process-list))
5962 ;; process-list is not defined on MSDOS.
5963 (let ((processes (process-list))
5966 (and (memq (process-status (car processes)) '(run stop open listen))
5967 (process-query-on-exit-flag (car processes))
5969 (setq processes (cdr processes)))
5972 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5973 ;; Query the user for other things, perhaps.
5974 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5975 (or (null confirm-kill-emacs)
5976 (funcall confirm-kill-emacs "Really exit Emacs? "))
5979 (defun save-buffers-kill-terminal (&optional arg)
5980 "Offer to save each buffer, then kill the current connection.
5981 If the current frame has no client, kill Emacs itself.
5983 With prefix ARG, silently save all file-visiting buffers, then kill.
5985 If emacsclient was started with a list of filenames to edit, then
5986 only these files will be asked to be saved."
5988 (if (frame-parameter (selected-frame) 'client)
5989 (server-save-buffers-kill-terminal arg)
5990 (save-buffers-kill-emacs arg)))
5992 ;; We use /: as a prefix to "quote" a file name
5993 ;; so that magic file name handlers will not apply to it.
5995 (setq file-name-handler-alist
5996 (cons (cons (purecopy "\\`/:") 'file-name-non-special)
5997 file-name-handler-alist))
5999 ;; We depend on being the last handler on the list,
6000 ;; so that anything else which does need handling
6001 ;; has been handled already.
6002 ;; So it is safe for us to inhibit *all* magic file name handlers.
6004 (defun file-name-non-special (operation &rest arguments)
6005 (let ((file-name-handler-alist nil)
6007 (if (eq operation 'insert-directory)
6008 (directory-file-name
6010 (unhandled-file-name-directory default-directory)))
6012 ;; Get a list of the indices of the args which are file names.
6014 (cdr (or (assq operation
6015 ;; The first six are special because they
6016 ;; return a file name. We want to include the /:
6017 ;; in the return value.
6018 ;; So just avoid stripping it in the first place.
6019 '((expand-file-name . nil)
6020 (file-name-directory . nil)
6021 (file-name-as-directory . nil)
6022 (directory-file-name . nil)
6023 (file-name-sans-versions . nil)
6024 (find-backup-file-name . nil)
6025 ;; `identity' means just return the first arg
6026 ;; not stripped of its quoting.
6027 (substitute-in-file-name identity)
6028 ;; `add' means add "/:" to the result.
6029 (file-truename add 0)
6030 ;; `quote' means add "/:" to buffer-file-name.
6031 (insert-file-contents quote 0)
6032 ;; `unquote-then-quote' means set buffer-file-name
6033 ;; temporarily to unquoted filename.
6034 (verify-visited-file-modtime unquote-then-quote)
6035 ;; List the arguments which are filenames.
6036 (file-name-completion 1)
6037 (file-name-all-completions 1)
6041 (make-symbolic-link 0 1)
6042 (add-name-to-file 0 1)))
6043 ;; For all other operations, treat the first argument only
6044 ;; as the file name.
6047 ;; Copy ARGUMENTS so we can replace elements in it.
6048 (arguments (copy-sequence arguments)))
6049 (if (symbolp (car file-arg-indices))
6050 (setq method (pop file-arg-indices)))
6051 ;; Strip off the /: from the file names that have it.
6053 (while (consp file-arg-indices)
6054 (let ((pair (nthcdr (car file-arg-indices) arguments)))
6056 (string-match "\\`/:" (car pair))
6058 (if (= (length (car pair)) 2)
6060 (substring (car pair) 2)))))
6061 (setq file-arg-indices (cdr file-arg-indices))))
6062 (cond ((eq method 'identity)
6065 (concat "/:" (apply operation arguments)))
6068 (apply operation arguments)
6069 (setq buffer-file-name (concat "/:" buffer-file-name))))
6070 ((eq method 'unquote-then-quote)
6072 (setq buffer-file-name (substring buffer-file-name 2))
6073 (setq res (apply operation arguments))
6074 (setq buffer-file-name (concat "/:" buffer-file-name))
6077 (apply operation arguments)))))
6079 ;; Symbolic modes and read-file-modes.
6081 (defun file-modes-char-to-who (char)
6082 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6083 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6084 Others, or All) for whom to produce the mask.
6085 The bit-mask that is returned extracts from mode bits the access rights
6086 for the specified category of users."
6087 (cond ((= char ?u) #o4700)
6088 ((= char ?g) #o2070)
6089 ((= char ?o) #o1007)
6090 ((= char ?a) #o7777)
6091 (t (error "%c: bad `who' character" char))))
6093 (defun file-modes-char-to-right (char &optional from)
6094 "Convert CHAR to a numeric value of mode bits.
6095 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6096 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6097 (or from (setq from 0))
6098 (cond ((= char ?r) #o0444)
6099 ((= char ?w) #o0222)
6100 ((= char ?x) #o0111)
6101 ((= char ?s) #o1000)
6102 ((= char ?t) #o6000)
6103 ;; Rights relative to the previous file modes.
6104 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
6105 ((= char ?u) (let ((uright (logand #o4700 from)))
6106 (+ uright (/ uright #o10) (/ uright #o100))))
6107 ((= char ?g) (let ((gright (logand #o2070 from)))
6108 (+ gright (/ gright #o10) (* gright #o10))))
6109 ((= char ?o) (let ((oright (logand #o1007 from)))
6110 (+ oright (* oright #o10) (* oright #o100))))
6111 (t (error "%c: bad right character" char))))
6113 (defun file-modes-rights-to-number (rights who-mask &optional from)
6114 "Convert a symbolic mode string specification to an equivalent number.
6115 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6116 WHO-MASK is the bit-mask specifying the category of users to which to
6117 apply the access permissions. See `file-modes-char-to-who'.
6118 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6119 RIGHTS request to add, remove, or set permissions based on existing ones,
6121 (let* ((num-rights (or from 0))
6122 (list-rights (string-to-list rights))
6123 (op (pop list-rights)))
6124 (while (memq op '(?+ ?- ?=))
6127 (while (memq (setq char-right (pop list-rights))
6128 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
6131 (file-modes-char-to-right char-right num-rights))))
6132 (setq num-right (logand who-mask num-right)
6134 (cond ((= op ?+) (logior num-rights num-right))
6135 ((= op ?-) (logand num-rights (lognot num-right)))
6136 (t (logior (logand num-rights (lognot who-mask)) num-right)))
6140 (defun file-modes-symbolic-to-number (modes &optional from)
6141 "Convert symbolic file modes to numeric file modes.
6142 MODES is the string to convert, it should match
6143 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6144 See (info \"(coreutils)File permissions\") for more information on this
6146 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6147 MODES request to add, remove, or set permissions based on existing ones,
6150 (let ((case-fold-search nil)
6151 (num-modes (or from 0)))
6152 (while (/= (string-to-char modes) 0)
6153 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes)
6154 (let ((num-who (apply 'logior 0
6155 (mapcar 'file-modes-char-to-who
6156 (match-string 1 modes)))))
6158 (setq num-who (default-file-modes)))
6160 (file-modes-rights-to-number (substring modes (match-end 1))
6162 modes (substring modes (match-end 3))))
6163 (error "Parse error in modes near `%s'" (substring modes 0))))
6166 (defun read-file-modes (&optional prompt orig-file)
6167 "Read file modes in octal or symbolic notation and return its numeric value.
6168 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6169 ORIG-FILE is the name of a file on whose mode bits to base returned
6170 permissions if what user types requests to add, remove, or set permissions
6171 based on existing mode bits, as in \"og+rX-w\"."
6172 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
6173 (error "File not found")))
6174 (modestr (and (stringp orig-file)
6175 (nth 8 (file-attributes orig-file))))
6177 (and (stringp modestr)
6178 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr)
6179 (replace-regexp-in-string
6181 (format "u=%s,g=%s,o=%s"
6182 (match-string 1 modestr)
6183 (match-string 2 modestr)
6184 (match-string 3 modestr)))))
6185 (value (read-string (or prompt "File modes (octal or symbolic): ")
6188 (if (string-match "^[0-7]+" value)
6189 (string-to-number value 8)
6190 (file-modes-symbolic-to-number value modes)))))
6193 ;; Trashcan handling.
6194 (defcustom trash-directory nil
6195 "Directory for `move-file-to-trash' to move files and directories to.
6196 This directory is only used when the function `system-move-file-to-trash'
6198 Relative paths are interpreted relative to `default-directory'.
6199 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6200 :type '(choice (const nil) directory)
6204 (defvar trash--hexify-table)
6206 (declare-function system-move-file-to-trash "w32fns.c" (filename))
6208 (defun move-file-to-trash (filename)
6209 "Move the file (or directory) named FILENAME to the trash.
6210 When `delete-by-moving-to-trash' is non-nil, this function is
6211 called by `delete-file' and `delete-directory' instead of
6212 deleting files outright.
6214 If the function `system-move-file-to-trash' is defined, call it
6215 with FILENAME as an argument.
6216 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6218 Otherwise, trash FILENAME using the freedesktop.org conventions,
6219 like the GNOME, KDE and XFCE desktop environments. Emacs only
6220 moves files to \"home trash\", ignoring per-volume trashcans."
6221 (interactive "fMove file to trash: ")
6222 (cond (trash-directory
6223 ;; If `trash-directory' is non-nil, move the file there.
6224 (let* ((trash-dir (expand-file-name trash-directory))
6225 (fn (directory-file-name (expand-file-name filename)))
6226 (new-fn (expand-file-name (file-name-nondirectory fn)
6228 ;; We can't trash a parent directory of trash-directory.
6229 (if (string-match fn trash-dir)
6230 (error "Trash directory `%s' is a subdirectory of `%s'"
6231 trash-dir filename))
6232 (unless (file-directory-p trash-dir)
6233 (make-directory trash-dir t))
6234 ;; Ensure that the trashed file-name is unique.
6235 (if (file-exists-p new-fn)
6236 (let ((version-control t)
6237 (backup-directory-alist nil))
6238 (setq new-fn (car (find-backup-file-name new-fn)))))
6239 (let (delete-by-moving-to-trash)
6240 (rename-file fn new-fn))))
6241 ;; If `system-move-file-to-trash' is defined, use it.
6242 ((fboundp 'system-move-file-to-trash)
6243 (system-move-file-to-trash filename))
6244 ;; Otherwise, use the freedesktop.org method, as specified at
6245 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6247 (let* ((xdg-data-dir
6248 (directory-file-name
6249 (expand-file-name "Trash"
6250 (or (getenv "XDG_DATA_HOME")
6251 "~/.local/share"))))
6252 (trash-files-dir (expand-file-name "files" xdg-data-dir))
6253 (trash-info-dir (expand-file-name "info" xdg-data-dir))
6254 (fn (directory-file-name (expand-file-name filename))))
6256 ;; Check if we have permissions to delete.
6257 (unless (file-writable-p (directory-file-name
6258 (file-name-directory fn)))
6259 (error "Cannot move %s to trash: Permission denied" filename))
6260 ;; The trashed file cannot be the trash dir or its parent.
6261 (if (string-match fn trash-files-dir)
6262 (error "The trash directory %s is a subdirectory of %s"
6263 trash-files-dir filename))
6264 (if (string-match fn trash-info-dir)
6265 (error "The trash directory %s is a subdirectory of %s"
6266 trash-info-dir filename))
6268 ;; Ensure that the trash directory exists; otherwise, create it.
6269 (let ((saved-default-file-modes (default-file-modes)))
6270 (set-default-file-modes ?\700)
6271 (unless (file-exists-p trash-files-dir)
6272 (make-directory trash-files-dir t))
6273 (unless (file-exists-p trash-info-dir)
6274 (make-directory trash-info-dir t))
6275 (set-default-file-modes saved-default-file-modes))
6277 ;; Try to move to trash with .trashinfo undo information
6280 (set-buffer-file-coding-system 'utf-8-unix)
6281 (insert "[Trash Info]\nPath=")
6282 ;; Perform url-encoding on FN. For compatibility with
6283 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6284 ;; for path separators.
6285 (unless (boundp 'trash--hexify-table)
6286 (setq trash--hexify-table (make-vector 256 nil))
6287 (let ((unreserved-chars
6288 (list ?/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6289 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6290 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6291 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?0 ?1 ?2
6292 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?_ ?. ?! ?~ ?* ?'
6295 (aset trash--hexify-table byte
6296 (if (memq byte unreserved-chars)
6297 (char-to-string byte)
6298 (format "%%%02x" byte))))))
6299 (mapc (lambda (byte)
6300 (insert (aref trash--hexify-table byte)))
6301 (if (multibyte-string-p fn)
6302 (encode-coding-string fn 'utf-8)
6304 (insert "\nDeletionDate="
6305 (format-time-string "%Y-%m-%dT%T")
6308 ;; Attempt to make .trashinfo file, trying up to 5
6309 ;; times. The .trashinfo file is opened with O_EXCL,
6310 ;; as per trash-spec 0.7, even if that can be a problem
6311 ;; on old NFS versions...
6313 (base-fn (expand-file-name
6314 (file-name-nondirectory fn)
6319 (setq info-fn (expand-file-name
6320 (concat (file-name-nondirectory new-fn)
6323 (unless (condition-case nil
6325 (write-region nil nil info-fn nil
6326 'quiet info-fn 'excl)
6327 (setq tries 0 success t))
6328 (file-already-exists nil))
6329 (setq tries (1- tries))
6330 ;; Uniqify new-fn. (Some file managers do not
6331 ;; like Emacs-style backup file names---e.g. bug
6332 ;; 170956 in Konqueror bug tracker.)
6333 (setq new-fn (make-temp-name (concat base-fn "_")))))
6335 (error "Cannot move %s to trash: Lock failed" filename))
6337 ;; Finally, try to move the file to the trashcan.
6338 (let ((delete-by-moving-to-trash nil))
6339 (rename-file fn new-fn)))))))))
6342 (define-key ctl-x-map "\C-f" 'find-file)
6343 (define-key ctl-x-map "\C-r" 'find-file-read-only)
6344 (define-key ctl-x-map "\C-v" 'find-alternate-file)
6345 (define-key ctl-x-map "\C-s" 'save-buffer)
6346 (define-key ctl-x-map "s" 'save-some-buffers)
6347 (define-key ctl-x-map "\C-w" 'write-file)
6348 (define-key ctl-x-map "i" 'insert-file)
6349 (define-key esc-map "~" 'not-modified)
6350 (define-key ctl-x-map "\C-d" 'list-directory)
6351 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
6352 (define-key ctl-x-map "\C-q" 'toggle-read-only)
6354 (define-key ctl-x-4-map "f" 'find-file-other-window)
6355 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
6356 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
6357 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
6358 (define-key ctl-x-4-map "\C-o" 'display-buffer)
6360 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
6361 (define-key ctl-x-5-map "f" 'find-file-other-frame)
6362 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
6363 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
6364 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
6366 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6367 ;;; files.el ends here