1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008, 2009, 2010, 2011 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.
60 FROM is matched against directory names anchored at the first
61 character, so it should start with a \"\\\\`\", or, if directory
62 names cannot have embedded newlines, with a \"^\".
64 FROM and TO should be equivalent names, which refer to the
65 same directory. Do not use `~' in the TO strings;
66 they should be ordinary absolute directory names.
68 Use this feature when you have directories which you normally refer to
69 via absolute symbolic links. Make TO the name of the link, and FROM
70 the name it is linked to."
71 :type
'(repeat (cons :format
"%v"
78 (defcustom make-backup-files t
79 "Non-nil means make a backup of a file the first time it is saved.
80 This can be done by renaming the file or by copying.
82 Renaming means that Emacs renames the existing file so that it is a
83 backup file, then writes the buffer into a new file. Any other names
84 that the old file had will now refer to the backup file. The new file
85 is owned by you and its group is defaulted.
87 Copying means that Emacs copies the existing file into the backup
88 file, then writes the buffer on top of the existing file. Any other
89 names that the old file had will now refer to the new (edited) file.
90 The file's owner and group are unchanged.
92 The choice of renaming or copying is controlled by the variables
93 `backup-by-copying', `backup-by-copying-when-linked',
94 `backup-by-copying-when-mismatch' and
95 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
99 ;; Do this so that local variables based on the file name
100 ;; are not overridden by the major mode.
101 (defvar backup-inhibited nil
102 "Non-nil means don't make a backup, regardless of the other parameters.
103 This variable is intended for use by making it local to a buffer.
104 But it is local only if you make it local.")
105 (put 'backup-inhibited
'permanent-local t
)
107 (defcustom backup-by-copying nil
108 "Non-nil means always use copying to create backup files.
109 See documentation of variable `make-backup-files'."
113 (defcustom backup-by-copying-when-linked nil
114 "Non-nil means use copying to create backups for files with multiple names.
115 This causes the alternate names to refer to the latest version as edited.
116 This variable is relevant only if `backup-by-copying' is nil."
120 (defcustom backup-by-copying-when-mismatch nil
121 "Non-nil means create backups by copying if this preserves owner or group.
122 Renaming may still be used (subject to control of other variables)
123 when it would not result in changing the owner or group of the file;
124 that is, for files which are owned by you and whose group matches
125 the default for a new file created there by you.
126 This variable is relevant only if `backup-by-copying' is nil."
129 (put 'backup-by-copying-when-mismatch
'permanent-local t
)
131 (defcustom backup-by-copying-when-privileged-mismatch
200
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
140 :type
'(choice (const nil
) integer
)
143 (defvar backup-enable-predicate
'normal-backup-enable-predicate
144 "Predicate that looks at a file name and decides whether to make backups.
145 Called with an absolute file name as argument, it returns t to enable backup.")
147 (defcustom buffer-offer-save nil
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
153 (make-variable-buffer-local 'buffer-offer-save
)
155 (defcustom find-file-existing-other-name t
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
162 (defcustom find-file-visit-truename nil
163 "Non-nil means visit a file under its truename.
164 The truename of a file is found by chasing all links
165 both at the file level and at the levels of the containing directories."
168 (put 'find-file-visit-truename
'safe-local-variable
'booleanp
)
170 (defcustom revert-without-query nil
171 "Specify which files should be reverted without query.
172 The value is a list of regular expressions.
173 If the file name matches one of these regular expressions,
174 then `revert-buffer' reverts the file without querying
175 if the file has changed on disk and you have not edited the buffer."
176 :type
'(repeat regexp
)
179 (defvar buffer-file-number nil
180 "The device number and file number of the file visited in the current buffer.
181 The value is a list of the form (FILENUM DEVNUM).
182 This pair of numbers uniquely identifies the file.
183 If the buffer is visiting a new file, the value is nil.")
184 (make-variable-buffer-local 'buffer-file-number
)
185 (put 'buffer-file-number
'permanent-local t
)
187 (defvar buffer-file-numbers-unique
(not (memq system-type
'(windows-nt)))
188 "Non-nil means that `buffer-file-number' uniquely identifies files.")
190 (defvar buffer-file-read-only nil
191 "Non-nil if visited file was read-only when visited.")
192 (make-variable-buffer-local 'buffer-file-read-only
)
194 (defcustom temporary-file-directory
195 (file-name-as-directory
196 (cond ((memq system-type
'(ms-dos windows-nt
))
197 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
199 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
200 "The directory for writing temporary files."
202 :initialize
'custom-initialize-delay
205 (defcustom small-temporary-file-directory
206 (if (eq system-type
'ms-dos
) (getenv "TMPDIR"))
207 "The directory for writing small temporary files.
208 If non-nil, this directory is used instead of `temporary-file-directory'
209 by programs that create small temporary files. This is for systems that
210 have fast storage with limited space, such as a RAM disk."
212 :initialize
'custom-initialize-delay
213 :type
'(choice (const nil
) directory
))
215 ;; The system null device. (Should reference NULL_DEVICE from C.)
216 (defvar null-device
(purecopy "/dev/null") "The system null device.")
218 (declare-function msdos-long-file-names
"msdos.c")
219 (declare-function w32-long-file-name
"w32proc.c")
220 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
221 (declare-function dired-unmark
"dired" (arg))
222 (declare-function dired-do-flagged-delete
"dired" (&optional nomessage
))
223 (declare-function dos-8
+3-filename
"dos-fns" (filename))
224 (declare-function view-mode-disable
"view" ())
225 (declare-function dosified-file-name
"dos-fns" (file-name))
227 (defvar file-name-invalid-regexp
228 (cond ((and (eq system-type
'ms-dos
) (not (msdos-long-file-names)))
230 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
231 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
232 "[\000-\037]\\|" ; control characters
233 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
234 "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot
235 ((memq system-type
'(ms-dos windows-nt cygwin
))
237 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
238 "[|<>\"?*\000-\037]"))) ; invalid characters
239 (t (purecopy "[\000]")))
240 "Regexp recognizing file names which aren't allowed by the filesystem.")
242 (defcustom file-precious-flag nil
243 "Non-nil means protect against I/O errors while saving files.
244 Some modes set this non-nil in particular buffers.
246 This feature works by writing the new contents into a temporary file
247 and then renaming the temporary file to replace the original.
248 In this way, any I/O error in writing leaves the original untouched,
249 and there is never any instant where the file is nonexistent.
251 Note that this feature forces backups to be made by copying.
252 Yet, at the same time, saving a precious file
253 breaks any hard links between it and other files.
255 This feature is advisory: for example, if the directory in which the
256 file is being saved is not writable, Emacs may ignore a non-nil value
257 of `file-precious-flag' and write directly into the file.
259 See also: `break-hardlink-on-save'."
263 (defcustom break-hardlink-on-save nil
264 "Non-nil means when saving a file that exists under several names
265 \(i.e., has multiple hardlinks), break the hardlink associated with
266 `buffer-file-name' and write to a new file, so that the other
267 instances of the file are not affected by the save.
269 If `buffer-file-name' refers to a symlink, do not break the symlink.
271 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
272 For example, if the directory in which a file is being saved is not
273 itself writable, then error instead of saving in some
274 hardlink-nonbreaking way.
276 See also `backup-by-copying' and `backup-by-copying-when-linked'."
281 (defcustom version-control nil
282 "Control use of version numbers for backup files.
283 When t, make numeric backup versions unconditionally.
284 When nil, make them for files that have some already.
285 The value `never' means do not make them."
286 :type
'(choice (const :tag
"Never" never
)
287 (const :tag
"If existing" nil
)
288 (other :tag
"Always" t
))
291 (put 'version-control
'safe-local-variable
292 '(lambda (x) (or (booleanp x
) (equal x
'never
))))
294 (defcustom dired-kept-versions
2
295 "When cleaning directory, number of versions to keep."
300 (defcustom delete-old-versions nil
301 "If t, delete excess backup versions silently.
302 If nil, ask confirmation. Any other value prevents any trimming."
303 :type
'(choice (const :tag
"Delete" t
)
304 (const :tag
"Ask" nil
)
305 (other :tag
"Leave" other
))
308 (defcustom kept-old-versions
2
309 "Number of oldest versions to keep when a new numbered backup is made."
312 (put 'kept-old-versions
'safe-local-variable
'integerp
)
314 (defcustom kept-new-versions
2
315 "Number of newest versions to keep when a new numbered backup is made.
316 Includes the new backup. Must be > 0"
319 (put 'kept-new-versions
'safe-local-variable
'integerp
)
321 (defcustom require-final-newline nil
322 "Whether to add a newline automatically at the end of the file.
324 A value of t means do this only when the file is about to be saved.
325 A value of `visit' means do this right after the file is visited.
326 A value of `visit-save' means do it at both of those times.
327 Any other non-nil value means ask user whether to add a newline, when saving.
328 A value of nil means don't add newlines.
330 Certain major modes set this locally to the value obtained
331 from `mode-require-final-newline'."
332 :type
'(choice (const :tag
"When visiting" visit
)
333 (const :tag
"When saving" t
)
334 (const :tag
"When visiting or saving" visit-save
)
335 (const :tag
"Don't add newlines" nil
)
336 (other :tag
"Ask each time" ask
))
337 :group
'editing-basics
)
339 (defcustom mode-require-final-newline t
340 "Whether to add a newline at end of file, in certain major modes.
341 Those modes set `require-final-newline' to this value when you enable them.
342 They do so because they are often used for files that are supposed
343 to end in newlines, and the question is how to arrange that.
345 A value of t means do this only when the file is about to be saved.
346 A value of `visit' means do this right after the file is visited.
347 A value of `visit-save' means do it at both of those times.
348 Any other non-nil value means ask user whether to add a newline, when saving.
350 A value of nil means do not add newlines. That is a risky choice in this
351 variable since this value is used for modes for files that ought to have
352 final newlines. So if you set this to nil, you must explicitly check and
353 add a final newline, whenever you save a file that really needs one."
354 :type
'(choice (const :tag
"When visiting" visit
)
355 (const :tag
"When saving" t
)
356 (const :tag
"When visiting or saving" visit-save
)
357 (const :tag
"Don't add newlines" nil
)
358 (other :tag
"Ask each time" ask
))
359 :group
'editing-basics
362 (defcustom auto-save-default t
363 "Non-nil says by default do auto-saving of every file-visiting buffer."
367 (defcustom auto-save-file-name-transforms
368 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
369 ;; Don't put "\\2" inside expand-file-name, since it will be
370 ;; transformed to "/2" on DOS/Windows.
371 ,(concat temporary-file-directory
"\\2") t
))
372 "Transforms to apply to buffer file name before making auto-save file name.
373 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
374 REGEXP is a regular expression to match against the file name.
375 If it matches, `replace-match' is used to replace the
376 matching part with REPLACEMENT.
377 If the optional element UNIQUIFY is non-nil, the auto-save file name is
378 constructed by taking the directory part of the replaced file-name,
379 concatenated with the buffer file name with all directory separators
380 changed to `!' to prevent clashes. This will not work
381 correctly if your filesystem truncates the resulting name.
383 All the transforms in the list are tried, in the order they are listed.
384 When one transform applies, its result is final;
385 no further transforms are tried.
387 The default value is set up to put the auto-save file into the
388 temporary directory (see the variable `temporary-file-directory') for
389 editing a remote file.
391 On MS-DOS filesystems without long names this variable is always
394 :type
'(repeat (list (string :tag
"Regexp") (string :tag
"Replacement")
395 (boolean :tag
"Uniquify")))
396 :initialize
'custom-initialize-delay
399 (defcustom save-abbrevs t
400 "Non-nil means save word abbrevs too when files are saved.
401 If `silently', don't ask the user before saving."
402 :type
'(choice (const t
) (const nil
) (const silently
))
405 (defcustom find-file-run-dired t
406 "Non-nil means allow `find-file' to visit directories.
407 To visit the directory, `find-file' runs `find-directory-functions'."
411 (defcustom find-directory-functions
'(cvs-dired-noselect dired-noselect
)
412 "List of functions to try in sequence to visit a directory.
413 Each function is called with the directory name as the sole argument
414 and should return either a buffer or nil."
415 :type
'(hook :options
(cvs-dired-noselect dired-noselect
))
418 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
419 (defcustom file-name-at-point-functions
'(ffap-guess-file-name-at-point)
420 "List of functions to try in sequence to get a file name at point.
421 Each function should return either nil or a file name found at the
422 location of point in the current buffer."
423 :type
'(hook :options
(ffap-guess-file-name-at-point))
426 ;;;It is not useful to make this a local variable.
427 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
428 (defvar find-file-not-found-functions nil
429 "List of functions to be called for `find-file' on nonexistent file.
430 These functions are called as soon as the error is detected.
431 Variable `buffer-file-name' is already set up.
432 The functions are called in the order given until one of them returns non-nil.")
433 (define-obsolete-variable-alias 'find-file-not-found-hooks
434 'find-file-not-found-functions
"22.1")
436 ;;;It is not useful to make this a local variable.
437 ;;;(put 'find-file-hooks 'permanent-local t)
438 (define-obsolete-variable-alias 'find-file-hooks
'find-file-hook
"22.1")
439 (defcustom find-file-hook nil
440 "List of functions to be called after a buffer is loaded from a file.
441 The buffer's local variables (if any) will have been processed before the
442 functions are called."
445 :options
'(auto-insert)
448 (defvar write-file-functions nil
449 "List of functions to be called before writing out a buffer to a file.
450 If one of them returns non-nil, the file is considered already written
451 and the rest are not called.
452 These hooks are considered to pertain to the visited file.
453 So any buffer-local binding of this variable is discarded if you change
454 the visited file name with \\[set-visited-file-name], but not when you
455 change the major mode.
457 This hook is not run if any of the functions in
458 `write-contents-functions' returns non-nil. Both hooks pertain
459 to how to save a buffer to file, for instance, choosing a suitable
460 coding system and setting mode bits. (See Info
461 node `(elisp)Saving Buffers'.) To perform various checks or
462 updates before the buffer is saved, use `before-save-hook'.")
463 (put 'write-file-functions
'permanent-local t
)
464 (define-obsolete-variable-alias 'write-file-hooks
'write-file-functions
"22.1")
466 (defvar local-write-file-hooks nil
)
467 (make-variable-buffer-local 'local-write-file-hooks
)
468 (put 'local-write-file-hooks
'permanent-local t
)
469 (make-obsolete-variable 'local-write-file-hooks
'write-file-functions
"22.1")
471 (defvar write-contents-functions nil
472 "List of functions to be called before writing out a buffer to a file.
473 If one of them returns non-nil, the file is considered already written
474 and the rest are not called and neither are the functions in
475 `write-file-functions'.
477 This variable is meant to be used for hooks that pertain to the
478 buffer's contents, not to the particular visited file; thus,
479 `set-visited-file-name' does not clear this variable; but changing the
480 major mode does clear it.
482 For hooks that _do_ pertain to the particular visited file, use
483 `write-file-functions'. Both this variable and
484 `write-file-functions' relate to how a buffer is saved to file.
485 To perform various checks or updates before the buffer is saved,
486 use `before-save-hook'.")
487 (make-variable-buffer-local 'write-contents-functions
)
488 (define-obsolete-variable-alias 'write-contents-hooks
489 'write-contents-functions
"22.1")
491 (defcustom enable-local-variables t
492 "Control use of local variables in files you visit.
493 The value can be t, nil, :safe, :all, or something else.
495 A value of t means file local variables specifications are obeyed
496 if all the specified variable values are safe; if any values are
497 not safe, Emacs queries you, once, whether to set them all.
498 \(When you say yes to certain values, they are remembered as safe.)
500 :safe means set the safe variables, and ignore the rest.
501 :all means set all variables, whether safe or not.
502 (Don't set it permanently to :all.)
503 A value of nil means always ignore the file local variables.
505 Any other value means always query you once whether to set them all.
506 \(When you say yes to certain values, they are remembered as safe, but
507 this has no effect when `enable-local-variables' is \"something else\".)
509 This variable also controls use of major modes specified in
512 The command \\[normal-mode], when used interactively,
513 always obeys file local variable specifications and the -*- line,
514 and ignores this variable."
516 :type
'(choice (const :tag
"Query Unsafe" t
)
517 (const :tag
"Safe Only" :safe
)
518 (const :tag
"Do all" :all
)
519 (const :tag
"Ignore" nil
)
520 (other :tag
"Query" other
))
523 (defvar local-enable-local-variables t
524 "Like `enable-local-variables' but meant for buffer-local bindings.
525 The meaningful values are nil and non-nil. The default is non-nil.
526 If a major mode sets this to nil, buffer-locally, then any local
527 variables list in the file will be ignored.
529 This variable does not affect the use of major modes
530 specified in a -*- line.")
532 (defcustom enable-local-eval
'maybe
533 "Control processing of the \"variable\" `eval' in a file's local variables.
534 The value can be t, nil or something else.
535 A value of t means obey `eval' variables.
536 A value of nil means ignore them; anything else means query."
538 :type
'(choice (const :tag
"Obey" t
)
539 (const :tag
"Ignore" nil
)
540 (other :tag
"Query" other
))
543 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
544 (or (fboundp 'lock-buffer
)
545 (defalias 'lock-buffer
'ignore
))
546 (or (fboundp 'unlock-buffer
)
547 (defalias 'unlock-buffer
'ignore
))
548 (or (fboundp 'file-locked-p
)
549 (defalias 'file-locked-p
'ignore
))
551 (defcustom view-read-only nil
552 "Non-nil means buffers visiting files read-only do so in view mode.
553 In fact, this means that all read-only buffers normally have
554 View mode enabled, including buffers that are read-only because
555 you visit a file you cannot alter, and buffers you make read-only
556 using \\[toggle-read-only]."
560 (defvar file-name-history nil
561 "History list of file names entered in the minibuffer.
563 Maximum length of the history list is determined by the value
564 of `history-length', which see.")
566 (put 'ange-ftp-completion-hook-function
'safe-magic t
)
567 (defun ange-ftp-completion-hook-function (op &rest args
)
568 "Provides support for ange-ftp host name completion.
569 Runs the usual ange-ftp hook, but only for completion operations."
570 ;; Having this here avoids the need to load ange-ftp when it's not
572 (if (memq op
'(file-name-completion file-name-all-completions
))
573 (apply 'ange-ftp-hook-function op args
)
574 (let ((inhibit-file-name-handlers
575 (cons 'ange-ftp-completion-hook-function
576 (and (eq inhibit-file-name-operation op
)
577 inhibit-file-name-handlers
)))
578 (inhibit-file-name-operation op
))
581 (defun convert-standard-filename (filename)
582 "Convert a standard file's name to something suitable for the OS.
583 This means to guarantee valid names and perhaps to canonicalize
586 FILENAME should be an absolute file name since the conversion rules
587 sometimes vary depending on the position in the file name. E.g. c:/foo
588 is a valid DOS file name, but c:/bar/c:/foo is not.
590 This function's standard definition is trivial; it just returns
591 the argument. However, on Windows and DOS, replace invalid
592 characters. On DOS, make sure to obey the 8.3 limitations.
593 In the native Windows build, turn Cygwin names into native names,
594 and also turn slashes into backslashes if the shell requires it (see
595 `w32-shell-dos-semantics').
597 See Info node `(elisp)Standard File Names' for more details."
598 (if (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)))
608 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
609 "Read directory name, prompting with PROMPT and completing in directory DIR.
610 Value is not expanded---you must call `expand-file-name' yourself.
611 Default name to DEFAULT-DIRNAME if user exits with the same
612 non-empty string that was inserted by this function.
613 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
614 or just DIR if INITIAL is nil.)
615 If the user exits with an empty minibuffer, this function returns
616 an empty string. (This can only happen if the user erased the
617 pre-inserted contents or if `insert-default-directory' is nil.)
618 Fourth arg MUSTMATCH non-nil means require existing directory's name.
619 Non-nil and non-t means also require confirmation after completion.
620 Fifth arg INITIAL specifies text to start with.
621 DIR should be an absolute directory name. It defaults to
622 the value of `default-directory'."
624 (setq dir default-directory
))
625 (read-file-name prompt dir
(or default-dirname
626 (if initial
(expand-file-name initial dir
)
633 "Show the current default directory."
635 (message "Directory %s" default-directory
))
638 "Value of the CDPATH environment variable, as a list.
639 Not actually set up until the first time you use it.")
641 (defun parse-colon-path (cd-path)
642 "Explode a search path into a list of directory names.
643 Directories are separated by occurrences of `path-separator'
644 \(which is colon in GNU and GNU-like systems)."
645 ;; We could use split-string here.
647 (let (cd-list (cd-start 0) cd-colon
)
648 (setq cd-path
(concat cd-path path-separator
))
649 (while (setq cd-colon
(string-match path-separator cd-path cd-start
))
652 (list (if (= cd-start cd-colon
)
654 (substitute-in-file-name
655 (file-name-as-directory
656 (substring cd-path cd-start cd-colon
)))))))
657 (setq cd-start
(+ cd-colon
1)))
660 (defun cd-absolute (dir)
661 "Change current directory to given absolute file name DIR."
662 ;; Put the name into directory syntax now,
663 ;; because otherwise expand-file-name may give some bad results.
664 (setq dir
(file-name-as-directory dir
))
665 ;; We used to additionally call abbreviate-file-name here, for an
666 ;; unknown reason. Problem is that most buffers are setup
667 ;; without going through cd-absolute and don't call
668 ;; abbreviate-file-name on their default-directory, so the few that
669 ;; do end up using a superficially different directory.
670 (setq dir
(expand-file-name dir
))
671 (if (not (file-directory-p dir
))
672 (if (file-exists-p dir
)
673 (error "%s is not a directory" dir
)
674 (error "%s: no such directory" dir
))
675 (unless (file-executable-p dir
)
676 (error "Cannot cd to %s: Permission denied" dir
))
677 (setq default-directory dir
)
678 (setq list-buffers-directory dir
)))
681 "Make DIR become the current buffer's default directory.
682 If your environment includes a `CDPATH' variable, try each one of
683 that list of directories (separated by occurrences of
684 `path-separator') when resolving a relative directory name.
685 The path separator is colon in GNU and GNU-like systems."
687 (list (read-directory-name "Change default directory: "
688 default-directory default-directory
689 (and (member cd-path
'(nil ("./")))
690 (null (getenv "CDPATH"))))))
691 (if (file-name-absolute-p dir
)
692 (cd-absolute (expand-file-name dir
))
694 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
695 (setq cd-path
(or trypath
(list "./")))))
696 (if (not (catch 'found
698 (function (lambda (x)
699 (let ((f (expand-file-name (concat x dir
))))
700 (if (file-directory-p f
)
703 (throw 'found t
))))))
706 (error "No such directory found via CDPATH environment variable"))))
708 (defun load-file (file)
709 "Load the Lisp file named FILE."
710 ;; This is a case where .elc makes a lot of sense.
711 (interactive (list (let ((completion-ignored-extensions
712 (remove ".elc" completion-ignored-extensions
)))
713 (read-file-name "Load file: "))))
714 (load (expand-file-name file
) nil nil t
))
716 (defun locate-file (filename path
&optional suffixes predicate
)
717 "Search for FILENAME through PATH.
718 If found, return the absolute file name of FILENAME, with its suffixes;
719 otherwise return nil.
720 PATH should be a list of directories to look in, like the lists in
721 `exec-path' or `load-path'.
722 If SUFFIXES is non-nil, it should be a list of suffixes to append to
723 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
724 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
725 If non-nil, PREDICATE is used instead of `file-readable-p'.
726 PREDICATE can also be an integer to pass to the `access' system call,
727 in which case file-name handlers are ignored. This usage is deprecated.
729 For compatibility, PREDICATE can also be one of the symbols
730 `executable', `readable', `writable', or `exists', or a list of
731 one or more of those symbols."
732 (if (and predicate
(symbolp predicate
) (not (functionp predicate
)))
733 (setq predicate
(list predicate
)))
734 (when (and (consp predicate
) (not (functionp predicate
)))
736 (logior (if (memq 'executable predicate
) 1 0)
737 (if (memq 'writable predicate
) 2 0)
738 (if (memq 'readable predicate
) 4 0))))
739 (locate-file-internal filename path suffixes predicate
))
741 (defun locate-file-completion-table (dirs suffixes string pred action
)
742 "Do completion for file names passed to `locate-file'."
744 ((file-name-absolute-p string
)
745 ;; FIXME: maybe we should use completion-file-name-table instead,
746 ;; tho at least for `load', the arg is passed through
747 ;; substitute-in-file-name for historical reasons.
748 (read-file-name-internal string pred action
))
749 ((eq (car-safe action
) 'boundaries
)
750 (let ((suffix (cdr action
)))
752 (length (file-name-directory string
))
753 (let ((x (file-name-directory suffix
)))
754 (if x
(1- (length x
)) (length suffix
))))))
757 (suffix (concat (regexp-opt suffixes t
) "\\'"))
758 (string-dir (file-name-directory string
))
759 (string-file (file-name-nondirectory string
)))
762 (setq dir default-directory
))
763 (if string-dir
(setq dir
(expand-file-name string-dir dir
)))
764 (when (file-directory-p dir
)
765 (dolist (file (file-name-all-completions
768 (when (string-match suffix file
)
769 (setq file
(substring file
0 (match-beginning 0)))
770 (push file names
)))))
771 (completion-table-with-context
772 string-dir names string-file pred action
)))))
774 (defun locate-file-completion (string path-and-suffixes action
)
775 "Do completion for file names passed to `locate-file'.
776 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
777 (locate-file-completion-table (car path-and-suffixes
)
778 (cdr path-and-suffixes
)
780 (make-obsolete 'locate-file-completion
'locate-file-completion-table
"23.1")
782 (defvar locate-dominating-stop-dir-regexp
783 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
784 "Regexp of directory names which stop the search in `locate-dominating-file'.
785 Any directory whose name matches this regexp will be treated like
786 a kind of root directory by `locate-dominating-file' which will stop its search
787 when it bumps into it.
788 The default regexp prevents fruitless and time-consuming attempts to find
789 special files in directories in which filenames are interpreted as hostnames,
790 or mount points potentially requiring authentication as a different user.")
792 ;; (defun locate-dominating-files (file regexp)
793 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
794 ;; Stop at the first parent where a matching file is found and return the list
795 ;; of files that that match in this directory."
797 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
798 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
800 ;; ;; Abbreviate, so as to stop when we cross ~/.
801 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
804 ;; ;; As a heuristic, we stop looking up the hierarchy of
805 ;; ;; directories as soon as we find a directory belonging to
806 ;; ;; another user. This should save us from looking in
807 ;; ;; things like /net and /afs. This assumes that all the
808 ;; ;; files inside a project belong to the same user.
809 ;; (let ((prev-user user))
810 ;; (setq user (nth 2 (file-attributes dir)))
811 ;; (or (null prev-user) (equal user prev-user))))
812 ;; (if (setq files (condition-case nil
813 ;; (directory-files dir 'full regexp 'nosort)
815 ;; (throw 'found files)
817 ;; (setq dir (file-name-directory
818 ;; (directory-file-name dir))))
822 (defun locate-dominating-file (file name
)
823 "Look up the directory hierarchy from FILE for a file named NAME.
824 Stop at the first parent directory containing a file NAME,
825 and return the directory. Return nil if not found."
826 ;; We used to use the above locate-dominating-files code, but the
827 ;; directory-files call is very costly, so we're much better off doing
828 ;; multiple calls using the code in here.
830 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
831 ;; `name' in /home or in /.
832 (setq file
(abbreviate-file-name file
))
835 ;; `user' is not initialized outside the loop because
836 ;; `file' may not exist, so we may have to walk up part of the
837 ;; hierarchy before we find the "initial UID".
842 ;; FIXME: Disabled this heuristic because it is sometimes
844 ;; As a heuristic, we stop looking up the hierarchy of
845 ;; directories as soon as we find a directory belonging
846 ;; to another user. This should save us from looking in
847 ;; things like /net and /afs. This assumes that all the
848 ;; files inside a project belong to the same user.
849 ;; (let ((prev-user user))
850 ;; (setq user (nth 2 (file-attributes file)))
851 ;; (and prev-user (not (equal user prev-user))))
852 (string-match locate-dominating-stop-dir-regexp file
)))
853 (setq try
(file-exists-p (expand-file-name name file
)))
854 (cond (try (setq root file
))
855 ((equal file
(setq prev-file file
856 file
(file-name-directory
857 (directory-file-name file
))))
862 (defun executable-find (command)
863 "Search for COMMAND in `exec-path' and return the absolute file name.
864 Return nil if COMMAND is not found anywhere in `exec-path'."
865 ;; Use 1 rather than file-executable-p to better match the behavior of
867 (locate-file command exec-path exec-suffixes
1))
869 (defun load-library (library)
870 "Load the Emacs Lisp library named LIBRARY.
871 This is an interface to the function `load'. LIBRARY is searched
872 for in `load-path', both with and without `load-suffixes' (as
873 well as `load-file-rep-suffixes').
875 See Info node `(emacs)Lisp Libraries' for more details.
876 See `load-file' for a different interface to `load'."
878 (list (completing-read "Load library: "
879 (apply-partially 'locate-file-completion-table
881 (get-load-suffixes)))))
884 (defun file-remote-p (file &optional identification connected
)
885 "Test whether FILE specifies a location on a remote system.
886 Returns nil or a string identifying the remote connection (ideally
887 a prefix of FILE). For example, the remote identification for filename
888 \"/user@host:/foo\" could be \"/user@host:\".
889 A file is considered \"remote\" if accessing it is likely to be slower or
890 less reliable than accessing local files.
891 Furthermore, relative file names do not work across remote connections.
893 IDENTIFICATION specifies which part of the identification shall
894 be returned as string. IDENTIFICATION can be the symbol
895 `method', `user', `host' or `localname'; any other value is
896 handled like nil and means to return the complete identification
899 If CONNECTED is non-nil, the function returns an identification only
900 if FILE is located on a remote system, and a connection is established
901 to that remote system.
903 `file-remote-p' will never open a connection on its own."
904 (let ((handler (find-file-name-handler file
'file-remote-p
)))
906 (funcall handler
'file-remote-p file identification connected
)
909 (defun file-local-copy (file)
910 "Copy the file FILE into a temporary file on this machine.
911 Returns the name of the local copy, or nil, if FILE is directly
913 ;; This formerly had an optional BUFFER argument that wasn't used by
915 (let ((handler (find-file-name-handler file
'file-local-copy
)))
917 (funcall handler
'file-local-copy file
)
920 (defun file-truename (filename &optional counter prev-dirs
)
921 "Return the truename of FILENAME, which should be absolute.
922 The truename of a file name is found by chasing symbolic links
923 both at the level of the file and at the level of the directories
924 containing it, until no links are left at any level.
926 \(fn FILENAME)" ;; Don't document the optional arguments.
927 ;; COUNTER and PREV-DIRS are only used in recursive calls.
928 ;; COUNTER can be a cons cell whose car is the count of how many
929 ;; more links to chase before getting an error.
930 ;; PREV-DIRS can be a cons cell whose car is an alist
931 ;; of truenames we've just recently computed.
932 (cond ((or (string= filename
"") (string= filename
"~"))
933 (setq filename
(expand-file-name filename
))
934 (if (string= filename
"")
935 (setq filename
"/")))
936 ((and (string= (substring filename
0 1) "~")
937 (string-match "~[^/]*/?" filename
))
939 (substring filename
0 (match-end 0)))
940 (rest (substring filename
(match-end 0))))
941 (setq filename
(concat (expand-file-name first-part
) rest
)))))
943 (or counter
(setq counter
(list 100)))
945 ;; For speed, remove the ange-ftp completion handler from the list.
946 ;; We know it's not needed here.
947 ;; For even more speed, do this only on the outermost call.
948 (file-name-handler-alist
949 (if prev-dirs file-name-handler-alist
950 (let ((tem (copy-sequence file-name-handler-alist
)))
951 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
952 (or prev-dirs
(setq prev-dirs
(list nil
)))
954 ;; andrewi@harlequin.co.uk - none of the following code (except for
955 ;; invoking the file-name handler) currently applies on Windows
956 ;; (ie. there are no native symlinks), but there is an issue with
957 ;; case differences being ignored by the OS, and short "8.3 DOS"
958 ;; name aliases existing for all files. (The short names are not
959 ;; reported by directory-files, but can be used to refer to files.)
960 ;; It seems appropriate for file-truename to resolve these issues in
961 ;; the most natural way, which on Windows is to call the function
962 ;; `w32-long-file-name' - this returns the exact name of a file as
963 ;; it is stored on disk (expanding short name aliases with the full
964 ;; name in the process).
965 (if (eq system-type
'windows-nt
)
966 (let ((handler (find-file-name-handler filename
'file-truename
)))
967 ;; For file name that has a special handler, call handler.
968 ;; This is so that ange-ftp can save time by doing a no-op.
970 (setq filename
(funcall handler
'file-truename filename
))
971 ;; If filename contains a wildcard, newname will be the old name.
972 (unless (string-match "[[*?]" filename
)
973 ;; If filename exists, use the long name. If it doesn't exist,
974 ;; drill down until we find a directory that exists, and use
975 ;; the long name of that, with the extra non-existent path
976 ;; components concatenated.
977 (let ((longname (w32-long-file-name filename
))
980 (setq filename longname
)
981 ;; Include the preceding directory separator in the missing
982 ;; part so subsequent recursion on the rest works.
983 (setq missing
(concat "/" (file-name-nondirectory filename
)))
984 (let ((length (length missing
)))
986 (if (> length
(length filename
))
988 (substring filename
0 (- length
)))))
989 (setq filename
(concat (file-truename rest
) missing
))))))
992 ;; If this file directly leads to a link, process that iteratively
993 ;; so that we don't use lots of stack.
995 (setcar counter
(1- (car counter
)))
996 (if (< (car counter
) 0)
997 (error "Apparent cycle of symbolic links for %s" filename
))
998 (let ((handler (find-file-name-handler filename
'file-truename
)))
999 ;; For file name that has a special handler, call handler.
1000 ;; This is so that ange-ftp can save time by doing a no-op.
1002 (setq filename
(funcall handler
'file-truename filename
)
1004 (let ((dir (or (file-name-directory filename
) default-directory
))
1006 ;; Get the truename of the directory.
1007 (setq dirfile
(directory-file-name dir
))
1008 ;; If these are equal, we have the (or a) root directory.
1009 (or (string= dir dirfile
)
1010 ;; If this is the same dir we last got the truename for,
1011 ;; save time--don't recalculate.
1012 (if (assoc dir
(car prev-dirs
))
1013 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
1015 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
1016 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
1018 (if (equal ".." (file-name-nondirectory filename
))
1020 (directory-file-name (file-name-directory (directory-file-name dir
)))
1022 (if (equal "." (file-name-nondirectory filename
))
1023 (setq filename
(directory-file-name dir
)
1025 ;; Put it back on the file name.
1026 (setq filename
(concat dir
(file-name-nondirectory filename
)))
1027 ;; Is the file name the name of a link?
1028 (setq target
(file-symlink-p filename
))
1030 ;; Yes => chase that link, then start all over
1031 ;; since the link may point to a directory name that uses links.
1032 ;; We can't safely use expand-file-name here
1033 ;; since target might look like foo/../bar where foo
1034 ;; is itself a link. Instead, we handle . and .. above.
1036 (if (file-name-absolute-p target
)
1038 (concat dir target
))
1041 (setq done t
))))))))
1044 (defun file-chase-links (filename &optional limit
)
1045 "Chase links in FILENAME until a name that is not a link.
1046 Unlike `file-truename', this does not check whether a parent
1047 directory name is a symbolic link.
1048 If the optional argument LIMIT is a number,
1049 it means chase no more than that many links and then stop."
1050 (let (tem (newname filename
)
1052 (while (and (or (null limit
) (< count limit
))
1053 (setq tem
(file-symlink-p newname
)))
1055 (if (and (null limit
) (= count
100))
1056 (error "Apparent cycle of symbolic links for %s" filename
))
1057 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1058 (while (string-match "//+" tem
)
1059 (setq tem
(replace-match "/" nil nil tem
)))
1060 ;; Handle `..' by hand, since it needs to work in the
1061 ;; target of any directory symlink.
1062 ;; This code is not quite complete; it does not handle
1063 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1064 (while (string-match "\\`\\.\\./" tem
)
1065 (setq tem
(substring tem
3))
1066 (setq newname
(expand-file-name newname
))
1067 ;; Chase links in the default dir of the symlink.
1070 (directory-file-name (file-name-directory newname
))))
1071 ;; Now find the parent of that dir.
1072 (setq newname
(file-name-directory newname
)))
1073 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
1074 (setq count
(1+ count
))))
1077 (defun make-temp-file (prefix &optional dir-flag suffix
)
1078 "Create a temporary file.
1079 The returned file name (created by appending some random characters at the end
1080 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1081 is guaranteed to point to a newly created empty file.
1082 You can then use `write-region' to write new data into the file.
1084 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1086 If SUFFIX is non-nil, add that at the end of the file name."
1087 (let ((umask (default-file-modes))
1091 ;; Create temp files with strict access rights. It's easy to
1092 ;; loosen them later, whereas it's impossible to close the
1093 ;; time-window of loose permissions otherwise.
1094 (set-default-file-modes ?
\700)
1095 (while (condition-case ()
1099 (if (zerop (length prefix
))
1100 (file-name-as-directory
1101 temporary-file-directory
)
1102 (expand-file-name prefix
1103 temporary-file-directory
))))
1105 (setq file
(concat file suffix
)))
1107 (make-directory file
)
1108 (write-region "" nil file nil
'silent nil
'excl
))
1110 (file-already-exists t
))
1111 ;; the file was somehow created by someone else between
1112 ;; `make-temp-name' and `write-region', let's try again.
1116 (set-default-file-modes umask
))))
1118 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
1119 "Change the encoding of FILE's name from CODING to NEW-CODING.
1120 The value is a new name of FILE.
1121 Signals a `file-already-exists' error if a file of the new name
1122 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1123 is non-nil. A number as fourth arg means request confirmation if
1124 the new name already exists. This is what happens in interactive
1127 (let ((default-coding (or file-name-coding-system
1128 default-file-name-coding-system
))
1129 (filename (read-file-name "Recode filename: " nil nil t
))
1130 from-coding to-coding
)
1131 (if (and default-coding
1132 ;; We provide the default coding only when it seems that
1133 ;; the filename is correctly decoded by the default
1135 (let ((charsets (find-charset-string filename
)))
1136 (and (not (memq 'eight-bit-control charsets
))
1137 (not (memq 'eight-bit-graphic charsets
)))))
1138 (setq from-coding
(read-coding-system
1139 (format "Recode filename %s from (default %s): "
1140 filename default-coding
)
1142 (setq from-coding
(read-coding-system
1143 (format "Recode filename %s from: " filename
))))
1145 ;; We provide the default coding only when a user is going to
1146 ;; change the encoding not from the default coding.
1147 (if (eq from-coding default-coding
)
1148 (setq to-coding
(read-coding-system
1149 (format "Recode filename %s from %s to: "
1150 filename from-coding
)))
1151 (setq to-coding
(read-coding-system
1152 (format "Recode filename %s from %s to (default %s): "
1153 filename from-coding default-coding
)
1155 (list filename from-coding to-coding
)))
1157 (let* ((default-coding (or file-name-coding-system
1158 default-file-name-coding-system
))
1159 ;; FILE should have been decoded by DEFAULT-CODING.
1160 (encoded (encode-coding-string file default-coding
))
1161 (newname (decode-coding-string encoded coding
))
1162 (new-encoded (encode-coding-string newname new-coding
))
1163 ;; Suppress further encoding.
1164 (file-name-coding-system nil
)
1165 (default-file-name-coding-system nil
)
1166 (locale-coding-system nil
))
1167 (rename-file encoded new-encoded ok-if-already-exists
)
1170 (defcustom confirm-nonexistent-file-or-buffer
'after-completion
1171 "Whether confirmation is requested before visiting a new file or buffer.
1172 If nil, confirmation is not requested.
1173 If the value is `after-completion', confirmation is only
1174 requested if the user called `minibuffer-complete' right before
1175 `minibuffer-complete-and-exit'.
1176 Any other non-nil value means to request confirmation.
1178 This affects commands like `switch-to-buffer' and `find-file'."
1181 :type
'(choice (const :tag
"After completion" after-completion
)
1182 (const :tag
"Never" nil
)
1183 (other :tag
"Always" t
)))
1185 (defun confirm-nonexistent-file-or-buffer ()
1186 "Whether to request confirmation before visiting a new file or buffer.
1187 The variable `confirm-nonexistent-file-or-buffer' determines the
1188 return value, which may be passed as the REQUIRE-MATCH arg to
1189 `read-buffer' or `find-file-read-args'."
1190 (cond ((eq confirm-nonexistent-file-or-buffer
'after-completion
)
1191 'confirm-after-completion
)
1192 (confirm-nonexistent-file-or-buffer
1196 (defun read-buffer-to-switch (prompt)
1197 "Read the name of a buffer to switch to and return as a string.
1198 It is intended for `switch-to-buffer' family of commands since they
1199 need to omit the name of current buffer from the list of completions
1200 and default values."
1201 (let ((rbts-completion-table (internal-complete-buffer-except)))
1202 (minibuffer-with-setup-hook
1204 (setq minibuffer-completion-table rbts-completion-table
)
1205 ;; Since rbts-completion-table is built dynamically, we
1206 ;; can't just add it to the default value of
1207 ;; icomplete-with-completion-tables, so we add it
1209 (if (and (boundp 'icomplete-with-completion-tables
)
1210 (listp icomplete-with-completion-tables
))
1211 (set (make-local-variable 'icomplete-with-completion-tables
)
1212 (cons rbts-completion-table
1213 icomplete-with-completion-tables
))))
1214 (read-buffer prompt
(other-buffer (current-buffer))
1215 (confirm-nonexistent-file-or-buffer)))))
1217 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord
)
1218 "Select the buffer specified by BUFFER-OR-NAME in another window.
1219 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1220 nil. Return the buffer switched to.
1222 If called interactively, prompt for the buffer name using the
1223 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1224 determines whether to request confirmation before creating a new
1227 If BUFFER-OR-NAME is a string and does not identify an existing
1228 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1229 nil, switch to the buffer returned by `other-buffer'.
1231 Optional second argument NORECORD non-nil means do not put this
1232 buffer at the front of the list of recently selected ones.
1234 This uses the function `display-buffer' as a subroutine; see its
1235 documentation for additional customization information."
1237 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1238 (let ((pop-up-windows t
)
1239 same-window-buffer-names same-window-regexps
)
1240 (pop-to-buffer buffer-or-name t norecord
)))
1242 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord
)
1243 "Switch to buffer BUFFER-OR-NAME in another frame.
1244 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1245 nil. Return the buffer switched to.
1247 If called interactively, prompt for the buffer name using the
1248 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1249 determines whether to request confirmation before creating a new
1252 If BUFFER-OR-NAME is a string and does not identify an existing
1253 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1254 nil, switch to the buffer returned by `other-buffer'.
1256 Optional second arg NORECORD non-nil means do not put this
1257 buffer at the front of the list of recently selected ones.
1259 This uses the function `display-buffer' as a subroutine; see its
1260 documentation for additional customization information."
1262 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1263 (let ((pop-up-frames t
)
1264 same-window-buffer-names same-window-regexps
)
1265 (pop-to-buffer buffer-or-name t norecord
)))
1267 (defun display-buffer-other-frame (buffer)
1268 "Display buffer BUFFER in another frame.
1269 This uses the function `display-buffer' as a subroutine; see
1270 its documentation for additional customization information."
1271 (interactive "BDisplay buffer in other frame: ")
1272 (let ((pop-up-frames t
)
1273 same-window-buffer-names same-window-regexps
1274 (old-window (selected-window))
1276 (setq new-window
(display-buffer buffer t
))
1277 ;; This may have been here in order to prevent the new frame from hiding
1278 ;; the old frame. But it does more harm than good.
1279 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1280 ;;(lower-frame (window-frame new-window))
1282 ;; This may have been here in order to make sure the old-frame gets the
1283 ;; focus. But not only can it cause an annoying flicker, with some
1284 ;; window-managers it just makes the window invisible, with no easy
1285 ;; way to recover it. --Stef
1286 ;;(make-frame-invisible (window-frame old-window))
1287 ;;(make-frame-visible (window-frame old-window))
1290 (defmacro minibuffer-with-setup-hook
(fun &rest body
)
1291 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1292 BODY should use the minibuffer at most once.
1293 Recursive uses of the minibuffer are unaffected (FUN is not
1294 called additional times).
1296 This macro actually adds an auxiliary function that calls FUN,
1297 rather than FUN itself, to `minibuffer-setup-hook'."
1298 (declare (indent 1) (debug t
))
1299 (let ((hook (make-symbol "setup-hook")))
1303 ;; Clear out this hook so it does not interfere
1304 ;; with any recursive minibuffer usage.
1305 (remove-hook 'minibuffer-setup-hook
,hook
)
1309 (add-hook 'minibuffer-setup-hook
,hook
)
1311 (remove-hook 'minibuffer-setup-hook
,hook
)))))
1313 (defun find-file-read-args (prompt mustmatch
)
1314 (list (read-file-name prompt nil default-directory mustmatch
)
1317 (defun find-file (filename &optional wildcards
)
1318 "Edit file FILENAME.
1319 Switch to a buffer visiting file FILENAME,
1320 creating one if none already exists.
1321 Interactively, the default if you just type RET is the current directory,
1322 but the visited file name is available through the minibuffer history:
1323 type M-n to pull it into the minibuffer.
1325 You can visit files on remote machines by specifying something
1326 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1327 also visit local files as a different user by specifying
1328 /sudo::FILE for the file name.
1329 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1330 manual, for more about this.
1332 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1333 expand wildcards (if any) and visit multiple files. You can
1334 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1336 To visit a file without any kind of conversion and without
1337 automatically choosing a major mode, use \\[find-file-literally]."
1339 (find-file-read-args "Find file: "
1340 (confirm-nonexistent-file-or-buffer)))
1341 (let ((value (find-file-noselect filename nil nil wildcards
)))
1343 (mapcar 'switch-to-buffer
(nreverse value
))
1344 (switch-to-buffer value
))))
1346 (defun find-file-other-window (filename &optional wildcards
)
1347 "Edit file FILENAME, in another window.
1349 Like \\[find-file] (which see), but creates a new window or reuses
1350 an existing one. See the function `display-buffer'.
1352 Interactively, the default if you just type RET is the current directory,
1353 but the visited file name is available through the minibuffer history:
1354 type M-n to pull it into the minibuffer.
1356 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1357 expand wildcards (if any) and visit multiple files."
1359 (find-file-read-args "Find file in other window: "
1360 (confirm-nonexistent-file-or-buffer)))
1361 (let ((value (find-file-noselect filename nil nil wildcards
)))
1364 (setq value
(nreverse value
))
1365 (cons (switch-to-buffer-other-window (car value
))
1366 (mapcar 'switch-to-buffer
(cdr value
))))
1367 (switch-to-buffer-other-window value
))))
1369 (defun find-file-other-frame (filename &optional wildcards
)
1370 "Edit file FILENAME, in another frame.
1372 Like \\[find-file] (which see), but creates a new frame or reuses
1373 an existing one. See the function `display-buffer'.
1375 Interactively, the default if you just type RET is the current directory,
1376 but the visited file name is available through the minibuffer history:
1377 type M-n to pull it into the minibuffer.
1379 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1380 expand wildcards (if any) and visit multiple files."
1382 (find-file-read-args "Find file in other frame: "
1383 (confirm-nonexistent-file-or-buffer)))
1384 (let ((value (find-file-noselect filename nil nil wildcards
)))
1387 (setq value
(nreverse value
))
1388 (cons (switch-to-buffer-other-frame (car value
))
1389 (mapcar 'switch-to-buffer
(cdr value
))))
1390 (switch-to-buffer-other-frame value
))))
1392 (defun find-file-existing (filename)
1393 "Edit the existing file FILENAME.
1394 Like \\[find-file], but only allow a file that exists, and do not allow
1395 file names with wildcards."
1396 (interactive (nbutlast (find-file-read-args "Find existing file: " t
)))
1397 (if (and (not (called-interactively-p 'interactive
))
1398 (not (file-exists-p filename
)))
1399 (error "%s does not exist" filename
)
1400 (find-file filename
)
1403 (defun find-file-read-only (filename &optional wildcards
)
1404 "Edit file FILENAME but don't allow changes.
1405 Like \\[find-file], but marks buffer as read-only.
1406 Use \\[toggle-read-only] to permit editing."
1408 (find-file-read-args "Find file read-only: "
1409 (confirm-nonexistent-file-or-buffer)))
1410 (unless (or (and wildcards find-file-wildcards
1411 (not (string-match "\\`/:" filename
))
1412 (string-match "[[*?]" filename
))
1413 (file-exists-p filename
))
1414 (error "%s does not exist" filename
))
1415 (let ((value (find-file filename wildcards
)))
1416 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1417 (if (listp value
) value
(list value
)))
1420 (defun find-file-read-only-other-window (filename &optional wildcards
)
1421 "Edit file FILENAME in another window but don't allow changes.
1422 Like \\[find-file-other-window], but marks buffer as read-only.
1423 Use \\[toggle-read-only] to permit editing."
1425 (find-file-read-args "Find file read-only other window: "
1426 (confirm-nonexistent-file-or-buffer)))
1427 (unless (or (and wildcards find-file-wildcards
1428 (not (string-match "\\`/:" filename
))
1429 (string-match "[[*?]" filename
))
1430 (file-exists-p filename
))
1431 (error "%s does not exist" filename
))
1432 (let ((value (find-file-other-window filename wildcards
)))
1433 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1434 (if (listp value
) value
(list value
)))
1437 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1438 "Edit file FILENAME in another frame but don't allow changes.
1439 Like \\[find-file-other-frame], but marks buffer as read-only.
1440 Use \\[toggle-read-only] to permit editing."
1442 (find-file-read-args "Find file read-only other frame: "
1443 (confirm-nonexistent-file-or-buffer)))
1444 (unless (or (and wildcards find-file-wildcards
1445 (not (string-match "\\`/:" filename
))
1446 (string-match "[[*?]" filename
))
1447 (file-exists-p filename
))
1448 (error "%s does not exist" filename
))
1449 (let ((value (find-file-other-frame filename wildcards
)))
1450 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1451 (if (listp value
) value
(list value
)))
1454 (defun find-alternate-file-other-window (filename &optional wildcards
)
1455 "Find file FILENAME as a replacement for the file in the next window.
1456 This command does not select that window.
1458 See \\[find-file] for the possible forms of the FILENAME argument.
1460 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1461 expand wildcards (if any) and replace the file with multiple files."
1463 (save-selected-window
1465 (let ((file buffer-file-name
)
1469 (setq file-name
(file-name-nondirectory file
)
1470 file-dir
(file-name-directory file
)))
1471 (list (read-file-name
1472 "Find alternate file: " file-dir nil
1473 (confirm-nonexistent-file-or-buffer) file-name
)
1476 (find-file-other-window filename wildcards
)
1477 (save-selected-window
1479 (find-alternate-file filename wildcards
))))
1481 (defun find-alternate-file (filename &optional wildcards
)
1482 "Find file FILENAME, select its buffer, kill previous buffer.
1483 If the current buffer now contains an empty file that you just visited
1484 \(presumably by mistake), use this command to visit the file you really want.
1486 See \\[find-file] for the possible forms of the FILENAME argument.
1488 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1489 expand wildcards (if any) and replace the file with multiple files.
1491 If the current buffer is an indirect buffer, or the base buffer
1492 for one or more indirect buffers, the other buffer(s) are not
1495 (let ((file buffer-file-name
)
1499 (setq file-name
(file-name-nondirectory file
)
1500 file-dir
(file-name-directory file
)))
1501 (list (read-file-name
1502 "Find alternate file: " file-dir nil
1503 (confirm-nonexistent-file-or-buffer) file-name
)
1505 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1507 (when (and (buffer-modified-p) buffer-file-name
)
1508 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1511 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1512 (error "Aborted"))))
1513 (let ((obuf (current-buffer))
1514 (ofile buffer-file-name
)
1515 (onum buffer-file-number
)
1516 (odir dired-directory
)
1517 (otrue buffer-file-truename
)
1518 (oname (buffer-name)))
1519 ;; Run `kill-buffer-hook' here. It needs to happen before
1520 ;; variables like `buffer-file-name' etc are set to nil below,
1521 ;; because some of the hooks that could be invoked
1522 ;; (e.g., `save-place-to-alist') depend on those variables.
1524 ;; Note that `kill-buffer-hook' is not what queries whether to
1525 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1526 ;; asks that itself. Thus, there's no need to temporarily do
1527 ;; `(set-buffer-modified-p nil)' before running this hook.
1528 (run-hooks 'kill-buffer-hook
)
1529 ;; Okay, now we can end-of-life the old buffer.
1530 (if (get-buffer " **lose**")
1531 (kill-buffer " **lose**"))
1532 (rename-buffer " **lose**")
1536 ;; This prevents us from finding the same buffer
1537 ;; if we specified the same file again.
1538 (setq buffer-file-name nil
)
1539 (setq buffer-file-number nil
)
1540 (setq buffer-file-truename nil
)
1541 ;; Likewise for dired buffers.
1542 (setq dired-directory nil
)
1543 (find-file filename wildcards
))
1544 (when (eq obuf
(current-buffer))
1545 ;; This executes if find-file gets an error
1546 ;; and does not really find anything.
1547 ;; We put things back as they were.
1548 ;; If find-file actually finds something, we kill obuf below.
1549 (setq buffer-file-name ofile
)
1550 (setq buffer-file-number onum
)
1551 (setq buffer-file-truename otrue
)
1552 (setq dired-directory odir
)
1554 (rename-buffer oname
)))
1555 (unless (eq (current-buffer) obuf
)
1556 (with-current-buffer obuf
1557 ;; We already ran these; don't run them again.
1558 (let (kill-buffer-query-functions kill-buffer-hook
)
1559 (kill-buffer obuf
))))))
1561 (defun create-file-buffer (filename)
1562 "Create a suitably named buffer for visiting FILENAME, and return it.
1563 FILENAME (sans directory) is used unchanged if that name is free;
1564 otherwise a string <2> or <3> or ... is appended to get an unused name.
1565 Spaces at the start of FILENAME (sans directory) are removed."
1566 (let ((lastname (file-name-nondirectory filename
)))
1567 (if (string= lastname
"")
1568 (setq lastname filename
))
1570 (string-match "^ *\\(.*\\)" lastname
)
1571 (generate-new-buffer (match-string 1 lastname
)))))
1573 (defun generate-new-buffer (name)
1574 "Create and return a buffer with a name based on NAME.
1575 Choose the buffer's name using `generate-new-buffer-name'."
1576 (get-buffer-create (generate-new-buffer-name name
)))
1578 (defcustom automount-dir-prefix
(purecopy "^/tmp_mnt/")
1579 "Regexp to match the automounter prefix in a directory name."
1583 (defvar abbreviated-home-dir nil
1584 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1586 (defun abbreviate-file-name (filename)
1587 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1588 This also substitutes \"~\" for the user's home directory (unless the
1589 home directory is a root directory) and removes automounter prefixes
1590 \(see the variable `automount-dir-prefix')."
1591 ;; Get rid of the prefixes added by the automounter.
1593 (if (and automount-dir-prefix
1594 (string-match automount-dir-prefix filename
)
1595 (file-exists-p (file-name-directory
1596 (substring filename
(1- (match-end 0))))))
1597 (setq filename
(substring filename
(1- (match-end 0)))))
1598 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1599 ;; To fix this right, we need a `file-name-case-sensitive-p'
1600 ;; function, but we don't have that yet, so just guess.
1601 (let ((case-fold-search
1602 (memq system-type
'(ms-dos windows-nt darwin cygwin
))))
1603 ;; If any elt of directory-abbrev-alist matches this name,
1604 ;; abbreviate accordingly.
1605 (dolist (dir-abbrev directory-abbrev-alist
)
1606 (if (string-match (car dir-abbrev
) filename
)
1608 (concat (cdr dir-abbrev
)
1609 (substring filename
(match-end 0))))))
1610 ;; Compute and save the abbreviated homedir name.
1611 ;; We defer computing this until the first time it's needed, to
1612 ;; give time for directory-abbrev-alist to be set properly.
1613 ;; We include a slash at the end, to avoid spurious matches
1614 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1615 (or abbreviated-home-dir
1616 (setq abbreviated-home-dir
1617 (let ((abbreviated-home-dir "$foo"))
1618 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1621 ;; If FILENAME starts with the abbreviated homedir,
1622 ;; make it start with `~' instead.
1623 (if (and (string-match abbreviated-home-dir filename
)
1624 ;; If the home dir is just /, don't change it.
1625 (not (and (= (match-end 0) 1)
1626 (= (aref filename
0) ?
/)))
1627 ;; MS-DOS root directories can come with a drive letter;
1628 ;; Novell Netware allows drive letters beyond `Z:'.
1629 (not (and (memq system-type
'(ms-dos windows-nt cygwin
))
1631 (string-match "^[a-zA-`]:/$" filename
)))))
1634 (match-string 1 filename
)
1635 (substring filename
(match-end 0)))))
1638 (defcustom find-file-not-true-dirname-list nil
1639 "List of logical names for which visiting shouldn't save the true dirname."
1640 :type
'(repeat (string :tag
"Name"))
1643 (defun find-buffer-visiting (filename &optional predicate
)
1644 "Return the buffer visiting file FILENAME (a string).
1645 This is like `get-file-buffer', except that it checks for any buffer
1646 visiting the same file, possibly under a different name.
1647 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1648 and others are ignored.
1649 If there is no such live buffer, return nil."
1650 (let ((predicate (or predicate
#'identity
))
1651 (truename (abbreviate-file-name (file-truename filename
))))
1652 (or (let ((buf (get-file-buffer filename
)))
1653 (when (and buf
(funcall predicate buf
)) buf
))
1654 (let ((list (buffer-list)) found
)
1655 (while (and (not found
) list
)
1656 (with-current-buffer (car list
)
1657 (if (and buffer-file-name
1658 (string= buffer-file-truename truename
)
1659 (funcall predicate
(current-buffer)))
1660 (setq found
(car list
))))
1661 (setq list
(cdr list
)))
1663 (let* ((attributes (file-attributes truename
))
1664 (number (nthcdr 10 attributes
))
1665 (list (buffer-list)) found
)
1666 (and buffer-file-numbers-unique
1667 (car-safe number
) ;Make sure the inode is not just nil.
1668 (while (and (not found
) list
)
1669 (with-current-buffer (car list
)
1670 (if (and buffer-file-name
1671 (equal buffer-file-number number
)
1672 ;; Verify this buffer's file number
1673 ;; still belongs to its file.
1674 (file-exists-p buffer-file-name
)
1675 (equal (file-attributes buffer-file-truename
)
1677 (funcall predicate
(current-buffer)))
1678 (setq found
(car list
))))
1679 (setq list
(cdr list
))))
1682 (defcustom find-file-wildcards t
1683 "Non-nil means file-visiting commands should handle wildcards.
1684 For example, if you specify `*.c', that would visit all the files
1685 whose names match the pattern."
1690 (defcustom find-file-suppress-same-file-warnings nil
1691 "Non-nil means suppress warning messages for symlinked files.
1692 When nil, Emacs prints a warning when visiting a file that is already
1693 visited, but with a different name. Setting this option to t
1694 suppresses this warning."
1699 (defcustom large-file-warning-threshold
10000000
1700 "Maximum size of file above which a confirmation is requested.
1701 When nil, never request confirmation."
1705 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1707 (defun abort-if-file-too-large (size op-type filename
)
1708 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1709 OP-TYPE specifies the file operation being performed (for message to user)."
1710 (when (and large-file-warning-threshold size
1711 (> size large-file-warning-threshold
)
1713 (format "File %s is large (%dMB), really %s? "
1714 (file-name-nondirectory filename
)
1715 (/ size
1048576) op-type
))))
1718 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1719 "Read file FILENAME into a buffer and return the buffer.
1720 If a buffer exists visiting FILENAME, return that one, but
1721 verify that the file has not changed since visited or saved.
1722 The buffer is not selected, just returned to the caller.
1723 Optional second arg NOWARN non-nil means suppress any warning messages.
1724 Optional third arg RAWFILE non-nil means the file is read literally.
1725 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1726 and visit all the matching files. When wildcards are actually
1727 used and expanded, return a list of buffers that are visiting
1730 (abbreviate-file-name
1731 (expand-file-name filename
)))
1732 (if (file-directory-p filename
)
1733 (or (and find-file-run-dired
1734 (run-hook-with-args-until-success
1735 'find-directory-functions
1736 (if find-file-visit-truename
1737 (abbreviate-file-name (file-truename filename
))
1739 (error "%s is a directory" filename
))
1742 (not (string-match "\\`/:" filename
))
1743 (string-match "[[*?]" filename
))
1744 (let ((files (condition-case nil
1745 (file-expand-wildcards filename t
)
1746 (error (list filename
))))
1747 (find-file-wildcards nil
))
1749 (find-file-noselect filename
)
1750 (mapcar #'find-file-noselect files
)))
1751 (let* ((buf (get-file-buffer filename
))
1752 (truename (abbreviate-file-name (file-truename filename
)))
1753 (attributes (file-attributes truename
))
1754 (number (nthcdr 10 attributes
))
1755 ;; Find any buffer for a file which has same truename.
1756 (other (and (not buf
) (find-buffer-visiting filename
))))
1757 ;; Let user know if there is a buffer with the same truename.
1761 find-file-suppress-same-file-warnings
1762 (string-equal filename
(buffer-file-name other
))
1763 (message "%s and %s are the same file"
1764 filename
(buffer-file-name other
)))
1765 ;; Optionally also find that buffer.
1766 (if (or find-file-existing-other-name find-file-visit-truename
)
1768 ;; Check to see if the file looks uncommonly large.
1769 (when (not (or buf nowarn
))
1770 (abort-if-file-too-large (nth 7 attributes
) "open" filename
))
1772 ;; We are using an existing buffer.
1775 (verify-visited-file-modtime buf
)
1776 (cond ((not (file-exists-p filename
))
1777 (setq nonexistent t
)
1778 (message "File %s no longer exists!" filename
))
1779 ;; Certain files should be reverted automatically
1780 ;; if they have changed on disk and not in the buffer.
1781 ((and (not (buffer-modified-p buf
))
1782 (let ((tail revert-without-query
)
1785 (if (string-match (car tail
) filename
)
1787 (setq tail
(cdr tail
)))
1789 (with-current-buffer buf
1790 (message "Reverting file %s..." filename
)
1792 (message "Reverting file %s...done" filename
)))
1794 (if (string= (file-name-nondirectory filename
)
1797 (if (buffer-modified-p buf
)
1798 "File %s changed on disk. Discard your edits? "
1799 "File %s changed on disk. Reread from disk? ")
1800 (file-name-nondirectory filename
))
1802 (if (buffer-modified-p buf
)
1803 "File %s changed on disk. Discard your edits in %s? "
1804 "File %s changed on disk. Reread from disk into %s? ")
1805 (file-name-nondirectory filename
)
1806 (buffer-name buf
))))
1807 (with-current-buffer buf
1808 (revert-buffer t t
)))))
1809 (with-current-buffer buf
1811 ;; Check if a formerly read-only file has become
1812 ;; writable and vice versa, but if the buffer agrees
1813 ;; with the new state of the file, that is ok too.
1814 (let ((read-only (not (file-writable-p buffer-file-name
))))
1815 (unless (or nonexistent
1816 (eq read-only buffer-file-read-only
)
1817 (eq read-only buffer-read-only
))
1820 (format "File %s is %s on disk. Change buffer mode? "
1822 (if read-only
"read-only" "writable"))))
1823 (y-or-n-p question
)))
1824 (setq buffer-read-only read-only
)))
1825 (setq buffer-file-read-only read-only
))
1827 (when (and (not (eq (not (null rawfile
))
1828 (not (null find-file-literally
))))
1830 ;; It is confusing to ask whether to visit
1831 ;; non-literally if they have the file in
1833 (not (eq major-mode
'hexl-mode
)))
1834 (if (buffer-modified-p)
1838 "The file %s is already visited normally,
1839 and you have edited the buffer. Now you have asked to visit it literally,
1840 meaning no coding system handling, format conversion, or local variables.
1841 Emacs can only visit a file in one way at a time.
1843 Do you want to save the file, and visit it literally instead? "
1844 "The file %s is already visited literally,
1845 meaning no coding system handling, format conversion, or local variables.
1846 You have edited the buffer. Now you have asked to visit the file normally,
1847 but Emacs can only visit a file in one way at a time.
1849 Do you want to save the file, and visit it normally instead? ")
1850 (file-name-nondirectory filename
)))
1853 (find-file-noselect-1 buf filename nowarn
1854 rawfile truename number
))
1859 Do you want to discard your changes, and visit the file literally now? "
1861 Do you want to discard your changes, and visit the file normally now? ")))
1862 (find-file-noselect-1 buf filename nowarn
1863 rawfile truename number
)
1864 (error (if rawfile
"File already visited non-literally"
1865 "File already visited literally"))))
1869 "The file %s is already visited normally.
1870 You have asked to visit it literally,
1871 meaning no coding system decoding, format conversion, or local variables.
1872 But Emacs can only visit a file in one way at a time.
1874 Do you want to revisit the file literally now? "
1875 "The file %s is already visited literally,
1876 meaning no coding system decoding, format conversion, or local variables.
1877 You have asked to visit it normally,
1878 but Emacs can only visit a file in one way at a time.
1880 Do you want to revisit the file normally now? ")
1881 (file-name-nondirectory filename
)))
1882 (find-file-noselect-1 buf filename nowarn
1883 rawfile truename number
)
1884 (error (if rawfile
"File already visited non-literally"
1885 "File already visited literally"))))))
1886 ;; Return the buffer we are using.
1888 ;; Create a new buffer.
1889 (setq buf
(create-file-buffer filename
))
1890 ;; find-file-noselect-1 may use a different buffer.
1891 (find-file-noselect-1 buf filename nowarn
1892 rawfile truename number
))))))
1894 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1896 (with-current-buffer buf
1897 (kill-local-variable 'find-file-literally
)
1898 ;; Needed in case we are re-visiting the file with a different
1899 ;; text representation.
1900 (kill-local-variable 'buffer-file-coding-system
)
1901 (kill-local-variable 'cursor-type
)
1902 (let ((inhibit-read-only t
))
1904 (and (default-value 'enable-multibyte-characters
)
1906 (set-buffer-multibyte t
))
1909 (let ((inhibit-read-only t
))
1910 (insert-file-contents-literally filename t
))
1912 (when (and (file-exists-p filename
)
1913 (not (file-readable-p filename
)))
1915 (signal 'file-error
(list "File is not readable"
1917 ;; Unconditionally set error
1920 (let ((inhibit-read-only t
))
1921 (insert-file-contents filename t
))
1923 (when (and (file-exists-p filename
)
1924 (not (file-readable-p filename
)))
1926 (signal 'file-error
(list "File is not readable"
1928 ;; Run find-file-not-found-functions until one returns non-nil.
1929 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1930 ;; If they fail too, set error.
1932 ;; Record the file's truename, and maybe use that as visited name.
1933 (if (equal filename buffer-file-name
)
1934 (setq buffer-file-truename truename
)
1935 (setq buffer-file-truename
1936 (abbreviate-file-name (file-truename buffer-file-name
))))
1937 (setq buffer-file-number number
)
1938 (if find-file-visit-truename
1939 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
1940 ;; Set buffer's default directory to that of the file.
1941 (setq default-directory
(file-name-directory buffer-file-name
))
1942 ;; Turn off backup files for certain file names. Since
1943 ;; this is a permanent local, the major mode won't eliminate it.
1944 (and backup-enable-predicate
1945 (not (funcall backup-enable-predicate buffer-file-name
))
1947 (make-local-variable 'backup-inhibited
)
1948 (setq backup-inhibited t
)))
1951 (set-buffer-multibyte nil
)
1952 (setq buffer-file-coding-system
'no-conversion
)
1953 (set-buffer-major-mode buf
)
1954 (make-local-variable 'find-file-literally
)
1955 (setq find-file-literally t
))
1956 (after-find-file error
(not nowarn
)))
1959 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
1960 "Like `insert-file-contents', but only reads in the file literally.
1961 A buffer may be modified in several ways after reading into the buffer,
1962 to Emacs features such as format decoding, character code
1963 conversion, `find-file-hook', automatic uncompression, etc.
1965 This function ensures that none of these modifications will take place."
1966 (let ((format-alist nil
)
1967 (after-insert-file-functions nil
)
1968 (coding-system-for-read 'no-conversion
)
1969 (coding-system-for-write 'no-conversion
)
1970 (find-buffer-file-type-function
1971 (if (fboundp 'find-buffer-file-type
)
1972 (symbol-function 'find-buffer-file-type
)
1974 (inhibit-file-name-handlers
1975 (append '(jka-compr-handler image-file-handler epa-file-handler
)
1976 inhibit-file-name-handlers
))
1977 (inhibit-file-name-operation 'insert-file-contents
))
1980 (fset 'find-buffer-file-type
(lambda (filename) t
))
1981 (insert-file-contents filename visit beg end replace
))
1982 (if find-buffer-file-type-function
1983 (fset 'find-buffer-file-type find-buffer-file-type-function
)
1984 (fmakunbound 'find-buffer-file-type
)))))
1986 (defun insert-file-1 (filename insert-func
)
1987 (if (file-directory-p filename
)
1988 (signal 'file-error
(list "Opening input file" "file is a directory"
1990 ;; Check whether the file is uncommonly large
1991 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert" filename
)
1992 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
1993 #'buffer-modified-p
))
1994 (tem (funcall insert-func filename
)))
1995 (push-mark (+ (point) (car (cdr tem
))))
1997 (message "File %s already visited and modified in buffer %s"
1998 filename
(buffer-name buffer
)))))
2000 (defun insert-file-literally (filename)
2001 "Insert contents of file FILENAME into buffer after point with no conversion.
2003 This function is meant for the user to run interactively.
2004 Don't call it from programs! Use `insert-file-contents-literally' instead.
2005 \(Its calling sequence is different; see its documentation)."
2006 (interactive "*fInsert file literally: ")
2007 (insert-file-1 filename
#'insert-file-contents-literally
))
2009 (defvar find-file-literally nil
2010 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2011 This is a permanent local.")
2012 (put 'find-file-literally
'permanent-local t
)
2014 (defun find-file-literally (filename)
2015 "Visit file FILENAME with no conversion of any kind.
2016 Format conversion and character code conversion are both disabled,
2017 and multibyte characters are disabled in the resulting buffer.
2018 The major mode used is Fundamental mode regardless of the file name,
2019 and local variable specifications in the file are ignored.
2020 Automatic uncompression and adding a newline at the end of the
2021 file due to `require-final-newline' is also disabled.
2023 You cannot absolutely rely on this function to result in
2024 visiting the file literally. If Emacs already has a buffer
2025 which is visiting the file, you get the existing buffer,
2026 regardless of whether it was created literally or not.
2028 In a Lisp program, if you want to be sure of accessing a file's
2029 contents literally, you should create a temporary buffer and then read
2030 the file contents into it using `insert-file-contents-literally'."
2032 (list (read-file-name
2033 "Find file literally: " nil default-directory
2034 (confirm-nonexistent-file-or-buffer))))
2035 (switch-to-buffer (find-file-noselect filename nil t
)))
2037 (defvar after-find-file-from-revert-buffer nil
)
2039 (defun after-find-file (&optional error warn noauto
2040 after-find-file-from-revert-buffer
2042 "Called after finding a file and by the default revert function.
2043 Sets buffer mode, parses local variables.
2044 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2045 error in reading the file. WARN non-nil means warn if there
2046 exists an auto-save file more recent than the visited file.
2047 NOAUTO means don't mess with auto-save mode.
2048 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2049 means this call was from `revert-buffer'.
2050 Fifth arg NOMODES non-nil means don't alter the file's modes.
2051 Finishes by calling the functions in `find-file-hook'
2052 unless NOMODES is non-nil."
2053 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
2060 ((and error
(file-attributes buffer-file-name
))
2061 (setq buffer-read-only t
)
2062 "File exists, but cannot be read")
2063 ((not buffer-read-only
)
2065 ;; No need to warn if buffer is auto-saved
2066 ;; under the name of the visited file.
2067 (not (and buffer-file-name
2068 auto-save-visited-file-name
))
2069 (file-newer-than-file-p (or buffer-auto-save-file-name
2070 (make-auto-save-file-name))
2072 (format "%s has auto save data; consider M-x recover-this-file"
2073 (file-name-nondirectory buffer-file-name
))
2074 (setq not-serious t
)
2075 (if error
"(New file)" nil
)))
2077 (setq not-serious t
)
2078 "Note: file is write protected")
2079 ((file-attributes (directory-file-name default-directory
))
2080 "File not found and directory write-protected")
2081 ((file-exists-p (file-name-directory buffer-file-name
))
2082 (setq buffer-read-only nil
))
2084 (setq buffer-read-only nil
)
2085 "Use M-x make-directory RET RET to create the directory and its parents"))))
2088 (or not-serious
(sit-for 1 t
))))
2089 (when (and auto-save-default
(not noauto
))
2090 (auto-save-mode t
)))
2091 ;; Make people do a little extra work (C-x C-q)
2092 ;; before altering a backup file.
2093 (when (backup-file-name-p buffer-file-name
)
2094 (setq buffer-read-only t
))
2095 ;; When a file is marked read-only,
2096 ;; make the buffer read-only even if root is looking at it.
2097 (when (and (file-modes (buffer-file-name))
2098 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
2099 (setq buffer-read-only t
))
2101 (when (and view-read-only view-mode
)
2102 (view-mode-disable))
2104 ;; If requested, add a newline at the end of the file.
2105 (and (memq require-final-newline
'(visit visit-save
))
2106 (> (point-max) (point-min))
2107 (/= (char-after (1- (point-max))) ?
\n)
2108 (not (and (eq selective-display t
)
2109 (= (char-after (1- (point-max))) ?
\r)))
2111 (goto-char (point-max))
2113 (when (and buffer-read-only
2115 (not (eq (get major-mode
'mode-class
) 'special
)))
2117 (run-hooks 'find-file-hook
)))
2119 (defmacro report-errors
(format &rest body
)
2120 "Eval BODY and turn any error into a FORMAT message.
2121 FORMAT can have a %s escape which will be replaced with the actual error.
2122 If `debug-on-error' is set, errors are not caught, so that you can
2124 Avoid using a large BODY since it is duplicated."
2125 (declare (debug t
) (indent 1))
2130 (error (message ,format
(prin1-to-string err
))))))
2132 (defun normal-mode (&optional find-file
)
2133 "Choose the major mode for this buffer automatically.
2134 Also sets up any specified local variables of the file.
2135 Uses the visited file name, the -*- line, and the local variables spec.
2137 This function is called automatically from `find-file'. In that case,
2138 we may set up the file-specified mode and local variables,
2139 depending on the value of `enable-local-variables'.
2140 In addition, if `local-enable-local-variables' is nil, we do
2141 not set local variables (though we do notice a mode specified with -*-.)
2143 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2144 or from Lisp without specifying the optional argument FIND-FILE;
2145 in that case, this function acts as if `enable-local-variables' were t."
2147 (funcall (or (default-value 'major-mode
) 'fundamental-mode
))
2148 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
2149 (report-errors "File mode specification error: %s"
2151 (report-errors "File local-variables error: %s"
2152 (hack-local-variables)))
2153 ;; Turn font lock off and on, to make sure it takes account of
2154 ;; whatever file local variables are relevant to it.
2155 (when (and font-lock-mode
2156 ;; Font-lock-mode (now in font-core.el) can be ON when
2157 ;; font-lock.el still hasn't been loaded.
2158 (boundp 'font-lock-keywords
)
2159 (eq (car font-lock-keywords
) t
))
2160 (setq font-lock-keywords
(cadr font-lock-keywords
))
2163 (if (fboundp 'ucs-set-table-for-input
) ; don't lose when building
2164 (ucs-set-table-for-input)))
2166 (defcustom auto-mode-case-fold nil
2167 "Non-nil means to try second pass through `auto-mode-alist'.
2168 This means that if the first case-sensitive search through the alist fails
2169 to find a matching major mode, a second case-insensitive search is made.
2170 On systems with case-insensitive file names, this variable is ignored,
2171 since only a single case-insensitive search through the alist is made."
2176 (defvar auto-mode-alist
2177 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2178 ;; c++-mode, java-mode and more) are added through autoload
2179 ;; directives in that file. That way is discouraged since it
2180 ;; spreads out the definition of the initial value.
2183 (cons (purecopy (car elt
)) (cdr elt
)))
2184 `(;; do this first, so that .html.pl is Polish html, not Perl
2185 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2186 ("\\.te?xt\\'" . text-mode
)
2187 ("\\.[tT]e[xX]\\'" . tex-mode
)
2188 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2189 ("\\.ltx\\'" . latex-mode
)
2190 ("\\.dtx\\'" . doctex-mode
)
2191 ("\\.org\\'" . org-mode
)
2192 ("\\.el\\'" . emacs-lisp-mode
)
2193 ("Project\\.ede\\'" . emacs-lisp-mode
)
2194 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2195 ("\\.l\\'" . lisp-mode
)
2196 ("\\.li?sp\\'" . lisp-mode
)
2197 ("\\.[fF]\\'" . fortran-mode
)
2198 ("\\.for\\'" . fortran-mode
)
2199 ("\\.p\\'" . pascal-mode
)
2200 ("\\.pas\\'" . pascal-mode
)
2201 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode
)
2202 ("\\.ad[abs]\\'" . ada-mode
)
2203 ("\\.ad[bs].dg\\'" . ada-mode
)
2204 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2205 ("Imakefile\\'" . makefile-imake-mode
)
2206 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2207 ("\\.makepp\\'" . makefile-makepp-mode
)
2208 ,@(if (memq system-type
'(berkeley-unix darwin
))
2209 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2210 ("GNUmakefile\\'" . makefile-gmake-mode
)
2211 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2212 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2213 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2214 ("\\.am\\'" . makefile-automake-mode
)
2215 ;; Less common extensions come here
2216 ;; so more common ones above are found faster.
2217 ("\\.texinfo\\'" . texinfo-mode
)
2218 ("\\.te?xi\\'" . texinfo-mode
)
2219 ("\\.[sS]\\'" . asm-mode
)
2220 ("\\.asm\\'" . asm-mode
)
2221 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2222 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2223 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2224 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2225 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2226 ("\\.bash\\'" . sh-mode
)
2227 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2228 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2229 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2230 ("\\.m?spec\\'" . sh-mode
)
2231 ("\\.m[mes]\\'" . nroff-mode
)
2232 ("\\.man\\'" . nroff-mode
)
2233 ("\\.sty\\'" . latex-mode
)
2234 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2235 ("\\.bbl\\'" . latex-mode
)
2236 ("\\.bib\\'" . bibtex-mode
)
2237 ("\\.sql\\'" . sql-mode
)
2238 ("\\.m[4c]\\'" . m4-mode
)
2239 ("\\.mf\\'" . metafont-mode
)
2240 ("\\.mp\\'" . metapost-mode
)
2241 ("\\.vhdl?\\'" . vhdl-mode
)
2242 ("\\.article\\'" . text-mode
)
2243 ("\\.letter\\'" . text-mode
)
2244 ("\\.i?tcl\\'" . tcl-mode
)
2245 ("\\.exp\\'" . tcl-mode
)
2246 ("\\.itk\\'" . tcl-mode
)
2247 ("\\.icn\\'" . icon-mode
)
2248 ("\\.sim\\'" . simula-mode
)
2249 ("\\.mss\\'" . scribe-mode
)
2250 ("\\.f9[05]\\'" . f90-mode
)
2251 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2252 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode
)
2253 ("\\.srt\\'" . srecode-template-mode
)
2254 ("\\.prolog\\'" . prolog-mode
)
2255 ("\\.tar\\'" . tar-mode
)
2256 ;; The list of archive file extensions should be in sync with
2257 ;; `auto-coding-alist' with `no-conversion' coding system.
2259 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2260 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode
)
2261 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode
) ;OpenOffice.org
2262 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode
) ; Debian/Opkg packages.
2263 ;; Mailer puts message to be edited in
2264 ;; /tmp/Re.... or Message
2265 ("\\`/tmp/Re" . text-mode
)
2266 ("/Message[0-9]*\\'" . text-mode
)
2267 ("\\.zone\\'" . zone-mode
)
2268 ;; some news reader is reported to use this
2269 ("\\`/tmp/fol/" . text-mode
)
2270 ("\\.oak\\'" . scheme-mode
)
2271 ("\\.sgml?\\'" . sgml-mode
)
2272 ("\\.x[ms]l\\'" . xml-mode
)
2273 ("\\.dbk\\'" . xml-mode
)
2274 ("\\.dtd\\'" . sgml-mode
)
2275 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2276 ("\\.js\\'" . js-mode
) ; javascript-mode would be better
2277 ("\\.[ds]?vh?\\'" . verilog-mode
)
2278 ;; .emacs or .gnus or .viper following a directory delimiter in
2279 ;; Unix, MSDOG or VMS syntax.
2280 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2281 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2282 ;; _emacs following a directory delimiter
2284 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2285 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2286 ("\\.ml\\'" . lisp-mode
)
2287 ;; Common Lisp ASDF package system.
2288 ("\\.asd\\'" . lisp-mode
)
2289 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2290 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2291 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2292 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2293 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2294 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode
)
2295 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2296 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode
)
2297 ("BROWSE\\'" . ebrowse-tree-mode
)
2298 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2299 ("#\\*mail\\*" . mail-mode
)
2300 ("\\.g\\'" . antlr-mode
)
2301 ("\\.ses\\'" . ses-mode
)
2302 ("\\.\\(soa\\|zone\\)\\'" . dns-mode
)
2303 ("\\.docbook\\'" . sgml-mode
)
2304 ("\\.com\\'" . dcl-mode
)
2305 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2306 ;; Windows candidates may be opened case sensitively on Unix
2307 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2308 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2309 ("\\.ppd\\'" . conf-ppd-mode
)
2310 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2311 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2312 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2313 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2314 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2315 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2316 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2317 ;; this has lower priority to avoid matching changelog.sgml etc.
2318 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2319 ;; either user's dot-files or under /etc or some such
2320 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2321 ;; alas not all ~/.*rc files are like this
2322 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2323 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2324 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2325 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2326 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2327 ;; this contains everything twice, with space and with colon :-(
2328 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2329 ;; Get rid of any trailing .n.m and try again.
2330 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2331 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2332 ;; Using mode nil rather than `ignore' would let the search continue
2333 ;; through this list (with the shortened name) rather than start over.
2334 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2335 ;; The following should come after the ChangeLog pattern
2336 ;; for the sake of ChangeLog.1, etc.
2337 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2338 ("\\.[1-9]\\'" . nroff-mode
)
2339 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)))
2340 "Alist of filename patterns vs corresponding major mode functions.
2341 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2342 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2343 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2344 mode function to use. FUNCTION will be called, unless it is nil.
2346 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2347 calling FUNCTION (if it's not nil), we delete the suffix that matched
2348 REGEXP and search the list again for another match.
2350 If the file name matches `inhibit-first-line-modes-regexps',
2351 then `auto-mode-alist' is not processed.
2353 The extensions whose FUNCTION is `archive-mode' should also
2354 appear in `auto-coding-alist' with `no-conversion' coding system.
2356 See also `interpreter-mode-alist', which detects executable script modes
2357 based on the interpreters they specify to run,
2358 and `magic-mode-alist', which determines modes based on file contents.")
2359 (put 'auto-mode-alist
'risky-local-variable t
)
2361 (defun conf-mode-maybe ()
2362 "Select Conf mode or XML mode according to start of file."
2366 (goto-char (point-min))
2367 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2371 (defvar interpreter-mode-alist
2372 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2373 ;; and pike-mode) are added through autoload directives in that
2374 ;; file. That way is discouraged since it spreads out the
2375 ;; definition of the initial value.
2378 (cons (purecopy (car l
)) (cdr l
)))
2379 '(("perl" . perl-mode
)
2380 ("perl5" . perl-mode
)
2381 ("miniperl" . perl-mode
)
2383 ("wishx" . tcl-mode
)
2385 ("tclsh" . tcl-mode
)
2386 ("scm" . scheme-mode
)
2406 ("tail" . text-mode
)
2407 ("more" . text-mode
)
2408 ("less" . text-mode
)
2410 ("make" . makefile-gmake-mode
) ; Debian uses this
2411 ("guile" . scheme-mode
)
2412 ("clisp" . lisp-mode
)))
2413 "Alist mapping interpreter names to major modes.
2414 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2415 Each element looks like (INTERPRETER . MODE).
2416 If INTERPRETER matches the name of the interpreter specified in the first line
2417 of a script, mode MODE is enabled.
2419 See also `auto-mode-alist'.")
2421 (defvar inhibit-first-line-modes-regexps
(mapcar 'purecopy
'("\\.tar\\'" "\\.tgz\\'"))
2422 "List of regexps; if one matches a file name, don't look for `-*-'.")
2424 (defvar inhibit-first-line-modes-suffixes nil
2425 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2426 When checking `inhibit-first-line-modes-regexps', we first discard
2427 from the end of the file name anything that matches one of these regexps.")
2429 (defvar auto-mode-interpreter-regexp
2430 (purecopy "#![ \t]?\\([^ \t\n]*\
2431 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2432 "Regexp matching interpreters, for file mode determination.
2433 This regular expression is matched against the first line of a file
2434 to determine the file's mode in `set-auto-mode'. If it matches, the file
2435 is assumed to be interpreted by the interpreter matched by the second group
2436 of the regular expression. The mode is then determined as the mode
2437 associated with that interpreter in `interpreter-mode-alist'.")
2439 (defvar magic-mode-alist nil
2440 "Alist of buffer beginnings vs. corresponding major mode functions.
2441 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2442 After visiting a file, if REGEXP matches the text at the beginning of the
2443 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2444 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2447 If FUNCTION is nil, then it is not called. (That is a way of saying
2448 \"allow `auto-mode-alist' to decide for these files.\")")
2449 (put 'magic-mode-alist
'risky-local-variable t
)
2451 (defvar magic-fallback-mode-alist
2453 `((image-type-auto-detected-p . image-mode
)
2454 ("\\(PK00\\)?[P]K\003\004" . archive-mode
) ; zip
2455 ;; The < comes before the groups (but the first) to reduce backtracking.
2456 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2457 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2458 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2459 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2460 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2462 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2463 "[Hh][Tt][Mm][Ll]"))
2465 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2466 ;; These two must come after html, because they are more general:
2467 ("<\\?xml " . xml-mode
)
2468 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2469 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2470 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2473 ("# xmcd " . conf-unix-mode
)))
2474 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2475 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2476 After visiting a file, if REGEXP matches the text at the beginning of the
2477 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2478 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2479 have not specified a mode for this file.
2481 If FUNCTION is nil, then it is not called.")
2482 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2484 (defvar magic-mode-regexp-match-limit
4000
2485 "Upper limit on `magic-mode-alist' regexp matches.
2486 Also applies to `magic-fallback-mode-alist'.")
2488 (defun set-auto-mode (&optional keep-mode-if-same
)
2489 "Select major mode appropriate for current buffer.
2491 To find the right major mode, this function checks for a -*- mode tag,
2492 checks if it uses an interpreter listed in `interpreter-mode-alist',
2493 matches the buffer beginning against `magic-mode-alist',
2494 compares the filename against the entries in `auto-mode-alist',
2495 then matches the buffer beginning against `magic-fallback-mode-alist'.
2497 It does not check for the `mode:' local variable in the
2498 Local Variables section of the file; for that, use `hack-local-variables'.
2500 If `enable-local-variables' is nil, this function does not check for a
2503 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2504 set the major mode only if that would change it. In other words
2505 we don't actually set it to the same mode the buffer already has."
2506 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2507 (let (end done mode modes
)
2508 ;; Find a -*- mode tag
2510 (goto-char (point-min))
2511 (skip-chars-forward " \t\n")
2512 (and enable-local-variables
2513 (setq end
(set-auto-mode-1))
2514 (if (save-excursion (search-forward ":" end t
))
2515 ;; Find all specifications for the `mode:' variable
2516 ;; and execute them left to right.
2517 (while (let ((case-fold-search t
))
2518 (or (and (looking-at "mode:")
2519 (goto-char (match-end 0)))
2520 (re-search-forward "[ \t;]mode:" end t
)))
2521 (skip-chars-forward " \t")
2522 (let ((beg (point)))
2523 (if (search-forward ";" end t
)
2526 (skip-chars-backward " \t")
2527 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2529 ;; Simple -*-MODE-*- case.
2530 (push (intern (concat (downcase (buffer-substring (point) end
))
2533 ;; If we found modes to use, invoke them now, outside the save-excursion.
2536 (dolist (mode (nreverse modes
))
2537 (if (not (functionp mode
))
2538 (message "Ignoring unknown mode `%s'" mode
)
2540 (or (set-auto-mode-0 mode keep-mode-if-same
)
2541 ;; continuing would call minor modes again, toggling them off
2542 (throw 'nop nil
))))))
2543 ;; If we didn't, look for an interpreter specified in the first line.
2544 ;; As a special case, allow for things like "#!/bin/env perl", which
2545 ;; finds the interpreter anywhere in $PATH.
2547 (setq mode
(save-excursion
2548 (goto-char (point-min))
2549 (if (looking-at auto-mode-interpreter-regexp
)
2552 ;; Map interpreter name to a mode, signalling we're done at the
2554 done
(assoc (file-name-nondirectory mode
)
2555 interpreter-mode-alist
))
2556 ;; If we found an interpreter mode to use, invoke it now.
2558 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2559 ;; Next try matching the buffer beginning against magic-mode-alist.
2561 (if (setq done
(save-excursion
2562 (goto-char (point-min))
2564 (narrow-to-region (point-min)
2566 (+ (point-min) magic-mode-regexp-match-limit
)))
2567 (assoc-default nil magic-mode-alist
2571 (looking-at re
)))))))
2572 (set-auto-mode-0 done keep-mode-if-same
)))
2573 ;; Next compare the filename against the entries in auto-mode-alist.
2575 (if buffer-file-name
2576 (let ((name buffer-file-name
)
2577 (remote-id (file-remote-p buffer-file-name
)))
2578 ;; Remove remote file name identification.
2579 (when (and (stringp remote-id
)
2580 (string-match (regexp-quote remote-id
) name
))
2581 (setq name
(substring name
(match-end 0))))
2582 ;; Remove backup-suffixes from file name.
2583 (setq name
(file-name-sans-versions name
))
2585 ;; Find first matching alist entry.
2587 (if (memq system-type
'(windows-nt cygwin
))
2588 ;; System is case-insensitive.
2589 (let ((case-fold-search t
))
2590 (assoc-default name auto-mode-alist
2592 ;; System is case-sensitive.
2594 ;; First match case-sensitively.
2595 (let ((case-fold-search nil
))
2596 (assoc-default name auto-mode-alist
2598 ;; Fallback to case-insensitive match.
2599 (and auto-mode-case-fold
2600 (let ((case-fold-search t
))
2601 (assoc-default name auto-mode-alist
2606 (setq mode
(car mode
)
2607 name
(substring name
0 (match-beginning 0)))
2610 (set-auto-mode-0 mode keep-mode-if-same
)
2612 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2614 (if (setq done
(save-excursion
2615 (goto-char (point-min))
2617 (narrow-to-region (point-min)
2619 (+ (point-min) magic-mode-regexp-match-limit
)))
2620 (assoc-default nil magic-fallback-mode-alist
2624 (looking-at re
)))))))
2625 (set-auto-mode-0 done keep-mode-if-same
)))))
2627 ;; When `keep-mode-if-same' is set, we are working on behalf of
2628 ;; set-visited-file-name. In that case, if the major mode specified is the
2629 ;; same one we already have, don't actually reset it. We don't want to lose
2630 ;; minor modes such as Font Lock.
2631 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2632 "Apply MODE and return it.
2633 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2634 any aliases and compared to current major mode. If they are the
2635 same, do nothing and return nil."
2636 (unless (and keep-mode-if-same
2637 (eq (indirect-function mode
)
2638 (indirect-function major-mode
)))
2643 (defun set-auto-mode-1 ()
2644 "Find the -*- spec in the buffer.
2645 Call with point at the place to start searching from.
2646 If one is found, set point to the beginning
2647 and return the position of the end.
2648 Otherwise, return nil; point may be changed."
2651 ;; Don't look for -*- if this file name matches any
2652 ;; of the regexps in inhibit-first-line-modes-regexps.
2653 (let ((temp inhibit-first-line-modes-regexps
)
2654 (name (if buffer-file-name
2655 (file-name-sans-versions buffer-file-name
)
2657 (while (let ((sufs inhibit-first-line-modes-suffixes
))
2658 (while (and sufs
(not (string-match (car sufs
) name
)))
2659 (setq sufs
(cdr sufs
)))
2661 (setq name
(substring name
0 (match-beginning 0))))
2663 (not (string-match (car temp
) name
)))
2664 (setq temp
(cdr temp
)))
2667 (search-forward "-*-" (line-end-position
2668 ;; If the file begins with "#!"
2669 ;; (exec interpreter magic), look
2670 ;; for mode frobs in the first two
2671 ;; lines. You cannot necessarily
2672 ;; put them in the first line of
2673 ;; such a file without screwing up
2674 ;; the interpreter invocation.
2675 ;; The same holds for
2677 ;; in man pages (preprocessor
2678 ;; magic for the `man' program).
2679 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t
)
2681 (skip-chars-forward " \t")
2683 (search-forward "-*-" (line-end-position) t
))
2686 (skip-chars-backward " \t")
2691 ;;; Handling file local variables
2693 (defvar ignored-local-variables
2694 '(ignored-local-variables safe-local-variable-values
2695 file-local-variables-alist dir-local-variables-alist
)
2696 "Variables to be ignored in a file's local variable spec.")
2697 (put 'ignored-local-variables
'risky-local-variable t
)
2699 (defvar hack-local-variables-hook nil
2700 "Normal hook run after processing a file's local variables specs.
2701 Major modes can use this to examine user-specified local variables
2702 in order to initialize other data structure based on them.")
2704 (defcustom safe-local-variable-values nil
2705 "List variable-value pairs that are considered safe.
2706 Each element is a cons cell (VAR . VAL), where VAR is a variable
2707 symbol and VAL is a value that is considered safe."
2712 (defcustom safe-local-eval-forms
2713 '((add-hook 'write-file-functions
'time-stamp
)
2714 (add-hook 'before-save-hook
'time-stamp
))
2715 "Expressions that are considered safe in an `eval:' local variable.
2716 Add expressions to this list if you want Emacs to evaluate them, when
2717 they appear in an `eval' local variable specification, without first
2718 asking you for confirmation."
2722 :type
'(repeat sexp
))
2724 ;; Risky local variables:
2725 (mapc (lambda (var) (put var
'risky-local-variable t
))
2727 buffer-auto-save-file-name
2729 buffer-file-truename
2732 default-text-properties
2736 file-name-handler-alist
2745 minor-mode-map-alist
2746 minor-mode-overriding-map-alist
2749 overriding-local-map
2750 overriding-terminal-local-map
2754 unread-command-events
))
2756 ;; Safe local variables:
2758 ;; For variables defined by major modes, the safety declarations can go into
2759 ;; the major mode's file, since that will be loaded before file variables are
2762 ;; For variables defined by minor modes, put the safety declarations in the
2763 ;; file defining the minor mode after the defcustom/defvar using an autoload
2766 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2768 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2769 ;; minor mode file may not be loaded yet.
2771 ;; For variables defined in the C source code the declaration should go here:
2773 (mapc (lambda (pair)
2774 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2775 '((buffer-read-only . booleanp
) ;; C source code
2776 (default-directory . stringp
) ;; C source code
2777 (fill-column . integerp
) ;; C source code
2778 (indent-tabs-mode . booleanp
) ;; C source code
2779 (left-margin . integerp
) ;; C source code
2780 (no-update-autoloads . booleanp
)
2781 (tab-width . integerp
) ;; C source code
2782 (truncate-lines . booleanp
) ;; C source code
2783 (word-wrap . booleanp
))) ;; C source code
2785 (put 'c-set-style
'safe-local-eval-function t
)
2787 (defvar file-local-variables-alist nil
2788 "Alist of file-local variable settings in the current buffer.
2789 Each element in this list has the form (VAR . VALUE), where VAR
2790 is a file-local variable (a symbol) and VALUE is the value
2791 specified. The actual value in the buffer may differ from VALUE,
2792 if it is changed by the major or minor modes, or by the user.")
2793 (make-variable-buffer-local 'file-local-variables-alist
)
2794 (put 'file-local-variables-alist
'permanent-local t
)
2796 (defvar dir-local-variables-alist nil
2797 "Alist of directory-local variable settings in the current buffer.
2798 Each element in this list has the form (VAR . VALUE), where VAR
2799 is a directory-local variable (a symbol) and VALUE is the value
2800 specified in .dir-locals.el. The actual value in the buffer
2801 may differ from VALUE, if it is changed by the major or minor modes,
2803 (make-variable-buffer-local 'dir-local-variables-alist
)
2805 (defvar before-hack-local-variables-hook nil
2806 "Normal hook run before setting file-local variables.
2807 It is called after checking for unsafe/risky variables and
2808 setting `file-local-variables-alist', and before applying the
2809 variables stored in `file-local-variables-alist'. A hook
2810 function is allowed to change the contents of this alist.
2812 This hook is called only if there is at least one file-local
2815 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name
)
2816 "Get confirmation before setting up local variable values.
2817 ALL-VARS is the list of all variables to be set up.
2818 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2819 RISKY-VARS is the list of those that are marked as risky.
2820 DIR-NAME is a directory name if these settings come from
2821 directory-local variables, or nil otherwise."
2824 (let ((name (or dir-name
2825 (if buffer-file-name
2826 (file-name-nondirectory buffer-file-name
)
2827 (concat "buffer " (buffer-name)))))
2828 (offer-save (and (eq enable-local-variables t
) unsafe-vars
))
2830 (save-window-excursion
2831 (let ((buf (get-buffer-create "*Local Variables*")))
2833 (set (make-local-variable 'cursor-type
) nil
)
2836 (insert "The local variables list in " name
2837 "\ncontains values that may not be safe (*)"
2839 ", and variables that are risky (**)."
2842 (insert "The local variables list in " name
2843 "\ncontains variables that are risky (**).")
2844 (insert "A local variables list is specified in " name
".")))
2845 (insert "\n\nDo you want to apply it? You can type
2846 y -- to apply the local variables list.
2847 n -- to ignore the local variables list.")
2850 ! -- to apply the local variables list, and permanently mark these
2851 values (*) as safe (in the future, they will be set automatically.)\n\n")
2853 (dolist (elt all-vars
)
2854 (cond ((member elt unsafe-vars
)
2856 ((member elt risky-vars
)
2860 (princ (car elt
) buf
)
2862 ;; Make strings with embedded whitespace easier to read.
2863 (let ((print-escape-newlines t
))
2864 (prin1 (cdr elt
) buf
))
2867 (format "Please type %s%s: "
2868 (if offer-save
"y, n, or !" "y or n")
2869 (if (< (line-number-at-pos) (window-body-height))
2871 ", or C-v to scroll")))
2872 (goto-char (point-min))
2873 (let ((cursor-in-echo-area t
)
2874 (executing-kbd-macro executing-kbd-macro
)
2876 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2879 (message "%s" prompt
)
2880 (setq char
(read-event))
2882 (cond ((eq char ?\C-v
)
2885 (error (goto-char (point-min)))))
2886 ;; read-event returns -1 if we are in a kbd
2887 ;; macro and there are no more events in the
2888 ;; macro. In that case, attempt to get an
2889 ;; event interactively.
2890 ((and executing-kbd-macro
(= char -
1))
2891 (setq executing-kbd-macro nil
))
2892 (t (setq done
(memq (downcase char
) exit-chars
)))))))
2893 (setq char
(downcase char
))
2894 (when (and offer-save
(= char ?
!) unsafe-vars
)
2895 (dolist (elt unsafe-vars
)
2896 (add-to-list 'safe-local-variable-values elt
))
2897 ;; When this is called from desktop-restore-file-buffer,
2898 ;; coding-system-for-read may be non-nil. Reset it before
2899 ;; writing to .emacs.
2900 (if (or custom-file user-init-file
)
2901 (let ((coding-system-for-read nil
))
2902 (customize-save-variable
2903 'safe-local-variable-values
2904 safe-local-variable-values
))))
2910 (defun hack-local-variables-prop-line (&optional mode-only
)
2911 "Return local variables specified in the -*- line.
2912 Ignore any specification for `mode:' and `coding:';
2913 `set-auto-mode' should already have handled `mode:',
2914 `set-auto-coding' should already have handled `coding:'.
2916 If MODE-ONLY is non-nil, all we do is check whether the major
2917 mode is specified, returning t if it is specified. Otherwise,
2918 return an alist of elements (VAR . VAL), where VAR is a variable
2919 and VAL is the specified value."
2921 (goto-char (point-min))
2922 (let ((end (set-auto-mode-1))
2923 result mode-specified
)
2924 ;; Parse the -*- line into the RESULT alist.
2925 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2928 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2929 ;; Simple form: "-*- MODENAME -*-". Already handled.
2930 (setq mode-specified t
)
2933 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2934 ;; (last ";" is optional).
2935 (while (< (point) end
)
2936 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2937 (error "Malformed -*- line"))
2938 (goto-char (match-end 0))
2939 ;; There used to be a downcase here,
2940 ;; but the manual didn't say so,
2941 ;; and people want to set var names that aren't all lc.
2942 (let ((key (intern (match-string 1)))
2943 (val (save-restriction
2944 (narrow-to-region (point) end
)
2945 (let ((read-circle nil
))
2946 (read (current-buffer))))))
2947 ;; It is traditional to ignore
2948 ;; case when checking for `mode' in set-auto-mode,
2949 ;; so we must do that here as well.
2950 ;; That is inconsistent, but we're stuck with it.
2951 ;; The same can be said for `coding' in set-auto-coding.
2952 (or (and (equal (downcase (symbol-name key
)) "mode")
2953 (setq mode-specified t
))
2954 (equal (downcase (symbol-name key
)) "coding")
2956 (push (cons (if (eq key
'eval
)
2958 (indirect-variable key
))
2961 (skip-chars-forward " \t;")))))
2967 (defun hack-local-variables-filter (variables dir-name
)
2968 "Filter local variable settings, querying the user if necessary.
2969 VARIABLES is the alist of variable-value settings. This alist is
2970 filtered based on the values of `ignored-local-variables',
2971 `enable-local-eval', `enable-local-variables', and (if necessary)
2972 user interaction. The results are added to
2973 `file-local-variables-alist', without applying them.
2974 DIR-NAME is a directory name if these settings come from
2975 directory-local variables, or nil otherwise."
2976 ;; Find those variables that we may want to save to
2977 ;; `safe-local-variable-values'.
2978 (let (all-vars risky-vars unsafe-vars
)
2979 (dolist (elt variables
)
2980 (let ((var (car elt
))
2982 (cond ((memq var ignored-local-variables
)
2983 ;; Ignore any variable in `ignored-local-variables'.
2985 ;; Obey `enable-local-eval'.
2987 (when enable-local-eval
2989 (or (eq enable-local-eval t
)
2990 (hack-one-local-variable-eval-safep (eval (quote val
)))
2991 (safe-local-variable-p var val
)
2992 (push elt unsafe-vars
))))
2993 ;; Ignore duplicates (except `mode') in the present list.
2994 ((and (assq var all-vars
) (not (eq var
'mode
))) nil
)
2995 ;; Accept known-safe variables.
2996 ((or (memq var
'(mode unibyte coding
))
2997 (safe-local-variable-p var val
))
2998 (push elt all-vars
))
2999 ;; The variable is either risky or unsafe:
3000 ((not (eq enable-local-variables
:safe
))
3002 (if (risky-local-variable-p var val
)
3003 (push elt risky-vars
)
3004 (push elt unsafe-vars
))))))
3006 ;; Query, unless all vars are safe or user wants no querying.
3007 (or (and (eq enable-local-variables t
)
3010 (memq enable-local-variables
'(:all
:safe
))
3011 (hack-local-variables-confirm all-vars unsafe-vars
3012 risky-vars dir-name
))
3013 (dolist (elt all-vars
)
3014 (unless (memq (car elt
) '(eval mode
))
3016 (setq dir-local-variables-alist
3017 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3018 (setq file-local-variables-alist
3019 (assq-delete-all (car elt
) file-local-variables-alist
)))
3020 (push elt file-local-variables-alist
)))))
3022 (defun hack-local-variables (&optional mode-only
)
3023 "Parse and put into effect this buffer's local variables spec.
3024 If MODE-ONLY is non-nil, all we do is check whether the major mode
3025 is specified, returning t if it is specified."
3026 (let ((enable-local-variables
3027 (and local-enable-local-variables enable-local-variables
))
3030 (setq file-local-variables-alist nil
)
3031 (report-errors "Directory-local variables error: %s"
3032 (hack-dir-local-variables)))
3033 (when (or mode-only enable-local-variables
)
3034 (setq result
(hack-local-variables-prop-line mode-only
))
3035 ;; Look for "Local variables:" line in last page.
3037 (goto-char (point-max))
3038 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3040 (when (let ((case-fold-search t
))
3041 (search-forward "Local Variables:" nil t
))
3042 (skip-chars-forward " \t")
3043 ;; suffix is what comes after "local variables:" in its line.
3044 ;; prefix is what comes before "local variables:" in its line.
3047 (regexp-quote (buffer-substring (point)
3048 (line-end-position)))
3051 (concat "^" (regexp-quote
3052 (buffer-substring (line-beginning-position)
3053 (match-beginning 0)))))
3057 (let ((startpos (point))
3059 (thisbuf (current-buffer)))
3061 (unless (let ((case-fold-search t
))
3063 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
3065 ;; This used to be an error, but really all it means is
3066 ;; that this may simply not be a local-variables section,
3067 ;; so just ignore it.
3068 (message "Local variables list is not properly terminated"))
3070 (setq endpos
(point)))
3073 (insert-buffer-substring thisbuf startpos endpos
)
3074 (goto-char (point-min))
3075 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
3077 ;; Discard the prefix.
3078 (if (looking-at prefix
)
3079 (delete-region (point) (match-end 0))
3080 (error "Local variables entry is missing the prefix"))
3082 ;; Discard the suffix.
3083 (if (looking-back suffix
)
3084 (delete-region (match-beginning 0) (point))
3085 (error "Local variables entry is missing the suffix"))
3087 (goto-char (point-min))
3090 ;; Find the variable name; strip whitespace.
3091 (skip-chars-forward " \t")
3093 (skip-chars-forward "^:\n")
3094 (if (eolp) (error "Missing colon in local variables entry"))
3095 (skip-chars-backward " \t")
3096 (let* ((str (buffer-substring beg
(point)))
3097 (var (let ((read-circle nil
))
3100 ;; Read the variable value.
3101 (skip-chars-forward "^:")
3103 (let ((read-circle nil
))
3104 (setq val
(read (current-buffer))))
3108 (unless (eq var
'coding
)
3110 (push (cons (if (eq var
'eval
)
3112 (indirect-variable var
))
3115 (forward-line 1))))))))
3116 ;; Now we've read all the local variables.
3117 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3118 (cond (mode-only result
)
3119 ;; Otherwise, set the variables.
3120 (enable-local-variables
3121 (hack-local-variables-filter result nil
)
3122 (when file-local-variables-alist
3123 ;; Any 'evals must run in the Right sequence.
3124 (setq file-local-variables-alist
3125 (nreverse file-local-variables-alist
))
3126 (run-hooks 'before-hack-local-variables-hook
)
3127 (dolist (elt file-local-variables-alist
)
3128 (hack-one-local-variable (car elt
) (cdr elt
))))
3129 (run-hooks 'hack-local-variables-hook
)))))
3131 (defun safe-local-variable-p (sym val
)
3132 "Non-nil if SYM is safe as a file-local variable with value VAL.
3133 It is safe if any of these conditions are met:
3135 * There is a matching entry (SYM . VAL) in the
3136 `safe-local-variable-values' user option.
3138 * The `safe-local-variable' property of SYM is a function that
3139 evaluates to a non-nil value with VAL as an argument."
3140 (or (member (cons sym val
) safe-local-variable-values
)
3141 (let ((safep (get sym
'safe-local-variable
)))
3142 (and (functionp safep
)
3143 ;; If the function signals an error, that means it
3144 ;; can't assure us that the value is safe.
3145 (with-demoted-errors (funcall safep val
))))))
3147 (defun risky-local-variable-p (sym &optional ignored
)
3148 "Non-nil if SYM could be dangerous as a file-local variable.
3149 It is dangerous if either of these conditions are met:
3151 * Its `risky-local-variable' property is non-nil.
3153 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3154 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3155 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3156 \"map-alist\", or \"bindat-spec\"."
3157 ;; If this is an alias, check the base name.
3159 (setq sym
(indirect-variable sym
))
3161 (or (get sym
'risky-local-variable
)
3162 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3163 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3164 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3165 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
3167 (defun hack-one-local-variable-quotep (exp)
3168 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
3170 (defun hack-one-local-variable-constantp (exp)
3171 (or (and (not (symbolp exp
)) (not (consp exp
)))
3174 (hack-one-local-variable-quotep exp
)))
3176 (defun hack-one-local-variable-eval-safep (exp)
3177 "Return t if it is safe to eval EXP when it is found in a file."
3178 (or (not (consp exp
))
3179 ;; Detect certain `put' expressions.
3180 (and (eq (car exp
) 'put
)
3181 (hack-one-local-variable-quotep (nth 1 exp
))
3182 (hack-one-local-variable-quotep (nth 2 exp
))
3183 (let ((prop (nth 1 (nth 2 exp
)))
3185 (cond ((memq prop
'(lisp-indent-hook
3186 lisp-indent-function
3187 scheme-indent-function
))
3188 ;; Only allow safe values (not functions).
3190 (and (hack-one-local-variable-quotep val
)
3191 (eq (nth 1 val
) 'defun
))))
3192 ((eq prop
'edebug-form-spec
)
3193 ;; Only allow indirect form specs.
3194 ;; During bootstrapping, edebug-basic-spec might not be
3196 (and (fboundp 'edebug-basic-spec
)
3197 (hack-one-local-variable-quotep val
)
3198 (edebug-basic-spec (nth 1 val
)))))))
3199 ;; Allow expressions that the user requested.
3200 (member exp safe-local-eval-forms
)
3201 ;; Certain functions can be allowed with safe arguments
3202 ;; or can specify verification functions to try.
3203 (and (symbolp (car exp
))
3204 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
3207 (dolist (arg (cdr exp
))
3208 (unless (hack-one-local-variable-constantp arg
)
3215 (dolist (function prop
)
3216 (if (funcall function exp
)
3220 (defun hack-one-local-variable (var val
)
3221 "Set local variable VAR with value VAL.
3222 If VAR is `mode', call `VAL-mode' as a function unless it's
3223 already the major mode."
3224 (cond ((eq var
'mode
)
3225 (let ((mode (intern (concat (downcase (symbol-name val
))
3227 (unless (eq (indirect-function mode
)
3228 (indirect-function major-mode
))
3229 (if (memq mode minor-mode-list
)
3230 ;; A minor mode must be passed an argument.
3231 ;; Otherwise, if the user enables the minor mode in a
3232 ;; major mode hook, this would toggle it off.
3236 (save-excursion (eval val
)))
3238 ;; Make sure the string has no text properties.
3239 ;; Some text properties can get evaluated in various ways,
3240 ;; so it is risky to put them on with a local variable list.
3242 (set-text-properties 0 (length val
) nil val
))
3243 (set (make-local-variable var
) val
))))
3245 ;;; Handling directory-local variables, aka project settings.
3247 (defvar dir-locals-class-alist
'()
3248 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3250 (defvar dir-locals-directory-cache
'()
3251 "List of cached directory roots for directory-local variable classes.
3252 Each element in this list has the form (DIR CLASS MTIME).
3253 DIR is the name of the directory.
3254 CLASS is the name of a variable class (a symbol).
3255 MTIME is the recorded modification time of the directory-local
3256 variables file associated with this entry. This time is a list
3257 of two integers (the same format as `file-attributes'), and is
3258 used to test whether the cache entry is still valid.
3259 Alternatively, MTIME can be nil, which means the entry is always
3262 (defsubst dir-locals-get-class-variables
(class)
3263 "Return the variable list for CLASS."
3264 (cdr (assq class dir-locals-class-alist
)))
3266 (defun dir-locals-collect-mode-variables (mode-variables variables
)
3267 "Collect directory-local variables from MODE-VARIABLES.
3268 VARIABLES is the initial list of variables.
3269 Returns the new list."
3270 (dolist (pair mode-variables variables
)
3271 (let* ((variable (car pair
))
3273 (slot (assq variable variables
)))
3274 ;; If variables are specified more than once, only use the last. (Why?)
3275 ;; The pseudo-variables mode and eval are different (bug#3430).
3276 (if (and slot
(not (memq variable
'(mode eval
))))
3278 ;; Need a new cons in case we setcdr later.
3279 (push (cons variable value
) variables
)))))
3281 (defun dir-locals-collect-variables (class-variables root variables
)
3282 "Collect entries from CLASS-VARIABLES into VARIABLES.
3283 ROOT is the root directory of the project.
3284 Return the new variables list."
3285 (let* ((file-name (buffer-file-name))
3286 (sub-file-name (if file-name
3287 (substring file-name
(length root
)))))
3288 (dolist (entry class-variables variables
)
3289 (let ((key (car entry
)))
3292 ;; Don't include this in the previous condition, because we
3293 ;; want to filter all strings before the next condition.
3294 (when (and sub-file-name
3295 (>= (length sub-file-name
) (length key
))
3296 (string= key
(substring sub-file-name
0 (length key
))))
3297 (setq variables
(dir-locals-collect-variables
3298 (cdr entry
) root variables
))))
3300 (derived-mode-p key
))
3301 (setq variables
(dir-locals-collect-mode-variables
3302 (cdr entry
) variables
))))))))
3304 (defun dir-locals-set-directory-class (directory class
&optional mtime
)
3305 "Declare that the DIRECTORY root is an instance of CLASS.
3306 DIRECTORY is the name of a directory, a string.
3307 CLASS is the name of a project class, a symbol.
3308 MTIME is either the modification time of the directory-local
3309 variables file that defined this class, or nil.
3311 When a file beneath DIRECTORY is visited, the mode-specific
3312 variables from CLASS are applied to the buffer. The variables
3313 for a class are defined using `dir-locals-set-class-variables'."
3314 (setq directory
(file-name-as-directory (expand-file-name directory
)))
3315 (unless (assq class dir-locals-class-alist
)
3316 (error "No such class `%s'" (symbol-name class
)))
3317 (push (list directory class mtime
) dir-locals-directory-cache
))
3319 (defun dir-locals-set-class-variables (class variables
)
3320 "Map the type CLASS to a list of variable settings.
3321 CLASS is the project class, a symbol. VARIABLES is a list
3322 that declares directory-local variables for the class.
3323 An element in VARIABLES is either of the form:
3324 (MAJOR-MODE . ALIST)
3328 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3329 whose elements are of the form (VARIABLE . VALUE).
3331 In the second form, DIRECTORY is a directory name (a string), and
3332 LIST is a list of the form accepted by the function.
3334 When a file is visited, the file's class is found. A directory
3335 may be assigned a class using `dir-locals-set-directory-class'.
3336 Then variables are set in the file's buffer according to the
3337 class' LIST. The list is processed in order.
3339 * If the element is of the form (MAJOR-MODE . ALIST), and the
3340 buffer's major mode is derived from MAJOR-MODE (as determined
3341 by `derived-mode-p'), then all the variables in ALIST are
3342 applied. A MAJOR-MODE of nil may be used to match any buffer.
3343 `make-local-variable' is called for each variable before it is
3346 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3347 is an initial substring of the file's directory, then LIST is
3348 applied by recursively following these rules."
3349 (let ((elt (assq class dir-locals-class-alist
)))
3351 (setcdr elt variables
)
3352 (push (cons class variables
) dir-locals-class-alist
))))
3354 (defconst dir-locals-file
".dir-locals.el"
3355 "File that contains directory-local variables.
3356 It has to be constant to enforce uniform values
3357 across different environments and users.")
3359 (defun dir-locals-find-file (file)
3360 "Find the directory-local variables for FILE.
3361 This searches upward in the directory tree from FILE.
3362 If the directory root of FILE has been registered in
3363 `dir-locals-directory-cache' and the directory-local variables
3364 file has not been modified, return the matching entry in
3365 `dir-locals-directory-cache'.
3366 Otherwise, if a directory-local variables file is found, return
3368 Otherwise, return nil."
3369 (setq file
(expand-file-name file
))
3370 (let* ((dir-locals-file-name
3371 (if (eq system-type
'ms-dos
)
3372 (dosified-file-name dir-locals-file
)
3374 (locals-file (locate-dominating-file file dir-locals-file-name
))
3376 ;; `locate-dominating-file' may have abbreviated the name.
3378 (setq locals-file
(expand-file-name dir-locals-file-name locals-file
)))
3379 ;; Find the best cached value in `dir-locals-directory-cache'.
3380 (dolist (elt dir-locals-directory-cache
)
3381 (when (and (eq t
(compare-strings file nil
(length (car elt
))
3384 '(windows-nt cygwin ms-dos
))))
3385 (> (length (car elt
)) (length (car dir-elt
))))
3386 (setq dir-elt elt
)))
3387 (let ((use-cache (and dir-elt
3388 (or (null locals-file
)
3389 (<= (length (file-name-directory locals-file
))
3390 (length (car dir-elt
)))))))
3392 ;; Check the validity of the cache.
3393 (if (and (file-readable-p (car dir-elt
))
3394 (or (null (nth 2 dir-elt
))
3395 (equal (nth 2 dir-elt
)
3396 (nth 5 (file-attributes (car dir-elt
))))))
3397 ;; This cache entry is OK.
3399 ;; This cache entry is invalid; clear it.
3400 (setq dir-locals-directory-cache
3401 (delq dir-elt dir-locals-directory-cache
))
3405 (defun dir-locals-read-from-file (file)
3406 "Load a variables FILE and register a new class and instance.
3407 FILE is the name of the file holding the variables to apply.
3408 The new class name is the same as the directory in which FILE
3409 is found. Returns the new class name."
3411 (insert-file-contents file
)
3412 (let* ((dir-name (file-name-directory file
))
3413 (class-name (intern dir-name
))
3414 (variables (let ((read-circle nil
))
3415 (read (current-buffer)))))
3416 (dir-locals-set-class-variables class-name variables
)
3417 (dir-locals-set-directory-class dir-name class-name
3418 (nth 5 (file-attributes file
)))
3421 (defun hack-dir-local-variables ()
3422 "Read per-directory local variables for the current buffer.
3423 Store the directory-local variables in `dir-local-variables-alist'
3424 and `file-local-variables-alist', without applying them."
3425 (when (and enable-local-variables
3427 (not (file-remote-p (buffer-file-name))))
3428 ;; Find the variables file.
3429 (let ((variables-file (dir-locals-find-file (buffer-file-name)))
3433 ((stringp variables-file
)
3434 (setq dir-name
(file-name-directory (buffer-file-name)))
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
)))))))
3452 (defcustom change-major-mode-with-file-name t
3453 "Non-nil means \\[write-file] should set the major mode from the file name.
3454 However, the mode will not be changed if
3455 \(1) a local variables list or the `-*-' line specifies a major mode, or
3456 \(2) the current major mode is a \"special\" mode,
3457 \ not suitable for ordinary files, or
3458 \(3) the new file name does not particularly specify any mode."
3460 :group
'editing-basics
)
3462 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3463 "Change name of file visited in current buffer to FILENAME.
3464 This also renames the buffer to correspond to the new file.
3465 The next time the buffer is saved it will go in the newly specified file.
3466 FILENAME nil or an empty string means mark buffer as not visiting any file.
3467 Remember to delete the initial contents of the minibuffer
3468 if you wish to pass an empty string as the argument.
3470 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3471 confirmation in the case where another buffer is already visiting FILENAME.
3473 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3474 the old visited file has been renamed to the new name FILENAME."
3475 (interactive "FSet visited file name: ")
3476 (if (buffer-base-buffer)
3477 (error "An indirect buffer cannot visit a file"))
3481 (if (string-equal filename
"")
3483 (expand-file-name filename
))))
3486 (setq truename
(file-truename filename
))
3487 (if find-file-visit-truename
3488 (setq filename truename
))))
3490 (let ((new-name (file-name-nondirectory filename
)))
3491 (if (string= new-name
"")
3492 (error "Empty file name"))))
3493 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3494 (and buffer
(not (eq buffer
(current-buffer)))
3496 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3499 (or (equal filename buffer-file-name
)
3501 (and filename
(lock-buffer filename
))
3503 (setq buffer-file-name filename
)
3504 (if filename
; make buffer name reflect filename.
3505 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3506 (setq default-directory
(file-name-directory buffer-file-name
))
3507 ;; If new-name == old-name, renaming would add a spurious <2>
3508 ;; and it's considered as a feature in rename-buffer.
3509 (or (string= new-name
(buffer-name))
3510 (rename-buffer new-name t
))))
3511 (setq buffer-backed-up nil
)
3513 (clear-visited-file-modtime))
3514 ;; Abbreviate the file names of the buffer.
3517 (setq buffer-file-truename
(abbreviate-file-name truename
))
3518 (if find-file-visit-truename
3519 (setq buffer-file-name truename
))))
3520 (setq buffer-file-number
3522 (nthcdr 10 (file-attributes buffer-file-name
))
3524 ;; write-file-functions is normally used for things like ftp-find-file
3525 ;; that visit things that are not local files as if they were files.
3526 ;; Changing to visit an ordinary local file instead should flush the hook.
3527 (kill-local-variable 'write-file-functions
)
3528 (kill-local-variable 'local-write-file-hooks
)
3529 (kill-local-variable 'revert-buffer-function
)
3530 (kill-local-variable 'backup-inhibited
)
3531 ;; If buffer was read-only because of version control,
3532 ;; that reason is gone now, so make it writable.
3534 (setq buffer-read-only nil
))
3535 (kill-local-variable 'vc-mode
)
3536 ;; Turn off backup files for certain file names.
3537 ;; Since this is a permanent local, the major mode won't eliminate it.
3538 (and buffer-file-name
3539 backup-enable-predicate
3540 (not (funcall backup-enable-predicate buffer-file-name
))
3542 (make-local-variable 'backup-inhibited
)
3543 (setq backup-inhibited t
)))
3544 (let ((oauto buffer-auto-save-file-name
))
3545 ;; If auto-save was not already on, turn it on if appropriate.
3546 (if (not buffer-auto-save-file-name
)
3547 (and buffer-file-name auto-save-default
3549 ;; If auto save is on, start using a new name.
3550 ;; We deliberately don't rename or delete the old auto save
3551 ;; for the old visited file name. This is because perhaps
3552 ;; the user wants to save the new state and then compare with the
3553 ;; previous state from the auto save file.
3554 (setq buffer-auto-save-file-name
3555 (make-auto-save-file-name)))
3556 ;; Rename the old auto save file if any.
3557 (and oauto buffer-auto-save-file-name
3558 (file-exists-p oauto
)
3559 (rename-file oauto buffer-auto-save-file-name t
)))
3560 (and buffer-file-name
3561 (not along-with-file
)
3562 (set-buffer-modified-p t
))
3563 ;; Update the major mode, if the file name determines it.
3565 ;; Don't change the mode if it is special.
3566 (or (not change-major-mode-with-file-name
)
3567 (get major-mode
'mode-class
)
3568 ;; Don't change the mode if the local variable list specifies it.
3569 (hack-local-variables t
)
3573 (defun write-file (filename &optional confirm
)
3574 "Write current buffer into file FILENAME.
3575 This makes the buffer visit that file, and marks it as not modified.
3577 If you specify just a directory name as FILENAME, that means to use
3578 the default file name but in that directory. You can also yank
3579 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3581 If the buffer is not already visiting a file, the default file name
3582 for the output file is the buffer name.
3584 If optional second arg CONFIRM is non-nil, this function
3585 asks for confirmation before overwriting an existing file.
3586 Interactively, confirmation is required unless you supply a prefix argument."
3587 ;; (interactive "FWrite file: ")
3589 (list (if buffer-file-name
3590 (read-file-name "Write file: "
3592 (read-file-name "Write file: " default-directory
3594 (file-name-nondirectory (buffer-name))
3597 (not current-prefix-arg
)))
3598 (or (null filename
) (string-equal filename
"")
3600 ;; If arg is just a directory,
3601 ;; use the default file name, but in that directory.
3602 (if (file-directory-p filename
)
3603 (setq filename
(concat (file-name-as-directory filename
)
3604 (file-name-nondirectory
3605 (or buffer-file-name
(buffer-name))))))
3607 (file-exists-p filename
)
3608 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3609 (error "Canceled")))
3610 (set-visited-file-name filename
(not confirm
))))
3611 (set-buffer-modified-p t
)
3612 ;; Make buffer writable if file is writable.
3613 (and buffer-file-name
3614 (file-writable-p buffer-file-name
)
3615 (setq buffer-read-only nil
))
3617 ;; It's likely that the VC status at the new location is different from
3618 ;; the one at the old location.
3619 (vc-find-file-hook))
3621 (defun backup-buffer ()
3622 "Make a backup of the disk file visited by the current buffer, if appropriate.
3623 This is normally done before saving the buffer the first time.
3625 A backup may be done by renaming or by copying; see documentation of
3626 variable `make-backup-files'. If it's done by renaming, then the file is
3627 no longer accessible under its old name.
3629 The value is non-nil after a backup was made by renaming.
3630 It has the form (MODES . BACKUPNAME).
3631 MODES is the result of `file-modes' on the original
3632 file; this means that the caller, after saving the buffer, should change
3633 the modes of the new file to agree with the old modes.
3634 BACKUPNAME is the backup file name, which is the old file renamed."
3635 (if (and make-backup-files
(not backup-inhibited
)
3636 (not buffer-backed-up
)
3637 (file-exists-p buffer-file-name
)
3638 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3640 (let ((real-file-name buffer-file-name
)
3641 backup-info backupname targets setmodes
)
3642 ;; If specified name is a symbolic link, chase it to the target.
3643 ;; Thus we make the backups in the directory where the real file is.
3644 (setq real-file-name
(file-chase-links real-file-name
))
3645 (setq backup-info
(find-backup-file-name real-file-name
)
3646 backupname
(car backup-info
)
3647 targets
(cdr backup-info
))
3648 ;; (if (file-directory-p buffer-file-name)
3649 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3652 (let ((delete-old-versions
3653 ;; If have old versions to maybe delete,
3654 ;; ask the user to confirm now, before doing anything.
3655 ;; But don't actually delete til later.
3657 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3658 (or delete-old-versions
3659 (y-or-n-p (format "Delete excess backup versions of %s? "
3661 (modes (file-modes buffer-file-name
)))
3662 ;; Actually write the back up file.
3664 (if (or file-precious-flag
3665 ; (file-symlink-p buffer-file-name)
3667 ;; Don't rename a suid or sgid file.
3668 (and modes
(< 0 (logand modes
#o6000
)))
3669 (not (file-writable-p (file-name-directory real-file-name
)))
3670 (and backup-by-copying-when-linked
3671 (> (file-nlinks real-file-name
) 1))
3672 (and (or backup-by-copying-when-mismatch
3673 (integerp backup-by-copying-when-privileged-mismatch
))
3674 (let ((attr (file-attributes real-file-name
)))
3675 (and (or backup-by-copying-when-mismatch
3676 (and (integerp (nth 2 attr
))
3677 (integerp backup-by-copying-when-privileged-mismatch
)
3678 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3680 (not (file-ownership-preserved-p real-file-name
)))))))
3681 (backup-buffer-copy real-file-name backupname modes
)
3682 ;; rename-file should delete old backup.
3683 (rename-file real-file-name backupname t
)
3684 (setq setmodes
(cons modes backupname
)))
3686 ;; If trouble writing the backup, write it in
3687 ;; .emacs.d/%backup%.
3688 (setq backupname
(locate-user-emacs-file "%backup%~"))
3689 (message "Cannot write backup file; backing up in %s"
3692 (backup-buffer-copy real-file-name backupname modes
)))
3693 (setq buffer-backed-up t
)
3694 ;; Now delete the old versions, if desired.
3695 (if delete-old-versions
3698 (delete-file (car targets
))
3700 (setq targets
(cdr targets
))))
3702 (file-error nil
))))))
3704 (defun backup-buffer-copy (from-name to-name modes
)
3705 (let ((umask (default-file-modes)))
3708 ;; Create temp files with strict access rights. It's easy to
3709 ;; loosen them later, whereas it's impossible to close the
3710 ;; time-window of loose permissions otherwise.
3711 (set-default-file-modes ?
\700)
3712 (when (condition-case nil
3713 ;; Try to overwrite old backup first.
3714 (copy-file from-name to-name t t t
)
3716 (while (condition-case nil
3718 (when (file-exists-p to-name
)
3719 (delete-file to-name
))
3720 (copy-file from-name to-name nil t t
)
3722 (file-already-exists t
))
3723 ;; The file was somehow created by someone else between
3724 ;; `delete-file' and `copy-file', so let's try again.
3725 ;; rms says "I think there is also a possible race
3726 ;; condition for making backup files" (emacs-devel 20070821).
3729 (set-default-file-modes umask
)))
3731 (set-file-modes to-name
(logand modes
#o1777
))))
3733 (defun file-name-sans-versions (name &optional keep-backup-version
)
3734 "Return file NAME sans backup versions or strings.
3735 This is a separate procedure so your site-init or startup file can
3737 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3738 we do not remove backup version numbers, only true file version numbers."
3739 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
3741 (funcall handler
'file-name-sans-versions name keep-backup-version
)
3743 (if keep-backup-version
3745 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name
)
3746 (string-match "~\\'" name
)
3749 (defun file-ownership-preserved-p (file)
3750 "Return t if deleting FILE and rewriting it would preserve the owner."
3751 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
3753 (funcall handler
'file-ownership-preserved-p file
)
3754 (let ((attributes (file-attributes file
)))
3755 ;; Return t if the file doesn't exist, since it's true that no
3756 ;; information would be lost by an (attempted) delete and create.
3757 (or (null attributes
)
3758 (= (nth 2 attributes
) (user-uid)))))))
3760 (defun file-name-sans-extension (filename)
3761 "Return FILENAME sans final \"extension\".
3762 The extension, in a file name, is the part that follows the last `.',
3763 except that a leading `.', if any, doesn't count."
3765 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
3767 (if (and (string-match "\\.[^.]*\\'" file
)
3768 (not (eq 0 (match-beginning 0))))
3769 (if (setq directory
(file-name-directory filename
))
3770 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3771 ;; we don't want to expand it.
3772 (concat directory
(substring file
0 (match-beginning 0)))
3773 (substring file
0 (match-beginning 0)))
3776 (defun file-name-extension (filename &optional period
)
3777 "Return FILENAME's final \"extension\".
3778 The extension, in a file name, is the part that follows the last `.',
3779 excluding version numbers and backup suffixes,
3780 except that a leading `.', if any, doesn't count.
3781 Return nil for extensionless file names such as `foo'.
3782 Return the empty string for file names such as `foo.'.
3784 If PERIOD is non-nil, then the returned value includes the period
3785 that delimits the extension, and if FILENAME has no extension,
3788 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
3789 (if (and (string-match "\\.[^.]*\\'" file
)
3790 (not (eq 0 (match-beginning 0))))
3791 (substring file
(+ (match-beginning 0) (if period
0 1)))
3795 (defcustom make-backup-file-name-function nil
3796 "A function to use instead of the default `make-backup-file-name'.
3797 A value of nil gives the default `make-backup-file-name' behavior.
3799 This could be buffer-local to do something special for specific
3800 files. If you define it, you may need to change `backup-file-name-p'
3801 and `file-name-sans-versions' too.
3803 See also `backup-directory-alist'."
3805 :type
'(choice (const :tag
"Default" nil
)
3806 (function :tag
"Your function")))
3808 (defcustom backup-directory-alist nil
3809 "Alist of filename patterns and backup directory names.
3810 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3811 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3812 relative or absolute. If it is absolute, so that all matching files
3813 are backed up into the same directory, the file names in this
3814 directory will be the full name of the file backed up with all
3815 directory separators changed to `!' to prevent clashes. This will not
3816 work correctly if your filesystem truncates the resulting name.
3818 For the common case of all backups going into one directory, the alist
3819 should contain a single element pairing \".\" with the appropriate
3822 If this variable is nil, or it fails to match a filename, the backup
3823 is made in the original file's directory.
3825 On MS-DOS filesystems without long names this variable is always
3828 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
3829 (directory :tag
"Backup directory name"))))
3831 (defun normal-backup-enable-predicate (name)
3832 "Default `backup-enable-predicate' function.
3833 Checks for files in `temporary-file-directory',
3834 `small-temporary-file-directory', and /tmp."
3835 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
3837 ;; Directory is under temporary-file-directory.
3838 (and (not (eq comp t
))
3839 (< comp
(- (length temporary-file-directory
)))))
3840 (let ((comp (compare-strings "/tmp" 0 nil
3842 ;; Directory is under /tmp.
3843 (and (not (eq comp t
))
3844 (< comp
(- (length "/tmp")))))
3845 (if small-temporary-file-directory
3846 (let ((comp (compare-strings small-temporary-file-directory
3849 ;; Directory is under small-temporary-file-directory.
3850 (and (not (eq comp t
))
3851 (< comp
(- (length small-temporary-file-directory
)))))))))
3853 (defun make-backup-file-name (file)
3854 "Create the non-numeric backup file name for FILE.
3855 Normally this will just be the file's name with `~' appended.
3856 Customization hooks are provided as follows.
3858 If the variable `make-backup-file-name-function' is non-nil, its value
3859 should be a function which will be called with FILE as its argument;
3860 the resulting name is used.
3862 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3863 the documentation of that variable. If the directory for the backup
3864 doesn't exist, it is created."
3865 (if make-backup-file-name-function
3866 (funcall make-backup-file-name-function file
)
3867 (if (and (eq system-type
'ms-dos
)
3868 (not (msdos-long-file-names)))
3869 (let ((fn (file-name-nondirectory file
)))
3870 (concat (file-name-directory file
)
3871 (or (and (string-match "\\`[^.]+\\'" fn
)
3872 (concat (match-string 0 fn
) ".~"))
3873 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
3874 (concat (match-string 0 fn
) "~")))))
3875 (concat (make-backup-file-name-1 file
) "~"))))
3877 (defun make-backup-file-name-1 (file)
3878 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3879 (let ((alist backup-directory-alist
)
3880 elt backup-directory abs-backup-directory
)
3882 (setq elt
(pop alist
))
3883 (if (string-match (car elt
) file
)
3884 (setq backup-directory
(cdr elt
)
3886 ;; If backup-directory is relative, it should be relative to the
3887 ;; file's directory. By expanding explicitly here, we avoid
3888 ;; depending on default-directory.
3889 (if backup-directory
3890 (setq abs-backup-directory
3891 (expand-file-name backup-directory
3892 (file-name-directory file
))))
3893 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
3895 (make-directory abs-backup-directory
'parents
)
3896 (file-error (setq backup-directory nil
3897 abs-backup-directory nil
))))
3898 (if (null backup-directory
)
3900 (if (file-name-absolute-p backup-directory
)
3902 (when (memq system-type
'(windows-nt ms-dos cygwin
))
3903 ;; Normalize DOSish file names: downcase the drive
3904 ;; letter, if any, and replace the leading "x:" with
3906 (or (file-name-absolute-p file
)
3907 (setq file
(expand-file-name file
))) ; make defaults explicit
3908 ;; Replace any invalid file-name characters (for the
3909 ;; case of backing up remote files).
3910 (setq file
(expand-file-name (convert-standard-filename file
)))
3911 (if (eq (aref file
1) ?
:)
3912 (setq file
(concat "/"
3914 (char-to-string (downcase (aref file
0)))
3915 (if (eq (aref file
2) ?
/)
3918 (substring file
2)))))
3919 ;; Make the name unique by substituting directory
3920 ;; separators. It may not really be worth bothering about
3921 ;; doubling `!'s in the original name...
3923 (subst-char-in-string
3925 (replace-regexp-in-string "!" "!!" file
))
3927 (expand-file-name (file-name-nondirectory file
)
3928 (file-name-as-directory abs-backup-directory
))))))
3930 (defun backup-file-name-p (file)
3931 "Return non-nil if FILE is a backup file name (numeric or not).
3932 This is a separate function so you can redefine it for customization.
3933 You may need to redefine `file-name-sans-versions' as well."
3934 (string-match "~\\'" file
))
3936 (defvar backup-extract-version-start
)
3938 ;; This is used in various files.
3939 ;; The usage of backup-extract-version-start is not very clean,
3940 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3941 (defun backup-extract-version (fn)
3942 "Given the name of a numeric backup file, FN, return the backup number.
3943 Uses the free variable `backup-extract-version-start', whose value should be
3944 the index in the name where the version number begins."
3945 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start
)
3946 (= (match-beginning 0) backup-extract-version-start
))
3947 (string-to-number (substring fn backup-extract-version-start -
1))
3950 (defun find-backup-file-name (fn)
3951 "Find a file name for a backup file FN, and suggestions for deletions.
3952 Value is a list whose car is the name for the backup file
3953 and whose cdr is a list of old versions to consider deleting now.
3954 If the value is nil, don't make a backup.
3955 Uses `backup-directory-alist' in the same way as does
3956 `make-backup-file-name'."
3957 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
3958 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3960 (funcall handler
'find-backup-file-name fn
)
3961 (if (or (eq version-control
'never
)
3962 ;; We don't support numbered backups on plain MS-DOS
3963 ;; when long file names are unavailable.
3964 (and (eq system-type
'ms-dos
)
3965 (not (msdos-long-file-names))))
3966 (list (make-backup-file-name fn
))
3967 (let* ((basic-name (make-backup-file-name-1 fn
))
3968 (base-versions (concat (file-name-nondirectory basic-name
)
3970 (backup-extract-version-start (length base-versions
))
3972 (number-to-delete 0)
3973 possibilities deserve-versions-p versions
)
3975 (setq possibilities
(file-name-all-completions
3977 (file-name-directory basic-name
))
3978 versions
(sort (mapcar #'backup-extract-version
3981 high-water-mark
(apply 'max
0 versions
)
3982 deserve-versions-p
(or version-control
3983 (> high-water-mark
0))
3984 number-to-delete
(- (length versions
)
3988 (file-error (setq possibilities nil
)))
3989 (if (not deserve-versions-p
)
3990 (list (make-backup-file-name fn
))
3991 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
3992 (if (and (> number-to-delete
0)
3993 ;; Delete nothing if there is overflow
3994 ;; in the number of versions to keep.
3995 (>= (+ kept-new-versions kept-old-versions -
1) 0))
3997 (format "%s.~%d~" basic-name n
))
3998 (let ((v (nthcdr kept-old-versions versions
)))
3999 (rplacd (nthcdr (1- number-to-delete
) v
) ())
4002 (defun file-nlinks (filename)
4003 "Return number of names file FILENAME has."
4004 (car (cdr (file-attributes filename
))))
4006 ;; (defun file-relative-name (filename &optional directory)
4007 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4008 ;; This function returns a relative file name which is equivalent to FILENAME
4009 ;; when used with that default directory as the default.
4010 ;; If this is impossible (which can happen on MSDOS and Windows
4011 ;; when the file name and directory use different drive names)
4012 ;; then it returns FILENAME."
4014 ;; (let ((fname (expand-file-name filename)))
4015 ;; (setq directory (file-name-as-directory
4016 ;; (expand-file-name (or directory default-directory))))
4017 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4018 ;; ;; drive names, they can't be relative, so return the absolute name.
4019 ;; (if (and (or (eq system-type 'ms-dos)
4020 ;; (eq system-type 'cygwin)
4021 ;; (eq system-type 'windows-nt))
4022 ;; (not (string-equal (substring fname 0 2)
4023 ;; (substring directory 0 2))))
4025 ;; (let ((ancestor ".")
4026 ;; (fname-dir (file-name-as-directory fname)))
4027 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4028 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4029 ;; (setq directory (file-name-directory (substring directory 0 -1))
4030 ;; ancestor (if (equal ancestor ".")
4032 ;; (concat "../" ancestor))))
4033 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4034 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4035 ;; ;; We matched within FNAME's directory part.
4036 ;; ;; Add the rest of FNAME onto ANCESTOR.
4037 ;; (let ((rest (substring fname (match-end 0))))
4038 ;; (if (and (equal ancestor ".")
4039 ;; (not (equal rest "")))
4040 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4042 ;; (concat (file-name-as-directory ancestor) rest)))
4043 ;; ;; We matched FNAME's directory equivalent.
4046 (defun file-relative-name (filename &optional directory
)
4047 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4048 This function returns a relative file name which is equivalent to FILENAME
4049 when used with that default directory as the default.
4050 If FILENAME and DIRECTORY lie on different machines or on different drives
4051 on a DOS/Windows machine, it returns FILENAME in expanded form."
4054 (file-name-as-directory (expand-file-name (or directory
4055 default-directory
))))
4056 (setq filename
(expand-file-name filename
))
4057 (let ((fremote (file-remote-p filename
))
4058 (dremote (file-remote-p directory
)))
4059 (if ;; Conditions for separate trees
4061 ;; Test for different filesystems on DOS/Windows
4063 ;; Should `cygwin' really be included here? --stef
4064 (memq system-type
'(ms-dos cygwin windows-nt
))
4066 ;; Test for different drive letters
4067 (not (eq t
(compare-strings filename
0 2 directory
0 2)))
4068 ;; Test for UNCs on different servers
4069 (not (eq t
(compare-strings
4071 (if (string-match "\\`//\\([^:/]+\\)/" filename
)
4072 (match-string 1 filename
)
4073 ;; Windows file names cannot have ? in
4074 ;; them, so use that to detect when
4075 ;; neither FILENAME nor DIRECTORY is a
4080 (if (string-match "\\`//\\([^:/]+\\)/" directory
)
4081 (match-string 1 directory
)
4084 ;; Test for different remote file system identification
4085 (not (equal fremote dremote
)))
4087 (let ((ancestor ".")
4088 (filename-dir (file-name-as-directory filename
)))
4091 (eq t
(compare-strings filename-dir nil
(length directory
)
4092 directory nil nil case-fold-search
))
4093 (eq t
(compare-strings filename nil
(length directory
)
4094 directory nil nil case-fold-search
))))
4095 (setq directory
(file-name-directory (substring directory
0 -
1))
4096 ancestor
(if (equal ancestor
".")
4098 (concat "../" ancestor
))))
4099 ;; Now ancestor is empty, or .., or ../.., etc.
4100 (if (eq t
(compare-strings filename nil
(length directory
)
4101 directory nil nil case-fold-search
))
4102 ;; We matched within FILENAME's directory part.
4103 ;; Add the rest of FILENAME onto ANCESTOR.
4104 (let ((rest (substring filename
(length directory
))))
4105 (if (and (equal ancestor
".") (not (equal rest
"")))
4106 ;; But don't bother with ANCESTOR if it would give us `./'.
4108 (concat (file-name-as-directory ancestor
) rest
)))
4109 ;; We matched FILENAME's directory equivalent.
4112 (defun save-buffer (&optional args
)
4113 "Save current buffer in visited file if modified.
4114 Variations are described below.
4116 By default, makes the previous version into a backup file
4117 if previously requested or if this is the first save.
4118 Prefixed with one \\[universal-argument], marks this version
4119 to become a backup when the next save is done.
4120 Prefixed with two \\[universal-argument]'s,
4121 unconditionally makes the previous version into a backup file.
4122 Prefixed with three \\[universal-argument]'s, marks this version
4123 to become a backup when the next save is done,
4124 and unconditionally makes the previous version into a backup file.
4126 With a numeric argument of 0, never make the previous version
4129 If a file's name is FOO, the names of its numbered backup versions are
4130 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4131 Numeric backups (rather than FOO~) will be made if value of
4132 `version-control' is not the atom `never' and either there are already
4133 numeric versions of the file being backed up, or `version-control' is
4135 We don't want excessive versions piling up, so there are variables
4136 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4137 and `kept-new-versions', which tells how many newest versions to keep.
4138 Defaults are 2 old versions and 2 new.
4139 `dired-kept-versions' controls dired's clean-directory (.) command.
4140 If `delete-old-versions' is nil, system will query user
4141 before trimming versions. Otherwise it does it silently.
4143 If `vc-make-backup-files' is nil, which is the default,
4144 no backup files are made for files managed by version control.
4145 (This is because the version control system itself records previous versions.)
4147 See the subroutine `basic-save-buffer' for more information."
4149 (let ((modp (buffer-modified-p))
4150 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
4151 (memq args
'(16 64)))))
4152 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
4153 ;; We used to display the message below only for files > 50KB, but
4154 ;; then Rmail-mbox never displays it due to buffer swapping. If
4155 ;; the test is ever re-introduced, be sure to handle saving of
4157 (if (and modp
(buffer-file-name))
4158 (message "Saving file %s..." (buffer-file-name)))
4160 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
4162 (defun delete-auto-save-file-if-necessary (&optional force
)
4163 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4164 Normally delete only if the file was written by this Emacs since
4165 the last real save, but optional arg FORCE non-nil means delete anyway."
4166 (and buffer-auto-save-file-name delete-auto-save-files
4167 (not (string= buffer-file-name buffer-auto-save-file-name
))
4168 (or force
(recent-auto-save-p))
4171 (delete-file buffer-auto-save-file-name
)
4173 (set-buffer-auto-saved))))
4175 (defvar auto-save-hook nil
4176 "Normal hook run just before auto-saving.")
4178 (defcustom before-save-hook nil
4179 "Normal hook that is run before a buffer is saved to its file."
4180 :options
'(copyright-update time-stamp
)
4184 (defcustom after-save-hook nil
4185 "Normal hook that is run after a buffer is saved to its file."
4186 :options
'(executable-make-buffer-file-executable-if-script-p)
4190 (defvar save-buffer-coding-system nil
4191 "If non-nil, use this coding system for saving the buffer.
4192 More precisely, use this coding system in place of the
4193 value of `buffer-file-coding-system', when saving the buffer.
4194 Calling `write-region' for any purpose other than saving the buffer
4195 will still use `buffer-file-coding-system'; this variable has no effect
4198 (make-variable-buffer-local 'save-buffer-coding-system
)
4199 (put 'save-buffer-coding-system
'permanent-local t
)
4201 (defun basic-save-buffer ()
4202 "Save the current buffer in its visited file, if it has been modified.
4203 The hooks `write-contents-functions' and `write-file-functions' get a chance
4204 to do the job of saving; if they do not, then the buffer is saved in
4205 the visited file in the usual way.
4206 Before and after saving the buffer, this function runs
4207 `before-save-hook' and `after-save-hook', respectively."
4209 (save-current-buffer
4210 ;; In an indirect buffer, save its base buffer instead.
4211 (if (buffer-base-buffer)
4212 (set-buffer (buffer-base-buffer)))
4213 (if (buffer-modified-p)
4214 (let ((recent-save (recent-auto-save-p))
4216 ;; If buffer has no file name, ask user for one.
4217 (or buffer-file-name
4220 (read-file-name "File to save in: ") nil
)))
4221 (if (file-exists-p filename
)
4222 (if (file-directory-p filename
)
4223 ;; Signal an error if the user specified the name of an
4224 ;; existing directory.
4225 (error "%s is a directory" filename
)
4226 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4228 (error "Canceled")))
4229 ;; Signal an error if the specified name refers to a
4230 ;; non-existing directory.
4231 (let ((dir (file-name-directory filename
)))
4232 (unless (file-directory-p dir
)
4233 (if (file-exists-p dir
)
4234 (error "%s is not a directory" dir
)
4235 (error "%s: no such directory" dir
)))))
4236 (set-visited-file-name filename
)))
4237 (or (verify-visited-file-modtime (current-buffer))
4238 (not (file-exists-p buffer-file-name
))
4240 (format "%s has changed since visited or saved. Save anyway? "
4241 (file-name-nondirectory buffer-file-name
)))
4242 (error "Save not confirmed"))
4246 (and (> (point-max) (point-min))
4247 (not find-file-literally
)
4248 (/= (char-after (1- (point-max))) ?
\n)
4249 (not (and (eq selective-display t
)
4250 (= (char-after (1- (point-max))) ?
\r)))
4251 (or (eq require-final-newline t
)
4252 (eq require-final-newline
'visit-save
)
4253 (and require-final-newline
4255 (format "Buffer %s does not end in newline. Add one? "
4258 (goto-char (point-max))
4260 ;; Support VC version backups.
4262 (run-hooks 'before-save-hook
)
4263 (or (run-hook-with-args-until-success 'write-contents-functions
)
4264 (run-hook-with-args-until-success 'local-write-file-hooks
)
4265 (run-hook-with-args-until-success 'write-file-functions
)
4266 ;; If a hook returned t, file is already "written".
4267 ;; Otherwise, write it the usual way now.
4268 (setq setmodes
(basic-save-buffer-1)))
4269 ;; Now we have saved the current buffer. Let's make sure
4270 ;; that buffer-file-coding-system is fixed to what
4271 ;; actually used for saving by binding it locally.
4272 (if save-buffer-coding-system
4273 (setq save-buffer-coding-system last-coding-system-used
)
4274 (setq buffer-file-coding-system last-coding-system-used
))
4275 (setq buffer-file-number
4276 (nthcdr 10 (file-attributes buffer-file-name
)))
4279 (set-file-modes buffer-file-name
(car setmodes
))
4281 ;; If the auto-save file was recent before this command,
4283 (delete-auto-save-file-if-necessary recent-save
)
4284 ;; Support VC `implicit' locking.
4286 (run-hooks 'after-save-hook
))
4287 (message "(No changes need to be saved)"))))
4289 ;; This does the "real job" of writing a buffer into its visited file
4290 ;; and making a backup file. This is what is normally done
4291 ;; but inhibited if one of write-file-functions returns non-nil.
4292 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4293 (defun basic-save-buffer-1 ()
4295 (if save-buffer-coding-system
4296 (let ((coding-system-for-write save-buffer-coding-system
))
4297 (basic-save-buffer-2))
4298 (basic-save-buffer-2))
4299 (if buffer-file-coding-system-explicit
4300 (setcar buffer-file-coding-system-explicit last-coding-system-used
)
4301 (setq buffer-file-coding-system-explicit
4302 (cons last-coding-system-used nil
)))))
4304 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4305 (defun basic-save-buffer-2 ()
4306 (let (tempsetmodes setmodes
)
4307 (if (not (file-writable-p buffer-file-name
))
4308 (let ((dir (file-name-directory buffer-file-name
)))
4309 (if (not (file-directory-p dir
))
4310 (if (file-exists-p dir
)
4311 (error "%s is not a directory" dir
)
4312 (error "%s: no such directory" dir
))
4313 (if (not (file-exists-p buffer-file-name
))
4314 (error "Directory %s write-protected" dir
)
4316 (format "File %s is write-protected; try to save anyway? "
4317 (file-name-nondirectory
4319 (setq tempsetmodes t
)
4320 (error "Attempt to save to a file which you aren't allowed to write"))))))
4321 (or buffer-backed-up
4322 (setq setmodes
(backup-buffer)))
4323 (let* ((dir (file-name-directory buffer-file-name
))
4324 (dir-writable (file-writable-p dir
)))
4325 (if (or (and file-precious-flag dir-writable
)
4326 (and break-hardlink-on-save
4327 (> (file-nlinks buffer-file-name
) 1)
4329 (error (concat (format
4330 "Directory %s write-protected; " dir
)
4331 "cannot break hardlink when saving")))))
4332 ;; Write temp name, then rename it.
4333 ;; This requires write access to the containing dir,
4334 ;; which is why we don't try it if we don't have that access.
4335 (let ((realname buffer-file-name
)
4337 (umask (default-file-modes))
4338 (old-modtime (visited-file-modtime)))
4339 ;; Create temp files with strict access rights. It's easy to
4340 ;; loosen them later, whereas it's impossible to close the
4341 ;; time-window of loose permissions otherwise.
4344 (clear-visited-file-modtime)
4345 (set-default-file-modes ?
\700)
4346 ;; Try various temporary names.
4347 ;; This code follows the example of make-temp-file,
4348 ;; but it calls write-region in the appropriate way
4349 ;; for saving the buffer.
4350 (while (condition-case ()
4354 (expand-file-name "tmp" dir
)))
4355 ;; Pass in nil&nil rather than point-min&max
4356 ;; cause we're saving the whole buffer.
4357 ;; write-region-annotate-functions may use it.
4358 (write-region nil nil
4359 tempname nil realname
4360 buffer-file-truename
'excl
)
4362 (file-already-exists t
))
4363 ;; The file was somehow created by someone else between
4364 ;; `make-temp-name' and `write-region', let's try again.
4368 (set-default-file-modes umask
)
4369 ;; If we failed, restore the buffer's modtime.
4371 (set-visited-file-modtime old-modtime
)))
4372 ;; Since we have created an entirely new file,
4373 ;; make sure it gets the right permission bits set.
4374 (setq setmodes
(or setmodes
4375 (cons (or (file-modes buffer-file-name
)
4376 (logand ?
\666 umask
))
4378 ;; We succeeded in writing the temp file,
4380 (rename-file tempname buffer-file-name t
))
4381 ;; If file not writable, see if we can make it writable
4382 ;; temporarily while we write it.
4383 ;; But no need to do so if we have just backed it up
4384 ;; (setmodes is set) because that says we're superseding.
4385 (cond ((and tempsetmodes
(not setmodes
))
4386 ;; Change the mode back, after writing.
4387 (setq setmodes
(cons (file-modes buffer-file-name
) buffer-file-name
))
4388 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))))
4392 ;; Pass in nil&nil rather than point-min&max to indicate
4393 ;; we're saving the buffer rather than just a region.
4394 ;; write-region-annotate-functions may make us of it.
4395 (write-region nil nil
4396 buffer-file-name nil t buffer-file-truename
)
4398 ;; If we get an error writing the new file, and we made
4399 ;; the backup by renaming, undo the backing-up.
4400 (and setmodes
(not success
)
4402 (rename-file (cdr setmodes
) buffer-file-name t
)
4403 (setq buffer-backed-up nil
)))))))
4406 (defun diff-buffer-with-file (&optional buffer
)
4407 "View the differences between BUFFER and its associated file.
4408 This requires the external program `diff' to be in your `exec-path'."
4409 (interactive "bBuffer: ")
4410 (with-current-buffer (get-buffer (or buffer
(current-buffer)))
4411 (if (and buffer-file-name
4412 (file-exists-p buffer-file-name
))
4413 (let ((tempfile (make-temp-file "buffer-content-")))
4416 (write-region nil nil tempfile nil
'nomessage
)
4417 (diff buffer-file-name tempfile nil t
)
4419 (when (file-exists-p tempfile
)
4420 (delete-file tempfile
))))
4421 (message "Buffer %s has no associated file on disc" (buffer-name))
4422 ;; Display that message for 1 second so that user can read it
4423 ;; in the minibuffer.
4425 ;; return always nil, so that save-buffers-kill-emacs will not move
4426 ;; over to the next unsaved buffer when calling `d'.
4429 (defvar save-some-buffers-action-alist
4432 (if (not enable-recursive-minibuffers
)
4433 (progn (display-buffer buf
)
4434 (setq other-window-scroll-buffer buf
))
4435 (view-buffer buf
(lambda (_) (exit-recursive-edit)))
4437 ;; Return nil to ask about BUF again.
4439 ,(purecopy "view this buffer"))
4441 (if (null (buffer-file-name buf
))
4442 (message "Not applicable: no file")
4443 (save-window-excursion (diff-buffer-with-file buf
))
4444 (if (not enable-recursive-minibuffers
)
4445 (progn (display-buffer (get-buffer-create "*Diff*"))
4446 (setq other-window-scroll-buffer
"*Diff*"))
4447 (view-buffer (get-buffer-create "*Diff*")
4448 (lambda (_) (exit-recursive-edit)))
4450 ;; Return nil to ask about BUF again.
4452 ,(purecopy "view changes in this buffer")))
4453 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4454 (put 'save-some-buffers-action-alist
'risky-local-variable t
)
4456 (defvar buffer-save-without-query nil
4457 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4458 (make-variable-buffer-local 'buffer-save-without-query
)
4460 (defun save-some-buffers (&optional arg pred
)
4461 "Save some modified file-visiting buffers. Asks user about each one.
4462 You can answer `y' to save, `n' not to save, `C-r' to look at the
4463 buffer in question with `view-buffer' before deciding or `d' to
4464 view the differences using `diff-buffer-with-file'.
4466 Optional argument (the prefix) non-nil means save all with no questions.
4467 Optional second argument PRED determines which buffers are considered:
4468 If PRED is nil, all the file-visiting buffers are considered.
4469 If PRED is t, then certain non-file buffers will also be considered.
4470 If PRED is a zero-argument function, it indicates for each buffer whether
4471 to consider it or not when called with that buffer current.
4473 See `save-some-buffers-action-alist' if you want to
4474 change the additional actions you can take on files."
4476 (save-window-excursion
4477 (let* (queried some-automatic
4478 files-done abbrevs-done
)
4479 (dolist (buffer (buffer-list))
4480 ;; First save any buffers that we're supposed to save unconditionally.
4481 ;; That way the following code won't ask about them.
4482 (with-current-buffer buffer
4483 (when (and buffer-save-without-query
(buffer-modified-p))
4484 (setq some-automatic t
)
4486 ;; Ask about those buffers that merit it,
4487 ;; and record the number thus saved.
4491 ;; Note that killing some buffers may kill others via
4492 ;; hooks (e.g. Rmail and its viewing buffer).
4493 (and (buffer-live-p buffer
)
4494 (buffer-modified-p buffer
)
4495 (not (buffer-base-buffer buffer
))
4497 (buffer-file-name buffer
)
4501 (and buffer-offer-save
(> (buffer-size) 0)))))
4502 (or (not (functionp pred
))
4503 (with-current-buffer buffer
(funcall pred
)))
4507 (if (buffer-file-name buffer
)
4508 (format "Save file %s? "
4509 (buffer-file-name buffer
))
4510 (format "Save buffer %s? "
4511 (buffer-name buffer
))))))
4513 (with-current-buffer buffer
4516 '("buffer" "buffers" "save")
4517 save-some-buffers-action-alist
))
4518 ;; Maybe to save abbrevs, and record whether
4519 ;; we either saved them or asked to.
4520 (and save-abbrevs abbrevs-changed
4523 (eq save-abbrevs
'silently
)
4524 (y-or-n-p (format "Save abbrevs in %s? "
4526 (write-abbrev-file nil
))
4527 ;; Don't keep bothering user if he says no.
4528 (setq abbrevs-changed nil
)
4529 (setq abbrevs-done t
)))
4530 (or queried
(> files-done
0) abbrevs-done
4531 (message (if some-automatic
4532 "(Some special files were saved without asking)"
4533 "(No files need saving)"))))))
4535 (defun not-modified (&optional arg
)
4536 "Mark current buffer as unmodified, not needing to be saved.
4537 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4539 It is not a good idea to use this function in Lisp programs, because it
4540 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4542 (message (if arg
"Modification-flag set"
4543 "Modification-flag cleared"))
4544 (set-buffer-modified-p arg
))
4546 (defun toggle-read-only (&optional arg
)
4547 "Change whether this buffer is read-only.
4548 With prefix argument ARG, make the buffer read-only if ARG is
4549 positive, otherwise make it writable. If buffer is read-only
4550 and `view-read-only' is non-nil, enter view mode."
4553 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4554 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4558 ((and buffer-read-only view-mode
)
4559 (View-exit-and-edit)
4560 (make-local-variable 'view-read-only
)
4561 (setq view-read-only t
)) ; Must leave view mode.
4562 ((and (not buffer-read-only
) view-read-only
4563 ;; If view-mode is already active, `view-mode-enter' is a nop.
4565 (not (eq (get major-mode
'mode-class
) 'special
)))
4567 (t (setq buffer-read-only
(not buffer-read-only
))
4568 (force-mode-line-update)))
4569 (if (vc-backend buffer-file-name
)
4570 (message "%s" (substitute-command-keys
4571 (concat "File is under version-control; "
4572 "use \\[vc-next-action] to check in/out"))))))
4574 (defun insert-file (filename)
4575 "Insert contents of file FILENAME into buffer after point.
4576 Set mark after the inserted text.
4578 This function is meant for the user to run interactively.
4579 Don't call it from programs! Use `insert-file-contents' instead.
4580 \(Its calling sequence is different; see its documentation)."
4581 (interactive "*fInsert file: ")
4582 (insert-file-1 filename
#'insert-file-contents
))
4584 (defun append-to-file (start end filename
)
4585 "Append the contents of the region to the end of file FILENAME.
4586 When called from a function, expects three arguments,
4587 START, END and FILENAME. START and END are normally buffer positions
4588 specifying the part of the buffer to write.
4589 If START is nil, that means to use the entire buffer contents.
4590 If START is a string, then output that string to the file
4591 instead of any buffer contents; END is ignored.
4593 This does character code conversion and applies annotations
4594 like `write-region' does."
4595 (interactive "r\nFAppend to file: ")
4596 (write-region start end filename t
))
4598 (defun file-newest-backup (filename)
4599 "Return most recent backup file for FILENAME or nil if no backups exist."
4600 ;; `make-backup-file-name' will get us the right directory for
4601 ;; ordinary or numeric backups. It might create a directory for
4602 ;; backups as a side-effect, according to `backup-directory-alist'.
4603 (let* ((filename (file-name-sans-versions
4604 (make-backup-file-name (expand-file-name filename
))))
4605 (file (file-name-nondirectory filename
))
4606 (dir (file-name-directory filename
))
4607 (comp (file-name-all-completions file dir
))
4611 (setq tem
(pop comp
))
4612 (cond ((and (backup-file-name-p tem
)
4613 (string= (file-name-sans-versions tem
) file
))
4614 (setq tem
(concat dir tem
))
4615 (if (or (null newest
)
4616 (file-newer-than-file-p tem newest
))
4617 (setq newest tem
)))))
4620 (defun rename-uniquely ()
4621 "Rename current buffer to a similar name not already taken.
4622 This function is useful for creating multiple shell process buffers
4623 or multiple mail buffers, etc."
4626 (let ((base-name (buffer-name)))
4627 (and (string-match "<[0-9]+>\\'" base-name
)
4628 (not (and buffer-file-name
4630 (file-name-nondirectory buffer-file-name
))))
4631 ;; If the existing buffer name has a <NNN>,
4632 ;; which isn't part of the file name (if any),
4633 ;; then get rid of that.
4634 (setq base-name
(substring base-name
0 (match-beginning 0))))
4635 (rename-buffer (generate-new-buffer-name base-name
))
4636 (force-mode-line-update))))
4638 (defun make-directory (dir &optional parents
)
4639 "Create the directory DIR and any nonexistent parent dirs.
4640 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4642 Interactively, the default choice of directory to create
4643 is the current default directory for file names.
4644 That is useful when you have visited a file in a nonexistent directory.
4646 Noninteractively, the second (optional) argument PARENTS says whether
4647 to create parent directories if they don't exist. Interactively,
4648 this happens by default."
4650 (list (read-file-name "Make directory: " default-directory default-directory
4653 ;; If default-directory is a remote directory,
4654 ;; make sure we find its make-directory handler.
4655 (setq dir
(expand-file-name dir
))
4656 (let ((handler (find-file-name-handler dir
'make-directory
)))
4658 (funcall handler
'make-directory dir parents
)
4660 (make-directory-internal dir
)
4661 (let ((dir (directory-file-name (expand-file-name dir
)))
4663 (while (and (not (file-exists-p dir
))
4664 ;; If directory is its own parent, then we can't
4665 ;; keep looping forever
4667 (directory-file-name
4668 (file-name-directory dir
)))))
4669 (setq create-list
(cons dir create-list
)
4670 dir
(directory-file-name (file-name-directory dir
))))
4672 (make-directory-internal (car create-list
))
4673 (setq create-list
(cdr create-list
))))))))
4675 (defconst directory-files-no-dot-files-regexp
4676 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4677 "Regexp matching any file name except \".\" and \"..\".")
4679 (defun delete-directory (directory &optional recursive
)
4680 "Delete the directory named DIRECTORY. Does not follow symlinks.
4681 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well."
4683 (let ((dir (expand-file-name
4685 "Delete directory: "
4686 default-directory default-directory nil nil
))))
4688 (if (directory-files dir nil directory-files-no-dot-files-regexp
)
4690 (format "Directory `%s' is not empty, really delete? " dir
))
4692 ;; If default-directory is a remote directory, make sure we find its
4693 ;; delete-directory handler.
4694 (setq directory
(directory-file-name (expand-file-name directory
)))
4695 (let ((handler (find-file-name-handler directory
'delete-directory
)))
4698 (funcall handler
'delete-directory directory recursive
))
4699 (delete-by-moving-to-trash
4700 ;; Only move non-empty dir to trash if recursive deletion was
4701 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4702 ;; case, where the operation fails in delete-directory-internal.
4703 ;; As `move-file-to-trash' trashes directories (empty or
4704 ;; otherwise) as a unit, we do not need to recurse here.
4705 (if (and (not recursive
)
4706 ;; Check if directory is empty apart from "." and "..".
4708 directory
'full directory-files-no-dot-files-regexp
))
4709 (error "Directory is not empty, not moving to trash")
4710 (move-file-to-trash directory
)))
4711 ;; Otherwise, call outselves recursively if needed.
4713 (if (and recursive
(not (file-symlink-p directory
)))
4714 (mapc (lambda (file)
4715 ;; This test is equivalent to
4716 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4717 ;; but more efficient
4718 (if (eq t
(car (file-attributes file
)))
4719 (delete-directory file recursive
)
4720 (delete-file file
)))
4721 ;; We do not want to delete "." and "..".
4723 directory
'full directory-files-no-dot-files-regexp
)))
4724 (delete-directory-internal directory
)))))
4726 (defun copy-directory (directory newname
&optional keep-time
4727 parents copy-as-subdir
)
4728 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4729 This function always sets the file modes of the output files to match
4730 the corresponding input file.
4732 The third arg KEEP-TIME non-nil means give the output files the same
4733 last-modified time as the old ones. (This works on only some systems.)
4734 A prefix arg makes KEEP-TIME non-nil.
4736 Optional arg PARENTS says whether to create parent directories if
4737 they don't exist. When called interactively, PARENTS is t.
4739 When NEWNAME is an existing directory, copy DIRECTORY into a
4740 subdirectory of NEWNAME if optional arg COPY-AS-SUBDIR is
4741 non-nil, otherwise copy the contents of DIRECTORY into NEWNAME.
4742 When called interactively, copy into a subdirectory by default."
4744 (let ((dir (read-directory-name
4745 "Copy directory: " default-directory default-directory t nil
)))
4748 (format "Copy directory %s to: " dir
)
4749 default-directory default-directory nil nil
)
4750 current-prefix-arg t t
)))
4751 ;; If default-directory is a remote directory, make sure we find its
4752 ;; copy-directory handler.
4753 (let ((handler (or (find-file-name-handler directory
'copy-directory
)
4754 (find-file-name-handler newname
'copy-directory
))))
4756 (funcall handler
'copy-directory directory newname keep-time parents
)
4758 ;; Compute target name.
4759 (setq directory
(directory-file-name (expand-file-name directory
))
4760 newname
(directory-file-name (expand-file-name newname
)))
4762 (unless (file-directory-p directory
)
4763 (error "%s is not a directory" directory
))
4766 ((not (file-directory-p newname
))
4767 ;; If NEWNAME is not an existing directory, create it;
4768 ;; that is where we will copy the files of DIRECTORY.
4769 (make-directory newname parents
))
4771 ;; If NEWNAME is an existing directory, and we are copying as
4772 ;; a subdirectory, the target is NEWNAME/[DIRECTORY-BASENAME].
4773 (setq newname
(expand-file-name
4774 (file-name-nondirectory
4775 (directory-file-name directory
))
4777 (and (file-exists-p newname
)
4778 (not (file-directory-p newname
))
4779 (error "Cannot overwrite non-directory %s with a directory"
4781 (make-directory newname t
)))
4783 ;; Copy recursively.
4785 ;; We do not want to copy "." and "..".
4786 (directory-files directory
'full
4787 directory-files-no-dot-files-regexp
))
4788 (let ((target (expand-file-name
4789 (file-name-nondirectory file
) newname
))
4790 (attrs (file-attributes file
)))
4791 (cond ((file-directory-p file
)
4792 (copy-directory file target keep-time parents nil
))
4793 ((stringp (car attrs
)) ; Symbolic link
4794 (make-symbolic-link (car attrs
) target t
))
4796 (copy-file file target t keep-time
)))))
4798 ;; Set directory attributes.
4799 (set-file-modes newname
(file-modes directory
))
4801 (set-file-times newname
(nth 5 (file-attributes directory
)))))))
4803 (put 'revert-buffer-function
'permanent-local t
)
4804 (defvar revert-buffer-function nil
4805 "Function to use to revert this buffer, or nil to do the default.
4806 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4807 which are the arguments that `revert-buffer' received.")
4809 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
4810 (defvar revert-buffer-insert-file-contents-function nil
4811 "Function to use to insert contents when reverting this buffer.
4812 Gets two args, first the nominal file name to use,
4813 and second, t if reading the auto-save file.
4815 The function you specify is responsible for updating (or preserving) point.")
4817 (defvar buffer-stale-function nil
4818 "Function to check whether a non-file buffer needs reverting.
4819 This should be a function with one optional argument NOCONFIRM.
4820 Auto Revert Mode passes t for NOCONFIRM. The function should return
4821 non-nil if the buffer should be reverted. A return value of
4822 `fast' means that the need for reverting was not checked, but
4823 that reverting the buffer is fast. The buffer is current when
4824 this function is called.
4826 The idea behind the NOCONFIRM argument is that it should be
4827 non-nil if the buffer is going to be reverted without asking the
4828 user. In such situations, one has to be careful with potentially
4829 time consuming operations.
4831 For more information on how this variable is used by Auto Revert mode,
4832 see Info node `(emacs)Supporting additional buffers'.")
4834 (defvar before-revert-hook nil
4835 "Normal hook for `revert-buffer' to run before reverting.
4836 If `revert-buffer-function' is used to override the normal revert
4837 mechanism, this hook is not used.")
4839 (defvar after-revert-hook nil
4840 "Normal hook for `revert-buffer' to run after reverting.
4841 Note that the hook value that it runs is the value that was in effect
4842 before reverting; that makes a difference if you have buffer-local
4845 If `revert-buffer-function' is used to override the normal revert
4846 mechanism, this hook is not used.")
4848 (defvar revert-buffer-internal-hook
)
4850 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
4851 "Replace current buffer text with the text of the visited file on disk.
4852 This undoes all changes since the file was visited or saved.
4853 With a prefix argument, offer to revert from latest auto-save file, if
4854 that is more recent than the visited file.
4856 This command also implements an interface for special buffers
4857 that contain text which doesn't come from a file, but reflects
4858 some other data instead (e.g. Dired buffers, `buffer-list'
4859 buffers). This is done via the variable `revert-buffer-function'.
4860 In these cases, it should reconstruct the buffer contents from the
4863 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4864 to revert from the auto-save file when this is nil. Note that the
4865 sense of this argument is the reverse of the prefix argument, for the
4866 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4869 Optional second argument NOCONFIRM means don't ask for confirmation
4870 at all. \(The variable `revert-without-query' offers another way to
4871 revert buffers without querying for confirmation.)
4873 Optional third argument PRESERVE-MODES non-nil means don't alter
4874 the files modes. Normally we reinitialize them using `normal-mode'.
4876 If the value of `revert-buffer-function' is non-nil, it is called to
4877 do all the work for this command. Otherwise, the hooks
4878 `before-revert-hook' and `after-revert-hook' are run at the beginning
4879 and the end, and if `revert-buffer-insert-file-contents-function' is
4880 non-nil, it is called instead of rereading visited file contents."
4882 ;; I admit it's odd to reverse the sense of the prefix argument, but
4883 ;; there is a lot of code out there which assumes that the first
4884 ;; argument should be t to avoid consulting the auto-save file, and
4885 ;; there's no straightforward way to encourage authors to notice a
4886 ;; reversal of the argument sense. So I'm just changing the user
4887 ;; interface, but leaving the programmatic interface the same.
4888 (interactive (list (not current-prefix-arg
)))
4889 (if revert-buffer-function
4890 (funcall revert-buffer-function ignore-auto noconfirm
)
4891 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4893 (let* ((auto-save-p (and (not ignore-auto
)
4894 (recent-auto-save-p)
4895 buffer-auto-save-file-name
4896 (file-readable-p buffer-auto-save-file-name
)
4898 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4899 (file-name (if auto-save-p
4900 buffer-auto-save-file-name
4902 (cond ((null file-name
)
4903 (error "Buffer does not seem to be associated with any file"))
4905 (and (not (buffer-modified-p))
4907 (dolist (regexp revert-without-query
)
4908 (when (string-match regexp file-name
)
4909 (throw 'found t
)))))
4910 (yes-or-no-p (format "Revert buffer from file %s? "
4912 (run-hooks 'before-revert-hook
)
4913 ;; If file was backed up but has changed since,
4914 ;; we should make another backup.
4915 (and (not auto-save-p
)
4916 (not (verify-visited-file-modtime (current-buffer)))
4917 (setq buffer-backed-up nil
))
4918 ;; Effectively copy the after-revert-hook status,
4919 ;; since after-find-file will clobber it.
4920 (let ((global-hook (default-value 'after-revert-hook
))
4921 (local-hook (when (local-variable-p 'after-revert-hook
)
4923 (inhibit-read-only t
))
4925 (revert-buffer-insert-file-contents-function
4926 (unless (eq buffer-undo-list t
)
4927 ;; Get rid of all undo records for this buffer.
4928 (setq buffer-undo-list nil
))
4929 ;; Don't make undo records for the reversion.
4930 (let ((buffer-undo-list t
))
4931 (funcall revert-buffer-insert-file-contents-function
4932 file-name auto-save-p
)))
4933 ((not (file-exists-p file-name
))
4934 (error (if buffer-file-number
4935 "File %s no longer exists!"
4936 "Cannot revert nonexistent file %s")
4938 ((not (file-readable-p file-name
))
4939 (error (if buffer-file-number
4940 "File %s no longer readable!"
4941 "Cannot revert unreadable file %s")
4944 ;; Bind buffer-file-name to nil
4945 ;; so that we don't try to lock the file.
4946 (let ((buffer-file-name nil
))
4950 (let ((coding-system-for-read
4951 ;; Auto-saved file should be read by Emacs'
4953 (if auto-save-p
'auto-save-coding
4954 (or coding-system-for-read
4956 buffer-file-coding-system-explicit
4957 (car buffer-file-coding-system-explicit
))))))
4958 (if (and (not enable-multibyte-characters
)
4959 coding-system-for-read
4960 (not (memq (coding-system-base
4961 coding-system-for-read
)
4962 '(no-conversion raw-text
))))
4963 ;; As a coding system suitable for multibyte
4964 ;; buffer is specified, make the current
4965 ;; buffer multibyte.
4966 (set-buffer-multibyte t
))
4968 ;; This force after-insert-file-set-coding
4969 ;; (called from insert-file-contents) to set
4970 ;; buffer-file-coding-system to a proper value.
4971 (kill-local-variable 'buffer-file-coding-system
)
4973 ;; Note that this preserves point in an intelligent way.
4975 (let ((buffer-file-format buffer-file-format
))
4976 (insert-file-contents file-name
(not auto-save-p
)
4978 (insert-file-contents file-name
(not auto-save-p
)
4980 ;; Recompute the truename in case changes in symlinks
4981 ;; have changed the truename.
4982 (setq buffer-file-truename
4983 (abbreviate-file-name (file-truename buffer-file-name
)))
4984 (after-find-file nil nil t t preserve-modes
)
4985 ;; Run after-revert-hook as it was before we reverted.
4986 (setq-default revert-buffer-internal-hook global-hook
)
4988 (set (make-local-variable 'revert-buffer-internal-hook
)
4990 (kill-local-variable 'revert-buffer-internal-hook
))
4991 (run-hooks 'revert-buffer-internal-hook
))
4994 (defun recover-this-file ()
4995 "Recover the visited file--get contents from its last auto-save file."
4997 (recover-file buffer-file-name
))
4999 (defun recover-file (file)
5000 "Visit file FILE, but get contents from its last auto-save file."
5001 ;; Actually putting the file name in the minibuffer should be used
5003 ;; Not just because users often use the default.
5004 (interactive "FRecover file: ")
5005 (setq file
(expand-file-name file
))
5006 (if (auto-save-file-name-p (file-name-nondirectory file
))
5007 (error "%s is an auto-save file" (abbreviate-file-name file
)))
5008 (let ((file-name (let ((buffer-file-name file
))
5009 (make-auto-save-file-name))))
5010 (cond ((if (file-exists-p file
)
5011 (not (file-newer-than-file-p file-name file
))
5012 (not (file-exists-p file-name
)))
5013 (error "Auto-save file %s not current"
5014 (abbreviate-file-name file-name
)))
5015 ((save-window-excursion
5016 (with-output-to-temp-buffer "*Directory*"
5017 (buffer-disable-undo standard-output
)
5019 (let ((switches dired-listing-switches
))
5020 (if (file-symlink-p file
)
5021 (setq switches
(concat switches
"L")))
5022 (set-buffer standard-output
)
5023 ;; Use insert-directory-safely, not insert-directory,
5024 ;; because these files might not exist. In particular,
5025 ;; FILE might not exist if the auto-save file was for
5026 ;; a buffer that didn't visit a file, such as "*mail*".
5027 ;; The code in v20.x called `ls' directly, so we need
5028 ;; to emulate what `ls' did in that case.
5029 (insert-directory-safely file switches
)
5030 (insert-directory-safely file-name switches
))))
5031 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
5032 (switch-to-buffer (find-file-noselect file t
))
5033 (let ((inhibit-read-only t
)
5034 ;; Keep the current buffer-file-coding-system.
5035 (coding-system buffer-file-coding-system
)
5036 ;; Auto-saved file should be read with special coding.
5037 (coding-system-for-read 'auto-save-coding
))
5039 (insert-file-contents file-name nil
)
5040 (set-buffer-file-coding-system coding-system
))
5041 (after-find-file nil nil t
))
5042 (t (error "Recover-file cancelled")))))
5044 (defun recover-session ()
5045 "Recover auto save files from a previous Emacs session.
5046 This command first displays a Dired buffer showing you the
5047 previous sessions that you could recover from.
5048 To choose one, move point to the proper line and then type C-c C-c.
5049 Then you'll be asked about a number of files to recover."
5051 (if (null auto-save-list-file-prefix
)
5052 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5053 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
5054 (unless (file-directory-p dir
)
5055 (make-directory dir t
))
5056 (unless (directory-files dir nil
5057 (concat "\\`" (regexp-quote
5058 (file-name-nondirectory
5059 auto-save-list-file-prefix
)))
5061 (error "No previous sessions to recover")))
5062 (let ((ls-lisp-support-shell-wildcards t
))
5063 (dired (concat auto-save-list-file-prefix
"*")
5064 (concat dired-listing-switches
"t")))
5066 (goto-char (point-min))
5067 (or (looking-at " Move to the session you want to recover,")
5068 (let ((inhibit-read-only t
))
5069 ;; Each line starts with a space
5070 ;; so that Font Lock mode won't highlight the first character.
5071 (insert " Move to the session you want to recover,\n"
5072 " then type C-c C-c to select it.\n\n"
5073 " You can also delete some of these files;\n"
5074 " type d on a line to mark that file for deletion.\n\n"))))
5075 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5076 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
5078 (defun recover-session-finish ()
5079 "Choose one saved session to recover auto-save files from.
5080 This command is used in the special Dired buffer created by
5081 \\[recover-session]."
5083 ;; Get the name of the session file to recover from.
5084 (let ((file (dired-get-filename))
5086 (buffer (get-buffer-create " *recover*")))
5088 (dired-do-flagged-delete t
)
5090 (with-current-buffer buffer
5091 ;; Read in the auto-save-list file.
5093 (insert-file-contents file
)
5094 ;; Loop thru the text of that file
5095 ;; and get out the names of the files to recover.
5097 (let (thisfile autofile
)
5099 ;; This is a pair of lines for a non-file-visiting buffer.
5100 ;; Get the auto-save file name and manufacture
5101 ;; a "visited file name" from that.
5104 ;; If there is no auto-save file name, the
5105 ;; auto-save-list file is probably corrupted.
5108 (buffer-substring-no-properties
5110 (line-end-position)))
5114 (file-name-nondirectory autofile
)
5116 (file-name-directory autofile
))))
5118 ;; This pair of lines is a file-visiting
5119 ;; buffer. Use the visited file name.
5122 (buffer-substring-no-properties
5123 (point) (progn (end-of-line) (point))))
5126 (buffer-substring-no-properties
5127 (point) (progn (end-of-line) (point))))
5129 ;; Ignore a file if its auto-save file does not exist now.
5130 (if (and autofile
(file-exists-p autofile
))
5131 (setq files
(cons thisfile files
)))))
5132 (setq files
(nreverse files
))
5133 ;; The file contains a pair of line for each auto-saved buffer.
5134 ;; The first line of the pair contains the visited file name
5135 ;; or is empty if the buffer was not visiting a file.
5136 ;; The second line is the auto-save file name.
5138 (map-y-or-n-p "Recover %s? "
5141 (save-excursion (recover-file file
))
5143 "Failed to recover `%s'" file
)))
5145 '("file" "files" "recover"))
5146 (message "No files can be recovered from this session now")))
5147 (kill-buffer buffer
))))
5149 (defun kill-buffer-ask (buffer)
5150 "Kill BUFFER if confirmed."
5152 (format "Buffer %s %s. Kill? " (buffer-name buffer
)
5153 (if (buffer-modified-p buffer
)
5154 "HAS BEEN EDITED" "is unmodified")))
5155 (kill-buffer buffer
)))
5157 (defun kill-some-buffers (&optional list
)
5158 "Kill some buffers. Asks the user whether to kill each one of them.
5159 Non-interactively, if optional argument LIST is non-nil, it
5160 specifies the list of buffers to kill, asking for approval for each one."
5163 (setq list
(buffer-list)))
5165 (let* ((buffer (car list
))
5166 (name (buffer-name buffer
)))
5167 (and name
; Can be nil for an indirect buffer
5168 ; if we killed the base buffer.
5169 (not (string-equal name
""))
5170 (/= (aref name
0) ?\s
)
5171 (kill-buffer-ask buffer
)))
5172 (setq list
(cdr list
))))
5174 (defun kill-matching-buffers (regexp &optional internal-too
)
5175 "Kill buffers whose name matches the specified REGEXP.
5176 The optional second argument indicates whether to kill internal buffers too."
5177 (interactive "sKill buffers matching this regular expression: \nP")
5178 (dolist (buffer (buffer-list))
5179 (let ((name (buffer-name buffer
)))
5180 (when (and name
(not (string-equal name
""))
5181 (or internal-too
(/= (aref name
0) ?\s
))
5182 (string-match regexp name
))
5183 (kill-buffer-ask buffer
)))))
5186 (defun auto-save-mode (arg)
5187 "Toggle auto-saving of contents of current buffer.
5188 With prefix argument ARG, turn auto-saving on if positive, else off."
5190 (setq buffer-auto-save-file-name
5192 (or (not buffer-auto-save-file-name
)
5193 ;; If auto-save is off because buffer has shrunk,
5194 ;; then toggling should turn it on.
5195 (< buffer-saved-size
0))
5196 (or (eq arg t
) (listp arg
) (and (integerp arg
) (> arg
0))))
5197 (if (and buffer-file-name auto-save-visited-file-name
5198 (not buffer-read-only
))
5200 (make-auto-save-file-name))))
5201 ;; If -1 was stored here, to temporarily turn off saving,
5203 (and (< buffer-saved-size
0)
5204 (setq buffer-saved-size
0))
5205 (if (called-interactively-p 'interactive
)
5206 (message "Auto-save %s (in this buffer)"
5207 (if buffer-auto-save-file-name
"on" "off")))
5208 buffer-auto-save-file-name
)
5210 (defun rename-auto-save-file ()
5211 "Adjust current buffer's auto save file name for current conditions.
5212 Also rename any existing auto save file, if it was made in this session."
5213 (let ((osave buffer-auto-save-file-name
))
5214 (setq buffer-auto-save-file-name
5215 (make-auto-save-file-name))
5216 (if (and osave buffer-auto-save-file-name
5217 (not (string= buffer-auto-save-file-name buffer-file-name
))
5218 (not (string= buffer-auto-save-file-name osave
))
5219 (file-exists-p osave
)
5220 (recent-auto-save-p))
5221 (rename-file osave buffer-auto-save-file-name t
))))
5223 (defun make-auto-save-file-name ()
5224 "Return file name to use for auto-saves of current buffer.
5225 Does not consider `auto-save-visited-file-name' as that variable is checked
5226 before calling this function. You can redefine this for customization.
5227 See also `auto-save-file-name-p'."
5228 (if buffer-file-name
5229 (let ((handler (find-file-name-handler buffer-file-name
5230 'make-auto-save-file-name
)))
5232 (funcall handler
'make-auto-save-file-name
)
5233 (let ((list auto-save-file-name-transforms
)
5234 (filename buffer-file-name
)
5236 ;; Apply user-specified translations
5237 ;; to the file name.
5238 (while (and list
(not result
))
5239 (if (string-match (car (car list
)) filename
)
5240 (setq result
(replace-match (cadr (car list
)) t nil
5242 uniq
(car (cddr (car list
)))))
5243 (setq list
(cdr list
)))
5246 (setq filename
(concat
5247 (file-name-directory result
)
5248 (subst-char-in-string
5250 (replace-regexp-in-string "!" "!!"
5252 (setq filename result
)))
5254 (if (and (eq system-type
'ms-dos
)
5255 (not (msdos-long-file-names)))
5256 ;; We truncate the file name to DOS 8+3 limits
5257 ;; before doing anything else, because the regexp
5258 ;; passed to string-match below cannot handle
5259 ;; extensions longer than 3 characters, multiple
5260 ;; dots, and other atrocities.
5261 (let ((fn (dos-8+3-filename
5262 (file-name-nondirectory buffer-file-name
))))
5264 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5266 (concat (file-name-directory buffer-file-name
)
5267 "#" (match-string 1 fn
)
5268 "." (match-string 3 fn
) "#"))
5269 (concat (file-name-directory filename
)
5271 (file-name-nondirectory filename
)
5273 ;; Make sure auto-save file names don't contain characters
5274 ;; invalid for the underlying filesystem.
5275 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5276 ;; Don't modify remote (ange-ftp) filenames
5277 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
5278 (convert-standard-filename result
)
5281 ;; Deal with buffers that don't have any associated files. (Mail
5282 ;; mode tends to create a good number of these.)
5284 (let ((buffer-name (buffer-name))
5287 ;; Restrict the characters used in the file name to those which
5288 ;; are known to be safe on all filesystems, url-encoding the
5290 ;; We do this on all platforms, because even if we are not
5291 ;; running on DOS/Windows, the current directory may be on a
5292 ;; mounted VFAT filesystem, such as a USB memory stick.
5293 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
5294 (let* ((character (aref buffer-name
(match-beginning 0)))
5296 ;; For multibyte characters, this will produce more than
5297 ;; 2 hex digits, so is not true URL encoding.
5298 (format "%%%02X" character
)))
5299 (setq buffer-name
(replace-match replacement t t buffer-name
))
5300 (setq limit
(1+ (match-end 0)))))
5301 ;; Generate the file name.
5306 (format "#%s#" buffer-name
)
5307 ;; Try a few alternative directories, to get one we can
5310 ((file-writable-p default-directory
) default-directory
)
5311 ((file-writable-p "/var/tmp/") "/var/tmp/")
5313 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5314 ;; Don't modify remote (ange-ftp) filenames
5315 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
5316 ;; The call to convert-standard-filename is in case
5317 ;; buffer-name includes characters not allowed by the
5318 ;; DOS/Windows filesystems. make-temp-file writes to the
5319 ;; file it creates, so we must fix the file name _before_
5320 ;; make-temp-file is called.
5321 (convert-standard-filename fname
)
5324 ;; make-temp-file creates the file,
5325 ;; but we don't want it to exist until we do an auto-save.
5327 (delete-file file-name
)
5331 (defun auto-save-file-name-p (filename)
5332 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5333 FILENAME should lack slashes. You can redefine this for customization."
5334 (string-match "^#.*#$" filename
))
5336 (defun wildcard-to-regexp (wildcard)
5337 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5338 The generated regexp will match a filename only if the filename
5339 matches that wildcard according to shell rules. Only wildcards known
5340 by `sh' are supported."
5341 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
5342 ;; Copy the initial run of non-special characters.
5343 (result (substring wildcard
0 i
))
5344 (len (length wildcard
)))
5345 ;; If no special characters, we're almost done.
5348 (let ((ch (aref wildcard i
))
5356 (eq (aref wildcard
(1+ i
)) ?\
]))
5358 ((eq ch ?\
[) ; [...] maps to regexp char class
5363 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
5366 (if (eq (aref wildcard i
) ?\
])
5371 ((eq (aref wildcard i
) ?^
)
5372 ;; Found "[^". Insert a `\0' character
5373 ;; (which cannot happen in a filename)
5374 ;; into the character class, so that `^'
5375 ;; is not the first character after `[',
5376 ;; and thus non-special in a regexp.
5380 ((eq (aref wildcard i
) ?\
])
5381 ;; I don't think `]' can appear in a
5382 ;; character class in a wildcard, but
5383 ;; let's be general here.
5388 (prog1 ; copy everything upto next `]'.
5391 (setq j
(string-match
5393 (setq i
(if j
(1- j
) (1- len
)))))))
5395 ((eq ch ?
*) "[^\000]*")
5399 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
5400 ((eq ch ??
) "[^\000]")
5401 (t (char-to-string ch
)))))
5403 ;; Shell wildcards should match the entire filename,
5404 ;; not its part. Make the regexp say so.
5405 (concat "\\`" result
"\\'")))
5407 (defcustom list-directory-brief-switches
5409 "Switches for `list-directory' to pass to `ls' for brief listing."
5413 (defcustom list-directory-verbose-switches
5415 "Switches for `list-directory' to pass to `ls' for verbose listing."
5419 (defun file-expand-wildcards (pattern &optional full
)
5420 "Expand wildcard pattern PATTERN.
5421 This returns a list of file names which match the pattern.
5423 If PATTERN is written as an absolute file name,
5424 the values are absolute also.
5426 If PATTERN is written as a relative file name, it is interpreted
5427 relative to the current default directory, `default-directory'.
5428 The file names returned are normally also relative to the current
5429 default directory. However, if FULL is non-nil, they are absolute."
5431 (let* ((nondir (file-name-nondirectory pattern
))
5432 (dirpart (file-name-directory pattern
))
5433 ;; A list of all dirs that DIRPART specifies.
5434 ;; This can be more than one dir
5435 ;; if DIRPART contains wildcards.
5436 (dirs (if (and dirpart
5437 (string-match "[[*?]"
5438 (or (file-remote-p dirpart
'localname
)
5440 (mapcar 'file-name-as-directory
5441 (file-expand-wildcards (directory-file-name dirpart
)))
5445 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
5446 (file-directory-p (directory-file-name (car dirs
))))
5447 (let ((this-dir-contents
5448 ;; Filter out "." and ".."
5450 (mapcar #'(lambda (name)
5451 (unless (string-match "\\`\\.\\.?\\'"
5452 (file-name-nondirectory name
))
5454 (directory-files (or (car dirs
) ".") full
5455 (wildcard-to-regexp nondir
))))))
5458 (if (and (car dirs
) (not full
))
5459 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
5463 (setq dirs
(cdr dirs
)))
5466 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5467 (provide 'files
'(remote-wildcards))
5469 (defun list-directory (dirname &optional verbose
)
5470 "Display a list of files in or matching DIRNAME, a la `ls'.
5471 DIRNAME is globbed by the shell if necessary.
5472 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5473 Actions controlled by variables `list-directory-brief-switches'
5474 and `list-directory-verbose-switches'."
5475 (interactive (let ((pfx current-prefix-arg
))
5476 (list (read-file-name (if pfx
"List directory (verbose): "
5477 "List directory (brief): ")
5478 nil default-directory nil
)
5480 (let ((switches (if verbose list-directory-verbose-switches
5481 list-directory-brief-switches
))
5483 (or dirname
(setq dirname default-directory
))
5484 (setq dirname
(expand-file-name dirname
))
5485 (with-output-to-temp-buffer "*Directory*"
5486 (setq buffer standard-output
)
5487 (buffer-disable-undo standard-output
)
5488 (princ "Directory ")
5491 (with-current-buffer "*Directory*"
5492 (let ((wildcard (not (file-directory-p dirname
))))
5493 (insert-directory dirname switches wildcard
(not wildcard
)))))
5494 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5495 (with-current-buffer buffer
5496 (setq default-directory
5497 (if (file-directory-p dirname
)
5498 (file-name-as-directory dirname
)
5499 (file-name-directory dirname
))))))
5501 (defun shell-quote-wildcard-pattern (pattern)
5502 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5504 PATTERN is assumed to represent a file-name wildcard suitable for the
5505 underlying filesystem. For Unix and GNU/Linux, each character from the
5506 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5507 the parts of the pattern which don't include wildcard characters are
5508 quoted with double quotes.
5510 This function leaves alone existing quote characters (\\ on Unix and \"
5511 on Windows), so PATTERN can use them to quote wildcard characters that
5512 need to be passed verbatim to shell commands."
5515 ((memq system-type
'(ms-dos windows-nt cygwin
))
5516 ;; DOS/Windows don't allow `"' in file names. So if the
5517 ;; argument has quotes, we can safely assume it is already
5518 ;; quoted by the caller.
5519 (if (or (string-match "[\"]" pattern
)
5520 ;; We quote [&()#$'] in case their shell is a port of a
5521 ;; Unixy shell. We quote [,=+] because stock DOS and
5522 ;; Windows shells require that in some cases, such as
5523 ;; passing arguments to batch files that use positional
5524 ;; arguments like %1.
5525 (not (string-match "[ \t;&()#$',=+]" pattern
)))
5530 (while (string-match "[*?]+" pattern beg
)
5531 (setq end
(match-beginning 0)
5532 result
(concat result
(substring pattern beg end
)
5534 (substring pattern end
(match-end 0))
5537 (concat result
(substring pattern beg
) "\""))))
5540 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
5542 (concat (substring pattern
0 (match-beginning 0))
5544 (substring pattern
(match-beginning 0)))
5545 beg
(1+ (match-end 0)))))
5549 (defvar insert-directory-program
(purecopy "ls")
5550 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5552 (defcustom directory-free-space-program
(purecopy "df")
5553 "Program to get the amount of free space on a file system.
5554 We assume the output has the format of `df'.
5555 The value of this variable must be just a command name or file name;
5556 if you want to specify options, use `directory-free-space-args'.
5558 A value of nil disables this feature.
5560 If the function `file-system-info' is defined, it is always used in
5561 preference to the program given by this variable."
5562 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
5565 (defcustom directory-free-space-args
5566 (purecopy (if (eq system-type
'darwin
) "-k" "-Pk"))
5567 "Options to use when running `directory-free-space-program'."
5571 (defun get-free-disk-space (dir)
5572 "Return the amount of free space on directory DIR's file system.
5573 The result is a string that gives the number of free 1KB blocks,
5574 or nil if the system call or the program which retrieve the information
5575 fail. It returns also nil when DIR is a remote directory.
5577 This function calls `file-system-info' if it is available, or invokes the
5578 program specified by `directory-free-space-program' if that is non-nil."
5579 (unless (file-remote-p dir
)
5580 ;; Try to find the number of free blocks. Non-Posix systems don't
5581 ;; always have df, but might have an equivalent system call.
5582 (if (fboundp 'file-system-info
)
5583 (let ((fsinfo (file-system-info dir
)))
5585 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
5586 (setq dir
(expand-file-name dir
))
5589 (when (and directory-free-space-program
5590 ;; Avoid failure if the default directory does
5591 ;; not exist (Bug#2631, Bug#3911).
5592 (let ((default-directory "/"))
5593 (eq (call-process directory-free-space-program
5595 directory-free-space-args
5598 ;; Usual format is a header line followed by a line of
5600 (goto-char (point-min))
5604 ;; Move to the end of the "available blocks" number.
5605 (skip-chars-forward "^ \t")
5607 ;; Copy it into AVAILABLE.
5608 (let ((end (point)))
5610 (buffer-substring (point) end
))))))))))
5612 ;; The following expression replaces `dired-move-to-filename-regexp'.
5613 (defvar directory-listing-before-filename-regexp
5614 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5615 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5616 ;; In some locales, month abbreviations are as short as 2 letters,
5617 ;; and they can be followed by ".".
5618 ;; In Breton, a month name can include a quote character.
5619 (month (concat l-or-quote l-or-quote
"+\\.?"))
5621 (yyyy "[0-9][0-9][0-9][0-9]")
5623 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5624 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5625 (zone "[-+][0-2][0-9][0-5][0-9]")
5626 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5627 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5628 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5629 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5630 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5632 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5633 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5634 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5635 ;; omits the Kanji characters after month and day-of-month.
5636 ;; On Mac OS X 10.3, the date format in East Asian locales is
5637 ;; day-of-month digits followed by month digits.
5640 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5641 "\\|" dd s mm s
"+" "\\)"
5642 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5643 ;; The "[0-9]" below requires the previous column to end in a digit.
5644 ;; This avoids recognizing `1 may 1997' as a date in the line:
5645 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5647 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5649 ;; For non-iso date formats, we add the ".*" in order to find
5650 ;; the last possible match. This avoids recognizing
5651 ;; `jservice 10 1024' as a date in the line:
5652 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5654 ;; vc dired listings provide the state or blanks between file
5655 ;; permissions and date. The state is always surrounded by
5657 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5658 ;; This is not supported yet.
5659 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5660 "\\|.*[0-9][BkKMGTPEZY]? "
5661 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\)"
5663 "Regular expression to match up to the file name in a directory listing.
5664 The default value is designed to recognize dates and times
5665 regardless of the language.")
5667 (defvar insert-directory-ls-version
'unknown
)
5670 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5671 ;; FULL-DIRECTORY-P is nil.
5672 ;; The single line of output must display FILE's name as it was
5673 ;; given, namely, an absolute path name.
5674 ;; - must insert exactly one line for each file if WILDCARD or
5675 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5676 ;; before the file lines, plus optional text after the file lines.
5677 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5679 ;; File lines should display the basename.
5680 ;; - must be consistent with
5681 ;; - functions dired-move-to-filename, (these two define what a file line is)
5682 ;; dired-move-to-end-of-filename,
5683 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5684 ;; dired-insert-headerline
5685 ;; dired-after-subdir-garbage (defines what a "total" line is)
5686 ;; - variable dired-subdir-regexp
5687 ;; - may be passed "--dired" as the first argument in SWITCHES.
5688 ;; Filename handlers might have to remove this switch if their
5689 ;; "ls" command does not support it.
5690 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
5691 "Insert directory listing for FILE, formatted according to SWITCHES.
5692 Leaves point after the inserted text.
5693 SWITCHES may be a string of options, or a list of strings
5694 representing individual options.
5695 Optional third arg WILDCARD means treat FILE as shell wildcard.
5696 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5697 switches do not contain `d', so that a full listing is expected.
5699 This works by running a directory listing program
5700 whose name is in the variable `insert-directory-program'.
5701 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5703 When SWITCHES contains the long `--dired' option, this function
5704 treats it specially, for the sake of dired. However, the
5705 normally equivalent short `-D' option is just passed on to
5706 `insert-directory-program', as any other option."
5707 ;; We need the directory in order to find the right handler.
5708 (let ((handler (find-file-name-handler (expand-file-name file
)
5709 'insert-directory
)))
5711 (funcall handler
'insert-directory file switches
5712 wildcard full-directory-p
)
5713 (let (result (beg (point)))
5715 ;; Read the actual directory using `insert-directory-program'.
5716 ;; RESULT gets the status code.
5717 (let* (;; We at first read by no-conversion, then after
5718 ;; putting text property `dired-filename, decode one
5719 ;; bunch by one to preserve that property.
5720 (coding-system-for-read 'no-conversion
)
5721 ;; This is to control encoding the arguments in call-process.
5722 (coding-system-for-write
5723 (and enable-multibyte-characters
5724 (or file-name-coding-system
5725 default-file-name-coding-system
))))
5728 ;; Run ls in the directory part of the file pattern
5729 ;; using the last component as argument.
5730 (let ((default-directory
5731 (if (file-name-absolute-p file
)
5732 (file-name-directory file
)
5733 (file-name-directory (expand-file-name file
))))
5734 (pattern (file-name-nondirectory file
)))
5736 shell-file-name nil t nil
5738 (concat (if (memq system-type
'(ms-dos windows-nt
))
5740 "\\") ; Disregard Unix shell aliases!
5741 insert-directory-program
5743 (if (stringp switches
)
5745 (mapconcat 'identity switches
" "))
5747 ;; Quote some characters that have
5748 ;; special meanings in shells; but
5749 ;; don't quote the wildcards--we want
5750 ;; them to be special. We also
5751 ;; currently don't quote the quoting
5752 ;; characters in case people want to
5753 ;; use them explicitly to quote
5754 ;; wildcard characters.
5755 (shell-quote-wildcard-pattern pattern
))))
5756 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5757 ;; directory if FILE is a symbolic link.
5758 (unless full-directory-p
5760 (if (stringp switches
)
5761 (concat switches
" -d")
5762 (add-to-list 'switches
"-d" 'append
))))
5763 (apply 'call-process
5764 insert-directory-program nil t nil
5766 (if (listp switches
) switches
5767 (unless (equal switches
"")
5768 ;; Split the switches at any spaces so we can
5769 ;; pass separate options as separate args.
5770 (split-string switches
)))
5771 ;; Avoid lossage if FILE starts with `-'.
5774 (if (string-match "\\`~" file
)
5775 (setq file
(expand-file-name file
)))
5777 (if full-directory-p
5778 (concat (file-name-as-directory file
) ".")
5781 ;; If we got "//DIRED//" in the output, it means we got a real
5782 ;; directory listing, even if `ls' returned nonzero.
5783 ;; So ignore any errors.
5784 (when (if (stringp switches
)
5785 (string-match "--dired\\>" switches
)
5786 (member "--dired" switches
))
5789 (when (looking-at "//SUBDIRED//")
5791 (if (looking-at "//DIRED//")
5794 (when (and (not (eq 0 result
))
5795 (eq insert-directory-ls-version
'unknown
))
5796 ;; The first time ls returns an error,
5797 ;; find the version numbers of ls,
5798 ;; and set insert-directory-ls-version
5799 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5800 ;; is equal or if the info cannot be obtained.
5801 ;; (That can mean it isn't GNU ls.)
5804 (call-process "ls" nil t nil
"--version")
5806 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
5807 (let* ((version (match-string 1 version-out
))
5808 (split (split-string version
"[.]"))
5809 (numbers (mapcar 'string-to-number split
))
5812 (while (and (not comparison
) (or numbers min
))
5814 (setq comparison
'>))
5816 (setq comparison
'<))
5817 ((> (car numbers
) (car min
))
5818 (setq comparison
'>))
5819 ((< (car numbers
) (car min
))
5820 (setq comparison
'<))
5822 (setq numbers
(cdr numbers
)
5824 (setq insert-directory-ls-version
(or comparison
'=)))
5825 (setq insert-directory-ls-version nil
))))
5827 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5828 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
5831 ;; If `insert-directory-program' failed, signal an error.
5832 (unless (eq 0 result
)
5833 ;; Delete the error message it may have output.
5834 (delete-region beg
(point))
5835 ;; On non-Posix systems, we cannot open a directory, so
5836 ;; don't even try, because that will always result in
5837 ;; the ubiquitous "Access denied". Instead, show the
5838 ;; command line so the user can try to guess what went wrong.
5839 (if (and (file-directory-p file
)
5840 (memq system-type
'(ms-dos windows-nt
)))
5842 "Reading directory: \"%s %s -- %s\" exited with status %s"
5843 insert-directory-program
5844 (if (listp switches
) (concat switches
) switches
)
5846 ;; Unix. Access the file to get a suitable error.
5847 (access-file file
"Reading directory")
5848 (error "Listing directory failed but `access-file' worked")))
5850 (when (if (stringp switches
)
5851 (string-match "--dired\\>" switches
)
5852 (member "--dired" switches
))
5853 ;; The following overshoots by one line for an empty
5854 ;; directory listed with "--dired", but without "-a"
5855 ;; switch, where the ls output contains a
5856 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5857 ;; We take care of that case later.
5859 (when (looking-at "//SUBDIRED//")
5860 (delete-region (point) (progn (forward-line 1) (point)))
5862 (if (looking-at "//DIRED//")
5863 (let ((end (line-end-position))
5866 ;; Find all the lines that are error messages,
5867 ;; and record the bounds of each one.
5869 (while (< (point) linebeg
)
5870 (or (eql (following-char) ?\s
)
5871 (push (list (point) (line-end-position)) error-lines
))
5873 (setq error-lines
(nreverse error-lines
))
5874 ;; Now read the numeric positions of file names.
5878 (while (< (point) end
)
5879 (let ((start (insert-directory-adj-pos
5880 (+ beg
(read (current-buffer)))
5882 (end (insert-directory-adj-pos
5883 (+ beg
(read (current-buffer)))
5885 (if (memq (char-after end
) '(?
\n ?\s
))
5886 ;; End is followed by \n or by " -> ".
5887 (put-text-property start end
'dired-filename t
)
5888 ;; It seems that we can't trust ls's output as to
5889 ;; byte positions of filenames.
5890 (put-text-property beg
(point) 'dired-filename nil
)
5894 (delete-region (point) (progn (forward-line 1) (point))))
5895 ;; Take care of the case where the ls output contains a
5896 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5897 ;; and we went one line too far back (see above).
5899 (if (looking-at "//DIRED-OPTIONS//")
5900 (delete-region (point) (progn (forward-line 1) (point)))))
5902 ;; Now decode what read if necessary.
5903 (let ((coding (or coding-system-for-read
5904 file-name-coding-system
5905 default-file-name-coding-system
5909 (when (and enable-multibyte-characters
5910 (not (memq (coding-system-base coding
)
5911 '(raw-text no-conversion
))))
5912 ;; If no coding system is specified or detection is
5913 ;; requested, detect the coding.
5914 (if (eq (coding-system-base coding
) 'undecided
)
5915 (setq coding
(detect-coding-region beg
(point) t
)))
5916 (if (not (eq (coding-system-base coding
) 'undecided
))
5919 (coding-system-change-eol-conversion coding
'unix
))
5920 (narrow-to-region beg
(point))
5921 (goto-char (point-min))
5924 val
(get-text-property (point) 'dired-filename
))
5925 (goto-char (next-single-property-change
5926 (point) 'dired-filename nil
(point-max)))
5927 ;; Force no eol conversion on a file name, so
5928 ;; that CR is preserved.
5929 (decode-coding-region pos
(point)
5930 (if val coding-no-eol coding
))
5932 (put-text-property pos
(point)
5933 'dired-filename t
)))))))
5935 (if full-directory-p
5936 ;; Try to insert the amount of free space.
5939 ;; First find the line to put it on.
5940 (when (re-search-forward "^ *\\(total\\)" nil t
)
5941 (let ((available (get-free-disk-space ".")))
5943 ;; Replace "total" with "used", to avoid confusion.
5944 (replace-match "total used in directory" nil nil nil
1)
5946 (insert " available " available
))))))))))
5948 (defun insert-directory-adj-pos (pos error-lines
)
5949 "Convert `ls --dired' file name position value POS to a buffer position.
5950 File name position values returned in ls --dired output
5951 count only stdout; they don't count the error messages sent to stderr.
5952 So this function converts to them to real buffer positions.
5953 ERROR-LINES is a list of buffer positions of error message lines,
5954 of the form (START END)."
5955 (while (and error-lines
(< (caar error-lines
) pos
))
5956 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
5960 (defun insert-directory-safely (file switches
5961 &optional wildcard full-directory-p
)
5962 "Insert directory listing for FILE, formatted according to SWITCHES.
5964 Like `insert-directory', but if FILE does not exist, it inserts a
5965 message to that effect instead of signaling an error."
5966 (if (file-exists-p file
)
5967 (insert-directory file switches wildcard full-directory-p
)
5968 ;; Simulate the message printed by `ls'.
5969 (insert (format "%s: No such file or directory\n" file
))))
5971 (defvar kill-emacs-query-functions nil
5972 "Functions to call with no arguments to query about killing Emacs.
5973 If any of these functions returns nil, killing Emacs is cancelled.
5974 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5975 the low level primitive, does not. See also `kill-emacs-hook'.")
5977 (defcustom confirm-kill-emacs nil
5978 "How to ask for confirmation when leaving Emacs.
5979 If nil, the default, don't ask at all. If the value is non-nil, it should
5980 be a predicate function such as `yes-or-no-p'."
5981 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
5982 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
5983 (const :tag
"Don't confirm" nil
))
5987 (defun save-buffers-kill-emacs (&optional arg
)
5988 "Offer to save each buffer, then kill this Emacs process.
5989 With prefix ARG, silently save all file-visiting buffers, then kill."
5991 (save-some-buffers arg t
)
5992 (and (or (not (memq t
(mapcar (function
5993 (lambda (buf) (and (buffer-file-name buf
)
5994 (buffer-modified-p buf
))))
5996 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5997 (or (not (fboundp 'process-list
))
5998 ;; process-list is not defined on MSDOS.
5999 (let ((processes (process-list))
6002 (and (memq (process-status (car processes
)) '(run stop open listen
))
6003 (process-query-on-exit-flag (car processes
))
6005 (setq processes
(cdr processes
)))
6008 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
6009 ;; Query the user for other things, perhaps.
6010 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
6011 (or (null confirm-kill-emacs
)
6012 (funcall confirm-kill-emacs
"Really exit Emacs? "))
6015 (defun save-buffers-kill-terminal (&optional arg
)
6016 "Offer to save each buffer, then kill the current connection.
6017 If the current frame has no client, kill Emacs itself.
6019 With prefix ARG, silently save all file-visiting buffers, then kill.
6021 If emacsclient was started with a list of filenames to edit, then
6022 only these files will be asked to be saved."
6024 (if (frame-parameter (selected-frame) 'client
)
6025 (server-save-buffers-kill-terminal arg
)
6026 (save-buffers-kill-emacs arg
)))
6028 ;; We use /: as a prefix to "quote" a file name
6029 ;; so that magic file name handlers will not apply to it.
6031 (setq file-name-handler-alist
6032 (cons (cons (purecopy "\\`/:") 'file-name-non-special
)
6033 file-name-handler-alist
))
6035 ;; We depend on being the last handler on the list,
6036 ;; so that anything else which does need handling
6037 ;; has been handled already.
6038 ;; So it is safe for us to inhibit *all* magic file name handlers.
6040 (defun file-name-non-special (operation &rest arguments
)
6041 (let ((file-name-handler-alist nil
)
6043 (if (eq operation
'insert-directory
)
6044 (directory-file-name
6046 (unhandled-file-name-directory default-directory
)))
6048 ;; Get a list of the indices of the args which are file names.
6050 (cdr (or (assq operation
6051 ;; The first six are special because they
6052 ;; return a file name. We want to include the /:
6053 ;; in the return value.
6054 ;; So just avoid stripping it in the first place.
6055 '((expand-file-name . nil
)
6056 (file-name-directory . nil
)
6057 (file-name-as-directory . nil
)
6058 (directory-file-name . nil
)
6059 (file-name-sans-versions . nil
)
6060 (find-backup-file-name . nil
)
6061 ;; `identity' means just return the first arg
6062 ;; not stripped of its quoting.
6063 (substitute-in-file-name identity
)
6064 ;; `add' means add "/:" to the result.
6065 (file-truename add
0)
6066 (insert-file-contents insert-file-contents
0)
6067 ;; `unquote-then-quote' means set buffer-file-name
6068 ;; temporarily to unquoted filename.
6069 (verify-visited-file-modtime unquote-then-quote
)
6070 ;; List the arguments which are filenames.
6071 (file-name-completion 1)
6072 (file-name-all-completions 1)
6076 (make-symbolic-link 0 1)
6077 (add-name-to-file 0 1)))
6078 ;; For all other operations, treat the first argument only
6079 ;; as the file name.
6082 ;; Copy ARGUMENTS so we can replace elements in it.
6083 (arguments (copy-sequence arguments
)))
6084 (if (symbolp (car file-arg-indices
))
6085 (setq method
(pop file-arg-indices
)))
6086 ;; Strip off the /: from the file names that have it.
6088 (while (consp file-arg-indices
)
6089 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
6091 (string-match "\\`/:" (car pair
))
6093 (if (= (length (car pair
)) 2)
6095 (substring (car pair
) 2)))))
6096 (setq file-arg-indices
(cdr file-arg-indices
))))
6098 (identity (car arguments
))
6099 (add (concat "/:" (apply operation arguments
)))
6100 (insert-file-contents
6101 (let ((visit (nth 1 arguments
)))
6103 (apply operation arguments
)
6104 (when (and visit buffer-file-name
)
6105 (setq buffer-file-name
(concat "/:" buffer-file-name
))))))
6107 (let ((buffer-file-name (substring buffer-file-name
2)))
6108 (apply operation arguments
)))
6110 (apply operation arguments
)))))
6112 ;; Symbolic modes and read-file-modes.
6114 (defun file-modes-char-to-who (char)
6115 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6116 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6117 Others, or All) for whom to produce the mask.
6118 The bit-mask that is returned extracts from mode bits the access rights
6119 for the specified category of users."
6120 (cond ((= char ?u
) #o4700
)
6121 ((= char ?g
) #o2070
)
6122 ((= char ?o
) #o1007
)
6123 ((= char ?a
) #o7777
)
6124 (t (error "%c: bad `who' character" char
))))
6126 (defun file-modes-char-to-right (char &optional from
)
6127 "Convert CHAR to a numeric value of mode bits.
6128 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6129 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6130 (or from
(setq from
0))
6131 (cond ((= char ?r
) #o0444
)
6132 ((= char ?w
) #o0222
)
6133 ((= char ?x
) #o0111
)
6134 ((= char ?s
) #o1000
)
6135 ((= char ?t
) #o6000
)
6136 ;; Rights relative to the previous file modes.
6137 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
6138 ((= char ?u
) (let ((uright (logand #o4700 from
)))
6139 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
6140 ((= char ?g
) (let ((gright (logand #o2070 from
)))
6141 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
6142 ((= char ?o
) (let ((oright (logand #o1007 from
)))
6143 (+ oright
(* oright
#o10
) (* oright
#o100
))))
6144 (t (error "%c: bad right character" char
))))
6146 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
6147 "Convert a symbolic mode string specification to an equivalent number.
6148 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6149 WHO-MASK is the bit-mask specifying the category of users to which to
6150 apply the access permissions. See `file-modes-char-to-who'.
6151 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6152 RIGHTS request to add, remove, or set permissions based on existing ones,
6154 (let* ((num-rights (or from
0))
6155 (list-rights (string-to-list rights
))
6156 (op (pop list-rights
)))
6157 (while (memq op
'(?
+ ?- ?
=))
6160 (while (memq (setq char-right
(pop list-rights
))
6161 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
6164 (file-modes-char-to-right char-right num-rights
))))
6165 (setq num-right
(logand who-mask num-right
)
6167 (cond ((= op ?
+) (logior num-rights num-right
))
6168 ((= op ?-
) (logand num-rights
(lognot num-right
)))
6169 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
6173 (defun file-modes-symbolic-to-number (modes &optional from
)
6174 "Convert symbolic file modes to numeric file modes.
6175 MODES is the string to convert, it should match
6176 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6177 See (info \"(coreutils)File permissions\") for more information on this
6179 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6180 MODES request to add, remove, or set permissions based on existing ones,
6183 (let ((case-fold-search nil
)
6184 (num-modes (or from
0)))
6185 (while (/= (string-to-char modes
) 0)
6186 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes
)
6187 (let ((num-who (apply 'logior
0
6188 (mapcar 'file-modes-char-to-who
6189 (match-string 1 modes
)))))
6191 (setq num-who
(default-file-modes)))
6193 (file-modes-rights-to-number (substring modes
(match-end 1))
6195 modes
(substring modes
(match-end 3))))
6196 (error "Parse error in modes near `%s'" (substring modes
0))))
6199 (defun read-file-modes (&optional prompt orig-file
)
6200 "Read file modes in octal or symbolic notation and return its numeric value.
6201 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6202 ORIG-FILE is the name of a file on whose mode bits to base returned
6203 permissions if what user types requests to add, remove, or set permissions
6204 based on existing mode bits, as in \"og+rX-w\"."
6205 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
6206 (error "File not found")))
6207 (modestr (and (stringp orig-file
)
6208 (nth 8 (file-attributes orig-file
))))
6210 (and (stringp modestr
)
6211 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
6212 (replace-regexp-in-string
6214 (format "u=%s,g=%s,o=%s"
6215 (match-string 1 modestr
)
6216 (match-string 2 modestr
)
6217 (match-string 3 modestr
)))))
6218 (value (read-string (or prompt
"File modes (octal or symbolic): ")
6221 (if (string-match "^[0-7]+" value
)
6222 (string-to-number value
8)
6223 (file-modes-symbolic-to-number value modes
)))))
6226 ;; Trashcan handling.
6227 (defcustom trash-directory nil
6228 "Directory for `move-file-to-trash' to move files and directories to.
6229 This directory is only used when the function `system-move-file-to-trash'
6231 Relative paths are interpreted relative to `default-directory'.
6232 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6233 :type
'(choice (const nil
) directory
)
6237 (defvar trash--hexify-table
)
6239 (declare-function system-move-file-to-trash
"w32fns.c" (filename))
6241 (defun move-file-to-trash (filename)
6242 "Move the file (or directory) named FILENAME to the trash.
6243 When `delete-by-moving-to-trash' is non-nil, this function is
6244 called by `delete-file' and `delete-directory' instead of
6245 deleting files outright.
6247 If the function `system-move-file-to-trash' is defined, call it
6248 with FILENAME as an argument.
6249 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6251 Otherwise, trash FILENAME using the freedesktop.org conventions,
6252 like the GNOME, KDE and XFCE desktop environments. Emacs only
6253 moves files to \"home trash\", ignoring per-volume trashcans."
6254 (interactive "fMove file to trash: ")
6255 (cond (trash-directory
6256 ;; If `trash-directory' is non-nil, move the file there.
6257 (let* ((trash-dir (expand-file-name trash-directory
))
6258 (fn (directory-file-name (expand-file-name filename
)))
6259 (new-fn (expand-file-name (file-name-nondirectory fn
)
6261 ;; We can't trash a parent directory of trash-directory.
6262 (if (string-match fn trash-dir
)
6263 (error "Trash directory `%s' is a subdirectory of `%s'"
6264 trash-dir filename
))
6265 (unless (file-directory-p trash-dir
)
6266 (make-directory trash-dir t
))
6267 ;; Ensure that the trashed file-name is unique.
6268 (if (file-exists-p new-fn
)
6269 (let ((version-control t
)
6270 (backup-directory-alist nil
))
6271 (setq new-fn
(car (find-backup-file-name new-fn
)))))
6272 (let (delete-by-moving-to-trash)
6273 (rename-file fn new-fn
))))
6274 ;; If `system-move-file-to-trash' is defined, use it.
6275 ((fboundp 'system-move-file-to-trash
)
6276 (system-move-file-to-trash filename
))
6277 ;; Otherwise, use the freedesktop.org method, as specified at
6278 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6280 (let* ((xdg-data-dir
6281 (directory-file-name
6282 (expand-file-name "Trash"
6283 (or (getenv "XDG_DATA_HOME")
6284 "~/.local/share"))))
6285 (trash-files-dir (expand-file-name "files" xdg-data-dir
))
6286 (trash-info-dir (expand-file-name "info" xdg-data-dir
))
6287 (fn (directory-file-name (expand-file-name filename
))))
6289 ;; Check if we have permissions to delete.
6290 (unless (file-writable-p (directory-file-name
6291 (file-name-directory fn
)))
6292 (error "Cannot move %s to trash: Permission denied" filename
))
6293 ;; The trashed file cannot be the trash dir or its parent.
6294 (if (string-match fn trash-files-dir
)
6295 (error "The trash directory %s is a subdirectory of %s"
6296 trash-files-dir filename
))
6297 (if (string-match fn trash-info-dir
)
6298 (error "The trash directory %s is a subdirectory of %s"
6299 trash-info-dir filename
))
6301 ;; Ensure that the trash directory exists; otherwise, create it.
6302 (let ((saved-default-file-modes (default-file-modes)))
6303 (set-default-file-modes ?
\700)
6304 (unless (file-exists-p trash-files-dir
)
6305 (make-directory trash-files-dir t
))
6306 (unless (file-exists-p trash-info-dir
)
6307 (make-directory trash-info-dir t
))
6308 (set-default-file-modes saved-default-file-modes
))
6310 ;; Try to move to trash with .trashinfo undo information
6313 (set-buffer-file-coding-system 'utf-8-unix
)
6314 (insert "[Trash Info]\nPath=")
6315 ;; Perform url-encoding on FN. For compatibility with
6316 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6317 ;; for path separators.
6318 (unless (boundp 'trash--hexify-table
)
6319 (setq trash--hexify-table
(make-vector 256 nil
))
6320 (let ((unreserved-chars
6321 (list ?
/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6322 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6323 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6324 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?
0 ?
1 ?
2
6325 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9 ?- ?_ ?. ?
! ?~ ?
* ?
'
6328 (aset trash--hexify-table byte
6329 (if (memq byte unreserved-chars
)
6330 (char-to-string byte
)
6331 (format "%%%02x" byte
))))))
6332 (mapc (lambda (byte)
6333 (insert (aref trash--hexify-table byte
)))
6334 (if (multibyte-string-p fn
)
6335 (encode-coding-string fn
'utf-8
)
6337 (insert "\nDeletionDate="
6338 (format-time-string "%Y-%m-%dT%T")
6341 ;; Attempt to make .trashinfo file, trying up to 5
6342 ;; times. The .trashinfo file is opened with O_EXCL,
6343 ;; as per trash-spec 0.7, even if that can be a problem
6344 ;; on old NFS versions...
6346 (base-fn (expand-file-name
6347 (file-name-nondirectory fn
)
6352 (setq info-fn
(expand-file-name
6353 (concat (file-name-nondirectory new-fn
)
6356 (unless (condition-case nil
6358 (write-region nil nil info-fn nil
6359 'quiet info-fn
'excl
)
6360 (setq tries
0 success t
))
6361 (file-already-exists nil
))
6362 (setq tries
(1- tries
))
6363 ;; Uniqify new-fn. (Some file managers do not
6364 ;; like Emacs-style backup file names---e.g. bug
6365 ;; 170956 in Konqueror bug tracker.)
6366 (setq new-fn
(make-temp-name (concat base-fn
"_")))))
6368 (error "Cannot move %s to trash: Lock failed" filename
))
6370 ;; Finally, try to move the file to the trashcan.
6371 (let ((delete-by-moving-to-trash nil
))
6372 (rename-file fn new-fn
)))))))))
6375 (define-key ctl-x-map
"\C-f" 'find-file
)
6376 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
6377 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
6378 (define-key ctl-x-map
"\C-s" 'save-buffer
)
6379 (define-key ctl-x-map
"s" 'save-some-buffers
)
6380 (define-key ctl-x-map
"\C-w" 'write-file
)
6381 (define-key ctl-x-map
"i" 'insert-file
)
6382 (define-key esc-map
"~" 'not-modified
)
6383 (define-key ctl-x-map
"\C-d" 'list-directory
)
6384 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
6385 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
6387 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
6388 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
6389 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
6390 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
6391 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
6393 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
6394 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
6395 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
6396 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
6397 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
6399 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
6400 ;;; files.el ends here