1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2011 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's 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 (eval-when-compile (require 'cl
))
33 (defvar font-lock-keywords
)
36 "Backups of edited data files."
39 (defgroup find-file nil
44 (defcustom delete-auto-save-files t
45 "Non-nil means delete auto-save file when a buffer is saved or killed.
47 Note that the auto-save file will not be deleted if the buffer is killed
48 when it has unsaved changes."
52 (defcustom directory-abbrev-alist
54 "Alist of abbreviations for file directories.
55 A list of elements of the form (FROM . TO), each meaning to replace
56 FROM with TO when it appears in a directory name. This replacement is
57 done when setting up the default directory of a newly visited file.
59 FROM is matched against directory names anchored at the first
60 character, so it should start with a \"\\\\`\", or, if directory
61 names cannot have embedded newlines, with a \"^\".
63 FROM and TO should be equivalent names, which refer to the
64 same directory. Do not use `~' in the TO strings;
65 they should be ordinary absolute directory names.
67 Use this feature when you have directories which you normally refer to
68 via absolute symbolic links. Make TO the name of the link, and FROM
69 the name it is linked to."
70 :type
'(repeat (cons :format
"%v"
77 (defcustom make-backup-files t
78 "Non-nil means make a backup of a file the first time it is saved.
79 This can be done by renaming the file or by copying.
81 Renaming means that Emacs renames the existing file so that it is a
82 backup file, then writes the buffer into a new file. Any other names
83 that the old file had will now refer to the backup file. The new file
84 is owned by you and its group is defaulted.
86 Copying means that Emacs copies the existing file into the backup
87 file, then writes the buffer on top of the existing file. Any other
88 names that the old file had will now refer to the new (edited) file.
89 The file's owner and group are unchanged.
91 The choice of renaming or copying is controlled by the variables
92 `backup-by-copying', `backup-by-copying-when-linked',
93 `backup-by-copying-when-mismatch' and
94 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
98 ;; Do this so that local variables based on the file name
99 ;; are not overridden by the major mode.
100 (defvar backup-inhibited nil
101 "Non-nil means don't make a backup, regardless of the other parameters.
102 This variable is intended for use by making it local to a buffer.
103 But it is local only if you make it local.")
104 (put 'backup-inhibited
'permanent-local t
)
106 (defcustom backup-by-copying nil
107 "Non-nil means always use copying to create backup files.
108 See documentation of variable `make-backup-files'."
112 (defcustom backup-by-copying-when-linked nil
113 "Non-nil means use copying to create backups for files with multiple names.
114 This causes the alternate names to refer to the latest version as edited.
115 This variable is relevant only if `backup-by-copying' is nil."
119 (defcustom backup-by-copying-when-mismatch t
120 "Non-nil means create backups by copying if this preserves owner or group.
121 Renaming may still be used (subject to control of other variables)
122 when it would not result in changing the owner or group of the file;
123 that is, for files which are owned by you and whose group matches
124 the default for a new file created there by you.
125 This variable is relevant only if `backup-by-copying' is nil."
129 (put 'backup-by-copying-when-mismatch
'permanent-local t
)
131 (defcustom backup-by-copying-when-privileged-mismatch
200
132 "Non-nil means create backups by copying to preserve a privileged owner.
133 Renaming may still be used (subject to control of other variables)
134 when it would not result in changing the owner of the file or if the owner
135 has a user id greater than the value of this variable. This is useful
136 when low-numbered uid's are used for special system users (such as root)
137 that must maintain ownership of certain files.
138 This variable is relevant only if `backup-by-copying' and
139 `backup-by-copying-when-mismatch' are nil."
140 :type
'(choice (const nil
) integer
)
143 (defvar backup-enable-predicate
'normal-backup-enable-predicate
144 "Predicate that looks at a file name and decides whether to make backups.
145 Called with an absolute file name as argument, it returns t to enable backup.")
147 (defcustom buffer-offer-save nil
148 "Non-nil in a buffer means always offer to save buffer on exit.
149 Do so even if the buffer is not visiting a file.
150 Automatically local in all buffers."
153 (make-variable-buffer-local 'buffer-offer-save
)
155 (defcustom find-file-existing-other-name t
156 "Non-nil means find a file under alternative names, in existing buffers.
157 This means if any existing buffer is visiting the file you want
158 under another name, you get the existing buffer instead of a new buffer."
162 (defcustom find-file-visit-truename nil
163 "Non-nil means visit a file under its truename.
164 The truename of a file is found by chasing all links
165 both at the file level and at the levels of the containing directories."
168 (put 'find-file-visit-truename
'safe-local-variable
'booleanp
)
170 (defcustom revert-without-query nil
171 "Specify which files should be reverted without query.
172 The value is a list of regular expressions.
173 If the file name matches one of these regular expressions,
174 then `revert-buffer' reverts the file without querying
175 if the file has changed on disk and you have not edited the buffer."
176 :type
'(repeat regexp
)
179 (defvar buffer-file-number nil
180 "The device number and file number of the file visited in the current buffer.
181 The value is a list of the form (FILENUM DEVNUM).
182 This pair of numbers uniquely identifies the file.
183 If the buffer is visiting a new file, the value is nil.")
184 (make-variable-buffer-local 'buffer-file-number
)
185 (put 'buffer-file-number
'permanent-local t
)
187 (defvar buffer-file-numbers-unique
(not (memq system-type
'(windows-nt)))
188 "Non-nil means that `buffer-file-number' uniquely identifies files.")
190 (defvar buffer-file-read-only nil
191 "Non-nil if visited file was read-only when visited.")
192 (make-variable-buffer-local 'buffer-file-read-only
)
194 (defcustom small-temporary-file-directory
195 (if (eq system-type
'ms-dos
) (getenv "TMPDIR"))
196 "The directory for writing small temporary files.
197 If non-nil, this directory is used instead of `temporary-file-directory'
198 by programs that create small temporary files. This is for systems that
199 have fast storage with limited space, such as a RAM disk."
201 :initialize
'custom-initialize-delay
202 :type
'(choice (const nil
) directory
))
204 ;; The system null device. (Should reference NULL_DEVICE from C.)
205 (defvar null-device
(purecopy "/dev/null") "The system null device.")
207 (declare-function msdos-long-file-names
"msdos.c")
208 (declare-function w32-long-file-name
"w32proc.c")
209 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
210 (declare-function dired-unmark
"dired" (arg))
211 (declare-function dired-do-flagged-delete
"dired" (&optional nomessage
))
212 (declare-function dos-8
+3-filename
"dos-fns" (filename))
213 (declare-function view-mode-disable
"view" ())
214 (declare-function dosified-file-name
"dos-fns" (file-name))
216 (defvar file-name-invalid-regexp
217 (cond ((and (eq system-type
'ms-dos
) (not (msdos-long-file-names)))
219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
220 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
221 "[\000-\037]\\|" ; control characters
222 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
223 "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot
224 ((memq system-type
'(ms-dos windows-nt cygwin
))
226 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
227 "[|<>\"?*\000-\037]"))) ; invalid characters
228 (t (purecopy "[\000]")))
229 "Regexp recognizing file names which aren't allowed by the filesystem.")
231 (defcustom file-precious-flag nil
232 "Non-nil means protect against I/O errors while saving files.
233 Some modes set this non-nil in particular buffers.
235 This feature works by writing the new contents into a temporary file
236 and then renaming the temporary file to replace the original.
237 In this way, any I/O error in writing leaves the original untouched,
238 and there is never any instant where the file is nonexistent.
240 Note that this feature forces backups to be made by copying.
241 Yet, at the same time, saving a precious file
242 breaks any hard links between it and other files.
244 This feature is advisory: for example, if the directory in which the
245 file is being saved is not writable, Emacs may ignore a non-nil value
246 of `file-precious-flag' and write directly into the file.
248 See also: `break-hardlink-on-save'."
252 (defcustom break-hardlink-on-save nil
253 "Non-nil means when saving a file that exists under several names
254 \(i.e., has multiple hardlinks), break the hardlink associated with
255 `buffer-file-name' and write to a new file, so that the other
256 instances of the file are not affected by the save.
258 If `buffer-file-name' refers to a symlink, do not break the symlink.
260 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
261 For example, if the directory in which a file is being saved is not
262 itself writable, then error instead of saving in some
263 hardlink-nonbreaking way.
265 See also `backup-by-copying' and `backup-by-copying-when-linked'."
270 (defcustom version-control nil
271 "Control use of version numbers for backup files.
272 When t, make numeric backup versions unconditionally.
273 When nil, make them for files that have some already.
274 The value `never' means do not make them."
275 :type
'(choice (const :tag
"Never" never
)
276 (const :tag
"If existing" nil
)
277 (other :tag
"Always" t
))
280 (put 'version-control
'safe-local-variable
281 '(lambda (x) (or (booleanp x
) (equal x
'never
))))
283 (defcustom dired-kept-versions
2
284 "When cleaning directory, number of versions to keep."
289 (defcustom delete-old-versions nil
290 "If t, delete excess backup versions silently.
291 If nil, ask confirmation. Any other value prevents any trimming."
292 :type
'(choice (const :tag
"Delete" t
)
293 (const :tag
"Ask" nil
)
294 (other :tag
"Leave" other
))
297 (defcustom kept-old-versions
2
298 "Number of oldest versions to keep when a new numbered backup is made."
301 (put 'kept-old-versions
'safe-local-variable
'integerp
)
303 (defcustom kept-new-versions
2
304 "Number of newest versions to keep when a new numbered backup is made.
305 Includes the new backup. Must be > 0"
308 (put 'kept-new-versions
'safe-local-variable
'integerp
)
310 (defcustom require-final-newline nil
311 "Whether to add a newline automatically at the end of the file.
313 A value of t means do this only when the file is about to be saved.
314 A value of `visit' means do this right after the file is visited.
315 A value of `visit-save' means do it at both of those times.
316 Any other non-nil value means ask user whether to add a newline, when saving.
317 A value of nil means don't add newlines.
319 Certain major modes set this locally to the value obtained
320 from `mode-require-final-newline'."
321 :type
'(choice (const :tag
"When visiting" visit
)
322 (const :tag
"When saving" t
)
323 (const :tag
"When visiting or saving" visit-save
)
324 (const :tag
"Don't add newlines" nil
)
325 (other :tag
"Ask each time" ask
))
326 :group
'editing-basics
)
328 (defcustom mode-require-final-newline t
329 "Whether to add a newline at end of file, in certain major modes.
330 Those modes set `require-final-newline' to this value when you enable them.
331 They do so because they are often used for files that are supposed
332 to end in newlines, and the question is how to arrange that.
334 A value of t means do this only when the file is about to be saved.
335 A value of `visit' means do this right after the file is visited.
336 A value of `visit-save' means do it at both of those times.
337 Any other non-nil value means ask user whether to add a newline, when saving.
339 A value of nil means do not add newlines. That is a risky choice in this
340 variable since this value is used for modes for files that ought to have
341 final newlines. So if you set this to nil, you must explicitly check and
342 add a final newline, whenever you save a file that really needs one."
343 :type
'(choice (const :tag
"When visiting" visit
)
344 (const :tag
"When saving" t
)
345 (const :tag
"When visiting or saving" visit-save
)
346 (const :tag
"Don't add newlines" nil
)
347 (other :tag
"Ask each time" ask
))
348 :group
'editing-basics
351 (defcustom auto-save-default t
352 "Non-nil says by default do auto-saving of every file-visiting buffer."
356 (defcustom auto-save-file-name-transforms
357 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
358 ;; Don't put "\\2" inside expand-file-name, since it will be
359 ;; transformed to "/2" on DOS/Windows.
360 ,(concat temporary-file-directory
"\\2") t
))
361 "Transforms to apply to buffer file name before making auto-save file name.
362 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
363 REGEXP is a regular expression to match against the file name.
364 If it matches, `replace-match' is used to replace the
365 matching part with REPLACEMENT.
366 If the optional element UNIQUIFY is non-nil, the auto-save file name is
367 constructed by taking the directory part of the replaced file-name,
368 concatenated with the buffer file name with all directory separators
369 changed to `!' to prevent clashes. This will not work
370 correctly if your filesystem truncates the resulting name.
372 All the transforms in the list are tried, in the order they are listed.
373 When one transform applies, its result is final;
374 no further transforms are tried.
376 The default value is set up to put the auto-save file into the
377 temporary directory (see the variable `temporary-file-directory') for
378 editing a remote file.
380 On MS-DOS filesystems without long names this variable is always
383 :type
'(repeat (list (string :tag
"Regexp") (string :tag
"Replacement")
384 (boolean :tag
"Uniquify")))
385 :initialize
'custom-initialize-delay
388 (defcustom save-abbrevs t
389 "Non-nil means save word abbrevs too when files are saved.
390 If `silently', don't ask the user before saving."
391 :type
'(choice (const t
) (const nil
) (const silently
))
394 (defcustom find-file-run-dired t
395 "Non-nil means allow `find-file' to visit directories.
396 To visit the directory, `find-file' runs `find-directory-functions'."
400 (defcustom find-directory-functions
'(cvs-dired-noselect dired-noselect
)
401 "List of functions to try in sequence to visit a directory.
402 Each function is called with the directory name as the sole argument
403 and should return either a buffer or nil."
404 :type
'(hook :options
(cvs-dired-noselect dired-noselect
))
407 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
408 (defcustom file-name-at-point-functions
'(ffap-guess-file-name-at-point)
409 "List of functions to try in sequence to get a file name at point.
410 Each function should return either nil or a file name found at the
411 location of point in the current buffer."
412 :type
'(hook :options
(ffap-guess-file-name-at-point))
415 ;;;It is not useful to make this a local variable.
416 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
417 (defvar find-file-not-found-functions nil
418 "List of functions to be called for `find-file' on nonexistent file.
419 These functions are called as soon as the error is detected.
420 Variable `buffer-file-name' is already set up.
421 The functions are called in the order given until one of them returns non-nil.")
422 (define-obsolete-variable-alias 'find-file-not-found-hooks
423 'find-file-not-found-functions
"22.1")
425 ;;;It is not useful to make this a local variable.
426 ;;;(put 'find-file-hooks 'permanent-local t)
427 (define-obsolete-variable-alias 'find-file-hooks
'find-file-hook
"22.1")
428 (defcustom find-file-hook nil
429 "List of functions to be called after a buffer is loaded from a file.
430 The buffer's local variables (if any) will have been processed before the
431 functions are called."
434 :options
'(auto-insert)
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
)
453 (define-obsolete-variable-alias 'write-file-hooks
'write-file-functions
"22.1")
455 (defvar local-write-file-hooks nil
)
456 (make-variable-buffer-local 'local-write-file-hooks
)
457 (put 'local-write-file-hooks
'permanent-local t
)
458 (make-obsolete-variable 'local-write-file-hooks
'write-file-functions
"22.1")
460 (defvar write-contents-functions nil
461 "List of functions to be called before writing out a buffer to a file.
462 If one of them returns non-nil, the file is considered already written
463 and the rest are not called and neither are the functions in
464 `write-file-functions'.
466 This variable is meant to be used for hooks that pertain to the
467 buffer's contents, not to the particular visited file; thus,
468 `set-visited-file-name' does not clear this variable; but changing the
469 major mode does clear it.
471 For hooks that _do_ pertain to the particular visited file, use
472 `write-file-functions'. Both this variable and
473 `write-file-functions' relate to how a buffer is saved to file.
474 To perform various checks or updates before the buffer is saved,
475 use `before-save-hook'.")
476 (make-variable-buffer-local 'write-contents-functions
)
477 (define-obsolete-variable-alias 'write-contents-hooks
478 'write-contents-functions
"22.1")
480 (defcustom enable-local-variables t
481 "Control use of local variables in files you visit.
482 The value can be t, nil, :safe, :all, or something else.
484 A value of t means file local variables specifications are obeyed
485 if all the specified variable values are safe; if any values are
486 not safe, Emacs queries you, once, whether to set them all.
487 \(When you say yes to certain values, they are remembered as safe.)
489 :safe means set the safe variables, and ignore the rest.
490 :all means set all variables, whether safe or not.
491 (Don't set it permanently to :all.)
492 A value of nil means always ignore the file local variables.
494 Any other value means always query you once whether to set them all.
495 \(When you say yes to certain values, they are remembered as safe, but
496 this has no effect when `enable-local-variables' is \"something else\".)
498 This variable also controls use of major modes specified in
501 The command \\[normal-mode], when used interactively,
502 always obeys file local variable specifications and the -*- line,
503 and ignores this variable."
505 :type
'(choice (const :tag
"Query Unsafe" t
)
506 (const :tag
"Safe Only" :safe
)
507 (const :tag
"Do all" :all
)
508 (const :tag
"Ignore" nil
)
509 (other :tag
"Query" other
))
512 (defvar local-enable-local-variables t
513 "Like `enable-local-variables' but meant for buffer-local bindings.
514 The meaningful values are nil and non-nil. The default is non-nil.
515 If a major mode sets this to nil, buffer-locally, then any local
516 variables list in the file will be ignored.
518 This variable does not affect the use of major modes
519 specified in a -*- line.")
521 (defcustom enable-local-eval
'maybe
522 "Control processing of the \"variable\" `eval' in a file's local variables.
523 The value can be t, nil or something else.
524 A value of t means obey `eval' variables.
525 A value of nil means ignore them; anything else means query."
527 :type
'(choice (const :tag
"Obey" t
)
528 (const :tag
"Ignore" nil
)
529 (other :tag
"Query" other
))
532 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
533 (or (fboundp 'lock-buffer
)
534 (defalias 'lock-buffer
'ignore
))
535 (or (fboundp 'unlock-buffer
)
536 (defalias 'unlock-buffer
'ignore
))
537 (or (fboundp 'file-locked-p
)
538 (defalias 'file-locked-p
'ignore
))
540 (defcustom view-read-only nil
541 "Non-nil means buffers visiting files read-only do so in view mode.
542 In fact, this means that all read-only buffers normally have
543 View mode enabled, including buffers that are read-only because
544 you visit a file you cannot alter, and buffers you make read-only
545 using \\[toggle-read-only]."
549 (defvar file-name-history nil
550 "History list of file names entered in the minibuffer.
552 Maximum length of the history list is determined by the value
553 of `history-length', which see.")
555 (put 'ange-ftp-completion-hook-function
'safe-magic t
)
556 (defun ange-ftp-completion-hook-function (op &rest args
)
557 "Provides support for ange-ftp host name completion.
558 Runs the usual ange-ftp hook, but only for completion operations."
559 ;; Having this here avoids the need to load ange-ftp when it's not
561 (if (memq op
'(file-name-completion file-name-all-completions
))
562 (apply 'ange-ftp-hook-function op args
)
563 (let ((inhibit-file-name-handlers
564 (cons 'ange-ftp-completion-hook-function
565 (and (eq inhibit-file-name-operation op
)
566 inhibit-file-name-handlers
)))
567 (inhibit-file-name-operation op
))
570 (declare-function dos-convert-standard-filename
"dos-fns.el" (filename))
571 (declare-function w32-convert-standard-filename
"w32-fns.el" (filename))
573 (defun convert-standard-filename (filename)
574 "Convert a standard file's name to something suitable for the OS.
575 This means to guarantee valid names and perhaps to canonicalize
578 FILENAME should be an absolute file name since the conversion rules
579 sometimes vary depending on the position in the file name. E.g. c:/foo
580 is a valid DOS file name, but c:/bar/c:/foo is not.
582 This function's standard definition is trivial; it just returns
583 the argument. However, on Windows and DOS, replace invalid
584 characters. On DOS, make sure to obey the 8.3 limitations.
585 In the native Windows build, turn Cygwin names into native names,
586 and also turn slashes into backslashes if the shell requires it (see
587 `w32-shell-dos-semantics').
589 See Info node `(elisp)Standard File Names' for more details."
591 ((eq system-type
'cygwin
)
592 (let ((name (copy-sequence filename
))
594 ;; Replace invalid filename characters with !
595 (while (string-match "[?*:<>|\"\000-\037]" name start
)
596 (aset name
(match-beginning 0) ?
!)
597 (setq start
(match-end 0)))
599 ((eq system-type
'windows-nt
)
600 (w32-convert-standard-filename filename
))
601 ((eq system-type
'ms-dos
)
602 (dos-convert-standard-filename filename
))
605 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
606 "Read directory name, prompting with PROMPT and completing in directory DIR.
607 Value is not expanded---you must call `expand-file-name' yourself.
608 Default name to DEFAULT-DIRNAME if user exits with the same
609 non-empty string that was inserted by this function.
610 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
611 or just DIR if INITIAL is nil.)
612 If the user exits with an empty minibuffer, this function returns
613 an empty string. (This can only happen if the user erased the
614 pre-inserted contents or if `insert-default-directory' is nil.)
615 Fourth arg MUSTMATCH non-nil means require existing directory's name.
616 Non-nil and non-t means also require confirmation after completion.
617 Fifth arg INITIAL specifies text to start with.
618 DIR should be an absolute directory name. It defaults to
619 the value of `default-directory'."
621 (setq dir default-directory
))
622 (read-file-name prompt dir
(or default-dirname
623 (if initial
(expand-file-name initial dir
)
630 "Show the current default directory."
632 (message "Directory %s" default-directory
))
635 "Value of the CDPATH environment variable, as a list.
636 Not actually set up until the first time you use it.")
638 (defun parse-colon-path (cd-path)
639 "Explode a search path into a list of directory names.
640 Directories are separated by occurrences of `path-separator'
641 \(which is colon in GNU and GNU-like systems)."
642 ;; We could use split-string here.
644 (let (cd-list (cd-start 0) cd-colon
)
645 (setq cd-path
(concat cd-path path-separator
))
646 (while (setq cd-colon
(string-match path-separator cd-path cd-start
))
649 (list (if (= cd-start cd-colon
)
651 (substitute-in-file-name
652 (file-name-as-directory
653 (substring cd-path cd-start cd-colon
)))))))
654 (setq cd-start
(+ cd-colon
1)))
657 (defun cd-absolute (dir)
658 "Change current directory to given absolute file name DIR."
659 ;; Put the name into directory syntax now,
660 ;; because otherwise expand-file-name may give some bad results.
661 (setq dir
(file-name-as-directory dir
))
662 ;; We used to additionally call abbreviate-file-name here, for an
663 ;; unknown reason. Problem is that most buffers are setup
664 ;; without going through cd-absolute and don't call
665 ;; abbreviate-file-name on their default-directory, so the few that
666 ;; do end up using a superficially different directory.
667 (setq dir
(expand-file-name dir
))
668 (if (not (file-directory-p dir
))
669 (if (file-exists-p dir
)
670 (error "%s is not a directory" dir
)
671 (error "%s: no such directory" dir
))
672 (unless (file-executable-p dir
)
673 (error "Cannot cd to %s: Permission denied" dir
))
674 (setq default-directory dir
)
675 (setq list-buffers-directory dir
)))
678 "Make DIR become the current buffer's default directory.
679 If your environment includes a `CDPATH' variable, try each one of
680 that list of directories (separated by occurrences of
681 `path-separator') when resolving a relative directory name.
682 The path separator is colon in GNU and GNU-like systems."
685 ;; FIXME: There's a subtle bug in the completion below. Seems linked
686 ;; to a fundamental difficulty of implementing `predicate' correctly.
687 ;; The manifestation is that TAB may list non-directories in the case where
688 ;; those files also correspond to valid directories (if your cd-path is (A/
689 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
690 ;; will be listed as valid completions).
691 ;; This is because `a' (listed because of A/a) is indeed a valid choice
692 ;; (which will lead to the use of B/a).
693 (minibuffer-with-setup-hook
695 (setq minibuffer-completion-table
696 (apply-partially #'locate-file-completion-table
698 (setq minibuffer-completion-predicate
700 (locate-file dir cd-path nil
701 (lambda (f) (and (file-directory-p f
) 'dir-ok
))))))
703 (setq cd-path
(or (parse-colon-path (getenv "CDPATH"))
705 (read-directory-name "Change default directory: "
706 default-directory default-directory
709 (setq cd-path
(or (parse-colon-path (getenv "CDPATH"))
712 (or (locate-file dir cd-path nil
713 (lambda (f) (and (file-directory-p f
) 'dir-ok
)))
714 (error "No such directory found via CDPATH environment variable"))))
716 (defun load-file (file)
717 "Load the Lisp file named FILE."
718 ;; This is a case where .elc makes a lot of sense.
719 (interactive (list (let ((completion-ignored-extensions
720 (remove ".elc" completion-ignored-extensions
)))
721 (read-file-name "Load file: "))))
722 (load (expand-file-name file
) nil nil t
))
724 (defun locate-file (filename path
&optional suffixes predicate
)
725 "Search for FILENAME through PATH.
726 If found, return the absolute file name of FILENAME, with its suffixes;
727 otherwise return nil.
728 PATH should be a list of directories to look in, like the lists in
729 `exec-path' or `load-path'.
730 If SUFFIXES is non-nil, it should be a list of suffixes to append to
731 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
732 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
733 If non-nil, PREDICATE is used instead of `file-readable-p'.
735 This function will normally skip directories, so if you want it to find
736 directories, make sure the PREDICATE function returns `dir-ok' for them.
738 PREDICATE can also be an integer to pass to the `access' system call,
739 in which case file-name handlers are ignored. This usage is deprecated.
740 For compatibility, PREDICATE can also be one of the symbols
741 `executable', `readable', `writable', or `exists', or a list of
742 one or more of those symbols."
743 (if (and predicate
(symbolp predicate
) (not (functionp predicate
)))
744 (setq predicate
(list predicate
)))
745 (when (and (consp predicate
) (not (functionp predicate
)))
747 (logior (if (memq 'executable predicate
) 1 0)
748 (if (memq 'writable predicate
) 2 0)
749 (if (memq 'readable predicate
) 4 0))))
750 (locate-file-internal filename path suffixes predicate
))
752 (defun locate-file-completion-table (dirs suffixes string pred action
)
753 "Do completion for file names passed to `locate-file'."
755 ((file-name-absolute-p string
)
756 ;; FIXME: maybe we should use completion-file-name-table instead,
757 ;; tho at least for `load', the arg is passed through
758 ;; substitute-in-file-name for historical reasons.
759 (read-file-name-internal string pred action
))
760 ((eq (car-safe action
) 'boundaries
)
761 (let ((suffix (cdr action
)))
763 (length (file-name-directory string
))
764 (let ((x (file-name-directory suffix
)))
765 (if x
(1- (length x
)) (length suffix
))))))
768 ;; If we have files like "foo.el" and "foo.elc", we could load one of
769 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
770 ;; preferred way. So if we list all 3, that gives a lot of redundant
771 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
772 ;; the user does want to pay attention to the extension. We try to
773 ;; diffuse this tension by stripping the suffix, except when the
774 ;; result is a single element (i.e. usually we only list "foo" unless
775 ;; it's the only remaining element in the list, in which case we do
776 ;; list "foo", "foo.elc" and "foo.el").
778 (suffix (concat (regexp-opt suffixes t
) "\\'"))
779 (string-dir (file-name-directory string
))
780 (string-file (file-name-nondirectory string
)))
783 (setq dir default-directory
))
784 (if string-dir
(setq dir
(expand-file-name string-dir dir
)))
785 (when (file-directory-p dir
)
786 (dolist (file (file-name-all-completions
788 (if (not (string-match suffix file
))
790 (push file fullnames
)
791 (push (substring file
0 (match-beginning 0)) names
)))))
792 ;; Switching from names to names+fullnames creates a non-monotonicity
793 ;; which can cause problems with things like partial-completion.
794 ;; To minimize the problem, filter out completion-regexp-list, so that
795 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
796 ;; from `names' which only matched `string' when they still had
798 (setq names
(all-completions string names
))
799 ;; Remove duplicates of the first element, so that we can easily check
800 ;; if `names' really only contains a single element.
801 (when (cdr names
) (setcdr names
(delete (car names
) (cdr names
))))
803 ;; There's no more than one matching non-suffixed element, so expand
804 ;; the list by adding the suffixed elements as well.
805 (setq names
(nconc names fullnames
)))
806 (completion-table-with-context
807 string-dir names string-file pred action
)))))
809 (defun locate-file-completion (string path-and-suffixes action
)
810 "Do completion for file names passed to `locate-file'.
811 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
812 (locate-file-completion-table (car path-and-suffixes
)
813 (cdr path-and-suffixes
)
815 (make-obsolete 'locate-file-completion
'locate-file-completion-table
"23.1")
817 (defvar locate-dominating-stop-dir-regexp
818 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
819 "Regexp of directory names which stop the search in `locate-dominating-file'.
820 Any directory whose name matches this regexp will be treated like
821 a kind of root directory by `locate-dominating-file' which will stop its search
822 when it bumps into it.
823 The default regexp prevents fruitless and time-consuming attempts to find
824 special files in directories in which filenames are interpreted as hostnames,
825 or mount points potentially requiring authentication as a different user.")
827 ;; (defun locate-dominating-files (file regexp)
828 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
829 ;; Stop at the first parent where a matching file is found and return the list
830 ;; of files that that match in this directory."
832 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
833 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
835 ;; ;; Abbreviate, so as to stop when we cross ~/.
836 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
839 ;; ;; As a heuristic, we stop looking up the hierarchy of
840 ;; ;; directories as soon as we find a directory belonging to
841 ;; ;; another user. This should save us from looking in
842 ;; ;; things like /net and /afs. This assumes that all the
843 ;; ;; files inside a project belong to the same user.
844 ;; (let ((prev-user user))
845 ;; (setq user (nth 2 (file-attributes dir)))
846 ;; (or (null prev-user) (equal user prev-user))))
847 ;; (if (setq files (condition-case nil
848 ;; (directory-files dir 'full regexp 'nosort)
850 ;; (throw 'found files)
852 ;; (setq dir (file-name-directory
853 ;; (directory-file-name dir))))
857 (defun locate-dominating-file (file name
)
858 "Look up the directory hierarchy from FILE for a file named NAME.
859 Stop at the first parent directory containing a file NAME,
860 and return the directory. Return nil if not found."
861 ;; We used to use the above locate-dominating-files code, but the
862 ;; directory-files call is very costly, so we're much better off doing
863 ;; multiple calls using the code in here.
865 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
866 ;; `name' in /home or in /.
867 (setq file
(abbreviate-file-name file
))
870 ;; `user' is not initialized outside the loop because
871 ;; `file' may not exist, so we may have to walk up part of the
872 ;; hierarchy before we find the "initial UID".
877 ;; FIXME: Disabled this heuristic because it is sometimes
879 ;; As a heuristic, we stop looking up the hierarchy of
880 ;; directories as soon as we find a directory belonging
881 ;; to another user. This should save us from looking in
882 ;; things like /net and /afs. This assumes that all the
883 ;; files inside a project belong to the same user.
884 ;; (let ((prev-user user))
885 ;; (setq user (nth 2 (file-attributes file)))
886 ;; (and prev-user (not (equal user prev-user))))
887 (string-match locate-dominating-stop-dir-regexp file
)))
888 (setq try
(file-exists-p (expand-file-name name file
)))
889 (cond (try (setq root file
))
890 ((equal file
(setq prev-file file
891 file
(file-name-directory
892 (directory-file-name file
))))
897 (defun executable-find (command)
898 "Search for COMMAND in `exec-path' and return the absolute file name.
899 Return nil if COMMAND is not found anywhere in `exec-path'."
900 ;; Use 1 rather than file-executable-p to better match the behavior of
902 (locate-file command exec-path exec-suffixes
1))
904 (defun load-library (library)
905 "Load the Emacs Lisp library named LIBRARY.
906 This is an interface to the function `load'. LIBRARY is searched
907 for in `load-path', both with and without `load-suffixes' (as
908 well as `load-file-rep-suffixes').
910 See Info node `(emacs)Lisp Libraries' for more details.
911 See `load-file' for a different interface to `load'."
913 (list (completing-read "Load library: "
914 (apply-partially 'locate-file-completion-table
916 (get-load-suffixes)))))
919 (defun file-remote-p (file &optional identification connected
)
920 "Test whether FILE specifies a location on a remote system.
921 Returns nil or a string identifying the remote connection (ideally
922 a prefix of FILE). For example, the remote identification for filename
923 \"/user@host:/foo\" could be \"/user@host:\".
924 A file is considered \"remote\" if accessing it is likely to be slower or
925 less reliable than accessing local files.
926 Furthermore, relative file names do not work across remote connections.
928 IDENTIFICATION specifies which part of the identification shall
929 be returned as string. IDENTIFICATION can be the symbol
930 `method', `user', `host' or `localname'; any other value is
931 handled like nil and means to return the complete identification
934 If CONNECTED is non-nil, the function returns an identification only
935 if FILE is located on a remote system, and a connection is established
936 to that remote system.
938 `file-remote-p' will never open a connection on its own."
939 (let ((handler (find-file-name-handler file
'file-remote-p
)))
941 (funcall handler
'file-remote-p file identification connected
)
944 (defcustom remote-file-name-inhibit-cache
10
945 "Whether to use the remote file-name cache for read access.
947 When `nil', always use the cached values.
948 When `t', never use them.
949 A number means use them for that amount of seconds since they were
952 File attributes of remote files are cached for better performance.
953 If they are changed out of Emacs' control, the cached values
954 become invalid, and must be invalidated.
956 In case a remote file is checked regularly, it might be
957 reasonable to let-bind this variable to a value less then the
958 time period between two checks.
961 \(defun display-time-file-nonempty-p \(file)
962 \(let \(\(remote-file-name-inhibit-cache \(- display-time-interval 5)))
963 \(and \(file-exists-p file)
964 \(< 0 \(nth 7 \(file-attributes \(file-chase-links file)))))))"
968 (const :tag
"Do not inhibit file name cache" nil
)
969 (const :tag
"Do not use file name cache" t
)
970 (integer :tag
"Do not use file name cache"
971 :format
"Do not use file name cache older then %v seconds"
974 (defun file-local-copy (file)
975 "Copy the file FILE into a temporary file on this machine.
976 Returns the name of the local copy, or nil, if FILE is directly
978 ;; This formerly had an optional BUFFER argument that wasn't used by
980 (let ((handler (find-file-name-handler file
'file-local-copy
)))
982 (funcall handler
'file-local-copy file
)
985 (defun file-truename (filename &optional counter prev-dirs
)
986 "Return the truename of FILENAME, which should be absolute.
987 The truename of a file name is found by chasing symbolic links
988 both at the level of the file and at the level of the directories
989 containing it, until no links are left at any level.
991 \(fn FILENAME)" ;; Don't document the optional arguments.
992 ;; COUNTER and PREV-DIRS are only used in recursive calls.
993 ;; COUNTER can be a cons cell whose car is the count of how many
994 ;; more links to chase before getting an error.
995 ;; PREV-DIRS can be a cons cell whose car is an alist
996 ;; of truenames we've just recently computed.
997 (cond ((or (string= filename
"") (string= filename
"~"))
998 (setq filename
(expand-file-name filename
))
999 (if (string= filename
"")
1000 (setq filename
"/")))
1001 ((and (string= (substring filename
0 1) "~")
1002 (string-match "~[^/]*/?" filename
))
1004 (substring filename
0 (match-end 0)))
1005 (rest (substring filename
(match-end 0))))
1006 (setq filename
(concat (expand-file-name first-part
) rest
)))))
1008 (or counter
(setq counter
(list 100)))
1010 ;; For speed, remove the ange-ftp completion handler from the list.
1011 ;; We know it's not needed here.
1012 ;; For even more speed, do this only on the outermost call.
1013 (file-name-handler-alist
1014 (if prev-dirs file-name-handler-alist
1015 (let ((tem (copy-sequence file-name-handler-alist
)))
1016 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
1017 (or prev-dirs
(setq prev-dirs
(list nil
)))
1019 ;; andrewi@harlequin.co.uk - none of the following code (except for
1020 ;; invoking the file-name handler) currently applies on Windows
1021 ;; (ie. there are no native symlinks), but there is an issue with
1022 ;; case differences being ignored by the OS, and short "8.3 DOS"
1023 ;; name aliases existing for all files. (The short names are not
1024 ;; reported by directory-files, but can be used to refer to files.)
1025 ;; It seems appropriate for file-truename to resolve these issues in
1026 ;; the most natural way, which on Windows is to call the function
1027 ;; `w32-long-file-name' - this returns the exact name of a file as
1028 ;; it is stored on disk (expanding short name aliases with the full
1029 ;; name in the process).
1030 (if (eq system-type
'windows-nt
)
1031 (let ((handler (find-file-name-handler filename
'file-truename
)))
1032 ;; For file name that has a special handler, call handler.
1033 ;; This is so that ange-ftp can save time by doing a no-op.
1035 (setq filename
(funcall handler
'file-truename filename
))
1036 ;; If filename contains a wildcard, newname will be the old name.
1037 (unless (string-match "[[*?]" filename
)
1038 ;; If filename exists, use the long name. If it doesn't exist,
1039 ;; drill down until we find a directory that exists, and use
1040 ;; the long name of that, with the extra non-existent path
1041 ;; components concatenated.
1042 (let ((longname (w32-long-file-name filename
))
1045 (setq filename longname
)
1046 ;; Include the preceding directory separator in the missing
1047 ;; part so subsequent recursion on the rest works.
1048 (setq missing
(concat "/" (file-name-nondirectory filename
)))
1049 (let ((length (length missing
)))
1051 (if (> length
(length filename
))
1053 (substring filename
0 (- length
)))))
1054 (setq filename
(concat (file-truename rest
) missing
))))))
1057 ;; If this file directly leads to a link, process that iteratively
1058 ;; so that we don't use lots of stack.
1060 (setcar counter
(1- (car counter
)))
1061 (if (< (car counter
) 0)
1062 (error "Apparent cycle of symbolic links for %s" filename
))
1063 (let ((handler (find-file-name-handler filename
'file-truename
)))
1064 ;; For file name that has a special handler, call handler.
1065 ;; This is so that ange-ftp can save time by doing a no-op.
1067 (setq filename
(funcall handler
'file-truename filename
)
1069 (let ((dir (or (file-name-directory filename
) default-directory
))
1071 ;; Get the truename of the directory.
1072 (setq dirfile
(directory-file-name dir
))
1073 ;; If these are equal, we have the (or a) root directory.
1074 (or (string= dir dirfile
)
1075 ;; If this is the same dir we last got the truename for,
1076 ;; save time--don't recalculate.
1077 (if (assoc dir
(car prev-dirs
))
1078 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
1080 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
1081 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
1083 (if (equal ".." (file-name-nondirectory filename
))
1085 (directory-file-name (file-name-directory (directory-file-name dir
)))
1087 (if (equal "." (file-name-nondirectory filename
))
1088 (setq filename
(directory-file-name dir
)
1090 ;; Put it back on the file name.
1091 (setq filename
(concat dir
(file-name-nondirectory filename
)))
1092 ;; Is the file name the name of a link?
1093 (setq target
(file-symlink-p filename
))
1095 ;; Yes => chase that link, then start all over
1096 ;; since the link may point to a directory name that uses links.
1097 ;; We can't safely use expand-file-name here
1098 ;; since target might look like foo/../bar where foo
1099 ;; is itself a link. Instead, we handle . and .. above.
1101 (if (file-name-absolute-p target
)
1103 (concat dir target
))
1106 (setq done t
))))))))
1109 (defun file-chase-links (filename &optional limit
)
1110 "Chase links in FILENAME until a name that is not a link.
1111 Unlike `file-truename', this does not check whether a parent
1112 directory name is a symbolic link.
1113 If the optional argument LIMIT is a number,
1114 it means chase no more than that many links and then stop."
1115 (let (tem (newname filename
)
1117 (while (and (or (null limit
) (< count limit
))
1118 (setq tem
(file-symlink-p newname
)))
1120 (if (and (null limit
) (= count
100))
1121 (error "Apparent cycle of symbolic links for %s" filename
))
1122 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1123 (while (string-match "//+" tem
)
1124 (setq tem
(replace-match "/" nil nil tem
)))
1125 ;; Handle `..' by hand, since it needs to work in the
1126 ;; target of any directory symlink.
1127 ;; This code is not quite complete; it does not handle
1128 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1129 (while (string-match "\\`\\.\\./" tem
)
1130 (setq tem
(substring tem
3))
1131 (setq newname
(expand-file-name newname
))
1132 ;; Chase links in the default dir of the symlink.
1135 (directory-file-name (file-name-directory newname
))))
1136 ;; Now find the parent of that dir.
1137 (setq newname
(file-name-directory newname
)))
1138 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
1139 (setq count
(1+ count
))))
1142 (defun make-temp-file (prefix &optional dir-flag suffix
)
1143 "Create a temporary file.
1144 The returned file name (created by appending some random characters at the end
1145 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1146 is guaranteed to point to a newly created empty file.
1147 You can then use `write-region' to write new data into the file.
1149 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1151 If SUFFIX is non-nil, add that at the end of the file name."
1152 (let ((umask (default-file-modes))
1156 ;; Create temp files with strict access rights. It's easy to
1157 ;; loosen them later, whereas it's impossible to close the
1158 ;; time-window of loose permissions otherwise.
1159 (set-default-file-modes ?
\700)
1160 (while (condition-case ()
1164 (if (zerop (length prefix
))
1165 (file-name-as-directory
1166 temporary-file-directory
)
1167 (expand-file-name prefix
1168 temporary-file-directory
))))
1170 (setq file
(concat file suffix
)))
1172 (make-directory file
)
1173 (write-region "" nil file nil
'silent nil
'excl
))
1175 (file-already-exists t
))
1176 ;; the file was somehow created by someone else between
1177 ;; `make-temp-name' and `write-region', let's try again.
1181 (set-default-file-modes umask
))))
1183 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
1184 "Change the encoding of FILE's name from CODING to NEW-CODING.
1185 The value is a new name of FILE.
1186 Signals a `file-already-exists' error if a file of the new name
1187 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1188 is non-nil. A number as fourth arg means request confirmation if
1189 the new name already exists. This is what happens in interactive
1192 (let ((default-coding (or file-name-coding-system
1193 default-file-name-coding-system
))
1194 (filename (read-file-name "Recode filename: " nil nil t
))
1195 from-coding to-coding
)
1196 (if (and default-coding
1197 ;; We provide the default coding only when it seems that
1198 ;; the filename is correctly decoded by the default
1200 (let ((charsets (find-charset-string filename
)))
1201 (and (not (memq 'eight-bit-control charsets
))
1202 (not (memq 'eight-bit-graphic charsets
)))))
1203 (setq from-coding
(read-coding-system
1204 (format "Recode filename %s from (default %s): "
1205 filename default-coding
)
1207 (setq from-coding
(read-coding-system
1208 (format "Recode filename %s from: " filename
))))
1210 ;; We provide the default coding only when a user is going to
1211 ;; change the encoding not from the default coding.
1212 (if (eq from-coding default-coding
)
1213 (setq to-coding
(read-coding-system
1214 (format "Recode filename %s from %s to: "
1215 filename from-coding
)))
1216 (setq to-coding
(read-coding-system
1217 (format "Recode filename %s from %s to (default %s): "
1218 filename from-coding default-coding
)
1220 (list filename from-coding to-coding
)))
1222 (let* ((default-coding (or file-name-coding-system
1223 default-file-name-coding-system
))
1224 ;; FILE should have been decoded by DEFAULT-CODING.
1225 (encoded (encode-coding-string file default-coding
))
1226 (newname (decode-coding-string encoded coding
))
1227 (new-encoded (encode-coding-string newname new-coding
))
1228 ;; Suppress further encoding.
1229 (file-name-coding-system nil
)
1230 (default-file-name-coding-system nil
)
1231 (locale-coding-system nil
))
1232 (rename-file encoded new-encoded ok-if-already-exists
)
1235 (defcustom confirm-nonexistent-file-or-buffer
'after-completion
1236 "Whether confirmation is requested before visiting a new file or buffer.
1237 If nil, confirmation is not requested.
1238 If the value is `after-completion', confirmation is only
1239 requested if the user called `minibuffer-complete' right before
1240 `minibuffer-complete-and-exit'.
1241 Any other non-nil value means to request confirmation.
1243 This affects commands like `switch-to-buffer' and `find-file'."
1246 :type
'(choice (const :tag
"After completion" after-completion
)
1247 (const :tag
"Never" nil
)
1248 (other :tag
"Always" t
)))
1250 (defun confirm-nonexistent-file-or-buffer ()
1251 "Whether to request confirmation before visiting a new file or buffer.
1252 The variable `confirm-nonexistent-file-or-buffer' determines the
1253 return value, which may be passed as the REQUIRE-MATCH arg to
1254 `read-buffer' or `find-file-read-args'."
1255 (cond ((eq confirm-nonexistent-file-or-buffer
'after-completion
)
1256 'confirm-after-completion
)
1257 (confirm-nonexistent-file-or-buffer
1261 (defun read-buffer-to-switch (prompt)
1262 "Read the name of a buffer to switch to and return as a string.
1263 It is intended for `switch-to-buffer' family of commands since they
1264 need to omit the name of current buffer from the list of completions
1265 and default values."
1266 (let ((rbts-completion-table (internal-complete-buffer-except)))
1267 (minibuffer-with-setup-hook
1269 (setq minibuffer-completion-table rbts-completion-table
)
1270 ;; Since rbts-completion-table is built dynamically, we
1271 ;; can't just add it to the default value of
1272 ;; icomplete-with-completion-tables, so we add it
1274 (if (and (boundp 'icomplete-with-completion-tables
)
1275 (listp icomplete-with-completion-tables
))
1276 (set (make-local-variable 'icomplete-with-completion-tables
)
1277 (cons rbts-completion-table
1278 icomplete-with-completion-tables
))))
1279 (read-buffer prompt
(other-buffer (current-buffer))
1280 (confirm-nonexistent-file-or-buffer)))))
1282 (defun switch-to-buffer-other-window (buffer-or-name &optional norecord
)
1283 "Select the buffer specified by BUFFER-OR-NAME in another window.
1284 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1285 nil. Return the buffer switched to.
1287 If called interactively, prompt for the buffer name using the
1288 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1289 determines whether to request confirmation before creating a new
1292 If BUFFER-OR-NAME is a string and does not identify an existing
1293 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1294 nil, switch to the buffer returned by `other-buffer'.
1296 Optional second argument NORECORD non-nil means do not put this
1297 buffer at the front of the list of recently selected ones.
1299 This uses the function `display-buffer' as a subroutine; see its
1300 documentation for additional customization information."
1302 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1303 (let ((pop-up-windows t
)
1304 same-window-buffer-names same-window-regexps
)
1305 (pop-to-buffer buffer-or-name t norecord
)))
1307 (defun switch-to-buffer-other-frame (buffer-or-name &optional norecord
)
1308 "Switch to buffer BUFFER-OR-NAME in another frame.
1309 BUFFER-OR-NAME may be a buffer, a string \(a buffer name), or
1310 nil. Return the buffer switched to.
1312 If called interactively, prompt for the buffer name using the
1313 minibuffer. The variable `confirm-nonexistent-file-or-buffer'
1314 determines whether to request confirmation before creating a new
1317 If BUFFER-OR-NAME is a string and does not identify an existing
1318 buffer, create a new buffer with that name. If BUFFER-OR-NAME is
1319 nil, switch to the buffer returned by `other-buffer'.
1321 Optional second arg NORECORD non-nil means do not put this
1322 buffer at the front of the list of recently selected ones.
1324 This uses the function `display-buffer' as a subroutine; see its
1325 documentation for additional customization information."
1327 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1328 (let ((pop-up-frames t
)
1329 same-window-buffer-names same-window-regexps
)
1330 (pop-to-buffer buffer-or-name t norecord
)))
1332 (defun display-buffer-other-frame (buffer)
1333 "Display buffer BUFFER in another frame.
1334 This uses the function `display-buffer' as a subroutine; see
1335 its documentation for additional customization information."
1336 (interactive "BDisplay buffer in other frame: ")
1337 (let ((pop-up-frames t
)
1338 same-window-buffer-names same-window-regexps
1339 (old-window (selected-window))
1341 (setq new-window
(display-buffer buffer t
))
1342 ;; This may have been here in order to prevent the new frame from hiding
1343 ;; the old frame. But it does more harm than good.
1344 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1345 ;;(lower-frame (window-frame new-window))
1347 ;; This may have been here in order to make sure the old-frame gets the
1348 ;; focus. But not only can it cause an annoying flicker, with some
1349 ;; window-managers it just makes the window invisible, with no easy
1350 ;; way to recover it. --Stef
1351 ;;(make-frame-invisible (window-frame old-window))
1352 ;;(make-frame-visible (window-frame old-window))
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 (filename &optional wildcards
)
1469 "Edit file FILENAME but don't allow changes.
1470 Like \\[find-file], but marks buffer as read-only.
1471 Use \\[toggle-read-only] to permit editing."
1473 (find-file-read-args "Find file read-only: "
1474 (confirm-nonexistent-file-or-buffer)))
1475 (unless (or (and wildcards find-file-wildcards
1476 (not (string-match "\\`/:" filename
))
1477 (string-match "[[*?]" filename
))
1478 (file-exists-p filename
))
1479 (error "%s does not exist" filename
))
1480 (let ((value (find-file filename wildcards
)))
1481 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1482 (if (listp value
) value
(list value
)))
1485 (defun find-file-read-only-other-window (filename &optional wildcards
)
1486 "Edit file FILENAME in another window but don't allow changes.
1487 Like \\[find-file-other-window], but marks buffer as read-only.
1488 Use \\[toggle-read-only] to permit editing."
1490 (find-file-read-args "Find file read-only other window: "
1491 (confirm-nonexistent-file-or-buffer)))
1492 (unless (or (and wildcards find-file-wildcards
1493 (not (string-match "\\`/:" filename
))
1494 (string-match "[[*?]" filename
))
1495 (file-exists-p filename
))
1496 (error "%s does not exist" filename
))
1497 (let ((value (find-file-other-window filename wildcards
)))
1498 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1499 (if (listp value
) value
(list value
)))
1502 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1503 "Edit file FILENAME in another frame but don't allow changes.
1504 Like \\[find-file-other-frame], but marks buffer as read-only.
1505 Use \\[toggle-read-only] to permit editing."
1507 (find-file-read-args "Find file read-only other frame: "
1508 (confirm-nonexistent-file-or-buffer)))
1509 (unless (or (and wildcards find-file-wildcards
1510 (not (string-match "\\`/:" filename
))
1511 (string-match "[[*?]" filename
))
1512 (file-exists-p filename
))
1513 (error "%s does not exist" filename
))
1514 (let ((value (find-file-other-frame filename wildcards
)))
1515 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1516 (if (listp value
) value
(list value
)))
1519 (defun find-alternate-file-other-window (filename &optional wildcards
)
1520 "Find file FILENAME as a replacement for the file in the next window.
1521 This command does not select that window.
1523 See \\[find-file] for the possible forms of the FILENAME argument.
1525 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1526 expand wildcards (if any) and replace the file with multiple files."
1528 (save-selected-window
1530 (let ((file buffer-file-name
)
1534 (setq file-name
(file-name-nondirectory file
)
1535 file-dir
(file-name-directory file
)))
1536 (list (read-file-name
1537 "Find alternate file: " file-dir nil
1538 (confirm-nonexistent-file-or-buffer) file-name
)
1541 (find-file-other-window filename wildcards
)
1542 (save-selected-window
1544 (find-alternate-file filename wildcards
))))
1546 (defun find-alternate-file (filename &optional wildcards
)
1547 "Find file FILENAME, select its buffer, kill previous buffer.
1548 If the current buffer now contains an empty file that you just visited
1549 \(presumably by mistake), use this command to visit the file you really want.
1551 See \\[find-file] for the possible forms of the FILENAME argument.
1553 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1554 expand wildcards (if any) and replace the file with multiple files.
1556 If the current buffer is an indirect buffer, or the base buffer
1557 for one or more indirect buffers, the other buffer(s) are not
1560 (let ((file buffer-file-name
)
1564 (setq file-name
(file-name-nondirectory file
)
1565 file-dir
(file-name-directory file
)))
1566 (list (read-file-name
1567 "Find alternate file: " file-dir nil
1568 (confirm-nonexistent-file-or-buffer) file-name
)
1570 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1572 (when (and (buffer-modified-p) buffer-file-name
)
1573 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1576 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1577 (error "Aborted"))))
1578 (let ((obuf (current-buffer))
1579 (ofile buffer-file-name
)
1580 (onum buffer-file-number
)
1581 (odir dired-directory
)
1582 (otrue buffer-file-truename
)
1583 (oname (buffer-name)))
1584 ;; Run `kill-buffer-hook' here. It needs to happen before
1585 ;; variables like `buffer-file-name' etc are set to nil below,
1586 ;; because some of the hooks that could be invoked
1587 ;; (e.g., `save-place-to-alist') depend on those variables.
1589 ;; Note that `kill-buffer-hook' is not what queries whether to
1590 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1591 ;; asks that itself. Thus, there's no need to temporarily do
1592 ;; `(set-buffer-modified-p nil)' before running this hook.
1593 (run-hooks 'kill-buffer-hook
)
1594 ;; Okay, now we can end-of-life the old buffer.
1595 (if (get-buffer " **lose**")
1596 (kill-buffer " **lose**"))
1597 (rename-buffer " **lose**")
1601 ;; This prevents us from finding the same buffer
1602 ;; if we specified the same file again.
1603 (setq buffer-file-name nil
)
1604 (setq buffer-file-number nil
)
1605 (setq buffer-file-truename nil
)
1606 ;; Likewise for dired buffers.
1607 (setq dired-directory nil
)
1608 (find-file filename wildcards
))
1609 (when (eq obuf
(current-buffer))
1610 ;; This executes if find-file gets an error
1611 ;; and does not really find anything.
1612 ;; We put things back as they were.
1613 ;; If find-file actually finds something, we kill obuf below.
1614 (setq buffer-file-name ofile
)
1615 (setq buffer-file-number onum
)
1616 (setq buffer-file-truename otrue
)
1617 (setq dired-directory odir
)
1619 (rename-buffer oname
)))
1620 (unless (eq (current-buffer) obuf
)
1621 (with-current-buffer obuf
1622 ;; We already ran these; don't run them again.
1623 (let (kill-buffer-query-functions kill-buffer-hook
)
1624 (kill-buffer obuf
))))))
1626 (defun create-file-buffer (filename)
1627 "Create a suitably named buffer for visiting FILENAME, and return it.
1628 FILENAME (sans directory) is used unchanged if that name is free;
1629 otherwise a string <2> or <3> or ... is appended to get an unused name.
1630 Spaces at the start of FILENAME (sans directory) are removed."
1631 (let ((lastname (file-name-nondirectory filename
)))
1632 (if (string= lastname
"")
1633 (setq lastname filename
))
1635 (string-match "^ *\\(.*\\)" lastname
)
1636 (generate-new-buffer (match-string 1 lastname
)))))
1638 (defun generate-new-buffer (name)
1639 "Create and return a buffer with a name based on NAME.
1640 Choose the buffer's name using `generate-new-buffer-name'."
1641 (get-buffer-create (generate-new-buffer-name name
)))
1643 (defcustom automount-dir-prefix
(purecopy "^/tmp_mnt/")
1644 "Regexp to match the automounter prefix in a directory name."
1648 (defvar abbreviated-home-dir nil
1649 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1651 (defun abbreviate-file-name (filename)
1652 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1653 This also substitutes \"~\" for the user's home directory (unless the
1654 home directory is a root directory) and removes automounter prefixes
1655 \(see the variable `automount-dir-prefix')."
1656 ;; Get rid of the prefixes added by the automounter.
1658 (if (and automount-dir-prefix
1659 (string-match automount-dir-prefix filename
)
1660 (file-exists-p (file-name-directory
1661 (substring filename
(1- (match-end 0))))))
1662 (setq filename
(substring filename
(1- (match-end 0)))))
1663 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1664 ;; To fix this right, we need a `file-name-case-sensitive-p'
1665 ;; function, but we don't have that yet, so just guess.
1666 (let ((case-fold-search
1667 (memq system-type
'(ms-dos windows-nt darwin cygwin
))))
1668 ;; If any elt of directory-abbrev-alist matches this name,
1669 ;; abbreviate accordingly.
1670 (dolist (dir-abbrev directory-abbrev-alist
)
1671 (if (string-match (car dir-abbrev
) filename
)
1673 (concat (cdr dir-abbrev
)
1674 (substring filename
(match-end 0))))))
1675 ;; Compute and save the abbreviated homedir name.
1676 ;; We defer computing this until the first time it's needed, to
1677 ;; give time for directory-abbrev-alist to be set properly.
1678 ;; We include a slash at the end, to avoid spurious matches
1679 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1680 (or abbreviated-home-dir
1681 (setq abbreviated-home-dir
1682 (let ((abbreviated-home-dir "$foo"))
1683 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1686 ;; If FILENAME starts with the abbreviated homedir,
1687 ;; make it start with `~' instead.
1688 (if (and (string-match abbreviated-home-dir filename
)
1689 ;; If the home dir is just /, don't change it.
1690 (not (and (= (match-end 0) 1)
1691 (= (aref filename
0) ?
/)))
1692 ;; MS-DOS root directories can come with a drive letter;
1693 ;; Novell Netware allows drive letters beyond `Z:'.
1694 (not (and (memq system-type
'(ms-dos windows-nt cygwin
))
1696 (string-match "^[a-zA-`]:/$" filename
)))))
1699 (match-string 1 filename
)
1700 (substring filename
(match-end 0)))))
1703 (defcustom find-file-not-true-dirname-list nil
1704 "List of logical names for which visiting shouldn't save the true dirname."
1705 :type
'(repeat (string :tag
"Name"))
1708 (defun find-buffer-visiting (filename &optional predicate
)
1709 "Return the buffer visiting file FILENAME (a string).
1710 This is like `get-file-buffer', except that it checks for any buffer
1711 visiting the same file, possibly under a different name.
1712 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1713 and others are ignored.
1714 If there is no such live buffer, return nil."
1715 (let ((predicate (or predicate
#'identity
))
1716 (truename (abbreviate-file-name (file-truename filename
))))
1717 (or (let ((buf (get-file-buffer filename
)))
1718 (when (and buf
(funcall predicate buf
)) buf
))
1719 (let ((list (buffer-list)) found
)
1720 (while (and (not found
) list
)
1721 (with-current-buffer (car list
)
1722 (if (and buffer-file-name
1723 (string= buffer-file-truename truename
)
1724 (funcall predicate
(current-buffer)))
1725 (setq found
(car list
))))
1726 (setq list
(cdr list
)))
1728 (let* ((attributes (file-attributes truename
))
1729 (number (nthcdr 10 attributes
))
1730 (list (buffer-list)) found
)
1731 (and buffer-file-numbers-unique
1732 (car-safe number
) ;Make sure the inode is not just nil.
1733 (while (and (not found
) list
)
1734 (with-current-buffer (car list
)
1735 (if (and buffer-file-name
1736 (equal buffer-file-number number
)
1737 ;; Verify this buffer's file number
1738 ;; still belongs to its file.
1739 (file-exists-p buffer-file-name
)
1740 (equal (file-attributes buffer-file-truename
)
1742 (funcall predicate
(current-buffer)))
1743 (setq found
(car list
))))
1744 (setq list
(cdr list
))))
1747 (defcustom find-file-wildcards t
1748 "Non-nil means file-visiting commands should handle wildcards.
1749 For example, if you specify `*.c', that would visit all the files
1750 whose names match the pattern."
1755 (defcustom find-file-suppress-same-file-warnings nil
1756 "Non-nil means suppress warning messages for symlinked files.
1757 When nil, Emacs prints a warning when visiting a file that is already
1758 visited, but with a different name. Setting this option to t
1759 suppresses this warning."
1764 (defcustom large-file-warning-threshold
10000000
1765 "Maximum size of file above which a confirmation is requested.
1766 When nil, never request confirmation."
1770 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1772 (defun abort-if-file-too-large (size op-type filename
)
1773 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1774 OP-TYPE specifies the file operation being performed (for message to user)."
1775 (when (and large-file-warning-threshold size
1776 (> size large-file-warning-threshold
)
1777 (not (y-or-n-p (format "File %s is large (%dMB), really %s? "
1778 (file-name-nondirectory filename
)
1779 (/ size
1048576) op-type
))))
1782 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1783 "Read file FILENAME into a buffer and return the buffer.
1784 If a buffer exists visiting FILENAME, return that one, but
1785 verify that the file has not changed since visited or saved.
1786 The buffer is not selected, just returned to the caller.
1787 Optional second arg NOWARN non-nil means suppress any warning messages.
1788 Optional third arg RAWFILE non-nil means the file is read literally.
1789 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1790 and visit all the matching files. When wildcards are actually
1791 used and expanded, return a list of buffers that are visiting
1794 (abbreviate-file-name
1795 (expand-file-name filename
)))
1796 (if (file-directory-p filename
)
1797 (or (and find-file-run-dired
1798 (run-hook-with-args-until-success
1799 'find-directory-functions
1800 (if find-file-visit-truename
1801 (abbreviate-file-name (file-truename filename
))
1803 (error "%s is a directory" filename
))
1806 (not (string-match "\\`/:" filename
))
1807 (string-match "[[*?]" filename
))
1808 (let ((files (condition-case nil
1809 (file-expand-wildcards filename t
)
1810 (error (list filename
))))
1811 (find-file-wildcards nil
))
1813 (find-file-noselect filename
)
1814 (mapcar #'find-file-noselect files
)))
1815 (let* ((buf (get-file-buffer filename
))
1816 (truename (abbreviate-file-name (file-truename filename
)))
1817 (attributes (file-attributes truename
))
1818 (number (nthcdr 10 attributes
))
1819 ;; Find any buffer for a file which has same truename.
1820 (other (and (not buf
) (find-buffer-visiting filename
))))
1821 ;; Let user know if there is a buffer with the same truename.
1825 find-file-suppress-same-file-warnings
1826 (string-equal filename
(buffer-file-name other
))
1827 (message "%s and %s are the same file"
1828 filename
(buffer-file-name other
)))
1829 ;; Optionally also find that buffer.
1830 (if (or find-file-existing-other-name find-file-visit-truename
)
1832 ;; Check to see if the file looks uncommonly large.
1833 (when (not (or buf nowarn
))
1834 (abort-if-file-too-large (nth 7 attributes
) "open" filename
))
1836 ;; We are using an existing buffer.
1839 (verify-visited-file-modtime buf
)
1840 (cond ((not (file-exists-p filename
))
1841 (setq nonexistent t
)
1842 (message "File %s no longer exists!" filename
))
1843 ;; Certain files should be reverted automatically
1844 ;; if they have changed on disk and not in the buffer.
1845 ((and (not (buffer-modified-p buf
))
1846 (let ((tail revert-without-query
)
1849 (if (string-match (car tail
) filename
)
1851 (setq tail
(cdr tail
)))
1853 (with-current-buffer buf
1854 (message "Reverting file %s..." filename
)
1856 (message "Reverting file %s...done" filename
)))
1858 (if (string= (file-name-nondirectory filename
)
1861 (if (buffer-modified-p buf
)
1862 "File %s changed on disk. Discard your edits? "
1863 "File %s changed on disk. Reread from disk? ")
1864 (file-name-nondirectory filename
))
1866 (if (buffer-modified-p buf
)
1867 "File %s changed on disk. Discard your edits in %s? "
1868 "File %s changed on disk. Reread from disk into %s? ")
1869 (file-name-nondirectory filename
)
1870 (buffer-name buf
))))
1871 (with-current-buffer buf
1872 (revert-buffer t t
)))))
1873 (with-current-buffer buf
1875 ;; Check if a formerly read-only file has become
1876 ;; writable and vice versa, but if the buffer agrees
1877 ;; with the new state of the file, that is ok too.
1878 (let ((read-only (not (file-writable-p buffer-file-name
))))
1879 (unless (or nonexistent
1880 (eq read-only buffer-file-read-only
)
1881 (eq read-only buffer-read-only
))
1884 (format "File %s is %s on disk. Change buffer mode? "
1886 (if read-only
"read-only" "writable"))))
1887 (y-or-n-p question
)))
1888 (setq buffer-read-only read-only
)))
1889 (setq buffer-file-read-only read-only
))
1891 (when (and (not (eq (not (null rawfile
))
1892 (not (null find-file-literally
))))
1894 ;; It is confusing to ask whether to visit
1895 ;; non-literally if they have the file in
1897 (not (eq major-mode
'hexl-mode
)))
1898 (if (buffer-modified-p)
1902 "The file %s is already visited normally,
1903 and you have edited the buffer. Now you have asked to visit it literally,
1904 meaning no coding system handling, format conversion, or local variables.
1905 Emacs can only visit a file in one way at a time.
1907 Do you want to save the file, and visit it literally instead? "
1908 "The file %s is already visited literally,
1909 meaning no coding system handling, format conversion, or local variables.
1910 You have edited the buffer. Now you have asked to visit the file normally,
1911 but Emacs can only visit a file in one way at a time.
1913 Do you want to save the file, and visit it normally instead? ")
1914 (file-name-nondirectory filename
)))
1917 (find-file-noselect-1 buf filename nowarn
1918 rawfile truename number
))
1923 Do you want to discard your changes, and visit the file literally now? "
1925 Do you want to discard your changes, and visit the file normally now? ")))
1926 (find-file-noselect-1 buf filename nowarn
1927 rawfile truename number
)
1928 (error (if rawfile
"File already visited non-literally"
1929 "File already visited literally"))))
1933 "The file %s is already visited normally.
1934 You have asked to visit it literally,
1935 meaning no coding system decoding, format conversion, or local variables.
1936 But Emacs can only visit a file in one way at a time.
1938 Do you want to revisit the file literally now? "
1939 "The file %s is already visited literally,
1940 meaning no coding system decoding, format conversion, or local variables.
1941 You have asked to visit it normally,
1942 but Emacs can only visit a file in one way at a time.
1944 Do you want to revisit the file normally now? ")
1945 (file-name-nondirectory filename
)))
1946 (find-file-noselect-1 buf filename nowarn
1947 rawfile truename number
)
1948 (error (if rawfile
"File already visited non-literally"
1949 "File already visited literally"))))))
1950 ;; Return the buffer we are using.
1952 ;; Create a new buffer.
1953 (setq buf
(create-file-buffer filename
))
1954 ;; find-file-noselect-1 may use a different buffer.
1955 (find-file-noselect-1 buf filename nowarn
1956 rawfile truename number
))))))
1958 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1960 (with-current-buffer buf
1961 (kill-local-variable 'find-file-literally
)
1962 ;; Needed in case we are re-visiting the file with a different
1963 ;; text representation.
1964 (kill-local-variable 'buffer-file-coding-system
)
1965 (kill-local-variable 'cursor-type
)
1966 (let ((inhibit-read-only t
))
1968 (and (default-value 'enable-multibyte-characters
)
1970 (set-buffer-multibyte t
))
1973 (let ((inhibit-read-only t
))
1974 (insert-file-contents-literally filename t
))
1976 (when (and (file-exists-p filename
)
1977 (not (file-readable-p filename
)))
1979 (signal 'file-error
(list "File is not readable"
1981 ;; Unconditionally set error
1984 (let ((inhibit-read-only t
))
1985 (insert-file-contents filename t
))
1987 (when (and (file-exists-p filename
)
1988 (not (file-readable-p filename
)))
1990 (signal 'file-error
(list "File is not readable"
1992 ;; Run find-file-not-found-functions until one returns non-nil.
1993 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1994 ;; If they fail too, set error.
1996 ;; Record the file's truename, and maybe use that as visited name.
1997 (if (equal filename buffer-file-name
)
1998 (setq buffer-file-truename truename
)
1999 (setq buffer-file-truename
2000 (abbreviate-file-name (file-truename buffer-file-name
))))
2001 (setq buffer-file-number number
)
2002 (if find-file-visit-truename
2003 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
2004 ;; Set buffer's default directory to that of the file.
2005 (setq default-directory
(file-name-directory buffer-file-name
))
2006 ;; Turn off backup files for certain file names. Since
2007 ;; this is a permanent local, the major mode won't eliminate it.
2008 (and backup-enable-predicate
2009 (not (funcall backup-enable-predicate buffer-file-name
))
2011 (make-local-variable 'backup-inhibited
)
2012 (setq backup-inhibited t
)))
2015 (set-buffer-multibyte nil
)
2016 (setq buffer-file-coding-system
'no-conversion
)
2017 (set-buffer-major-mode buf
)
2018 (make-local-variable 'find-file-literally
)
2019 (setq find-file-literally t
))
2020 (after-find-file error
(not nowarn
)))
2023 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
2024 "Like `insert-file-contents', but only reads in the file literally.
2025 A buffer may be modified in several ways after reading into the buffer,
2026 to Emacs features such as format decoding, character code
2027 conversion, `find-file-hook', automatic uncompression, etc.
2029 This function ensures that none of these modifications will take place."
2030 (let ((format-alist nil
)
2031 (after-insert-file-functions nil
)
2032 (coding-system-for-read 'no-conversion
)
2033 (coding-system-for-write 'no-conversion
)
2034 (find-buffer-file-type-function
2035 (if (fboundp 'find-buffer-file-type
)
2036 (symbol-function 'find-buffer-file-type
)
2038 (inhibit-file-name-handlers
2039 (append '(jka-compr-handler image-file-handler epa-file-handler
)
2040 inhibit-file-name-handlers
))
2041 (inhibit-file-name-operation 'insert-file-contents
))
2044 (fset 'find-buffer-file-type
(lambda (filename) t
))
2045 (insert-file-contents filename visit beg end replace
))
2046 (if find-buffer-file-type-function
2047 (fset 'find-buffer-file-type find-buffer-file-type-function
)
2048 (fmakunbound 'find-buffer-file-type
)))))
2050 (defun insert-file-1 (filename insert-func
)
2051 (if (file-directory-p filename
)
2052 (signal 'file-error
(list "Opening input file" "file is a directory"
2054 ;; Check whether the file is uncommonly large
2055 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert" filename
)
2056 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
2057 #'buffer-modified-p
))
2058 (tem (funcall insert-func filename
)))
2059 (push-mark (+ (point) (car (cdr tem
))))
2061 (message "File %s already visited and modified in buffer %s"
2062 filename
(buffer-name buffer
)))))
2064 (defun insert-file-literally (filename)
2065 "Insert contents of file FILENAME into buffer after point with no conversion.
2067 This function is meant for the user to run interactively.
2068 Don't call it from programs! Use `insert-file-contents-literally' instead.
2069 \(Its calling sequence is different; see its documentation)."
2070 (interactive "*fInsert file literally: ")
2071 (insert-file-1 filename
#'insert-file-contents-literally
))
2073 (defvar find-file-literally nil
2074 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2075 This has the `permanent-local' property, which takes effect if you
2076 make the variable buffer-local.")
2077 (put 'find-file-literally
'permanent-local t
)
2079 (defun find-file-literally (filename)
2080 "Visit file FILENAME with no conversion of any kind.
2081 Format conversion and character code conversion are both disabled,
2082 and multibyte characters are disabled in the resulting buffer.
2083 The major mode used is Fundamental mode regardless of the file name,
2084 and local variable specifications in the file are ignored.
2085 Automatic uncompression and adding a newline at the end of the
2086 file due to `require-final-newline' is also disabled.
2088 You cannot absolutely rely on this function to result in
2089 visiting the file literally. If Emacs already has a buffer
2090 which is visiting the file, you get the existing buffer,
2091 regardless of whether it was created literally or not.
2093 In a Lisp program, if you want to be sure of accessing a file's
2094 contents literally, you should create a temporary buffer and then read
2095 the file contents into it using `insert-file-contents-literally'."
2097 (list (read-file-name
2098 "Find file literally: " nil default-directory
2099 (confirm-nonexistent-file-or-buffer))))
2100 (switch-to-buffer (find-file-noselect filename nil t
)))
2102 (defvar after-find-file-from-revert-buffer nil
)
2104 (defun after-find-file (&optional error warn noauto
2105 after-find-file-from-revert-buffer
2107 "Called after finding a file and by the default revert function.
2108 Sets buffer mode, parses local variables.
2109 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2110 error in reading the file. WARN non-nil means warn if there
2111 exists an auto-save file more recent than the visited file.
2112 NOAUTO means don't mess with auto-save mode.
2113 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
2114 means this call was from `revert-buffer'.
2115 Fifth arg NOMODES non-nil means don't alter the file's modes.
2116 Finishes by calling the functions in `find-file-hook'
2117 unless NOMODES is non-nil."
2118 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
2125 ((and error
(file-attributes buffer-file-name
))
2126 (setq buffer-read-only t
)
2127 "File exists, but cannot be read")
2128 ((not buffer-read-only
)
2130 ;; No need to warn if buffer is auto-saved
2131 ;; under the name of the visited file.
2132 (not (and buffer-file-name
2133 auto-save-visited-file-name
))
2134 (file-newer-than-file-p (or buffer-auto-save-file-name
2135 (make-auto-save-file-name))
2137 (format "%s has auto save data; consider M-x recover-this-file"
2138 (file-name-nondirectory buffer-file-name
))
2139 (setq not-serious t
)
2140 (if error
"(New file)" nil
)))
2142 (setq not-serious t
)
2143 "Note: file is write protected")
2144 ((file-attributes (directory-file-name default-directory
))
2145 "File not found and directory write-protected")
2146 ((file-exists-p (file-name-directory buffer-file-name
))
2147 (setq buffer-read-only nil
))
2149 (setq buffer-read-only nil
)
2150 "Use M-x make-directory RET RET to create the directory and its parents"))))
2153 (or not-serious
(sit-for 1 t
))))
2154 (when (and auto-save-default
(not noauto
))
2155 (auto-save-mode t
)))
2156 ;; Make people do a little extra work (C-x C-q)
2157 ;; before altering a backup file.
2158 (when (backup-file-name-p buffer-file-name
)
2159 (setq buffer-read-only t
))
2160 ;; When a file is marked read-only,
2161 ;; make the buffer read-only even if root is looking at it.
2162 (when (and (file-modes (buffer-file-name))
2163 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
2164 (setq buffer-read-only t
))
2166 (when (and view-read-only view-mode
)
2167 (view-mode-disable))
2169 ;; If requested, add a newline at the end of the file.
2170 (and (memq require-final-newline
'(visit visit-save
))
2171 (> (point-max) (point-min))
2172 (/= (char-after (1- (point-max))) ?
\n)
2173 (not (and (eq selective-display t
)
2174 (= (char-after (1- (point-max))) ?
\r)))
2176 (goto-char (point-max))
2178 (when (and buffer-read-only
2180 (not (eq (get major-mode
'mode-class
) 'special
)))
2182 (run-hooks 'find-file-hook
)))
2184 (defmacro report-errors
(format &rest body
)
2185 "Eval BODY and turn any error into a FORMAT message.
2186 FORMAT can have a %s escape which will be replaced with the actual error.
2187 If `debug-on-error' is set, errors are not caught, so that you can
2189 Avoid using a large BODY since it is duplicated."
2190 (declare (debug t
) (indent 1))
2195 (error (message ,format
(prin1-to-string err
))))))
2197 (defun normal-mode (&optional find-file
)
2198 "Choose the major mode for this buffer automatically.
2199 Also sets up any specified local variables of the file.
2200 Uses the visited file name, the -*- line, and the local variables spec.
2202 This function is called automatically from `find-file'. In that case,
2203 we may set up the file-specified mode and local variables,
2204 depending on the value of `enable-local-variables'.
2205 In addition, if `local-enable-local-variables' is nil, we do
2206 not set local variables (though we do notice a mode specified with -*-.)
2208 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2209 or from Lisp without specifying the optional argument FIND-FILE;
2210 in that case, this function acts as if `enable-local-variables' were t."
2212 (funcall (or (default-value 'major-mode
) 'fundamental-mode
))
2213 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
2214 (report-errors "File mode specification error: %s"
2216 (report-errors "File local-variables error: %s"
2217 (hack-local-variables)))
2218 ;; Turn font lock off and on, to make sure it takes account of
2219 ;; whatever file local variables are relevant to it.
2220 (when (and font-lock-mode
2221 ;; Font-lock-mode (now in font-core.el) can be ON when
2222 ;; font-lock.el still hasn't been loaded.
2223 (boundp 'font-lock-keywords
)
2224 (eq (car font-lock-keywords
) t
))
2225 (setq font-lock-keywords
(cadr font-lock-keywords
))
2228 (if (fboundp 'ucs-set-table-for-input
) ; don't lose when building
2229 (ucs-set-table-for-input)))
2231 (defcustom auto-mode-case-fold t
2232 "Non-nil means to try second pass through `auto-mode-alist'.
2233 This means that if the first case-sensitive search through the alist fails
2234 to find a matching major mode, a second case-insensitive search is made.
2235 On systems with case-insensitive file names, this variable is ignored,
2236 since only a single case-insensitive search through the alist is made."
2241 (defvar auto-mode-alist
2242 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2243 ;; c++-mode, java-mode and more) are added through autoload
2244 ;; directives in that file. That way is discouraged since it
2245 ;; spreads out the definition of the initial value.
2248 (cons (purecopy (car elt
)) (cdr elt
)))
2249 `(;; do this first, so that .html.pl is Polish html, not Perl
2250 ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2251 ("\\.svgz?\\'" . image-mode
)
2252 ("\\.svgz?\\'" . xml-mode
)
2253 ("\\.x[bp]m\\'" . image-mode
)
2254 ("\\.x[bp]m\\'" . c-mode
)
2255 ("\\.p[bpgn]m\\'" . image-mode
)
2256 ("\\.tiff?\\'" . image-mode
)
2257 ("\\.gif\\'" . image-mode
)
2258 ("\\.png\\'" . image-mode
)
2259 ("\\.jpe?g\\'" . image-mode
)
2260 ("\\.te?xt\\'" . text-mode
)
2261 ("\\.[tT]e[xX]\\'" . tex-mode
)
2262 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2263 ("\\.ltx\\'" . latex-mode
)
2264 ("\\.dtx\\'" . doctex-mode
)
2265 ("\\.org\\'" . org-mode
)
2266 ("\\.el\\'" . emacs-lisp-mode
)
2267 ("Project\\.ede\\'" . emacs-lisp-mode
)
2268 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2269 ("\\.l\\'" . lisp-mode
)
2270 ("\\.li?sp\\'" . lisp-mode
)
2271 ("\\.[fF]\\'" . fortran-mode
)
2272 ("\\.for\\'" . fortran-mode
)
2273 ("\\.p\\'" . pascal-mode
)
2274 ("\\.pas\\'" . pascal-mode
)
2275 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode
)
2276 ("\\.ad[abs]\\'" . ada-mode
)
2277 ("\\.ad[bs].dg\\'" . ada-mode
)
2278 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2279 ("Imakefile\\'" . makefile-imake-mode
)
2280 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2281 ("\\.makepp\\'" . makefile-makepp-mode
)
2282 ,@(if (memq system-type
'(berkeley-unix darwin
))
2283 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2284 ("GNUmakefile\\'" . makefile-gmake-mode
)
2285 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2286 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2287 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2288 ("\\.am\\'" . makefile-automake-mode
)
2289 ;; Less common extensions come here
2290 ;; so more common ones above are found faster.
2291 ("\\.texinfo\\'" . texinfo-mode
)
2292 ("\\.te?xi\\'" . texinfo-mode
)
2293 ("\\.[sS]\\'" . asm-mode
)
2294 ("\\.asm\\'" . asm-mode
)
2295 ("\\.css\\'" . css-mode
)
2296 ("\\.mixal\\'" . mixal-mode
)
2297 ("\\.gcov\\'" . compilation-mode
)
2298 ;; Besides .gdbinit, gdb documents other names to be usable for init
2299 ;; files, cross-debuggers can use something like
2300 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2301 ;; don't interfere with each other.
2302 ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode
)
2303 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2304 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2305 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2306 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2307 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2308 ("\\.bash\\'" . sh-mode
)
2309 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2310 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2311 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2312 ("\\.m?spec\\'" . sh-mode
)
2313 ("\\.m[mes]\\'" . nroff-mode
)
2314 ("\\.man\\'" . nroff-mode
)
2315 ("\\.sty\\'" . latex-mode
)
2316 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2317 ("\\.bbl\\'" . latex-mode
)
2318 ("\\.bib\\'" . bibtex-mode
)
2319 ("\\.bst\\'" . bibtex-style-mode
)
2320 ("\\.sql\\'" . sql-mode
)
2321 ("\\.m[4c]\\'" . m4-mode
)
2322 ("\\.mf\\'" . metafont-mode
)
2323 ("\\.mp\\'" . metapost-mode
)
2324 ("\\.vhdl?\\'" . vhdl-mode
)
2325 ("\\.article\\'" . text-mode
)
2326 ("\\.letter\\'" . text-mode
)
2327 ("\\.i?tcl\\'" . tcl-mode
)
2328 ("\\.exp\\'" . tcl-mode
)
2329 ("\\.itk\\'" . tcl-mode
)
2330 ("\\.icn\\'" . icon-mode
)
2331 ("\\.sim\\'" . simula-mode
)
2332 ("\\.mss\\'" . scribe-mode
)
2333 ("\\.f9[05]\\'" . f90-mode
)
2334 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2335 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode
)
2336 ("\\.srt\\'" . srecode-template-mode
)
2337 ("\\.prolog\\'" . prolog-mode
)
2338 ("\\.tar\\'" . tar-mode
)
2339 ;; The list of archive file extensions should be in sync with
2340 ;; `auto-coding-alist' with `no-conversion' coding system.
2342 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2343 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode
)
2344 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode
) ;OpenOffice.org
2345 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode
) ; Debian/Opkg packages.
2346 ;; Mailer puts message to be edited in
2347 ;; /tmp/Re.... or Message
2348 ("\\`/tmp/Re" . text-mode
)
2349 ("/Message[0-9]*\\'" . text-mode
)
2350 ;; some news reader is reported to use this
2351 ("\\`/tmp/fol/" . text-mode
)
2352 ("\\.oak\\'" . scheme-mode
)
2353 ("\\.sgml?\\'" . sgml-mode
)
2354 ("\\.x[ms]l\\'" . xml-mode
)
2355 ("\\.dbk\\'" . xml-mode
)
2356 ("\\.dtd\\'" . sgml-mode
)
2357 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2358 ("\\.js\\'" . js-mode
) ; javascript-mode would be better
2359 ("\\.[ds]?vh?\\'" . verilog-mode
)
2360 ;; .emacs or .gnus or .viper following a directory delimiter in
2361 ;; Unix, MSDOG or VMS syntax.
2362 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2363 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2364 ;; _emacs following a directory delimiter
2366 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2367 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2368 ("\\.ml\\'" . lisp-mode
)
2369 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2370 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2371 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2372 ("\\.ld[si]?\\'" . ld-script-mode
)
2373 ("ld\\.?script\\'" . ld-script-mode
)
2374 ;; .xs is also used for ld scripts, but seems to be more commonly
2375 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2376 ("\\.xs\\'" . c-mode
)
2377 ;; Explained in binutils ld/genscripts.sh. Eg:
2378 ;; A .x script file is the default script.
2379 ;; A .xr script is for linking without relocation (-r flag). Etc.
2380 ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode
)
2381 ("\\.zone\\'" . dns-mode
)
2382 ("\\.soa\\'" . dns-mode
)
2383 ;; Common Lisp ASDF package system.
2384 ("\\.asd\\'" . lisp-mode
)
2385 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2386 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2387 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2388 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2389 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2390 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe
)
2391 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2392 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode
)
2393 ("BROWSE\\'" . ebrowse-tree-mode
)
2394 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2395 ("#\\*mail\\*" . mail-mode
)
2396 ("\\.g\\'" . antlr-mode
)
2397 ("\\.ses\\'" . ses-mode
)
2398 ("\\.docbook\\'" . sgml-mode
)
2399 ("\\.com\\'" . dcl-mode
)
2400 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2401 ;; Windows candidates may be opened case sensitively on Unix
2402 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2403 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2404 ("\\.ppd\\'" . conf-ppd-mode
)
2405 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2406 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2407 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2408 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2409 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2410 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2411 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2412 ;; this has lower priority to avoid matching changelog.sgml etc.
2413 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2414 ;; either user's dot-files or under /etc or some such
2415 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2416 ;; alas not all ~/.*rc files are like this
2417 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2418 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2419 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2420 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2421 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2422 ;; this contains everything twice, with space and with colon :-(
2423 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2424 ;; Get rid of any trailing .n.m and try again.
2425 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2426 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2427 ;; Using mode nil rather than `ignore' would let the search continue
2428 ;; through this list (with the shortened name) rather than start over.
2429 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2430 ;; The following should come after the ChangeLog pattern
2431 ;; for the sake of ChangeLog.1, etc.
2432 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2433 ("\\.[1-9]\\'" . nroff-mode
)
2434 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)))
2435 "Alist of filename patterns vs corresponding major mode functions.
2436 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2437 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2438 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2439 mode function to use. FUNCTION will be called, unless it is nil.
2441 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2442 calling FUNCTION (if it's not nil), we delete the suffix that matched
2443 REGEXP and search the list again for another match.
2445 If the file name matches `inhibit-first-line-modes-regexps',
2446 then `auto-mode-alist' is not processed.
2448 The extensions whose FUNCTION is `archive-mode' should also
2449 appear in `auto-coding-alist' with `no-conversion' coding system.
2451 See also `interpreter-mode-alist', which detects executable script modes
2452 based on the interpreters they specify to run,
2453 and `magic-mode-alist', which determines modes based on file contents.")
2454 (put 'auto-mode-alist
'risky-local-variable t
)
2456 (defun conf-mode-maybe ()
2457 "Select Conf mode or XML mode according to start of file."
2461 (goto-char (point-min))
2462 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2466 (defvar interpreter-mode-alist
2467 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2468 ;; and pike-mode) are added through autoload directives in that
2469 ;; file. That way is discouraged since it spreads out the
2470 ;; definition of the initial value.
2473 (cons (purecopy (car l
)) (cdr l
)))
2474 '(("perl" . perl-mode
)
2475 ("perl5" . perl-mode
)
2476 ("miniperl" . perl-mode
)
2478 ("wishx" . tcl-mode
)
2480 ("tclsh" . tcl-mode
)
2481 ("scm" . scheme-mode
)
2501 ("tail" . text-mode
)
2502 ("more" . text-mode
)
2503 ("less" . text-mode
)
2505 ("make" . makefile-gmake-mode
) ; Debian uses this
2506 ("guile" . scheme-mode
)
2507 ("clisp" . lisp-mode
)
2508 ("emacs" . emacs-lisp-mode
)))
2509 "Alist mapping interpreter names to major modes.
2510 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2511 Each element looks like (INTERPRETER . MODE).
2512 If INTERPRETER matches the name of the interpreter specified in the first line
2513 of a script, mode MODE is enabled.
2515 See also `auto-mode-alist'.")
2517 (defvar inhibit-first-line-modes-regexps
(mapcar 'purecopy
'("\\.tar\\'" "\\.tgz\\'"))
2518 "List of regexps; if one matches a file name, don't look for `-*-'.")
2520 (defvar inhibit-first-line-modes-suffixes nil
2521 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2522 When checking `inhibit-first-line-modes-regexps', we first discard
2523 from the end of the file name anything that matches one of these regexps.")
2525 (defvar auto-mode-interpreter-regexp
2526 (purecopy "#![ \t]?\\([^ \t\n]*\
2527 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2528 "Regexp matching interpreters, for file mode determination.
2529 This regular expression is matched against the first line of a file
2530 to determine the file's mode in `set-auto-mode'. If it matches, the file
2531 is assumed to be interpreted by the interpreter matched by the second group
2532 of the regular expression. The mode is then determined as the mode
2533 associated with that interpreter in `interpreter-mode-alist'.")
2535 (defvar magic-mode-alist nil
2536 "Alist of buffer beginnings vs. corresponding major mode functions.
2537 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2538 After visiting a file, if REGEXP matches the text at the beginning of the
2539 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2540 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2543 If FUNCTION is nil, then it is not called. (That is a way of saying
2544 \"allow `auto-mode-alist' to decide for these files.\")")
2545 (put 'magic-mode-alist
'risky-local-variable t
)
2547 (defvar magic-fallback-mode-alist
2549 `((image-type-auto-detected-p . image-mode
)
2550 ("\\(PK00\\)?[P]K\003\004" . archive-mode
) ; zip
2551 ;; The < comes before the groups (but the first) to reduce backtracking.
2552 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2553 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2554 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2555 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2556 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2558 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2559 "[Hh][Tt][Mm][Ll]"))
2561 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2562 ;; These two must come after html, because they are more general:
2563 ("<\\?xml " . xml-mode
)
2564 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2565 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2566 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2569 ("# xmcd " . conf-unix-mode
)))
2570 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2571 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2572 After visiting a file, if REGEXP matches the text at the beginning of the
2573 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2574 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2575 have not specified a mode for this file.
2577 If FUNCTION is nil, then it is not called.")
2578 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2580 (defvar magic-mode-regexp-match-limit
4000
2581 "Upper limit on `magic-mode-alist' regexp matches.
2582 Also applies to `magic-fallback-mode-alist'.")
2584 (defun set-auto-mode (&optional keep-mode-if-same
)
2585 "Select major mode appropriate for current buffer.
2587 To find the right major mode, this function checks for a -*- mode tag,
2588 checks if it uses an interpreter listed in `interpreter-mode-alist',
2589 matches the buffer beginning against `magic-mode-alist',
2590 compares the filename against the entries in `auto-mode-alist',
2591 then matches the buffer beginning against `magic-fallback-mode-alist'.
2593 It does not check for the `mode:' local variable in the
2594 Local Variables section of the file; for that, use `hack-local-variables'.
2596 If `enable-local-variables' is nil, this function does not check for a
2599 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2600 set the major mode only if that would change it. In other words
2601 we don't actually set it to the same mode the buffer already has."
2602 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2603 (let (end done mode modes
)
2604 ;; Find a -*- mode tag
2606 (goto-char (point-min))
2607 (skip-chars-forward " \t\n")
2608 (and enable-local-variables
2609 (setq end
(set-auto-mode-1))
2610 (if (save-excursion (search-forward ":" end t
))
2611 ;; Find all specifications for the `mode:' variable
2612 ;; and execute them left to right.
2613 (while (let ((case-fold-search t
))
2614 (or (and (looking-at "mode:")
2615 (goto-char (match-end 0)))
2616 (re-search-forward "[ \t;]mode:" end t
)))
2617 (skip-chars-forward " \t")
2618 (let ((beg (point)))
2619 (if (search-forward ";" end t
)
2622 (skip-chars-backward " \t")
2623 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2625 ;; Simple -*-MODE-*- case.
2626 (push (intern (concat (downcase (buffer-substring (point) end
))
2629 ;; If we found modes to use, invoke them now, outside the save-excursion.
2632 (dolist (mode (nreverse modes
))
2633 (if (not (functionp mode
))
2634 (message "Ignoring unknown mode `%s'" mode
)
2636 (or (set-auto-mode-0 mode keep-mode-if-same
)
2637 ;; continuing would call minor modes again, toggling them off
2638 (throw 'nop nil
))))))
2639 ;; If we didn't, look for an interpreter specified in the first line.
2640 ;; As a special case, allow for things like "#!/bin/env perl", which
2641 ;; finds the interpreter anywhere in $PATH.
2643 (setq mode
(save-excursion
2644 (goto-char (point-min))
2645 (if (looking-at auto-mode-interpreter-regexp
)
2648 ;; Map interpreter name to a mode, signalling we're done at the
2650 done
(assoc (file-name-nondirectory mode
)
2651 interpreter-mode-alist
))
2652 ;; If we found an interpreter mode to use, invoke it now.
2654 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2655 ;; Next try matching the buffer beginning against magic-mode-alist.
2657 (if (setq done
(save-excursion
2658 (goto-char (point-min))
2660 (narrow-to-region (point-min)
2662 (+ (point-min) magic-mode-regexp-match-limit
)))
2663 (assoc-default nil magic-mode-alist
2667 (looking-at re
)))))))
2668 (set-auto-mode-0 done keep-mode-if-same
)))
2669 ;; Next compare the filename against the entries in auto-mode-alist.
2671 (if buffer-file-name
2672 (let ((name buffer-file-name
)
2673 (remote-id (file-remote-p buffer-file-name
)))
2674 ;; Remove remote file name identification.
2675 (when (and (stringp remote-id
)
2676 (string-match (regexp-quote remote-id
) name
))
2677 (setq name
(substring name
(match-end 0))))
2678 ;; Remove backup-suffixes from file name.
2679 (setq name
(file-name-sans-versions name
))
2681 ;; Find first matching alist entry.
2683 (if (memq system-type
'(windows-nt cygwin
))
2684 ;; System is case-insensitive.
2685 (let ((case-fold-search t
))
2686 (assoc-default name auto-mode-alist
2688 ;; System is case-sensitive.
2690 ;; First match case-sensitively.
2691 (let ((case-fold-search nil
))
2692 (assoc-default name auto-mode-alist
2694 ;; Fallback to case-insensitive match.
2695 (and auto-mode-case-fold
2696 (let ((case-fold-search t
))
2697 (assoc-default name auto-mode-alist
2702 (setq mode
(car mode
)
2703 name
(substring name
0 (match-beginning 0)))
2706 (set-auto-mode-0 mode keep-mode-if-same
)
2708 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2710 (if (setq done
(save-excursion
2711 (goto-char (point-min))
2713 (narrow-to-region (point-min)
2715 (+ (point-min) magic-mode-regexp-match-limit
)))
2716 (assoc-default nil magic-fallback-mode-alist
2720 (looking-at re
)))))))
2721 (set-auto-mode-0 done keep-mode-if-same
)))))
2723 ;; When `keep-mode-if-same' is set, we are working on behalf of
2724 ;; set-visited-file-name. In that case, if the major mode specified is the
2725 ;; same one we already have, don't actually reset it. We don't want to lose
2726 ;; minor modes such as Font Lock.
2727 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2728 "Apply MODE and return it.
2729 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2730 any aliases and compared to current major mode. If they are the
2731 same, do nothing and return nil."
2732 (unless (and keep-mode-if-same
2733 (eq (indirect-function mode
)
2734 (indirect-function major-mode
)))
2739 (defun set-auto-mode-1 ()
2740 "Find the -*- spec in the buffer.
2741 Call with point at the place to start searching from.
2742 If one is found, set point to the beginning
2743 and return the position of the end.
2744 Otherwise, return nil; point may be changed."
2747 ;; Don't look for -*- if this file name matches any
2748 ;; of the regexps in inhibit-first-line-modes-regexps.
2749 (let ((temp inhibit-first-line-modes-regexps
)
2750 (name (if buffer-file-name
2751 (file-name-sans-versions buffer-file-name
)
2753 (while (let ((sufs inhibit-first-line-modes-suffixes
))
2754 (while (and sufs
(not (string-match (car sufs
) name
)))
2755 (setq sufs
(cdr sufs
)))
2757 (setq name
(substring name
0 (match-beginning 0))))
2759 (not (string-match (car temp
) name
)))
2760 (setq temp
(cdr temp
)))
2763 (search-forward "-*-" (line-end-position
2764 ;; If the file begins with "#!"
2765 ;; (exec interpreter magic), look
2766 ;; for mode frobs in the first two
2767 ;; lines. You cannot necessarily
2768 ;; put them in the first line of
2769 ;; such a file without screwing up
2770 ;; the interpreter invocation.
2771 ;; The same holds for
2773 ;; in man pages (preprocessor
2774 ;; magic for the `man' program).
2775 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t
)
2777 (skip-chars-forward " \t")
2779 (search-forward "-*-" (line-end-position) t
))
2782 (skip-chars-backward " \t")
2787 ;;; Handling file local variables
2789 (defvar ignored-local-variables
2790 '(ignored-local-variables safe-local-variable-values
2791 file-local-variables-alist dir-local-variables-alist
)
2792 "Variables to be ignored in a file's local variable spec.")
2793 (put 'ignored-local-variables
'risky-local-variable t
)
2795 (defvar hack-local-variables-hook nil
2796 "Normal hook run after processing a file's local variables specs.
2797 Major modes can use this to examine user-specified local variables
2798 in order to initialize other data structure based on them.")
2800 (defcustom safe-local-variable-values nil
2801 "List variable-value pairs that are considered safe.
2802 Each element is a cons cell (VAR . VAL), where VAR is a variable
2803 symbol and VAL is a value that is considered safe."
2808 (defcustom safe-local-eval-forms
2809 '((add-hook 'write-file-functions
'time-stamp
)
2810 (add-hook 'before-save-hook
'time-stamp
))
2811 "Expressions that are considered safe in an `eval:' local variable.
2812 Add expressions to this list if you want Emacs to evaluate them, when
2813 they appear in an `eval' local variable specification, without first
2814 asking you for confirmation."
2818 :type
'(repeat sexp
))
2820 ;; Risky local variables:
2821 (mapc (lambda (var) (put var
'risky-local-variable t
))
2823 buffer-auto-save-file-name
2825 buffer-file-truename
2828 default-text-properties
2832 file-name-handler-alist
2841 minor-mode-map-alist
2842 minor-mode-overriding-map-alist
2845 overriding-local-map
2846 overriding-terminal-local-map
2850 unread-command-events
))
2852 ;; Safe local variables:
2854 ;; For variables defined by major modes, the safety declarations can go into
2855 ;; the major mode's file, since that will be loaded before file variables are
2858 ;; For variables defined by minor modes, put the safety declarations in the
2859 ;; file defining the minor mode after the defcustom/defvar using an autoload
2862 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2864 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2865 ;; minor mode file may not be loaded yet.
2867 ;; For variables defined in the C source code the declaration should go here:
2869 (mapc (lambda (pair)
2870 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2871 '((buffer-read-only . booleanp
) ;; C source code
2872 (default-directory . stringp
) ;; C source code
2873 (fill-column . integerp
) ;; C source code
2874 (indent-tabs-mode . booleanp
) ;; C source code
2875 (left-margin . integerp
) ;; C source code
2876 (no-update-autoloads . booleanp
)
2877 (tab-width . integerp
) ;; C source code
2878 (truncate-lines . booleanp
) ;; C source code
2879 (word-wrap . booleanp
) ;; C source code
2880 (bidi-display-reordering . booleanp
))) ;; C source code
2882 (put 'bidi-paragraph-direction
'safe-local-variable
2883 (lambda (v) (memq v
'(nil right-to-left left-to-right
))))
2885 (put 'c-set-style
'safe-local-eval-function t
)
2887 (defvar file-local-variables-alist nil
2888 "Alist of file-local variable settings in the current buffer.
2889 Each element in this list has the form (VAR . VALUE), where VAR
2890 is a file-local variable (a symbol) and VALUE is the value
2891 specified. The actual value in the buffer may differ from VALUE,
2892 if it is changed by the major or minor modes, or by the user.")
2893 (make-variable-buffer-local 'file-local-variables-alist
)
2894 (put 'file-local-variables-alist
'permanent-local t
)
2896 (defvar dir-local-variables-alist nil
2897 "Alist of directory-local variable settings in the current buffer.
2898 Each element in this list has the form (VAR . VALUE), where VAR
2899 is a directory-local variable (a symbol) and VALUE is the value
2900 specified in .dir-locals.el. The actual value in the buffer
2901 may differ from VALUE, if it is changed by the major or minor modes,
2903 (make-variable-buffer-local 'dir-local-variables-alist
)
2905 (defvar before-hack-local-variables-hook nil
2906 "Normal hook run before setting file-local variables.
2907 It is called after checking for unsafe/risky variables and
2908 setting `file-local-variables-alist', and before applying the
2909 variables stored in `file-local-variables-alist'. A hook
2910 function is allowed to change the contents of this alist.
2912 This hook is called only if there is at least one file-local
2915 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name
)
2916 "Get confirmation before setting up local variable values.
2917 ALL-VARS is the list of all variables to be set up.
2918 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2919 RISKY-VARS is the list of those that are marked as risky.
2920 DIR-NAME is a directory name if these settings come from
2921 directory-local variables, or nil otherwise."
2924 (save-window-excursion
2925 (let* ((name (or dir-name
2926 (if buffer-file-name
2927 (file-name-nondirectory buffer-file-name
)
2928 (concat "buffer " (buffer-name)))))
2929 (offer-save (and (eq enable-local-variables t
)
2932 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2933 (buf (pop-to-buffer "*Local Variables*"))
2935 (set (make-local-variable 'cursor-type
) nil
)
2939 (insert "The local variables list in " name
2940 "\ncontains values that may not be safe (*)"
2942 ", and variables that are risky (**)."
2945 (insert "The local variables list in " name
2946 "\ncontains variables that are risky (**)."))
2948 (insert "A local variables list is specified in " name
".")))
2949 (insert "\n\nDo you want to apply it? You can type
2950 y -- to apply the local variables list.
2951 n -- to ignore the local variables list.")
2954 ! -- to apply the local variables list, and permanently mark these
2955 values (*) as safe (in the future, they will be set automatically.)\n\n")
2957 (dolist (elt all-vars
)
2958 (cond ((member elt unsafe-vars
)
2960 ((member elt risky-vars
)
2964 (princ (car elt
) buf
)
2966 ;; Make strings with embedded whitespace easier to read.
2967 (let ((print-escape-newlines t
))
2968 (prin1 (cdr elt
) buf
))
2971 (format "Please type %s%s: "
2972 (if offer-save
"y, n, or !" "y or n")
2973 (if (< (line-number-at-pos) (window-body-height))
2975 (push ?\C-v exit-chars
)
2976 ", or C-v to scroll")))
2977 (goto-char (point-min))
2979 (setq char
(read-char-choice prompt exit-chars t
))
2980 (when (eq char ?\C-v
)
2983 (error (goto-char (point-min))))
2986 (when (and offer-save
(= char ?
!) unsafe-vars
)
2987 (dolist (elt unsafe-vars
)
2988 (add-to-list 'safe-local-variable-values elt
))
2989 ;; When this is called from desktop-restore-file-buffer,
2990 ;; coding-system-for-read may be non-nil. Reset it before
2991 ;; writing to .emacs.
2992 (if (or custom-file user-init-file
)
2993 (let ((coding-system-for-read nil
))
2994 (customize-save-variable
2995 'safe-local-variable-values
2996 safe-local-variable-values
))))
2997 (memq char
'(?
! ?\s ?y
))))))
2999 (defun hack-local-variables-prop-line (&optional mode-only
)
3000 "Return local variables specified in the -*- line.
3001 Ignore any specification for `mode:' and `coding:';
3002 `set-auto-mode' should already have handled `mode:',
3003 `set-auto-coding' should already have handled `coding:'.
3005 If MODE-ONLY is non-nil, all we do is check whether the major
3006 mode is specified, returning t if it is specified. Otherwise,
3007 return an alist of elements (VAR . VAL), where VAR is a variable
3008 and VAL is the specified value."
3010 (goto-char (point-min))
3011 (let ((end (set-auto-mode-1))
3012 result mode-specified
)
3013 ;; Parse the -*- line into the RESULT alist.
3014 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
3017 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
3018 ;; Simple form: "-*- MODENAME -*-". Already handled.
3019 (setq mode-specified t
)
3022 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
3023 ;; (last ";" is optional).
3024 (while (< (point) end
)
3025 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
3026 (error "Malformed -*- line"))
3027 (goto-char (match-end 0))
3028 ;; There used to be a downcase here,
3029 ;; but the manual didn't say so,
3030 ;; and people want to set var names that aren't all lc.
3031 (let ((key (intern (match-string 1)))
3032 (val (save-restriction
3033 (narrow-to-region (point) end
)
3034 (let ((read-circle nil
))
3035 (read (current-buffer))))))
3036 ;; It is traditional to ignore
3037 ;; case when checking for `mode' in set-auto-mode,
3038 ;; so we must do that here as well.
3039 ;; That is inconsistent, but we're stuck with it.
3040 ;; The same can be said for `coding' in set-auto-coding.
3041 (or (and (equal (downcase (symbol-name key
)) "mode")
3042 (setq mode-specified t
))
3043 (equal (downcase (symbol-name key
)) "coding")
3045 (push (cons (if (eq key
'eval
)
3047 (indirect-variable key
))
3050 (skip-chars-forward " \t;")))))
3056 (defun hack-local-variables-filter (variables dir-name
)
3057 "Filter local variable settings, querying the user if necessary.
3058 VARIABLES is the alist of variable-value settings. This alist is
3059 filtered based on the values of `ignored-local-variables',
3060 `enable-local-eval', `enable-local-variables', and (if necessary)
3061 user interaction. The results are added to
3062 `file-local-variables-alist', without applying them.
3063 DIR-NAME is a directory name if these settings come from
3064 directory-local variables, or nil otherwise."
3065 ;; Find those variables that we may want to save to
3066 ;; `safe-local-variable-values'.
3067 (let (all-vars risky-vars unsafe-vars
)
3068 (dolist (elt variables
)
3069 (let ((var (car elt
))
3071 (cond ((memq var ignored-local-variables
)
3072 ;; Ignore any variable in `ignored-local-variables'.
3074 ;; Obey `enable-local-eval'.
3076 (when enable-local-eval
3078 (or (eq enable-local-eval t
)
3079 (hack-one-local-variable-eval-safep (eval (quote val
)))
3080 (safe-local-variable-p var val
)
3081 (push elt unsafe-vars
))))
3082 ;; Ignore duplicates (except `mode') in the present list.
3083 ((and (assq var all-vars
) (not (eq var
'mode
))) nil
)
3084 ;; Accept known-safe variables.
3085 ((or (memq var
'(mode unibyte coding
))
3086 (safe-local-variable-p var val
))
3087 (push elt all-vars
))
3088 ;; The variable is either risky or unsafe:
3089 ((not (eq enable-local-variables
:safe
))
3091 (if (risky-local-variable-p var val
)
3092 (push elt risky-vars
)
3093 (push elt unsafe-vars
))))))
3095 ;; Query, unless all vars are safe or user wants no querying.
3096 (or (and (eq enable-local-variables t
)
3099 (memq enable-local-variables
'(:all
:safe
))
3100 (hack-local-variables-confirm all-vars unsafe-vars
3101 risky-vars dir-name
))
3102 (dolist (elt all-vars
)
3103 (unless (memq (car elt
) '(eval mode
))
3105 (setq dir-local-variables-alist
3106 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3107 (setq file-local-variables-alist
3108 (assq-delete-all (car elt
) file-local-variables-alist
)))
3109 (push elt file-local-variables-alist
)))))
3111 (defun hack-local-variables (&optional mode-only
)
3112 "Parse and put into effect this buffer's local variables spec.
3113 If MODE-ONLY is non-nil, all we do is check whether the major mode
3114 is specified, returning t if it is specified."
3115 (let ((enable-local-variables
3116 (and local-enable-local-variables enable-local-variables
))
3119 (setq file-local-variables-alist nil
)
3120 (report-errors "Directory-local variables error: %s"
3121 (hack-dir-local-variables)))
3122 (when (or mode-only enable-local-variables
)
3123 (setq result
(hack-local-variables-prop-line mode-only
))
3124 ;; Look for "Local variables:" line in last page.
3126 (goto-char (point-max))
3127 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3129 (when (let ((case-fold-search t
))
3130 (search-forward "Local Variables:" nil t
))
3131 (skip-chars-forward " \t")
3132 ;; suffix is what comes after "local variables:" in its line.
3133 ;; prefix is what comes before "local variables:" in its line.
3136 (regexp-quote (buffer-substring (point)
3137 (line-end-position)))
3140 (concat "^" (regexp-quote
3141 (buffer-substring (line-beginning-position)
3142 (match-beginning 0)))))
3146 (let ((startpos (point))
3148 (thisbuf (current-buffer)))
3150 (unless (let ((case-fold-search t
))
3152 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
3154 ;; This used to be an error, but really all it means is
3155 ;; that this may simply not be a local-variables section,
3156 ;; so just ignore it.
3157 (message "Local variables list is not properly terminated"))
3159 (setq endpos
(point)))
3162 (insert-buffer-substring thisbuf startpos endpos
)
3163 (goto-char (point-min))
3164 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
3166 ;; Discard the prefix.
3167 (if (looking-at prefix
)
3168 (delete-region (point) (match-end 0))
3169 (error "Local variables entry is missing the prefix"))
3171 ;; Discard the suffix.
3172 (if (looking-back suffix
)
3173 (delete-region (match-beginning 0) (point))
3174 (error "Local variables entry is missing the suffix"))
3176 (goto-char (point-min))
3179 ;; Find the variable name; strip whitespace.
3180 (skip-chars-forward " \t")
3182 (skip-chars-forward "^:\n")
3183 (if (eolp) (error "Missing colon in local variables entry"))
3184 (skip-chars-backward " \t")
3185 (let* ((str (buffer-substring beg
(point)))
3186 (var (let ((read-circle nil
))
3189 ;; Read the variable value.
3190 (skip-chars-forward "^:")
3192 (let ((read-circle nil
))
3193 (setq val
(read (current-buffer))))
3197 (unless (eq var
'coding
)
3199 (push (cons (if (eq var
'eval
)
3201 (indirect-variable var
))
3204 (forward-line 1))))))))
3205 ;; Now we've read all the local variables.
3206 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3207 (cond (mode-only result
)
3208 ;; Otherwise, set the variables.
3209 (enable-local-variables
3210 (hack-local-variables-filter result nil
)
3211 (hack-local-variables-apply)))))
3213 (defun hack-local-variables-apply ()
3214 (when file-local-variables-alist
3215 ;; Any 'evals must run in the Right sequence.
3216 (setq file-local-variables-alist
3217 (nreverse file-local-variables-alist
))
3218 (run-hooks 'before-hack-local-variables-hook
)
3219 (dolist (elt file-local-variables-alist
)
3220 (hack-one-local-variable (car elt
) (cdr elt
))))
3221 (run-hooks 'hack-local-variables-hook
))
3223 (defun safe-local-variable-p (sym val
)
3224 "Non-nil if SYM is safe as a file-local variable with value VAL.
3225 It is safe if any of these conditions are met:
3227 * There is a matching entry (SYM . VAL) in the
3228 `safe-local-variable-values' user option.
3230 * The `safe-local-variable' property of SYM is a function that
3231 evaluates to a non-nil value with VAL as an argument."
3232 (or (member (cons sym val
) safe-local-variable-values
)
3233 (let ((safep (get sym
'safe-local-variable
)))
3234 (and (functionp safep
)
3235 ;; If the function signals an error, that means it
3236 ;; can't assure us that the value is safe.
3237 (with-demoted-errors (funcall safep val
))))))
3239 (defun risky-local-variable-p (sym &optional ignored
)
3240 "Non-nil if SYM could be dangerous as a file-local variable.
3241 It is dangerous if either of these conditions are met:
3243 * Its `risky-local-variable' property is non-nil.
3245 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3246 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3247 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3248 \"map-alist\", or \"bindat-spec\"."
3249 ;; If this is an alias, check the base name.
3251 (setq sym
(indirect-variable sym
))
3253 (or (get sym
'risky-local-variable
)
3254 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3255 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3256 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3257 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
3259 (defun hack-one-local-variable-quotep (exp)
3260 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
3262 (defun hack-one-local-variable-constantp (exp)
3263 (or (and (not (symbolp exp
)) (not (consp exp
)))
3266 (hack-one-local-variable-quotep exp
)))
3268 (defun hack-one-local-variable-eval-safep (exp)
3269 "Return t if it is safe to eval EXP when it is found in a file."
3270 (or (not (consp exp
))
3271 ;; Detect certain `put' expressions.
3272 (and (eq (car exp
) 'put
)
3273 (hack-one-local-variable-quotep (nth 1 exp
))
3274 (hack-one-local-variable-quotep (nth 2 exp
))
3275 (let ((prop (nth 1 (nth 2 exp
)))
3277 (cond ((memq prop
'(lisp-indent-hook
3278 lisp-indent-function
3279 scheme-indent-function
))
3280 ;; Only allow safe values (not functions).
3282 (and (hack-one-local-variable-quotep val
)
3283 (eq (nth 1 val
) 'defun
))))
3284 ((eq prop
'edebug-form-spec
)
3285 ;; Only allow indirect form specs.
3286 ;; During bootstrapping, edebug-basic-spec might not be
3288 (and (fboundp 'edebug-basic-spec
)
3289 (hack-one-local-variable-quotep val
)
3290 (edebug-basic-spec (nth 1 val
)))))))
3291 ;; Allow expressions that the user requested.
3292 (member exp safe-local-eval-forms
)
3293 ;; Certain functions can be allowed with safe arguments
3294 ;; or can specify verification functions to try.
3295 (and (symbolp (car exp
))
3296 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
3299 (dolist (arg (cdr exp
))
3300 (unless (hack-one-local-variable-constantp arg
)
3307 (dolist (function prop
)
3308 (if (funcall function exp
)
3312 (defun hack-one-local-variable (var val
)
3313 "Set local variable VAR with value VAL.
3314 If VAR is `mode', call `VAL-mode' as a function unless it's
3315 already the major mode."
3316 (cond ((eq var
'mode
)
3317 (let ((mode (intern (concat (downcase (symbol-name val
))
3319 (unless (eq (indirect-function mode
)
3320 (indirect-function major-mode
))
3321 (if (memq mode minor-mode-list
)
3322 ;; A minor mode must be passed an argument.
3323 ;; Otherwise, if the user enables the minor mode in a
3324 ;; major mode hook, this would toggle it off.
3328 (save-excursion (eval val
)))
3330 ;; Make sure the string has no text properties.
3331 ;; Some text properties can get evaluated in various ways,
3332 ;; so it is risky to put them on with a local variable list.
3334 (set-text-properties 0 (length val
) nil val
))
3335 (set (make-local-variable var
) val
))))
3337 ;;; Handling directory-local variables, aka project settings.
3339 (defvar dir-locals-class-alist
'()
3340 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3342 (defvar dir-locals-directory-cache
'()
3343 "List of cached directory roots for directory-local variable classes.
3344 Each element in this list has the form (DIR CLASS MTIME).
3345 DIR is the name of the directory.
3346 CLASS is the name of a variable class (a symbol).
3347 MTIME is the recorded modification time of the directory-local
3348 variables file associated with this entry. This time is a list
3349 of two integers (the same format as `file-attributes'), and is
3350 used to test whether the cache entry is still valid.
3351 Alternatively, MTIME can be nil, which means the entry is always
3354 (defsubst dir-locals-get-class-variables
(class)
3355 "Return the variable list for CLASS."
3356 (cdr (assq class dir-locals-class-alist
)))
3358 (defun dir-locals-collect-mode-variables (mode-variables variables
)
3359 "Collect directory-local variables from MODE-VARIABLES.
3360 VARIABLES is the initial list of variables.
3361 Returns the new list."
3362 (dolist (pair mode-variables variables
)
3363 (let* ((variable (car pair
))
3365 (slot (assq variable variables
)))
3366 ;; If variables are specified more than once, only use the last. (Why?)
3367 ;; The pseudo-variables mode and eval are different (bug#3430).
3368 (if (and slot
(not (memq variable
'(mode eval
))))
3370 ;; Need a new cons in case we setcdr later.
3371 (push (cons variable value
) variables
)))))
3373 (defun dir-locals-collect-variables (class-variables root variables
)
3374 "Collect entries from CLASS-VARIABLES into VARIABLES.
3375 ROOT is the root directory of the project.
3376 Return the new variables list."
3377 (let* ((file-name (buffer-file-name))
3378 (sub-file-name (if file-name
3379 ;; FIXME: Why not use file-relative-name?
3380 (substring file-name
(length root
)))))
3382 (dolist (entry class-variables variables
)
3383 (let ((key (car entry
)))
3386 ;; Don't include this in the previous condition, because we
3387 ;; want to filter all strings before the next condition.
3388 (when (and sub-file-name
3389 (>= (length sub-file-name
) (length key
))
3390 (string-prefix-p key sub-file-name
))
3391 (setq variables
(dir-locals-collect-variables
3392 (cdr entry
) root variables
))))
3394 (derived-mode-p key
))
3395 (setq variables
(dir-locals-collect-mode-variables
3396 (cdr entry
) variables
))))))
3398 ;; The file's content might be invalid (e.g. have a merge conflict), but
3399 ;; that shouldn't prevent the user from opening the file.
3400 (message ".dir-locals error: %s" (error-message-string err
))
3403 (defun dir-locals-set-directory-class (directory class
&optional mtime
)
3404 "Declare that the DIRECTORY root is an instance of CLASS.
3405 DIRECTORY is the name of a directory, a string.
3406 CLASS is the name of a project class, a symbol.
3407 MTIME is either the modification time of the directory-local
3408 variables file that defined this class, or nil.
3410 When a file beneath DIRECTORY is visited, the mode-specific
3411 variables from CLASS are applied to the buffer. The variables
3412 for a class are defined using `dir-locals-set-class-variables'."
3413 (setq directory
(file-name-as-directory (expand-file-name directory
)))
3414 (unless (assq class dir-locals-class-alist
)
3415 (error "No such class `%s'" (symbol-name class
)))
3416 (push (list directory class mtime
) dir-locals-directory-cache
))
3418 (defun dir-locals-set-class-variables (class variables
)
3419 "Map the type CLASS to a list of variable settings.
3420 CLASS is the project class, a symbol. VARIABLES is a list
3421 that declares directory-local variables for the class.
3422 An element in VARIABLES is either of the form:
3423 (MAJOR-MODE . ALIST)
3427 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3428 whose elements are of the form (VARIABLE . VALUE).
3430 In the second form, DIRECTORY is a directory name (a string), and
3431 LIST is a list of the form accepted by the function.
3433 When a file is visited, the file's class is found. A directory
3434 may be assigned a class using `dir-locals-set-directory-class'.
3435 Then variables are set in the file's buffer according to the
3436 class' LIST. The list is processed in order.
3438 * If the element is of the form (MAJOR-MODE . ALIST), and the
3439 buffer's major mode is derived from MAJOR-MODE (as determined
3440 by `derived-mode-p'), then all the variables in ALIST are
3441 applied. A MAJOR-MODE of nil may be used to match any buffer.
3442 `make-local-variable' is called for each variable before it is
3445 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3446 is an initial substring of the file's directory, then LIST is
3447 applied by recursively following these rules."
3448 (let ((elt (assq class dir-locals-class-alist
)))
3450 (setcdr elt variables
)
3451 (push (cons class variables
) dir-locals-class-alist
))))
3453 (defconst dir-locals-file
".dir-locals.el"
3454 "File that contains directory-local variables.
3455 It has to be constant to enforce uniform values
3456 across different environments and users.")
3458 (defun dir-locals-find-file (file)
3459 "Find the directory-local variables for FILE.
3460 This searches upward in the directory tree from FILE.
3461 If the directory root of FILE has been registered in
3462 `dir-locals-directory-cache' and the directory-local variables
3463 file has not been modified, return the matching entry in
3464 `dir-locals-directory-cache'.
3465 Otherwise, if a directory-local variables file is found, return
3467 Otherwise, return nil."
3468 (setq file
(expand-file-name file
))
3469 (let* ((dir-locals-file-name
3470 (if (eq system-type
'ms-dos
)
3471 (dosified-file-name dir-locals-file
)
3473 (locals-file (locate-dominating-file file dir-locals-file-name
))
3475 ;; `locate-dominating-file' may have abbreviated the name.
3477 (setq locals-file
(expand-file-name dir-locals-file-name locals-file
)))
3478 ;; Find the best cached value in `dir-locals-directory-cache'.
3479 (dolist (elt dir-locals-directory-cache
)
3480 (when (and (eq t
(compare-strings file nil
(length (car elt
))
3483 '(windows-nt cygwin ms-dos
))))
3484 (> (length (car elt
)) (length (car dir-elt
))))
3485 (setq dir-elt elt
)))
3486 (let ((use-cache (and dir-elt
3487 (or (null locals-file
)
3488 (<= (length (file-name-directory locals-file
))
3489 (length (car dir-elt
)))))))
3491 ;; Check the validity of the cache.
3492 (if (and (file-readable-p (car dir-elt
))
3493 (or (null (nth 2 dir-elt
))
3494 (equal (nth 2 dir-elt
)
3495 (nth 5 (file-attributes (car dir-elt
))))))
3496 ;; This cache entry is OK.
3498 ;; This cache entry is invalid; clear it.
3499 (setq dir-locals-directory-cache
3500 (delq dir-elt dir-locals-directory-cache
))
3504 (defun dir-locals-read-from-file (file)
3505 "Load a variables FILE and register a new class and instance.
3506 FILE is the name of the file holding the variables to apply.
3507 The new class name is the same as the directory in which FILE
3508 is found. Returns the new class name."
3510 (insert-file-contents file
)
3511 (let* ((dir-name (file-name-directory file
))
3512 (class-name (intern dir-name
))
3513 (variables (let ((read-circle nil
))
3514 (read (current-buffer)))))
3515 (dir-locals-set-class-variables class-name variables
)
3516 (dir-locals-set-directory-class dir-name class-name
3517 (nth 5 (file-attributes file
)))
3520 (defun hack-dir-local-variables ()
3521 "Read per-directory local variables for the current buffer.
3522 Store the directory-local variables in `dir-local-variables-alist'
3523 and `file-local-variables-alist', without applying them."
3524 (when (and enable-local-variables
3525 (not (file-remote-p (or (buffer-file-name) default-directory
))))
3526 ;; Find the variables file.
3527 (let ((variables-file (dir-locals-find-file (or (buffer-file-name) default-directory
)))
3531 ((stringp variables-file
)
3532 (setq dir-name
(if (buffer-file-name)
3533 (file-name-directory (buffer-file-name))
3535 (setq class
(dir-locals-read-from-file variables-file
)))
3536 ((consp variables-file
)
3537 (setq dir-name
(nth 0 variables-file
))
3538 (setq class
(nth 1 variables-file
))))
3541 (dir-locals-collect-variables
3542 (dir-locals-get-class-variables class
) dir-name nil
)))
3544 (dolist (elt variables
)
3545 (unless (memq (car elt
) '(eval mode
))
3546 (setq dir-local-variables-alist
3547 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3548 (push elt dir-local-variables-alist
))
3549 (hack-local-variables-filter variables dir-name
)))))))
3551 (defun hack-dir-local-variables-non-file-buffer ()
3552 (hack-dir-local-variables)
3553 (hack-local-variables-apply))
3556 (defcustom change-major-mode-with-file-name t
3557 "Non-nil means \\[write-file] should set the major mode from the file name.
3558 However, the mode will not be changed if
3559 \(1) a local variables list or the `-*-' line specifies a major mode, or
3560 \(2) the current major mode is a \"special\" mode,
3561 \ not suitable for ordinary files, or
3562 \(3) the new file name does not particularly specify any mode."
3564 :group
'editing-basics
)
3566 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3567 "Change name of file visited in current buffer to FILENAME.
3568 This also renames the buffer to correspond to the new file.
3569 The next time the buffer is saved it will go in the newly specified file.
3570 FILENAME nil or an empty string means mark buffer as not visiting any file.
3571 Remember to delete the initial contents of the minibuffer
3572 if you wish to pass an empty string as the argument.
3574 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3575 confirmation in the case where another buffer is already visiting FILENAME.
3577 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3578 the old visited file has been renamed to the new name FILENAME."
3579 (interactive "FSet visited file name: ")
3580 (if (buffer-base-buffer)
3581 (error "An indirect buffer cannot visit a file"))
3585 (if (string-equal filename
"")
3587 (expand-file-name filename
))))
3590 (setq truename
(file-truename filename
))
3591 (if find-file-visit-truename
3592 (setq filename truename
))))
3594 (let ((new-name (file-name-nondirectory filename
)))
3595 (if (string= new-name
"")
3596 (error "Empty file name"))))
3597 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3598 (and buffer
(not (eq buffer
(current-buffer)))
3600 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3603 (or (equal filename buffer-file-name
)
3605 (and filename
(lock-buffer filename
))
3607 (setq buffer-file-name filename
)
3608 (if filename
; make buffer name reflect filename.
3609 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3610 (setq default-directory
(file-name-directory buffer-file-name
))
3611 ;; If new-name == old-name, renaming would add a spurious <2>
3612 ;; and it's considered as a feature in rename-buffer.
3613 (or (string= new-name
(buffer-name))
3614 (rename-buffer new-name t
))))
3615 (setq buffer-backed-up nil
)
3617 (clear-visited-file-modtime))
3618 ;; Abbreviate the file names of the buffer.
3621 (setq buffer-file-truename
(abbreviate-file-name truename
))
3622 (if find-file-visit-truename
3623 (setq buffer-file-name truename
))))
3624 (setq buffer-file-number
3626 (nthcdr 10 (file-attributes buffer-file-name
))
3628 ;; write-file-functions is normally used for things like ftp-find-file
3629 ;; that visit things that are not local files as if they were files.
3630 ;; Changing to visit an ordinary local file instead should flush the hook.
3631 (kill-local-variable 'write-file-functions
)
3632 (kill-local-variable 'local-write-file-hooks
)
3633 (kill-local-variable 'revert-buffer-function
)
3634 (kill-local-variable 'backup-inhibited
)
3635 ;; If buffer was read-only because of version control,
3636 ;; that reason is gone now, so make it writable.
3638 (setq buffer-read-only nil
))
3639 (kill-local-variable 'vc-mode
)
3640 ;; Turn off backup files for certain file names.
3641 ;; Since this is a permanent local, the major mode won't eliminate it.
3642 (and buffer-file-name
3643 backup-enable-predicate
3644 (not (funcall backup-enable-predicate buffer-file-name
))
3646 (make-local-variable 'backup-inhibited
)
3647 (setq backup-inhibited t
)))
3648 (let ((oauto buffer-auto-save-file-name
))
3649 ;; If auto-save was not already on, turn it on if appropriate.
3650 (if (not buffer-auto-save-file-name
)
3651 (and buffer-file-name auto-save-default
3653 ;; If auto save is on, start using a new name.
3654 ;; We deliberately don't rename or delete the old auto save
3655 ;; for the old visited file name. This is because perhaps
3656 ;; the user wants to save the new state and then compare with the
3657 ;; previous state from the auto save file.
3658 (setq buffer-auto-save-file-name
3659 (make-auto-save-file-name)))
3660 ;; Rename the old auto save file if any.
3661 (and oauto buffer-auto-save-file-name
3662 (file-exists-p oauto
)
3663 (rename-file oauto buffer-auto-save-file-name t
)))
3664 (and buffer-file-name
3665 (not along-with-file
)
3666 (set-buffer-modified-p t
))
3667 ;; Update the major mode, if the file name determines it.
3669 ;; Don't change the mode if it is special.
3670 (or (not change-major-mode-with-file-name
)
3671 (get major-mode
'mode-class
)
3672 ;; Don't change the mode if the local variable list specifies it.
3673 (hack-local-variables t
)
3677 (defun write-file (filename &optional confirm
)
3678 "Write current buffer into file FILENAME.
3679 This makes the buffer visit that file, and marks it as not modified.
3681 If you specify just a directory name as FILENAME, that means to use
3682 the default file name but in that directory. You can also yank
3683 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3685 If the buffer is not already visiting a file, the default file name
3686 for the output file is the buffer name.
3688 If optional second arg CONFIRM is non-nil, this function
3689 asks for confirmation before overwriting an existing file.
3690 Interactively, confirmation is required unless you supply a prefix argument."
3691 ;; (interactive "FWrite file: ")
3693 (list (if buffer-file-name
3694 (read-file-name "Write file: "
3696 (read-file-name "Write file: " default-directory
3698 (file-name-nondirectory (buffer-name))
3701 (not current-prefix-arg
)))
3702 (or (null filename
) (string-equal filename
"")
3704 ;; If arg is just a directory,
3705 ;; use the default file name, but in that directory.
3706 (if (file-directory-p filename
)
3707 (setq filename
(concat (file-name-as-directory filename
)
3708 (file-name-nondirectory
3709 (or buffer-file-name
(buffer-name))))))
3711 (file-exists-p filename
)
3712 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3713 (error "Canceled")))
3714 (set-visited-file-name filename
(not confirm
))))
3715 (set-buffer-modified-p t
)
3716 ;; Make buffer writable if file is writable.
3717 (and buffer-file-name
3718 (file-writable-p buffer-file-name
)
3719 (setq buffer-read-only nil
))
3721 ;; It's likely that the VC status at the new location is different from
3722 ;; the one at the old location.
3723 (vc-find-file-hook))
3725 (defun backup-buffer ()
3726 "Make a backup of the disk file visited by the current buffer, if appropriate.
3727 This is normally done before saving the buffer the first time.
3729 A backup may be done by renaming or by copying; see documentation of
3730 variable `make-backup-files'. If it's done by renaming, then the file is
3731 no longer accessible under its old name.
3733 The value is non-nil after a backup was made by renaming.
3734 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3735 MODES is the result of `file-modes' on the original
3736 file; this means that the caller, after saving the buffer, should change
3737 the modes of the new file to agree with the old modes.
3738 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3739 file; this means that the caller, after saving the buffer, should change
3740 the SELinux context of the new file to agree with the old context.
3741 BACKUPNAME is the backup file name, which is the old file renamed."
3742 (if (and make-backup-files
(not backup-inhibited
)
3743 (not buffer-backed-up
)
3744 (file-exists-p buffer-file-name
)
3745 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3747 (let ((real-file-name buffer-file-name
)
3748 backup-info backupname targets setmodes
)
3749 ;; If specified name is a symbolic link, chase it to the target.
3750 ;; Thus we make the backups in the directory where the real file is.
3751 (setq real-file-name
(file-chase-links real-file-name
))
3752 (setq backup-info
(find-backup-file-name real-file-name
)
3753 backupname
(car backup-info
)
3754 targets
(cdr backup-info
))
3755 ;; (if (file-directory-p buffer-file-name)
3756 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3759 (let ((delete-old-versions
3760 ;; If have old versions to maybe delete,
3761 ;; ask the user to confirm now, before doing anything.
3762 ;; But don't actually delete til later.
3764 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3765 (or delete-old-versions
3766 (y-or-n-p (format "Delete excess backup versions of %s? "
3768 (modes (file-modes buffer-file-name
))
3769 (context (file-selinux-context buffer-file-name
)))
3770 ;; Actually write the back up file.
3772 (if (or file-precious-flag
3773 ; (file-symlink-p buffer-file-name)
3775 ;; Don't rename a suid or sgid file.
3776 (and modes
(< 0 (logand modes
#o6000
)))
3777 (not (file-writable-p (file-name-directory real-file-name
)))
3778 (and backup-by-copying-when-linked
3779 (> (file-nlinks real-file-name
) 1))
3780 (and (or backup-by-copying-when-mismatch
3781 (integerp backup-by-copying-when-privileged-mismatch
))
3782 (let ((attr (file-attributes real-file-name
)))
3783 (and (or backup-by-copying-when-mismatch
3784 (and (integerp (nth 2 attr
))
3785 (integerp backup-by-copying-when-privileged-mismatch
)
3786 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3788 (not (file-ownership-preserved-p real-file-name
)))))))
3789 (backup-buffer-copy real-file-name backupname modes context
)
3790 ;; rename-file should delete old backup.
3791 (rename-file real-file-name backupname t
)
3792 (setq setmodes
(list modes context backupname
)))
3794 ;; If trouble writing the backup, write it in
3795 ;; .emacs.d/%backup%.
3796 (setq backupname
(locate-user-emacs-file "%backup%~"))
3797 (message "Cannot write backup file; backing up in %s"
3800 (backup-buffer-copy real-file-name backupname modes context
)))
3801 (setq buffer-backed-up t
)
3802 ;; Now delete the old versions, if desired.
3803 (if delete-old-versions
3806 (delete-file (car targets
))
3808 (setq targets
(cdr targets
))))
3810 (file-error nil
))))))
3812 (defun backup-buffer-copy (from-name to-name modes context
)
3813 (let ((umask (default-file-modes)))
3816 ;; Create temp files with strict access rights. It's easy to
3817 ;; loosen them later, whereas it's impossible to close the
3818 ;; time-window of loose permissions otherwise.
3819 (set-default-file-modes ?
\700)
3820 (when (condition-case nil
3821 ;; Try to overwrite old backup first.
3822 (copy-file from-name to-name t t t
)
3824 (while (condition-case nil
3826 (when (file-exists-p to-name
)
3827 (delete-file to-name
))
3828 (copy-file from-name to-name nil t t
)
3830 (file-already-exists t
))
3831 ;; The file was somehow created by someone else between
3832 ;; `delete-file' and `copy-file', so let's try again.
3833 ;; rms says "I think there is also a possible race
3834 ;; condition for making backup files" (emacs-devel 20070821).
3837 (set-default-file-modes umask
)))
3839 (set-file-modes to-name
(logand modes
#o1777
)))
3841 (set-file-selinux-context to-name context
)))
3843 (defvar file-name-version-regexp
3844 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+~\\)"
3845 "Regular expression matching the backup/version part of a file name.
3846 Used by `file-name-sans-versions'.")
3848 (defun file-name-sans-versions (name &optional keep-backup-version
)
3849 "Return file NAME sans backup versions or strings.
3850 This is a separate procedure so your site-init or startup file can
3852 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3853 we do not remove backup version numbers, only true file version numbers.
3854 See also `file-name-version-regexp'."
3855 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
3857 (funcall handler
'file-name-sans-versions name keep-backup-version
)
3859 (unless keep-backup-version
3860 (string-match (concat file-name-version-regexp
"\\'")
3863 (defun file-ownership-preserved-p (file)
3864 "Return t if deleting FILE and rewriting it would preserve the owner."
3865 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
3867 (funcall handler
'file-ownership-preserved-p file
)
3868 (let ((attributes (file-attributes file
)))
3869 ;; Return t if the file doesn't exist, since it's true that no
3870 ;; information would be lost by an (attempted) delete and create.
3871 (or (null attributes
)
3872 (= (nth 2 attributes
) (user-uid)))))))
3874 (defun file-name-sans-extension (filename)
3875 "Return FILENAME sans final \"extension\".
3876 The extension, in a file name, is the part that follows the last `.',
3877 except that a leading `.', if any, doesn't count."
3879 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
3881 (if (and (string-match "\\.[^.]*\\'" file
)
3882 (not (eq 0 (match-beginning 0))))
3883 (if (setq directory
(file-name-directory filename
))
3884 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3885 ;; we don't want to expand it.
3886 (concat directory
(substring file
0 (match-beginning 0)))
3887 (substring file
0 (match-beginning 0)))
3890 (defun file-name-extension (filename &optional period
)
3891 "Return FILENAME's final \"extension\".
3892 The extension, in a file name, is the part that follows the last `.',
3893 excluding version numbers and backup suffixes,
3894 except that a leading `.', if any, doesn't count.
3895 Return nil for extensionless file names such as `foo'.
3896 Return the empty string for file names such as `foo.'.
3898 If PERIOD is non-nil, then the returned value includes the period
3899 that delimits the extension, and if FILENAME has no extension,
3902 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
3903 (if (and (string-match "\\.[^.]*\\'" file
)
3904 (not (eq 0 (match-beginning 0))))
3905 (substring file
(+ (match-beginning 0) (if period
0 1)))
3909 (defcustom make-backup-file-name-function nil
3910 "A function to use instead of the default `make-backup-file-name'.
3911 A value of nil gives the default `make-backup-file-name' behavior.
3913 This could be buffer-local to do something special for specific
3914 files. If you define it, you may need to change `backup-file-name-p'
3915 and `file-name-sans-versions' too.
3917 See also `backup-directory-alist'."
3919 :type
'(choice (const :tag
"Default" nil
)
3920 (function :tag
"Your function")))
3922 (defcustom backup-directory-alist nil
3923 "Alist of filename patterns and backup directory names.
3924 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3925 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3926 relative or absolute. If it is absolute, so that all matching files
3927 are backed up into the same directory, the file names in this
3928 directory will be the full name of the file backed up with all
3929 directory separators changed to `!' to prevent clashes. This will not
3930 work correctly if your filesystem truncates the resulting name.
3932 For the common case of all backups going into one directory, the alist
3933 should contain a single element pairing \".\" with the appropriate
3936 If this variable is nil, or it fails to match a filename, the backup
3937 is made in the original file's directory.
3939 On MS-DOS filesystems without long names this variable is always
3942 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
3943 (directory :tag
"Backup directory name"))))
3945 (defun normal-backup-enable-predicate (name)
3946 "Default `backup-enable-predicate' function.
3947 Checks for files in `temporary-file-directory',
3948 `small-temporary-file-directory', and /tmp."
3949 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
3951 ;; Directory is under temporary-file-directory.
3952 (and (not (eq comp t
))
3953 (< comp
(- (length temporary-file-directory
)))))
3954 (let ((comp (compare-strings "/tmp" 0 nil
3956 ;; Directory is under /tmp.
3957 (and (not (eq comp t
))
3958 (< comp
(- (length "/tmp")))))
3959 (if small-temporary-file-directory
3960 (let ((comp (compare-strings small-temporary-file-directory
3963 ;; Directory is under small-temporary-file-directory.
3964 (and (not (eq comp t
))
3965 (< comp
(- (length small-temporary-file-directory
)))))))))
3967 (defun make-backup-file-name (file)
3968 "Create the non-numeric backup file name for FILE.
3969 Normally this will just be the file's name with `~' appended.
3970 Customization hooks are provided as follows.
3972 If the variable `make-backup-file-name-function' is non-nil, its value
3973 should be a function which will be called with FILE as its argument;
3974 the resulting name is used.
3976 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3977 the documentation of that variable. If the directory for the backup
3978 doesn't exist, it is created."
3979 (if make-backup-file-name-function
3980 (funcall make-backup-file-name-function file
)
3981 (if (and (eq system-type
'ms-dos
)
3982 (not (msdos-long-file-names)))
3983 (let ((fn (file-name-nondirectory file
)))
3984 (concat (file-name-directory file
)
3985 (or (and (string-match "\\`[^.]+\\'" fn
)
3986 (concat (match-string 0 fn
) ".~"))
3987 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
3988 (concat (match-string 0 fn
) "~")))))
3989 (concat (make-backup-file-name-1 file
) "~"))))
3991 (defun make-backup-file-name-1 (file)
3992 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3993 (let ((alist backup-directory-alist
)
3994 elt backup-directory abs-backup-directory
)
3996 (setq elt
(pop alist
))
3997 (if (string-match (car elt
) file
)
3998 (setq backup-directory
(cdr elt
)
4000 ;; If backup-directory is relative, it should be relative to the
4001 ;; file's directory. By expanding explicitly here, we avoid
4002 ;; depending on default-directory.
4003 (if backup-directory
4004 (setq abs-backup-directory
4005 (expand-file-name backup-directory
4006 (file-name-directory file
))))
4007 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
4009 (make-directory abs-backup-directory
'parents
)
4010 (file-error (setq backup-directory nil
4011 abs-backup-directory nil
))))
4012 (if (null backup-directory
)
4014 (if (file-name-absolute-p backup-directory
)
4016 (when (memq system-type
'(windows-nt ms-dos cygwin
))
4017 ;; Normalize DOSish file names: downcase the drive
4018 ;; letter, if any, and replace the leading "x:" with
4020 (or (file-name-absolute-p file
)
4021 (setq file
(expand-file-name file
))) ; make defaults explicit
4022 ;; Replace any invalid file-name characters (for the
4023 ;; case of backing up remote files).
4024 (setq file
(expand-file-name (convert-standard-filename file
)))
4025 (if (eq (aref file
1) ?
:)
4026 (setq file
(concat "/"
4028 (char-to-string (downcase (aref file
0)))
4029 (if (eq (aref file
2) ?
/)
4032 (substring file
2)))))
4033 ;; Make the name unique by substituting directory
4034 ;; separators. It may not really be worth bothering about
4035 ;; doubling `!'s in the original name...
4037 (subst-char-in-string
4039 (replace-regexp-in-string "!" "!!" file
))
4041 (expand-file-name (file-name-nondirectory file
)
4042 (file-name-as-directory abs-backup-directory
))))))
4044 (defun backup-file-name-p (file)
4045 "Return non-nil if FILE is a backup file name (numeric or not).
4046 This is a separate function so you can redefine it for customization.
4047 You may need to redefine `file-name-sans-versions' as well."
4048 (string-match "~\\'" file
))
4050 (defvar backup-extract-version-start
)
4052 ;; This is used in various files.
4053 ;; The usage of backup-extract-version-start is not very clean,
4054 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4055 (defun backup-extract-version (fn)
4056 "Given the name of a numeric backup file, FN, return the backup number.
4057 Uses the free variable `backup-extract-version-start', whose value should be
4058 the index in the name where the version number begins."
4059 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start
)
4060 (= (match-beginning 0) backup-extract-version-start
))
4061 (string-to-number (substring fn backup-extract-version-start -
1))
4064 (defun find-backup-file-name (fn)
4065 "Find a file name for a backup file FN, and suggestions for deletions.
4066 Value is a list whose car is the name for the backup file
4067 and whose cdr is a list of old versions to consider deleting now.
4068 If the value is nil, don't make a backup.
4069 Uses `backup-directory-alist' in the same way as does
4070 `make-backup-file-name'."
4071 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
4072 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4074 (funcall handler
'find-backup-file-name fn
)
4075 (if (or (eq version-control
'never
)
4076 ;; We don't support numbered backups on plain MS-DOS
4077 ;; when long file names are unavailable.
4078 (and (eq system-type
'ms-dos
)
4079 (not (msdos-long-file-names))))
4080 (list (make-backup-file-name fn
))
4081 (let* ((basic-name (make-backup-file-name-1 fn
))
4082 (base-versions (concat (file-name-nondirectory basic-name
)
4084 (backup-extract-version-start (length base-versions
))
4086 (number-to-delete 0)
4087 possibilities deserve-versions-p versions
)
4089 (setq possibilities
(file-name-all-completions
4091 (file-name-directory basic-name
))
4092 versions
(sort (mapcar #'backup-extract-version
4095 high-water-mark
(apply 'max
0 versions
)
4096 deserve-versions-p
(or version-control
4097 (> high-water-mark
0))
4098 number-to-delete
(- (length versions
)
4102 (file-error (setq possibilities nil
)))
4103 (if (not deserve-versions-p
)
4104 (list (make-backup-file-name fn
))
4105 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
4106 (if (and (> number-to-delete
0)
4107 ;; Delete nothing if there is overflow
4108 ;; in the number of versions to keep.
4109 (>= (+ kept-new-versions kept-old-versions -
1) 0))
4111 (format "%s.~%d~" basic-name n
))
4112 (let ((v (nthcdr kept-old-versions versions
)))
4113 (rplacd (nthcdr (1- number-to-delete
) v
) ())
4116 (defun file-nlinks (filename)
4117 "Return number of names file FILENAME has."
4118 (car (cdr (file-attributes filename
))))
4120 ;; (defun file-relative-name (filename &optional directory)
4121 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4122 ;; This function returns a relative file name which is equivalent to FILENAME
4123 ;; when used with that default directory as the default.
4124 ;; If this is impossible (which can happen on MSDOS and Windows
4125 ;; when the file name and directory use different drive names)
4126 ;; then it returns FILENAME."
4128 ;; (let ((fname (expand-file-name filename)))
4129 ;; (setq directory (file-name-as-directory
4130 ;; (expand-file-name (or directory default-directory))))
4131 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4132 ;; ;; drive names, they can't be relative, so return the absolute name.
4133 ;; (if (and (or (eq system-type 'ms-dos)
4134 ;; (eq system-type 'cygwin)
4135 ;; (eq system-type 'windows-nt))
4136 ;; (not (string-equal (substring fname 0 2)
4137 ;; (substring directory 0 2))))
4139 ;; (let ((ancestor ".")
4140 ;; (fname-dir (file-name-as-directory fname)))
4141 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4142 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4143 ;; (setq directory (file-name-directory (substring directory 0 -1))
4144 ;; ancestor (if (equal ancestor ".")
4146 ;; (concat "../" ancestor))))
4147 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4148 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4149 ;; ;; We matched within FNAME's directory part.
4150 ;; ;; Add the rest of FNAME onto ANCESTOR.
4151 ;; (let ((rest (substring fname (match-end 0))))
4152 ;; (if (and (equal ancestor ".")
4153 ;; (not (equal rest "")))
4154 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4156 ;; (concat (file-name-as-directory ancestor) rest)))
4157 ;; ;; We matched FNAME's directory equivalent.
4160 (defun file-relative-name (filename &optional directory
)
4161 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4162 This function returns a relative file name which is equivalent to FILENAME
4163 when used with that default directory as the default.
4164 If FILENAME and DIRECTORY lie on different machines or on different drives
4165 on a DOS/Windows machine, it returns FILENAME in expanded form."
4168 (file-name-as-directory (expand-file-name (or directory
4169 default-directory
))))
4170 (setq filename
(expand-file-name filename
))
4171 (let ((fremote (file-remote-p filename
))
4172 (dremote (file-remote-p directory
)))
4173 (if ;; Conditions for separate trees
4175 ;; Test for different filesystems on DOS/Windows
4177 ;; Should `cygwin' really be included here? --stef
4178 (memq system-type
'(ms-dos cygwin windows-nt
))
4180 ;; Test for different drive letters
4181 (not (eq t
(compare-strings filename
0 2 directory
0 2)))
4182 ;; Test for UNCs on different servers
4183 (not (eq t
(compare-strings
4185 (if (string-match "\\`//\\([^:/]+\\)/" filename
)
4186 (match-string 1 filename
)
4187 ;; Windows file names cannot have ? in
4188 ;; them, so use that to detect when
4189 ;; neither FILENAME nor DIRECTORY is a
4194 (if (string-match "\\`//\\([^:/]+\\)/" directory
)
4195 (match-string 1 directory
)
4198 ;; Test for different remote file system identification
4199 (not (equal fremote dremote
)))
4201 (let ((ancestor ".")
4202 (filename-dir (file-name-as-directory filename
)))
4205 (eq t
(compare-strings filename-dir nil
(length directory
)
4206 directory nil nil case-fold-search
))
4207 (eq t
(compare-strings filename nil
(length directory
)
4208 directory nil nil case-fold-search
))))
4209 (setq directory
(file-name-directory (substring directory
0 -
1))
4210 ancestor
(if (equal ancestor
".")
4212 (concat "../" ancestor
))))
4213 ;; Now ancestor is empty, or .., or ../.., etc.
4214 (if (eq t
(compare-strings filename nil
(length directory
)
4215 directory nil nil case-fold-search
))
4216 ;; We matched within FILENAME's directory part.
4217 ;; Add the rest of FILENAME onto ANCESTOR.
4218 (let ((rest (substring filename
(length directory
))))
4219 (if (and (equal ancestor
".") (not (equal rest
"")))
4220 ;; But don't bother with ANCESTOR if it would give us `./'.
4222 (concat (file-name-as-directory ancestor
) rest
)))
4223 ;; We matched FILENAME's directory equivalent.
4226 (defun save-buffer (&optional args
)
4227 "Save current buffer in visited file if modified.
4228 Variations are described below.
4230 By default, makes the previous version into a backup file
4231 if previously requested or if this is the first save.
4232 Prefixed with one \\[universal-argument], marks this version
4233 to become a backup when the next save is done.
4234 Prefixed with two \\[universal-argument]'s,
4235 unconditionally makes the previous version into a backup file.
4236 Prefixed with three \\[universal-argument]'s, marks this version
4237 to become a backup when the next save is done,
4238 and unconditionally makes the previous version into a backup file.
4240 With a numeric argument of 0, never make the previous version
4243 If a file's name is FOO, the names of its numbered backup versions are
4244 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4245 Numeric backups (rather than FOO~) will be made if value of
4246 `version-control' is not the atom `never' and either there are already
4247 numeric versions of the file being backed up, or `version-control' is
4249 We don't want excessive versions piling up, so there are variables
4250 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4251 and `kept-new-versions', which tells how many newest versions to keep.
4252 Defaults are 2 old versions and 2 new.
4253 `dired-kept-versions' controls dired's clean-directory (.) command.
4254 If `delete-old-versions' is nil, system will query user
4255 before trimming versions. Otherwise it does it silently.
4257 If `vc-make-backup-files' is nil, which is the default,
4258 no backup files are made for files managed by version control.
4259 (This is because the version control system itself records previous versions.)
4261 See the subroutine `basic-save-buffer' for more information."
4263 (let ((modp (buffer-modified-p))
4264 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
4265 (memq args
'(16 64)))))
4266 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
4267 ;; We used to display the message below only for files > 50KB, but
4268 ;; then Rmail-mbox never displays it due to buffer swapping. If
4269 ;; the test is ever re-introduced, be sure to handle saving of
4271 (if (and modp
(buffer-file-name))
4272 (message "Saving file %s..." (buffer-file-name)))
4274 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
4276 (defun delete-auto-save-file-if-necessary (&optional force
)
4277 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4278 Normally delete only if the file was written by this Emacs since
4279 the last real save, but optional arg FORCE non-nil means delete anyway."
4280 (and buffer-auto-save-file-name delete-auto-save-files
4281 (not (string= buffer-file-name buffer-auto-save-file-name
))
4282 (or force
(recent-auto-save-p))
4285 (delete-file buffer-auto-save-file-name
)
4287 (set-buffer-auto-saved))))
4289 (defvar auto-save-hook nil
4290 "Normal hook run just before auto-saving.")
4292 (defcustom before-save-hook nil
4293 "Normal hook that is run before a buffer is saved to its file."
4294 :options
'(copyright-update time-stamp
)
4298 (defcustom after-save-hook nil
4299 "Normal hook that is run after a buffer is saved to its file."
4300 :options
'(executable-make-buffer-file-executable-if-script-p)
4304 (defvar save-buffer-coding-system nil
4305 "If non-nil, use this coding system for saving the buffer.
4306 More precisely, use this coding system in place of the
4307 value of `buffer-file-coding-system', when saving the buffer.
4308 Calling `write-region' for any purpose other than saving the buffer
4309 will still use `buffer-file-coding-system'; this variable has no effect
4312 (make-variable-buffer-local 'save-buffer-coding-system
)
4313 (put 'save-buffer-coding-system
'permanent-local t
)
4315 (defun basic-save-buffer ()
4316 "Save the current buffer in its visited file, if it has been modified.
4317 The hooks `write-contents-functions' and `write-file-functions' get a chance
4318 to do the job of saving; if they do not, then the buffer is saved in
4319 the visited file in the usual way.
4320 Before and after saving the buffer, this function runs
4321 `before-save-hook' and `after-save-hook', respectively."
4323 (save-current-buffer
4324 ;; In an indirect buffer, save its base buffer instead.
4325 (if (buffer-base-buffer)
4326 (set-buffer (buffer-base-buffer)))
4327 (if (or (buffer-modified-p)
4328 ;; handle the case when no modification has been made but
4329 ;; the file disappeared since visited
4330 (and buffer-file-name
4331 (not (file-exists-p buffer-file-name
))))
4332 (let ((recent-save (recent-auto-save-p))
4334 ;; If buffer has no file name, ask user for one.
4335 (or buffer-file-name
4338 (read-file-name "File to save in: ") nil
)))
4339 (if (file-exists-p filename
)
4340 (if (file-directory-p filename
)
4341 ;; Signal an error if the user specified the name of an
4342 ;; existing directory.
4343 (error "%s is a directory" filename
)
4344 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4346 (error "Canceled")))
4347 ;; Signal an error if the specified name refers to a
4348 ;; non-existing directory.
4349 (let ((dir (file-name-directory filename
)))
4350 (unless (file-directory-p dir
)
4351 (if (file-exists-p dir
)
4352 (error "%s is not a directory" dir
)
4353 (error "%s: no such directory" dir
)))))
4354 (set-visited-file-name filename
)))
4355 (or (verify-visited-file-modtime (current-buffer))
4356 (not (file-exists-p buffer-file-name
))
4359 "%s has changed since visited or saved. Save anyway? "
4360 (file-name-nondirectory buffer-file-name
)))
4361 (error "Save not confirmed"))
4365 (and (> (point-max) (point-min))
4366 (not find-file-literally
)
4367 (/= (char-after (1- (point-max))) ?
\n)
4368 (not (and (eq selective-display t
)
4369 (= (char-after (1- (point-max))) ?
\r)))
4370 (or (eq require-final-newline t
)
4371 (eq require-final-newline
'visit-save
)
4372 (and require-final-newline
4374 (format "Buffer %s does not end in newline. Add one? "
4377 (goto-char (point-max))
4379 ;; Support VC version backups.
4381 (run-hooks 'before-save-hook
)
4382 (or (run-hook-with-args-until-success 'write-contents-functions
)
4383 (run-hook-with-args-until-success 'local-write-file-hooks
)
4384 (run-hook-with-args-until-success 'write-file-functions
)
4385 ;; If a hook returned t, file is already "written".
4386 ;; Otherwise, write it the usual way now.
4387 (setq setmodes
(basic-save-buffer-1)))
4388 ;; Now we have saved the current buffer. Let's make sure
4389 ;; that buffer-file-coding-system is fixed to what
4390 ;; actually used for saving by binding it locally.
4391 (if save-buffer-coding-system
4392 (setq save-buffer-coding-system last-coding-system-used
)
4393 (setq buffer-file-coding-system last-coding-system-used
))
4394 (setq buffer-file-number
4395 (nthcdr 10 (file-attributes buffer-file-name
)))
4399 (set-file-modes buffer-file-name
(car setmodes
))
4400 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))
4402 ;; If the auto-save file was recent before this command,
4404 (delete-auto-save-file-if-necessary recent-save
)
4405 ;; Support VC `implicit' locking.
4407 (run-hooks 'after-save-hook
))
4408 (message "(No changes need to be saved)"))))
4410 ;; This does the "real job" of writing a buffer into its visited file
4411 ;; and making a backup file. This is what is normally done
4412 ;; but inhibited if one of write-file-functions returns non-nil.
4413 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4414 (defun basic-save-buffer-1 ()
4416 (if save-buffer-coding-system
4417 (let ((coding-system-for-write save-buffer-coding-system
))
4418 (basic-save-buffer-2))
4419 (basic-save-buffer-2))
4420 (if buffer-file-coding-system-explicit
4421 (setcar buffer-file-coding-system-explicit last-coding-system-used
)
4422 (setq buffer-file-coding-system-explicit
4423 (cons last-coding-system-used nil
)))))
4425 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4426 (defun basic-save-buffer-2 ()
4427 (let (tempsetmodes setmodes
)
4428 (if (not (file-writable-p buffer-file-name
))
4429 (let ((dir (file-name-directory buffer-file-name
)))
4430 (if (not (file-directory-p dir
))
4431 (if (file-exists-p dir
)
4432 (error "%s is not a directory" dir
)
4433 (error "%s: no such directory" dir
))
4434 (if (not (file-exists-p buffer-file-name
))
4435 (error "Directory %s write-protected" dir
)
4438 "File %s is write-protected; try to save anyway? "
4439 (file-name-nondirectory
4441 (setq tempsetmodes t
)
4442 (error "Attempt to save to a file which you aren't allowed to write"))))))
4443 (or buffer-backed-up
4444 (setq setmodes
(backup-buffer)))
4445 (let* ((dir (file-name-directory buffer-file-name
))
4446 (dir-writable (file-writable-p dir
)))
4447 (if (or (and file-precious-flag dir-writable
)
4448 (and break-hardlink-on-save
4449 (> (file-nlinks buffer-file-name
) 1)
4451 (error (concat (format
4452 "Directory %s write-protected; " dir
)
4453 "cannot break hardlink when saving")))))
4454 ;; Write temp name, then rename it.
4455 ;; This requires write access to the containing dir,
4456 ;; which is why we don't try it if we don't have that access.
4457 (let ((realname buffer-file-name
)
4459 (umask (default-file-modes))
4460 (old-modtime (visited-file-modtime)))
4461 ;; Create temp files with strict access rights. It's easy to
4462 ;; loosen them later, whereas it's impossible to close the
4463 ;; time-window of loose permissions otherwise.
4466 (clear-visited-file-modtime)
4467 (set-default-file-modes ?
\700)
4468 ;; Try various temporary names.
4469 ;; This code follows the example of make-temp-file,
4470 ;; but it calls write-region in the appropriate way
4471 ;; for saving the buffer.
4472 (while (condition-case ()
4476 (expand-file-name "tmp" dir
)))
4477 ;; Pass in nil&nil rather than point-min&max
4478 ;; cause we're saving the whole buffer.
4479 ;; write-region-annotate-functions may use it.
4480 (write-region nil nil
4481 tempname nil realname
4482 buffer-file-truename
'excl
)
4484 (file-already-exists t
))
4485 ;; The file was somehow created by someone else between
4486 ;; `make-temp-name' and `write-region', let's try again.
4490 (set-default-file-modes umask
)
4491 ;; If we failed, restore the buffer's modtime.
4493 (set-visited-file-modtime old-modtime
)))
4494 ;; Since we have created an entirely new file,
4495 ;; make sure it gets the right permission bits set.
4496 (setq setmodes
(or setmodes
4497 (list (or (file-modes buffer-file-name
)
4498 (logand ?
\666 umask
))
4499 (file-selinux-context buffer-file-name
)
4501 ;; We succeeded in writing the temp file,
4503 (rename-file tempname buffer-file-name t
))
4504 ;; If file not writable, see if we can make it writable
4505 ;; temporarily while we write it.
4506 ;; But no need to do so if we have just backed it up
4507 ;; (setmodes is set) because that says we're superseding.
4508 (cond ((and tempsetmodes
(not setmodes
))
4509 ;; Change the mode back, after writing.
4510 (setq setmodes
(list (file-modes buffer-file-name
)
4511 (file-selinux-context buffer-file-name
)
4513 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))
4514 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))))
4518 ;; Pass in nil&nil rather than point-min&max to indicate
4519 ;; we're saving the buffer rather than just a region.
4520 ;; write-region-annotate-functions may make us of it.
4521 (write-region nil nil
4522 buffer-file-name nil t buffer-file-truename
)
4524 ;; If we get an error writing the new file, and we made
4525 ;; the backup by renaming, undo the backing-up.
4526 (and setmodes
(not success
)
4528 (rename-file (nth 2 setmodes
) buffer-file-name t
)
4529 (setq buffer-backed-up nil
))))))
4532 (declare-function diff-no-select
"diff"
4533 (old new
&optional switches no-async buf
))
4535 (defvar save-some-buffers-action-alist
4538 (if (not enable-recursive-minibuffers
)
4539 (progn (display-buffer buf
)
4540 (setq other-window-scroll-buffer buf
))
4541 (view-buffer buf
(lambda (_) (exit-recursive-edit)))
4543 ;; Return nil to ask about BUF again.
4545 ,(purecopy "view this buffer"))
4547 (if (null (buffer-file-name buf
))
4548 (message "Not applicable: no file")
4549 (require 'diff
) ;for diff-no-select.
4550 (let ((diffbuf (diff-no-select (buffer-file-name buf
) buf
4552 (if (not enable-recursive-minibuffers
)
4553 (progn (display-buffer diffbuf
)
4554 (setq other-window-scroll-buffer diffbuf
))
4555 (view-buffer diffbuf
(lambda (_) (exit-recursive-edit)))
4557 ;; Return nil to ask about BUF again.
4559 ,(purecopy "view changes in this buffer")))
4560 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4561 (put 'save-some-buffers-action-alist
'risky-local-variable t
)
4563 (defvar buffer-save-without-query nil
4564 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4565 (make-variable-buffer-local 'buffer-save-without-query
)
4567 (defun save-some-buffers (&optional arg pred
)
4568 "Save some modified file-visiting buffers. Asks user about each one.
4569 You can answer `y' to save, `n' not to save, `C-r' to look at the
4570 buffer in question with `view-buffer' before deciding or `d' to
4571 view the differences using `diff-buffer-with-file'.
4573 Optional argument (the prefix) non-nil means save all with no questions.
4574 Optional second argument PRED determines which buffers are considered:
4575 If PRED is nil, all the file-visiting buffers are considered.
4576 If PRED is t, then certain non-file buffers will also be considered.
4577 If PRED is a zero-argument function, it indicates for each buffer whether
4578 to consider it or not when called with that buffer current.
4580 See `save-some-buffers-action-alist' if you want to
4581 change the additional actions you can take on files."
4583 (save-window-excursion
4584 (let* (queried some-automatic
4585 files-done abbrevs-done
)
4586 (dolist (buffer (buffer-list))
4587 ;; First save any buffers that we're supposed to save unconditionally.
4588 ;; That way the following code won't ask about them.
4589 (with-current-buffer buffer
4590 (when (and buffer-save-without-query
(buffer-modified-p))
4591 (setq some-automatic t
)
4593 ;; Ask about those buffers that merit it,
4594 ;; and record the number thus saved.
4598 ;; Note that killing some buffers may kill others via
4599 ;; hooks (e.g. Rmail and its viewing buffer).
4600 (and (buffer-live-p buffer
)
4601 (buffer-modified-p buffer
)
4602 (not (buffer-base-buffer buffer
))
4604 (buffer-file-name buffer
)
4608 (and buffer-offer-save
(> (buffer-size) 0)))))
4609 (or (not (functionp pred
))
4610 (with-current-buffer buffer
(funcall pred
)))
4614 (if (buffer-file-name buffer
)
4615 (format "Save file %s? "
4616 (buffer-file-name buffer
))
4617 (format "Save buffer %s? "
4618 (buffer-name buffer
))))))
4620 (with-current-buffer buffer
4623 '("buffer" "buffers" "save")
4624 save-some-buffers-action-alist
))
4625 ;; Maybe to save abbrevs, and record whether
4626 ;; we either saved them or asked to.
4627 (and save-abbrevs abbrevs-changed
4630 (eq save-abbrevs
'silently
)
4631 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name
)))
4632 (write-abbrev-file nil
))
4633 ;; Don't keep bothering user if he says no.
4634 (setq abbrevs-changed nil
)
4635 (setq abbrevs-done t
)))
4636 (or queried
(> files-done
0) abbrevs-done
4637 (message (if some-automatic
4638 "(Some special files were saved without asking)"
4639 "(No files need saving)"))))))
4641 (defun not-modified (&optional arg
)
4642 "Mark current buffer as unmodified, not needing to be saved.
4643 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4645 It is not a good idea to use this function in Lisp programs, because it
4646 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4648 (message (if arg
"Modification-flag set"
4649 "Modification-flag cleared"))
4650 (set-buffer-modified-p arg
))
4652 (defun toggle-read-only (&optional arg
)
4653 "Change whether this buffer is read-only.
4654 With prefix argument ARG, make the buffer read-only if ARG is
4655 positive, otherwise make it writable. If buffer is read-only
4656 and `view-read-only' is non-nil, enter view mode."
4659 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4660 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4664 ((and buffer-read-only view-mode
)
4665 (View-exit-and-edit)
4666 (make-local-variable 'view-read-only
)
4667 (setq view-read-only t
)) ; Must leave view mode.
4668 ((and (not buffer-read-only
) view-read-only
4669 ;; If view-mode is already active, `view-mode-enter' is a nop.
4671 (not (eq (get major-mode
'mode-class
) 'special
)))
4673 (t (setq buffer-read-only
(not buffer-read-only
))
4674 (force-mode-line-update)))
4675 (if (vc-backend buffer-file-name
)
4676 (message "%s" (substitute-command-keys
4677 (concat "File is under version-control; "
4678 "use \\[vc-next-action] to check in/out"))))))
4680 (defun insert-file (filename)
4681 "Insert contents of file FILENAME into buffer after point.
4682 Set mark after the inserted text.
4684 This function is meant for the user to run interactively.
4685 Don't call it from programs! Use `insert-file-contents' instead.
4686 \(Its calling sequence is different; see its documentation)."
4687 (interactive "*fInsert file: ")
4688 (insert-file-1 filename
#'insert-file-contents
))
4690 (defun append-to-file (start end filename
)
4691 "Append the contents of the region to the end of file FILENAME.
4692 When called from a function, expects three arguments,
4693 START, END and FILENAME. START and END are normally buffer positions
4694 specifying the part of the buffer to write.
4695 If START is nil, that means to use the entire buffer contents.
4696 If START is a string, then output that string to the file
4697 instead of any buffer contents; END is ignored.
4699 This does character code conversion and applies annotations
4700 like `write-region' does."
4701 (interactive "r\nFAppend to file: ")
4702 (write-region start end filename t
))
4704 (defun file-newest-backup (filename)
4705 "Return most recent backup file for FILENAME or nil if no backups exist."
4706 ;; `make-backup-file-name' will get us the right directory for
4707 ;; ordinary or numeric backups. It might create a directory for
4708 ;; backups as a side-effect, according to `backup-directory-alist'.
4709 (let* ((filename (file-name-sans-versions
4710 (make-backup-file-name (expand-file-name filename
))))
4711 (file (file-name-nondirectory filename
))
4712 (dir (file-name-directory filename
))
4713 (comp (file-name-all-completions file dir
))
4717 (setq tem
(pop comp
))
4718 (cond ((and (backup-file-name-p tem
)
4719 (string= (file-name-sans-versions tem
) file
))
4720 (setq tem
(concat dir tem
))
4721 (if (or (null newest
)
4722 (file-newer-than-file-p tem newest
))
4723 (setq newest tem
)))))
4726 (defun rename-uniquely ()
4727 "Rename current buffer to a similar name not already taken.
4728 This function is useful for creating multiple shell process buffers
4729 or multiple mail buffers, etc."
4732 (let ((base-name (buffer-name)))
4733 (and (string-match "<[0-9]+>\\'" base-name
)
4734 (not (and buffer-file-name
4736 (file-name-nondirectory buffer-file-name
))))
4737 ;; If the existing buffer name has a <NNN>,
4738 ;; which isn't part of the file name (if any),
4739 ;; then get rid of that.
4740 (setq base-name
(substring base-name
0 (match-beginning 0))))
4741 (rename-buffer (generate-new-buffer-name base-name
))
4742 (force-mode-line-update))))
4744 (defun make-directory (dir &optional parents
)
4745 "Create the directory DIR and optionally any nonexistent parent dirs.
4746 If DIR already exists as a directory, signal an error, unless
4749 Interactively, the default choice of directory to create is the
4750 current buffer's default directory. That is useful when you have
4751 visited a file in a nonexistent directory.
4753 Noninteractively, the second (optional) argument PARENTS, if
4754 non-nil, says whether to create parent directories that don't
4755 exist. Interactively, this happens by default."
4757 (list (read-file-name "Make directory: " default-directory default-directory
4760 ;; If default-directory is a remote directory,
4761 ;; make sure we find its make-directory handler.
4762 (setq dir
(expand-file-name dir
))
4763 (let ((handler (find-file-name-handler dir
'make-directory
)))
4765 (funcall handler
'make-directory dir parents
)
4767 (make-directory-internal dir
)
4768 (let ((dir (directory-file-name (expand-file-name dir
)))
4770 (while (and (not (file-exists-p dir
))
4771 ;; If directory is its own parent, then we can't
4772 ;; keep looping forever
4774 (directory-file-name
4775 (file-name-directory dir
)))))
4776 (setq create-list
(cons dir create-list
)
4777 dir
(directory-file-name (file-name-directory dir
))))
4779 (make-directory-internal (car create-list
))
4780 (setq create-list
(cdr create-list
))))))))
4782 (defconst directory-files-no-dot-files-regexp
4783 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4784 "Regexp matching any file name except \".\" and \"..\".")
4786 (defun delete-directory (directory &optional recursive trash
)
4787 "Delete the directory named DIRECTORY. Does not follow symlinks.
4788 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4789 TRASH non-nil means to trash the directory instead, provided
4790 `delete-by-moving-to-trash' is non-nil.
4792 When called interactively, TRASH is t if no prefix argument is
4793 given. With a prefix argument, TRASH is nil."
4795 (let* ((trashing (and delete-by-moving-to-trash
4796 (null current-prefix-arg
)))
4797 (dir (expand-file-name
4800 "Move directory to trash: "
4801 "Delete directory: ")
4802 default-directory default-directory nil nil
))))
4804 (if (directory-files dir nil directory-files-no-dot-files-regexp
)
4806 (format "Directory `%s' is not empty, really %s? "
4807 dir
(if trashing
"trash" "delete")))
4809 (null current-prefix-arg
))))
4810 ;; If default-directory is a remote directory, make sure we find its
4811 ;; delete-directory handler.
4812 (setq directory
(directory-file-name (expand-file-name directory
)))
4813 (let ((handler (find-file-name-handler directory
'delete-directory
)))
4816 (funcall handler
'delete-directory directory recursive
))
4817 ((and delete-by-moving-to-trash trash
)
4818 ;; Only move non-empty dir to trash if recursive deletion was
4819 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4820 ;; case, where the operation fails in delete-directory-internal.
4821 ;; As `move-file-to-trash' trashes directories (empty or
4822 ;; otherwise) as a unit, we do not need to recurse here.
4823 (if (and (not recursive
)
4824 ;; Check if directory is empty apart from "." and "..".
4826 directory
'full directory-files-no-dot-files-regexp
))
4827 (error "Directory is not empty, not moving to trash")
4828 (move-file-to-trash directory
)))
4829 ;; Otherwise, call outselves recursively if needed.
4831 (if (and recursive
(not (file-symlink-p directory
)))
4832 (mapc (lambda (file)
4833 ;; This test is equivalent to
4834 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4835 ;; but more efficient
4836 (if (eq t
(car (file-attributes file
)))
4837 (delete-directory file recursive nil
)
4838 (delete-file file nil
)))
4839 ;; We do not want to delete "." and "..".
4841 directory
'full directory-files-no-dot-files-regexp
)))
4842 (delete-directory-internal directory
)))))
4844 (defun copy-directory (directory newname
&optional keep-time parents copy-contents
)
4845 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4846 This function always sets the file modes of the output files to match
4847 the corresponding input file.
4849 The third arg KEEP-TIME non-nil means give the output files the same
4850 last-modified time as the old ones. (This works on only some systems.)
4852 A prefix arg makes KEEP-TIME non-nil.
4854 Noninteractively, the last argument PARENTS says whether to
4855 create parent directories if they don't exist. Interactively,
4856 this happens by default.
4858 If NEWNAME names an existing directory, copy DIRECTORY as a
4859 subdirectory there. However, if called from Lisp with a non-nil
4860 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
4861 directly into NEWNAME instead."
4863 (let ((dir (read-directory-name
4864 "Copy directory: " default-directory default-directory t nil
)))
4867 (format "Copy directory %s to: " dir
)
4868 default-directory default-directory nil nil
)
4869 current-prefix-arg t nil
)))
4870 ;; If default-directory is a remote directory, make sure we find its
4871 ;; copy-directory handler.
4872 (let ((handler (or (find-file-name-handler directory
'copy-directory
)
4873 (find-file-name-handler newname
'copy-directory
))))
4875 (funcall handler
'copy-directory directory newname keep-time parents
)
4877 ;; Compute target name.
4878 (setq directory
(directory-file-name (expand-file-name directory
))
4879 newname
(directory-file-name (expand-file-name newname
)))
4881 (cond ((not (file-directory-p newname
))
4882 ;; If NEWNAME is not an existing directory, create it;
4883 ;; that is where we will copy the files of DIRECTORY.
4884 (make-directory newname parents
))
4885 ;; If NEWNAME is an existing directory and COPY-CONTENTS
4886 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
4887 ((not copy-contents
)
4888 (setq newname
(expand-file-name
4889 (file-name-nondirectory
4890 (directory-file-name directory
))
4892 (and (file-exists-p newname
)
4893 (not (file-directory-p newname
))
4894 (error "Cannot overwrite non-directory %s with a directory"
4896 (make-directory newname t
)))
4898 ;; Copy recursively.
4900 ;; We do not want to copy "." and "..".
4901 (directory-files directory
'full
4902 directory-files-no-dot-files-regexp
))
4903 (if (file-directory-p file
)
4904 (copy-directory file newname keep-time parents
)
4905 (let ((target (expand-file-name (file-name-nondirectory file
) newname
))
4906 (attrs (file-attributes file
)))
4907 (if (stringp (car attrs
)) ; Symbolic link
4908 (make-symbolic-link (car attrs
) target t
)
4909 (copy-file file target t keep-time
)))))
4911 ;; Set directory attributes.
4912 (set-file-modes newname
(file-modes directory
))
4914 (set-file-times newname
(nth 5 (file-attributes directory
)))))))
4916 (put 'revert-buffer-function
'permanent-local t
)
4917 (defvar revert-buffer-function nil
4918 "Function to use to revert this buffer, or nil to do the default.
4919 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4920 which are the arguments that `revert-buffer' received.")
4922 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
4923 (defvar revert-buffer-insert-file-contents-function nil
4924 "Function to use to insert contents when reverting this buffer.
4925 Gets two args, first the nominal file name to use,
4926 and second, t if reading the auto-save file.
4928 The function you specify is responsible for updating (or preserving) point.")
4930 (defvar buffer-stale-function nil
4931 "Function to check whether a non-file buffer needs reverting.
4932 This should be a function with one optional argument NOCONFIRM.
4933 Auto Revert Mode passes t for NOCONFIRM. The function should return
4934 non-nil if the buffer should be reverted. A return value of
4935 `fast' means that the need for reverting was not checked, but
4936 that reverting the buffer is fast. The buffer is current when
4937 this function is called.
4939 The idea behind the NOCONFIRM argument is that it should be
4940 non-nil if the buffer is going to be reverted without asking the
4941 user. In such situations, one has to be careful with potentially
4942 time consuming operations.
4944 For more information on how this variable is used by Auto Revert mode,
4945 see Info node `(emacs)Supporting additional buffers'.")
4947 (defvar before-revert-hook nil
4948 "Normal hook for `revert-buffer' to run before reverting.
4949 If `revert-buffer-function' is used to override the normal revert
4950 mechanism, this hook is not used.")
4952 (defvar after-revert-hook nil
4953 "Normal hook for `revert-buffer' to run after reverting.
4954 Note that the hook value that it runs is the value that was in effect
4955 before reverting; that makes a difference if you have buffer-local
4958 If `revert-buffer-function' is used to override the normal revert
4959 mechanism, this hook is not used.")
4961 (defvar revert-buffer-internal-hook
)
4963 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
4964 "Replace current buffer text with the text of the visited file on disk.
4965 This undoes all changes since the file was visited or saved.
4966 With a prefix argument, offer to revert from latest auto-save file, if
4967 that is more recent than the visited file.
4969 This command also implements an interface for special buffers
4970 that contain text which doesn't come from a file, but reflects
4971 some other data instead (e.g. Dired buffers, `buffer-list'
4972 buffers). This is done via the variable `revert-buffer-function'.
4973 In these cases, it should reconstruct the buffer contents from the
4976 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4977 to revert from the auto-save file when this is nil. Note that the
4978 sense of this argument is the reverse of the prefix argument, for the
4979 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4982 Optional second argument NOCONFIRM means don't ask for confirmation
4983 at all. \(The variable `revert-without-query' offers another way to
4984 revert buffers without querying for confirmation.)
4986 Optional third argument PRESERVE-MODES non-nil means don't alter
4987 the files modes. Normally we reinitialize them using `normal-mode'.
4989 If the value of `revert-buffer-function' is non-nil, it is called to
4990 do all the work for this command. Otherwise, the hooks
4991 `before-revert-hook' and `after-revert-hook' are run at the beginning
4992 and the end, and if `revert-buffer-insert-file-contents-function' is
4993 non-nil, it is called instead of rereading visited file contents."
4995 ;; I admit it's odd to reverse the sense of the prefix argument, but
4996 ;; there is a lot of code out there which assumes that the first
4997 ;; argument should be t to avoid consulting the auto-save file, and
4998 ;; there's no straightforward way to encourage authors to notice a
4999 ;; reversal of the argument sense. So I'm just changing the user
5000 ;; interface, but leaving the programmatic interface the same.
5001 (interactive (list (not current-prefix-arg
)))
5002 (if revert-buffer-function
5003 (funcall revert-buffer-function ignore-auto noconfirm
)
5004 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5006 (let* ((auto-save-p (and (not ignore-auto
)
5007 (recent-auto-save-p)
5008 buffer-auto-save-file-name
5009 (file-readable-p buffer-auto-save-file-name
)
5011 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5012 (file-name (if auto-save-p
5013 buffer-auto-save-file-name
5015 (cond ((null file-name
)
5016 (error "Buffer does not seem to be associated with any file"))
5018 (and (not (buffer-modified-p))
5020 (dolist (regexp revert-without-query
)
5021 (when (string-match regexp file-name
)
5022 (throw 'found t
)))))
5023 (yes-or-no-p (format "Revert buffer from file %s? "
5025 (run-hooks 'before-revert-hook
)
5026 ;; If file was backed up but has changed since,
5027 ;; we should make another backup.
5028 (and (not auto-save-p
)
5029 (not (verify-visited-file-modtime (current-buffer)))
5030 (setq buffer-backed-up nil
))
5031 ;; Effectively copy the after-revert-hook status,
5032 ;; since after-find-file will clobber it.
5033 (let ((global-hook (default-value 'after-revert-hook
))
5034 (local-hook (when (local-variable-p 'after-revert-hook
)
5036 (inhibit-read-only t
))
5038 (revert-buffer-insert-file-contents-function
5039 (unless (eq buffer-undo-list t
)
5040 ;; Get rid of all undo records for this buffer.
5041 (setq buffer-undo-list nil
))
5042 ;; Don't make undo records for the reversion.
5043 (let ((buffer-undo-list t
))
5044 (funcall revert-buffer-insert-file-contents-function
5045 file-name auto-save-p
)))
5046 ((not (file-exists-p file-name
))
5047 (error (if buffer-file-number
5048 "File %s no longer exists!"
5049 "Cannot revert nonexistent file %s")
5051 ((not (file-readable-p file-name
))
5052 (error (if buffer-file-number
5053 "File %s no longer readable!"
5054 "Cannot revert unreadable file %s")
5057 ;; Bind buffer-file-name to nil
5058 ;; so that we don't try to lock the file.
5059 (let ((buffer-file-name nil
))
5063 (let ((coding-system-for-read
5064 ;; Auto-saved file should be read by Emacs'
5066 (if auto-save-p
'auto-save-coding
5067 (or coding-system-for-read
5069 buffer-file-coding-system-explicit
5070 (car buffer-file-coding-system-explicit
))))))
5071 (if (and (not enable-multibyte-characters
)
5072 coding-system-for-read
5073 (not (memq (coding-system-base
5074 coding-system-for-read
)
5075 '(no-conversion raw-text
))))
5076 ;; As a coding system suitable for multibyte
5077 ;; buffer is specified, make the current
5078 ;; buffer multibyte.
5079 (set-buffer-multibyte t
))
5081 ;; This force after-insert-file-set-coding
5082 ;; (called from insert-file-contents) to set
5083 ;; buffer-file-coding-system to a proper value.
5084 (kill-local-variable 'buffer-file-coding-system
)
5086 ;; Note that this preserves point in an intelligent way.
5088 (let ((buffer-file-format buffer-file-format
))
5089 (insert-file-contents file-name
(not auto-save-p
)
5091 (insert-file-contents file-name
(not auto-save-p
)
5093 ;; Recompute the truename in case changes in symlinks
5094 ;; have changed the truename.
5095 (setq buffer-file-truename
5096 (abbreviate-file-name (file-truename buffer-file-name
)))
5097 (after-find-file nil nil t t preserve-modes
)
5098 ;; Run after-revert-hook as it was before we reverted.
5099 (setq-default revert-buffer-internal-hook global-hook
)
5101 (set (make-local-variable 'revert-buffer-internal-hook
)
5103 (kill-local-variable 'revert-buffer-internal-hook
))
5104 (run-hooks 'revert-buffer-internal-hook
))
5107 (defun recover-this-file ()
5108 "Recover the visited file--get contents from its last auto-save file."
5110 (recover-file buffer-file-name
))
5112 (defun recover-file (file)
5113 "Visit file FILE, but get contents from its last auto-save file."
5114 ;; Actually putting the file name in the minibuffer should be used
5116 ;; Not just because users often use the default.
5117 (interactive "FRecover file: ")
5118 (setq file
(expand-file-name file
))
5119 (if (auto-save-file-name-p (file-name-nondirectory file
))
5120 (error "%s is an auto-save file" (abbreviate-file-name file
)))
5121 (let ((file-name (let ((buffer-file-name file
))
5122 (make-auto-save-file-name))))
5123 (cond ((if (file-exists-p file
)
5124 (not (file-newer-than-file-p file-name file
))
5125 (not (file-exists-p file-name
)))
5126 (error "Auto-save file %s not current"
5127 (abbreviate-file-name file-name
)))
5128 ((save-window-excursion
5129 (with-output-to-temp-buffer "*Directory*"
5130 (buffer-disable-undo standard-output
)
5132 (let ((switches dired-listing-switches
))
5133 (if (file-symlink-p file
)
5134 (setq switches
(concat switches
"L")))
5135 (set-buffer standard-output
)
5136 ;; Use insert-directory-safely, not insert-directory,
5137 ;; because these files might not exist. In particular,
5138 ;; FILE might not exist if the auto-save file was for
5139 ;; a buffer that didn't visit a file, such as "*mail*".
5140 ;; The code in v20.x called `ls' directly, so we need
5141 ;; to emulate what `ls' did in that case.
5142 (insert-directory-safely file switches
)
5143 (insert-directory-safely file-name switches
))))
5144 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
5145 (switch-to-buffer (find-file-noselect file t
))
5146 (let ((inhibit-read-only t
)
5147 ;; Keep the current buffer-file-coding-system.
5148 (coding-system buffer-file-coding-system
)
5149 ;; Auto-saved file should be read with special coding.
5150 (coding-system-for-read 'auto-save-coding
))
5152 (insert-file-contents file-name nil
)
5153 (set-buffer-file-coding-system coding-system
))
5154 (after-find-file nil nil t
))
5155 (t (error "Recover-file cancelled")))))
5157 (defun recover-session ()
5158 "Recover auto save files from a previous Emacs session.
5159 This command first displays a Dired buffer showing you the
5160 previous sessions that you could recover from.
5161 To choose one, move point to the proper line and then type C-c C-c.
5162 Then you'll be asked about a number of files to recover."
5164 (if (null auto-save-list-file-prefix
)
5165 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5166 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
5167 (unless (file-directory-p dir
)
5168 (make-directory dir t
))
5169 (unless (directory-files dir nil
5170 (concat "\\`" (regexp-quote
5171 (file-name-nondirectory
5172 auto-save-list-file-prefix
)))
5174 (error "No previous sessions to recover")))
5175 (let ((ls-lisp-support-shell-wildcards t
))
5176 (dired (concat auto-save-list-file-prefix
"*")
5177 (concat dired-listing-switches
"t")))
5179 (goto-char (point-min))
5180 (or (looking-at " Move to the session you want to recover,")
5181 (let ((inhibit-read-only t
))
5182 ;; Each line starts with a space
5183 ;; so that Font Lock mode won't highlight the first character.
5184 (insert " Move to the session you want to recover,\n"
5185 " then type C-c C-c to select it.\n\n"
5186 " You can also delete some of these files;\n"
5187 " type d on a line to mark that file for deletion.\n\n"))))
5188 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5189 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
5191 (defun recover-session-finish ()
5192 "Choose one saved session to recover auto-save files from.
5193 This command is used in the special Dired buffer created by
5194 \\[recover-session]."
5196 ;; Get the name of the session file to recover from.
5197 (let ((file (dired-get-filename))
5199 (buffer (get-buffer-create " *recover*")))
5201 (dired-do-flagged-delete t
)
5203 (with-current-buffer buffer
5204 ;; Read in the auto-save-list file.
5206 (insert-file-contents file
)
5207 ;; Loop thru the text of that file
5208 ;; and get out the names of the files to recover.
5210 (let (thisfile autofile
)
5212 ;; This is a pair of lines for a non-file-visiting buffer.
5213 ;; Get the auto-save file name and manufacture
5214 ;; a "visited file name" from that.
5217 ;; If there is no auto-save file name, the
5218 ;; auto-save-list file is probably corrupted.
5221 (buffer-substring-no-properties
5223 (line-end-position)))
5227 (file-name-nondirectory autofile
)
5229 (file-name-directory autofile
))))
5231 ;; This pair of lines is a file-visiting
5232 ;; buffer. Use the visited file name.
5235 (buffer-substring-no-properties
5236 (point) (progn (end-of-line) (point))))
5239 (buffer-substring-no-properties
5240 (point) (progn (end-of-line) (point))))
5242 ;; Ignore a file if its auto-save file does not exist now.
5243 (if (and autofile
(file-exists-p autofile
))
5244 (setq files
(cons thisfile files
)))))
5245 (setq files
(nreverse files
))
5246 ;; The file contains a pair of line for each auto-saved buffer.
5247 ;; The first line of the pair contains the visited file name
5248 ;; or is empty if the buffer was not visiting a file.
5249 ;; The second line is the auto-save file name.
5251 (map-y-or-n-p "Recover %s? "
5254 (save-excursion (recover-file file
))
5256 "Failed to recover `%s'" file
)))
5258 '("file" "files" "recover"))
5259 (message "No files can be recovered from this session now")))
5260 (kill-buffer buffer
))))
5262 (defun kill-buffer-ask (buffer)
5263 "Kill BUFFER if confirmed."
5264 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5265 (buffer-name buffer
)
5266 (if (buffer-modified-p buffer
)
5267 "HAS BEEN EDITED" "is unmodified")))
5268 (kill-buffer buffer
)))
5270 (defun kill-some-buffers (&optional list
)
5271 "Kill some buffers. Asks the user whether to kill each one of them.
5272 Non-interactively, if optional argument LIST is non-nil, it
5273 specifies the list of buffers to kill, asking for approval for each one."
5276 (setq list
(buffer-list)))
5278 (let* ((buffer (car list
))
5279 (name (buffer-name buffer
)))
5280 (and name
; Can be nil for an indirect buffer
5281 ; if we killed the base buffer.
5282 (not (string-equal name
""))
5283 (/= (aref name
0) ?\s
)
5284 (kill-buffer-ask buffer
)))
5285 (setq list
(cdr list
))))
5287 (defun kill-matching-buffers (regexp &optional internal-too
)
5288 "Kill buffers whose name matches the specified REGEXP.
5289 The optional second argument indicates whether to kill internal buffers too."
5290 (interactive "sKill buffers matching this regular expression: \nP")
5291 (dolist (buffer (buffer-list))
5292 (let ((name (buffer-name buffer
)))
5293 (when (and name
(not (string-equal name
""))
5294 (or internal-too
(/= (aref name
0) ?\s
))
5295 (string-match regexp name
))
5296 (kill-buffer-ask buffer
)))))
5299 (defun rename-auto-save-file ()
5300 "Adjust current buffer's auto save file name for current conditions.
5301 Also rename any existing auto save file, if it was made in this session."
5302 (let ((osave buffer-auto-save-file-name
))
5303 (setq buffer-auto-save-file-name
5304 (make-auto-save-file-name))
5305 (if (and osave buffer-auto-save-file-name
5306 (not (string= buffer-auto-save-file-name buffer-file-name
))
5307 (not (string= buffer-auto-save-file-name osave
))
5308 (file-exists-p osave
)
5309 (recent-auto-save-p))
5310 (rename-file osave buffer-auto-save-file-name t
))))
5312 (defun make-auto-save-file-name ()
5313 "Return file name to use for auto-saves of current buffer.
5314 Does not consider `auto-save-visited-file-name' as that variable is checked
5315 before calling this function. You can redefine this for customization.
5316 See also `auto-save-file-name-p'."
5317 (if buffer-file-name
5318 (let ((handler (find-file-name-handler buffer-file-name
5319 'make-auto-save-file-name
)))
5321 (funcall handler
'make-auto-save-file-name
)
5322 (let ((list auto-save-file-name-transforms
)
5323 (filename buffer-file-name
)
5325 ;; Apply user-specified translations
5326 ;; to the file name.
5327 (while (and list
(not result
))
5328 (if (string-match (car (car list
)) filename
)
5329 (setq result
(replace-match (cadr (car list
)) t nil
5331 uniq
(car (cddr (car list
)))))
5332 (setq list
(cdr list
)))
5335 (setq filename
(concat
5336 (file-name-directory result
)
5337 (subst-char-in-string
5339 (replace-regexp-in-string "!" "!!"
5341 (setq filename result
)))
5343 (if (and (eq system-type
'ms-dos
)
5344 (not (msdos-long-file-names)))
5345 ;; We truncate the file name to DOS 8+3 limits
5346 ;; before doing anything else, because the regexp
5347 ;; passed to string-match below cannot handle
5348 ;; extensions longer than 3 characters, multiple
5349 ;; dots, and other atrocities.
5350 (let ((fn (dos-8+3-filename
5351 (file-name-nondirectory buffer-file-name
))))
5353 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5355 (concat (file-name-directory buffer-file-name
)
5356 "#" (match-string 1 fn
)
5357 "." (match-string 3 fn
) "#"))
5358 (concat (file-name-directory filename
)
5360 (file-name-nondirectory filename
)
5362 ;; Make sure auto-save file names don't contain characters
5363 ;; invalid for the underlying filesystem.
5364 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5365 ;; Don't modify remote (ange-ftp) filenames
5366 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
5367 (convert-standard-filename result
)
5370 ;; Deal with buffers that don't have any associated files. (Mail
5371 ;; mode tends to create a good number of these.)
5373 (let ((buffer-name (buffer-name))
5376 ;; Restrict the characters used in the file name to those which
5377 ;; are known to be safe on all filesystems, url-encoding the
5379 ;; We do this on all platforms, because even if we are not
5380 ;; running on DOS/Windows, the current directory may be on a
5381 ;; mounted VFAT filesystem, such as a USB memory stick.
5382 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
5383 (let* ((character (aref buffer-name
(match-beginning 0)))
5385 ;; For multibyte characters, this will produce more than
5386 ;; 2 hex digits, so is not true URL encoding.
5387 (format "%%%02X" character
)))
5388 (setq buffer-name
(replace-match replacement t t buffer-name
))
5389 (setq limit
(1+ (match-end 0)))))
5390 ;; Generate the file name.
5395 (format "#%s#" buffer-name
)
5396 ;; Try a few alternative directories, to get one we can
5399 ((file-writable-p default-directory
) default-directory
)
5400 ((file-writable-p "/var/tmp/") "/var/tmp/")
5402 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5403 ;; Don't modify remote (ange-ftp) filenames
5404 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
5405 ;; The call to convert-standard-filename is in case
5406 ;; buffer-name includes characters not allowed by the
5407 ;; DOS/Windows filesystems. make-temp-file writes to the
5408 ;; file it creates, so we must fix the file name _before_
5409 ;; make-temp-file is called.
5410 (convert-standard-filename fname
)
5413 ;; make-temp-file creates the file,
5414 ;; but we don't want it to exist until we do an auto-save.
5416 (delete-file file-name
)
5420 (defun auto-save-file-name-p (filename)
5421 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5422 FILENAME should lack slashes. You can redefine this for customization."
5423 (string-match "^#.*#$" filename
))
5425 (defun wildcard-to-regexp (wildcard)
5426 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5427 The generated regexp will match a filename only if the filename
5428 matches that wildcard according to shell rules. Only wildcards known
5429 by `sh' are supported."
5430 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
5431 ;; Copy the initial run of non-special characters.
5432 (result (substring wildcard
0 i
))
5433 (len (length wildcard
)))
5434 ;; If no special characters, we're almost done.
5437 (let ((ch (aref wildcard i
))
5445 (eq (aref wildcard
(1+ i
)) ?\
]))
5447 ((eq ch ?\
[) ; [...] maps to regexp char class
5452 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
5455 (if (eq (aref wildcard i
) ?\
])
5460 ((eq (aref wildcard i
) ?^
)
5461 ;; Found "[^". Insert a `\0' character
5462 ;; (which cannot happen in a filename)
5463 ;; into the character class, so that `^'
5464 ;; is not the first character after `[',
5465 ;; and thus non-special in a regexp.
5469 ((eq (aref wildcard i
) ?\
])
5470 ;; I don't think `]' can appear in a
5471 ;; character class in a wildcard, but
5472 ;; let's be general here.
5477 (prog1 ; copy everything upto next `]'.
5480 (setq j
(string-match
5482 (setq i
(if j
(1- j
) (1- len
)))))))
5484 ((eq ch ?
*) "[^\000]*")
5488 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
5489 ((eq ch ??
) "[^\000]")
5490 (t (char-to-string ch
)))))
5492 ;; Shell wildcards should match the entire filename,
5493 ;; not its part. Make the regexp say so.
5494 (concat "\\`" result
"\\'")))
5496 (defcustom list-directory-brief-switches
5498 "Switches for `list-directory' to pass to `ls' for brief listing."
5502 (defcustom list-directory-verbose-switches
5504 "Switches for `list-directory' to pass to `ls' for verbose listing."
5508 (defun file-expand-wildcards (pattern &optional full
)
5509 "Expand wildcard pattern PATTERN.
5510 This returns a list of file names which match the pattern.
5512 If PATTERN is written as an absolute file name,
5513 the values are absolute also.
5515 If PATTERN is written as a relative file name, it is interpreted
5516 relative to the current default directory, `default-directory'.
5517 The file names returned are normally also relative to the current
5518 default directory. However, if FULL is non-nil, they are absolute."
5520 (let* ((nondir (file-name-nondirectory pattern
))
5521 (dirpart (file-name-directory pattern
))
5522 ;; A list of all dirs that DIRPART specifies.
5523 ;; This can be more than one dir
5524 ;; if DIRPART contains wildcards.
5525 (dirs (if (and dirpart
5526 (string-match "[[*?]"
5527 (or (file-remote-p dirpart
'localname
)
5529 (mapcar 'file-name-as-directory
5530 (file-expand-wildcards (directory-file-name dirpart
)))
5534 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
5535 (file-directory-p (directory-file-name (car dirs
))))
5536 (let ((this-dir-contents
5537 ;; Filter out "." and ".."
5539 (mapcar #'(lambda (name)
5540 (unless (string-match "\\`\\.\\.?\\'"
5541 (file-name-nondirectory name
))
5543 (directory-files (or (car dirs
) ".") full
5544 (wildcard-to-regexp nondir
))))))
5547 (if (and (car dirs
) (not full
))
5548 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
5552 (setq dirs
(cdr dirs
)))
5555 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5556 (provide 'files
'(remote-wildcards))
5558 (defun list-directory (dirname &optional verbose
)
5559 "Display a list of files in or matching DIRNAME, a la `ls'.
5560 DIRNAME is globbed by the shell if necessary.
5561 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5562 Actions controlled by variables `list-directory-brief-switches'
5563 and `list-directory-verbose-switches'."
5564 (interactive (let ((pfx current-prefix-arg
))
5565 (list (read-file-name (if pfx
"List directory (verbose): "
5566 "List directory (brief): ")
5567 nil default-directory nil
)
5569 (let ((switches (if verbose list-directory-verbose-switches
5570 list-directory-brief-switches
))
5572 (or dirname
(setq dirname default-directory
))
5573 (setq dirname
(expand-file-name dirname
))
5574 (with-output-to-temp-buffer "*Directory*"
5575 (setq buffer standard-output
)
5576 (buffer-disable-undo standard-output
)
5577 (princ "Directory ")
5580 (with-current-buffer "*Directory*"
5581 (let ((wildcard (not (file-directory-p dirname
))))
5582 (insert-directory dirname switches wildcard
(not wildcard
)))))
5583 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5584 (with-current-buffer buffer
5585 (setq default-directory
5586 (if (file-directory-p dirname
)
5587 (file-name-as-directory dirname
)
5588 (file-name-directory dirname
))))))
5590 (defun shell-quote-wildcard-pattern (pattern)
5591 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5593 PATTERN is assumed to represent a file-name wildcard suitable for the
5594 underlying filesystem. For Unix and GNU/Linux, each character from the
5595 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5596 the parts of the pattern which don't include wildcard characters are
5597 quoted with double quotes.
5599 This function leaves alone existing quote characters (\\ on Unix and \"
5600 on Windows), so PATTERN can use them to quote wildcard characters that
5601 need to be passed verbatim to shell commands."
5604 ((memq system-type
'(ms-dos windows-nt cygwin
))
5605 ;; DOS/Windows don't allow `"' in file names. So if the
5606 ;; argument has quotes, we can safely assume it is already
5607 ;; quoted by the caller.
5608 (if (or (string-match "[\"]" pattern
)
5609 ;; We quote [&()#$'] in case their shell is a port of a
5610 ;; Unixy shell. We quote [,=+] because stock DOS and
5611 ;; Windows shells require that in some cases, such as
5612 ;; passing arguments to batch files that use positional
5613 ;; arguments like %1.
5614 (not (string-match "[ \t;&()#$',=+]" pattern
)))
5619 (while (string-match "[*?]+" pattern beg
)
5620 (setq end
(match-beginning 0)
5621 result
(concat result
(substring pattern beg end
)
5623 (substring pattern end
(match-end 0))
5626 (concat result
(substring pattern beg
) "\""))))
5629 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
5631 (concat (substring pattern
0 (match-beginning 0))
5633 (substring pattern
(match-beginning 0)))
5634 beg
(1+ (match-end 0)))))
5638 (defvar insert-directory-program
(purecopy "ls")
5639 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5641 (defcustom directory-free-space-program
(purecopy "df")
5642 "Program to get the amount of free space on a file system.
5643 We assume the output has the format of `df'.
5644 The value of this variable must be just a command name or file name;
5645 if you want to specify options, use `directory-free-space-args'.
5647 A value of nil disables this feature.
5649 If the function `file-system-info' is defined, it is always used in
5650 preference to the program given by this variable."
5651 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
5654 (defcustom directory-free-space-args
5655 (purecopy (if (eq system-type
'darwin
) "-k" "-Pk"))
5656 "Options to use when running `directory-free-space-program'."
5660 (defun get-free-disk-space (dir)
5661 "Return the amount of free space on directory DIR's file system.
5662 The return value is a string describing the amount of free
5663 space (normally, the number of free 1KB blocks).
5665 This function calls `file-system-info' if it is available, or
5666 invokes the program specified by `directory-free-space-program'
5667 and `directory-free-space-args'. If the system call or program
5668 is unsuccessful, or if DIR is a remote directory, this function
5670 (unless (file-remote-p dir
)
5671 ;; Try to find the number of free blocks. Non-Posix systems don't
5672 ;; always have df, but might have an equivalent system call.
5673 (if (fboundp 'file-system-info
)
5674 (let ((fsinfo (file-system-info dir
)))
5676 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
5677 (setq dir
(expand-file-name dir
))
5680 (when (and directory-free-space-program
5681 ;; Avoid failure if the default directory does
5682 ;; not exist (Bug#2631, Bug#3911).
5683 (let ((default-directory "/"))
5684 (eq (call-process directory-free-space-program
5686 directory-free-space-args
5689 ;; Assume that the "available" column is before the
5690 ;; "capacity" column. Find the "%" and scan backward.
5691 (goto-char (point-min))
5693 (when (re-search-forward
5694 "[[:space:]]+[^[:space:]]+%[^%]*$"
5695 (line-end-position) t
)
5696 (goto-char (match-beginning 0))
5697 (let ((endpt (point)))
5698 (skip-chars-backward "^[:space:]")
5699 (buffer-substring-no-properties (point) endpt
)))))))))
5701 ;; The following expression replaces `dired-move-to-filename-regexp'.
5702 (defvar directory-listing-before-filename-regexp
5703 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5704 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5705 ;; In some locales, month abbreviations are as short as 2 letters,
5706 ;; and they can be followed by ".".
5707 ;; In Breton, a month name can include a quote character.
5708 (month (concat l-or-quote l-or-quote
"+\\.?"))
5710 (yyyy "[0-9][0-9][0-9][0-9]")
5712 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5713 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5714 (zone "[-+][0-2][0-9][0-5][0-9]")
5715 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5716 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5717 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5718 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5719 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5721 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5722 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5723 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5724 ;; omits the Kanji characters after month and day-of-month.
5725 ;; On Mac OS X 10.3, the date format in East Asian locales is
5726 ;; day-of-month digits followed by month digits.
5729 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5730 "\\|" dd s mm s
"+" "\\)"
5731 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5732 ;; The "[0-9]" below requires the previous column to end in a digit.
5733 ;; This avoids recognizing `1 may 1997' as a date in the line:
5734 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5736 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5738 ;; For non-iso date formats, we add the ".*" in order to find
5739 ;; the last possible match. This avoids recognizing
5740 ;; `jservice 10 1024' as a date in the line:
5741 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5743 ;; vc dired listings provide the state or blanks between file
5744 ;; permissions and date. The state is always surrounded by
5746 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5747 ;; This is not supported yet.
5748 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5749 "\\|.*[0-9][BkKMGTPEZY]? "
5750 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\)"
5752 "Regular expression to match up to the file name in a directory listing.
5753 The default value is designed to recognize dates and times
5754 regardless of the language.")
5756 (defvar insert-directory-ls-version
'unknown
)
5759 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5760 ;; FULL-DIRECTORY-P is nil.
5761 ;; The single line of output must display FILE's name as it was
5762 ;; given, namely, an absolute path name.
5763 ;; - must insert exactly one line for each file if WILDCARD or
5764 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5765 ;; before the file lines, plus optional text after the file lines.
5766 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5768 ;; File lines should display the basename.
5769 ;; - must be consistent with
5770 ;; - functions dired-move-to-filename, (these two define what a file line is)
5771 ;; dired-move-to-end-of-filename,
5772 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5773 ;; dired-insert-headerline
5774 ;; dired-after-subdir-garbage (defines what a "total" line is)
5775 ;; - variable dired-subdir-regexp
5776 ;; - may be passed "--dired" as the first argument in SWITCHES.
5777 ;; Filename handlers might have to remove this switch if their
5778 ;; "ls" command does not support it.
5779 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
5780 "Insert directory listing for FILE, formatted according to SWITCHES.
5781 Leaves point after the inserted text.
5782 SWITCHES may be a string of options, or a list of strings
5783 representing individual options.
5784 Optional third arg WILDCARD means treat FILE as shell wildcard.
5785 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5786 switches do not contain `d', so that a full listing is expected.
5788 This works by running a directory listing program
5789 whose name is in the variable `insert-directory-program'.
5790 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5792 When SWITCHES contains the long `--dired' option, this function
5793 treats it specially, for the sake of dired. However, the
5794 normally equivalent short `-D' option is just passed on to
5795 `insert-directory-program', as any other option."
5796 ;; We need the directory in order to find the right handler.
5797 (let ((handler (find-file-name-handler (expand-file-name file
)
5798 'insert-directory
)))
5800 (funcall handler
'insert-directory file switches
5801 wildcard full-directory-p
)
5802 (let (result (beg (point)))
5804 ;; Read the actual directory using `insert-directory-program'.
5805 ;; RESULT gets the status code.
5806 (let* (;; We at first read by no-conversion, then after
5807 ;; putting text property `dired-filename, decode one
5808 ;; bunch by one to preserve that property.
5809 (coding-system-for-read 'no-conversion
)
5810 ;; This is to control encoding the arguments in call-process.
5811 (coding-system-for-write
5812 (and enable-multibyte-characters
5813 (or file-name-coding-system
5814 default-file-name-coding-system
))))
5817 ;; Run ls in the directory part of the file pattern
5818 ;; using the last component as argument.
5819 (let ((default-directory
5820 (if (file-name-absolute-p file
)
5821 (file-name-directory file
)
5822 (file-name-directory (expand-file-name file
))))
5823 (pattern (file-name-nondirectory file
)))
5825 shell-file-name nil t nil
5827 (concat (if (memq system-type
'(ms-dos windows-nt
))
5829 "\\") ; Disregard Unix shell aliases!
5830 insert-directory-program
5832 (if (stringp switches
)
5834 (mapconcat 'identity switches
" "))
5836 ;; Quote some characters that have
5837 ;; special meanings in shells; but
5838 ;; don't quote the wildcards--we want
5839 ;; them to be special. We also
5840 ;; currently don't quote the quoting
5841 ;; characters in case people want to
5842 ;; use them explicitly to quote
5843 ;; wildcard characters.
5844 (shell-quote-wildcard-pattern pattern
))))
5845 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5846 ;; directory if FILE is a symbolic link.
5847 (unless full-directory-p
5849 (if (stringp switches
)
5850 (concat switches
" -d")
5851 (add-to-list 'switches
"-d" 'append
))))
5852 (apply 'call-process
5853 insert-directory-program nil t nil
5855 (if (listp switches
) switches
5856 (unless (equal switches
"")
5857 ;; Split the switches at any spaces so we can
5858 ;; pass separate options as separate args.
5859 (split-string switches
)))
5860 ;; Avoid lossage if FILE starts with `-'.
5863 (if (string-match "\\`~" file
)
5864 (setq file
(expand-file-name file
)))
5866 (if full-directory-p
5867 (concat (file-name-as-directory file
) ".")
5870 ;; If we got "//DIRED//" in the output, it means we got a real
5871 ;; directory listing, even if `ls' returned nonzero.
5872 ;; So ignore any errors.
5873 (when (if (stringp switches
)
5874 (string-match "--dired\\>" switches
)
5875 (member "--dired" switches
))
5878 (when (looking-at "//SUBDIRED//")
5880 (if (looking-at "//DIRED//")
5883 (when (and (not (eq 0 result
))
5884 (eq insert-directory-ls-version
'unknown
))
5885 ;; The first time ls returns an error,
5886 ;; find the version numbers of ls,
5887 ;; and set insert-directory-ls-version
5888 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5889 ;; is equal or if the info cannot be obtained.
5890 ;; (That can mean it isn't GNU ls.)
5893 (call-process "ls" nil t nil
"--version")
5895 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
5896 (let* ((version (match-string 1 version-out
))
5897 (split (split-string version
"[.]"))
5898 (numbers (mapcar 'string-to-number split
))
5901 (while (and (not comparison
) (or numbers min
))
5903 (setq comparison
'>))
5905 (setq comparison
'<))
5906 ((> (car numbers
) (car min
))
5907 (setq comparison
'>))
5908 ((< (car numbers
) (car min
))
5909 (setq comparison
'<))
5911 (setq numbers
(cdr numbers
)
5913 (setq insert-directory-ls-version
(or comparison
'=)))
5914 (setq insert-directory-ls-version nil
))))
5916 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5917 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
5920 ;; If `insert-directory-program' failed, signal an error.
5921 (unless (eq 0 result
)
5922 ;; Delete the error message it may have output.
5923 (delete-region beg
(point))
5924 ;; On non-Posix systems, we cannot open a directory, so
5925 ;; don't even try, because that will always result in
5926 ;; the ubiquitous "Access denied". Instead, show the
5927 ;; command line so the user can try to guess what went wrong.
5928 (if (and (file-directory-p file
)
5929 (memq system-type
'(ms-dos windows-nt
)))
5931 "Reading directory: \"%s %s -- %s\" exited with status %s"
5932 insert-directory-program
5933 (if (listp switches
) (concat switches
) switches
)
5935 ;; Unix. Access the file to get a suitable error.
5936 (access-file file
"Reading directory")
5937 (error "Listing directory failed but `access-file' worked")))
5939 (when (if (stringp switches
)
5940 (string-match "--dired\\>" switches
)
5941 (member "--dired" switches
))
5942 ;; The following overshoots by one line for an empty
5943 ;; directory listed with "--dired", but without "-a"
5944 ;; switch, where the ls output contains a
5945 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5946 ;; We take care of that case later.
5948 (when (looking-at "//SUBDIRED//")
5949 (delete-region (point) (progn (forward-line 1) (point)))
5951 (if (looking-at "//DIRED//")
5952 (let ((end (line-end-position))
5955 ;; Find all the lines that are error messages,
5956 ;; and record the bounds of each one.
5958 (while (< (point) linebeg
)
5959 (or (eql (following-char) ?\s
)
5960 (push (list (point) (line-end-position)) error-lines
))
5962 (setq error-lines
(nreverse error-lines
))
5963 ;; Now read the numeric positions of file names.
5967 (while (< (point) end
)
5968 (let ((start (insert-directory-adj-pos
5969 (+ beg
(read (current-buffer)))
5971 (end (insert-directory-adj-pos
5972 (+ beg
(read (current-buffer)))
5974 (if (memq (char-after end
) '(?
\n ?\s
))
5975 ;; End is followed by \n or by " -> ".
5976 (put-text-property start end
'dired-filename t
)
5977 ;; It seems that we can't trust ls's output as to
5978 ;; byte positions of filenames.
5979 (put-text-property beg
(point) 'dired-filename nil
)
5983 (delete-region (point) (progn (forward-line 1) (point))))
5984 ;; Take care of the case where the ls output contains a
5985 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5986 ;; and we went one line too far back (see above).
5988 (if (looking-at "//DIRED-OPTIONS//")
5989 (delete-region (point) (progn (forward-line 1) (point)))))
5991 ;; Now decode what read if necessary.
5992 (let ((coding (or coding-system-for-read
5993 file-name-coding-system
5994 default-file-name-coding-system
5998 (when (and enable-multibyte-characters
5999 (not (memq (coding-system-base coding
)
6000 '(raw-text no-conversion
))))
6001 ;; If no coding system is specified or detection is
6002 ;; requested, detect the coding.
6003 (if (eq (coding-system-base coding
) 'undecided
)
6004 (setq coding
(detect-coding-region beg
(point) t
)))
6005 (if (not (eq (coding-system-base coding
) 'undecided
))
6008 (coding-system-change-eol-conversion coding
'unix
))
6009 (narrow-to-region beg
(point))
6010 (goto-char (point-min))
6013 val
(get-text-property (point) 'dired-filename
))
6014 (goto-char (next-single-property-change
6015 (point) 'dired-filename nil
(point-max)))
6016 ;; Force no eol conversion on a file name, so
6017 ;; that CR is preserved.
6018 (decode-coding-region pos
(point)
6019 (if val coding-no-eol coding
))
6021 (put-text-property pos
(point)
6022 'dired-filename t
)))))))
6024 (if full-directory-p
6025 ;; Try to insert the amount of free space.
6028 ;; First find the line to put it on.
6029 (when (re-search-forward "^ *\\(total\\)" nil t
)
6030 (let ((available (get-free-disk-space ".")))
6032 ;; Replace "total" with "used", to avoid confusion.
6033 (replace-match "total used in directory" nil nil nil
1)
6035 (insert " available " available
))))))))))
6037 (defun insert-directory-adj-pos (pos error-lines
)
6038 "Convert `ls --dired' file name position value POS to a buffer position.
6039 File name position values returned in ls --dired output
6040 count only stdout; they don't count the error messages sent to stderr.
6041 So this function converts to them to real buffer positions.
6042 ERROR-LINES is a list of buffer positions of error message lines,
6043 of the form (START END)."
6044 (while (and error-lines
(< (caar error-lines
) pos
))
6045 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
6049 (defun insert-directory-safely (file switches
6050 &optional wildcard full-directory-p
)
6051 "Insert directory listing for FILE, formatted according to SWITCHES.
6053 Like `insert-directory', but if FILE does not exist, it inserts a
6054 message to that effect instead of signaling an error."
6055 (if (file-exists-p file
)
6056 (insert-directory file switches wildcard full-directory-p
)
6057 ;; Simulate the message printed by `ls'.
6058 (insert (format "%s: No such file or directory\n" file
))))
6060 (defvar kill-emacs-query-functions nil
6061 "Functions to call with no arguments to query about killing Emacs.
6062 If any of these functions returns nil, killing Emacs is cancelled.
6063 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6064 the low level primitive, does not. See also `kill-emacs-hook'.")
6066 (defcustom confirm-kill-emacs nil
6067 "How to ask for confirmation when leaving Emacs.
6068 If nil, the default, don't ask at all. If the value is non-nil, it should
6069 be a predicate function such as `yes-or-no-p'."
6070 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
6071 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
6072 (const :tag
"Don't confirm" nil
))
6076 (defun save-buffers-kill-emacs (&optional arg
)
6077 "Offer to save each buffer, then kill this Emacs process.
6078 With prefix ARG, silently save all file-visiting buffers, then kill."
6080 (save-some-buffers arg t
)
6081 (and (or (not (memq t
(mapcar (function
6082 (lambda (buf) (and (buffer-file-name buf
)
6083 (buffer-modified-p buf
))))
6085 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6086 (or (not (fboundp 'process-list
))
6087 ;; process-list is not defined on MSDOS.
6088 (let ((processes (process-list))
6091 (and (memq (process-status (car processes
)) '(run stop open listen
))
6092 (process-query-on-exit-flag (car processes
))
6094 (setq processes
(cdr processes
)))
6097 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
6098 ;; Query the user for other things, perhaps.
6099 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
6100 (or (null confirm-kill-emacs
)
6101 (funcall confirm-kill-emacs
"Really exit Emacs? "))
6104 (defun save-buffers-kill-terminal (&optional arg
)
6105 "Offer to save each buffer, then kill the current connection.
6106 If the current frame has no client, kill Emacs itself.
6108 With prefix ARG, silently save all file-visiting buffers, then kill.
6110 If emacsclient was started with a list of filenames to edit, then
6111 only these files will be asked to be saved."
6113 (if (frame-parameter (selected-frame) 'client
)
6114 (server-save-buffers-kill-terminal arg
)
6115 (save-buffers-kill-emacs arg
)))
6117 ;; We use /: as a prefix to "quote" a file name
6118 ;; so that magic file name handlers will not apply to it.
6120 (setq file-name-handler-alist
6121 (cons (cons (purecopy "\\`/:") 'file-name-non-special
)
6122 file-name-handler-alist
))
6124 ;; We depend on being the last handler on the list,
6125 ;; so that anything else which does need handling
6126 ;; has been handled already.
6127 ;; So it is safe for us to inhibit *all* magic file name handlers.
6129 (defun file-name-non-special (operation &rest arguments
)
6130 (let ((file-name-handler-alist nil
)
6132 (if (eq operation
'insert-directory
)
6133 (directory-file-name
6135 (unhandled-file-name-directory default-directory
)))
6137 ;; Get a list of the indices of the args which are file names.
6139 (cdr (or (assq operation
6140 ;; The first six are special because they
6141 ;; return a file name. We want to include the /:
6142 ;; in the return value.
6143 ;; So just avoid stripping it in the first place.
6144 '((expand-file-name . nil
)
6145 (file-name-directory . nil
)
6146 (file-name-as-directory . nil
)
6147 (directory-file-name . nil
)
6148 (file-name-sans-versions . nil
)
6149 (find-backup-file-name . nil
)
6150 ;; `identity' means just return the first arg
6151 ;; not stripped of its quoting.
6152 (substitute-in-file-name identity
)
6153 ;; `add' means add "/:" to the result.
6154 (file-truename add
0)
6155 (insert-file-contents insert-file-contents
0)
6156 ;; `unquote-then-quote' means set buffer-file-name
6157 ;; temporarily to unquoted filename.
6158 (verify-visited-file-modtime unquote-then-quote
)
6159 ;; List the arguments which are filenames.
6160 (file-name-completion 1)
6161 (file-name-all-completions 1)
6165 (make-symbolic-link 0 1)
6166 (add-name-to-file 0 1)))
6167 ;; For all other operations, treat the first argument only
6168 ;; as the file name.
6171 ;; Copy ARGUMENTS so we can replace elements in it.
6172 (arguments (copy-sequence arguments
)))
6173 (if (symbolp (car file-arg-indices
))
6174 (setq method
(pop file-arg-indices
)))
6175 ;; Strip off the /: from the file names that have it.
6177 (while (consp file-arg-indices
)
6178 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
6180 (string-match "\\`/:" (car pair
))
6182 (if (= (length (car pair
)) 2)
6184 (substring (car pair
) 2)))))
6185 (setq file-arg-indices
(cdr file-arg-indices
))))
6187 (identity (car arguments
))
6188 (add (concat "/:" (apply operation arguments
)))
6189 (insert-file-contents
6190 (let ((visit (nth 1 arguments
)))
6192 (apply operation arguments
)
6193 (when (and visit buffer-file-name
)
6194 (setq buffer-file-name
(concat "/:" buffer-file-name
))))))
6196 (let ((buffer-file-name (substring buffer-file-name
2)))
6197 (apply operation arguments
)))
6199 (apply operation arguments
)))))
6201 ;; Symbolic modes and read-file-modes.
6203 (defun file-modes-char-to-who (char)
6204 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6205 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6206 Others, or All) for whom to produce the mask.
6207 The bit-mask that is returned extracts from mode bits the access rights
6208 for the specified category of users."
6209 (cond ((= char ?u
) #o4700
)
6210 ((= char ?g
) #o2070
)
6211 ((= char ?o
) #o1007
)
6212 ((= char ?a
) #o7777
)
6213 (t (error "%c: bad `who' character" char
))))
6215 (defun file-modes-char-to-right (char &optional from
)
6216 "Convert CHAR to a numeric value of mode bits.
6217 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6218 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6219 (or from
(setq from
0))
6220 (cond ((= char ?r
) #o0444
)
6221 ((= char ?w
) #o0222
)
6222 ((= char ?x
) #o0111
)
6223 ((= char ?s
) #o1000
)
6224 ((= char ?t
) #o6000
)
6225 ;; Rights relative to the previous file modes.
6226 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
6227 ((= char ?u
) (let ((uright (logand #o4700 from
)))
6228 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
6229 ((= char ?g
) (let ((gright (logand #o2070 from
)))
6230 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
6231 ((= char ?o
) (let ((oright (logand #o1007 from
)))
6232 (+ oright
(* oright
#o10
) (* oright
#o100
))))
6233 (t (error "%c: bad right character" char
))))
6235 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
6236 "Convert a symbolic mode string specification to an equivalent number.
6237 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6238 WHO-MASK is the bit-mask specifying the category of users to which to
6239 apply the access permissions. See `file-modes-char-to-who'.
6240 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6241 RIGHTS request to add, remove, or set permissions based on existing ones,
6243 (let* ((num-rights (or from
0))
6244 (list-rights (string-to-list rights
))
6245 (op (pop list-rights
)))
6246 (while (memq op
'(?
+ ?- ?
=))
6249 (while (memq (setq char-right
(pop list-rights
))
6250 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
6253 (file-modes-char-to-right char-right num-rights
))))
6254 (setq num-right
(logand who-mask num-right
)
6256 (cond ((= op ?
+) (logior num-rights num-right
))
6257 ((= op ?-
) (logand num-rights
(lognot num-right
)))
6258 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
6262 (defun file-modes-symbolic-to-number (modes &optional from
)
6263 "Convert symbolic file modes to numeric file modes.
6264 MODES is the string to convert, it should match
6265 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6266 See (info \"(coreutils)File permissions\") for more information on this
6268 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6269 MODES request to add, remove, or set permissions based on existing ones,
6272 (let ((case-fold-search nil
)
6273 (num-modes (or from
0)))
6274 (while (/= (string-to-char modes
) 0)
6275 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes
)
6276 (let ((num-who (apply 'logior
0
6277 (mapcar 'file-modes-char-to-who
6278 (match-string 1 modes
)))))
6280 (setq num-who
(default-file-modes)))
6282 (file-modes-rights-to-number (substring modes
(match-end 1))
6284 modes
(substring modes
(match-end 3))))
6285 (error "Parse error in modes near `%s'" (substring modes
0))))
6288 (defun read-file-modes (&optional prompt orig-file
)
6289 "Read file modes in octal or symbolic notation and return its numeric value.
6290 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6291 ORIG-FILE is the name of a file on whose mode bits to base returned
6292 permissions if what user types requests to add, remove, or set permissions
6293 based on existing mode bits, as in \"og+rX-w\"."
6294 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
6295 (error "File not found")))
6296 (modestr (and (stringp orig-file
)
6297 (nth 8 (file-attributes orig-file
))))
6299 (and (stringp modestr
)
6300 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
6301 (replace-regexp-in-string
6303 (format "u=%s,g=%s,o=%s"
6304 (match-string 1 modestr
)
6305 (match-string 2 modestr
)
6306 (match-string 3 modestr
)))))
6307 (value (read-string (or prompt
"File modes (octal or symbolic): ")
6310 (if (string-match "^[0-7]+" value
)
6311 (string-to-number value
8)
6312 (file-modes-symbolic-to-number value modes
)))))
6315 ;; Trashcan handling.
6316 (defcustom trash-directory nil
6317 "Directory for `move-file-to-trash' to move files and directories to.
6318 This directory is only used when the function `system-move-file-to-trash'
6320 Relative paths are interpreted relative to `default-directory'.
6321 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6322 :type
'(choice (const nil
) directory
)
6326 (defvar trash--hexify-table
)
6328 (declare-function system-move-file-to-trash
"w32fns.c" (filename))
6330 (defun move-file-to-trash (filename)
6331 "Move the file (or directory) named FILENAME to the trash.
6332 When `delete-by-moving-to-trash' is non-nil, this function is
6333 called by `delete-file' and `delete-directory' instead of
6334 deleting files outright.
6336 If the function `system-move-file-to-trash' is defined, call it
6337 with FILENAME as an argument.
6338 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6340 Otherwise, trash FILENAME using the freedesktop.org conventions,
6341 like the GNOME, KDE and XFCE desktop environments. Emacs only
6342 moves files to \"home trash\", ignoring per-volume trashcans."
6343 (interactive "fMove file to trash: ")
6344 (cond (trash-directory
6345 ;; If `trash-directory' is non-nil, move the file there.
6346 (let* ((trash-dir (expand-file-name trash-directory
))
6347 (fn (directory-file-name (expand-file-name filename
)))
6348 (new-fn (expand-file-name (file-name-nondirectory fn
)
6350 ;; We can't trash a parent directory of trash-directory.
6351 (if (string-match fn trash-dir
)
6352 (error "Trash directory `%s' is a subdirectory of `%s'"
6353 trash-dir filename
))
6354 (unless (file-directory-p trash-dir
)
6355 (make-directory trash-dir t
))
6356 ;; Ensure that the trashed file-name is unique.
6357 (if (file-exists-p new-fn
)
6358 (let ((version-control t
)
6359 (backup-directory-alist nil
))
6360 (setq new-fn
(car (find-backup-file-name new-fn
)))))
6361 (let (delete-by-moving-to-trash)
6362 (rename-file fn new-fn
))))
6363 ;; If `system-move-file-to-trash' is defined, use it.
6364 ((fboundp 'system-move-file-to-trash
)
6365 (system-move-file-to-trash filename
))
6366 ;; Otherwise, use the freedesktop.org method, as specified at
6367 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6369 (let* ((xdg-data-dir
6370 (directory-file-name
6371 (expand-file-name "Trash"
6372 (or (getenv "XDG_DATA_HOME")
6373 "~/.local/share"))))
6374 (trash-files-dir (expand-file-name "files" xdg-data-dir
))
6375 (trash-info-dir (expand-file-name "info" xdg-data-dir
))
6376 (fn (directory-file-name (expand-file-name filename
))))
6378 ;; Check if we have permissions to delete.
6379 (unless (file-writable-p (directory-file-name
6380 (file-name-directory fn
)))
6381 (error "Cannot move %s to trash: Permission denied" filename
))
6382 ;; The trashed file cannot be the trash dir or its parent.
6383 (if (string-match fn trash-files-dir
)
6384 (error "The trash directory %s is a subdirectory of %s"
6385 trash-files-dir filename
))
6386 (if (string-match fn trash-info-dir
)
6387 (error "The trash directory %s is a subdirectory of %s"
6388 trash-info-dir filename
))
6390 ;; Ensure that the trash directory exists; otherwise, create it.
6391 (let ((saved-default-file-modes (default-file-modes)))
6392 (set-default-file-modes ?
\700)
6393 (unless (file-exists-p trash-files-dir
)
6394 (make-directory trash-files-dir t
))
6395 (unless (file-exists-p trash-info-dir
)
6396 (make-directory trash-info-dir t
))
6397 (set-default-file-modes saved-default-file-modes
))
6399 ;; Try to move to trash with .trashinfo undo information
6402 (set-buffer-file-coding-system 'utf-8-unix
)
6403 (insert "[Trash Info]\nPath=")
6404 ;; Perform url-encoding on FN. For compatibility with
6405 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6406 ;; for path separators.
6407 (unless (boundp 'trash--hexify-table
)
6408 (setq trash--hexify-table
(make-vector 256 nil
))
6409 (let ((unreserved-chars
6410 (list ?
/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6411 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6412 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6413 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?
0 ?
1 ?
2
6414 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9 ?- ?_ ?. ?
! ?~ ?
* ?
'
6417 (aset trash--hexify-table byte
6418 (if (memq byte unreserved-chars
)
6419 (char-to-string byte
)
6420 (format "%%%02x" byte
))))))
6421 (mapc (lambda (byte)
6422 (insert (aref trash--hexify-table byte
)))
6423 (if (multibyte-string-p fn
)
6424 (encode-coding-string fn
'utf-8
)
6426 (insert "\nDeletionDate="
6427 (format-time-string "%Y-%m-%dT%T")
6430 ;; Attempt to make .trashinfo file, trying up to 5
6431 ;; times. The .trashinfo file is opened with O_EXCL,
6432 ;; as per trash-spec 0.7, even if that can be a problem
6433 ;; on old NFS versions...
6435 (base-fn (expand-file-name
6436 (file-name-nondirectory fn
)
6441 (setq info-fn
(expand-file-name
6442 (concat (file-name-nondirectory new-fn
)
6445 (unless (condition-case nil
6447 (write-region nil nil info-fn nil
6448 'quiet info-fn
'excl
)
6449 (setq tries
0 success t
))
6450 (file-already-exists nil
))
6451 (setq tries
(1- tries
))
6452 ;; Uniqify new-fn. (Some file managers do not
6453 ;; like Emacs-style backup file names---e.g. bug
6454 ;; 170956 in Konqueror bug tracker.)
6455 (setq new-fn
(make-temp-name (concat base-fn
"_")))))
6457 (error "Cannot move %s to trash: Lock failed" filename
))
6459 ;; Finally, try to move the file to the trashcan.
6460 (let ((delete-by-moving-to-trash nil
))
6461 (rename-file fn new-fn
)))))))))
6464 (define-key ctl-x-map
"\C-f" 'find-file
)
6465 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
6466 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
6467 (define-key ctl-x-map
"\C-s" 'save-buffer
)
6468 (define-key ctl-x-map
"s" 'save-some-buffers
)
6469 (define-key ctl-x-map
"\C-w" 'write-file
)
6470 (define-key ctl-x-map
"i" 'insert-file
)
6471 (define-key esc-map
"~" 'not-modified
)
6472 (define-key ctl-x-map
"\C-d" 'list-directory
)
6473 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
6474 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
6476 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
6477 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
6478 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
6479 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
6480 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
6482 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
6483 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
6484 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
6485 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
6486 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
6488 ;;; files.el ends here