1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2012 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Defines most of Emacs'ss file- and directory-handling functions,
26 ;; including basic file visiting, backup generation, link handling,
27 ;; ITS-id version control, load- and write-hook handling, and the like.
31 (defvar font-lock-keywords
)
34 "Backups of edited data files."
37 (defgroup find-file nil
42 (defcustom delete-auto-save-files t
43 "Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that the auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
50 (defcustom directory-abbrev-alist
52 "Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
57 FROM is matched against directory names anchored at the first
58 character, so it should start with a \"\\\\`\", or, if directory
59 names cannot have embedded newlines, with a \"^\".
61 FROM and TO should be equivalent names, which refer to the
62 same directory. Do not use `~' in the TO strings;
63 they should be ordinary absolute directory names.
65 Use this feature when you have directories which you normally refer to
66 via absolute symbolic links. Make TO the name of the link, and FROM
67 the name it is linked to."
68 :type
'(repeat (cons :format
"%v"
75 (defcustom make-backup-files t
76 "Non-nil means make a backup of a file the first time it is saved.
77 This can be done by renaming the file or by copying.
79 Renaming means that Emacs renames the existing file so that it is a
80 backup file, then writes the buffer into a new file. Any other names
81 that the old file had will now refer to the backup file. The new file
82 is owned by you and its group is defaulted.
84 Copying means that Emacs copies the existing file into the backup
85 file, then writes the buffer on top of the existing file. Any other
86 names that the old file had will now refer to the new (edited) file.
87 The file's owner and group are unchanged.
89 The choice of renaming or copying is controlled by the variables
90 `backup-by-copying', `backup-by-copying-when-linked',
91 `backup-by-copying-when-mismatch' and
92 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
96 ;; Do this so that local variables based on the file name
97 ;; are not overridden by the major mode.
98 (defvar backup-inhibited nil
99 "Non-nil means don't make a backup, regardless of the other parameters.
100 This variable is intended for use by making it local to a buffer.
101 But it is local only if you make it local.")
102 (put 'backup-inhibited
'permanent-local t
)
104 (defcustom backup-by-copying nil
105 "Non-nil means always use copying to create backup files.
106 See documentation of variable `make-backup-files'."
110 (defcustom backup-by-copying-when-linked nil
111 "Non-nil means use copying to create backups for files with multiple names.
112 This causes the alternate names to refer to the latest version as edited.
113 This variable is relevant only if `backup-by-copying' is nil."
117 (defcustom backup-by-copying-when-mismatch t
118 "Non-nil means create backups by copying if this preserves owner or group.
119 Renaming may still be used (subject to control of other variables)
120 when it would not result in changing the owner or group of the file;
121 that is, for files which are owned by you and whose group matches
122 the default for a new file created there by you.
123 This variable is relevant only if `backup-by-copying' is nil."
127 (put 'backup-by-copying-when-mismatch
'permanent-local t
)
129 (defcustom backup-by-copying-when-privileged-mismatch
200
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
138 :type
'(choice (const nil
) integer
)
141 (defvar backup-enable-predicate
'normal-backup-enable-predicate
142 "Predicate that looks at a file name and decides whether to make backups.
143 Called with an absolute file name as argument, it returns t to enable backup.")
145 (defcustom buffer-offer-save nil
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
151 (make-variable-buffer-local 'buffer-offer-save
)
152 (put 'buffer-offer-save
'permanent-local t
)
154 (defcustom find-file-existing-other-name t
155 "Non-nil means find a file under alternative names, in existing buffers.
156 This means if any existing buffer is visiting the file you want
157 under another name, you get the existing buffer instead of a new buffer."
161 (defcustom find-file-visit-truename nil
162 "Non-nil means visit a file under its truename.
163 The truename of a file is found by chasing all links
164 both at the file level and at the levels of the containing directories."
167 (put 'find-file-visit-truename
'safe-local-variable
'booleanp
)
169 (defcustom revert-without-query nil
170 "Specify which files should be reverted without query.
171 The value is a list of regular expressions.
172 If the file name matches one of these regular expressions,
173 then `revert-buffer' reverts the file without querying
174 if the file has changed on disk and you have not edited the buffer."
175 :type
'(repeat regexp
)
178 (defvar buffer-file-number nil
179 "The device number and file number of the file visited in the current buffer.
180 The value is a list of the form (FILENUM DEVNUM).
181 This pair of numbers uniquely identifies the file.
182 If the buffer is visiting a new file, the value is nil.")
183 (make-variable-buffer-local 'buffer-file-number
)
184 (put 'buffer-file-number
'permanent-local t
)
186 (defvar buffer-file-numbers-unique
(not (memq system-type
'(windows-nt)))
187 "Non-nil means that `buffer-file-number' uniquely identifies files.")
189 (defvar buffer-file-read-only nil
190 "Non-nil if visited file was read-only when visited.")
191 (make-variable-buffer-local 'buffer-file-read-only
)
193 (defcustom small-temporary-file-directory
194 (if (eq system-type
'ms-dos
) (getenv "TMPDIR"))
195 "The directory for writing small temporary files.
196 If non-nil, this directory is used instead of `temporary-file-directory'
197 by programs that create small temporary files. This is for systems that
198 have fast storage with limited space, such as a RAM disk."
200 :initialize
'custom-initialize-delay
201 :type
'(choice (const nil
) directory
))
203 ;; The system null device. (Should reference NULL_DEVICE from C.)
204 (defvar null-device
(purecopy "/dev/null") "The system null device.")
206 (declare-function msdos-long-file-names
"msdos.c")
207 (declare-function w32-long-file-name
"w32proc.c")
208 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
209 (declare-function dired-unmark
"dired" (arg))
210 (declare-function dired-do-flagged-delete
"dired" (&optional nomessage
))
211 (declare-function dos-8
+3-filename
"dos-fns" (filename))
212 (declare-function view-mode-disable
"view" ())
213 (declare-function dosified-file-name
"dos-fns" (file-name))
215 (defvar file-name-invalid-regexp
216 (cond ((and (eq system-type
'ms-dos
) (not (msdos-long-file-names)))
218 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
219 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
220 "[\000-\037]\\|" ; control characters
221 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
222 "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot
223 ((memq system-type
'(ms-dos windows-nt cygwin
))
225 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
226 "[|<>\"?*\000-\037]"))) ; invalid characters
227 (t (purecopy "[\000]")))
228 "Regexp recognizing file names which aren't allowed by the filesystem.")
230 (defcustom file-precious-flag nil
231 "Non-nil means protect against I/O errors while saving files.
232 Some modes set this non-nil in particular buffers.
234 This feature works by writing the new contents into a temporary file
235 and then renaming the temporary file to replace the original.
236 In this way, any I/O error in writing leaves the original untouched,
237 and there is never any instant where the file is nonexistent.
239 Note that this feature forces backups to be made by copying.
240 Yet, at the same time, saving a precious file
241 breaks any hard links between it and other files.
243 This feature is advisory: for example, if the directory in which the
244 file is being saved is not writable, Emacs may ignore a non-nil value
245 of `file-precious-flag' and write directly into the file.
247 See also: `break-hardlink-on-save'."
251 (defcustom break-hardlink-on-save nil
252 "Non-nil means when saving a file that exists under several names
253 \(i.e., has multiple hardlinks), break the hardlink associated with
254 `buffer-file-name' and write to a new file, so that the other
255 instances of the file are not affected by the save.
257 If `buffer-file-name' refers to a symlink, do not break the symlink.
259 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
260 For example, if the directory in which a file is being saved is not
261 itself writable, then error instead of saving in some
262 hardlink-nonbreaking way.
264 See also `backup-by-copying' and `backup-by-copying-when-linked'."
269 (defcustom version-control nil
270 "Control use of version numbers for backup files.
271 When t, make numeric backup versions unconditionally.
272 When nil, make them for files that have some already.
273 The value `never' means do not make them."
274 :type
'(choice (const :tag
"Never" never
)
275 (const :tag
"If existing" nil
)
276 (other :tag
"Always" t
))
279 (put 'version-control
'safe-local-variable
280 (lambda (x) (or (booleanp x
) (equal x
'never
))))
282 (defcustom dired-kept-versions
2
283 "When cleaning directory, number of versions to keep."
288 (defcustom delete-old-versions nil
289 "If t, delete excess backup versions silently.
290 If nil, ask confirmation. Any other value prevents any trimming."
291 :type
'(choice (const :tag
"Delete" t
)
292 (const :tag
"Ask" nil
)
293 (other :tag
"Leave" other
))
296 (defcustom kept-old-versions
2
297 "Number of oldest versions to keep when a new numbered backup is made."
300 (put 'kept-old-versions
'safe-local-variable
'integerp
)
302 (defcustom kept-new-versions
2
303 "Number of newest versions to keep when a new numbered backup is made.
304 Includes the new backup. Must be > 0"
307 (put 'kept-new-versions
'safe-local-variable
'integerp
)
309 (defcustom require-final-newline nil
310 "Whether to add a newline automatically at the end of the file.
312 A value of t means do this only when the file is about to be saved.
313 A value of `visit' means do this right after the file is visited.
314 A value of `visit-save' means do it at both of those times.
315 Any other non-nil value means ask user whether to add a newline, when saving.
316 A value of nil means don't add newlines.
318 Certain major modes set this locally to the value obtained
319 from `mode-require-final-newline'."
320 :type
'(choice (const :tag
"When visiting" visit
)
321 (const :tag
"When saving" t
)
322 (const :tag
"When visiting or saving" visit-save
)
323 (const :tag
"Don't add newlines" nil
)
324 (other :tag
"Ask each time" ask
))
325 :group
'editing-basics
)
327 (defcustom mode-require-final-newline t
328 "Whether to add a newline at end of file, in certain major modes.
329 Those modes set `require-final-newline' to this value when you enable them.
330 They do so because they are often used for files that are supposed
331 to end in newlines, and the question is how to arrange that.
333 A value of t means do this only when the file is about to be saved.
334 A value of `visit' means do this right after the file is visited.
335 A value of `visit-save' means do it at both of those times.
336 Any other non-nil value means ask user whether to add a newline, when saving.
338 A value of nil means do not add newlines. That is a risky choice in this
339 variable since this value is used for modes for files that ought to have
340 final newlines. So if you set this to nil, you must explicitly check and
341 add a final newline, whenever you save a file that really needs one."
342 :type
'(choice (const :tag
"When visiting" visit
)
343 (const :tag
"When saving" t
)
344 (const :tag
"When visiting or saving" visit-save
)
345 (const :tag
"Don't add newlines" nil
)
346 (other :tag
"Ask each time" ask
))
347 :group
'editing-basics
350 (defcustom auto-save-default t
351 "Non-nil says by default do auto-saving of every file-visiting buffer."
355 (defcustom auto-save-file-name-transforms
356 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
357 ;; Don't put "\\2" inside expand-file-name, since it will be
358 ;; transformed to "/2" on DOS/Windows.
359 ,(concat temporary-file-directory
"\\2") t
))
360 "Transforms to apply to buffer file name before making auto-save file name.
361 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
362 REGEXP is a regular expression to match against the file name.
363 If it matches, `replace-match' is used to replace the
364 matching part with REPLACEMENT.
365 If the optional element UNIQUIFY is non-nil, the auto-save file name is
366 constructed by taking the directory part of the replaced file-name,
367 concatenated with the buffer file name with all directory separators
368 changed to `!' to prevent clashes. This will not work
369 correctly if your filesystem truncates the resulting name.
371 All the transforms in the list are tried, in the order they are listed.
372 When one transform applies, its result is final;
373 no further transforms are tried.
375 The default value is set up to put the auto-save file into the
376 temporary directory (see the variable `temporary-file-directory') for
377 editing a remote file.
379 On MS-DOS filesystems without long names this variable is always
382 :type
'(repeat (list (string :tag
"Regexp") (string :tag
"Replacement")
383 (boolean :tag
"Uniquify")))
384 :initialize
'custom-initialize-delay
387 (defcustom save-abbrevs t
388 "Non-nil means save word abbrevs too when files are saved.
389 If `silently', don't ask the user before saving."
390 :type
'(choice (const t
) (const nil
) (const silently
))
393 (defcustom find-file-run-dired t
394 "Non-nil means allow `find-file' to visit directories.
395 To visit the directory, `find-file' runs `find-directory-functions'."
399 (defcustom find-directory-functions
'(cvs-dired-noselect dired-noselect
)
400 "List of functions to try in sequence to visit a directory.
401 Each function is called with the directory name as the sole argument
402 and should return either a buffer or nil."
403 :type
'(hook :options
(cvs-dired-noselect dired-noselect
))
406 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
407 (defcustom file-name-at-point-functions
'(ffap-guess-file-name-at-point)
408 "List of functions to try in sequence to get a file name at point.
409 Each function should return either nil or a file name found at the
410 location of point in the current buffer."
411 :type
'(hook :options
(ffap-guess-file-name-at-point))
414 ;;;It is not useful to make this a local variable.
415 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
416 (define-obsolete-variable-alias 'find-file-not-found-hooks
417 'find-file-not-found-functions
"22.1")
418 (defvar find-file-not-found-functions nil
419 "List of functions to be called for `find-file' on nonexistent file.
420 These functions are called as soon as the error is detected.
421 Variable `buffer-file-name' is already set up.
422 The functions are called in the order given until one of them returns non-nil.")
424 ;;;It is not useful to make this a local variable.
425 ;;;(put 'find-file-hooks 'permanent-local t)
426 (define-obsolete-variable-alias 'find-file-hooks
'find-file-hook
"22.1")
427 (defcustom find-file-hook nil
428 "List of functions to be called after a buffer is loaded from a file.
429 The buffer's local variables (if any) will have been processed before the
430 functions are called."
433 :options
'(auto-insert)
436 (define-obsolete-variable-alias 'write-file-hooks
'write-file-functions
"22.1")
437 (defvar write-file-functions nil
438 "List of functions to be called before writing out a buffer to a file.
439 If one of them returns non-nil, the file is considered already written
440 and the rest are not called.
441 These hooks are considered to pertain to the visited file.
442 So any buffer-local binding of this variable is discarded if you change
443 the visited file name with \\[set-visited-file-name], but not when you
444 change the major mode.
446 This hook is not run if any of the functions in
447 `write-contents-functions' returns non-nil. Both hooks pertain
448 to how to save a buffer to file, for instance, choosing a suitable
449 coding system and setting mode bits. (See Info
450 node `(elisp)Saving Buffers'.) To perform various checks or
451 updates before the buffer is saved, use `before-save-hook'.")
452 (put 'write-file-functions
'permanent-local t
)
454 (defvar local-write-file-hooks nil
)
455 (make-variable-buffer-local 'local-write-file-hooks
)
456 (put 'local-write-file-hooks
'permanent-local t
)
457 (make-obsolete-variable 'local-write-file-hooks
'write-file-functions
"22.1")
459 (define-obsolete-variable-alias 'write-contents-hooks
460 'write-contents-functions
"22.1")
461 (defvar write-contents-functions nil
462 "List of functions to be called before writing out a buffer to a file.
463 If one of them returns non-nil, the file is considered already written
464 and the rest are not called and neither are the functions in
465 `write-file-functions'.
467 This variable is meant to be used for hooks that pertain to the
468 buffer's contents, not to the particular visited file; thus,
469 `set-visited-file-name' does not clear this variable; but changing the
470 major mode does clear it.
472 For hooks that _do_ pertain to the particular visited file, use
473 `write-file-functions'. Both this variable and
474 `write-file-functions' relate to how a buffer is saved to file.
475 To perform various checks or updates before the buffer is saved,
476 use `before-save-hook'.")
477 (make-variable-buffer-local 'write-contents-functions
)
479 (defcustom enable-local-variables t
480 "Control use of local variables in files you visit.
481 The value can be t, nil, :safe, :all, or something else.
483 A value of t means file local variables specifications are obeyed
484 if all the specified variable values are safe; if any values are
485 not safe, Emacs queries you, once, whether to set them all.
486 \(When you say yes to certain values, they are remembered as safe.)
488 :safe means set the safe variables, and ignore the rest.
489 :all means set all variables, whether safe or not.
490 (Don't set it permanently to :all.)
491 A value of nil means always ignore the file local variables.
493 Any other value means always query you once whether to set them all.
494 \(When you say yes to certain values, they are remembered as safe, but
495 this has no effect when `enable-local-variables' is \"something else\".)
497 This variable also controls use of major modes specified in
500 The command \\[normal-mode], when used interactively,
501 always obeys file local variable specifications and the -*- line,
502 and ignores this variable."
504 :type
'(choice (const :tag
"Query Unsafe" t
)
505 (const :tag
"Safe Only" :safe
)
506 (const :tag
"Do all" :all
)
507 (const :tag
"Ignore" nil
)
508 (other :tag
"Query" other
))
511 ;; This is an odd variable IMO.
512 ;; You might wonder why it is needed, when we could just do:
513 ;; (set (make-local-variable 'enable-local-variables) nil)
514 ;; These two are not precisely the same.
515 ;; Setting this variable does not cause -*- mode settings to be
516 ;; ignored, whereas setting enable-local-variables does.
517 ;; Only three places in Emacs use this variable: tar and arc modes,
518 ;; and rmail. The first two don't need it. They already use
519 ;; inhibit-local-variables-regexps, which is probably enough, and
520 ;; could also just set enable-local-variables locally to nil.
521 ;; Them setting it has the side-effect that dir-locals cannot apply to
522 ;; eg tar files (?). FIXME Is this appropriate?
523 ;; AFAICS, rmail is the only thing that needs this, and the only
524 ;; reason it uses it is for BABYL files (which are obsolete).
525 ;; These contain "-*- rmail -*-" in the first line, which rmail wants
526 ;; to respect, so that find-file on a BABYL file will switch to
527 ;; rmail-mode automatically (this is nice, but hardly essential,
528 ;; since most people are used to explicitly running a command to
529 ;; access their mail; M-x gnus etc). Rmail files may happen to
530 ;; contain Local Variables sections in messages, which Rmail wants to
531 ;; ignore. So AFAICS the only reason this variable exists is for a
532 ;; minor convenience feature for handling of an obsolete Rmail file format.
533 (defvar local-enable-local-variables t
534 "Like `enable-local-variables' but meant for buffer-local bindings.
535 The meaningful values are nil and non-nil. The default is non-nil.
536 If a major mode sets this to nil, buffer-locally, then any local
537 variables list in a file visited in that mode will be ignored.
539 This variable does not affect the use of major modes specified
542 (defcustom enable-local-eval
'maybe
543 "Control processing of the \"variable\" `eval' in a file's local variables.
544 The value can be t, nil or something else.
545 A value of t means obey `eval' variables.
546 A value of nil means ignore them; anything else means query."
548 :type
'(choice (const :tag
"Obey" t
)
549 (const :tag
"Ignore" nil
)
550 (other :tag
"Query" other
))
553 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
554 (or (fboundp 'lock-buffer
)
555 (defalias 'lock-buffer
'ignore
))
556 (or (fboundp 'unlock-buffer
)
557 (defalias 'unlock-buffer
'ignore
))
558 (or (fboundp 'file-locked-p
)
559 (defalias 'file-locked-p
'ignore
))
561 (defcustom view-read-only nil
562 "Non-nil means buffers visiting files read-only do so in view mode.
563 In fact, this means that all read-only buffers normally have
564 View mode enabled, including buffers that are read-only because
565 you visit a file you cannot alter, and buffers you make read-only
566 using \\[toggle-read-only]."
570 (defvar file-name-history nil
571 "History list of file names entered in the minibuffer.
573 Maximum length of the history list is determined by the value
574 of `history-length', which see.")
576 (put 'ange-ftp-completion-hook-function
'safe-magic t
)
577 (defun ange-ftp-completion-hook-function (op &rest args
)
578 "Provides support for ange-ftp host name completion.
579 Runs the usual ange-ftp hook, but only for completion operations."
580 ;; Having this here avoids the need to load ange-ftp when it's not
582 (if (memq op
'(file-name-completion file-name-all-completions
))
583 (apply 'ange-ftp-hook-function op args
)
584 (let ((inhibit-file-name-handlers
585 (cons 'ange-ftp-completion-hook-function
586 (and (eq inhibit-file-name-operation op
)
587 inhibit-file-name-handlers
)))
588 (inhibit-file-name-operation op
))
591 (declare-function dos-convert-standard-filename
"dos-fns.el" (filename))
592 (declare-function w32-convert-standard-filename
"w32-fns.el" (filename))
594 (defun convert-standard-filename (filename)
595 "Convert a standard file's name to something suitable for the OS.
596 This means to guarantee valid names and perhaps to canonicalize
599 FILENAME should be an absolute file name since the conversion rules
600 sometimes vary depending on the position in the file name. E.g. c:/foo
601 is a valid DOS file name, but c:/bar/c:/foo is not.
603 This function's standard definition is trivial; it just returns
604 the argument. However, on Windows and DOS, replace invalid
605 characters. On DOS, make sure to obey the 8.3 limitations.
606 In the native Windows build, turn Cygwin names into native names,
607 and also turn slashes into backslashes if the shell requires it (see
608 `w32-shell-dos-semantics').
610 See Info node `(elisp)Standard File Names' for more details."
612 ((eq system-type
'cygwin
)
613 (let ((name (copy-sequence filename
))
615 ;; Replace invalid filename characters with !
616 (while (string-match "[?*:<>|\"\000-\037]" name start
)
617 (aset name
(match-beginning 0) ?
!)
618 (setq start
(match-end 0)))
620 ((eq system-type
'windows-nt
)
621 (w32-convert-standard-filename filename
))
622 ((eq system-type
'ms-dos
)
623 (dos-convert-standard-filename filename
))
626 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
627 "Read directory name, prompting with PROMPT and completing in directory DIR.
628 Value is not expanded---you must call `expand-file-name' yourself.
629 Default name to DEFAULT-DIRNAME if user exits with the same
630 non-empty string that was inserted by this function.
631 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
632 or just DIR if INITIAL is nil.)
633 If the user exits with an empty minibuffer, this function returns
634 an empty string. (This can only happen if the user erased the
635 pre-inserted contents or if `insert-default-directory' is nil.)
636 Fourth arg MUSTMATCH non-nil means require existing directory's name.
637 Non-nil and non-t means also require confirmation after completion.
638 Fifth arg INITIAL specifies text to start with.
639 DIR should be an absolute directory name. It defaults to
640 the value of `default-directory'."
642 (setq dir default-directory
))
643 (read-file-name prompt dir
(or default-dirname
644 (if initial
(expand-file-name initial dir
)
651 "Show the current default directory."
653 (message "Directory %s" default-directory
))
656 "Value of the CDPATH environment variable, as a list.
657 Not actually set up until the first time you use it.")
659 (defun parse-colon-path (search-path)
660 "Explode a search path into a list of directory names.
661 Directories are separated by occurrences of `path-separator'
662 \(which is colon in GNU and GNU-like systems)."
663 ;; We could use split-string here.
665 (let (cd-list (cd-start 0) cd-colon
)
666 (setq search-path
(concat search-path path-separator
))
667 (while (setq cd-colon
(string-match path-separator search-path cd-start
))
670 (list (if (= cd-start cd-colon
)
672 (substitute-in-file-name
673 (file-name-as-directory
674 (substring search-path cd-start cd-colon
)))))))
675 (setq cd-start
(+ cd-colon
1)))
678 (defun cd-absolute (dir)
679 "Change current directory to given absolute file name DIR."
680 ;; Put the name into directory syntax now,
681 ;; because otherwise expand-file-name may give some bad results.
682 (setq dir
(file-name-as-directory dir
))
683 ;; We used to additionally call abbreviate-file-name here, for an
684 ;; unknown reason. Problem is that most buffers are setup
685 ;; without going through cd-absolute and don't call
686 ;; abbreviate-file-name on their default-directory, so the few that
687 ;; do end up using a superficially different directory.
688 (setq dir
(expand-file-name dir
))
689 (if (not (file-directory-p dir
))
690 (if (file-exists-p dir
)
691 (error "%s is not a directory" dir
)
692 (error "%s: no such directory" dir
))
693 (unless (file-executable-p dir
)
694 (error "Cannot cd to %s: Permission denied" dir
))
695 (setq default-directory dir
)
696 (setq list-buffers-directory dir
)))
699 "Make DIR become the current buffer's default directory.
700 If your environment includes a `CDPATH' variable, try each one of
701 that list of directories (separated by occurrences of
702 `path-separator') when resolving a relative directory name.
703 The path separator is colon in GNU and GNU-like systems."
706 ;; FIXME: There's a subtle bug in the completion below. Seems linked
707 ;; to a fundamental difficulty of implementing `predicate' correctly.
708 ;; The manifestation is that TAB may list non-directories in the case where
709 ;; those files also correspond to valid directories (if your cd-path is (A/
710 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
711 ;; will be listed as valid completions).
712 ;; This is because `a' (listed because of A/a) is indeed a valid choice
713 ;; (which will lead to the use of B/a).
714 (minibuffer-with-setup-hook
716 (setq minibuffer-completion-table
717 (apply-partially #'locate-file-completion-table
719 (setq minibuffer-completion-predicate
721 (locate-file dir cd-path nil
722 (lambda (f) (and (file-directory-p f
) 'dir-ok
))))))
724 (setq cd-path
(or (parse-colon-path (getenv "CDPATH"))
726 (read-directory-name "Change default directory: "
727 default-directory default-directory
730 (setq cd-path
(or (parse-colon-path (getenv "CDPATH"))
733 (or (locate-file dir cd-path nil
734 (lambda (f) (and (file-directory-p f
) 'dir-ok
)))
735 (error "No such directory found via CDPATH environment variable"))))
737 (defun load-file (file)
738 "Load the Lisp file named FILE."
739 ;; This is a case where .elc makes a lot of sense.
740 (interactive (list (let ((completion-ignored-extensions
741 (remove ".elc" completion-ignored-extensions
)))
742 (read-file-name "Load file: "))))
743 (load (expand-file-name file
) nil nil t
))
745 (defun locate-file (filename path
&optional suffixes predicate
)
746 "Search for FILENAME through PATH.
747 If found, return the absolute file name of FILENAME, with its suffixes;
748 otherwise return nil.
749 PATH should be a list of directories to look in, like the lists in
750 `exec-path' or `load-path'.
751 If SUFFIXES is non-nil, it should be a list of suffixes to append to
752 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
753 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
754 If non-nil, PREDICATE is used instead of `file-readable-p'.
756 This function will normally skip directories, so if you want it to find
757 directories, make sure the PREDICATE function returns `dir-ok' for them.
759 PREDICATE can also be an integer to pass to the `access' system call,
760 in which case file-name handlers are ignored. This usage is deprecated.
761 For compatibility, PREDICATE can also be one of the symbols
762 `executable', `readable', `writable', or `exists', or a list of
763 one or more of those symbols."
764 (if (and predicate
(symbolp predicate
) (not (functionp predicate
)))
765 (setq predicate
(list predicate
)))
766 (when (and (consp predicate
) (not (functionp predicate
)))
768 (logior (if (memq 'executable predicate
) 1 0)
769 (if (memq 'writable predicate
) 2 0)
770 (if (memq 'readable predicate
) 4 0))))
771 (locate-file-internal filename path suffixes predicate
))
773 (defun locate-file-completion-table (dirs suffixes string pred action
)
774 "Do completion for file names passed to `locate-file'."
776 ((file-name-absolute-p string
)
777 ;; FIXME: maybe we should use completion-file-name-table instead,
778 ;; tho at least for `load', the arg is passed through
779 ;; substitute-in-file-name for historical reasons.
780 (read-file-name-internal string pred action
))
781 ((eq (car-safe action
) 'boundaries
)
782 (let ((suffix (cdr action
)))
784 ,(length (file-name-directory string
))
785 ,@(let ((x (file-name-directory suffix
)))
786 (if x
(1- (length x
)) (length suffix
))))))
789 ;; If we have files like "foo.el" and "foo.elc", we could load one of
790 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
791 ;; preferred way. So if we list all 3, that gives a lot of redundant
792 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
793 ;; the user does want to pay attention to the extension. We try to
794 ;; diffuse this tension by stripping the suffix, except when the
795 ;; result is a single element (i.e. usually we only list "foo" unless
796 ;; it's the only remaining element in the list, in which case we do
797 ;; list "foo", "foo.elc" and "foo.el").
799 (suffix (concat (regexp-opt suffixes t
) "\\'"))
800 (string-dir (file-name-directory string
))
801 (string-file (file-name-nondirectory string
)))
804 (setq dir default-directory
))
805 (if string-dir
(setq dir
(expand-file-name string-dir dir
)))
806 (when (file-directory-p dir
)
807 (dolist (file (file-name-all-completions
809 (if (not (string-match suffix file
))
811 (push file fullnames
)
812 (push (substring file
0 (match-beginning 0)) names
)))))
813 ;; Switching from names to names+fullnames creates a non-monotonicity
814 ;; which can cause problems with things like partial-completion.
815 ;; To minimize the problem, filter out completion-regexp-list, so that
816 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
817 ;; from `names' which only matched `string' when they still had
819 (setq names
(all-completions string names
))
820 ;; Remove duplicates of the first element, so that we can easily check
821 ;; if `names' really only contains a single element.
822 (when (cdr names
) (setcdr names
(delete (car names
) (cdr names
))))
824 ;; There's no more than one matching non-suffixed element, so expand
825 ;; the list by adding the suffixed elements as well.
826 (setq names
(nconc names fullnames
)))
827 (completion-table-with-context
828 string-dir names string-file pred action
)))))
830 (defun locate-file-completion (string path-and-suffixes action
)
831 "Do completion for file names passed to `locate-file'.
832 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
833 (locate-file-completion-table (car path-and-suffixes
)
834 (cdr path-and-suffixes
)
836 (make-obsolete 'locate-file-completion
'locate-file-completion-table
"23.1")
838 (defvar locate-dominating-stop-dir-regexp
839 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
840 "Regexp of directory names which stop the search in `locate-dominating-file'.
841 Any directory whose name matches this regexp will be treated like
842 a kind of root directory by `locate-dominating-file' which will stop its search
843 when it bumps into it.
844 The default regexp prevents fruitless and time-consuming attempts to find
845 special files in directories in which filenames are interpreted as hostnames,
846 or mount points potentially requiring authentication as a different user.")
848 ;; (defun locate-dominating-files (file regexp)
849 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
850 ;; Stop at the first parent where a matching file is found and return the list
851 ;; of files that that match in this directory."
853 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
854 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
856 ;; ;; Abbreviate, so as to stop when we cross ~/.
857 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
860 ;; ;; As a heuristic, we stop looking up the hierarchy of
861 ;; ;; directories as soon as we find a directory belonging to
862 ;; ;; another user. This should save us from looking in
863 ;; ;; things like /net and /afs. This assumes that all the
864 ;; ;; files inside a project belong to the same user.
865 ;; (let ((prev-user user))
866 ;; (setq user (nth 2 (file-attributes dir)))
867 ;; (or (null prev-user) (equal user prev-user))))
868 ;; (if (setq files (condition-case nil
869 ;; (directory-files dir 'full regexp 'nosort)
871 ;; (throw 'found files)
873 ;; (setq dir (file-name-directory
874 ;; (directory-file-name dir))))
878 (defun locate-dominating-file (file name
)
879 "Look up the directory hierarchy from FILE for a directory containing NAME.
880 Stop at the first parent directory containing a file NAME,
881 and return the directory. Return nil if not found.
882 Instead of a string, NAME can also be a predicate taking one argument
883 \(a directory) and returning a non-nil value if that directory is the one for
884 which we're looking."
885 ;; We used to use the above locate-dominating-files code, but the
886 ;; directory-files call is very costly, so we're much better off doing
887 ;; multiple calls using the code in here.
889 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
890 ;; `name' in /home or in /.
891 (setq file
(abbreviate-file-name file
))
893 ;; `user' is not initialized outside the loop because
894 ;; `file' may not exist, so we may have to walk up part of the
895 ;; hierarchy before we find the "initial UID". Note: currently unused
900 ;; FIXME: Disabled this heuristic because it is sometimes
902 ;; As a heuristic, we stop looking up the hierarchy of
903 ;; directories as soon as we find a directory belonging
904 ;; to another user. This should save us from looking in
905 ;; things like /net and /afs. This assumes that all the
906 ;; files inside a project belong to the same user.
907 ;; (let ((prev-user user))
908 ;; (setq user (nth 2 (file-attributes file)))
909 ;; (and prev-user (not (equal user prev-user))))
910 (string-match locate-dominating-stop-dir-regexp file
)))
911 (setq try
(if (stringp name
)
912 (file-exists-p (expand-file-name name file
))
913 (funcall name file
)))
914 (cond (try (setq root file
))
915 ((equal file
(setq file
(file-name-directory
916 (directory-file-name file
))))
918 (if root
(file-name-as-directory root
))))
921 (defun executable-find (command)
922 "Search for COMMAND in `exec-path' and return the absolute file name.
923 Return nil if COMMAND is not found anywhere in `exec-path'."
924 ;; Use 1 rather than file-executable-p to better match the behavior of
926 (locate-file command exec-path exec-suffixes
1))
928 (defun load-library (library)
929 "Load the Emacs Lisp library named LIBRARY.
930 This is an interface to the function `load'. LIBRARY is searched
931 for in `load-path', both with and without `load-suffixes' (as
932 well as `load-file-rep-suffixes').
934 See Info node `(emacs)Lisp Libraries' for more details.
935 See `load-file' for a different interface to `load'."
937 (list (completing-read "Load library: "
938 (apply-partially 'locate-file-completion-table
940 (get-load-suffixes)))))
943 (defun file-remote-p (file &optional identification connected
)
944 "Test whether FILE specifies a location on a remote system.
945 A file is considered remote if accessing it is likely to
946 be slower or less reliable than accessing local files.
948 `file-remote-p' never opens a new remote connection. It can
949 only reuse a connection that is already open.
951 Return nil or a string identifying the remote connection
952 \(ideally a prefix of FILE). Return nil if FILE is a relative
955 When IDENTIFICATION is nil, the returned string is a complete
956 remote identifier: with components method, user, and host. The
957 components are those present in FILE, with defaults filled in for
958 any that are missing.
960 IDENTIFICATION can specify which part of the identification to
961 return. IDENTIFICATION can be the symbol `method', `user',
962 `host', or `localname'. Any other value is handled like nil and
963 means to return the complete identification. The string returned
964 for IDENTIFICATION `localname' can differ depending on whether
965 there is an existing connection.
967 If CONNECTED is non-nil, return an identification only if FILE is
968 located on a remote system and a connection is established to
971 Tip: You can use this expansion of remote identifier components
972 to derive a new remote file name from an existing one. For
973 example, if FILE is \"/sudo::/path/to/file\" then
975 \(concat \(file-remote-p FILE) \"/bin/sh\")
977 returns a remote file name for file \"/bin/sh\" that has the
978 same remote identifier as FILE but expanded; a name such as
979 \"/sudo:root@myhost:/bin/sh\"."
980 (let ((handler (find-file-name-handler file
'file-remote-p
)))
982 (funcall handler
'file-remote-p file identification connected
)
985 ;; Probably this entire variable should be obsolete now, in favor of
986 ;; something Tramp-related (?). It is not used in many places.
987 ;; It's not clear what the best file for this to be in is, but given
988 ;; it uses custom-initialize-delay, it is easier if it is preloaded
989 ;; rather than autoloaded.
990 (defcustom remote-shell-program
991 ;; This used to try various hard-coded places for remsh, rsh, and
992 ;; rcmd, trying to guess based on location whether "rsh" was
993 ;; "restricted shell" or "remote shell", but I don't see the point
994 ;; in this day and age. Almost everyone will use ssh, and have
995 ;; whatever command they want to use in PATH.
997 (let ((list '("ssh" "remsh" "rcmd" "rsh")))
999 (not (executable-find (car list
)))
1000 (setq list
(cdr list
))))
1001 (or (car list
) "ssh")))
1002 "Program to use to execute commands on a remote host (e.g. ssh or rsh)."
1003 :version
"24.2" ; ssh rather than rsh, etc
1004 :initialize
'custom-initialize-delay
1008 (defcustom remote-file-name-inhibit-cache
10
1009 "Whether to use the remote file-name cache for read access.
1010 When `nil', never expire cached values (caution)
1011 When `t', never use the cache (safe, but may be slow)
1012 A number means use cached values for that amount of seconds since caching.
1014 The attributes of remote files are cached for better performance.
1015 If they are changed outside of Emacs's control, the cached values
1016 become invalid, and must be reread. If you are sure that nothing
1017 other than Emacs changes the files, you can set this variable to `nil'.
1019 If a remote file is checked regularly, it might be a good idea to
1020 let-bind this variable to a value less than the interval between
1021 consecutive checks. For example:
1023 (defun display-time-file-nonempty-p (file)
1024 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
1025 (and (file-exists-p file)
1026 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
1030 (const :tag
"Do not inhibit file name cache" nil
)
1031 (const :tag
"Do not use file name cache" t
)
1032 (integer :tag
"Do not use file name cache"
1033 :format
"Do not use file name cache older then %v seconds"
1036 (defun file-local-copy (file)
1037 "Copy the file FILE into a temporary file on this machine.
1038 Returns the name of the local copy, or nil, if FILE is directly
1040 ;; This formerly had an optional BUFFER argument that wasn't used by
1042 (let ((handler (find-file-name-handler file
'file-local-copy
)))
1044 (funcall handler
'file-local-copy file
)
1047 (defun file-truename (filename &optional counter prev-dirs
)
1048 "Return the truename of FILENAME.
1049 If FILENAME is not absolute, first expands it against `default-directory'.
1050 The truename of a file name is found by chasing symbolic links
1051 both at the level of the file and at the level of the directories
1052 containing it, until no links are left at any level.
1054 \(fn FILENAME)" ;; Don't document the optional arguments.
1055 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1056 ;; COUNTER can be a cons cell whose car is the count of how many
1057 ;; more links to chase before getting an error.
1058 ;; PREV-DIRS can be a cons cell whose car is an alist
1059 ;; of truenames we've just recently computed.
1060 (cond ((or (string= filename
"") (string= filename
"~"))
1061 (setq filename
(expand-file-name filename
))
1062 (if (string= filename
"")
1063 (setq filename
"/")))
1064 ((and (string= (substring filename
0 1) "~")
1065 (string-match "~[^/]*/?" filename
))
1067 (substring filename
0 (match-end 0)))
1068 (rest (substring filename
(match-end 0))))
1069 (setq filename
(concat (expand-file-name first-part
) rest
)))))
1071 (or counter
(setq counter
(list 100)))
1073 ;; For speed, remove the ange-ftp completion handler from the list.
1074 ;; We know it's not needed here.
1075 ;; For even more speed, do this only on the outermost call.
1076 (file-name-handler-alist
1077 (if prev-dirs file-name-handler-alist
1078 (let ((tem (copy-sequence file-name-handler-alist
)))
1079 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
1080 (or prev-dirs
(setq prev-dirs
(list nil
)))
1082 ;; andrewi@harlequin.co.uk - none of the following code (except for
1083 ;; invoking the file-name handler) currently applies on Windows
1084 ;; (ie. there are no native symlinks), but there is an issue with
1085 ;; case differences being ignored by the OS, and short "8.3 DOS"
1086 ;; name aliases existing for all files. (The short names are not
1087 ;; reported by directory-files, but can be used to refer to files.)
1088 ;; It seems appropriate for file-truename to resolve these issues in
1089 ;; the most natural way, which on Windows is to call the function
1090 ;; `w32-long-file-name' - this returns the exact name of a file as
1091 ;; it is stored on disk (expanding short name aliases with the full
1092 ;; name in the process).
1093 (if (eq system-type
'windows-nt
)
1094 (let ((handler (find-file-name-handler filename
'file-truename
)))
1095 ;; For file name that has a special handler, call handler.
1096 ;; This is so that ange-ftp can save time by doing a no-op.
1098 (setq filename
(funcall handler
'file-truename filename
))
1099 ;; If filename contains a wildcard, newname will be the old name.
1100 (unless (string-match "[[*?]" filename
)
1101 ;; If filename exists, use the long name. If it doesn't exist,
1102 ;; drill down until we find a directory that exists, and use
1103 ;; the long name of that, with the extra non-existent path
1104 ;; components concatenated.
1105 (let ((longname (w32-long-file-name filename
))
1108 (setq filename longname
)
1109 ;; Include the preceding directory separator in the missing
1110 ;; part so subsequent recursion on the rest works.
1111 (setq missing
(concat "/" (file-name-nondirectory filename
)))
1112 (let ((length (length missing
)))
1114 (if (> length
(length filename
))
1116 (substring filename
0 (- length
)))))
1117 (setq filename
(concat (file-truename rest
) missing
))))))
1120 ;; If this file directly leads to a link, process that iteratively
1121 ;; so that we don't use lots of stack.
1123 (setcar counter
(1- (car counter
)))
1124 (if (< (car counter
) 0)
1125 (error "Apparent cycle of symbolic links for %s" filename
))
1126 (let ((handler (find-file-name-handler filename
'file-truename
)))
1127 ;; For file name that has a special handler, call handler.
1128 ;; This is so that ange-ftp can save time by doing a no-op.
1130 (setq filename
(funcall handler
'file-truename filename
)
1132 (let ((dir (or (file-name-directory filename
) default-directory
))
1134 ;; Get the truename of the directory.
1135 (setq dirfile
(directory-file-name dir
))
1136 ;; If these are equal, we have the (or a) root directory.
1137 (or (string= dir dirfile
)
1138 ;; If this is the same dir we last got the truename for,
1139 ;; save time--don't recalculate.
1140 (if (assoc dir
(car prev-dirs
))
1141 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
1143 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
1144 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
1146 (if (equal ".." (file-name-nondirectory filename
))
1148 (directory-file-name (file-name-directory (directory-file-name dir
)))
1150 (if (equal "." (file-name-nondirectory filename
))
1151 (setq filename
(directory-file-name dir
)
1153 ;; Put it back on the file name.
1154 (setq filename
(concat dir
(file-name-nondirectory filename
)))
1155 ;; Is the file name the name of a link?
1156 (setq target
(file-symlink-p filename
))
1158 ;; Yes => chase that link, then start all over
1159 ;; since the link may point to a directory name that uses links.
1160 ;; We can't safely use expand-file-name here
1161 ;; since target might look like foo/../bar where foo
1162 ;; is itself a link. Instead, we handle . and .. above.
1164 (if (file-name-absolute-p target
)
1166 (concat dir target
))
1169 (setq done t
))))))))
1172 (defun file-chase-links (filename &optional limit
)
1173 "Chase links in FILENAME until a name that is not a link.
1174 Unlike `file-truename', this does not check whether a parent
1175 directory name is a symbolic link.
1176 If the optional argument LIMIT is a number,
1177 it means chase no more than that many links and then stop."
1178 (let (tem (newname filename
)
1180 (while (and (or (null limit
) (< count limit
))
1181 (setq tem
(file-symlink-p newname
)))
1183 (if (and (null limit
) (= count
100))
1184 (error "Apparent cycle of symbolic links for %s" filename
))
1185 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1186 (while (string-match "//+" tem
)
1187 (setq tem
(replace-match "/" nil nil tem
)))
1188 ;; Handle `..' by hand, since it needs to work in the
1189 ;; target of any directory symlink.
1190 ;; This code is not quite complete; it does not handle
1191 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1192 (while (string-match "\\`\\.\\./" tem
)
1193 (setq tem
(substring tem
3))
1194 (setq newname
(expand-file-name newname
))
1195 ;; Chase links in the default dir of the symlink.
1198 (directory-file-name (file-name-directory newname
))))
1199 ;; Now find the parent of that dir.
1200 (setq newname
(file-name-directory newname
)))
1201 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
1202 (setq count
(1+ count
))))
1205 ;; A handy function to display file sizes in human-readable form.
1206 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1207 (defun file-size-human-readable (file-size &optional flavor
)
1208 "Produce a string showing FILE-SIZE in human-readable form.
1210 Optional second argument FLAVOR controls the units and the display format:
1212 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1213 suffixes are \"k\", \"M\", \"G\", \"T\", etc.
1214 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1215 are \"k\", \"M\", \"G\", \"T\", etc.
1216 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1217 are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc."
1218 (let ((power (if (or (null flavor
) (eq flavor
'iec
))
1222 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1223 (list "" "k" "M" "G" "T" "P" "E" "Z" "Y")))
1224 (while (and (>= file-size power
) (cdr post-fixes
))
1225 (setq file-size
(/ file-size power
)
1226 post-fixes
(cdr post-fixes
)))
1227 (format (if (> (mod file-size
1.0) 0.05)
1231 (if (and (eq flavor
'iec
) (string= (car post-fixes
) "k"))
1234 (if (eq flavor
'iec
) "iB" ""))))
1236 (defun make-temp-file (prefix &optional dir-flag suffix
)
1237 "Create a temporary file.
1238 The returned file name (created by appending some random characters at the end
1239 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1240 is guaranteed to point to a newly created empty file.
1241 You can then use `write-region' to write new data into the file.
1243 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1245 If SUFFIX is non-nil, add that at the end of the file name."
1246 (let ((umask (default-file-modes))
1250 ;; Create temp files with strict access rights. It's easy to
1251 ;; loosen them later, whereas it's impossible to close the
1252 ;; time-window of loose permissions otherwise.
1253 (set-default-file-modes ?
\700)
1254 (while (condition-case ()
1258 (if (zerop (length prefix
))
1259 (file-name-as-directory
1260 temporary-file-directory
)
1261 (expand-file-name prefix
1262 temporary-file-directory
))))
1264 (setq file
(concat file suffix
)))
1266 (make-directory file
)
1267 (write-region "" nil file nil
'silent nil
'excl
))
1269 (file-already-exists t
))
1270 ;; the file was somehow created by someone else between
1271 ;; `make-temp-name' and `write-region', let's try again.
1275 (set-default-file-modes umask
))))
1277 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
1278 "Change the encoding of FILE's name from CODING to NEW-CODING.
1279 The value is a new name of FILE.
1280 Signals a `file-already-exists' error if a file of the new name
1281 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1282 is non-nil. A number as fourth arg means request confirmation if
1283 the new name already exists. This is what happens in interactive
1286 (let ((default-coding (or file-name-coding-system
1287 default-file-name-coding-system
))
1288 (filename (read-file-name "Recode filename: " nil nil t
))
1289 from-coding to-coding
)
1290 (if (and default-coding
1291 ;; We provide the default coding only when it seems that
1292 ;; the filename is correctly decoded by the default
1294 (let ((charsets (find-charset-string filename
)))
1295 (and (not (memq 'eight-bit-control charsets
))
1296 (not (memq 'eight-bit-graphic charsets
)))))
1297 (setq from-coding
(read-coding-system
1298 (format "Recode filename %s from (default %s): "
1299 filename default-coding
)
1301 (setq from-coding
(read-coding-system
1302 (format "Recode filename %s from: " filename
))))
1304 ;; We provide the default coding only when a user is going to
1305 ;; change the encoding not from the default coding.
1306 (if (eq from-coding default-coding
)
1307 (setq to-coding
(read-coding-system
1308 (format "Recode filename %s from %s to: "
1309 filename from-coding
)))
1310 (setq to-coding
(read-coding-system
1311 (format "Recode filename %s from %s to (default %s): "
1312 filename from-coding default-coding
)
1314 (list filename from-coding to-coding
)))
1316 (let* ((default-coding (or file-name-coding-system
1317 default-file-name-coding-system
))
1318 ;; FILE should have been decoded by DEFAULT-CODING.
1319 (encoded (encode-coding-string file default-coding
))
1320 (newname (decode-coding-string encoded coding
))
1321 (new-encoded (encode-coding-string newname new-coding
))
1322 ;; Suppress further encoding.
1323 (file-name-coding-system nil
)
1324 (default-file-name-coding-system nil
)
1325 (locale-coding-system nil
))
1326 (rename-file encoded new-encoded ok-if-already-exists
)
1329 (defcustom confirm-nonexistent-file-or-buffer
'after-completion
1330 "Whether confirmation is requested before visiting a new file or buffer.
1331 If nil, confirmation is not requested.
1332 If the value is `after-completion', confirmation is only
1333 requested if the user called `minibuffer-complete' right before
1334 `minibuffer-complete-and-exit'.
1335 Any other non-nil value means to request confirmation.
1337 This affects commands like `switch-to-buffer' and `find-file'."
1340 :type
'(choice (const :tag
"After completion" after-completion
)
1341 (const :tag
"Never" nil
)
1342 (other :tag
"Always" t
)))
1344 (defun confirm-nonexistent-file-or-buffer ()
1345 "Whether to request confirmation before visiting a new file or buffer.
1346 The variable `confirm-nonexistent-file-or-buffer' determines the
1347 return value, which may be passed as the REQUIRE-MATCH arg to
1348 `read-buffer' or `find-file-read-args'."
1349 (cond ((eq confirm-nonexistent-file-or-buffer
'after-completion
)
1350 'confirm-after-completion
)
1351 (confirm-nonexistent-file-or-buffer
1355 (defmacro minibuffer-with-setup-hook
(fun &rest body
)
1356 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1357 BODY should use the minibuffer at most once.
1358 Recursive uses of the minibuffer are unaffected (FUN is not
1359 called additional times).
1361 This macro actually adds an auxiliary function that calls FUN,
1362 rather than FUN itself, to `minibuffer-setup-hook'."
1363 (declare (indent 1) (debug t
))
1364 (let ((hook (make-symbol "setup-hook")))
1368 ;; Clear out this hook so it does not interfere
1369 ;; with any recursive minibuffer usage.
1370 (remove-hook 'minibuffer-setup-hook
,hook
)
1374 (add-hook 'minibuffer-setup-hook
,hook
)
1376 (remove-hook 'minibuffer-setup-hook
,hook
)))))
1378 (defun find-file-read-args (prompt mustmatch
)
1379 (list (read-file-name prompt nil default-directory mustmatch
)
1382 (defun find-file (filename &optional wildcards
)
1383 "Edit file FILENAME.
1384 Switch to a buffer visiting file FILENAME,
1385 creating one if none already exists.
1386 Interactively, the default if you just type RET is the current directory,
1387 but the visited file name is available through the minibuffer history:
1388 type M-n to pull it into the minibuffer.
1390 You can visit files on remote machines by specifying something
1391 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1392 also visit local files as a different user by specifying
1393 /sudo::FILE for the file name.
1394 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1395 manual, for more about this.
1397 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1398 expand wildcards (if any) and visit multiple files. You can
1399 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1401 To visit a file without any kind of conversion and without
1402 automatically choosing a major mode, use \\[find-file-literally]."
1404 (find-file-read-args "Find file: "
1405 (confirm-nonexistent-file-or-buffer)))
1406 (let ((value (find-file-noselect filename nil nil wildcards
)))
1408 (mapcar 'switch-to-buffer
(nreverse value
))
1409 (switch-to-buffer value
))))
1411 (defun find-file-other-window (filename &optional wildcards
)
1412 "Edit file FILENAME, in another window.
1414 Like \\[find-file] (which see), but creates a new window or reuses
1415 an existing one. See the function `display-buffer'.
1417 Interactively, the default if you just type RET is the current directory,
1418 but the visited file name is available through the minibuffer history:
1419 type M-n to pull it into the minibuffer.
1421 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1422 expand wildcards (if any) and visit multiple files."
1424 (find-file-read-args "Find file in other window: "
1425 (confirm-nonexistent-file-or-buffer)))
1426 (let ((value (find-file-noselect filename nil nil wildcards
)))
1429 (setq value
(nreverse value
))
1430 (cons (switch-to-buffer-other-window (car value
))
1431 (mapcar 'switch-to-buffer
(cdr value
))))
1432 (switch-to-buffer-other-window value
))))
1434 (defun find-file-other-frame (filename &optional wildcards
)
1435 "Edit file FILENAME, in another frame.
1437 Like \\[find-file] (which see), but creates a new frame or reuses
1438 an existing one. See the function `display-buffer'.
1440 Interactively, the default if you just type RET is the current directory,
1441 but the visited file name is available through the minibuffer history:
1442 type M-n to pull it into the minibuffer.
1444 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1445 expand wildcards (if any) and visit multiple files."
1447 (find-file-read-args "Find file in other frame: "
1448 (confirm-nonexistent-file-or-buffer)))
1449 (let ((value (find-file-noselect filename nil nil wildcards
)))
1452 (setq value
(nreverse value
))
1453 (cons (switch-to-buffer-other-frame (car value
))
1454 (mapcar 'switch-to-buffer
(cdr value
))))
1455 (switch-to-buffer-other-frame value
))))
1457 (defun find-file-existing (filename)
1458 "Edit the existing file FILENAME.
1459 Like \\[find-file], but only allow a file that exists, and do not allow
1460 file names with wildcards."
1461 (interactive (nbutlast (find-file-read-args "Find existing file: " t
)))
1462 (if (and (not (called-interactively-p 'interactive
))
1463 (not (file-exists-p filename
)))
1464 (error "%s does not exist" filename
)
1465 (find-file filename
)
1468 (defun find-file--read-only (fun filename wildcards
)
1469 (unless (or (and wildcards find-file-wildcards
1470 (not (string-match "\\`/:" filename
))
1471 (string-match "[[*?]" filename
))
1472 (file-exists-p filename
))
1473 (error "%s does not exist" filename
))
1474 (let ((value (funcall fun filename wildcards
)))
1475 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1476 (if (listp value
) value
(list value
)))
1479 (defun find-file-read-only (filename &optional wildcards
)
1480 "Edit file FILENAME but don't allow changes.
1481 Like \\[find-file], but marks buffer as read-only.
1482 Use \\[toggle-read-only] to permit editing."
1484 (find-file-read-args "Find file read-only: "
1485 (confirm-nonexistent-file-or-buffer)))
1486 (find-file--read-only #'find-file filename wildcards
))
1488 (defun find-file-read-only-other-window (filename &optional wildcards
)
1489 "Edit file FILENAME in another window but don't allow changes.
1490 Like \\[find-file-other-window], but marks buffer as read-only.
1491 Use \\[toggle-read-only] to permit editing."
1493 (find-file-read-args "Find file read-only other window: "
1494 (confirm-nonexistent-file-or-buffer)))
1495 (find-file--read-only #'find-file-other-window filename wildcards
))
1497 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1498 "Edit file FILENAME in another frame but don't allow changes.
1499 Like \\[find-file-other-frame], but marks buffer as read-only.
1500 Use \\[toggle-read-only] to permit editing."
1502 (find-file-read-args "Find file read-only other frame: "
1503 (confirm-nonexistent-file-or-buffer)))
1504 (find-file--read-only #'find-file-other-frame filename wildcards
))
1506 (defun find-alternate-file-other-window (filename &optional wildcards
)
1507 "Find file FILENAME as a replacement for the file in the next window.
1508 This command does not select that window.
1510 See \\[find-file] for the possible forms of the FILENAME argument.
1512 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1513 expand wildcards (if any) and replace the file with multiple files."
1515 (save-selected-window
1517 (let ((file buffer-file-name
)
1521 (setq file-name
(file-name-nondirectory file
)
1522 file-dir
(file-name-directory file
)))
1523 (list (read-file-name
1524 "Find alternate file: " file-dir nil
1525 (confirm-nonexistent-file-or-buffer) file-name
)
1528 (find-file-other-window filename wildcards
)
1529 (save-selected-window
1531 (find-alternate-file filename wildcards
))))
1533 (defvar kill-buffer-hook
) ; from buffer.c
1535 (defun find-alternate-file (filename &optional wildcards
)
1536 "Find file FILENAME, select its buffer, kill previous buffer.
1537 If the current buffer now contains an empty file that you just visited
1538 \(presumably by mistake), use this command to visit the file you really want.
1540 See \\[find-file] for the possible forms of the FILENAME argument.
1542 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1543 expand wildcards (if any) and replace the file with multiple files.
1545 If the current buffer is an indirect buffer, or the base buffer
1546 for one or more indirect buffers, the other buffer(s) are not
1549 (let ((file buffer-file-name
)
1553 (setq file-name
(file-name-nondirectory file
)
1554 file-dir
(file-name-directory file
)))
1555 (list (read-file-name
1556 "Find alternate file: " file-dir nil
1557 (confirm-nonexistent-file-or-buffer) file-name
)
1559 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1561 (when (and (buffer-modified-p) buffer-file-name
)
1562 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1565 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1566 (error "Aborted"))))
1567 (let ((obuf (current-buffer))
1568 (ofile buffer-file-name
)
1569 (onum buffer-file-number
)
1570 (odir dired-directory
)
1571 (otrue buffer-file-truename
)
1572 (oname (buffer-name)))
1573 ;; Run `kill-buffer-hook' here. It needs to happen before
1574 ;; variables like `buffer-file-name' etc are set to nil below,
1575 ;; because some of the hooks that could be invoked
1576 ;; (e.g., `save-place-to-alist') depend on those variables.
1578 ;; Note that `kill-buffer-hook' is not what queries whether to
1579 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1580 ;; asks that itself. Thus, there's no need to temporarily do
1581 ;; `(set-buffer-modified-p nil)' before running this hook.
1582 (run-hooks 'kill-buffer-hook
)
1583 ;; Okay, now we can end-of-life the old buffer.
1584 (if (get-buffer " **lose**")
1585 (kill-buffer " **lose**"))
1586 (rename-buffer " **lose**")
1590 ;; This prevents us from finding the same buffer
1591 ;; if we specified the same file again.
1592 (setq buffer-file-name nil
)
1593 (setq buffer-file-number nil
)
1594 (setq buffer-file-truename nil
)
1595 ;; Likewise for dired buffers.
1596 (setq dired-directory nil
)
1597 (find-file filename wildcards
))
1598 (when (eq obuf
(current-buffer))
1599 ;; This executes if find-file gets an error
1600 ;; and does not really find anything.
1601 ;; We put things back as they were.
1602 ;; If find-file actually finds something, we kill obuf below.
1603 (setq buffer-file-name ofile
)
1604 (setq buffer-file-number onum
)
1605 (setq buffer-file-truename otrue
)
1606 (setq dired-directory odir
)
1608 (rename-buffer oname
)))
1609 (unless (eq (current-buffer) obuf
)
1610 (with-current-buffer obuf
1611 ;; We already ran these; don't run them again.
1612 (let (kill-buffer-query-functions kill-buffer-hook
)
1613 (kill-buffer obuf
))))))
1615 (defun create-file-buffer (filename)
1616 "Create a suitably named buffer for visiting FILENAME, and return it.
1617 FILENAME (sans directory) is used unchanged if that name is free;
1618 otherwise a string <2> or <3> or ... is appended to get an unused name.
1619 Spaces at the start of FILENAME (sans directory) are removed."
1620 (let ((lastname (file-name-nondirectory filename
)))
1621 (if (string= lastname
"")
1622 (setq lastname filename
))
1624 (string-match "^ *\\(.*\\)" lastname
)
1625 (generate-new-buffer (match-string 1 lastname
)))))
1627 (defun generate-new-buffer (name)
1628 "Create and return a buffer with a name based on NAME.
1629 Choose the buffer's name using `generate-new-buffer-name'."
1630 (get-buffer-create (generate-new-buffer-name name
)))
1632 (defcustom automount-dir-prefix
(purecopy "^/tmp_mnt/")
1633 "Regexp to match the automounter prefix in a directory name."
1636 (make-obsolete-variable 'automount-dir-prefix
'directory-abbrev-alist
"24.2")
1638 (defvar abbreviated-home-dir nil
1639 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1641 (defun abbreviate-file-name (filename)
1642 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1643 This also substitutes \"~\" for the user's home directory (unless the
1644 home directory is a root directory) and removes automounter prefixes
1645 \(see the variable `automount-dir-prefix')."
1646 ;; Get rid of the prefixes added by the automounter.
1648 (if (and automount-dir-prefix
1649 (string-match automount-dir-prefix filename
)
1650 (file-exists-p (file-name-directory
1651 (substring filename
(1- (match-end 0))))))
1652 (setq filename
(substring filename
(1- (match-end 0)))))
1653 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1654 ;; To fix this right, we need a `file-name-case-sensitive-p'
1655 ;; function, but we don't have that yet, so just guess.
1656 (let ((case-fold-search
1657 (memq system-type
'(ms-dos windows-nt darwin cygwin
))))
1658 ;; If any elt of directory-abbrev-alist matches this name,
1659 ;; abbreviate accordingly.
1660 (dolist (dir-abbrev directory-abbrev-alist
)
1661 (if (string-match (car dir-abbrev
) filename
)
1663 (concat (cdr dir-abbrev
)
1664 (substring filename
(match-end 0))))))
1665 ;; Compute and save the abbreviated homedir name.
1666 ;; We defer computing this until the first time it's needed, to
1667 ;; give time for directory-abbrev-alist to be set properly.
1668 ;; We include a slash at the end, to avoid spurious matches
1669 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1670 (or abbreviated-home-dir
1671 (setq abbreviated-home-dir
1672 (let ((abbreviated-home-dir "$foo"))
1673 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1676 ;; If FILENAME starts with the abbreviated homedir,
1677 ;; make it start with `~' instead.
1678 (if (and (string-match abbreviated-home-dir filename
)
1679 ;; If the home dir is just /, don't change it.
1680 (not (and (= (match-end 0) 1)
1681 (= (aref filename
0) ?
/)))
1682 ;; MS-DOS root directories can come with a drive letter;
1683 ;; Novell Netware allows drive letters beyond `Z:'.
1684 (not (and (memq system-type
'(ms-dos windows-nt cygwin
))
1686 (string-match "^[a-zA-`]:/$" filename
)))))
1689 (match-string 1 filename
)
1690 (substring filename
(match-end 0)))))
1693 (defun find-buffer-visiting (filename &optional predicate
)
1694 "Return the buffer visiting file FILENAME (a string).
1695 This is like `get-file-buffer', except that it checks for any buffer
1696 visiting the same file, possibly under a different name.
1697 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1698 and others are ignored.
1699 If there is no such live buffer, return nil."
1700 (let ((predicate (or predicate
#'identity
))
1701 (truename (abbreviate-file-name (file-truename filename
))))
1702 (or (let ((buf (get-file-buffer filename
)))
1703 (when (and buf
(funcall predicate buf
)) buf
))
1704 (let ((list (buffer-list)) found
)
1705 (while (and (not found
) list
)
1706 (with-current-buffer (car list
)
1707 (if (and buffer-file-name
1708 (string= buffer-file-truename truename
)
1709 (funcall predicate
(current-buffer)))
1710 (setq found
(car list
))))
1711 (setq list
(cdr list
)))
1713 (let* ((attributes (file-attributes truename
))
1714 (number (nthcdr 10 attributes
))
1715 (list (buffer-list)) found
)
1716 (and buffer-file-numbers-unique
1717 (car-safe number
) ;Make sure the inode is not just nil.
1718 (while (and (not found
) list
)
1719 (with-current-buffer (car list
)
1720 (if (and buffer-file-name
1721 (equal buffer-file-number number
)
1722 ;; Verify this buffer's file number
1723 ;; still belongs to its file.
1724 (file-exists-p buffer-file-name
)
1725 (equal (file-attributes buffer-file-truename
)
1727 (funcall predicate
(current-buffer)))
1728 (setq found
(car list
))))
1729 (setq list
(cdr list
))))
1732 (defcustom find-file-wildcards t
1733 "Non-nil means file-visiting commands should handle wildcards.
1734 For example, if you specify `*.c', that would visit all the files
1735 whose names match the pattern."
1740 (defcustom find-file-suppress-same-file-warnings nil
1741 "Non-nil means suppress warning messages for symlinked files.
1742 When nil, Emacs prints a warning when visiting a file that is already
1743 visited, but with a different name. Setting this option to t
1744 suppresses this warning."
1749 (defcustom large-file-warning-threshold
10000000
1750 "Maximum size of file above which a confirmation is requested.
1751 When nil, never request confirmation."
1755 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1757 (defun abort-if-file-too-large (size op-type filename
)
1758 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1759 OP-TYPE specifies the file operation being performed (for message to user)."
1760 (when (and large-file-warning-threshold size
1761 (> size large-file-warning-threshold
)
1762 (not (y-or-n-p (format "File %s is large (%s), really %s? "
1763 (file-name-nondirectory filename
)
1764 (file-size-human-readable size
) op-type
))))
1767 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1768 "Read file FILENAME into a buffer and return the buffer.
1769 If a buffer exists visiting FILENAME, return that one, but
1770 verify that the file has not changed since visited or saved.
1771 The buffer is not selected, just returned to the caller.
1772 Optional second arg NOWARN non-nil means suppress any warning messages.
1773 Optional third arg RAWFILE non-nil means the file is read literally.
1774 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1775 and visit all the matching files. When wildcards are actually
1776 used and expanded, return a list of buffers that are visiting
1779 (abbreviate-file-name
1780 (expand-file-name filename
)))
1781 (if (file-directory-p filename
)
1782 (or (and find-file-run-dired
1783 (run-hook-with-args-until-success
1784 'find-directory-functions
1785 (if find-file-visit-truename
1786 (abbreviate-file-name (file-truename filename
))
1788 (error "%s is a directory" filename
))
1791 (not (string-match "\\`/:" filename
))
1792 (string-match "[[*?]" filename
))
1793 (let ((files (condition-case nil
1794 (file-expand-wildcards filename t
)
1795 (error (list filename
))))
1796 (find-file-wildcards nil
))
1798 (find-file-noselect filename
)
1799 (mapcar #'find-file-noselect files
)))
1800 (let* ((buf (get-file-buffer filename
))
1801 (truename (abbreviate-file-name (file-truename filename
)))
1802 (attributes (file-attributes truename
))
1803 (number (nthcdr 10 attributes
))
1804 ;; Find any buffer for a file which has same truename.
1805 (other (and (not buf
) (find-buffer-visiting filename
))))
1806 ;; Let user know if there is a buffer with the same truename.
1810 find-file-suppress-same-file-warnings
1811 (string-equal filename
(buffer-file-name other
))
1812 (message "%s and %s are the same file"
1813 filename
(buffer-file-name other
)))
1814 ;; Optionally also find that buffer.
1815 (if (or find-file-existing-other-name find-file-visit-truename
)
1817 ;; Check to see if the file looks uncommonly large.
1818 (when (not (or buf nowarn
))
1819 (abort-if-file-too-large (nth 7 attributes
) "open" filename
))
1821 ;; We are using an existing buffer.
1824 (verify-visited-file-modtime buf
)
1825 (cond ((not (file-exists-p filename
))
1826 (setq nonexistent t
)
1827 (message "File %s no longer exists!" filename
))
1828 ;; Certain files should be reverted automatically
1829 ;; if they have changed on disk and not in the buffer.
1830 ((and (not (buffer-modified-p buf
))
1831 (let ((tail revert-without-query
)
1834 (if (string-match (car tail
) filename
)
1836 (setq tail
(cdr tail
)))
1838 (with-current-buffer buf
1839 (message "Reverting file %s..." filename
)
1841 (message "Reverting file %s...done" filename
)))
1843 (if (string= (file-name-nondirectory filename
)
1846 (if (buffer-modified-p buf
)
1847 "File %s changed on disk. Discard your edits? "
1848 "File %s changed on disk. Reread from disk? ")
1849 (file-name-nondirectory filename
))
1851 (if (buffer-modified-p buf
)
1852 "File %s changed on disk. Discard your edits in %s? "
1853 "File %s changed on disk. Reread from disk into %s? ")
1854 (file-name-nondirectory filename
)
1855 (buffer-name buf
))))
1856 (with-current-buffer buf
1857 (revert-buffer t t
)))))
1858 (with-current-buffer buf
1860 ;; Check if a formerly read-only file has become
1861 ;; writable and vice versa, but if the buffer agrees
1862 ;; with the new state of the file, that is ok too.
1863 (let ((read-only (not (file-writable-p buffer-file-name
))))
1864 (unless (or nonexistent
1865 (eq read-only buffer-file-read-only
)
1866 (eq read-only buffer-read-only
))
1869 (format "File %s is %s on disk. Change buffer mode? "
1871 (if read-only
"read-only" "writable"))))
1872 (y-or-n-p question
)))
1873 (setq buffer-read-only read-only
)))
1874 (setq buffer-file-read-only read-only
))
1876 (when (and (not (eq (not (null rawfile
))
1877 (not (null find-file-literally
))))
1879 ;; It is confusing to ask whether to visit
1880 ;; non-literally if they have the file in
1881 ;; hexl-mode or image-mode.
1882 (not (memq major-mode
'(hexl-mode image-mode
))))
1883 (if (buffer-modified-p)
1887 "The file %s is already visited normally,
1888 and you have edited the buffer. Now you have asked to visit it literally,
1889 meaning no coding system handling, format conversion, or local variables.
1890 Emacs can only visit a file in one way at a time.
1892 Do you want to save the file, and visit it literally instead? "
1893 "The file %s is already visited literally,
1894 meaning no coding system handling, format conversion, or local variables.
1895 You have edited the buffer. Now you have asked to visit the file normally,
1896 but Emacs can only visit a file in one way at a time.
1898 Do you want to save the file, and visit it normally instead? ")
1899 (file-name-nondirectory filename
)))
1902 (find-file-noselect-1 buf filename nowarn
1903 rawfile truename number
))
1908 Do you want to discard your changes, and visit the file literally now? "
1910 Do you want to discard your changes, and visit the file normally now? ")))
1911 (find-file-noselect-1 buf filename nowarn
1912 rawfile truename number
)
1913 (error (if rawfile
"File already visited non-literally"
1914 "File already visited literally"))))
1918 "The file %s is already visited normally.
1919 You have asked to visit it literally,
1920 meaning no coding system decoding, format conversion, or local variables.
1921 But Emacs can only visit a file in one way at a time.
1923 Do you want to revisit the file literally now? "
1924 "The file %s is already visited literally,
1925 meaning no coding system decoding, format conversion, or local variables.
1926 You have asked to visit it normally,
1927 but Emacs can only visit a file in one way at a time.
1929 Do you want to revisit the file normally now? ")
1930 (file-name-nondirectory filename
)))
1931 (find-file-noselect-1 buf filename nowarn
1932 rawfile truename number
)
1933 (error (if rawfile
"File already visited non-literally"
1934 "File already visited literally"))))))
1935 ;; Return the buffer we are using.
1937 ;; Create a new buffer.
1938 (setq buf
(create-file-buffer filename
))
1939 ;; find-file-noselect-1 may use a different buffer.
1940 (find-file-noselect-1 buf filename nowarn
1941 rawfile truename number
))))))
1943 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1945 (with-current-buffer buf
1946 (kill-local-variable 'find-file-literally
)
1947 ;; Needed in case we are re-visiting the file with a different
1948 ;; text representation.
1949 (kill-local-variable 'buffer-file-coding-system
)
1950 (kill-local-variable 'cursor-type
)
1951 (let ((inhibit-read-only t
))
1953 (and (default-value 'enable-multibyte-characters
)
1955 (set-buffer-multibyte t
))
1958 (let ((inhibit-read-only t
))
1959 (insert-file-contents-literally filename t
))
1961 (when (and (file-exists-p filename
)
1962 (not (file-readable-p filename
)))
1964 (signal 'file-error
(list "File is not readable"
1966 ;; Unconditionally set error
1969 (let ((inhibit-read-only t
))
1970 (insert-file-contents filename t
))
1972 (when (and (file-exists-p filename
)
1973 (not (file-readable-p filename
)))
1975 (signal 'file-error
(list "File is not readable"
1977 ;; Run find-file-not-found-functions until one returns non-nil.
1978 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1979 ;; If they fail too, set error.
1981 ;; Record the file's truename, and maybe use that as visited name.
1982 (if (equal filename buffer-file-name
)
1983 (setq buffer-file-truename truename
)
1984 (setq buffer-file-truename
1985 (abbreviate-file-name (file-truename buffer-file-name
))))
1986 (setq buffer-file-number number
)
1987 (if find-file-visit-truename
1988 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
1989 ;; Set buffer's default directory to that of the file.
1990 (setq default-directory
(file-name-directory buffer-file-name
))
1991 ;; Turn off backup files for certain file names. Since
1992 ;; this is a permanent local, the major mode won't eliminate it.
1993 (and backup-enable-predicate
1994 (not (funcall backup-enable-predicate buffer-file-name
))
1996 (make-local-variable 'backup-inhibited
)
1997 (setq backup-inhibited t
)))
2000 (set-buffer-multibyte nil
)
2001 (setq buffer-file-coding-system
'no-conversion
)
2002 (set-buffer-major-mode buf
)
2003 (make-local-variable 'find-file-literally
)
2004 (setq find-file-literally t
))
2005 (after-find-file error
(not nowarn
)))
2008 (defvar file-name-buffer-file-type-alist
) ;From dos-w32.el.
2010 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
2011 "Like `insert-file-contents', but only reads in the file literally.
2012 A buffer may be modified in several ways after reading into the buffer,
2013 to Emacs features such as format decoding, character code
2014 conversion, `find-file-hook', automatic uncompression, etc.
2016 This function ensures that none of these modifications will take place."
2017 (let ((format-alist nil
)
2018 (after-insert-file-functions nil
)
2019 (coding-system-for-read 'no-conversion
)
2020 (coding-system-for-write 'no-conversion
)
2021 (file-name-buffer-file-type-alist '(("" . t
)))
2022 (inhibit-file-name-handlers
2023 ;; FIXME: Yuck!! We should turn insert-file-contents-literally
2024 ;; into a file operation instead!
2025 (append '(jka-compr-handler image-file-handler epa-file-handler
)
2026 inhibit-file-name-handlers
))
2027 (inhibit-file-name-operation 'insert-file-contents
))
2028 (insert-file-contents filename visit beg end replace
)))
2030 (defun insert-file-1 (filename insert-func
)
2031 (if (file-directory-p filename
)
2032 (signal 'file-error
(list "Opening input file" "file is a directory"
2034 ;; Check whether the file is uncommonly large
2035 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert" filename
)
2036 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
2037 #'buffer-modified-p
))
2038 (tem (funcall insert-func filename
)))
2039 (push-mark (+ (point) (car (cdr tem
))))
2041 (message "File %s already visited and modified in buffer %s"
2042 filename
(buffer-name buffer
)))))
2044 (defun insert-file-literally (filename)
2045 "Insert contents of file FILENAME into buffer after point with no conversion.
2047 This function is meant for the user to run interactively.
2048 Don't call it from programs! Use `insert-file-contents-literally' instead.
2049 \(Its calling sequence is different; see its documentation)."
2050 (interactive "*fInsert file literally: ")
2051 (insert-file-1 filename
#'insert-file-contents-literally
))
2053 (defvar find-file-literally nil
2054 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2055 This has the `permanent-local' property, which takes effect if you
2056 make the variable buffer-local.")
2057 (put 'find-file-literally
'permanent-local t
)
2059 (defun find-file-literally (filename)
2060 "Visit file FILENAME with no conversion of any kind.
2061 Format conversion and character code conversion are both disabled,
2062 and multibyte characters are disabled in the resulting buffer.
2063 The major mode used is Fundamental mode regardless of the file name,
2064 and local variable specifications in the file are ignored.
2065 Automatic uncompression and adding a newline at the end of the
2066 file due to `require-final-newline' is also disabled.
2068 You cannot absolutely rely on this function to result in
2069 visiting the file literally. If Emacs already has a buffer
2070 which is visiting the file, you get the existing buffer,
2071 regardless of whether it was created literally or not.
2073 In a Lisp program, if you want to be sure of accessing a file's
2074 contents literally, you should create a temporary buffer and then read
2075 the file contents into it using `insert-file-contents-literally'."
2077 (list (read-file-name
2078 "Find file literally: " nil default-directory
2079 (confirm-nonexistent-file-or-buffer))))
2080 (switch-to-buffer (find-file-noselect filename nil t
)))
2082 (defun after-find-file (&optional error warn noauto
2083 _after-find-file-from-revert-buffer
2085 "Called after finding a file and by the default revert function.
2086 Sets buffer mode, parses local variables.
2087 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2088 error in reading the file. WARN non-nil means warn if there
2089 exists an auto-save file more recent than the visited file.
2090 NOAUTO means don't mess with auto-save mode.
2091 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2092 \(see `revert-buffer-in-progress-p' for similar functionality).
2093 Fifth arg NOMODES non-nil means don't alter the file's modes.
2094 Finishes by calling the functions in `find-file-hook'
2095 unless NOMODES is non-nil."
2096 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
2103 ((and error
(file-attributes buffer-file-name
))
2104 (setq buffer-read-only t
)
2105 (if (and (file-symlink-p buffer-file-name
)
2107 (file-chase-links buffer-file-name
))))
2108 "Symbolic link that points to nonexistent file"
2109 "File exists, but cannot be read"))
2110 ((not buffer-read-only
)
2112 ;; No need to warn if buffer is auto-saved
2113 ;; under the name of the visited file.
2114 (not (and buffer-file-name
2115 auto-save-visited-file-name
))
2116 (file-newer-than-file-p (or buffer-auto-save-file-name
2117 (make-auto-save-file-name))
2119 (format "%s has auto save data; consider M-x recover-this-file"
2120 (file-name-nondirectory buffer-file-name
))
2121 (setq not-serious t
)
2122 (if error
"(New file)" nil
)))
2124 (setq not-serious t
)
2125 "Note: file is write protected")
2126 ((file-attributes (directory-file-name default-directory
))
2127 "File not found and directory write-protected")
2128 ((file-exists-p (file-name-directory buffer-file-name
))
2129 (setq buffer-read-only nil
))
2131 (setq buffer-read-only nil
)
2132 "Use M-x make-directory RET RET to create the directory and its parents"))))
2135 (or not-serious
(sit-for 1 t
))))
2136 (when (and auto-save-default
(not noauto
))
2137 (auto-save-mode 1)))
2138 ;; Make people do a little extra work (C-x C-q)
2139 ;; before altering a backup file.
2140 (when (backup-file-name-p buffer-file-name
)
2141 (setq buffer-read-only t
))
2142 ;; When a file is marked read-only,
2143 ;; make the buffer read-only even if root is looking at it.
2144 (when (and (file-modes (buffer-file-name))
2145 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
2146 (setq buffer-read-only t
))
2148 (when (and view-read-only view-mode
)
2149 (view-mode-disable))
2151 ;; If requested, add a newline at the end of the file.
2152 (and (memq require-final-newline
'(visit visit-save
))
2153 (> (point-max) (point-min))
2154 (/= (char-after (1- (point-max))) ?
\n)
2155 (not (and (eq selective-display t
)
2156 (= (char-after (1- (point-max))) ?
\r)))
2157 (not buffer-read-only
)
2159 (goto-char (point-max))
2161 (when (and buffer-read-only
2163 (not (eq (get major-mode
'mode-class
) 'special
)))
2165 (run-hooks 'find-file-hook
)))
2167 (defmacro report-errors
(format &rest body
)
2168 "Eval BODY and turn any error into a FORMAT message.
2169 FORMAT can have a %s escape which will be replaced with the actual error.
2170 If `debug-on-error' is set, errors are not caught, so that you can
2172 Avoid using a large BODY since it is duplicated."
2173 (declare (debug t
) (indent 1))
2178 (error (message ,format
(prin1-to-string err
))))))
2180 (defun normal-mode (&optional find-file
)
2181 "Choose the major mode for this buffer automatically.
2182 Also sets up any specified local variables of the file.
2183 Uses the visited file name, the -*- line, and the local variables spec.
2185 This function is called automatically from `find-file'. In that case,
2186 we may set up the file-specified mode and local variables,
2187 depending on the value of `enable-local-variables'.
2188 In addition, if `local-enable-local-variables' is nil, we do
2189 not set local variables (though we do notice a mode specified with -*-.)
2191 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2192 or from Lisp without specifying the optional argument FIND-FILE;
2193 in that case, this function acts as if `enable-local-variables' were t."
2195 (funcall (or (default-value 'major-mode
) 'fundamental-mode
))
2196 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
2197 ;; FIXME this is less efficient than it could be, since both
2198 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2199 (report-errors "File mode specification error: %s"
2201 (report-errors "File local-variables error: %s"
2202 (hack-local-variables)))
2203 ;; Turn font lock off and on, to make sure it takes account of
2204 ;; whatever file local variables are relevant to it.
2205 (when (and font-lock-mode
2206 ;; Font-lock-mode (now in font-core.el) can be ON when
2207 ;; font-lock.el still hasn't been loaded.
2208 (boundp 'font-lock-keywords
)
2209 (eq (car font-lock-keywords
) t
))
2210 (setq font-lock-keywords
(cadr font-lock-keywords
))
2211 (font-lock-mode 1)))
2213 (defcustom auto-mode-case-fold t
2214 "Non-nil means to try second pass through `auto-mode-alist'.
2215 This means that if the first case-sensitive search through the alist fails
2216 to find a matching major mode, a second case-insensitive search is made.
2217 On systems with case-insensitive file names, this variable is ignored,
2218 since only a single case-insensitive search through the alist is made."
2223 (defvar auto-mode-alist
2224 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2225 ;; c++-mode, java-mode and more) are added through autoload
2226 ;; directives in that file. That way is discouraged since it
2227 ;; spreads out the definition of the initial value.
2230 (cons (purecopy (car elt
)) (cdr elt
)))
2231 `(;; do this first, so that .html.pl is Polish html, not Perl
2232 ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2233 ("\\.svgz?\\'" . image-mode
)
2234 ("\\.svgz?\\'" . xml-mode
)
2235 ("\\.x[bp]m\\'" . image-mode
)
2236 ("\\.x[bp]m\\'" . c-mode
)
2237 ("\\.p[bpgn]m\\'" . image-mode
)
2238 ("\\.tiff?\\'" . image-mode
)
2239 ("\\.gif\\'" . image-mode
)
2240 ("\\.png\\'" . image-mode
)
2241 ("\\.jpe?g\\'" . image-mode
)
2242 ("\\.te?xt\\'" . text-mode
)
2243 ("\\.[tT]e[xX]\\'" . tex-mode
)
2244 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2245 ("\\.ltx\\'" . latex-mode
)
2246 ("\\.dtx\\'" . doctex-mode
)
2247 ("\\.org\\'" . org-mode
)
2248 ("\\.el\\'" . emacs-lisp-mode
)
2249 ("Project\\.ede\\'" . emacs-lisp-mode
)
2250 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2251 ("\\.l\\'" . lisp-mode
)
2252 ("\\.li?sp\\'" . lisp-mode
)
2253 ("\\.[fF]\\'" . fortran-mode
)
2254 ("\\.for\\'" . fortran-mode
)
2255 ("\\.p\\'" . pascal-mode
)
2256 ("\\.pas\\'" . pascal-mode
)
2257 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode
)
2258 ("\\.ad[abs]\\'" . ada-mode
)
2259 ("\\.ad[bs].dg\\'" . ada-mode
)
2260 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2261 ("Imakefile\\'" . makefile-imake-mode
)
2262 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2263 ("\\.makepp\\'" . makefile-makepp-mode
)
2264 ,@(if (memq system-type
'(berkeley-unix darwin
))
2265 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2266 ("\\.make\\'" . makefile-bsdmake-mode
)
2267 ("GNUmakefile\\'" . makefile-gmake-mode
)
2268 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2269 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2270 ("\\.make\\'" . makefile-gmake-mode
)
2271 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2272 ("\\.am\\'" . makefile-automake-mode
)
2273 ;; Less common extensions come here
2274 ;; so more common ones above are found faster.
2275 ("\\.texinfo\\'" . texinfo-mode
)
2276 ("\\.te?xi\\'" . texinfo-mode
)
2277 ("\\.[sS]\\'" . asm-mode
)
2278 ("\\.asm\\'" . asm-mode
)
2279 ("\\.css\\'" . css-mode
)
2280 ("\\.mixal\\'" . mixal-mode
)
2281 ("\\.gcov\\'" . compilation-mode
)
2282 ;; Besides .gdbinit, gdb documents other names to be usable for init
2283 ;; files, cross-debuggers can use something like
2284 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2285 ;; don't interfere with each other.
2286 ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode
)
2287 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2288 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2289 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2290 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2291 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2292 ("\\.bash\\'" . sh-mode
)
2293 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2294 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2295 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2296 ("\\.m?spec\\'" . sh-mode
)
2297 ("\\.m[mes]\\'" . nroff-mode
)
2298 ("\\.man\\'" . nroff-mode
)
2299 ("\\.sty\\'" . latex-mode
)
2300 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2301 ("\\.bbl\\'" . latex-mode
)
2302 ("\\.bib\\'" . bibtex-mode
)
2303 ("\\.bst\\'" . bibtex-style-mode
)
2304 ("\\.sql\\'" . sql-mode
)
2305 ("\\.m[4c]\\'" . m4-mode
)
2306 ("\\.mf\\'" . metafont-mode
)
2307 ("\\.mp\\'" . metapost-mode
)
2308 ("\\.vhdl?\\'" . vhdl-mode
)
2309 ("\\.article\\'" . text-mode
)
2310 ("\\.letter\\'" . text-mode
)
2311 ("\\.i?tcl\\'" . tcl-mode
)
2312 ("\\.exp\\'" . tcl-mode
)
2313 ("\\.itk\\'" . tcl-mode
)
2314 ("\\.icn\\'" . icon-mode
)
2315 ("\\.sim\\'" . simula-mode
)
2316 ("\\.mss\\'" . scribe-mode
)
2317 ;; The Fortran standard does not say anything about file extensions.
2318 ;; .f90 was widely used for F90, now we seem to be trapped into
2319 ;; using a different extension for each language revision.
2320 ;; Anyway, the following extensions are supported by gfortran.
2321 ("\\.f9[05]\\'" . f90-mode
)
2322 ("\\.f0[38]\\'" . f90-mode
)
2323 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2324 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode
)
2325 ("\\.srt\\'" . srecode-template-mode
)
2326 ("\\.prolog\\'" . prolog-mode
)
2327 ("\\.tar\\'" . tar-mode
)
2328 ;; The list of archive file extensions should be in sync with
2329 ;; `auto-coding-alist' with `no-conversion' coding system.
2331 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2332 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode
)
2333 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode
) ;OpenOffice.org
2334 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode
) ; Debian/Opkg packages.
2335 ;; Mailer puts message to be edited in
2336 ;; /tmp/Re.... or Message
2337 ("\\`/tmp/Re" . text-mode
)
2338 ("/Message[0-9]*\\'" . text-mode
)
2339 ;; some news reader is reported to use this
2340 ("\\`/tmp/fol/" . text-mode
)
2341 ("\\.oak\\'" . scheme-mode
)
2342 ("\\.sgml?\\'" . sgml-mode
)
2343 ("\\.x[ms]l\\'" . xml-mode
)
2344 ("\\.dbk\\'" . xml-mode
)
2345 ("\\.dtd\\'" . sgml-mode
)
2346 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2347 ("\\.js\\'" . javascript-mode
)
2348 ("\\.json\\'" . javascript-mode
)
2349 ("\\.[ds]?vh?\\'" . verilog-mode
)
2350 ;; .emacs or .gnus or .viper following a directory delimiter in
2351 ;; Unix, MSDOG or VMS syntax.
2352 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2353 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2354 ;; _emacs following a directory delimiter
2356 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2357 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2358 ("\\.ml\\'" . lisp-mode
)
2359 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2360 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2361 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2362 ("\\.ld[si]?\\'" . ld-script-mode
)
2363 ("ld\\.?script\\'" . ld-script-mode
)
2364 ;; .xs is also used for ld scripts, but seems to be more commonly
2365 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2366 ("\\.xs\\'" . c-mode
)
2367 ;; Explained in binutils ld/genscripts.sh. Eg:
2368 ;; A .x script file is the default script.
2369 ;; A .xr script is for linking without relocation (-r flag). Etc.
2370 ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode
)
2371 ("\\.zone\\'" . dns-mode
)
2372 ("\\.soa\\'" . dns-mode
)
2373 ;; Common Lisp ASDF package system.
2374 ("\\.asd\\'" . lisp-mode
)
2375 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2376 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2377 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2378 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2379 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2380 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe
)
2381 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2382 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode
)
2383 ("BROWSE\\'" . ebrowse-tree-mode
)
2384 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2385 ("#\\*mail\\*" . mail-mode
)
2386 ("\\.g\\'" . antlr-mode
)
2387 ("\\.mod\\'" . m2-mode
)
2388 ("\\.ses\\'" . ses-mode
)
2389 ("\\.docbook\\'" . sgml-mode
)
2390 ("\\.com\\'" . dcl-mode
)
2391 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2392 ;; Windows candidates may be opened case sensitively on Unix
2393 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2394 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2395 ("\\.ppd\\'" . conf-ppd-mode
)
2396 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2397 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2398 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2399 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2400 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2401 ;; this has lower priority to avoid matching changelog.sgml etc.
2402 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2403 ;; either user's dot-files or under /etc or some such
2404 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2405 ;; alas not all ~/.*rc files are like this
2406 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2407 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2408 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2409 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2410 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2411 ;; this contains everything twice, with space and with colon :-(
2412 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2413 ;; Get rid of any trailing .n.m and try again.
2414 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2415 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2416 ;; Using mode nil rather than `ignore' would let the search continue
2417 ;; through this list (with the shortened name) rather than start over.
2418 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2419 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)
2420 ;; This should come after "in" stripping (e.g. config.h.in).
2421 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2422 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2423 ;; The following should come after the ChangeLog pattern
2424 ;; for the sake of ChangeLog.1, etc.
2425 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2426 ("\\.[1-9]\\'" . nroff-mode
)))
2427 "Alist of filename patterns vs corresponding major mode functions.
2428 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2429 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2430 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2431 mode function to use. FUNCTION will be called, unless it is nil.
2433 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2434 calling FUNCTION (if it's not nil), we delete the suffix that matched
2435 REGEXP and search the list again for another match.
2437 The extensions whose FUNCTION is `archive-mode' should also
2438 appear in `auto-coding-alist' with `no-conversion' coding system.
2440 See also `interpreter-mode-alist', which detects executable script modes
2441 based on the interpreters they specify to run,
2442 and `magic-mode-alist', which determines modes based on file contents.")
2443 (put 'auto-mode-alist
'risky-local-variable t
)
2445 (defun conf-mode-maybe ()
2446 "Select Conf mode or XML mode according to start of file."
2450 (goto-char (point-min))
2451 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2455 (defvar interpreter-mode-alist
2456 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2457 ;; and pike-mode) are added through autoload directives in that
2458 ;; file. That way is discouraged since it spreads out the
2459 ;; definition of the initial value.
2462 (cons (purecopy (car l
)) (cdr l
)))
2463 '(("perl" . perl-mode
)
2464 ("perl5" . perl-mode
)
2465 ("miniperl" . perl-mode
)
2467 ("wishx" . tcl-mode
)
2469 ("tclsh" . tcl-mode
)
2470 ("scm" . scheme-mode
)
2491 ("tail" . text-mode
)
2492 ("more" . text-mode
)
2493 ("less" . text-mode
)
2495 ("make" . makefile-gmake-mode
) ; Debian uses this
2496 ("guile" . scheme-mode
)
2497 ("clisp" . lisp-mode
)
2498 ("emacs" . emacs-lisp-mode
)))
2499 "Alist mapping interpreter names to major modes.
2500 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2501 Each element looks like (INTERPRETER . MODE).
2502 If INTERPRETER matches the name of the interpreter specified in the first line
2503 of a script, mode MODE is enabled.
2505 See also `auto-mode-alist'.")
2507 (define-obsolete-variable-alias 'inhibit-first-line-modes-regexps
2508 'inhibit-file-local-variables-regexps
"24.1")
2510 ;; TODO really this should be a list of modes (eg tar-mode), not regexps,
2511 ;; because we are duplicating info from auto-mode-alist.
2512 ;; TODO many elements of this list are also in auto-coding-alist.
2513 (defvar inhibit-local-variables-regexps
2514 (mapcar 'purecopy
'("\\.tar\\'" "\\.t[bg]z\\'"
2515 "\\.arc\\'" "\\.zip\\'" "\\.lzh\\'" "\\.lha\\'"
2516 "\\.zoo\\'" "\\.[jew]ar\\'" "\\.xpi\\'" "\\.rar\\'"
2518 "\\.sx[dmicw]\\'" "\\.odt\\'"
2519 "\\.tiff?\\'" "\\.gif\\'" "\\.png\\'" "\\.jpe?g\\'"))
2520 "List of regexps matching file names in which to ignore local variables.
2521 This includes `-*-' lines as well as trailing \"Local Variables\" sections.
2522 Files matching this list are typically binary file formats.
2523 They may happen to contain sequences that look like local variable
2524 specifications, but are not really, or they may be containers for
2525 member files with their own local variable sections, which are
2526 not appropriate for the containing file.
2527 See also `inhibit-local-variables-suffixes'.")
2529 (define-obsolete-variable-alias 'inhibit-first-line-modes-suffixes
2530 'inhibit-local-variables-suffixes
"24.1")
2532 (defvar inhibit-local-variables-suffixes nil
2533 "List of regexps matching suffixes to remove from file names.
2534 When checking `inhibit-local-variables-regexps', we first discard
2535 from the end of the file name anything that matches one of these regexps.")
2537 ;; TODO explicitly add case-fold-search t?
2538 (defun inhibit-local-variables-p ()
2539 "Return non-nil if file local variables should be ignored.
2540 This checks the file (or buffer) name against `inhibit-local-variables-regexps'
2541 and `inhibit-local-variables-suffixes'."
2542 (let ((temp inhibit-local-variables-regexps
)
2543 (name (if buffer-file-name
2544 (file-name-sans-versions buffer-file-name
)
2546 (while (let ((sufs inhibit-local-variables-suffixes
))
2547 (while (and sufs
(not (string-match (car sufs
) name
)))
2548 (setq sufs
(cdr sufs
)))
2550 (setq name
(substring name
0 (match-beginning 0))))
2552 (not (string-match (car temp
) name
)))
2553 (setq temp
(cdr temp
)))
2556 (defvar auto-mode-interpreter-regexp
2557 (purecopy "#![ \t]?\\([^ \t\n]*\
2558 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2559 "Regexp matching interpreters, for file mode determination.
2560 This regular expression is matched against the first line of a file
2561 to determine the file's mode in `set-auto-mode'. If it matches, the file
2562 is assumed to be interpreted by the interpreter matched by the second group
2563 of the regular expression. The mode is then determined as the mode
2564 associated with that interpreter in `interpreter-mode-alist'.")
2566 (defvar magic-mode-alist nil
2567 "Alist of buffer beginnings vs. corresponding major mode functions.
2568 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2569 After visiting a file, if REGEXP matches the text at the beginning of the
2570 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2571 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2574 If FUNCTION is nil, then it is not called. (That is a way of saying
2575 \"allow `auto-mode-alist' to decide for these files.\")")
2576 (put 'magic-mode-alist
'risky-local-variable t
)
2578 (defvar magic-fallback-mode-alist
2580 `((image-type-auto-detected-p . image-mode
)
2581 ("\\(PK00\\)?[P]K\003\004" . archive-mode
) ; zip
2582 ;; The < comes before the groups (but the first) to reduce backtracking.
2583 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2584 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2585 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2586 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2587 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2589 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2590 "[Hh][Tt][Mm][Ll]"))
2592 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2593 ;; These two must come after html, because they are more general:
2594 ("<\\?xml " . xml-mode
)
2595 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2596 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2597 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2600 ("# xmcd " . conf-unix-mode
)))
2601 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2602 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2603 After visiting a file, if REGEXP matches the text at the beginning of the
2604 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2605 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2606 have not specified a mode for this file.
2608 If FUNCTION is nil, then it is not called.")
2609 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2611 (defvar magic-mode-regexp-match-limit
4000
2612 "Upper limit on `magic-mode-alist' regexp matches.
2613 Also applies to `magic-fallback-mode-alist'.")
2615 (defun set-auto-mode (&optional keep-mode-if-same
)
2616 "Select major mode appropriate for current buffer.
2618 To find the right major mode, this function checks for a -*- mode tag
2619 checks for a `mode:' entry in the Local Variables section of the file,
2620 checks if it uses an interpreter listed in `interpreter-mode-alist',
2621 matches the buffer beginning against `magic-mode-alist',
2622 compares the filename against the entries in `auto-mode-alist',
2623 then matches the buffer beginning against `magic-fallback-mode-alist'.
2625 If `enable-local-variables' is nil, or if the file name matches
2626 `inhibit-local-variables-regexps', this function does not check
2627 for any mode: tag anywhere in the file. If `local-enable-local-variables'
2628 is nil, then the only mode: tag that can be relevant is a -*- one.
2630 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2631 set the major mode only if that would change it. In other words
2632 we don't actually set it to the same mode the buffer already has."
2633 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2634 (let ((try-locals (not (inhibit-local-variables-p)))
2635 end done mode modes
)
2636 ;; Once we drop the deprecated feature where mode: is also allowed to
2637 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2638 ;; remove this section and just let (hack-local-variables t) handle it.
2639 ;; Find a -*- mode tag.
2641 (goto-char (point-min))
2642 (skip-chars-forward " \t\n")
2643 ;; Note by design local-enable-local-variables does not matter here.
2644 (and enable-local-variables
2646 (setq end
(set-auto-mode-1))
2647 (if (save-excursion (search-forward ":" end t
))
2648 ;; Find all specifications for the `mode:' variable
2649 ;; and execute them left to right.
2650 (while (let ((case-fold-search t
))
2651 (or (and (looking-at "mode:")
2652 (goto-char (match-end 0)))
2653 (re-search-forward "[ \t;]mode:" end t
)))
2654 (skip-chars-forward " \t")
2655 (let ((beg (point)))
2656 (if (search-forward ";" end t
)
2659 (skip-chars-backward " \t")
2660 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2662 ;; Simple -*-MODE-*- case.
2663 (push (intern (concat (downcase (buffer-substring (point) end
))
2666 ;; If we found modes to use, invoke them now, outside the save-excursion.
2669 (dolist (mode (nreverse modes
))
2670 (if (not (functionp mode
))
2671 (message "Ignoring unknown mode `%s'" mode
)
2673 (or (set-auto-mode-0 mode keep-mode-if-same
)
2674 ;; continuing would call minor modes again, toggling them off
2675 (throw 'nop nil
))))))
2676 ;; hack-local-variables checks local-enable-local-variables etc, but
2677 ;; we might as well be explicit here for the sake of clarity.
2679 enable-local-variables
2680 local-enable-local-variables
2682 (setq mode
(hack-local-variables t
))
2683 (not (memq mode modes
)) ; already tried and failed
2684 (if (not (functionp mode
))
2685 (message "Ignoring unknown mode `%s'" mode
)
2687 (set-auto-mode-0 mode keep-mode-if-same
)))
2688 ;; If we didn't, look for an interpreter specified in the first line.
2689 ;; As a special case, allow for things like "#!/bin/env perl", which
2690 ;; finds the interpreter anywhere in $PATH.
2692 (setq mode
(save-excursion
2693 (goto-char (point-min))
2694 (if (looking-at auto-mode-interpreter-regexp
)
2697 ;; Map interpreter name to a mode, signaling we're done at the
2699 done
(assoc (file-name-nondirectory mode
)
2700 interpreter-mode-alist
))
2701 ;; If we found an interpreter mode to use, invoke it now.
2703 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2704 ;; Next try matching the buffer beginning against magic-mode-alist.
2706 (if (setq done
(save-excursion
2707 (goto-char (point-min))
2709 (narrow-to-region (point-min)
2711 (+ (point-min) magic-mode-regexp-match-limit
)))
2712 (assoc-default nil magic-mode-alist
2716 (looking-at re
)))))))
2717 (set-auto-mode-0 done keep-mode-if-same
)))
2718 ;; Next compare the filename against the entries in auto-mode-alist.
2720 (if buffer-file-name
2721 (let ((name buffer-file-name
)
2722 (remote-id (file-remote-p buffer-file-name
)))
2723 ;; Remove backup-suffixes from file name.
2724 (setq name
(file-name-sans-versions name
))
2725 ;; Remove remote file name identification.
2726 (when (and (stringp remote-id
)
2727 (string-match (regexp-quote remote-id
) name
))
2728 (setq name
(substring name
(match-end 0))))
2730 ;; Find first matching alist entry.
2732 (if (memq system-type
'(windows-nt cygwin
))
2733 ;; System is case-insensitive.
2734 (let ((case-fold-search t
))
2735 (assoc-default name auto-mode-alist
2737 ;; System is case-sensitive.
2739 ;; First match case-sensitively.
2740 (let ((case-fold-search nil
))
2741 (assoc-default name auto-mode-alist
2743 ;; Fallback to case-insensitive match.
2744 (and auto-mode-case-fold
2745 (let ((case-fold-search t
))
2746 (assoc-default name auto-mode-alist
2751 (setq mode
(car mode
)
2752 name
(substring name
0 (match-beginning 0)))
2755 (set-auto-mode-0 mode keep-mode-if-same
)
2757 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2759 (if (setq done
(save-excursion
2760 (goto-char (point-min))
2762 (narrow-to-region (point-min)
2764 (+ (point-min) magic-mode-regexp-match-limit
)))
2765 (assoc-default nil magic-fallback-mode-alist
2769 (looking-at re
)))))))
2770 (set-auto-mode-0 done keep-mode-if-same
)))))
2772 ;; When `keep-mode-if-same' is set, we are working on behalf of
2773 ;; set-visited-file-name. In that case, if the major mode specified is the
2774 ;; same one we already have, don't actually reset it. We don't want to lose
2775 ;; minor modes such as Font Lock.
2776 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2777 "Apply MODE and return it.
2778 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2779 any aliases and compared to current major mode. If they are the
2780 same, do nothing and return nil."
2781 (unless (and keep-mode-if-same
2782 (eq (indirect-function mode
)
2783 (indirect-function major-mode
)))
2788 (defvar file-auto-mode-skip
"^\\(#!\\|'\\\\\"\\)"
2789 "Regexp of lines to skip when looking for file-local settings.
2790 If the first line matches this regular expression, then the -*-...-*- file-
2791 local settings will be consulted on the second line instead of the first.")
2793 (defun set-auto-mode-1 ()
2794 "Find the -*- spec in the buffer.
2795 Call with point at the place to start searching from.
2796 If one is found, set point to the beginning and return the position
2797 of the end. Otherwise, return nil; may change point.
2798 The variable `inhibit-local-variables-regexps' can cause a -*- spec to
2799 be ignored; but `enable-local-variables' and `local-enable-local-variables'
2803 ;; Don't look for -*- if this file name matches any
2804 ;; of the regexps in inhibit-local-variables-regexps.
2805 (not (inhibit-local-variables-p))
2806 (search-forward "-*-" (line-end-position
2807 ;; If the file begins with "#!" (exec
2808 ;; interpreter magic), look for mode frobs
2809 ;; in the first two lines. You cannot
2810 ;; necessarily put them in the first line
2811 ;; of such a file without screwing up the
2812 ;; interpreter invocation. The same holds
2813 ;; for '\" in man pages (preprocessor
2814 ;; magic for the `man' program).
2815 (and (looking-at file-auto-mode-skip
) 2)) t
)
2817 (skip-chars-forward " \t")
2819 (search-forward "-*-" (line-end-position) t
))
2822 (skip-chars-backward " \t")
2827 ;;; Handling file local variables
2829 (defvar ignored-local-variables
2830 '(ignored-local-variables safe-local-variable-values
2831 file-local-variables-alist dir-local-variables-alist
)
2832 "Variables to be ignored in a file's local variable spec.")
2833 (put 'ignored-local-variables
'risky-local-variable t
)
2835 (defvar hack-local-variables-hook nil
2836 "Normal hook run after processing a file's local variables specs.
2837 Major modes can use this to examine user-specified local variables
2838 in order to initialize other data structure based on them.")
2840 (defcustom safe-local-variable-values nil
2841 "List variable-value pairs that are considered safe.
2842 Each element is a cons cell (VAR . VAL), where VAR is a variable
2843 symbol and VAL is a value that is considered safe."
2848 (defcustom safe-local-eval-forms
2849 ;; This should be here at least as long as Emacs supports write-file-hooks.
2850 '((add-hook 'write-file-hooks
'time-stamp
)
2851 (add-hook 'write-file-functions
'time-stamp
)
2852 (add-hook 'before-save-hook
'time-stamp
))
2853 "Expressions that are considered safe in an `eval:' local variable.
2854 Add expressions to this list if you want Emacs to evaluate them, when
2855 they appear in an `eval' local variable specification, without first
2856 asking you for confirmation."
2859 :version
"24.1" ; added write-file-hooks
2860 :type
'(repeat sexp
))
2862 ;; Risky local variables:
2863 (mapc (lambda (var) (put var
'risky-local-variable t
))
2865 buffer-auto-save-file-name
2867 buffer-file-truename
2870 default-text-properties
2874 file-name-handler-alist
2883 minor-mode-map-alist
2884 minor-mode-overriding-map-alist
2887 overriding-local-map
2888 overriding-terminal-local-map
2892 unread-command-events
))
2894 ;; Safe local variables:
2896 ;; For variables defined by major modes, the safety declarations can go into
2897 ;; the major mode's file, since that will be loaded before file variables are
2900 ;; For variables defined by minor modes, put the safety declarations in the
2901 ;; file defining the minor mode after the defcustom/defvar using an autoload
2904 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2906 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2907 ;; minor mode file may not be loaded yet.
2909 ;; For variables defined in the C source code the declaration should go here:
2912 '((buffer-read-only . booleanp
) ;; C source code
2913 (default-directory . stringp
) ;; C source code
2914 (fill-column . integerp
) ;; C source code
2915 (indent-tabs-mode . booleanp
) ;; C source code
2916 (left-margin . integerp
) ;; C source code
2917 (no-update-autoloads . booleanp
)
2918 (lexical-binding . booleanp
) ;; C source code
2919 (tab-width . integerp
) ;; C source code
2920 (truncate-lines . booleanp
) ;; C source code
2921 (word-wrap . booleanp
) ;; C source code
2922 (bidi-display-reordering . booleanp
))) ;; C source code
2923 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2925 (put 'bidi-paragraph-direction
'safe-local-variable
2926 (lambda (v) (memq v
'(nil right-to-left left-to-right
))))
2928 (put 'c-set-style
'safe-local-eval-function t
)
2930 (defvar file-local-variables-alist nil
2931 "Alist of file-local variable settings in the current buffer.
2932 Each element in this list has the form (VAR . VALUE), where VAR
2933 is a file-local variable (a symbol) and VALUE is the value
2934 specified. The actual value in the buffer may differ from VALUE,
2935 if it is changed by the major or minor modes, or by the user.")
2936 (make-variable-buffer-local 'file-local-variables-alist
)
2937 (put 'file-local-variables-alist
'permanent-local t
)
2939 (defvar dir-local-variables-alist nil
2940 "Alist of directory-local variable settings in the current buffer.
2941 Each element in this list has the form (VAR . VALUE), where VAR
2942 is a directory-local variable (a symbol) and VALUE is the value
2943 specified in .dir-locals.el. The actual value in the buffer
2944 may differ from VALUE, if it is changed by the major or minor modes,
2946 (make-variable-buffer-local 'dir-local-variables-alist
)
2948 (defvar before-hack-local-variables-hook nil
2949 "Normal hook run before setting file-local variables.
2950 It is called after checking for unsafe/risky variables and
2951 setting `file-local-variables-alist', and before applying the
2952 variables stored in `file-local-variables-alist'. A hook
2953 function is allowed to change the contents of this alist.
2955 This hook is called only if there is at least one file-local
2958 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name
)
2959 "Get confirmation before setting up local variable values.
2960 ALL-VARS is the list of all variables to be set up.
2961 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2962 RISKY-VARS is the list of those that are marked as risky.
2963 If these settings come from directory-local variables, then
2964 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2967 (save-window-excursion
2968 (let* ((name (or dir-name
2969 (if buffer-file-name
2970 (file-name-nondirectory buffer-file-name
)
2971 (concat "buffer " (buffer-name)))))
2972 (offer-save (and (eq enable-local-variables t
)
2975 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2976 (buf (pop-to-buffer "*Local Variables*"))
2978 (set (make-local-variable 'cursor-type
) nil
)
2982 (insert "The local variables list in " name
2983 "\ncontains values that may not be safe (*)"
2985 ", and variables that are risky (**)."
2988 (insert "The local variables list in " name
2989 "\ncontains variables that are risky (**)."))
2991 (insert "A local variables list is specified in " name
".")))
2992 (insert "\n\nDo you want to apply it? You can type
2993 y -- to apply the local variables list.
2994 n -- to ignore the local variables list.")
2997 ! -- to apply the local variables list, and permanently mark these
2998 values (*) as safe (in the future, they will be set automatically.)\n\n")
3000 (dolist (elt all-vars
)
3001 (cond ((member elt unsafe-vars
)
3003 ((member elt risky-vars
)
3007 (princ (car elt
) buf
)
3009 ;; Make strings with embedded whitespace easier to read.
3010 (let ((print-escape-newlines t
))
3011 (prin1 (cdr elt
) buf
))
3014 (format "Please type %s%s: "
3015 (if offer-save
"y, n, or !" "y or n")
3016 (if (< (line-number-at-pos) (window-body-height))
3018 (push ?\C-v exit-chars
)
3019 ", or C-v to scroll")))
3020 (goto-char (point-min))
3022 (setq char
(read-char-choice prompt exit-chars t
))
3023 (when (eq char ?\C-v
)
3026 (error (goto-char (point-min))))
3029 (when (and offer-save
(= char ?
!) unsafe-vars
)
3030 (customize-push-and-save 'safe-local-variable-values unsafe-vars
))
3031 (memq char
'(?
! ?\s ?y
))))))
3033 (defun hack-local-variables-prop-line (&optional mode-only
)
3034 "Return local variables specified in the -*- line.
3035 Returns an alist of elements (VAR . VAL), where VAR is a variable
3036 and VAL is the specified value. Ignores any specification for
3037 `mode:' and `coding:' (which should have already been handled
3038 by `set-auto-mode' and `set-auto-coding', respectively).
3039 Return nil if the -*- line is malformed.
3041 If MODE-ONLY is non-nil, just returns the symbol specifying the
3042 mode, if there is one, otherwise nil."
3043 (catch 'malformed-line
3045 (goto-char (point-min))
3046 (let ((end (set-auto-mode-1))
3050 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
3051 ;; Simple form: "-*- MODENAME -*-".
3053 (intern (concat (match-string 1) "-mode"))))
3055 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3056 ;; (last ";" is optional).
3057 ;; If MODE-ONLY, just check for `mode'.
3058 ;; Otherwise, parse the -*- line into the RESULT alist.
3059 (while (and (or (not mode-only
)
3062 (unless (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
3063 (message "Malformed mode-line")
3064 (throw 'malformed-line nil
))
3065 (goto-char (match-end 0))
3066 ;; There used to be a downcase here,
3067 ;; but the manual didn't say so,
3068 ;; and people want to set var names that aren't all lc.
3069 (let* ((key (intern (match-string 1)))
3070 (val (save-restriction
3071 (narrow-to-region (point) end
)
3072 (let ((read-circle nil
))
3073 (read (current-buffer)))))
3074 ;; It is traditional to ignore
3075 ;; case when checking for `mode' in set-auto-mode,
3076 ;; so we must do that here as well.
3077 ;; That is inconsistent, but we're stuck with it.
3078 ;; The same can be said for `coding' in set-auto-coding.
3079 (keyname (downcase (symbol-name key
))))
3081 (and (equal keyname
"mode")
3083 (intern (concat (downcase (symbol-name val
))
3085 (or (equal keyname
"coding")
3087 (push (cons (cond ((eq key
'eval
) 'eval
)
3088 ;; Downcase "Mode:".
3089 ((equal keyname
"mode") 'mode
)
3090 (t (indirect-variable key
)))
3093 (skip-chars-forward " \t;")))
3096 (defun hack-local-variables-filter (variables dir-name
)
3097 "Filter local variable settings, querying the user if necessary.
3098 VARIABLES is the alist of variable-value settings. This alist is
3099 filtered based on the values of `ignored-local-variables',
3100 `enable-local-eval', `enable-local-variables', and (if necessary)
3101 user interaction. The results are added to
3102 `file-local-variables-alist', without applying them.
3103 If these settings come from directory-local variables, then
3104 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3105 ;; Find those variables that we may want to save to
3106 ;; `safe-local-variable-values'.
3107 (let (all-vars risky-vars unsafe-vars
)
3108 (dolist (elt variables
)
3109 (let ((var (car elt
))
3111 (cond ((memq var ignored-local-variables
)
3112 ;; Ignore any variable in `ignored-local-variables'.
3114 ;; Obey `enable-local-eval'.
3116 (when enable-local-eval
3118 (or (eq enable-local-eval t
)
3119 (hack-one-local-variable-eval-safep (eval (quote val
)))
3120 (safe-local-variable-p var val
)
3121 (push elt unsafe-vars
))))
3122 ;; Ignore duplicates (except `mode') in the present list.
3123 ((and (assq var all-vars
) (not (eq var
'mode
))) nil
)
3124 ;; Accept known-safe variables.
3125 ((or (memq var
'(mode unibyte coding
))
3126 (safe-local-variable-p var val
))
3127 (push elt all-vars
))
3128 ;; The variable is either risky or unsafe:
3129 ((not (eq enable-local-variables
:safe
))
3131 (if (risky-local-variable-p var val
)
3132 (push elt risky-vars
)
3133 (push elt unsafe-vars
))))))
3135 ;; Query, unless all vars are safe or user wants no querying.
3136 (or (and (eq enable-local-variables t
)
3139 (memq enable-local-variables
'(:all
:safe
))
3140 (hack-local-variables-confirm all-vars unsafe-vars
3141 risky-vars dir-name
))
3142 (dolist (elt all-vars
)
3143 (unless (memq (car elt
) '(eval mode
))
3145 (setq dir-local-variables-alist
3146 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3147 (setq file-local-variables-alist
3148 (assq-delete-all (car elt
) file-local-variables-alist
)))
3149 (push elt file-local-variables-alist
)))))
3151 (defun hack-local-variables (&optional mode-only
)
3152 "Parse and put into effect this buffer's local variables spec.
3153 Uses `hack-local-variables-apply' to apply the variables.
3155 If MODE-ONLY is non-nil, all we do is check whether a \"mode:\"
3156 is specified, and return the corresponding mode symbol, or nil.
3157 In this case, we try to ignore minor-modes, and only return a
3160 If `enable-local-variables' or `local-enable-local-variables' is nil,
3161 this function does nothing. If `inhibit-local-variables-regexps'
3162 applies to the file in question, the file is not scanned for
3163 local variables, but directory-local variables may still be applied."
3164 ;; We don't let inhibit-local-variables-p influence the value of
3165 ;; enable-local-variables, because then it would affect dir-local
3166 ;; variables. We don't want to search eg tar files for file local
3167 ;; variable sections, but there is no reason dir-locals cannot apply
3168 ;; to them. The real meaning of inhibit-local-variables-p is "do
3169 ;; not scan this file for local variables".
3170 (let ((enable-local-variables
3171 (and local-enable-local-variables enable-local-variables
))
3174 (setq file-local-variables-alist nil
)
3175 (report-errors "Directory-local variables error: %s"
3176 ;; Note this is a no-op if enable-local-variables is nil.
3177 (hack-dir-local-variables)))
3178 ;; This entire function is basically a no-op if enable-local-variables
3179 ;; is nil. All it does is set file-local-variables-alist to nil.
3180 (when enable-local-variables
3181 ;; This part used to ignore enable-local-variables when mode-only
3182 ;; was non-nil. That was inappropriate, eg consider the
3183 ;; (artificial) example of:
3184 ;; (setq local-enable-local-variables nil)
3185 ;; Open a file foo.txt that contains "mode: sh".
3186 ;; It correctly opens in text-mode.
3187 ;; M-x set-visited-file name foo.c, and it incorrectly stays in text-mode.
3188 (unless (or (inhibit-local-variables-p)
3189 ;; If MODE-ONLY is non-nil, and the prop line specifies a
3190 ;; mode, then we're done, and have no need to scan further.
3191 (and (setq result
(hack-local-variables-prop-line mode-only
))
3193 ;; Look for "Local variables:" line in last page.
3195 (goto-char (point-max))
3196 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3198 (when (let ((case-fold-search t
))
3199 (search-forward "Local Variables:" nil t
))
3200 (skip-chars-forward " \t")
3201 ;; suffix is what comes after "local variables:" in its line.
3202 ;; prefix is what comes before "local variables:" in its line.
3205 (regexp-quote (buffer-substring (point)
3206 (line-end-position)))
3209 (concat "^" (regexp-quote
3210 (buffer-substring (line-beginning-position)
3211 (match-beginning 0)))))
3215 (let ((startpos (point))
3217 (thisbuf (current-buffer)))
3219 (unless (let ((case-fold-search t
))
3221 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
3223 ;; This used to be an error, but really all it means is
3224 ;; that this may simply not be a local-variables section,
3225 ;; so just ignore it.
3226 (message "Local variables list is not properly terminated"))
3228 (setq endpos
(point)))
3231 (insert-buffer-substring thisbuf startpos endpos
)
3232 (goto-char (point-min))
3233 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
3235 ;; Discard the prefix.
3236 (if (looking-at prefix
)
3237 (delete-region (point) (match-end 0))
3238 (error "Local variables entry is missing the prefix"))
3240 ;; Discard the suffix.
3241 (if (looking-back suffix
)
3242 (delete-region (match-beginning 0) (point))
3243 (error "Local variables entry is missing the suffix"))
3245 (goto-char (point-min))
3247 (while (and (not (eobp))
3250 ;; Find the variable name; strip whitespace.
3251 (skip-chars-forward " \t")
3253 (skip-chars-forward "^:\n")
3254 (if (eolp) (error "Missing colon in local variables entry"))
3255 (skip-chars-backward " \t")
3256 (let* ((str (buffer-substring beg
(point)))
3257 (var (let ((read-circle nil
))
3260 (and (equal (downcase (symbol-name var
)) "mode")
3262 ;; Read the variable value.
3263 (skip-chars-forward "^:")
3265 (let ((read-circle nil
))
3266 (setq val
(read (current-buffer))))
3269 ;; Specifying minor-modes via mode: is
3270 ;; deprecated, but try to reject them anyway.
3273 (setq val2
(downcase (symbol-name val
)))))
3274 (setq result
(intern (concat val2
"-mode"))))
3275 (unless (eq var
'coding
)
3277 (push (cons (if (eq var
'eval
)
3279 (indirect-variable var
))
3282 (forward-line 1))))))))
3283 ;; Now we've read all the local variables.
3284 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3285 (if mode-only result
3286 ;; Otherwise, set the variables.
3287 (hack-local-variables-filter result nil
)
3288 (hack-local-variables-apply)))))
3290 (defun hack-local-variables-apply ()
3291 "Apply the elements of `file-local-variables-alist'.
3292 If there are any elements, runs `before-hack-local-variables-hook',
3293 then calls `hack-one-local-variable' to apply the alist elements one by one.
3294 Finishes by running `hack-local-variables-hook', regardless of whether
3295 the alist is empty or not.
3297 Note that this function ignores a `mode' entry if it specifies the same
3298 major mode as the buffer already has."
3299 (when file-local-variables-alist
3300 ;; Any 'evals must run in the Right sequence.
3301 (setq file-local-variables-alist
3302 (nreverse file-local-variables-alist
))
3303 (run-hooks 'before-hack-local-variables-hook
)
3304 (dolist (elt file-local-variables-alist
)
3305 (hack-one-local-variable (car elt
) (cdr elt
))))
3306 (run-hooks 'hack-local-variables-hook
))
3308 (defun safe-local-variable-p (sym val
)
3309 "Non-nil if SYM is safe as a file-local variable with value VAL.
3310 It is safe if any of these conditions are met:
3312 * There is a matching entry (SYM . VAL) in the
3313 `safe-local-variable-values' user option.
3315 * The `safe-local-variable' property of SYM is a function that
3316 evaluates to a non-nil value with VAL as an argument."
3317 (or (member (cons sym val
) safe-local-variable-values
)
3318 (let ((safep (get sym
'safe-local-variable
)))
3319 (and (functionp safep
)
3320 ;; If the function signals an error, that means it
3321 ;; can't assure us that the value is safe.
3322 (with-demoted-errors (funcall safep val
))))))
3324 (defun risky-local-variable-p (sym &optional _ignored
)
3325 "Non-nil if SYM could be dangerous as a file-local variable.
3326 It is dangerous if either of these conditions are met:
3328 * Its `risky-local-variable' property is non-nil.
3330 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3331 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3332 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3333 \"map-alist\", or \"bindat-spec\"."
3334 ;; If this is an alias, check the base name.
3336 (setq sym
(indirect-variable sym
))
3338 (or (get sym
'risky-local-variable
)
3339 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3340 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3341 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3342 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
3344 (defun hack-one-local-variable-quotep (exp)
3345 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
3347 (defun hack-one-local-variable-constantp (exp)
3348 (or (and (not (symbolp exp
)) (not (consp exp
)))
3351 (hack-one-local-variable-quotep exp
)))
3353 (defun hack-one-local-variable-eval-safep (exp)
3354 "Return t if it is safe to eval EXP when it is found in a file."
3355 (or (not (consp exp
))
3356 ;; Detect certain `put' expressions.
3357 (and (eq (car exp
) 'put
)
3358 (hack-one-local-variable-quotep (nth 1 exp
))
3359 (hack-one-local-variable-quotep (nth 2 exp
))
3360 (let ((prop (nth 1 (nth 2 exp
)))
3362 (cond ((memq prop
'(lisp-indent-hook
3363 lisp-indent-function
3364 scheme-indent-function
))
3365 ;; Only allow safe values (not functions).
3367 (and (hack-one-local-variable-quotep val
)
3368 (eq (nth 1 val
) 'defun
))))
3369 ((eq prop
'edebug-form-spec
)
3370 ;; Only allow indirect form specs.
3371 ;; During bootstrapping, edebug-basic-spec might not be
3373 (and (fboundp 'edebug-basic-spec
)
3374 (hack-one-local-variable-quotep val
)
3375 (edebug-basic-spec (nth 1 val
)))))))
3376 ;; Allow expressions that the user requested.
3377 (member exp safe-local-eval-forms
)
3378 ;; Certain functions can be allowed with safe arguments
3379 ;; or can specify verification functions to try.
3380 (and (symbolp (car exp
))
3381 ;; Allow (minor)-modes calls with no arguments.
3382 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3383 (or (and (member (cdr exp
) '(nil (1) (0) (-1)))
3384 (string-match "-mode\\'" (symbol-name (car exp
))))
3385 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
3388 (dolist (arg (cdr exp
))
3389 (unless (hack-one-local-variable-constantp arg
)
3396 (dolist (function prop
)
3397 (if (funcall function exp
)
3401 (defun hack-one-local-variable (var val
)
3402 "Set local variable VAR with value VAL.
3403 If VAR is `mode', call `VAL-mode' as a function unless it's
3404 already the major mode."
3405 (cond ((eq var
'mode
)
3406 (let ((mode (intern (concat (downcase (symbol-name val
))
3408 (unless (eq (indirect-function mode
)
3409 (indirect-function major-mode
))
3410 (if (memq mode minor-mode-list
)
3411 ;; A minor mode must be passed an argument.
3412 ;; Otherwise, if the user enables the minor mode in a
3413 ;; major mode hook, this would toggle it off.
3417 (save-excursion (eval val
)))
3419 ;; Make sure the string has no text properties.
3420 ;; Some text properties can get evaluated in various ways,
3421 ;; so it is risky to put them on with a local variable list.
3423 (set-text-properties 0 (length val
) nil val
))
3424 (set (make-local-variable var
) val
))))
3426 ;;; Handling directory-local variables, aka project settings.
3428 (defvar dir-locals-class-alist
'()
3429 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3431 (defvar dir-locals-directory-cache
'()
3432 "List of cached directory roots for directory-local variable classes.
3433 Each element in this list has the form (DIR CLASS MTIME).
3434 DIR is the name of the directory.
3435 CLASS is the name of a variable class (a symbol).
3436 MTIME is the recorded modification time of the directory-local
3437 variables file associated with this entry. This time is a list
3438 of two integers (the same format as `file-attributes'), and is
3439 used to test whether the cache entry is still valid.
3440 Alternatively, MTIME can be nil, which means the entry is always
3443 (defsubst dir-locals-get-class-variables
(class)
3444 "Return the variable list for CLASS."
3445 (cdr (assq class dir-locals-class-alist
)))
3447 (defun dir-locals-collect-mode-variables (mode-variables variables
)
3448 "Collect directory-local variables from MODE-VARIABLES.
3449 VARIABLES is the initial list of variables.
3450 Returns the new list."
3451 (dolist (pair mode-variables variables
)
3452 (let* ((variable (car pair
))
3454 (slot (assq variable variables
)))
3455 ;; If variables are specified more than once, only use the last. (Why?)
3456 ;; The pseudo-variables mode and eval are different (bug#3430).
3457 (if (and slot
(not (memq variable
'(mode eval
))))
3459 ;; Need a new cons in case we setcdr later.
3460 (push (cons variable value
) variables
)))))
3462 (defun dir-locals-collect-variables (class-variables root variables
)
3463 "Collect entries from CLASS-VARIABLES into VARIABLES.
3464 ROOT is the root directory of the project.
3465 Return the new variables list."
3466 (let* ((file-name (buffer-file-name))
3467 (sub-file-name (if file-name
3468 ;; FIXME: Why not use file-relative-name?
3469 (substring file-name
(length root
)))))
3471 (dolist (entry class-variables variables
)
3472 (let ((key (car entry
)))
3475 ;; Don't include this in the previous condition, because we
3476 ;; want to filter all strings before the next condition.
3477 (when (and sub-file-name
3478 (>= (length sub-file-name
) (length key
))
3479 (string-prefix-p key sub-file-name
))
3480 (setq variables
(dir-locals-collect-variables
3481 (cdr entry
) root variables
))))
3483 (derived-mode-p key
))
3484 (let* ((alist (cdr entry
))
3485 (subdirs (assq 'subdirs alist
)))
3486 (if (or (not subdirs
)
3488 (setq alist
(delq subdirs alist
))
3490 ;; TODO someone might want to extend this to allow
3491 ;; integer values for subdir, where N means
3492 ;; variables apply to this directory and N levels
3493 ;; below it (0 == nil).
3494 (equal root default-directory
))
3495 (setq variables
(dir-locals-collect-mode-variables
3496 alist variables
))))))))
3498 ;; The file's content might be invalid (e.g. have a merge conflict), but
3499 ;; that shouldn't prevent the user from opening the file.
3500 (message ".dir-locals error: %s" (error-message-string err
))
3503 (defun dir-locals-set-directory-class (directory class
&optional mtime
)
3504 "Declare that the DIRECTORY root is an instance of CLASS.
3505 DIRECTORY is the name of a directory, a string.
3506 CLASS is the name of a project class, a symbol.
3507 MTIME is either the modification time of the directory-local
3508 variables file that defined this class, or nil.
3510 When a file beneath DIRECTORY is visited, the mode-specific
3511 variables from CLASS are applied to the buffer. The variables
3512 for a class are defined using `dir-locals-set-class-variables'."
3513 (setq directory
(file-name-as-directory (expand-file-name directory
)))
3514 (unless (assq class dir-locals-class-alist
)
3515 (error "No such class `%s'" (symbol-name class
)))
3516 (push (list directory class mtime
) dir-locals-directory-cache
))
3518 (defun dir-locals-set-class-variables (class variables
)
3519 "Map the type CLASS to a list of variable settings.
3520 CLASS is the project class, a symbol. VARIABLES is a list
3521 that declares directory-local variables for the class.
3522 An element in VARIABLES is either of the form:
3523 (MAJOR-MODE . ALIST)
3527 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3528 whose elements are of the form (VARIABLE . VALUE).
3530 In the second form, DIRECTORY is a directory name (a string), and
3531 LIST is a list of the form accepted by the function.
3533 When a file is visited, the file's class is found. A directory
3534 may be assigned a class using `dir-locals-set-directory-class'.
3535 Then variables are set in the file's buffer according to the
3536 VARIABLES list of the class. The list is processed in order.
3538 * If the element is of the form (MAJOR-MODE . ALIST), and the
3539 buffer's major mode is derived from MAJOR-MODE (as determined
3540 by `derived-mode-p'), then all the variables in ALIST are
3541 applied. A MAJOR-MODE of nil may be used to match any buffer.
3542 `make-local-variable' is called for each variable before it is
3545 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3546 is an initial substring of the file's directory, then LIST is
3547 applied by recursively following these rules."
3548 (let ((elt (assq class dir-locals-class-alist
)))
3550 (setcdr elt variables
)
3551 (push (cons class variables
) dir-locals-class-alist
))))
3553 (defconst dir-locals-file
".dir-locals.el"
3554 "File that contains directory-local variables.
3555 It has to be constant to enforce uniform values
3556 across different environments and users.")
3558 (defun dir-locals-find-file (file)
3559 "Find the directory-local variables for FILE.
3560 This searches upward in the directory tree from FILE.
3561 It stops at the first directory that has been registered in
3562 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3563 If it finds an entry in the cache, it checks that it is valid.
3564 A cache entry with no modification time element (normally, one that
3565 has been assigned directly using `dir-locals-set-directory-class', not
3566 set from a file) is always valid.
3567 A cache entry based on a `dir-locals-file' is valid if the modification
3568 time stored in the cache matches the current file modification time.
3569 If not, the cache entry is cleared so that the file will be re-read.
3571 This function returns either nil (no directory local variables found),
3572 or the matching entry from `dir-locals-directory-cache' (a list),
3573 or the full path to the `dir-locals-file' (a string) in the case
3574 of no valid cache entry."
3575 (setq file
(expand-file-name file
))
3576 (let* ((dir-locals-file-name
3577 (if (eq system-type
'ms-dos
)
3578 (dosified-file-name dir-locals-file
)
3580 (locals-file (locate-dominating-file file dir-locals-file-name
))
3582 ;; `locate-dominating-file' may have abbreviated the name.
3584 (setq locals-file
(expand-file-name dir-locals-file-name locals-file
)))
3585 ;; Let dir-locals-read-from-file inform us via demoted-errors
3586 ;; about unreadable files, etc.
3587 ;; Maybe we'd want to keep searching though - that is
3588 ;; a locate-dominating-file issue.
3589 ;;; (or (not (file-readable-p locals-file))
3590 ;;; (not (file-regular-p locals-file)))
3591 ;;; (setq locals-file nil))
3592 ;; Find the best cached value in `dir-locals-directory-cache'.
3593 (dolist (elt dir-locals-directory-cache
)
3594 (when (and (eq t
(compare-strings file nil
(length (car elt
))
3597 '(windows-nt cygwin ms-dos
))))
3598 (> (length (car elt
)) (length (car dir-elt
))))
3599 (setq dir-elt elt
)))
3601 (or (null locals-file
)
3602 (<= (length (file-name-directory locals-file
))
3603 (length (car dir-elt
)))))
3604 ;; Found a potential cache entry. Check validity.
3605 ;; A cache entry with no MTIME is assumed to always be valid
3606 ;; (ie, set directly, not from a dir-locals file).
3607 ;; Note, we don't bother to check that there is a matching class
3608 ;; element in dir-locals-class-alist, since that's done by
3609 ;; dir-locals-set-directory-class.
3610 (if (or (null (nth 2 dir-elt
))
3611 (let ((cached-file (expand-file-name dir-locals-file-name
3613 (and (file-readable-p cached-file
)
3614 (equal (nth 2 dir-elt
)
3615 (nth 5 (file-attributes cached-file
))))))
3616 ;; This cache entry is OK.
3618 ;; This cache entry is invalid; clear it.
3619 (setq dir-locals-directory-cache
3620 (delq dir-elt dir-locals-directory-cache
))
3621 ;; Return the first existing dir-locals file. Might be the same
3622 ;; as dir-elt's, might not (eg latter might have been deleted).
3627 (defun dir-locals-read-from-file (file)
3628 "Load a variables FILE and register a new class and instance.
3629 FILE is the name of the file holding the variables to apply.
3630 The new class name is the same as the directory in which FILE
3631 is found. Returns the new class name."
3633 ;; This is with-demoted-errors, but we want to mention dir-locals
3634 ;; in any error message.
3638 (insert-file-contents file
)
3639 (let* ((dir-name (file-name-directory file
))
3640 (class-name (intern dir-name
))
3641 (variables (let ((read-circle nil
))
3642 (read (current-buffer)))))
3643 (dir-locals-set-class-variables class-name variables
)
3644 (dir-locals-set-directory-class dir-name class-name
3645 (nth 5 (file-attributes file
)))
3647 (error (message "Error reading dir-locals: %S" err
) nil
)))))
3649 (defcustom enable-remote-dir-locals nil
3650 "Non-nil means dir-local variables will be applied to remote files."
3655 (defun hack-dir-local-variables ()
3656 "Read per-directory local variables for the current buffer.
3657 Store the directory-local variables in `dir-local-variables-alist'
3658 and `file-local-variables-alist', without applying them."
3659 (when (and enable-local-variables
3660 (or enable-remote-dir-locals
3661 (not (file-remote-p (or (buffer-file-name)
3662 default-directory
)))))
3663 ;; Find the variables file.
3664 (let ((variables-file (dir-locals-find-file
3665 (or (buffer-file-name) default-directory
)))
3669 ((stringp variables-file
)
3670 (setq dir-name
(file-name-directory variables-file
)
3671 class
(dir-locals-read-from-file variables-file
)))
3672 ((consp variables-file
)
3673 (setq dir-name
(nth 0 variables-file
))
3674 (setq class
(nth 1 variables-file
))))
3677 (dir-locals-collect-variables
3678 (dir-locals-get-class-variables class
) dir-name nil
)))
3680 (dolist (elt variables
)
3681 (unless (memq (car elt
) '(eval mode
))
3682 (setq dir-local-variables-alist
3683 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3684 (push elt dir-local-variables-alist
))
3685 (hack-local-variables-filter variables dir-name
)))))))
3687 (defun hack-dir-local-variables-non-file-buffer ()
3688 "Apply directory-local variables to a non-file buffer.
3689 For non-file buffers, such as Dired buffers, directory-local
3690 variables are looked for in `default-directory' and its parent
3692 (hack-dir-local-variables)
3693 (hack-local-variables-apply))
3696 (defcustom change-major-mode-with-file-name t
3697 "Non-nil means \\[write-file] should set the major mode from the file name.
3698 However, the mode will not be changed if
3699 \(1) a local variables list or the `-*-' line specifies a major mode, or
3700 \(2) the current major mode is a \"special\" mode,
3701 \ not suitable for ordinary files, or
3702 \(3) the new file name does not particularly specify any mode."
3704 :group
'editing-basics
)
3706 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3707 "Change name of file visited in current buffer to FILENAME.
3708 This also renames the buffer to correspond to the new file.
3709 The next time the buffer is saved it will go in the newly specified file.
3710 FILENAME nil or an empty string means mark buffer as not visiting any file.
3711 Remember to delete the initial contents of the minibuffer
3712 if you wish to pass an empty string as the argument.
3714 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3715 confirmation in the case where another buffer is already visiting FILENAME.
3717 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3718 the old visited file has been renamed to the new name FILENAME."
3719 (interactive "FSet visited file name: ")
3720 (if (buffer-base-buffer)
3721 (error "An indirect buffer cannot visit a file"))
3722 (let (truename old-try-locals
)
3725 (if (string-equal filename
"")
3727 (expand-file-name filename
))))
3730 (setq truename
(file-truename filename
))
3731 (if find-file-visit-truename
3732 (setq filename truename
))))
3734 (let ((new-name (file-name-nondirectory filename
)))
3735 (if (string= new-name
"")
3736 (error "Empty file name"))))
3737 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3738 (and buffer
(not (eq buffer
(current-buffer)))
3740 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3743 (or (equal filename buffer-file-name
)
3745 (and filename
(lock-buffer filename
))
3747 (setq old-try-locals
(not (inhibit-local-variables-p))
3748 buffer-file-name filename
)
3749 (if filename
; make buffer name reflect filename.
3750 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3751 (setq default-directory
(file-name-directory buffer-file-name
))
3752 ;; If new-name == old-name, renaming would add a spurious <2>
3753 ;; and it's considered as a feature in rename-buffer.
3754 (or (string= new-name
(buffer-name))
3755 (rename-buffer new-name t
))))
3756 (setq buffer-backed-up nil
)
3758 (clear-visited-file-modtime))
3759 ;; Abbreviate the file names of the buffer.
3762 (setq buffer-file-truename
(abbreviate-file-name truename
))
3763 (if find-file-visit-truename
3764 (setq buffer-file-name truename
))))
3765 (setq buffer-file-number
3767 (nthcdr 10 (file-attributes buffer-file-name
))
3769 ;; write-file-functions is normally used for things like ftp-find-file
3770 ;; that visit things that are not local files as if they were files.
3771 ;; Changing to visit an ordinary local file instead should flush the hook.
3772 (kill-local-variable 'write-file-functions
)
3773 (kill-local-variable 'local-write-file-hooks
)
3774 (kill-local-variable 'revert-buffer-function
)
3775 (kill-local-variable 'backup-inhibited
)
3776 ;; If buffer was read-only because of version control,
3777 ;; that reason is gone now, so make it writable.
3779 (setq buffer-read-only nil
))
3780 (kill-local-variable 'vc-mode
)
3781 ;; Turn off backup files for certain file names.
3782 ;; Since this is a permanent local, the major mode won't eliminate it.
3783 (and buffer-file-name
3784 backup-enable-predicate
3785 (not (funcall backup-enable-predicate buffer-file-name
))
3787 (make-local-variable 'backup-inhibited
)
3788 (setq backup-inhibited t
)))
3789 (let ((oauto buffer-auto-save-file-name
))
3790 ;; If auto-save was not already on, turn it on if appropriate.
3791 (if (not buffer-auto-save-file-name
)
3792 (and buffer-file-name auto-save-default
3794 ;; If auto save is on, start using a new name.
3795 ;; We deliberately don't rename or delete the old auto save
3796 ;; for the old visited file name. This is because perhaps
3797 ;; the user wants to save the new state and then compare with the
3798 ;; previous state from the auto save file.
3799 (setq buffer-auto-save-file-name
3800 (make-auto-save-file-name)))
3801 ;; Rename the old auto save file if any.
3802 (and oauto buffer-auto-save-file-name
3803 (file-exists-p oauto
)
3804 (rename-file oauto buffer-auto-save-file-name t
)))
3805 (and buffer-file-name
3806 (not along-with-file
)
3807 (set-buffer-modified-p t
))
3808 ;; Update the major mode, if the file name determines it.
3810 ;; Don't change the mode if it is special.
3811 (or (not change-major-mode-with-file-name
)
3812 (get major-mode
'mode-class
)
3813 ;; Don't change the mode if the local variable list specifies it.
3814 ;; The file name can influence whether the local variables apply.
3816 ;; h-l-v also checks it, but might as well be explicit.
3817 (not (inhibit-local-variables-p))
3818 (hack-local-variables t
))
3819 ;; TODO consider making normal-mode handle this case.
3820 (let ((old major-mode
))
3822 (or (eq old major-mode
)
3823 (hack-local-variables))))
3826 (defun write-file (filename &optional confirm
)
3827 "Write current buffer into file FILENAME.
3828 This makes the buffer visit that file, and marks it as not modified.
3830 If you specify just a directory name as FILENAME, that means to use
3831 the default file name but in that directory. You can also yank
3832 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3834 If the buffer is not already visiting a file, the default file name
3835 for the output file is the buffer name.
3837 If optional second arg CONFIRM is non-nil, this function
3838 asks for confirmation before overwriting an existing file.
3839 Interactively, confirmation is required unless you supply a prefix argument."
3840 ;; (interactive "FWrite file: ")
3842 (list (if buffer-file-name
3843 (read-file-name "Write file: "
3845 (read-file-name "Write file: " default-directory
3847 (file-name-nondirectory (buffer-name))
3850 (not current-prefix-arg
)))
3851 (or (null filename
) (string-equal filename
"")
3853 ;; If arg is just a directory,
3854 ;; use the default file name, but in that directory.
3855 (if (file-directory-p filename
)
3856 (setq filename
(concat (file-name-as-directory filename
)
3857 (file-name-nondirectory
3858 (or buffer-file-name
(buffer-name))))))
3860 (file-exists-p filename
)
3861 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3862 (error "Canceled")))
3863 (set-visited-file-name filename
(not confirm
))))
3864 (set-buffer-modified-p t
)
3865 ;; Make buffer writable if file is writable.
3866 (and buffer-file-name
3867 (file-writable-p buffer-file-name
)
3868 (setq buffer-read-only nil
))
3870 ;; It's likely that the VC status at the new location is different from
3871 ;; the one at the old location.
3872 (vc-find-file-hook))
3874 (defun backup-buffer ()
3875 "Make a backup of the disk file visited by the current buffer, if appropriate.
3876 This is normally done before saving the buffer the first time.
3878 A backup may be done by renaming or by copying; see documentation of
3879 variable `make-backup-files'. If it's done by renaming, then the file is
3880 no longer accessible under its old name.
3882 The value is non-nil after a backup was made by renaming.
3883 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3884 MODES is the result of `file-modes' on the original
3885 file; this means that the caller, after saving the buffer, should change
3886 the modes of the new file to agree with the old modes.
3887 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3888 file; this means that the caller, after saving the buffer, should change
3889 the SELinux context of the new file to agree with the old context.
3890 BACKUPNAME is the backup file name, which is the old file renamed."
3891 (if (and make-backup-files
(not backup-inhibited
)
3892 (not buffer-backed-up
)
3893 (file-exists-p buffer-file-name
)
3894 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3896 (let ((real-file-name buffer-file-name
)
3897 backup-info backupname targets setmodes
)
3898 ;; If specified name is a symbolic link, chase it to the target.
3899 ;; Thus we make the backups in the directory where the real file is.
3900 (setq real-file-name
(file-chase-links real-file-name
))
3901 (setq backup-info
(find-backup-file-name real-file-name
)
3902 backupname
(car backup-info
)
3903 targets
(cdr backup-info
))
3904 ;; (if (file-directory-p buffer-file-name)
3905 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3908 (let ((delete-old-versions
3909 ;; If have old versions to maybe delete,
3910 ;; ask the user to confirm now, before doing anything.
3911 ;; But don't actually delete til later.
3913 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3914 (or delete-old-versions
3915 (y-or-n-p (format "Delete excess backup versions of %s? "
3917 (modes (file-modes buffer-file-name
))
3918 (context (file-selinux-context buffer-file-name
)))
3919 ;; Actually write the back up file.
3921 (if (or file-precious-flag
3922 ; (file-symlink-p buffer-file-name)
3924 ;; Don't rename a suid or sgid file.
3925 (and modes
(< 0 (logand modes
#o6000
)))
3926 (not (file-writable-p (file-name-directory real-file-name
)))
3927 (and backup-by-copying-when-linked
3928 (> (file-nlinks real-file-name
) 1))
3929 (and (or backup-by-copying-when-mismatch
3930 (integerp backup-by-copying-when-privileged-mismatch
))
3931 (let ((attr (file-attributes real-file-name
)))
3932 (and (or backup-by-copying-when-mismatch
3933 (and (integerp (nth 2 attr
))
3934 (integerp backup-by-copying-when-privileged-mismatch
)
3935 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3937 (not (file-ownership-preserved-p real-file-name
)))))))
3938 (backup-buffer-copy real-file-name backupname modes context
)
3939 ;; rename-file should delete old backup.
3940 (rename-file real-file-name backupname t
)
3941 (setq setmodes
(list modes context backupname
)))
3943 ;; If trouble writing the backup, write it in
3944 ;; .emacs.d/%backup%.
3945 (setq backupname
(locate-user-emacs-file "%backup%~"))
3946 (message "Cannot write backup file; backing up in %s"
3949 (backup-buffer-copy real-file-name backupname modes context
)))
3950 (setq buffer-backed-up t
)
3951 ;; Now delete the old versions, if desired.
3952 (if delete-old-versions
3955 (delete-file (car targets
))
3957 (setq targets
(cdr targets
))))
3959 (file-error nil
))))))
3961 (defun backup-buffer-copy (from-name to-name modes context
)
3962 (let ((umask (default-file-modes)))
3965 ;; Create temp files with strict access rights. It's easy to
3966 ;; loosen them later, whereas it's impossible to close the
3967 ;; time-window of loose permissions otherwise.
3968 (set-default-file-modes ?
\700)
3969 (when (condition-case nil
3970 ;; Try to overwrite old backup first.
3971 (copy-file from-name to-name t t t
)
3973 (while (condition-case nil
3975 (when (file-exists-p to-name
)
3976 (delete-file to-name
))
3977 (copy-file from-name to-name nil t t
)
3979 (file-already-exists t
))
3980 ;; The file was somehow created by someone else between
3981 ;; `delete-file' and `copy-file', so let's try again.
3982 ;; rms says "I think there is also a possible race
3983 ;; condition for making backup files" (emacs-devel 20070821).
3986 (set-default-file-modes umask
)))
3988 (set-file-modes to-name
(logand modes
#o1777
)))
3990 (set-file-selinux-context to-name context
)))
3992 (defvar file-name-version-regexp
3993 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)"
3994 ;; The last ~[[:digit]]+ matches relative versions in git,
3995 ;; e.g. `foo.js.~HEAD~1~'.
3996 "Regular expression matching the backup/version part of a file name.
3997 Used by `file-name-sans-versions'.")
3999 (defun file-name-sans-versions (name &optional keep-backup-version
)
4000 "Return file NAME sans backup versions or strings.
4001 This is a separate procedure so your site-init or startup file can
4003 If the optional argument KEEP-BACKUP-VERSION is non-nil,
4004 we do not remove backup version numbers, only true file version numbers.
4005 See also `file-name-version-regexp'."
4006 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
4008 (funcall handler
'file-name-sans-versions name keep-backup-version
)
4010 (unless keep-backup-version
4011 (string-match (concat file-name-version-regexp
"\\'")
4014 (defun file-ownership-preserved-p (file)
4015 "Return t if deleting FILE and rewriting it would preserve the owner."
4016 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
4018 (funcall handler
'file-ownership-preserved-p file
)
4019 (let ((attributes (file-attributes file
'integer
)))
4020 ;; Return t if the file doesn't exist, since it's true that no
4021 ;; information would be lost by an (attempted) delete and create.
4022 (or (null attributes
)
4023 (= (nth 2 attributes
) (user-uid))
4024 ;; Files created on Windows by Administrator (RID=500)
4025 ;; have the Administrators group (RID=544) recorded as
4026 ;; their owner. Rewriting them will still preserve the
4028 (and (eq system-type
'windows-nt
)
4029 (= (user-uid) 500) (= (nth 2 attributes
) 544)))))))
4031 (defun file-name-sans-extension (filename)
4032 "Return FILENAME sans final \"extension\".
4033 The extension, in a file name, is the part that follows the last `.',
4034 except that a leading `.', if any, doesn't count."
4036 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
4038 (if (and (string-match "\\.[^.]*\\'" file
)
4039 (not (eq 0 (match-beginning 0))))
4040 (if (setq directory
(file-name-directory filename
))
4041 ;; Don't use expand-file-name here; if DIRECTORY is relative,
4042 ;; we don't want to expand it.
4043 (concat directory
(substring file
0 (match-beginning 0)))
4044 (substring file
0 (match-beginning 0)))
4047 (defun file-name-extension (filename &optional period
)
4048 "Return FILENAME's final \"extension\".
4049 The extension, in a file name, is the part that follows the last `.',
4050 excluding version numbers and backup suffixes,
4051 except that a leading `.', if any, doesn't count.
4052 Return nil for extensionless file names such as `foo'.
4053 Return the empty string for file names such as `foo.'.
4055 If PERIOD is non-nil, then the returned value includes the period
4056 that delimits the extension, and if FILENAME has no extension,
4059 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
4060 (if (and (string-match "\\.[^.]*\\'" file
)
4061 (not (eq 0 (match-beginning 0))))
4062 (substring file
(+ (match-beginning 0) (if period
0 1)))
4066 (defun file-name-base (&optional filename
)
4067 "Return the base name of the FILENAME: no directory, no extension.
4068 FILENAME defaults to `buffer-file-name'."
4069 (file-name-sans-extension
4070 (file-name-nondirectory (or filename
(buffer-file-name)))))
4072 (defcustom make-backup-file-name-function nil
4073 "A function to use instead of the default `make-backup-file-name'.
4074 A value of nil gives the default `make-backup-file-name' behavior.
4076 This could be buffer-local to do something special for specific
4077 files. If you define it, you may need to change `backup-file-name-p'
4078 and `file-name-sans-versions' too.
4080 See also `backup-directory-alist'."
4082 :type
'(choice (const :tag
"Default" nil
)
4083 (function :tag
"Your function")))
4085 (defcustom backup-directory-alist nil
4086 "Alist of filename patterns and backup directory names.
4087 Each element looks like (REGEXP . DIRECTORY). Backups of files with
4088 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
4089 relative or absolute. If it is absolute, so that all matching files
4090 are backed up into the same directory, the file names in this
4091 directory will be the full name of the file backed up with all
4092 directory separators changed to `!' to prevent clashes. This will not
4093 work correctly if your filesystem truncates the resulting name.
4095 For the common case of all backups going into one directory, the alist
4096 should contain a single element pairing \".\" with the appropriate
4099 If this variable is nil, or it fails to match a filename, the backup
4100 is made in the original file's directory.
4102 On MS-DOS filesystems without long names this variable is always
4105 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
4106 (directory :tag
"Backup directory name"))))
4108 (defun normal-backup-enable-predicate (name)
4109 "Default `backup-enable-predicate' function.
4110 Checks for files in `temporary-file-directory',
4111 `small-temporary-file-directory', and /tmp."
4112 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
4114 ;; Directory is under temporary-file-directory.
4115 (and (not (eq comp t
))
4116 (< comp
(- (length temporary-file-directory
)))))
4117 (let ((comp (compare-strings "/tmp" 0 nil
4119 ;; Directory is under /tmp.
4120 (and (not (eq comp t
))
4121 (< comp
(- (length "/tmp")))))
4122 (if small-temporary-file-directory
4123 (let ((comp (compare-strings small-temporary-file-directory
4126 ;; Directory is under small-temporary-file-directory.
4127 (and (not (eq comp t
))
4128 (< comp
(- (length small-temporary-file-directory
)))))))))
4130 (defun make-backup-file-name (file)
4131 "Create the non-numeric backup file name for FILE.
4132 Normally this will just be the file's name with `~' appended.
4133 Customization hooks are provided as follows.
4135 If the variable `make-backup-file-name-function' is non-nil, its value
4136 should be a function which will be called with FILE as its argument;
4137 the resulting name is used.
4139 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4140 the documentation of that variable. If the directory for the backup
4141 doesn't exist, it is created."
4142 (if make-backup-file-name-function
4143 (funcall make-backup-file-name-function file
)
4144 (if (and (eq system-type
'ms-dos
)
4145 (not (msdos-long-file-names)))
4146 (let ((fn (file-name-nondirectory file
)))
4147 (concat (file-name-directory file
)
4148 (or (and (string-match "\\`[^.]+\\'" fn
)
4149 (concat (match-string 0 fn
) ".~"))
4150 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
4151 (concat (match-string 0 fn
) "~")))))
4152 (concat (make-backup-file-name-1 file
) "~"))))
4154 (defun make-backup-file-name-1 (file)
4155 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4156 (let ((alist backup-directory-alist
)
4157 elt backup-directory abs-backup-directory
)
4159 (setq elt
(pop alist
))
4160 (if (string-match (car elt
) file
)
4161 (setq backup-directory
(cdr elt
)
4163 ;; If backup-directory is relative, it should be relative to the
4164 ;; file's directory. By expanding explicitly here, we avoid
4165 ;; depending on default-directory.
4166 (if backup-directory
4167 (setq abs-backup-directory
4168 (expand-file-name backup-directory
4169 (file-name-directory file
))))
4170 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
4172 (make-directory abs-backup-directory
'parents
)
4173 (file-error (setq backup-directory nil
4174 abs-backup-directory nil
))))
4175 (if (null backup-directory
)
4177 (if (file-name-absolute-p backup-directory
)
4179 (when (memq system-type
'(windows-nt ms-dos cygwin
))
4180 ;; Normalize DOSish file names: downcase the drive
4181 ;; letter, if any, and replace the leading "x:" with
4183 (or (file-name-absolute-p file
)
4184 (setq file
(expand-file-name file
))) ; make defaults explicit
4185 ;; Replace any invalid file-name characters (for the
4186 ;; case of backing up remote files).
4187 (setq file
(expand-file-name (convert-standard-filename file
)))
4188 (if (eq (aref file
1) ?
:)
4189 (setq file
(concat "/"
4191 (char-to-string (downcase (aref file
0)))
4192 (if (eq (aref file
2) ?
/)
4195 (substring file
2)))))
4196 ;; Make the name unique by substituting directory
4197 ;; separators. It may not really be worth bothering about
4198 ;; doubling `!'s in the original name...
4200 (subst-char-in-string
4202 (replace-regexp-in-string "!" "!!" file
))
4204 (expand-file-name (file-name-nondirectory file
)
4205 (file-name-as-directory abs-backup-directory
))))))
4207 (defun backup-file-name-p (file)
4208 "Return non-nil if FILE is a backup file name (numeric or not).
4209 This is a separate function so you can redefine it for customization.
4210 You may need to redefine `file-name-sans-versions' as well."
4211 (string-match "~\\'" file
))
4213 (defvar backup-extract-version-start
)
4215 ;; This is used in various files.
4216 ;; The usage of backup-extract-version-start is not very clean,
4217 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4218 (defun backup-extract-version (fn)
4219 "Given the name of a numeric backup file, FN, return the backup number.
4220 Uses the free variable `backup-extract-version-start', whose value should be
4221 the index in the name where the version number begins."
4222 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start
)
4223 (= (match-beginning 0) backup-extract-version-start
))
4224 (string-to-number (substring fn backup-extract-version-start -
1))
4227 (defun find-backup-file-name (fn)
4228 "Find a file name for a backup file FN, and suggestions for deletions.
4229 Value is a list whose car is the name for the backup file
4230 and whose cdr is a list of old versions to consider deleting now.
4231 If the value is nil, don't make a backup.
4232 Uses `backup-directory-alist' in the same way as does
4233 `make-backup-file-name'."
4234 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
4235 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4237 (funcall handler
'find-backup-file-name fn
)
4238 (if (or (eq version-control
'never
)
4239 ;; We don't support numbered backups on plain MS-DOS
4240 ;; when long file names are unavailable.
4241 (and (eq system-type
'ms-dos
)
4242 (not (msdos-long-file-names))))
4243 (list (make-backup-file-name fn
))
4244 (let* ((basic-name (make-backup-file-name-1 fn
))
4245 (base-versions (concat (file-name-nondirectory basic-name
)
4247 (backup-extract-version-start (length base-versions
))
4249 (number-to-delete 0)
4250 possibilities deserve-versions-p versions
)
4252 (setq possibilities
(file-name-all-completions
4254 (file-name-directory basic-name
))
4255 versions
(sort (mapcar #'backup-extract-version
4258 high-water-mark
(apply 'max
0 versions
)
4259 deserve-versions-p
(or version-control
4260 (> high-water-mark
0))
4261 number-to-delete
(- (length versions
)
4265 (file-error (setq possibilities nil
)))
4266 (if (not deserve-versions-p
)
4267 (list (make-backup-file-name fn
))
4268 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
4269 (if (and (> number-to-delete
0)
4270 ;; Delete nothing if there is overflow
4271 ;; in the number of versions to keep.
4272 (>= (+ kept-new-versions kept-old-versions -
1) 0))
4274 (format "%s.~%d~" basic-name n
))
4275 (let ((v (nthcdr kept-old-versions versions
)))
4276 (rplacd (nthcdr (1- number-to-delete
) v
) ())
4279 (defun file-nlinks (filename)
4280 "Return number of names file FILENAME has."
4281 (car (cdr (file-attributes filename
))))
4283 ;; (defun file-relative-name (filename &optional directory)
4284 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4285 ;; This function returns a relative file name which is equivalent to FILENAME
4286 ;; when used with that default directory as the default.
4287 ;; If this is impossible (which can happen on MSDOS and Windows
4288 ;; when the file name and directory use different drive names)
4289 ;; then it returns FILENAME."
4291 ;; (let ((fname (expand-file-name filename)))
4292 ;; (setq directory (file-name-as-directory
4293 ;; (expand-file-name (or directory default-directory))))
4294 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4295 ;; ;; drive names, they can't be relative, so return the absolute name.
4296 ;; (if (and (or (eq system-type 'ms-dos)
4297 ;; (eq system-type 'cygwin)
4298 ;; (eq system-type 'windows-nt))
4299 ;; (not (string-equal (substring fname 0 2)
4300 ;; (substring directory 0 2))))
4302 ;; (let ((ancestor ".")
4303 ;; (fname-dir (file-name-as-directory fname)))
4304 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4305 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4306 ;; (setq directory (file-name-directory (substring directory 0 -1))
4307 ;; ancestor (if (equal ancestor ".")
4309 ;; (concat "../" ancestor))))
4310 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4311 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4312 ;; ;; We matched within FNAME's directory part.
4313 ;; ;; Add the rest of FNAME onto ANCESTOR.
4314 ;; (let ((rest (substring fname (match-end 0))))
4315 ;; (if (and (equal ancestor ".")
4316 ;; (not (equal rest "")))
4317 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4319 ;; (concat (file-name-as-directory ancestor) rest)))
4320 ;; ;; We matched FNAME's directory equivalent.
4323 (defun file-relative-name (filename &optional directory
)
4324 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4325 This function returns a relative file name which is equivalent to FILENAME
4326 when used with that default directory as the default.
4327 If FILENAME and DIRECTORY lie on different machines or on different drives
4328 on a DOS/Windows machine, it returns FILENAME in expanded form."
4331 (file-name-as-directory (expand-file-name (or directory
4332 default-directory
))))
4333 (setq filename
(expand-file-name filename
))
4334 (let ((fremote (file-remote-p filename
))
4335 (dremote (file-remote-p directory
))
4336 (fold-case (or (memq system-type
'(ms-dos cygwin windows-nt
))
4337 read-file-name-completion-ignore-case
)))
4338 (if ;; Conditions for separate trees
4340 ;; Test for different filesystems on DOS/Windows
4342 ;; Should `cygwin' really be included here? --stef
4343 (memq system-type
'(ms-dos cygwin windows-nt
))
4345 ;; Test for different drive letters
4346 (not (eq t
(compare-strings filename
0 2 directory
0 2 fold-case
)))
4347 ;; Test for UNCs on different servers
4348 (not (eq t
(compare-strings
4350 (if (string-match "\\`//\\([^:/]+\\)/" filename
)
4351 (match-string 1 filename
)
4352 ;; Windows file names cannot have ? in
4353 ;; them, so use that to detect when
4354 ;; neither FILENAME nor DIRECTORY is a
4359 (if (string-match "\\`//\\([^:/]+\\)/" directory
)
4360 (match-string 1 directory
)
4363 ;; Test for different remote file system identification
4364 (not (equal fremote dremote
)))
4366 (let ((ancestor ".")
4367 (filename-dir (file-name-as-directory filename
)))
4370 (eq t
(compare-strings filename-dir nil
(length directory
)
4371 directory nil nil fold-case
))
4372 (eq t
(compare-strings filename nil
(length directory
)
4373 directory nil nil fold-case
))))
4374 (setq directory
(file-name-directory (substring directory
0 -
1))
4375 ancestor
(if (equal ancestor
".")
4377 (concat "../" ancestor
))))
4378 ;; Now ancestor is empty, or .., or ../.., etc.
4379 (if (eq t
(compare-strings filename nil
(length directory
)
4380 directory nil nil fold-case
))
4381 ;; We matched within FILENAME's directory part.
4382 ;; Add the rest of FILENAME onto ANCESTOR.
4383 (let ((rest (substring filename
(length directory
))))
4384 (if (and (equal ancestor
".") (not (equal rest
"")))
4385 ;; But don't bother with ANCESTOR if it would give us `./'.
4387 (concat (file-name-as-directory ancestor
) rest
)))
4388 ;; We matched FILENAME's directory equivalent.
4391 (defun save-buffer (&optional args
)
4392 "Save current buffer in visited file if modified.
4393 Variations are described below.
4395 By default, makes the previous version into a backup file
4396 if previously requested or if this is the first save.
4397 Prefixed with one \\[universal-argument], marks this version
4398 to become a backup when the next save is done.
4399 Prefixed with two \\[universal-argument]'s,
4400 unconditionally makes the previous version into a backup file.
4401 Prefixed with three \\[universal-argument]'s, marks this version
4402 to become a backup when the next save is done,
4403 and unconditionally makes the previous version into a backup file.
4405 With a numeric argument of 0, never make the previous version
4408 If a file's name is FOO, the names of its numbered backup versions are
4409 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4410 Numeric backups (rather than FOO~) will be made if value of
4411 `version-control' is not the atom `never' and either there are already
4412 numeric versions of the file being backed up, or `version-control' is
4414 We don't want excessive versions piling up, so there are variables
4415 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4416 and `kept-new-versions', which tells how many newest versions to keep.
4417 Defaults are 2 old versions and 2 new.
4418 `dired-kept-versions' controls dired's clean-directory (.) command.
4419 If `delete-old-versions' is nil, system will query user
4420 before trimming versions. Otherwise it does it silently.
4422 If `vc-make-backup-files' is nil, which is the default,
4423 no backup files are made for files managed by version control.
4424 (This is because the version control system itself records previous versions.)
4426 See the subroutine `basic-save-buffer' for more information."
4428 (let ((modp (buffer-modified-p))
4429 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
4430 (memq args
'(16 64)))))
4431 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
4432 ;; We used to display the message below only for files > 50KB, but
4433 ;; then Rmail-mbox never displays it due to buffer swapping. If
4434 ;; the test is ever re-introduced, be sure to handle saving of
4436 (if (and modp
(buffer-file-name))
4437 (message "Saving file %s..." (buffer-file-name)))
4439 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
4441 (defun delete-auto-save-file-if-necessary (&optional force
)
4442 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4443 Normally delete only if the file was written by this Emacs since
4444 the last real save, but optional arg FORCE non-nil means delete anyway."
4445 (and buffer-auto-save-file-name delete-auto-save-files
4446 (not (string= buffer-file-name buffer-auto-save-file-name
))
4447 (or force
(recent-auto-save-p))
4450 (delete-file buffer-auto-save-file-name
)
4452 (set-buffer-auto-saved))))
4454 (defvar auto-save-hook nil
4455 "Normal hook run just before auto-saving.")
4457 (defcustom before-save-hook nil
4458 "Normal hook that is run before a buffer is saved to its file."
4459 :options
'(copyright-update time-stamp
)
4463 (defcustom after-save-hook nil
4464 "Normal hook that is run after a buffer is saved to its file."
4465 :options
'(executable-make-buffer-file-executable-if-script-p)
4469 (defvar save-buffer-coding-system nil
4470 "If non-nil, use this coding system for saving the buffer.
4471 More precisely, use this coding system in place of the
4472 value of `buffer-file-coding-system', when saving the buffer.
4473 Calling `write-region' for any purpose other than saving the buffer
4474 will still use `buffer-file-coding-system'; this variable has no effect
4477 (make-variable-buffer-local 'save-buffer-coding-system
)
4478 (put 'save-buffer-coding-system
'permanent-local t
)
4480 (defun basic-save-buffer ()
4481 "Save the current buffer in its visited file, if it has been modified.
4482 The hooks `write-contents-functions' and `write-file-functions' get a chance
4483 to do the job of saving; if they do not, then the buffer is saved in
4484 the visited file in the usual way.
4485 Before and after saving the buffer, this function runs
4486 `before-save-hook' and `after-save-hook', respectively."
4488 (save-current-buffer
4489 ;; In an indirect buffer, save its base buffer instead.
4490 (if (buffer-base-buffer)
4491 (set-buffer (buffer-base-buffer)))
4492 (if (or (buffer-modified-p)
4493 ;; handle the case when no modification has been made but
4494 ;; the file disappeared since visited
4495 (and buffer-file-name
4496 (not (file-exists-p buffer-file-name
))))
4497 (let ((recent-save (recent-auto-save-p))
4499 ;; If buffer has no file name, ask user for one.
4500 (or buffer-file-name
4503 (read-file-name "File to save in: ") nil
)))
4504 (if (file-exists-p filename
)
4505 (if (file-directory-p filename
)
4506 ;; Signal an error if the user specified the name of an
4507 ;; existing directory.
4508 (error "%s is a directory" filename
)
4509 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4511 (error "Canceled")))
4512 ;; Signal an error if the specified name refers to a
4513 ;; non-existing directory.
4514 (let ((dir (file-name-directory filename
)))
4515 (unless (file-directory-p dir
)
4516 (if (file-exists-p dir
)
4517 (error "%s is not a directory" dir
)
4518 (error "%s: no such directory" dir
)))))
4519 (set-visited-file-name filename
)))
4520 (or (verify-visited-file-modtime (current-buffer))
4521 (not (file-exists-p buffer-file-name
))
4524 "%s has changed since visited or saved. Save anyway? "
4525 (file-name-nondirectory buffer-file-name
)))
4526 (user-error "Save not confirmed"))
4530 (and (> (point-max) (point-min))
4531 (not find-file-literally
)
4532 (/= (char-after (1- (point-max))) ?
\n)
4533 (not (and (eq selective-display t
)
4534 (= (char-after (1- (point-max))) ?
\r)))
4535 (or (eq require-final-newline t
)
4536 (eq require-final-newline
'visit-save
)
4537 (and require-final-newline
4539 (format "Buffer %s does not end in newline. Add one? "
4542 (goto-char (point-max))
4544 ;; Support VC version backups.
4546 (run-hooks 'before-save-hook
)
4547 (or (run-hook-with-args-until-success 'write-contents-functions
)
4548 (run-hook-with-args-until-success 'local-write-file-hooks
)
4549 (run-hook-with-args-until-success 'write-file-functions
)
4550 ;; If a hook returned t, file is already "written".
4551 ;; Otherwise, write it the usual way now.
4552 (setq setmodes
(basic-save-buffer-1)))
4553 ;; Now we have saved the current buffer. Let's make sure
4554 ;; that buffer-file-coding-system is fixed to what
4555 ;; actually used for saving by binding it locally.
4556 (if save-buffer-coding-system
4557 (setq save-buffer-coding-system last-coding-system-used
)
4558 (setq buffer-file-coding-system last-coding-system-used
))
4559 (setq buffer-file-number
4560 (nthcdr 10 (file-attributes buffer-file-name
)))
4564 (set-file-modes buffer-file-name
(car setmodes
))
4565 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))
4567 ;; If the auto-save file was recent before this command,
4569 (delete-auto-save-file-if-necessary recent-save
)
4570 ;; Support VC `implicit' locking.
4572 (run-hooks 'after-save-hook
))
4573 (message "(No changes need to be saved)"))))
4575 ;; This does the "real job" of writing a buffer into its visited file
4576 ;; and making a backup file. This is what is normally done
4577 ;; but inhibited if one of write-file-functions returns non-nil.
4578 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4579 (defun basic-save-buffer-1 ()
4581 (if save-buffer-coding-system
4582 (let ((coding-system-for-write save-buffer-coding-system
))
4583 (basic-save-buffer-2))
4584 (basic-save-buffer-2))
4585 (if buffer-file-coding-system-explicit
4586 (setcar buffer-file-coding-system-explicit last-coding-system-used
)
4587 (setq buffer-file-coding-system-explicit
4588 (cons last-coding-system-used nil
)))))
4590 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4591 (defun basic-save-buffer-2 ()
4592 (let (tempsetmodes setmodes
)
4593 (if (not (file-writable-p buffer-file-name
))
4594 (let ((dir (file-name-directory buffer-file-name
)))
4595 (if (not (file-directory-p dir
))
4596 (if (file-exists-p dir
)
4597 (error "%s is not a directory" dir
)
4598 (error "%s: no such directory" dir
))
4599 (if (not (file-exists-p buffer-file-name
))
4600 (error "Directory %s write-protected" dir
)
4603 "File %s is write-protected; try to save anyway? "
4604 (file-name-nondirectory
4606 (setq tempsetmodes t
)
4607 (error "Attempt to save to a file which you aren't allowed to write"))))))
4608 (or buffer-backed-up
4609 (setq setmodes
(backup-buffer)))
4610 (let* ((dir (file-name-directory buffer-file-name
))
4611 (dir-writable (file-writable-p dir
)))
4612 (if (or (and file-precious-flag dir-writable
)
4613 (and break-hardlink-on-save
4614 (file-exists-p buffer-file-name
)
4615 (> (file-nlinks buffer-file-name
) 1)
4617 (error (concat (format
4618 "Directory %s write-protected; " dir
)
4619 "cannot break hardlink when saving")))))
4620 ;; Write temp name, then rename it.
4621 ;; This requires write access to the containing dir,
4622 ;; which is why we don't try it if we don't have that access.
4623 (let ((realname buffer-file-name
)
4625 (umask (default-file-modes))
4626 (old-modtime (visited-file-modtime)))
4627 ;; Create temp files with strict access rights. It's easy to
4628 ;; loosen them later, whereas it's impossible to close the
4629 ;; time-window of loose permissions otherwise.
4632 (clear-visited-file-modtime)
4633 (set-default-file-modes ?
\700)
4634 ;; Try various temporary names.
4635 ;; This code follows the example of make-temp-file,
4636 ;; but it calls write-region in the appropriate way
4637 ;; for saving the buffer.
4638 (while (condition-case ()
4642 (expand-file-name "tmp" dir
)))
4643 ;; Pass in nil&nil rather than point-min&max
4644 ;; cause we're saving the whole buffer.
4645 ;; write-region-annotate-functions may use it.
4646 (write-region nil nil
4647 tempname nil realname
4648 buffer-file-truename
'excl
)
4650 (file-already-exists t
))
4651 ;; The file was somehow created by someone else between
4652 ;; `make-temp-name' and `write-region', let's try again.
4656 (set-default-file-modes umask
)
4657 ;; If we failed, restore the buffer's modtime.
4659 (set-visited-file-modtime old-modtime
)))
4660 ;; Since we have created an entirely new file,
4661 ;; make sure it gets the right permission bits set.
4662 (setq setmodes
(or setmodes
4663 (list (or (file-modes buffer-file-name
)
4664 (logand ?
\666 umask
))
4665 (file-selinux-context buffer-file-name
)
4667 ;; We succeeded in writing the temp file,
4669 (rename-file tempname buffer-file-name t
))
4670 ;; If file not writable, see if we can make it writable
4671 ;; temporarily while we write it.
4672 ;; But no need to do so if we have just backed it up
4673 ;; (setmodes is set) because that says we're superseding.
4674 (cond ((and tempsetmodes
(not setmodes
))
4675 ;; Change the mode back, after writing.
4676 (setq setmodes
(list (file-modes buffer-file-name
)
4677 (file-selinux-context buffer-file-name
)
4679 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))
4680 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))))
4684 ;; Pass in nil&nil rather than point-min&max to indicate
4685 ;; we're saving the buffer rather than just a region.
4686 ;; write-region-annotate-functions may make us of it.
4687 (write-region nil nil
4688 buffer-file-name nil t buffer-file-truename
)
4690 ;; If we get an error writing the new file, and we made
4691 ;; the backup by renaming, undo the backing-up.
4692 (and setmodes
(not success
)
4694 (rename-file (nth 2 setmodes
) buffer-file-name t
)
4695 (setq buffer-backed-up nil
))))))
4698 (declare-function diff-no-select
"diff"
4699 (old new
&optional switches no-async buf
))
4701 (defvar save-some-buffers-action-alist
4704 (if (not enable-recursive-minibuffers
)
4705 (progn (display-buffer buf
)
4706 (setq other-window-scroll-buffer buf
))
4707 (view-buffer buf
(lambda (_) (exit-recursive-edit)))
4709 ;; Return nil to ask about BUF again.
4711 ,(purecopy "view this buffer"))
4713 (if (null (buffer-file-name buf
))
4714 (message "Not applicable: no file")
4715 (require 'diff
) ;for diff-no-select.
4716 (let ((diffbuf (diff-no-select (buffer-file-name buf
) buf
4718 (if (not enable-recursive-minibuffers
)
4719 (progn (display-buffer diffbuf
)
4720 (setq other-window-scroll-buffer diffbuf
))
4721 (view-buffer diffbuf
(lambda (_) (exit-recursive-edit)))
4723 ;; Return nil to ask about BUF again.
4725 ,(purecopy "view changes in this buffer")))
4726 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4727 (put 'save-some-buffers-action-alist
'risky-local-variable t
)
4729 (defvar buffer-save-without-query nil
4730 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4731 (make-variable-buffer-local 'buffer-save-without-query
)
4733 (defun save-some-buffers (&optional arg pred
)
4734 "Save some modified file-visiting buffers. Asks user about each one.
4735 You can answer `y' to save, `n' not to save, `C-r' to look at the
4736 buffer in question with `view-buffer' before deciding or `d' to
4737 view the differences using `diff-buffer-with-file'.
4739 This command first saves any buffers where `buffer-save-without-query' is
4740 non-nil, without asking.
4742 Optional argument (the prefix) non-nil means save all with no questions.
4743 Optional second argument PRED determines which buffers are considered:
4744 If PRED is nil, all the file-visiting buffers are considered.
4745 If PRED is t, then certain non-file buffers will also be considered.
4746 If PRED is a zero-argument function, it indicates for each buffer whether
4747 to consider it or not when called with that buffer current.
4749 See `save-some-buffers-action-alist' if you want to
4750 change the additional actions you can take on files."
4752 (save-window-excursion
4753 (let* (queried autosaved-buffers
4754 files-done abbrevs-done
)
4755 (dolist (buffer (buffer-list))
4756 ;; First save any buffers that we're supposed to save unconditionally.
4757 ;; That way the following code won't ask about them.
4758 (with-current-buffer buffer
4759 (when (and buffer-save-without-query
(buffer-modified-p))
4760 (push (buffer-name) autosaved-buffers
)
4762 ;; Ask about those buffers that merit it,
4763 ;; and record the number thus saved.
4767 ;; Note that killing some buffers may kill others via
4768 ;; hooks (e.g. Rmail and its viewing buffer).
4769 (and (buffer-live-p buffer
)
4770 (buffer-modified-p buffer
)
4771 (not (buffer-base-buffer buffer
))
4773 (buffer-file-name buffer
)
4777 (and buffer-offer-save
(> (buffer-size) 0)))))
4778 (or (not (functionp pred
))
4779 (with-current-buffer buffer
(funcall pred
)))
4783 (if (buffer-file-name buffer
)
4784 (format "Save file %s? "
4785 (buffer-file-name buffer
))
4786 (format "Save buffer %s? "
4787 (buffer-name buffer
))))))
4789 (with-current-buffer buffer
4792 '("buffer" "buffers" "save")
4793 save-some-buffers-action-alist
))
4794 ;; Maybe to save abbrevs, and record whether
4795 ;; we either saved them or asked to.
4796 (and save-abbrevs abbrevs-changed
4799 (eq save-abbrevs
'silently
)
4800 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name
)))
4801 (write-abbrev-file nil
))
4802 ;; Don't keep bothering user if he says no.
4803 (setq abbrevs-changed nil
)
4804 (setq abbrevs-done t
)))
4805 (or queried
(> files-done
0) abbrevs-done
4807 ((null autosaved-buffers
)
4808 (message "(No files need saving)"))
4809 ((= (length autosaved-buffers
) 1)
4810 (message "(Saved %s)" (car autosaved-buffers
)))
4812 (message "(Saved %d files: %s)"
4813 (length autosaved-buffers
)
4814 (mapconcat 'identity autosaved-buffers
", "))))))))
4816 (defun not-modified (&optional arg
)
4817 "Mark current buffer as unmodified, not needing to be saved.
4818 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4820 It is not a good idea to use this function in Lisp programs, because it
4821 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4823 (message (if arg
"Modification-flag set"
4824 "Modification-flag cleared"))
4825 (set-buffer-modified-p arg
))
4827 (defun toggle-read-only (&optional arg
)
4828 "Change whether this buffer is read-only.
4829 With prefix argument ARG, make the buffer read-only if ARG is
4830 positive, otherwise make it writable. If buffer is read-only
4831 and `view-read-only' is non-nil, enter view mode.
4833 This function is usually the wrong thing to use in a Lisp program.
4834 It can have side-effects beyond changing the read-only status of a buffer
4835 \(e.g., enabling view mode), and does not affect read-only regions that
4836 are caused by text properties. To make a buffer read-only in Lisp code,
4837 set `buffer-read-only'. To ignore read-only status (whether due to text
4838 properties or buffer state) and make changes, temporarily bind
4839 `inhibit-read-only'."
4842 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4843 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4848 ((and buffer-read-only view-mode
)
4849 (View-exit-and-edit)
4850 (make-local-variable 'view-read-only
)
4851 (setq view-read-only t
)) ; Must leave view mode.
4852 ((and (not buffer-read-only
) view-read-only
4853 ;; If view-mode is already active, `view-mode-enter' is a nop.
4855 (not (eq (get major-mode
'mode-class
) 'special
)))
4857 (t (setq buffer-read-only
(not buffer-read-only
))
4858 (force-mode-line-update))))
4859 (message "Read-only %s for this buffer"
4860 (if buffer-read-only
"enabled" "disabled"))))
4862 (defun insert-file (filename)
4863 "Insert contents of file FILENAME into buffer after point.
4864 Set mark after the inserted text.
4866 This function is meant for the user to run interactively.
4867 Don't call it from programs! Use `insert-file-contents' instead.
4868 \(Its calling sequence is different; see its documentation)."
4869 (interactive "*fInsert file: ")
4870 (insert-file-1 filename
#'insert-file-contents
))
4872 (defun append-to-file (start end filename
)
4873 "Append the contents of the region to the end of file FILENAME.
4874 When called from a function, expects three arguments,
4875 START, END and FILENAME. START and END are normally buffer positions
4876 specifying the part of the buffer to write.
4877 If START is nil, that means to use the entire buffer contents.
4878 If START is a string, then output that string to the file
4879 instead of any buffer contents; END is ignored.
4881 This does character code conversion and applies annotations
4882 like `write-region' does."
4883 (interactive "r\nFAppend to file: ")
4884 (write-region start end filename t
))
4886 (defun file-newest-backup (filename)
4887 "Return most recent backup file for FILENAME or nil if no backups exist."
4888 ;; `make-backup-file-name' will get us the right directory for
4889 ;; ordinary or numeric backups. It might create a directory for
4890 ;; backups as a side-effect, according to `backup-directory-alist'.
4891 (let* ((filename (file-name-sans-versions
4892 (make-backup-file-name (expand-file-name filename
))))
4893 (file (file-name-nondirectory filename
))
4894 (dir (file-name-directory filename
))
4895 (comp (file-name-all-completions file dir
))
4899 (setq tem
(pop comp
))
4900 (cond ((and (backup-file-name-p tem
)
4901 (string= (file-name-sans-versions tem
) file
))
4902 (setq tem
(concat dir tem
))
4903 (if (or (null newest
)
4904 (file-newer-than-file-p tem newest
))
4905 (setq newest tem
)))))
4908 (defun rename-uniquely ()
4909 "Rename current buffer to a similar name not already taken.
4910 This function is useful for creating multiple shell process buffers
4911 or multiple mail buffers, etc.
4913 Note that some commands, in particular those based on `compilation-mode'
4914 \(`compile', `grep', etc.) will reuse the current buffer if it has the
4915 appropriate mode even if it has been renamed. So as well as renaming
4916 the buffer, you also need to switch buffers before running another
4917 instance of such commands."
4920 (let ((base-name (buffer-name)))
4921 (and (string-match "<[0-9]+>\\'" base-name
)
4922 (not (and buffer-file-name
4924 (file-name-nondirectory buffer-file-name
))))
4925 ;; If the existing buffer name has a <NNN>,
4926 ;; which isn't part of the file name (if any),
4927 ;; then get rid of that.
4928 (setq base-name
(substring base-name
0 (match-beginning 0))))
4929 (rename-buffer (generate-new-buffer-name base-name
))
4930 (force-mode-line-update))))
4932 (defun make-directory (dir &optional parents
)
4933 "Create the directory DIR and optionally any nonexistent parent dirs.
4934 If DIR already exists as a directory, signal an error, unless
4937 Interactively, the default choice of directory to create is the
4938 current buffer's default directory. That is useful when you have
4939 visited a file in a nonexistent directory.
4941 Noninteractively, the second (optional) argument PARENTS, if
4942 non-nil, says whether to create parent directories that don't
4943 exist. Interactively, this happens by default.
4945 If creating the directory or directories fail, an error will be
4948 (list (read-file-name "Make directory: " default-directory default-directory
4951 ;; If default-directory is a remote directory,
4952 ;; make sure we find its make-directory handler.
4953 (setq dir
(expand-file-name dir
))
4954 (let ((handler (find-file-name-handler dir
'make-directory
)))
4956 (funcall handler
'make-directory dir parents
)
4958 (make-directory-internal dir
)
4959 (let ((dir (directory-file-name (expand-file-name dir
)))
4961 (while (and (not (file-exists-p dir
))
4962 ;; If directory is its own parent, then we can't
4963 ;; keep looping forever
4965 (directory-file-name
4966 (file-name-directory dir
)))))
4967 (setq create-list
(cons dir create-list
)
4968 dir
(directory-file-name (file-name-directory dir
))))
4970 (make-directory-internal (car create-list
))
4971 (setq create-list
(cdr create-list
))))))))
4973 (defconst directory-files-no-dot-files-regexp
4974 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4975 "Regexp matching any file name except \".\" and \"..\".")
4977 (defun delete-directory (directory &optional recursive trash
)
4978 "Delete the directory named DIRECTORY. Does not follow symlinks.
4979 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4980 TRASH non-nil means to trash the directory instead, provided
4981 `delete-by-moving-to-trash' is non-nil.
4983 When called interactively, TRASH is t if no prefix argument is
4984 given. With a prefix argument, TRASH is nil."
4986 (let* ((trashing (and delete-by-moving-to-trash
4987 (null current-prefix-arg
)))
4988 (dir (expand-file-name
4989 (read-directory-name
4991 "Move directory to trash: "
4992 "Delete directory: ")
4993 default-directory default-directory nil nil
))))
4995 (if (directory-files dir nil directory-files-no-dot-files-regexp
)
4997 (format "Directory `%s' is not empty, really %s? "
4998 dir
(if trashing
"trash" "delete")))
5000 (null current-prefix-arg
))))
5001 ;; If default-directory is a remote directory, make sure we find its
5002 ;; delete-directory handler.
5003 (setq directory
(directory-file-name (expand-file-name directory
)))
5004 (let ((handler (find-file-name-handler directory
'delete-directory
)))
5007 (funcall handler
'delete-directory directory recursive
))
5008 ((and delete-by-moving-to-trash trash
)
5009 ;; Only move non-empty dir to trash if recursive deletion was
5010 ;; requested. This mimics the non-`delete-by-moving-to-trash'
5011 ;; case, where the operation fails in delete-directory-internal.
5012 ;; As `move-file-to-trash' trashes directories (empty or
5013 ;; otherwise) as a unit, we do not need to recurse here.
5014 (if (and (not recursive
)
5015 ;; Check if directory is empty apart from "." and "..".
5017 directory
'full directory-files-no-dot-files-regexp
))
5018 (error "Directory is not empty, not moving to trash")
5019 (move-file-to-trash directory
)))
5020 ;; Otherwise, call ourselves recursively if needed.
5022 (if (and recursive
(not (file-symlink-p directory
)))
5023 (mapc (lambda (file)
5024 ;; This test is equivalent to
5025 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
5026 ;; but more efficient
5027 (if (eq t
(car (file-attributes file
)))
5028 (delete-directory file recursive nil
)
5029 (delete-file file nil
)))
5030 ;; We do not want to delete "." and "..".
5032 directory
'full directory-files-no-dot-files-regexp
)))
5033 (delete-directory-internal directory
)))))
5035 (defun file-equal-p (file1 file2
)
5036 "Return non-nil if files FILE1 and FILE2 name the same file.
5037 If FILE1 or FILE2 does not exist, the return value is unspecified."
5038 (let ((handler (or (find-file-name-handler file1
'file-equal-p
)
5039 (find-file-name-handler file2
'file-equal-p
))))
5041 (funcall handler
'file-equal-p file1 file2
)
5042 (let (f1-attr f2-attr
)
5043 (and (setq f1-attr
(file-attributes (file-truename file1
)))
5044 (setq f2-attr
(file-attributes (file-truename file2
)))
5045 (equal f1-attr f2-attr
))))))
5047 (defun file-in-directory-p (file dir
)
5048 "Return non-nil if FILE is in DIR or a subdirectory of DIR.
5049 A directory is considered to be \"in\" itself.
5050 Return nil if DIR is not an existing directory."
5051 (let ((handler (or (find-file-name-handler file
'file-in-directory-p
)
5052 (find-file-name-handler dir
'file-in-directory-p
))))
5054 (funcall handler
'file-in-directory-p file dir
)
5055 (when (file-directory-p dir
) ; DIR must exist.
5056 (setq file
(file-truename file
)
5057 dir
(file-truename dir
))
5058 (let ((ls1 (split-string file
"/" t
))
5059 (ls2 (split-string dir
"/" t
))
5060 (root (if (string-match "\\`/" file
) "/" ""))
5062 (while (and ls1 ls2
(not mismatch
))
5063 (if (string-equal (car ls1
) (car ls2
))
5064 (setq root
(concat root
(car ls1
) "/"))
5069 (file-equal-p root dir
)))))))
5071 (defun copy-directory (directory newname
&optional keep-time parents copy-contents
)
5072 "Copy DIRECTORY to NEWNAME. Both args must be strings.
5073 This function always sets the file modes of the output files to match
5074 the corresponding input file.
5076 The third arg KEEP-TIME non-nil means give the output files the same
5077 last-modified time as the old ones. (This works on only some systems.)
5079 A prefix arg makes KEEP-TIME non-nil.
5081 Noninteractively, the last argument PARENTS says whether to
5082 create parent directories if they don't exist. Interactively,
5083 this happens by default.
5085 If NEWNAME names an existing directory, copy DIRECTORY as a
5086 subdirectory there. However, if called from Lisp with a non-nil
5087 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
5088 directly into NEWNAME instead."
5090 (let ((dir (read-directory-name
5091 "Copy directory: " default-directory default-directory t nil
)))
5093 (read-directory-name
5094 (format "Copy directory %s to: " dir
)
5095 default-directory default-directory nil nil
)
5096 current-prefix-arg t nil
)))
5097 (when (file-in-directory-p newname directory
)
5098 (error "Cannot copy `%s' into its subdirectory `%s'"
5100 ;; If default-directory is a remote directory, make sure we find its
5101 ;; copy-directory handler.
5102 (let ((handler (or (find-file-name-handler directory
'copy-directory
)
5103 (find-file-name-handler newname
'copy-directory
))))
5105 (funcall handler
'copy-directory directory
5106 newname keep-time parents copy-contents
)
5108 ;; Compute target name.
5109 (setq directory
(directory-file-name (expand-file-name directory
))
5110 newname
(directory-file-name (expand-file-name newname
)))
5112 (cond ((not (file-directory-p newname
))
5113 ;; If NEWNAME is not an existing directory, create it;
5114 ;; that is where we will copy the files of DIRECTORY.
5115 (make-directory newname parents
))
5116 ;; If NEWNAME is an existing directory and COPY-CONTENTS
5117 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
5118 ((not copy-contents
)
5119 (setq newname
(expand-file-name
5120 (file-name-nondirectory
5121 (directory-file-name directory
))
5123 (and (file-exists-p newname
)
5124 (not (file-directory-p newname
))
5125 (error "Cannot overwrite non-directory %s with a directory"
5127 (make-directory newname t
)))
5129 ;; Copy recursively.
5131 ;; We do not want to copy "." and "..".
5132 (directory-files directory
'full
5133 directory-files-no-dot-files-regexp
))
5134 (let ((target (expand-file-name (file-name-nondirectory file
) newname
))
5135 (filetype (car (file-attributes file
))))
5137 ((eq filetype t
) ; Directory but not a symlink.
5138 (copy-directory file newname keep-time parents
))
5139 ((stringp filetype
) ; Symbolic link
5140 (make-symbolic-link filetype target t
))
5141 ((copy-file file target t keep-time
)))))
5143 ;; Set directory attributes.
5144 (let ((modes (file-modes directory
))
5145 (times (and keep-time
(nth 5 (file-attributes directory
)))))
5146 (if modes
(set-file-modes newname modes
))
5147 (if times
(set-file-times newname times
))))))
5150 ;; At time of writing, only info uses this.
5151 (defun prune-directory-list (dirs &optional keep reject
)
5152 "Return a copy of DIRS with all non-existent directories removed.
5153 The optional argument KEEP is a list of directories to retain even if
5154 they don't exist, and REJECT is a list of directories to remove from
5155 DIRS, even if they exist; REJECT takes precedence over KEEP.
5157 Note that membership in REJECT and KEEP is checked using simple string
5160 (mapcar (lambda (dir)
5161 (and (not (member dir reject
))
5162 (or (member dir keep
) (file-directory-p dir
))
5167 (put 'revert-buffer-function
'permanent-local t
)
5168 (defvar revert-buffer-function nil
5169 "Function to use to revert this buffer, or nil to do the default.
5170 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
5171 which are the arguments that `revert-buffer' received.")
5173 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
5174 (defvar revert-buffer-insert-file-contents-function nil
5175 "Function to use to insert contents when reverting this buffer.
5176 Gets two args, first the nominal file name to use,
5177 and second, t if reading the auto-save file.
5179 The function you specify is responsible for updating (or preserving) point.")
5181 (defvar buffer-stale-function nil
5182 "Function to check whether a non-file buffer needs reverting.
5183 This should be a function with one optional argument NOCONFIRM.
5184 Auto Revert Mode passes t for NOCONFIRM. The function should return
5185 non-nil if the buffer should be reverted. A return value of
5186 `fast' means that the need for reverting was not checked, but
5187 that reverting the buffer is fast. The buffer is current when
5188 this function is called.
5190 The idea behind the NOCONFIRM argument is that it should be
5191 non-nil if the buffer is going to be reverted without asking the
5192 user. In such situations, one has to be careful with potentially
5193 time consuming operations.
5195 For more information on how this variable is used by Auto Revert mode,
5196 see Info node `(emacs)Supporting additional buffers'.")
5198 (defvar before-revert-hook nil
5199 "Normal hook for `revert-buffer' to run before reverting.
5200 If `revert-buffer-function' is used to override the normal revert
5201 mechanism, this hook is not used.")
5203 (defvar after-revert-hook nil
5204 "Normal hook for `revert-buffer' to run after reverting.
5205 Note that the hook value that it runs is the value that was in effect
5206 before reverting; that makes a difference if you have buffer-local
5209 If `revert-buffer-function' is used to override the normal revert
5210 mechanism, this hook is not used.")
5212 (defvar revert-buffer-in-progress-p nil
5213 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5214 This is true even if a `revert-buffer-function' is being used.")
5216 (defvar revert-buffer-internal-hook
)
5218 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
5219 "Replace current buffer text with the text of the visited file on disk.
5220 This undoes all changes since the file was visited or saved.
5221 With a prefix argument, offer to revert from latest auto-save file, if
5222 that is more recent than the visited file.
5224 This command also implements an interface for special buffers
5225 that contain text which doesn't come from a file, but reflects
5226 some other data instead (e.g. Dired buffers, `buffer-list'
5227 buffers). This is done via the variable `revert-buffer-function'.
5228 In these cases, it should reconstruct the buffer contents from the
5231 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5232 to revert from the auto-save file when this is nil. Note that the
5233 sense of this argument is the reverse of the prefix argument, for the
5234 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5237 Optional second argument NOCONFIRM means don't ask for confirmation
5238 at all. (The variable `revert-without-query' offers another way to
5239 revert buffers without querying for confirmation.)
5241 Optional third argument PRESERVE-MODES non-nil means don't alter
5242 the files modes. Normally we reinitialize them using `normal-mode'.
5244 This function binds `revert-buffer-in-progress-p' non-nil while it operates.
5246 If the value of `revert-buffer-function' is non-nil, it is called to
5247 do all the work for this command. Otherwise, the hooks
5248 `before-revert-hook' and `after-revert-hook' are run at the beginning
5249 and the end, and if `revert-buffer-insert-file-contents-function' is
5250 non-nil, it is called instead of rereading visited file contents."
5252 ;; I admit it's odd to reverse the sense of the prefix argument, but
5253 ;; there is a lot of code out there which assumes that the first
5254 ;; argument should be t to avoid consulting the auto-save file, and
5255 ;; there's no straightforward way to encourage authors to notice a
5256 ;; reversal of the argument sense. So I'm just changing the user
5257 ;; interface, but leaving the programmatic interface the same.
5258 (interactive (list (not current-prefix-arg
)))
5259 (if revert-buffer-function
5260 (let ((revert-buffer-in-progress-p t
))
5261 (funcall revert-buffer-function ignore-auto noconfirm
))
5262 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5264 (let* ((revert-buffer-in-progress-p t
)
5265 (auto-save-p (and (not ignore-auto
)
5266 (recent-auto-save-p)
5267 buffer-auto-save-file-name
5268 (file-readable-p buffer-auto-save-file-name
)
5270 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5271 (file-name (if auto-save-p
5272 buffer-auto-save-file-name
5274 (cond ((null file-name
)
5275 (error "Buffer does not seem to be associated with any file"))
5277 (and (not (buffer-modified-p))
5279 (dolist (regexp revert-without-query
)
5280 (when (string-match regexp file-name
)
5281 (throw 'found t
)))))
5282 (yes-or-no-p (format "Revert buffer from file %s? "
5284 (run-hooks 'before-revert-hook
)
5285 ;; If file was backed up but has changed since,
5286 ;; we should make another backup.
5287 (and (not auto-save-p
)
5288 (not (verify-visited-file-modtime (current-buffer)))
5289 (setq buffer-backed-up nil
))
5290 ;; Effectively copy the after-revert-hook status,
5291 ;; since after-find-file will clobber it.
5292 (let ((global-hook (default-value 'after-revert-hook
))
5293 (local-hook (when (local-variable-p 'after-revert-hook
)
5295 (inhibit-read-only t
))
5297 (revert-buffer-insert-file-contents-function
5298 (unless (eq buffer-undo-list t
)
5299 ;; Get rid of all undo records for this buffer.
5300 (setq buffer-undo-list nil
))
5301 ;; Don't make undo records for the reversion.
5302 (let ((buffer-undo-list t
))
5303 (funcall revert-buffer-insert-file-contents-function
5304 file-name auto-save-p
)))
5305 ((not (file-exists-p file-name
))
5306 (error (if buffer-file-number
5307 "File %s no longer exists!"
5308 "Cannot revert nonexistent file %s")
5310 ((not (file-readable-p file-name
))
5311 (error (if buffer-file-number
5312 "File %s no longer readable!"
5313 "Cannot revert unreadable file %s")
5316 ;; Bind buffer-file-name to nil
5317 ;; so that we don't try to lock the file.
5318 (let ((buffer-file-name nil
))
5322 (let ((coding-system-for-read
5323 ;; Auto-saved file should be read by Emacs's
5325 (if auto-save-p
'auto-save-coding
5326 (or coding-system-for-read
5328 buffer-file-coding-system-explicit
5329 (car buffer-file-coding-system-explicit
))))))
5330 (if (and (not enable-multibyte-characters
)
5331 coding-system-for-read
5332 (not (memq (coding-system-base
5333 coding-system-for-read
)
5334 '(no-conversion raw-text
))))
5335 ;; As a coding system suitable for multibyte
5336 ;; buffer is specified, make the current
5337 ;; buffer multibyte.
5338 (set-buffer-multibyte t
))
5340 ;; This force after-insert-file-set-coding
5341 ;; (called from insert-file-contents) to set
5342 ;; buffer-file-coding-system to a proper value.
5343 (kill-local-variable 'buffer-file-coding-system
)
5345 ;; Note that this preserves point in an intelligent way.
5347 (let ((buffer-file-format buffer-file-format
))
5348 (insert-file-contents file-name
(not auto-save-p
)
5350 (insert-file-contents file-name
(not auto-save-p
)
5352 ;; Recompute the truename in case changes in symlinks
5353 ;; have changed the truename.
5354 (setq buffer-file-truename
5355 (abbreviate-file-name (file-truename buffer-file-name
)))
5356 (after-find-file nil nil t nil preserve-modes
)
5357 ;; Run after-revert-hook as it was before we reverted.
5358 (setq-default revert-buffer-internal-hook global-hook
)
5360 (set (make-local-variable 'revert-buffer-internal-hook
)
5362 (kill-local-variable 'revert-buffer-internal-hook
))
5363 (run-hooks 'revert-buffer-internal-hook
))
5366 (defun recover-this-file ()
5367 "Recover the visited file--get contents from its last auto-save file."
5369 (recover-file buffer-file-name
))
5371 (defun recover-file (file)
5372 "Visit file FILE, but get contents from its last auto-save file."
5373 ;; Actually putting the file name in the minibuffer should be used
5375 ;; Not just because users often use the default.
5376 (interactive "FRecover file: ")
5377 (setq file
(expand-file-name file
))
5378 (if (auto-save-file-name-p (file-name-nondirectory file
))
5379 (error "%s is an auto-save file" (abbreviate-file-name file
)))
5380 (let ((file-name (let ((buffer-file-name file
))
5381 (make-auto-save-file-name))))
5382 (cond ((if (file-exists-p file
)
5383 (not (file-newer-than-file-p file-name file
))
5384 (not (file-exists-p file-name
)))
5385 (error "Auto-save file %s not current"
5386 (abbreviate-file-name file-name
)))
5387 ((save-window-excursion
5388 (with-output-to-temp-buffer "*Directory*"
5389 (buffer-disable-undo standard-output
)
5391 (let ((switches dired-listing-switches
))
5392 (if (file-symlink-p file
)
5393 (setq switches
(concat switches
" -L")))
5394 (set-buffer standard-output
)
5395 ;; Use insert-directory-safely, not insert-directory,
5396 ;; because these files might not exist. In particular,
5397 ;; FILE might not exist if the auto-save file was for
5398 ;; a buffer that didn't visit a file, such as "*mail*".
5399 ;; The code in v20.x called `ls' directly, so we need
5400 ;; to emulate what `ls' did in that case.
5401 (insert-directory-safely file switches
)
5402 (insert-directory-safely file-name switches
))))
5403 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
5404 (switch-to-buffer (find-file-noselect file t
))
5405 (let ((inhibit-read-only t
)
5406 ;; Keep the current buffer-file-coding-system.
5407 (coding-system buffer-file-coding-system
)
5408 ;; Auto-saved file should be read with special coding.
5409 (coding-system-for-read 'auto-save-coding
))
5411 (insert-file-contents file-name nil
)
5412 (set-buffer-file-coding-system coding-system
))
5413 (after-find-file nil nil t
))
5414 (t (user-error "Recover-file cancelled")))))
5416 (defun recover-session ()
5417 "Recover auto save files from a previous Emacs session.
5418 This command first displays a Dired buffer showing you the
5419 previous sessions that you could recover from.
5420 To choose one, move point to the proper line and then type C-c C-c.
5421 Then you'll be asked about a number of files to recover."
5423 (if (null auto-save-list-file-prefix
)
5424 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5425 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
5426 (unless (file-directory-p dir
)
5427 (make-directory dir t
))
5428 (unless (directory-files dir nil
5429 (concat "\\`" (regexp-quote
5430 (file-name-nondirectory
5431 auto-save-list-file-prefix
)))
5433 (error "No previous sessions to recover")))
5434 (let ((ls-lisp-support-shell-wildcards t
))
5435 (dired (concat auto-save-list-file-prefix
"*")
5436 (concat dired-listing-switches
" -t")))
5438 (goto-char (point-min))
5439 (or (looking-at " Move to the session you want to recover,")
5440 (let ((inhibit-read-only t
))
5441 ;; Each line starts with a space
5442 ;; so that Font Lock mode won't highlight the first character.
5443 (insert " Move to the session you want to recover,\n"
5444 " then type C-c C-c to select it.\n\n"
5445 " You can also delete some of these files;\n"
5446 " type d on a line to mark that file for deletion.\n\n"))))
5447 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5448 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
5450 (defun recover-session-finish ()
5451 "Choose one saved session to recover auto-save files from.
5452 This command is used in the special Dired buffer created by
5453 \\[recover-session]."
5455 ;; Get the name of the session file to recover from.
5456 (let ((file (dired-get-filename))
5458 (buffer (get-buffer-create " *recover*")))
5460 (dired-do-flagged-delete t
)
5462 (with-current-buffer buffer
5463 ;; Read in the auto-save-list file.
5465 (insert-file-contents file
)
5466 ;; Loop thru the text of that file
5467 ;; and get out the names of the files to recover.
5469 (let (thisfile autofile
)
5471 ;; This is a pair of lines for a non-file-visiting buffer.
5472 ;; Get the auto-save file name and manufacture
5473 ;; a "visited file name" from that.
5476 ;; If there is no auto-save file name, the
5477 ;; auto-save-list file is probably corrupted.
5480 (buffer-substring-no-properties
5482 (line-end-position)))
5486 (file-name-nondirectory autofile
)
5488 (file-name-directory autofile
))))
5490 ;; This pair of lines is a file-visiting
5491 ;; buffer. Use the visited file name.
5494 (buffer-substring-no-properties
5495 (point) (progn (end-of-line) (point))))
5498 (buffer-substring-no-properties
5499 (point) (progn (end-of-line) (point))))
5501 ;; Ignore a file if its auto-save file does not exist now.
5502 (if (and autofile
(file-exists-p autofile
))
5503 (setq files
(cons thisfile files
)))))
5504 (setq files
(nreverse files
))
5505 ;; The file contains a pair of line for each auto-saved buffer.
5506 ;; The first line of the pair contains the visited file name
5507 ;; or is empty if the buffer was not visiting a file.
5508 ;; The second line is the auto-save file name.
5510 (map-y-or-n-p "Recover %s? "
5513 (save-excursion (recover-file file
))
5515 "Failed to recover `%s'" file
)))
5517 '("file" "files" "recover"))
5518 (message "No files can be recovered from this session now")))
5519 (kill-buffer buffer
))))
5521 (defun kill-buffer-ask (buffer)
5522 "Kill BUFFER if confirmed."
5523 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5524 (buffer-name buffer
)
5525 (if (buffer-modified-p buffer
)
5526 "HAS BEEN EDITED" "is unmodified")))
5527 (kill-buffer buffer
)))
5529 (defun kill-some-buffers (&optional list
)
5530 "Kill some buffers. Asks the user whether to kill each one of them.
5531 Non-interactively, if optional argument LIST is non-nil, it
5532 specifies the list of buffers to kill, asking for approval for each one."
5535 (setq list
(buffer-list)))
5537 (let* ((buffer (car list
))
5538 (name (buffer-name buffer
)))
5539 (and name
; Can be nil for an indirect buffer
5540 ; if we killed the base buffer.
5541 (not (string-equal name
""))
5542 (/= (aref name
0) ?\s
)
5543 (kill-buffer-ask buffer
)))
5544 (setq list
(cdr list
))))
5546 (defun kill-matching-buffers (regexp &optional internal-too
)
5547 "Kill buffers whose name matches the specified REGEXP.
5548 The optional second argument indicates whether to kill internal buffers too."
5549 (interactive "sKill buffers matching this regular expression: \nP")
5550 (dolist (buffer (buffer-list))
5551 (let ((name (buffer-name buffer
)))
5552 (when (and name
(not (string-equal name
""))
5553 (or internal-too
(/= (aref name
0) ?\s
))
5554 (string-match regexp name
))
5555 (kill-buffer-ask buffer
)))))
5558 (defun rename-auto-save-file ()
5559 "Adjust current buffer's auto save file name for current conditions.
5560 Also rename any existing auto save file, if it was made in this session."
5561 (let ((osave buffer-auto-save-file-name
))
5562 (setq buffer-auto-save-file-name
5563 (make-auto-save-file-name))
5564 (if (and osave buffer-auto-save-file-name
5565 (not (string= buffer-auto-save-file-name buffer-file-name
))
5566 (not (string= buffer-auto-save-file-name osave
))
5567 (file-exists-p osave
)
5568 (recent-auto-save-p))
5569 (rename-file osave buffer-auto-save-file-name t
))))
5571 (defun make-auto-save-file-name ()
5572 "Return file name to use for auto-saves of current buffer.
5573 Does not consider `auto-save-visited-file-name' as that variable is checked
5574 before calling this function. You can redefine this for customization.
5575 See also `auto-save-file-name-p'."
5576 (if buffer-file-name
5577 (let ((handler (find-file-name-handler buffer-file-name
5578 'make-auto-save-file-name
)))
5580 (funcall handler
'make-auto-save-file-name
)
5581 (let ((list auto-save-file-name-transforms
)
5582 (filename buffer-file-name
)
5584 ;; Apply user-specified translations
5585 ;; to the file name.
5586 (while (and list
(not result
))
5587 (if (string-match (car (car list
)) filename
)
5588 (setq result
(replace-match (cadr (car list
)) t nil
5590 uniq
(car (cddr (car list
)))))
5591 (setq list
(cdr list
)))
5594 (setq filename
(concat
5595 (file-name-directory result
)
5596 (subst-char-in-string
5598 (replace-regexp-in-string "!" "!!"
5600 (setq filename result
)))
5602 (if (and (eq system-type
'ms-dos
)
5603 (not (msdos-long-file-names)))
5604 ;; We truncate the file name to DOS 8+3 limits
5605 ;; before doing anything else, because the regexp
5606 ;; passed to string-match below cannot handle
5607 ;; extensions longer than 3 characters, multiple
5608 ;; dots, and other atrocities.
5609 (let ((fn (dos-8+3-filename
5610 (file-name-nondirectory buffer-file-name
))))
5612 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5614 (concat (file-name-directory buffer-file-name
)
5615 "#" (match-string 1 fn
)
5616 "." (match-string 3 fn
) "#"))
5617 (concat (file-name-directory filename
)
5619 (file-name-nondirectory filename
)
5621 ;; Make sure auto-save file names don't contain characters
5622 ;; invalid for the underlying filesystem.
5623 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5624 ;; Don't modify remote (ange-ftp) filenames
5625 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
5626 (convert-standard-filename result
)
5629 ;; Deal with buffers that don't have any associated files. (Mail
5630 ;; mode tends to create a good number of these.)
5632 (let ((buffer-name (buffer-name))
5635 ;; Restrict the characters used in the file name to those which
5636 ;; are known to be safe on all filesystems, url-encoding the
5638 ;; We do this on all platforms, because even if we are not
5639 ;; running on DOS/Windows, the current directory may be on a
5640 ;; mounted VFAT filesystem, such as a USB memory stick.
5641 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
5642 (let* ((character (aref buffer-name
(match-beginning 0)))
5644 ;; For multibyte characters, this will produce more than
5645 ;; 2 hex digits, so is not true URL encoding.
5646 (format "%%%02X" character
)))
5647 (setq buffer-name
(replace-match replacement t t buffer-name
))
5648 (setq limit
(1+ (match-end 0)))))
5649 ;; Generate the file name.
5654 (format "#%s#" buffer-name
)
5655 ;; Try a few alternative directories, to get one we can
5658 ((file-writable-p default-directory
) default-directory
)
5659 ((file-writable-p "/var/tmp/") "/var/tmp/")
5661 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5662 ;; Don't modify remote (ange-ftp) filenames
5663 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
5664 ;; The call to convert-standard-filename is in case
5665 ;; buffer-name includes characters not allowed by the
5666 ;; DOS/Windows filesystems. make-temp-file writes to the
5667 ;; file it creates, so we must fix the file name _before_
5668 ;; make-temp-file is called.
5669 (convert-standard-filename fname
)
5672 ;; make-temp-file creates the file,
5673 ;; but we don't want it to exist until we do an auto-save.
5675 (delete-file file-name
)
5679 (defun auto-save-file-name-p (filename)
5680 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5681 FILENAME should lack slashes. You can redefine this for customization."
5682 (string-match "^#.*#$" filename
))
5684 (defun wildcard-to-regexp (wildcard)
5685 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5686 The generated regexp will match a filename only if the filename
5687 matches that wildcard according to shell rules. Only wildcards known
5688 by `sh' are supported."
5689 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
5690 ;; Copy the initial run of non-special characters.
5691 (result (substring wildcard
0 i
))
5692 (len (length wildcard
)))
5693 ;; If no special characters, we're almost done.
5696 (let ((ch (aref wildcard i
))
5704 (eq (aref wildcard
(1+ i
)) ?\
]))
5706 ((eq ch ?\
[) ; [...] maps to regexp char class
5711 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
5714 (if (eq (aref wildcard i
) ?\
])
5719 ((eq (aref wildcard i
) ?^
)
5720 ;; Found "[^". Insert a `\0' character
5721 ;; (which cannot happen in a filename)
5722 ;; into the character class, so that `^'
5723 ;; is not the first character after `[',
5724 ;; and thus non-special in a regexp.
5728 ((eq (aref wildcard i
) ?\
])
5729 ;; I don't think `]' can appear in a
5730 ;; character class in a wildcard, but
5731 ;; let's be general here.
5736 (prog1 ; copy everything upto next `]'.
5739 (setq j
(string-match
5741 (setq i
(if j
(1- j
) (1- len
)))))))
5743 ((eq ch ?
*) "[^\000]*")
5747 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
5748 ((eq ch ??
) "[^\000]")
5749 (t (char-to-string ch
)))))
5751 ;; Shell wildcards should match the entire filename,
5752 ;; not its part. Make the regexp say so.
5753 (concat "\\`" result
"\\'")))
5755 (defcustom list-directory-brief-switches
5757 "Switches for `list-directory' to pass to `ls' for brief listing."
5761 (defcustom list-directory-verbose-switches
5763 "Switches for `list-directory' to pass to `ls' for verbose listing."
5767 (defun file-expand-wildcards (pattern &optional full
)
5768 "Expand wildcard pattern PATTERN.
5769 This returns a list of file names which match the pattern.
5771 If PATTERN is written as an absolute file name,
5772 the values are absolute also.
5774 If PATTERN is written as a relative file name, it is interpreted
5775 relative to the current default directory, `default-directory'.
5776 The file names returned are normally also relative to the current
5777 default directory. However, if FULL is non-nil, they are absolute."
5779 (let* ((nondir (file-name-nondirectory pattern
))
5780 (dirpart (file-name-directory pattern
))
5781 ;; A list of all dirs that DIRPART specifies.
5782 ;; This can be more than one dir
5783 ;; if DIRPART contains wildcards.
5784 (dirs (if (and dirpart
5785 (string-match "[[*?]"
5786 (or (file-remote-p dirpart
'localname
)
5788 (mapcar 'file-name-as-directory
5789 (file-expand-wildcards (directory-file-name dirpart
)))
5793 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
5794 (and (file-directory-p (directory-file-name (car dirs
)))
5795 (file-readable-p (car dirs
))))
5796 (let ((this-dir-contents
5797 ;; Filter out "." and ".."
5799 (mapcar #'(lambda (name)
5800 (unless (string-match "\\`\\.\\.?\\'"
5801 (file-name-nondirectory name
))
5803 (directory-files (or (car dirs
) ".") full
5804 (wildcard-to-regexp nondir
))))))
5807 (if (and (car dirs
) (not full
))
5808 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
5812 (setq dirs
(cdr dirs
)))
5815 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5816 (provide 'files
'(remote-wildcards))
5818 (defun list-directory (dirname &optional verbose
)
5819 "Display a list of files in or matching DIRNAME, a la `ls'.
5820 DIRNAME is globbed by the shell if necessary.
5821 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5822 Actions controlled by variables `list-directory-brief-switches'
5823 and `list-directory-verbose-switches'."
5824 (interactive (let ((pfx current-prefix-arg
))
5825 (list (read-directory-name (if pfx
"List directory (verbose): "
5826 "List directory (brief): ")
5827 nil default-directory nil
)
5829 (let ((switches (if verbose list-directory-verbose-switches
5830 list-directory-brief-switches
))
5832 (or dirname
(setq dirname default-directory
))
5833 (setq dirname
(expand-file-name dirname
))
5834 (with-output-to-temp-buffer "*Directory*"
5835 (setq buffer standard-output
)
5836 (buffer-disable-undo standard-output
)
5837 (princ "Directory ")
5840 (with-current-buffer "*Directory*"
5841 (let ((wildcard (not (file-directory-p dirname
))))
5842 (insert-directory dirname switches wildcard
(not wildcard
)))))
5843 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5844 (with-current-buffer buffer
5845 (setq default-directory
5846 (if (file-directory-p dirname
)
5847 (file-name-as-directory dirname
)
5848 (file-name-directory dirname
))))))
5850 (defun shell-quote-wildcard-pattern (pattern)
5851 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5853 PATTERN is assumed to represent a file-name wildcard suitable for the
5854 underlying filesystem. For Unix and GNU/Linux, each character from the
5855 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5856 the parts of the pattern which don't include wildcard characters are
5857 quoted with double quotes.
5859 This function leaves alone existing quote characters (\\ on Unix and \"
5860 on Windows), so PATTERN can use them to quote wildcard characters that
5861 need to be passed verbatim to shell commands."
5864 ((memq system-type
'(ms-dos windows-nt cygwin
))
5865 ;; DOS/Windows don't allow `"' in file names. So if the
5866 ;; argument has quotes, we can safely assume it is already
5867 ;; quoted by the caller.
5868 (if (or (string-match "[\"]" pattern
)
5869 ;; We quote [&()#$'] in case their shell is a port of a
5870 ;; Unixy shell. We quote [,=+] because stock DOS and
5871 ;; Windows shells require that in some cases, such as
5872 ;; passing arguments to batch files that use positional
5873 ;; arguments like %1.
5874 (not (string-match "[ \t;&()#$',=+]" pattern
)))
5879 (while (string-match "[*?]+" pattern beg
)
5880 (setq end
(match-beginning 0)
5881 result
(concat result
(substring pattern beg end
)
5883 (substring pattern end
(match-end 0))
5886 (concat result
(substring pattern beg
) "\""))))
5889 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
5891 (concat (substring pattern
0 (match-beginning 0))
5893 (substring pattern
(match-beginning 0)))
5894 beg
(1+ (match-end 0)))))
5898 (defvar insert-directory-program
(purecopy "ls")
5899 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5901 (defcustom directory-free-space-program
(purecopy "df")
5902 "Program to get the amount of free space on a file system.
5903 We assume the output has the format of `df'.
5904 The value of this variable must be just a command name or file name;
5905 if you want to specify options, use `directory-free-space-args'.
5907 A value of nil disables this feature.
5909 If the function `file-system-info' is defined, it is always used in
5910 preference to the program given by this variable."
5911 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
5914 (defcustom directory-free-space-args
5915 (purecopy (if (eq system-type
'darwin
) "-k" "-Pk"))
5916 "Options to use when running `directory-free-space-program'."
5920 (defun get-free-disk-space (dir)
5921 "Return the amount of free space on directory DIR's file system.
5922 The return value is a string describing the amount of free
5923 space (normally, the number of free 1KB blocks).
5925 This function calls `file-system-info' if it is available, or
5926 invokes the program specified by `directory-free-space-program'
5927 and `directory-free-space-args'. If the system call or program
5928 is unsuccessful, or if DIR is a remote directory, this function
5930 (unless (file-remote-p dir
)
5931 ;; Try to find the number of free blocks. Non-Posix systems don't
5932 ;; always have df, but might have an equivalent system call.
5933 (if (fboundp 'file-system-info
)
5934 (let ((fsinfo (file-system-info dir
)))
5936 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
5937 (setq dir
(expand-file-name dir
))
5940 (when (and directory-free-space-program
5941 ;; Avoid failure if the default directory does
5942 ;; not exist (Bug#2631, Bug#3911).
5943 (let ((default-directory
5944 (locate-dominating-file dir
'file-directory-p
)))
5945 (eq (process-file directory-free-space-program
5947 directory-free-space-args
5948 (file-relative-name dir
))
5950 ;; Assume that the "available" column is before the
5951 ;; "capacity" column. Find the "%" and scan backward.
5952 (goto-char (point-min))
5954 (when (re-search-forward
5955 "[[:space:]]+[^[:space:]]+%[^%]*$"
5956 (line-end-position) t
)
5957 (goto-char (match-beginning 0))
5958 (let ((endpt (point)))
5959 (skip-chars-backward "^[:space:]")
5960 (buffer-substring-no-properties (point) endpt
)))))))))
5962 ;; The following expression replaces `dired-move-to-filename-regexp'.
5963 (defvar directory-listing-before-filename-regexp
5964 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5965 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5966 ;; In some locales, month abbreviations are as short as 2 letters,
5967 ;; and they can be followed by ".".
5968 ;; In Breton, a month name can include a quote character.
5969 (month (concat l-or-quote l-or-quote
"+\\.?"))
5971 (yyyy "[0-9][0-9][0-9][0-9]")
5973 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5974 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5975 (zone "[-+][0-2][0-9][0-5][0-9]")
5976 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5977 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5978 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5979 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5980 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5982 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5983 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5984 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5985 ;; omits the Kanji characters after month and day-of-month.
5986 ;; On Mac OS X 10.3, the date format in East Asian locales is
5987 ;; day-of-month digits followed by month digits.
5990 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5991 "\\|" dd s mm s
"+" "\\)"
5992 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5993 ;; The "[0-9]" below requires the previous column to end in a digit.
5994 ;; This avoids recognizing `1 may 1997' as a date in the line:
5995 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5997 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5999 ;; For non-iso date formats, we add the ".*" in order to find
6000 ;; the last possible match. This avoids recognizing
6001 ;; `jservice 10 1024' as a date in the line:
6002 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
6004 ;; vc dired listings provide the state or blanks between file
6005 ;; permissions and date. The state is always surrounded by
6007 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
6008 ;; This is not supported yet.
6009 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
6010 "\\|.*[0-9][BkKMGTPEZY]? "
6011 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\)"
6013 "Regular expression to match up to the file name in a directory listing.
6014 The default value is designed to recognize dates and times
6015 regardless of the language.")
6017 (defvar insert-directory-ls-version
'unknown
)
6020 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
6021 ;; FULL-DIRECTORY-P is nil.
6022 ;; The single line of output must display FILE's name as it was
6023 ;; given, namely, an absolute path name.
6024 ;; - must insert exactly one line for each file if WILDCARD or
6025 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
6026 ;; before the file lines, plus optional text after the file lines.
6027 ;; Lines are delimited by "\n", so filenames containing "\n" are not
6029 ;; File lines should display the basename.
6030 ;; - must be consistent with
6031 ;; - functions dired-move-to-filename, (these two define what a file line is)
6032 ;; dired-move-to-end-of-filename,
6033 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
6034 ;; dired-insert-headerline
6035 ;; dired-after-subdir-garbage (defines what a "total" line is)
6036 ;; - variable dired-subdir-regexp
6037 ;; - may be passed "--dired" as the first argument in SWITCHES.
6038 ;; Filename handlers might have to remove this switch if their
6039 ;; "ls" command does not support it.
6040 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
6041 "Insert directory listing for FILE, formatted according to SWITCHES.
6042 Leaves point after the inserted text.
6043 SWITCHES may be a string of options, or a list of strings
6044 representing individual options.
6045 Optional third arg WILDCARD means treat FILE as shell wildcard.
6046 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
6047 switches do not contain `d', so that a full listing is expected.
6049 This works by running a directory listing program
6050 whose name is in the variable `insert-directory-program'.
6051 If WILDCARD, it also runs the shell specified by `shell-file-name'.
6053 When SWITCHES contains the long `--dired' option, this function
6054 treats it specially, for the sake of dired. However, the
6055 normally equivalent short `-D' option is just passed on to
6056 `insert-directory-program', as any other option."
6057 ;; We need the directory in order to find the right handler.
6058 (let ((handler (find-file-name-handler (expand-file-name file
)
6059 'insert-directory
)))
6061 (funcall handler
'insert-directory file switches
6062 wildcard full-directory-p
)
6063 (let (result (beg (point)))
6065 ;; Read the actual directory using `insert-directory-program'.
6066 ;; RESULT gets the status code.
6067 (let* (;; We at first read by no-conversion, then after
6068 ;; putting text property `dired-filename, decode one
6069 ;; bunch by one to preserve that property.
6070 (coding-system-for-read 'no-conversion
)
6071 ;; This is to control encoding the arguments in call-process.
6072 (coding-system-for-write
6073 (and enable-multibyte-characters
6074 (or file-name-coding-system
6075 default-file-name-coding-system
))))
6078 ;; Run ls in the directory part of the file pattern
6079 ;; using the last component as argument.
6080 (let ((default-directory
6081 (if (file-name-absolute-p file
)
6082 (file-name-directory file
)
6083 (file-name-directory (expand-file-name file
))))
6084 (pattern (file-name-nondirectory file
)))
6085 ;; NB since switches is passed to the shell, be
6086 ;; careful of malicious values, eg "-l;reboot".
6087 ;; See eg dired-safe-switches-p.
6089 shell-file-name nil t nil
6091 (concat (if (memq system-type
'(ms-dos windows-nt
))
6093 "\\") ; Disregard Unix shell aliases!
6094 insert-directory-program
6096 (if (stringp switches
)
6098 (mapconcat 'identity switches
" "))
6100 ;; Quote some characters that have
6101 ;; special meanings in shells; but
6102 ;; don't quote the wildcards--we want
6103 ;; them to be special. We also
6104 ;; currently don't quote the quoting
6105 ;; characters in case people want to
6106 ;; use them explicitly to quote
6107 ;; wildcard characters.
6108 (shell-quote-wildcard-pattern pattern
))))
6109 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
6110 ;; directory if FILE is a symbolic link.
6111 (unless full-directory-p
6113 (if (stringp switches
)
6114 (concat switches
" -d")
6115 (add-to-list 'switches
"-d" 'append
))))
6116 (apply 'call-process
6117 insert-directory-program nil t nil
6119 (if (listp switches
) switches
6120 (unless (equal switches
"")
6121 ;; Split the switches at any spaces so we can
6122 ;; pass separate options as separate args.
6123 (split-string switches
)))
6124 ;; Avoid lossage if FILE starts with `-'.
6127 (if (string-match "\\`~" file
)
6128 (setq file
(expand-file-name file
)))
6130 (if full-directory-p
6131 (concat (file-name-as-directory file
) ".")
6134 ;; If we got "//DIRED//" in the output, it means we got a real
6135 ;; directory listing, even if `ls' returned nonzero.
6136 ;; So ignore any errors.
6137 (when (if (stringp switches
)
6138 (string-match "--dired\\>" switches
)
6139 (member "--dired" switches
))
6142 (when (looking-at "//SUBDIRED//")
6144 (if (looking-at "//DIRED//")
6147 (when (and (not (eq 0 result
))
6148 (eq insert-directory-ls-version
'unknown
))
6149 ;; The first time ls returns an error,
6150 ;; find the version numbers of ls,
6151 ;; and set insert-directory-ls-version
6152 ;; to > if it is more than 5.2.1, < if it is less, nil if it
6153 ;; is equal or if the info cannot be obtained.
6154 ;; (That can mean it isn't GNU ls.)
6157 (call-process "ls" nil t nil
"--version")
6159 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
6160 (let* ((version (match-string 1 version-out
))
6161 (split (split-string version
"[.]"))
6162 (numbers (mapcar 'string-to-number split
))
6165 (while (and (not comparison
) (or numbers min
))
6167 (setq comparison
'>))
6169 (setq comparison
'<))
6170 ((> (car numbers
) (car min
))
6171 (setq comparison
'>))
6172 ((< (car numbers
) (car min
))
6173 (setq comparison
'<))
6175 (setq numbers
(cdr numbers
)
6177 (setq insert-directory-ls-version
(or comparison
'=)))
6178 (setq insert-directory-ls-version nil
))))
6180 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
6181 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
6184 ;; If `insert-directory-program' failed, signal an error.
6185 (unless (eq 0 result
)
6186 ;; Delete the error message it may have output.
6187 (delete-region beg
(point))
6188 ;; On non-Posix systems, we cannot open a directory, so
6189 ;; don't even try, because that will always result in
6190 ;; the ubiquitous "Access denied". Instead, show the
6191 ;; command line so the user can try to guess what went wrong.
6192 (if (and (file-directory-p file
)
6193 (memq system-type
'(ms-dos windows-nt
)))
6195 "Reading directory: \"%s %s -- %s\" exited with status %s"
6196 insert-directory-program
6197 (if (listp switches
) (concat switches
) switches
)
6199 ;; Unix. Access the file to get a suitable error.
6200 (access-file file
"Reading directory")
6201 (error "Listing directory failed but `access-file' worked")))
6203 (when (if (stringp switches
)
6204 (string-match "--dired\\>" switches
)
6205 (member "--dired" switches
))
6206 ;; The following overshoots by one line for an empty
6207 ;; directory listed with "--dired", but without "-a"
6208 ;; switch, where the ls output contains a
6209 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6210 ;; We take care of that case later.
6212 (when (looking-at "//SUBDIRED//")
6213 (delete-region (point) (progn (forward-line 1) (point)))
6215 (if (looking-at "//DIRED//")
6216 (let ((end (line-end-position))
6219 ;; Find all the lines that are error messages,
6220 ;; and record the bounds of each one.
6222 (while (< (point) linebeg
)
6223 (or (eql (following-char) ?\s
)
6224 (push (list (point) (line-end-position)) error-lines
))
6226 (setq error-lines
(nreverse error-lines
))
6227 ;; Now read the numeric positions of file names.
6231 (while (< (point) end
)
6232 (let ((start (insert-directory-adj-pos
6233 (+ beg
(read (current-buffer)))
6235 (end (insert-directory-adj-pos
6236 (+ beg
(read (current-buffer)))
6238 (if (memq (char-after end
) '(?
\n ?\s
))
6239 ;; End is followed by \n or by " -> ".
6240 (put-text-property start end
'dired-filename t
)
6241 ;; It seems that we can't trust ls's output as to
6242 ;; byte positions of filenames.
6243 (put-text-property beg
(point) 'dired-filename nil
)
6247 (delete-region (point) (progn (forward-line 1) (point))))
6248 ;; Take care of the case where the ls output contains a
6249 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6250 ;; and we went one line too far back (see above).
6252 (if (looking-at "//DIRED-OPTIONS//")
6253 (delete-region (point) (progn (forward-line 1) (point)))))
6255 ;; Now decode what read if necessary.
6256 (let ((coding (or coding-system-for-read
6257 file-name-coding-system
6258 default-file-name-coding-system
6262 (when (and enable-multibyte-characters
6263 (not (memq (coding-system-base coding
)
6264 '(raw-text no-conversion
))))
6265 ;; If no coding system is specified or detection is
6266 ;; requested, detect the coding.
6267 (if (eq (coding-system-base coding
) 'undecided
)
6268 (setq coding
(detect-coding-region beg
(point) t
)))
6269 (if (not (eq (coding-system-base coding
) 'undecided
))
6272 (coding-system-change-eol-conversion coding
'unix
))
6273 (narrow-to-region beg
(point))
6274 (goto-char (point-min))
6277 val
(get-text-property (point) 'dired-filename
))
6278 (goto-char (next-single-property-change
6279 (point) 'dired-filename nil
(point-max)))
6280 ;; Force no eol conversion on a file name, so
6281 ;; that CR is preserved.
6282 (decode-coding-region pos
(point)
6283 (if val coding-no-eol coding
))
6285 (put-text-property pos
(point)
6286 'dired-filename t
)))))))
6288 (if full-directory-p
6289 ;; Try to insert the amount of free space.
6292 ;; First find the line to put it on.
6293 (when (re-search-forward "^ *\\(total\\)" nil t
)
6294 (let ((available (get-free-disk-space ".")))
6296 ;; Replace "total" with "used", to avoid confusion.
6297 (replace-match "total used in directory" nil nil nil
1)
6299 (insert " available " available
))))))))))
6301 (defun insert-directory-adj-pos (pos error-lines
)
6302 "Convert `ls --dired' file name position value POS to a buffer position.
6303 File name position values returned in ls --dired output
6304 count only stdout; they don't count the error messages sent to stderr.
6305 So this function converts to them to real buffer positions.
6306 ERROR-LINES is a list of buffer positions of error message lines,
6307 of the form (START END)."
6308 (while (and error-lines
(< (caar error-lines
) pos
))
6309 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
6313 (defun insert-directory-safely (file switches
6314 &optional wildcard full-directory-p
)
6315 "Insert directory listing for FILE, formatted according to SWITCHES.
6317 Like `insert-directory', but if FILE does not exist, it inserts a
6318 message to that effect instead of signaling an error."
6319 (if (file-exists-p file
)
6320 (insert-directory file switches wildcard full-directory-p
)
6321 ;; Simulate the message printed by `ls'.
6322 (insert (format "%s: No such file or directory\n" file
))))
6324 (defvar kill-emacs-query-functions nil
6325 "Functions to call with no arguments to query about killing Emacs.
6326 If any of these functions returns nil, killing Emacs is canceled.
6327 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6328 the low level primitive, does not. See also `kill-emacs-hook'.")
6330 (defcustom confirm-kill-emacs nil
6331 "How to ask for confirmation when leaving Emacs.
6332 If nil, the default, don't ask at all. If the value is non-nil, it should
6333 be a predicate function such as `yes-or-no-p'."
6334 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
6335 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
6336 (const :tag
"Don't confirm" nil
))
6340 (defun save-buffers-kill-emacs (&optional arg
)
6341 "Offer to save each buffer, then kill this Emacs process.
6342 With prefix ARG, silently save all file-visiting buffers without asking.
6343 If there are active processes where `process-query-on-exit-flag'
6344 returns non-nil, asks whether processes should be killed.
6345 Runs the members of `kill-emacs-query-functions' in turn and stops
6346 if any returns nil. If `confirm-kill-emacs' is non-nil, calls it."
6348 (save-some-buffers arg t
)
6349 (and (or (not (memq t
(mapcar (function
6350 (lambda (buf) (and (buffer-file-name buf
)
6351 (buffer-modified-p buf
))))
6353 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6354 (or (not (fboundp 'process-list
))
6355 ;; process-list is not defined on MSDOS.
6356 (let ((processes (process-list))
6359 (and (memq (process-status (car processes
)) '(run stop open listen
))
6360 (process-query-on-exit-flag (car processes
))
6362 (setq processes
(cdr processes
)))
6364 (progn (list-processes t
)
6365 (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))))
6366 ;; Query the user for other things, perhaps.
6367 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
6368 (or (null confirm-kill-emacs
)
6369 (funcall confirm-kill-emacs
"Really exit Emacs? "))
6372 (defun save-buffers-kill-terminal (&optional arg
)
6373 "Offer to save each buffer, then kill the current connection.
6374 If the current frame has no client, kill Emacs itself.
6376 With prefix ARG, silently save all file-visiting buffers, then kill.
6378 If emacsclient was started with a list of filenames to edit, then
6379 only these files will be asked to be saved."
6381 (if (frame-parameter (selected-frame) 'client
)
6382 (server-save-buffers-kill-terminal arg
)
6383 (save-buffers-kill-emacs arg
)))
6385 ;; We use /: as a prefix to "quote" a file name
6386 ;; so that magic file name handlers will not apply to it.
6388 (setq file-name-handler-alist
6389 (cons (cons (purecopy "\\`/:") 'file-name-non-special
)
6390 file-name-handler-alist
))
6392 ;; We depend on being the last handler on the list,
6393 ;; so that anything else which does need handling
6394 ;; has been handled already.
6395 ;; So it is safe for us to inhibit *all* magic file name handlers.
6397 (defun file-name-non-special (operation &rest arguments
)
6398 (let ((file-name-handler-alist nil
)
6400 (if (eq operation
'insert-directory
)
6401 (directory-file-name
6403 (unhandled-file-name-directory default-directory
)))
6405 ;; Get a list of the indices of the args which are file names.
6407 (cdr (or (assq operation
6408 ;; The first six are special because they
6409 ;; return a file name. We want to include the /:
6410 ;; in the return value.
6411 ;; So just avoid stripping it in the first place.
6412 '((expand-file-name . nil
)
6413 (file-name-directory . nil
)
6414 (file-name-as-directory . nil
)
6415 (directory-file-name . nil
)
6416 (file-name-sans-versions . nil
)
6417 (find-backup-file-name . nil
)
6418 ;; `identity' means just return the first arg
6419 ;; not stripped of its quoting.
6420 (substitute-in-file-name identity
)
6421 ;; `add' means add "/:" to the result.
6422 (file-truename add
0)
6423 (insert-file-contents insert-file-contents
0)
6424 ;; `unquote-then-quote' means set buffer-file-name
6425 ;; temporarily to unquoted filename.
6426 (verify-visited-file-modtime unquote-then-quote
)
6427 ;; List the arguments which are filenames.
6428 (file-name-completion 1)
6429 (file-name-all-completions 1)
6433 (make-symbolic-link 0 1)
6434 (add-name-to-file 0 1)))
6435 ;; For all other operations, treat the first argument only
6436 ;; as the file name.
6439 ;; Copy ARGUMENTS so we can replace elements in it.
6440 (arguments (copy-sequence arguments
)))
6441 (if (symbolp (car file-arg-indices
))
6442 (setq method
(pop file-arg-indices
)))
6443 ;; Strip off the /: from the file names that have it.
6445 (while (consp file-arg-indices
)
6446 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
6448 (string-match "\\`/:" (car pair
))
6450 (if (= (length (car pair
)) 2)
6452 (substring (car pair
) 2)))))
6453 (setq file-arg-indices
(cdr file-arg-indices
))))
6455 (`identity
(car arguments
))
6456 (`add
(concat "/:" (apply operation arguments
)))
6457 (`insert-file-contents
6458 (let ((visit (nth 1 arguments
)))
6460 (apply operation arguments
)
6461 (when (and visit buffer-file-name
)
6462 (setq buffer-file-name
(concat "/:" buffer-file-name
))))))
6463 (`unquote-then-quote
6464 (let ((buffer-file-name (substring buffer-file-name
2)))
6465 (apply operation arguments
)))
6467 (apply operation arguments
)))))
6469 ;; Symbolic modes and read-file-modes.
6471 (defun file-modes-char-to-who (char)
6472 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6473 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6474 Others, or All) for whom to produce the mask.
6475 The bit-mask that is returned extracts from mode bits the access rights
6476 for the specified category of users."
6477 (cond ((= char ?u
) #o4700
)
6478 ((= char ?g
) #o2070
)
6479 ((= char ?o
) #o1007
)
6480 ((= char ?a
) #o7777
)
6481 (t (error "%c: bad `who' character" char
))))
6483 (defun file-modes-char-to-right (char &optional from
)
6484 "Convert CHAR to a numeric value of mode bits.
6485 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6486 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6487 (or from
(setq from
0))
6488 (cond ((= char ?r
) #o0444
)
6489 ((= char ?w
) #o0222
)
6490 ((= char ?x
) #o0111
)
6491 ((= char ?s
) #o1000
)
6492 ((= char ?t
) #o6000
)
6493 ;; Rights relative to the previous file modes.
6494 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
6495 ((= char ?u
) (let ((uright (logand #o4700 from
)))
6496 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
6497 ((= char ?g
) (let ((gright (logand #o2070 from
)))
6498 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
6499 ((= char ?o
) (let ((oright (logand #o1007 from
)))
6500 (+ oright
(* oright
#o10
) (* oright
#o100
))))
6501 (t (error "%c: bad right character" char
))))
6503 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
6504 "Convert a symbolic mode string specification to an equivalent number.
6505 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6506 WHO-MASK is the bit-mask specifying the category of users to which to
6507 apply the access permissions. See `file-modes-char-to-who'.
6508 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6509 RIGHTS request to add, remove, or set permissions based on existing ones,
6511 (let* ((num-rights (or from
0))
6512 (list-rights (string-to-list rights
))
6513 (op (pop list-rights
)))
6514 (while (memq op
'(?
+ ?- ?
=))
6517 (while (memq (setq char-right
(pop list-rights
))
6518 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
6521 (file-modes-char-to-right char-right num-rights
))))
6522 (setq num-right
(logand who-mask num-right
)
6524 (cond ((= op ?
+) (logior num-rights num-right
))
6525 ((= op ?-
) (logand num-rights
(lognot num-right
)))
6526 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
6530 (defun file-modes-symbolic-to-number (modes &optional from
)
6531 "Convert symbolic file modes to numeric file modes.
6532 MODES is the string to convert, it should match
6533 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6534 See Info node `(coreutils)File permissions' for more information on this
6536 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6537 MODES request to add, remove, or set permissions based on existing ones,
6540 (let ((case-fold-search nil
)
6541 (num-modes (or from
0)))
6542 (while (/= (string-to-char modes
) 0)
6543 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes
)
6544 (let ((num-who (apply 'logior
0
6545 (mapcar 'file-modes-char-to-who
6546 (match-string 1 modes
)))))
6548 (setq num-who
(default-file-modes)))
6550 (file-modes-rights-to-number (substring modes
(match-end 1))
6552 modes
(substring modes
(match-end 3))))
6553 (error "Parse error in modes near `%s'" (substring modes
0))))
6556 (defun read-file-modes (&optional prompt orig-file
)
6557 "Read file modes in octal or symbolic notation and return its numeric value.
6558 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6559 ORIG-FILE is the name of a file on whose mode bits to base returned
6560 permissions if what user types requests to add, remove, or set permissions
6561 based on existing mode bits, as in \"og+rX-w\"."
6562 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
6563 (error "File not found")))
6564 (modestr (and (stringp orig-file
)
6565 (nth 8 (file-attributes orig-file
))))
6567 (and (stringp modestr
)
6568 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
6569 (replace-regexp-in-string
6571 (format "u=%s,g=%s,o=%s"
6572 (match-string 1 modestr
)
6573 (match-string 2 modestr
)
6574 (match-string 3 modestr
)))))
6575 (value (read-string (or prompt
"File modes (octal or symbolic): ")
6578 (if (string-match "^[0-7]+" value
)
6579 (string-to-number value
8)
6580 (file-modes-symbolic-to-number value modes
)))))
6583 ;; Trashcan handling.
6584 (defcustom trash-directory nil
6585 "Directory for `move-file-to-trash' to move files and directories to.
6586 This directory is only used when the function `system-move-file-to-trash'
6588 Relative paths are interpreted relative to `default-directory'.
6589 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6590 :type
'(choice (const nil
) directory
)
6594 (defvar trash--hexify-table
)
6596 (declare-function system-move-file-to-trash
"w32fns.c" (filename))
6598 (defun move-file-to-trash (filename)
6599 "Move the file (or directory) named FILENAME to the trash.
6600 When `delete-by-moving-to-trash' is non-nil, this function is
6601 called by `delete-file' and `delete-directory' instead of
6602 deleting files outright.
6604 If the function `system-move-file-to-trash' is defined, call it
6605 with FILENAME as an argument.
6606 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6608 Otherwise, trash FILENAME using the freedesktop.org conventions,
6609 like the GNOME, KDE and XFCE desktop environments. Emacs only
6610 moves files to \"home trash\", ignoring per-volume trashcans."
6611 (interactive "fMove file to trash: ")
6612 (cond (trash-directory
6613 ;; If `trash-directory' is non-nil, move the file there.
6614 (let* ((trash-dir (expand-file-name trash-directory
))
6615 (fn (directory-file-name (expand-file-name filename
)))
6616 (new-fn (expand-file-name (file-name-nondirectory fn
)
6618 ;; We can't trash a parent directory of trash-directory.
6619 (if (string-prefix-p fn trash-dir
)
6620 (error "Trash directory `%s' is a subdirectory of `%s'"
6621 trash-dir filename
))
6622 (unless (file-directory-p trash-dir
)
6623 (make-directory trash-dir t
))
6624 ;; Ensure that the trashed file-name is unique.
6625 (if (file-exists-p new-fn
)
6626 (let ((version-control t
)
6627 (backup-directory-alist nil
))
6628 (setq new-fn
(car (find-backup-file-name new-fn
)))))
6629 (let (delete-by-moving-to-trash)
6630 (rename-file fn new-fn
))))
6631 ;; If `system-move-file-to-trash' is defined, use it.
6632 ((fboundp 'system-move-file-to-trash
)
6633 (system-move-file-to-trash filename
))
6634 ;; Otherwise, use the freedesktop.org method, as specified at
6635 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6637 (let* ((xdg-data-dir
6638 (directory-file-name
6639 (expand-file-name "Trash"
6640 (or (getenv "XDG_DATA_HOME")
6641 "~/.local/share"))))
6642 (trash-files-dir (expand-file-name "files" xdg-data-dir
))
6643 (trash-info-dir (expand-file-name "info" xdg-data-dir
))
6644 (fn (directory-file-name (expand-file-name filename
))))
6646 ;; Check if we have permissions to delete.
6647 (unless (file-writable-p (directory-file-name
6648 (file-name-directory fn
)))
6649 (error "Cannot move %s to trash: Permission denied" filename
))
6650 ;; The trashed file cannot be the trash dir or its parent.
6651 (if (string-prefix-p fn trash-files-dir
)
6652 (error "The trash directory %s is a subdirectory of %s"
6653 trash-files-dir filename
))
6654 (if (string-prefix-p fn trash-info-dir
)
6655 (error "The trash directory %s is a subdirectory of %s"
6656 trash-info-dir filename
))
6658 ;; Ensure that the trash directory exists; otherwise, create it.
6659 (let ((saved-default-file-modes (default-file-modes)))
6662 (set-default-file-modes #o700
)
6663 (unless (file-exists-p trash-files-dir
)
6664 (make-directory trash-files-dir t
))
6665 (unless (file-exists-p trash-info-dir
)
6666 (make-directory trash-info-dir t
)))
6667 (set-default-file-modes saved-default-file-modes
)))
6669 ;; Try to move to trash with .trashinfo undo information
6672 (set-buffer-file-coding-system 'utf-8-unix
)
6673 (insert "[Trash Info]\nPath=")
6674 ;; Perform url-encoding on FN. For compatibility with
6675 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6676 ;; for path separators.
6677 (unless (boundp 'trash--hexify-table
)
6678 (setq trash--hexify-table
(make-vector 256 nil
))
6679 (let ((unreserved-chars
6680 (list ?
/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6681 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6682 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6683 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?
0 ?
1 ?
2
6684 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9 ?- ?_ ?. ?
! ?~ ?
* ?
'
6687 (aset trash--hexify-table byte
6688 (if (memq byte unreserved-chars
)
6689 (char-to-string byte
)
6690 (format "%%%02x" byte
))))))
6691 (mapc (lambda (byte)
6692 (insert (aref trash--hexify-table byte
)))
6693 (if (multibyte-string-p fn
)
6694 (encode-coding-string fn
'utf-8
)
6696 (insert "\nDeletionDate="
6697 (format-time-string "%Y-%m-%dT%T")
6700 ;; Attempt to make .trashinfo file, trying up to 5
6701 ;; times. The .trashinfo file is opened with O_EXCL,
6702 ;; as per trash-spec 0.7, even if that can be a problem
6703 ;; on old NFS versions...
6705 (base-fn (expand-file-name
6706 (file-name-nondirectory fn
)
6711 (setq info-fn
(expand-file-name
6712 (concat (file-name-nondirectory new-fn
)
6715 (unless (condition-case nil
6717 (write-region nil nil info-fn nil
6718 'quiet info-fn
'excl
)
6719 (setq tries
0 success t
))
6720 (file-already-exists nil
))
6721 (setq tries
(1- tries
))
6722 ;; Uniquify new-fn. (Some file managers do not
6723 ;; like Emacs-style backup file names---e.g. bug
6724 ;; 170956 in Konqueror bug tracker.)
6725 (setq new-fn
(make-temp-name (concat base-fn
"_")))))
6727 (error "Cannot move %s to trash: Lock failed" filename
))
6729 ;; Finally, try to move the file to the trashcan.
6730 (let ((delete-by-moving-to-trash nil
))
6731 (rename-file fn new-fn
)))))))))
6734 (define-key ctl-x-map
"\C-f" 'find-file
)
6735 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
6736 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
6737 (define-key ctl-x-map
"\C-s" 'save-buffer
)
6738 (define-key ctl-x-map
"s" 'save-some-buffers
)
6739 (define-key ctl-x-map
"\C-w" 'write-file
)
6740 (define-key ctl-x-map
"i" 'insert-file
)
6741 (define-key esc-map
"~" 'not-modified
)
6742 (define-key ctl-x-map
"\C-d" 'list-directory
)
6743 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
6744 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
6746 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
6747 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
6748 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
6749 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
6750 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
6752 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
6753 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
6754 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
6755 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
6756 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
6758 ;;; files.el ends here