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 (search-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 search-path
(concat search-path path-separator
))
646 (while (setq cd-colon
(string-match path-separator search-path cd-start
))
649 (list (if (= cd-start cd-colon
)
651 (substitute-in-file-name
652 (file-name-as-directory
653 (substring search-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
))
869 ;; `user' is not initialized outside the loop because
870 ;; `file' may not exist, so we may have to walk up part of the
871 ;; hierarchy before we find the "initial UID". Note: currently unused
876 ;; FIXME: Disabled this heuristic because it is sometimes
878 ;; As a heuristic, we stop looking up the hierarchy of
879 ;; directories as soon as we find a directory belonging
880 ;; to another user. This should save us from looking in
881 ;; things like /net and /afs. This assumes that all the
882 ;; files inside a project belong to the same user.
883 ;; (let ((prev-user user))
884 ;; (setq user (nth 2 (file-attributes file)))
885 ;; (and prev-user (not (equal user prev-user))))
886 (string-match locate-dominating-stop-dir-regexp file
)))
887 (setq try
(file-exists-p (expand-file-name name file
)))
888 (cond (try (setq root file
))
889 ((equal file
(setq file
(file-name-directory
890 (directory-file-name file
))))
895 (defun executable-find (command)
896 "Search for COMMAND in `exec-path' and return the absolute file name.
897 Return nil if COMMAND is not found anywhere in `exec-path'."
898 ;; Use 1 rather than file-executable-p to better match the behavior of
900 (locate-file command exec-path exec-suffixes
1))
902 (defun load-library (library)
903 "Load the Emacs Lisp library named LIBRARY.
904 This is an interface to the function `load'. LIBRARY is searched
905 for in `load-path', both with and without `load-suffixes' (as
906 well as `load-file-rep-suffixes').
908 See Info node `(emacs)Lisp Libraries' for more details.
909 See `load-file' for a different interface to `load'."
911 (list (completing-read "Load library: "
912 (apply-partially 'locate-file-completion-table
914 (get-load-suffixes)))))
917 (defun file-remote-p (file &optional identification connected
)
918 "Test whether FILE specifies a location on a remote system.
919 Returns nil or a string identifying the remote connection (ideally
920 a prefix of FILE). For example, the remote identification for filename
921 \"/user@host:/foo\" could be \"/user@host:\".
922 A file is considered \"remote\" if accessing it is likely to be slower or
923 less reliable than accessing local files.
924 Furthermore, relative file names do not work across remote connections.
926 IDENTIFICATION specifies which part of the identification shall
927 be returned as string. IDENTIFICATION can be the symbol
928 `method', `user', `host' or `localname'; any other value is
929 handled like nil and means to return the complete identification
932 If CONNECTED is non-nil, the function returns an identification only
933 if FILE is located on a remote system, and a connection is established
934 to that remote system.
936 `file-remote-p' will never open a connection on its own."
937 (let ((handler (find-file-name-handler file
'file-remote-p
)))
939 (funcall handler
'file-remote-p file identification connected
)
942 (defcustom remote-file-name-inhibit-cache
10
943 "Whether to use the remote file-name cache for read access.
945 When `nil', always use the cached values.
946 When `t', never use them.
947 A number means use them for that amount of seconds since they were
950 File attributes of remote files are cached for better performance.
951 If they are changed out of Emacs' control, the cached values
952 become invalid, and must be invalidated.
954 In case a remote file is checked regularly, it might be
955 reasonable to let-bind this variable to a value less then the
956 time period between two checks.
959 (defun display-time-file-nonempty-p (file)
960 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
961 (and (file-exists-p file)
962 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
966 (const :tag
"Do not inhibit file name cache" nil
)
967 (const :tag
"Do not use file name cache" t
)
968 (integer :tag
"Do not use file name cache"
969 :format
"Do not use file name cache older then %v seconds"
972 (defun file-local-copy (file)
973 "Copy the file FILE into a temporary file on this machine.
974 Returns the name of the local copy, or nil, if FILE is directly
976 ;; This formerly had an optional BUFFER argument that wasn't used by
978 (let ((handler (find-file-name-handler file
'file-local-copy
)))
980 (funcall handler
'file-local-copy file
)
983 (defun file-truename (filename &optional counter prev-dirs
)
984 "Return the truename of FILENAME.
985 If FILENAME is not absolute, first expands it against `default-directory'.
986 The truename of a file name is found by chasing symbolic links
987 both at the level of the file and at the level of the directories
988 containing it, until no links are left at any level.
990 \(fn FILENAME)" ;; Don't document the optional arguments.
991 ;; COUNTER and PREV-DIRS are only used in recursive calls.
992 ;; COUNTER can be a cons cell whose car is the count of how many
993 ;; more links to chase before getting an error.
994 ;; PREV-DIRS can be a cons cell whose car is an alist
995 ;; of truenames we've just recently computed.
996 (cond ((or (string= filename
"") (string= filename
"~"))
997 (setq filename
(expand-file-name filename
))
998 (if (string= filename
"")
999 (setq filename
"/")))
1000 ((and (string= (substring filename
0 1) "~")
1001 (string-match "~[^/]*/?" filename
))
1003 (substring filename
0 (match-end 0)))
1004 (rest (substring filename
(match-end 0))))
1005 (setq filename
(concat (expand-file-name first-part
) rest
)))))
1007 (or counter
(setq counter
(list 100)))
1009 ;; For speed, remove the ange-ftp completion handler from the list.
1010 ;; We know it's not needed here.
1011 ;; For even more speed, do this only on the outermost call.
1012 (file-name-handler-alist
1013 (if prev-dirs file-name-handler-alist
1014 (let ((tem (copy-sequence file-name-handler-alist
)))
1015 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
1016 (or prev-dirs
(setq prev-dirs
(list nil
)))
1018 ;; andrewi@harlequin.co.uk - none of the following code (except for
1019 ;; invoking the file-name handler) currently applies on Windows
1020 ;; (ie. there are no native symlinks), but there is an issue with
1021 ;; case differences being ignored by the OS, and short "8.3 DOS"
1022 ;; name aliases existing for all files. (The short names are not
1023 ;; reported by directory-files, but can be used to refer to files.)
1024 ;; It seems appropriate for file-truename to resolve these issues in
1025 ;; the most natural way, which on Windows is to call the function
1026 ;; `w32-long-file-name' - this returns the exact name of a file as
1027 ;; it is stored on disk (expanding short name aliases with the full
1028 ;; name in the process).
1029 (if (eq system-type
'windows-nt
)
1030 (let ((handler (find-file-name-handler filename
'file-truename
)))
1031 ;; For file name that has a special handler, call handler.
1032 ;; This is so that ange-ftp can save time by doing a no-op.
1034 (setq filename
(funcall handler
'file-truename filename
))
1035 ;; If filename contains a wildcard, newname will be the old name.
1036 (unless (string-match "[[*?]" filename
)
1037 ;; If filename exists, use the long name. If it doesn't exist,
1038 ;; drill down until we find a directory that exists, and use
1039 ;; the long name of that, with the extra non-existent path
1040 ;; components concatenated.
1041 (let ((longname (w32-long-file-name filename
))
1044 (setq filename longname
)
1045 ;; Include the preceding directory separator in the missing
1046 ;; part so subsequent recursion on the rest works.
1047 (setq missing
(concat "/" (file-name-nondirectory filename
)))
1048 (let ((length (length missing
)))
1050 (if (> length
(length filename
))
1052 (substring filename
0 (- length
)))))
1053 (setq filename
(concat (file-truename rest
) missing
))))))
1056 ;; If this file directly leads to a link, process that iteratively
1057 ;; so that we don't use lots of stack.
1059 (setcar counter
(1- (car counter
)))
1060 (if (< (car counter
) 0)
1061 (error "Apparent cycle of symbolic links for %s" filename
))
1062 (let ((handler (find-file-name-handler filename
'file-truename
)))
1063 ;; For file name that has a special handler, call handler.
1064 ;; This is so that ange-ftp can save time by doing a no-op.
1066 (setq filename
(funcall handler
'file-truename filename
)
1068 (let ((dir (or (file-name-directory filename
) default-directory
))
1070 ;; Get the truename of the directory.
1071 (setq dirfile
(directory-file-name dir
))
1072 ;; If these are equal, we have the (or a) root directory.
1073 (or (string= dir dirfile
)
1074 ;; If this is the same dir we last got the truename for,
1075 ;; save time--don't recalculate.
1076 (if (assoc dir
(car prev-dirs
))
1077 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
1079 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
1080 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
1082 (if (equal ".." (file-name-nondirectory filename
))
1084 (directory-file-name (file-name-directory (directory-file-name dir
)))
1086 (if (equal "." (file-name-nondirectory filename
))
1087 (setq filename
(directory-file-name dir
)
1089 ;; Put it back on the file name.
1090 (setq filename
(concat dir
(file-name-nondirectory filename
)))
1091 ;; Is the file name the name of a link?
1092 (setq target
(file-symlink-p filename
))
1094 ;; Yes => chase that link, then start all over
1095 ;; since the link may point to a directory name that uses links.
1096 ;; We can't safely use expand-file-name here
1097 ;; since target might look like foo/../bar where foo
1098 ;; is itself a link. Instead, we handle . and .. above.
1100 (if (file-name-absolute-p target
)
1102 (concat dir target
))
1105 (setq done t
))))))))
1108 (defun file-chase-links (filename &optional limit
)
1109 "Chase links in FILENAME until a name that is not a link.
1110 Unlike `file-truename', this does not check whether a parent
1111 directory name is a symbolic link.
1112 If the optional argument LIMIT is a number,
1113 it means chase no more than that many links and then stop."
1114 (let (tem (newname filename
)
1116 (while (and (or (null limit
) (< count limit
))
1117 (setq tem
(file-symlink-p newname
)))
1119 (if (and (null limit
) (= count
100))
1120 (error "Apparent cycle of symbolic links for %s" filename
))
1121 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1122 (while (string-match "//+" tem
)
1123 (setq tem
(replace-match "/" nil nil tem
)))
1124 ;; Handle `..' by hand, since it needs to work in the
1125 ;; target of any directory symlink.
1126 ;; This code is not quite complete; it does not handle
1127 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1128 (while (string-match "\\`\\.\\./" tem
)
1129 (setq tem
(substring tem
3))
1130 (setq newname
(expand-file-name newname
))
1131 ;; Chase links in the default dir of the symlink.
1134 (directory-file-name (file-name-directory newname
))))
1135 ;; Now find the parent of that dir.
1136 (setq newname
(file-name-directory newname
)))
1137 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
1138 (setq count
(1+ count
))))
1141 ;; A handy function to display file sizes in human-readable form.
1142 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1143 (defun file-size-human-readable (file-size &optional flavor
)
1144 "Produce a string showing FILE-SIZE in human-readable form.
1146 Optional second argument FLAVOR controls the units and the display format:
1148 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1149 suffixes are \"k\", \"M\", \"G\", \"T\", etc.
1150 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1151 are \"k\", \"M\", \"G\", \"T\", etc.
1152 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1153 are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc."
1154 (let ((power (if (or (null flavor
) (eq flavor
'iec
))
1158 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1159 (list "" "k" "M" "G" "T" "P" "E" "Z" "Y")))
1160 (while (and (>= file-size power
) (cdr post-fixes
))
1161 (setq file-size
(/ file-size power
)
1162 post-fixes
(cdr post-fixes
)))
1163 (format (if (> (mod file-size
1.0) 0.05)
1167 (if (and (eq flavor
'iec
) (string= (car post-fixes
) "k"))
1170 (if (eq flavor
'iec
) "iB" ""))))
1172 (defun make-temp-file (prefix &optional dir-flag suffix
)
1173 "Create a temporary file.
1174 The returned file name (created by appending some random characters at the end
1175 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1176 is guaranteed to point to a newly created empty file.
1177 You can then use `write-region' to write new data into the file.
1179 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1181 If SUFFIX is non-nil, add that at the end of the file name."
1182 (let ((umask (default-file-modes))
1186 ;; Create temp files with strict access rights. It's easy to
1187 ;; loosen them later, whereas it's impossible to close the
1188 ;; time-window of loose permissions otherwise.
1189 (set-default-file-modes ?
\700)
1190 (while (condition-case ()
1194 (if (zerop (length prefix
))
1195 (file-name-as-directory
1196 temporary-file-directory
)
1197 (expand-file-name prefix
1198 temporary-file-directory
))))
1200 (setq file
(concat file suffix
)))
1202 (make-directory file
)
1203 (write-region "" nil file nil
'silent nil
'excl
))
1205 (file-already-exists t
))
1206 ;; the file was somehow created by someone else between
1207 ;; `make-temp-name' and `write-region', let's try again.
1211 (set-default-file-modes umask
))))
1213 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
1214 "Change the encoding of FILE's name from CODING to NEW-CODING.
1215 The value is a new name of FILE.
1216 Signals a `file-already-exists' error if a file of the new name
1217 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1218 is non-nil. A number as fourth arg means request confirmation if
1219 the new name already exists. This is what happens in interactive
1222 (let ((default-coding (or file-name-coding-system
1223 default-file-name-coding-system
))
1224 (filename (read-file-name "Recode filename: " nil nil t
))
1225 from-coding to-coding
)
1226 (if (and default-coding
1227 ;; We provide the default coding only when it seems that
1228 ;; the filename is correctly decoded by the default
1230 (let ((charsets (find-charset-string filename
)))
1231 (and (not (memq 'eight-bit-control charsets
))
1232 (not (memq 'eight-bit-graphic charsets
)))))
1233 (setq from-coding
(read-coding-system
1234 (format "Recode filename %s from (default %s): "
1235 filename default-coding
)
1237 (setq from-coding
(read-coding-system
1238 (format "Recode filename %s from: " filename
))))
1240 ;; We provide the default coding only when a user is going to
1241 ;; change the encoding not from the default coding.
1242 (if (eq from-coding default-coding
)
1243 (setq to-coding
(read-coding-system
1244 (format "Recode filename %s from %s to: "
1245 filename from-coding
)))
1246 (setq to-coding
(read-coding-system
1247 (format "Recode filename %s from %s to (default %s): "
1248 filename from-coding default-coding
)
1250 (list filename from-coding to-coding
)))
1252 (let* ((default-coding (or file-name-coding-system
1253 default-file-name-coding-system
))
1254 ;; FILE should have been decoded by DEFAULT-CODING.
1255 (encoded (encode-coding-string file default-coding
))
1256 (newname (decode-coding-string encoded coding
))
1257 (new-encoded (encode-coding-string newname new-coding
))
1258 ;; Suppress further encoding.
1259 (file-name-coding-system nil
)
1260 (default-file-name-coding-system nil
)
1261 (locale-coding-system nil
))
1262 (rename-file encoded new-encoded ok-if-already-exists
)
1265 (defcustom confirm-nonexistent-file-or-buffer
'after-completion
1266 "Whether confirmation is requested before visiting a new file or buffer.
1267 If nil, confirmation is not requested.
1268 If the value is `after-completion', confirmation is only
1269 requested if the user called `minibuffer-complete' right before
1270 `minibuffer-complete-and-exit'.
1271 Any other non-nil value means to request confirmation.
1273 This affects commands like `switch-to-buffer' and `find-file'."
1276 :type
'(choice (const :tag
"After completion" after-completion
)
1277 (const :tag
"Never" nil
)
1278 (other :tag
"Always" t
)))
1280 (defun confirm-nonexistent-file-or-buffer ()
1281 "Whether to request confirmation before visiting a new file or buffer.
1282 The variable `confirm-nonexistent-file-or-buffer' determines the
1283 return value, which may be passed as the REQUIRE-MATCH arg to
1284 `read-buffer' or `find-file-read-args'."
1285 (cond ((eq confirm-nonexistent-file-or-buffer
'after-completion
)
1286 'confirm-after-completion
)
1287 (confirm-nonexistent-file-or-buffer
1291 (defmacro minibuffer-with-setup-hook
(fun &rest body
)
1292 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1293 BODY should use the minibuffer at most once.
1294 Recursive uses of the minibuffer are unaffected (FUN is not
1295 called additional times).
1297 This macro actually adds an auxiliary function that calls FUN,
1298 rather than FUN itself, to `minibuffer-setup-hook'."
1299 (declare (indent 1) (debug t
))
1300 (let ((hook (make-symbol "setup-hook")))
1304 ;; Clear out this hook so it does not interfere
1305 ;; with any recursive minibuffer usage.
1306 (remove-hook 'minibuffer-setup-hook
,hook
)
1310 (add-hook 'minibuffer-setup-hook
,hook
)
1312 (remove-hook 'minibuffer-setup-hook
,hook
)))))
1314 (defun find-file-read-args (prompt mustmatch
)
1315 (list (read-file-name prompt nil default-directory mustmatch
)
1318 (defun find-file (filename &optional wildcards
)
1319 "Edit file FILENAME.
1320 Switch to a buffer visiting file FILENAME,
1321 creating one if none already exists.
1322 Interactively, the default if you just type RET is the current directory,
1323 but the visited file name is available through the minibuffer history:
1324 type M-n to pull it into the minibuffer.
1326 You can visit files on remote machines by specifying something
1327 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1328 also visit local files as a different user by specifying
1329 /sudo::FILE for the file name.
1330 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1331 manual, for more about this.
1333 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1334 expand wildcards (if any) and visit multiple files. You can
1335 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1337 To visit a file without any kind of conversion and without
1338 automatically choosing a major mode, use \\[find-file-literally]."
1340 (find-file-read-args "Find file: "
1341 (confirm-nonexistent-file-or-buffer)))
1342 (let ((value (find-file-noselect filename nil nil wildcards
)))
1344 (mapcar 'switch-to-buffer
(nreverse value
))
1345 (switch-to-buffer value
))))
1347 (defun find-file-other-window (filename &optional wildcards
)
1348 "Edit file FILENAME, in another window.
1350 Like \\[find-file] (which see), but creates a new window or reuses
1351 an existing one. See the function `display-buffer'.
1353 Interactively, the default if you just type RET is the current directory,
1354 but the visited file name is available through the minibuffer history:
1355 type M-n to pull it into the minibuffer.
1357 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1358 expand wildcards (if any) and visit multiple files."
1360 (find-file-read-args "Find file in other window: "
1361 (confirm-nonexistent-file-or-buffer)))
1362 (let ((value (find-file-noselect filename nil nil wildcards
)))
1365 (setq value
(nreverse value
))
1366 (cons (switch-to-buffer-other-window (car value
))
1367 (mapcar 'switch-to-buffer
(cdr value
))))
1368 (switch-to-buffer-other-window value
))))
1370 (defun find-file-other-frame (filename &optional wildcards
)
1371 "Edit file FILENAME, in another frame.
1373 Like \\[find-file] (which see), but creates a new frame or reuses
1374 an existing one. See the function `display-buffer'.
1376 Interactively, the default if you just type RET is the current directory,
1377 but the visited file name is available through the minibuffer history:
1378 type M-n to pull it into the minibuffer.
1380 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1381 expand wildcards (if any) and visit multiple files."
1383 (find-file-read-args "Find file in other frame: "
1384 (confirm-nonexistent-file-or-buffer)))
1385 (let ((value (find-file-noselect filename nil nil wildcards
)))
1388 (setq value
(nreverse value
))
1389 (cons (switch-to-buffer-other-frame (car value
))
1390 (mapcar 'switch-to-buffer
(cdr value
))))
1391 (switch-to-buffer-other-frame value
))))
1393 (defun find-file-existing (filename)
1394 "Edit the existing file FILENAME.
1395 Like \\[find-file], but only allow a file that exists, and do not allow
1396 file names with wildcards."
1397 (interactive (nbutlast (find-file-read-args "Find existing file: " t
)))
1398 (if (and (not (called-interactively-p 'interactive
))
1399 (not (file-exists-p filename
)))
1400 (error "%s does not exist" filename
)
1401 (find-file filename
)
1404 (defun find-file-read-only (filename &optional wildcards
)
1405 "Edit file FILENAME but don't allow changes.
1406 Like \\[find-file], but marks buffer as read-only.
1407 Use \\[toggle-read-only] to permit editing."
1409 (find-file-read-args "Find file read-only: "
1410 (confirm-nonexistent-file-or-buffer)))
1411 (unless (or (and wildcards find-file-wildcards
1412 (not (string-match "\\`/:" filename
))
1413 (string-match "[[*?]" filename
))
1414 (file-exists-p filename
))
1415 (error "%s does not exist" filename
))
1416 (let ((value (find-file filename wildcards
)))
1417 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1418 (if (listp value
) value
(list value
)))
1421 (defun find-file-read-only-other-window (filename &optional wildcards
)
1422 "Edit file FILENAME in another window but don't allow changes.
1423 Like \\[find-file-other-window], but marks buffer as read-only.
1424 Use \\[toggle-read-only] to permit editing."
1426 (find-file-read-args "Find file read-only other window: "
1427 (confirm-nonexistent-file-or-buffer)))
1428 (unless (or (and wildcards find-file-wildcards
1429 (not (string-match "\\`/:" filename
))
1430 (string-match "[[*?]" filename
))
1431 (file-exists-p filename
))
1432 (error "%s does not exist" filename
))
1433 (let ((value (find-file-other-window filename wildcards
)))
1434 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1435 (if (listp value
) value
(list value
)))
1438 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1439 "Edit file FILENAME in another frame but don't allow changes.
1440 Like \\[find-file-other-frame], but marks buffer as read-only.
1441 Use \\[toggle-read-only] to permit editing."
1443 (find-file-read-args "Find file read-only other frame: "
1444 (confirm-nonexistent-file-or-buffer)))
1445 (unless (or (and wildcards find-file-wildcards
1446 (not (string-match "\\`/:" filename
))
1447 (string-match "[[*?]" filename
))
1448 (file-exists-p filename
))
1449 (error "%s does not exist" filename
))
1450 (let ((value (find-file-other-frame filename wildcards
)))
1451 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1452 (if (listp value
) value
(list value
)))
1455 (defun find-alternate-file-other-window (filename &optional wildcards
)
1456 "Find file FILENAME as a replacement for the file in the next window.
1457 This command does not select that window.
1459 See \\[find-file] for the possible forms of the FILENAME argument.
1461 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1462 expand wildcards (if any) and replace the file with multiple files."
1464 (save-selected-window
1466 (let ((file buffer-file-name
)
1470 (setq file-name
(file-name-nondirectory file
)
1471 file-dir
(file-name-directory file
)))
1472 (list (read-file-name
1473 "Find alternate file: " file-dir nil
1474 (confirm-nonexistent-file-or-buffer) file-name
)
1477 (find-file-other-window filename wildcards
)
1478 (save-selected-window
1480 (find-alternate-file filename wildcards
))))
1482 (defvar kill-buffer-hook
) ; from buffer.c
1484 (defun find-alternate-file (filename &optional wildcards
)
1485 "Find file FILENAME, select its buffer, kill previous buffer.
1486 If the current buffer now contains an empty file that you just visited
1487 \(presumably by mistake), use this command to visit the file you really want.
1489 See \\[find-file] for the possible forms of the FILENAME argument.
1491 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1492 expand wildcards (if any) and replace the file with multiple files.
1494 If the current buffer is an indirect buffer, or the base buffer
1495 for one or more indirect buffers, the other buffer(s) are not
1498 (let ((file buffer-file-name
)
1502 (setq file-name
(file-name-nondirectory file
)
1503 file-dir
(file-name-directory file
)))
1504 (list (read-file-name
1505 "Find alternate file: " file-dir nil
1506 (confirm-nonexistent-file-or-buffer) file-name
)
1508 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1510 (when (and (buffer-modified-p) buffer-file-name
)
1511 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1514 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1515 (error "Aborted"))))
1516 (let ((obuf (current-buffer))
1517 (ofile buffer-file-name
)
1518 (onum buffer-file-number
)
1519 (odir dired-directory
)
1520 (otrue buffer-file-truename
)
1521 (oname (buffer-name)))
1522 ;; Run `kill-buffer-hook' here. It needs to happen before
1523 ;; variables like `buffer-file-name' etc are set to nil below,
1524 ;; because some of the hooks that could be invoked
1525 ;; (e.g., `save-place-to-alist') depend on those variables.
1527 ;; Note that `kill-buffer-hook' is not what queries whether to
1528 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1529 ;; asks that itself. Thus, there's no need to temporarily do
1530 ;; `(set-buffer-modified-p nil)' before running this hook.
1531 (run-hooks 'kill-buffer-hook
)
1532 ;; Okay, now we can end-of-life the old buffer.
1533 (if (get-buffer " **lose**")
1534 (kill-buffer " **lose**"))
1535 (rename-buffer " **lose**")
1539 ;; This prevents us from finding the same buffer
1540 ;; if we specified the same file again.
1541 (setq buffer-file-name nil
)
1542 (setq buffer-file-number nil
)
1543 (setq buffer-file-truename nil
)
1544 ;; Likewise for dired buffers.
1545 (setq dired-directory nil
)
1546 (find-file filename wildcards
))
1547 (when (eq obuf
(current-buffer))
1548 ;; This executes if find-file gets an error
1549 ;; and does not really find anything.
1550 ;; We put things back as they were.
1551 ;; If find-file actually finds something, we kill obuf below.
1552 (setq buffer-file-name ofile
)
1553 (setq buffer-file-number onum
)
1554 (setq buffer-file-truename otrue
)
1555 (setq dired-directory odir
)
1557 (rename-buffer oname
)))
1558 (unless (eq (current-buffer) obuf
)
1559 (with-current-buffer obuf
1560 ;; We already ran these; don't run them again.
1561 (let (kill-buffer-query-functions kill-buffer-hook
)
1562 (kill-buffer obuf
))))))
1564 (defun create-file-buffer (filename)
1565 "Create a suitably named buffer for visiting FILENAME, and return it.
1566 FILENAME (sans directory) is used unchanged if that name is free;
1567 otherwise a string <2> or <3> or ... is appended to get an unused name.
1568 Spaces at the start of FILENAME (sans directory) are removed."
1569 (let ((lastname (file-name-nondirectory filename
)))
1570 (if (string= lastname
"")
1571 (setq lastname filename
))
1573 (string-match "^ *\\(.*\\)" lastname
)
1574 (generate-new-buffer (match-string 1 lastname
)))))
1576 (defun generate-new-buffer (name)
1577 "Create and return a buffer with a name based on NAME.
1578 Choose the buffer's name using `generate-new-buffer-name'."
1579 (get-buffer-create (generate-new-buffer-name name
)))
1581 (defcustom automount-dir-prefix
(purecopy "^/tmp_mnt/")
1582 "Regexp to match the automounter prefix in a directory name."
1586 (defvar abbreviated-home-dir nil
1587 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1589 (defun abbreviate-file-name (filename)
1590 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1591 This also substitutes \"~\" for the user's home directory (unless the
1592 home directory is a root directory) and removes automounter prefixes
1593 \(see the variable `automount-dir-prefix')."
1594 ;; Get rid of the prefixes added by the automounter.
1596 (if (and automount-dir-prefix
1597 (string-match automount-dir-prefix filename
)
1598 (file-exists-p (file-name-directory
1599 (substring filename
(1- (match-end 0))))))
1600 (setq filename
(substring filename
(1- (match-end 0)))))
1601 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1602 ;; To fix this right, we need a `file-name-case-sensitive-p'
1603 ;; function, but we don't have that yet, so just guess.
1604 (let ((case-fold-search
1605 (memq system-type
'(ms-dos windows-nt darwin cygwin
))))
1606 ;; If any elt of directory-abbrev-alist matches this name,
1607 ;; abbreviate accordingly.
1608 (dolist (dir-abbrev directory-abbrev-alist
)
1609 (if (string-match (car dir-abbrev
) filename
)
1611 (concat (cdr dir-abbrev
)
1612 (substring filename
(match-end 0))))))
1613 ;; Compute and save the abbreviated homedir name.
1614 ;; We defer computing this until the first time it's needed, to
1615 ;; give time for directory-abbrev-alist to be set properly.
1616 ;; We include a slash at the end, to avoid spurious matches
1617 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1618 (or abbreviated-home-dir
1619 (setq abbreviated-home-dir
1620 (let ((abbreviated-home-dir "$foo"))
1621 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1624 ;; If FILENAME starts with the abbreviated homedir,
1625 ;; make it start with `~' instead.
1626 (if (and (string-match abbreviated-home-dir filename
)
1627 ;; If the home dir is just /, don't change it.
1628 (not (and (= (match-end 0) 1)
1629 (= (aref filename
0) ?
/)))
1630 ;; MS-DOS root directories can come with a drive letter;
1631 ;; Novell Netware allows drive letters beyond `Z:'.
1632 (not (and (memq system-type
'(ms-dos windows-nt cygwin
))
1634 (string-match "^[a-zA-`]:/$" filename
)))))
1637 (match-string 1 filename
)
1638 (substring filename
(match-end 0)))))
1641 (defcustom find-file-not-true-dirname-list nil
1642 "List of logical names for which visiting shouldn't save the true dirname."
1643 :type
'(repeat (string :tag
"Name"))
1646 (defun find-buffer-visiting (filename &optional predicate
)
1647 "Return the buffer visiting file FILENAME (a string).
1648 This is like `get-file-buffer', except that it checks for any buffer
1649 visiting the same file, possibly under a different name.
1650 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1651 and others are ignored.
1652 If there is no such live buffer, return nil."
1653 (let ((predicate (or predicate
#'identity
))
1654 (truename (abbreviate-file-name (file-truename filename
))))
1655 (or (let ((buf (get-file-buffer filename
)))
1656 (when (and buf
(funcall predicate buf
)) buf
))
1657 (let ((list (buffer-list)) found
)
1658 (while (and (not found
) list
)
1659 (with-current-buffer (car list
)
1660 (if (and buffer-file-name
1661 (string= buffer-file-truename truename
)
1662 (funcall predicate
(current-buffer)))
1663 (setq found
(car list
))))
1664 (setq list
(cdr list
)))
1666 (let* ((attributes (file-attributes truename
))
1667 (number (nthcdr 10 attributes
))
1668 (list (buffer-list)) found
)
1669 (and buffer-file-numbers-unique
1670 (car-safe number
) ;Make sure the inode is not just nil.
1671 (while (and (not found
) list
)
1672 (with-current-buffer (car list
)
1673 (if (and buffer-file-name
1674 (equal buffer-file-number number
)
1675 ;; Verify this buffer's file number
1676 ;; still belongs to its file.
1677 (file-exists-p buffer-file-name
)
1678 (equal (file-attributes buffer-file-truename
)
1680 (funcall predicate
(current-buffer)))
1681 (setq found
(car list
))))
1682 (setq list
(cdr list
))))
1685 (defcustom find-file-wildcards t
1686 "Non-nil means file-visiting commands should handle wildcards.
1687 For example, if you specify `*.c', that would visit all the files
1688 whose names match the pattern."
1693 (defcustom find-file-suppress-same-file-warnings nil
1694 "Non-nil means suppress warning messages for symlinked files.
1695 When nil, Emacs prints a warning when visiting a file that is already
1696 visited, but with a different name. Setting this option to t
1697 suppresses this warning."
1702 (defcustom large-file-warning-threshold
10000000
1703 "Maximum size of file above which a confirmation is requested.
1704 When nil, never request confirmation."
1708 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1710 (defun abort-if-file-too-large (size op-type filename
)
1711 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1712 OP-TYPE specifies the file operation being performed (for message to user)."
1713 (when (and large-file-warning-threshold size
1714 (> size large-file-warning-threshold
)
1715 (not (y-or-n-p (format "File %s is large (%dMB), really %s? "
1716 (file-name-nondirectory filename
)
1717 (/ size
1048576) op-type
))))
1720 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1721 "Read file FILENAME into a buffer and return the buffer.
1722 If a buffer exists visiting FILENAME, return that one, but
1723 verify that the file has not changed since visited or saved.
1724 The buffer is not selected, just returned to the caller.
1725 Optional second arg NOWARN non-nil means suppress any warning messages.
1726 Optional third arg RAWFILE non-nil means the file is read literally.
1727 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1728 and visit all the matching files. When wildcards are actually
1729 used and expanded, return a list of buffers that are visiting
1732 (abbreviate-file-name
1733 (expand-file-name filename
)))
1734 (if (file-directory-p filename
)
1735 (or (and find-file-run-dired
1736 (run-hook-with-args-until-success
1737 'find-directory-functions
1738 (if find-file-visit-truename
1739 (abbreviate-file-name (file-truename filename
))
1741 (error "%s is a directory" filename
))
1744 (not (string-match "\\`/:" filename
))
1745 (string-match "[[*?]" filename
))
1746 (let ((files (condition-case nil
1747 (file-expand-wildcards filename t
)
1748 (error (list filename
))))
1749 (find-file-wildcards nil
))
1751 (find-file-noselect filename
)
1752 (mapcar #'find-file-noselect files
)))
1753 (let* ((buf (get-file-buffer filename
))
1754 (truename (abbreviate-file-name (file-truename filename
)))
1755 (attributes (file-attributes truename
))
1756 (number (nthcdr 10 attributes
))
1757 ;; Find any buffer for a file which has same truename.
1758 (other (and (not buf
) (find-buffer-visiting filename
))))
1759 ;; Let user know if there is a buffer with the same truename.
1763 find-file-suppress-same-file-warnings
1764 (string-equal filename
(buffer-file-name other
))
1765 (message "%s and %s are the same file"
1766 filename
(buffer-file-name other
)))
1767 ;; Optionally also find that buffer.
1768 (if (or find-file-existing-other-name find-file-visit-truename
)
1770 ;; Check to see if the file looks uncommonly large.
1771 (when (not (or buf nowarn
))
1772 (abort-if-file-too-large (nth 7 attributes
) "open" filename
))
1774 ;; We are using an existing buffer.
1777 (verify-visited-file-modtime buf
)
1778 (cond ((not (file-exists-p filename
))
1779 (setq nonexistent t
)
1780 (message "File %s no longer exists!" filename
))
1781 ;; Certain files should be reverted automatically
1782 ;; if they have changed on disk and not in the buffer.
1783 ((and (not (buffer-modified-p buf
))
1784 (let ((tail revert-without-query
)
1787 (if (string-match (car tail
) filename
)
1789 (setq tail
(cdr tail
)))
1791 (with-current-buffer buf
1792 (message "Reverting file %s..." filename
)
1794 (message "Reverting file %s...done" filename
)))
1796 (if (string= (file-name-nondirectory filename
)
1799 (if (buffer-modified-p buf
)
1800 "File %s changed on disk. Discard your edits? "
1801 "File %s changed on disk. Reread from disk? ")
1802 (file-name-nondirectory filename
))
1804 (if (buffer-modified-p buf
)
1805 "File %s changed on disk. Discard your edits in %s? "
1806 "File %s changed on disk. Reread from disk into %s? ")
1807 (file-name-nondirectory filename
)
1808 (buffer-name buf
))))
1809 (with-current-buffer buf
1810 (revert-buffer t t
)))))
1811 (with-current-buffer buf
1813 ;; Check if a formerly read-only file has become
1814 ;; writable and vice versa, but if the buffer agrees
1815 ;; with the new state of the file, that is ok too.
1816 (let ((read-only (not (file-writable-p buffer-file-name
))))
1817 (unless (or nonexistent
1818 (eq read-only buffer-file-read-only
)
1819 (eq read-only buffer-read-only
))
1822 (format "File %s is %s on disk. Change buffer mode? "
1824 (if read-only
"read-only" "writable"))))
1825 (y-or-n-p question
)))
1826 (setq buffer-read-only read-only
)))
1827 (setq buffer-file-read-only read-only
))
1829 (when (and (not (eq (not (null rawfile
))
1830 (not (null find-file-literally
))))
1832 ;; It is confusing to ask whether to visit
1833 ;; non-literally if they have the file in
1834 ;; hexl-mode or image-mode.
1835 (not (memq major-mode
'(hexl-mode image-mode
))))
1836 (if (buffer-modified-p)
1840 "The file %s is already visited normally,
1841 and you have edited the buffer. Now you have asked to visit it literally,
1842 meaning no coding system handling, format conversion, or local variables.
1843 Emacs can only visit a file in one way at a time.
1845 Do you want to save the file, and visit it literally instead? "
1846 "The file %s is already visited literally,
1847 meaning no coding system handling, format conversion, or local variables.
1848 You have edited the buffer. Now you have asked to visit the file normally,
1849 but Emacs can only visit a file in one way at a time.
1851 Do you want to save the file, and visit it normally instead? ")
1852 (file-name-nondirectory filename
)))
1855 (find-file-noselect-1 buf filename nowarn
1856 rawfile truename number
))
1861 Do you want to discard your changes, and visit the file literally now? "
1863 Do you want to discard your changes, and visit the file normally now? ")))
1864 (find-file-noselect-1 buf filename nowarn
1865 rawfile truename number
)
1866 (error (if rawfile
"File already visited non-literally"
1867 "File already visited literally"))))
1871 "The file %s is already visited normally.
1872 You have asked to visit it literally,
1873 meaning no coding system decoding, format conversion, or local variables.
1874 But Emacs can only visit a file in one way at a time.
1876 Do you want to revisit the file literally now? "
1877 "The file %s is already visited literally,
1878 meaning no coding system decoding, format conversion, or local variables.
1879 You have asked to visit it normally,
1880 but Emacs can only visit a file in one way at a time.
1882 Do you want to revisit the file normally now? ")
1883 (file-name-nondirectory filename
)))
1884 (find-file-noselect-1 buf filename nowarn
1885 rawfile truename number
)
1886 (error (if rawfile
"File already visited non-literally"
1887 "File already visited literally"))))))
1888 ;; Return the buffer we are using.
1890 ;; Create a new buffer.
1891 (setq buf
(create-file-buffer filename
))
1892 ;; find-file-noselect-1 may use a different buffer.
1893 (find-file-noselect-1 buf filename nowarn
1894 rawfile truename number
))))))
1896 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1898 (with-current-buffer buf
1899 (kill-local-variable 'find-file-literally
)
1900 ;; Needed in case we are re-visiting the file with a different
1901 ;; text representation.
1902 (kill-local-variable 'buffer-file-coding-system
)
1903 (kill-local-variable 'cursor-type
)
1904 (let ((inhibit-read-only t
))
1906 (and (default-value 'enable-multibyte-characters
)
1908 (set-buffer-multibyte t
))
1911 (let ((inhibit-read-only t
))
1912 (insert-file-contents-literally filename t
))
1914 (when (and (file-exists-p filename
)
1915 (not (file-readable-p filename
)))
1917 (signal 'file-error
(list "File is not readable"
1919 ;; Unconditionally set error
1922 (let ((inhibit-read-only t
))
1923 (insert-file-contents filename t
))
1925 (when (and (file-exists-p filename
)
1926 (not (file-readable-p filename
)))
1928 (signal 'file-error
(list "File is not readable"
1930 ;; Run find-file-not-found-functions until one returns non-nil.
1931 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1932 ;; If they fail too, set error.
1934 ;; Record the file's truename, and maybe use that as visited name.
1935 (if (equal filename buffer-file-name
)
1936 (setq buffer-file-truename truename
)
1937 (setq buffer-file-truename
1938 (abbreviate-file-name (file-truename buffer-file-name
))))
1939 (setq buffer-file-number number
)
1940 (if find-file-visit-truename
1941 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
1942 ;; Set buffer's default directory to that of the file.
1943 (setq default-directory
(file-name-directory buffer-file-name
))
1944 ;; Turn off backup files for certain file names. Since
1945 ;; this is a permanent local, the major mode won't eliminate it.
1946 (and backup-enable-predicate
1947 (not (funcall backup-enable-predicate buffer-file-name
))
1949 (make-local-variable 'backup-inhibited
)
1950 (setq backup-inhibited t
)))
1953 (set-buffer-multibyte nil
)
1954 (setq buffer-file-coding-system
'no-conversion
)
1955 (set-buffer-major-mode buf
)
1956 (make-local-variable 'find-file-literally
)
1957 (setq find-file-literally t
))
1958 (after-find-file error
(not nowarn
)))
1961 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
1962 "Like `insert-file-contents', but only reads in the file literally.
1963 A buffer may be modified in several ways after reading into the buffer,
1964 to Emacs features such as format decoding, character code
1965 conversion, `find-file-hook', automatic uncompression, etc.
1967 This function ensures that none of these modifications will take place."
1968 (let ((format-alist nil
)
1969 (after-insert-file-functions nil
)
1970 (coding-system-for-read 'no-conversion
)
1971 (coding-system-for-write 'no-conversion
)
1972 (find-buffer-file-type-function
1973 (if (fboundp 'find-buffer-file-type
)
1974 (symbol-function 'find-buffer-file-type
)
1976 (inhibit-file-name-handlers
1977 (append '(jka-compr-handler image-file-handler epa-file-handler
)
1978 inhibit-file-name-handlers
))
1979 (inhibit-file-name-operation 'insert-file-contents
))
1982 (fset 'find-buffer-file-type
(lambda (_filename) t
))
1983 (insert-file-contents filename visit beg end replace
))
1984 (if find-buffer-file-type-function
1985 (fset 'find-buffer-file-type find-buffer-file-type-function
)
1986 (fmakunbound 'find-buffer-file-type
)))))
1988 (defun insert-file-1 (filename insert-func
)
1989 (if (file-directory-p filename
)
1990 (signal 'file-error
(list "Opening input file" "file is a directory"
1992 ;; Check whether the file is uncommonly large
1993 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert" filename
)
1994 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
1995 #'buffer-modified-p
))
1996 (tem (funcall insert-func filename
)))
1997 (push-mark (+ (point) (car (cdr tem
))))
1999 (message "File %s already visited and modified in buffer %s"
2000 filename
(buffer-name buffer
)))))
2002 (defun insert-file-literally (filename)
2003 "Insert contents of file FILENAME into buffer after point with no conversion.
2005 This function is meant for the user to run interactively.
2006 Don't call it from programs! Use `insert-file-contents-literally' instead.
2007 \(Its calling sequence is different; see its documentation)."
2008 (interactive "*fInsert file literally: ")
2009 (insert-file-1 filename
#'insert-file-contents-literally
))
2011 (defvar find-file-literally nil
2012 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2013 This has the `permanent-local' property, which takes effect if you
2014 make the variable buffer-local.")
2015 (put 'find-file-literally
'permanent-local t
)
2017 (defun find-file-literally (filename)
2018 "Visit file FILENAME with no conversion of any kind.
2019 Format conversion and character code conversion are both disabled,
2020 and multibyte characters are disabled in the resulting buffer.
2021 The major mode used is Fundamental mode regardless of the file name,
2022 and local variable specifications in the file are ignored.
2023 Automatic uncompression and adding a newline at the end of the
2024 file due to `require-final-newline' is also disabled.
2026 You cannot absolutely rely on this function to result in
2027 visiting the file literally. If Emacs already has a buffer
2028 which is visiting the file, you get the existing buffer,
2029 regardless of whether it was created literally or not.
2031 In a Lisp program, if you want to be sure of accessing a file's
2032 contents literally, you should create a temporary buffer and then read
2033 the file contents into it using `insert-file-contents-literally'."
2035 (list (read-file-name
2036 "Find file literally: " nil default-directory
2037 (confirm-nonexistent-file-or-buffer))))
2038 (switch-to-buffer (find-file-noselect filename nil t
)))
2040 (defun after-find-file (&optional error warn noauto
2041 _after-find-file-from-revert-buffer
2043 "Called after finding a file and by the default revert function.
2044 Sets buffer mode, parses local variables.
2045 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2046 error in reading the file. WARN non-nil means warn if there
2047 exists an auto-save file more recent than the visited file.
2048 NOAUTO means don't mess with auto-save mode.
2049 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2050 \(see `revert-buffer-in-progress-p' for similar functionality).
2051 Fifth arg NOMODES non-nil means don't alter the file's modes.
2052 Finishes by calling the functions in `find-file-hook'
2053 unless NOMODES is non-nil."
2054 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
2061 ((and error
(file-attributes buffer-file-name
))
2062 (setq buffer-read-only t
)
2063 "File exists, but cannot be read")
2064 ((not buffer-read-only
)
2066 ;; No need to warn if buffer is auto-saved
2067 ;; under the name of the visited file.
2068 (not (and buffer-file-name
2069 auto-save-visited-file-name
))
2070 (file-newer-than-file-p (or buffer-auto-save-file-name
2071 (make-auto-save-file-name))
2073 (format "%s has auto save data; consider M-x recover-this-file"
2074 (file-name-nondirectory buffer-file-name
))
2075 (setq not-serious t
)
2076 (if error
"(New file)" nil
)))
2078 (setq not-serious t
)
2079 "Note: file is write protected")
2080 ((file-attributes (directory-file-name default-directory
))
2081 "File not found and directory write-protected")
2082 ((file-exists-p (file-name-directory buffer-file-name
))
2083 (setq buffer-read-only nil
))
2085 (setq buffer-read-only nil
)
2086 "Use M-x make-directory RET RET to create the directory and its parents"))))
2089 (or not-serious
(sit-for 1 t
))))
2090 (when (and auto-save-default
(not noauto
))
2091 (auto-save-mode 1)))
2092 ;; Make people do a little extra work (C-x C-q)
2093 ;; before altering a backup file.
2094 (when (backup-file-name-p buffer-file-name
)
2095 (setq buffer-read-only t
))
2096 ;; When a file is marked read-only,
2097 ;; make the buffer read-only even if root is looking at it.
2098 (when (and (file-modes (buffer-file-name))
2099 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
2100 (setq buffer-read-only t
))
2102 (when (and view-read-only view-mode
)
2103 (view-mode-disable))
2105 ;; If requested, add a newline at the end of the file.
2106 (and (memq require-final-newline
'(visit visit-save
))
2107 (> (point-max) (point-min))
2108 (/= (char-after (1- (point-max))) ?
\n)
2109 (not (and (eq selective-display t
)
2110 (= (char-after (1- (point-max))) ?
\r)))
2112 (goto-char (point-max))
2114 (when (and buffer-read-only
2116 (not (eq (get major-mode
'mode-class
) 'special
)))
2118 (run-hooks 'find-file-hook
)))
2120 (defmacro report-errors
(format &rest body
)
2121 "Eval BODY and turn any error into a FORMAT message.
2122 FORMAT can have a %s escape which will be replaced with the actual error.
2123 If `debug-on-error' is set, errors are not caught, so that you can
2125 Avoid using a large BODY since it is duplicated."
2126 (declare (debug t
) (indent 1))
2131 (error (message ,format
(prin1-to-string err
))))))
2133 (defun normal-mode (&optional find-file
)
2134 "Choose the major mode for this buffer automatically.
2135 Also sets up any specified local variables of the file.
2136 Uses the visited file name, the -*- line, and the local variables spec.
2138 This function is called automatically from `find-file'. In that case,
2139 we may set up the file-specified mode and local variables,
2140 depending on the value of `enable-local-variables'.
2141 In addition, if `local-enable-local-variables' is nil, we do
2142 not set local variables (though we do notice a mode specified with -*-.)
2144 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2145 or from Lisp without specifying the optional argument FIND-FILE;
2146 in that case, this function acts as if `enable-local-variables' were t."
2148 (funcall (or (default-value 'major-mode
) 'fundamental-mode
))
2149 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
2150 ;; FIXME this is less efficient than it could be, since both
2151 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2152 (report-errors "File mode specification error: %s"
2154 (report-errors "File local-variables error: %s"
2155 (hack-local-variables)))
2156 ;; Turn font lock off and on, to make sure it takes account of
2157 ;; whatever file local variables are relevant to it.
2158 (when (and font-lock-mode
2159 ;; Font-lock-mode (now in font-core.el) can be ON when
2160 ;; font-lock.el still hasn't been loaded.
2161 (boundp 'font-lock-keywords
)
2162 (eq (car font-lock-keywords
) t
))
2163 (setq font-lock-keywords
(cadr font-lock-keywords
))
2166 (if (fboundp 'ucs-set-table-for-input
) ; don't lose when building
2167 (ucs-set-table-for-input)))
2169 (defcustom auto-mode-case-fold t
2170 "Non-nil means to try second pass through `auto-mode-alist'.
2171 This means that if the first case-sensitive search through the alist fails
2172 to find a matching major mode, a second case-insensitive search is made.
2173 On systems with case-insensitive file names, this variable is ignored,
2174 since only a single case-insensitive search through the alist is made."
2179 (defvar auto-mode-alist
2180 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2181 ;; c++-mode, java-mode and more) are added through autoload
2182 ;; directives in that file. That way is discouraged since it
2183 ;; spreads out the definition of the initial value.
2186 (cons (purecopy (car elt
)) (cdr elt
)))
2187 `(;; do this first, so that .html.pl is Polish html, not Perl
2188 ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2189 ("\\.svgz?\\'" . image-mode
)
2190 ("\\.svgz?\\'" . xml-mode
)
2191 ("\\.x[bp]m\\'" . image-mode
)
2192 ("\\.x[bp]m\\'" . c-mode
)
2193 ("\\.p[bpgn]m\\'" . image-mode
)
2194 ("\\.tiff?\\'" . image-mode
)
2195 ("\\.gif\\'" . image-mode
)
2196 ("\\.png\\'" . image-mode
)
2197 ("\\.jpe?g\\'" . image-mode
)
2198 ("\\.te?xt\\'" . text-mode
)
2199 ("\\.[tT]e[xX]\\'" . tex-mode
)
2200 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2201 ("\\.ltx\\'" . latex-mode
)
2202 ("\\.dtx\\'" . doctex-mode
)
2203 ("\\.org\\'" . org-mode
)
2204 ("\\.el\\'" . emacs-lisp-mode
)
2205 ("Project\\.ede\\'" . emacs-lisp-mode
)
2206 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2207 ("\\.l\\'" . lisp-mode
)
2208 ("\\.li?sp\\'" . lisp-mode
)
2209 ("\\.[fF]\\'" . fortran-mode
)
2210 ("\\.for\\'" . fortran-mode
)
2211 ("\\.p\\'" . pascal-mode
)
2212 ("\\.pas\\'" . pascal-mode
)
2213 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode
)
2214 ("\\.ad[abs]\\'" . ada-mode
)
2215 ("\\.ad[bs].dg\\'" . ada-mode
)
2216 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2217 ("Imakefile\\'" . makefile-imake-mode
)
2218 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2219 ("\\.makepp\\'" . makefile-makepp-mode
)
2220 ,@(if (memq system-type
'(berkeley-unix darwin
))
2221 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2222 ("GNUmakefile\\'" . makefile-gmake-mode
)
2223 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2224 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2225 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2226 ("\\.am\\'" . makefile-automake-mode
)
2227 ;; Less common extensions come here
2228 ;; so more common ones above are found faster.
2229 ("\\.texinfo\\'" . texinfo-mode
)
2230 ("\\.te?xi\\'" . texinfo-mode
)
2231 ("\\.[sS]\\'" . asm-mode
)
2232 ("\\.asm\\'" . asm-mode
)
2233 ("\\.css\\'" . css-mode
)
2234 ("\\.mixal\\'" . mixal-mode
)
2235 ("\\.gcov\\'" . compilation-mode
)
2236 ;; Besides .gdbinit, gdb documents other names to be usable for init
2237 ;; files, cross-debuggers can use something like
2238 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2239 ;; don't interfere with each other.
2240 ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode
)
2241 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2242 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2243 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2244 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2245 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2246 ("\\.bash\\'" . sh-mode
)
2247 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2248 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2249 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2250 ("\\.m?spec\\'" . sh-mode
)
2251 ("\\.m[mes]\\'" . nroff-mode
)
2252 ("\\.man\\'" . nroff-mode
)
2253 ("\\.sty\\'" . latex-mode
)
2254 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2255 ("\\.bbl\\'" . latex-mode
)
2256 ("\\.bib\\'" . bibtex-mode
)
2257 ("\\.bst\\'" . bibtex-style-mode
)
2258 ("\\.sql\\'" . sql-mode
)
2259 ("\\.m[4c]\\'" . m4-mode
)
2260 ("\\.mf\\'" . metafont-mode
)
2261 ("\\.mp\\'" . metapost-mode
)
2262 ("\\.vhdl?\\'" . vhdl-mode
)
2263 ("\\.article\\'" . text-mode
)
2264 ("\\.letter\\'" . text-mode
)
2265 ("\\.i?tcl\\'" . tcl-mode
)
2266 ("\\.exp\\'" . tcl-mode
)
2267 ("\\.itk\\'" . tcl-mode
)
2268 ("\\.icn\\'" . icon-mode
)
2269 ("\\.sim\\'" . simula-mode
)
2270 ("\\.mss\\'" . scribe-mode
)
2271 ;; The Fortran standard does not say anything about file extensions.
2272 ;; .f90 was widely used for F90, now we seem to be trapped into
2273 ;; using a different extension for each language revision.
2274 ;; Anyway, the following extensions are supported by gfortran.
2275 ("\\.f9[05]\\'" . f90-mode
)
2276 ("\\.f0[38]\\'" . f90-mode
)
2277 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2278 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode
)
2279 ("\\.srt\\'" . srecode-template-mode
)
2280 ("\\.prolog\\'" . prolog-mode
)
2281 ("\\.tar\\'" . tar-mode
)
2282 ;; The list of archive file extensions should be in sync with
2283 ;; `auto-coding-alist' with `no-conversion' coding system.
2285 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2286 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode
)
2287 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode
) ;OpenOffice.org
2288 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode
) ; Debian/Opkg packages.
2289 ;; Mailer puts message to be edited in
2290 ;; /tmp/Re.... or Message
2291 ("\\`/tmp/Re" . text-mode
)
2292 ("/Message[0-9]*\\'" . text-mode
)
2293 ;; some news reader is reported to use this
2294 ("\\`/tmp/fol/" . text-mode
)
2295 ("\\.oak\\'" . scheme-mode
)
2296 ("\\.sgml?\\'" . sgml-mode
)
2297 ("\\.x[ms]l\\'" . xml-mode
)
2298 ("\\.dbk\\'" . xml-mode
)
2299 ("\\.dtd\\'" . sgml-mode
)
2300 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2301 ("\\.js\\'" . js-mode
) ; javascript-mode would be better
2302 ("\\.json\\'" . js-mode
)
2303 ("\\.[ds]?vh?\\'" . verilog-mode
)
2304 ;; .emacs or .gnus or .viper following a directory delimiter in
2305 ;; Unix, MSDOG or VMS syntax.
2306 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2307 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2308 ;; _emacs following a directory delimiter
2310 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2311 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2312 ("\\.ml\\'" . lisp-mode
)
2313 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2314 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2315 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2316 ("\\.ld[si]?\\'" . ld-script-mode
)
2317 ("ld\\.?script\\'" . ld-script-mode
)
2318 ;; .xs is also used for ld scripts, but seems to be more commonly
2319 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2320 ("\\.xs\\'" . c-mode
)
2321 ;; Explained in binutils ld/genscripts.sh. Eg:
2322 ;; A .x script file is the default script.
2323 ;; A .xr script is for linking without relocation (-r flag). Etc.
2324 ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode
)
2325 ("\\.zone\\'" . dns-mode
)
2326 ("\\.soa\\'" . dns-mode
)
2327 ;; Common Lisp ASDF package system.
2328 ("\\.asd\\'" . lisp-mode
)
2329 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2330 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2331 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2332 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2333 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2334 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe
)
2335 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2336 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode
)
2337 ("BROWSE\\'" . ebrowse-tree-mode
)
2338 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2339 ("#\\*mail\\*" . mail-mode
)
2340 ("\\.g\\'" . antlr-mode
)
2341 ("\\.mod\\'" . m2-mode
)
2342 ("\\.ses\\'" . ses-mode
)
2343 ("\\.docbook\\'" . sgml-mode
)
2344 ("\\.com\\'" . dcl-mode
)
2345 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2346 ;; Windows candidates may be opened case sensitively on Unix
2347 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2348 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2349 ("\\.ppd\\'" . conf-ppd-mode
)
2350 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2351 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2352 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2353 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2354 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2355 ;; this has lower priority to avoid matching changelog.sgml etc.
2356 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2357 ;; either user's dot-files or under /etc or some such
2358 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2359 ;; alas not all ~/.*rc files are like this
2360 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2361 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2362 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2363 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2364 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2365 ;; this contains everything twice, with space and with colon :-(
2366 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2367 ;; Get rid of any trailing .n.m and try again.
2368 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2369 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2370 ;; Using mode nil rather than `ignore' would let the search continue
2371 ;; through this list (with the shortened name) rather than start over.
2372 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2373 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)
2374 ;; This should come after "in" stripping (e.g. config.h.in).
2375 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2376 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2377 ;; The following should come after the ChangeLog pattern
2378 ;; for the sake of ChangeLog.1, etc.
2379 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2380 ("\\.[1-9]\\'" . nroff-mode
)))
2381 "Alist of filename patterns vs corresponding major mode functions.
2382 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2383 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2384 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2385 mode function to use. FUNCTION will be called, unless it is nil.
2387 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2388 calling FUNCTION (if it's not nil), we delete the suffix that matched
2389 REGEXP and search the list again for another match.
2391 If the file name matches `inhibit-first-line-modes-regexps',
2392 then `auto-mode-alist' is not processed.
2394 The extensions whose FUNCTION is `archive-mode' should also
2395 appear in `auto-coding-alist' with `no-conversion' coding system.
2397 See also `interpreter-mode-alist', which detects executable script modes
2398 based on the interpreters they specify to run,
2399 and `magic-mode-alist', which determines modes based on file contents.")
2400 (put 'auto-mode-alist
'risky-local-variable t
)
2402 (defun conf-mode-maybe ()
2403 "Select Conf mode or XML mode according to start of file."
2407 (goto-char (point-min))
2408 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2412 (defvar interpreter-mode-alist
2413 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2414 ;; and pike-mode) are added through autoload directives in that
2415 ;; file. That way is discouraged since it spreads out the
2416 ;; definition of the initial value.
2419 (cons (purecopy (car l
)) (cdr l
)))
2420 '(("perl" . perl-mode
)
2421 ("perl5" . perl-mode
)
2422 ("miniperl" . perl-mode
)
2424 ("wishx" . tcl-mode
)
2426 ("tclsh" . tcl-mode
)
2427 ("scm" . scheme-mode
)
2448 ("tail" . text-mode
)
2449 ("more" . text-mode
)
2450 ("less" . text-mode
)
2452 ("make" . makefile-gmake-mode
) ; Debian uses this
2453 ("guile" . scheme-mode
)
2454 ("clisp" . lisp-mode
)
2455 ("emacs" . emacs-lisp-mode
)))
2456 "Alist mapping interpreter names to major modes.
2457 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2458 Each element looks like (INTERPRETER . MODE).
2459 If INTERPRETER matches the name of the interpreter specified in the first line
2460 of a script, mode MODE is enabled.
2462 See also `auto-mode-alist'.")
2464 (defvar inhibit-first-line-modes-regexps
(mapcar 'purecopy
'("\\.tar\\'" "\\.tgz\\'"))
2465 "List of regexps; if one matches a file name, don't look for `-*-'.")
2467 (defvar inhibit-first-line-modes-suffixes nil
2468 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2469 When checking `inhibit-first-line-modes-regexps', we first discard
2470 from the end of the file name anything that matches one of these regexps.")
2472 (defvar auto-mode-interpreter-regexp
2473 (purecopy "#![ \t]?\\([^ \t\n]*\
2474 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2475 "Regexp matching interpreters, for file mode determination.
2476 This regular expression is matched against the first line of a file
2477 to determine the file's mode in `set-auto-mode'. If it matches, the file
2478 is assumed to be interpreted by the interpreter matched by the second group
2479 of the regular expression. The mode is then determined as the mode
2480 associated with that interpreter in `interpreter-mode-alist'.")
2482 (defvar magic-mode-alist nil
2483 "Alist of buffer beginnings vs. corresponding major mode functions.
2484 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2485 After visiting a file, if REGEXP matches the text at the beginning of the
2486 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2487 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2490 If FUNCTION is nil, then it is not called. (That is a way of saying
2491 \"allow `auto-mode-alist' to decide for these files.\")")
2492 (put 'magic-mode-alist
'risky-local-variable t
)
2494 (defvar magic-fallback-mode-alist
2496 `((image-type-auto-detected-p . image-mode
)
2497 ("\\(PK00\\)?[P]K\003\004" . archive-mode
) ; zip
2498 ;; The < comes before the groups (but the first) to reduce backtracking.
2499 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2500 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2501 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2502 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2503 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2505 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2506 "[Hh][Tt][Mm][Ll]"))
2508 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2509 ;; These two must come after html, because they are more general:
2510 ("<\\?xml " . xml-mode
)
2511 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2512 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2513 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2516 ("# xmcd " . conf-unix-mode
)))
2517 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2518 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2519 After visiting a file, if REGEXP matches the text at the beginning of the
2520 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2521 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2522 have not specified a mode for this file.
2524 If FUNCTION is nil, then it is not called.")
2525 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2527 (defvar magic-mode-regexp-match-limit
4000
2528 "Upper limit on `magic-mode-alist' regexp matches.
2529 Also applies to `magic-fallback-mode-alist'.")
2531 (defun set-auto-mode (&optional keep-mode-if-same
)
2532 "Select major mode appropriate for current buffer.
2534 To find the right major mode, this function checks for a -*- mode tag,
2535 checks for a `mode:' entry in the Local Variables section of the file,
2536 checks if it uses an interpreter listed in `interpreter-mode-alist',
2537 matches the buffer beginning against `magic-mode-alist',
2538 compares the filename against the entries in `auto-mode-alist',
2539 then matches the buffer beginning against `magic-fallback-mode-alist'.
2541 If `enable-local-variables' is nil, this function does not check for
2542 any mode: tag anywhere in the file.
2544 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2545 set the major mode only if that would change it. In other words
2546 we don't actually set it to the same mode the buffer already has."
2547 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2548 (let (end done mode modes
)
2549 ;; Once we drop the deprecated feature where mode: is also allowed to
2550 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2551 ;; remove this section and just let (hack-local-variables t) handle it.
2552 ;; Find a -*- mode tag.
2554 (goto-char (point-min))
2555 (skip-chars-forward " \t\n")
2556 (and enable-local-variables
2557 (setq end
(set-auto-mode-1))
2558 (if (save-excursion (search-forward ":" end t
))
2559 ;; Find all specifications for the `mode:' variable
2560 ;; and execute them left to right.
2561 (while (let ((case-fold-search t
))
2562 (or (and (looking-at "mode:")
2563 (goto-char (match-end 0)))
2564 (re-search-forward "[ \t;]mode:" end t
)))
2565 (skip-chars-forward " \t")
2566 (let ((beg (point)))
2567 (if (search-forward ";" end t
)
2570 (skip-chars-backward " \t")
2571 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2573 ;; Simple -*-MODE-*- case.
2574 (push (intern (concat (downcase (buffer-substring (point) end
))
2577 ;; If we found modes to use, invoke them now, outside the save-excursion.
2580 (dolist (mode (nreverse modes
))
2581 (if (not (functionp mode
))
2582 (message "Ignoring unknown mode `%s'" mode
)
2584 (or (set-auto-mode-0 mode keep-mode-if-same
)
2585 ;; continuing would call minor modes again, toggling them off
2586 (throw 'nop nil
))))))
2588 enable-local-variables
2589 (setq mode
(hack-local-variables t
))
2590 (not (memq mode modes
)) ; already tried and failed
2591 (if (not (functionp mode
))
2592 (message "Ignoring unknown mode `%s'" mode
)
2594 (set-auto-mode-0 mode keep-mode-if-same
)))
2595 ;; If we didn't, look for an interpreter specified in the first line.
2596 ;; As a special case, allow for things like "#!/bin/env perl", which
2597 ;; finds the interpreter anywhere in $PATH.
2599 (setq mode
(save-excursion
2600 (goto-char (point-min))
2601 (if (looking-at auto-mode-interpreter-regexp
)
2604 ;; Map interpreter name to a mode, signalling we're done at the
2606 done
(assoc (file-name-nondirectory mode
)
2607 interpreter-mode-alist
))
2608 ;; If we found an interpreter mode to use, invoke it now.
2610 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2611 ;; Next try matching the buffer beginning against magic-mode-alist.
2613 (if (setq done
(save-excursion
2614 (goto-char (point-min))
2616 (narrow-to-region (point-min)
2618 (+ (point-min) magic-mode-regexp-match-limit
)))
2619 (assoc-default nil magic-mode-alist
2623 (looking-at re
)))))))
2624 (set-auto-mode-0 done keep-mode-if-same
)))
2625 ;; Next compare the filename against the entries in auto-mode-alist.
2627 (if buffer-file-name
2628 (let ((name buffer-file-name
)
2629 (remote-id (file-remote-p buffer-file-name
)))
2630 ;; Remove remote file name identification.
2631 (when (and (stringp remote-id
)
2632 (string-match (regexp-quote remote-id
) name
))
2633 (setq name
(substring name
(match-end 0))))
2634 ;; Remove backup-suffixes from file name.
2635 (setq name
(file-name-sans-versions name
))
2637 ;; Find first matching alist entry.
2639 (if (memq system-type
'(windows-nt cygwin
))
2640 ;; System is case-insensitive.
2641 (let ((case-fold-search t
))
2642 (assoc-default name auto-mode-alist
2644 ;; System is case-sensitive.
2646 ;; First match case-sensitively.
2647 (let ((case-fold-search nil
))
2648 (assoc-default name auto-mode-alist
2650 ;; Fallback to case-insensitive match.
2651 (and auto-mode-case-fold
2652 (let ((case-fold-search t
))
2653 (assoc-default name auto-mode-alist
2658 (setq mode
(car mode
)
2659 name
(substring name
0 (match-beginning 0)))
2662 (set-auto-mode-0 mode keep-mode-if-same
)
2664 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2666 (if (setq done
(save-excursion
2667 (goto-char (point-min))
2669 (narrow-to-region (point-min)
2671 (+ (point-min) magic-mode-regexp-match-limit
)))
2672 (assoc-default nil magic-fallback-mode-alist
2676 (looking-at re
)))))))
2677 (set-auto-mode-0 done keep-mode-if-same
)))))
2679 ;; When `keep-mode-if-same' is set, we are working on behalf of
2680 ;; set-visited-file-name. In that case, if the major mode specified is the
2681 ;; same one we already have, don't actually reset it. We don't want to lose
2682 ;; minor modes such as Font Lock.
2683 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2684 "Apply MODE and return it.
2685 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2686 any aliases and compared to current major mode. If they are the
2687 same, do nothing and return nil."
2688 (unless (and keep-mode-if-same
2689 (eq (indirect-function mode
)
2690 (indirect-function major-mode
)))
2695 (defun set-auto-mode-1 ()
2696 "Find the -*- spec in the buffer.
2697 Call with point at the place to start searching from.
2698 If one is found, set point to the beginning
2699 and return the position of the end.
2700 Otherwise, return nil; point may be changed."
2703 ;; Don't look for -*- if this file name matches any
2704 ;; of the regexps in inhibit-first-line-modes-regexps.
2705 (let ((temp inhibit-first-line-modes-regexps
)
2706 (name (if buffer-file-name
2707 (file-name-sans-versions buffer-file-name
)
2709 (while (let ((sufs inhibit-first-line-modes-suffixes
))
2710 (while (and sufs
(not (string-match (car sufs
) name
)))
2711 (setq sufs
(cdr sufs
)))
2713 (setq name
(substring name
0 (match-beginning 0))))
2715 (not (string-match (car temp
) name
)))
2716 (setq temp
(cdr temp
)))
2719 (search-forward "-*-" (line-end-position
2720 ;; If the file begins with "#!"
2721 ;; (exec interpreter magic), look
2722 ;; for mode frobs in the first two
2723 ;; lines. You cannot necessarily
2724 ;; put them in the first line of
2725 ;; such a file without screwing up
2726 ;; the interpreter invocation.
2727 ;; The same holds for
2729 ;; in man pages (preprocessor
2730 ;; magic for the `man' program).
2731 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t
)
2733 (skip-chars-forward " \t")
2735 (search-forward "-*-" (line-end-position) t
))
2738 (skip-chars-backward " \t")
2743 ;;; Handling file local variables
2745 (defvar ignored-local-variables
2746 '(ignored-local-variables safe-local-variable-values
2747 file-local-variables-alist dir-local-variables-alist
)
2748 "Variables to be ignored in a file's local variable spec.")
2749 (put 'ignored-local-variables
'risky-local-variable t
)
2751 (defvar hack-local-variables-hook nil
2752 "Normal hook run after processing a file's local variables specs.
2753 Major modes can use this to examine user-specified local variables
2754 in order to initialize other data structure based on them.")
2756 (defcustom safe-local-variable-values nil
2757 "List variable-value pairs that are considered safe.
2758 Each element is a cons cell (VAR . VAL), where VAR is a variable
2759 symbol and VAL is a value that is considered safe."
2764 (defcustom safe-local-eval-forms
2765 ;; This should be here at least as long as Emacs supports write-file-hooks.
2766 '((add-hook 'write-file-hooks
'time-stamp
)
2767 (add-hook 'write-file-functions
'time-stamp
)
2768 (add-hook 'before-save-hook
'time-stamp
))
2769 "Expressions that are considered safe in an `eval:' local variable.
2770 Add expressions to this list if you want Emacs to evaluate them, when
2771 they appear in an `eval' local variable specification, without first
2772 asking you for confirmation."
2775 :version
"24.1" ; added write-file-hooks
2776 :type
'(repeat sexp
))
2778 ;; Risky local variables:
2779 (mapc (lambda (var) (put var
'risky-local-variable t
))
2781 buffer-auto-save-file-name
2783 buffer-file-truename
2786 default-text-properties
2790 file-name-handler-alist
2799 minor-mode-map-alist
2800 minor-mode-overriding-map-alist
2803 overriding-local-map
2804 overriding-terminal-local-map
2808 unread-command-events
))
2810 ;; Safe local variables:
2812 ;; For variables defined by major modes, the safety declarations can go into
2813 ;; the major mode's file, since that will be loaded before file variables are
2816 ;; For variables defined by minor modes, put the safety declarations in the
2817 ;; file defining the minor mode after the defcustom/defvar using an autoload
2820 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2822 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2823 ;; minor mode file may not be loaded yet.
2825 ;; For variables defined in the C source code the declaration should go here:
2828 '((buffer-read-only . booleanp
) ;; C source code
2829 (default-directory . stringp
) ;; C source code
2830 (fill-column . integerp
) ;; C source code
2831 (indent-tabs-mode . booleanp
) ;; C source code
2832 (left-margin . integerp
) ;; C source code
2833 (no-update-autoloads . booleanp
)
2834 (lexical-binding . booleanp
) ;; C source code
2835 (tab-width . integerp
) ;; C source code
2836 (truncate-lines . booleanp
) ;; C source code
2837 (word-wrap . booleanp
) ;; C source code
2838 (bidi-display-reordering . booleanp
))) ;; C source code
2839 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2841 (put 'bidi-paragraph-direction
'safe-local-variable
2842 (lambda (v) (memq v
'(nil right-to-left left-to-right
))))
2844 (put 'c-set-style
'safe-local-eval-function t
)
2846 (defvar file-local-variables-alist nil
2847 "Alist of file-local variable settings in the current buffer.
2848 Each element in this list has the form (VAR . VALUE), where VAR
2849 is a file-local variable (a symbol) and VALUE is the value
2850 specified. The actual value in the buffer may differ from VALUE,
2851 if it is changed by the major or minor modes, or by the user.")
2852 (make-variable-buffer-local 'file-local-variables-alist
)
2853 (put 'file-local-variables-alist
'permanent-local t
)
2855 (defvar dir-local-variables-alist nil
2856 "Alist of directory-local variable settings in the current buffer.
2857 Each element in this list has the form (VAR . VALUE), where VAR
2858 is a directory-local variable (a symbol) and VALUE is the value
2859 specified in .dir-locals.el. The actual value in the buffer
2860 may differ from VALUE, if it is changed by the major or minor modes,
2862 (make-variable-buffer-local 'dir-local-variables-alist
)
2864 (defvar before-hack-local-variables-hook nil
2865 "Normal hook run before setting file-local variables.
2866 It is called after checking for unsafe/risky variables and
2867 setting `file-local-variables-alist', and before applying the
2868 variables stored in `file-local-variables-alist'. A hook
2869 function is allowed to change the contents of this alist.
2871 This hook is called only if there is at least one file-local
2874 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name
)
2875 "Get confirmation before setting up local variable values.
2876 ALL-VARS is the list of all variables to be set up.
2877 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2878 RISKY-VARS is the list of those that are marked as risky.
2879 If these settings come from directory-local variables, then
2880 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2883 (save-window-excursion
2884 (let* ((name (or dir-name
2885 (if buffer-file-name
2886 (file-name-nondirectory buffer-file-name
)
2887 (concat "buffer " (buffer-name)))))
2888 (offer-save (and (eq enable-local-variables t
)
2891 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2892 (buf (pop-to-buffer "*Local Variables*"))
2894 (set (make-local-variable 'cursor-type
) nil
)
2898 (insert "The local variables list in " name
2899 "\ncontains values that may not be safe (*)"
2901 ", and variables that are risky (**)."
2904 (insert "The local variables list in " name
2905 "\ncontains variables that are risky (**)."))
2907 (insert "A local variables list is specified in " name
".")))
2908 (insert "\n\nDo you want to apply it? You can type
2909 y -- to apply the local variables list.
2910 n -- to ignore the local variables list.")
2913 ! -- to apply the local variables list, and permanently mark these
2914 values (*) as safe (in the future, they will be set automatically.)\n\n")
2916 (dolist (elt all-vars
)
2917 (cond ((member elt unsafe-vars
)
2919 ((member elt risky-vars
)
2923 (princ (car elt
) buf
)
2925 ;; Make strings with embedded whitespace easier to read.
2926 (let ((print-escape-newlines t
))
2927 (prin1 (cdr elt
) buf
))
2930 (format "Please type %s%s: "
2931 (if offer-save
"y, n, or !" "y or n")
2932 (if (< (line-number-at-pos) (window-body-height))
2934 (push ?\C-v exit-chars
)
2935 ", or C-v to scroll")))
2936 (goto-char (point-min))
2938 (setq char
(read-char-choice prompt exit-chars t
))
2939 (when (eq char ?\C-v
)
2942 (error (goto-char (point-min))))
2945 (when (and offer-save
(= char ?
!) unsafe-vars
)
2946 (dolist (elt unsafe-vars
)
2947 (add-to-list 'safe-local-variable-values elt
))
2948 ;; When this is called from desktop-restore-file-buffer,
2949 ;; coding-system-for-read may be non-nil. Reset it before
2950 ;; writing to .emacs.
2951 (if (or custom-file user-init-file
)
2952 (let ((coding-system-for-read nil
))
2953 (customize-save-variable
2954 'safe-local-variable-values
2955 safe-local-variable-values
))))
2956 (memq char
'(?
! ?\s ?y
))))))
2958 (defun hack-local-variables-prop-line (&optional mode-only
)
2959 "Return local variables specified in the -*- line.
2960 Returns an alist of elements (VAR . VAL), where VAR is a variable
2961 and VAL is the specified value. Ignores any specification for
2962 `mode:' and `coding:' (which should have already been handled
2963 by `set-auto-mode' and `set-auto-coding', respectively).
2964 Throws an error if the -*- line is malformed.
2966 If MODE-ONLY is non-nil, just returns the symbol specifying the
2967 mode, if there is one, otherwise nil."
2969 (goto-char (point-min))
2970 (let ((end (set-auto-mode-1))
2974 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2975 ;; Simple form: "-*- MODENAME -*-".
2977 (intern (concat (match-string 1) "-mode"))))
2979 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2980 ;; (last ";" is optional).
2981 ;; If MODE-ONLY, just check for `mode'.
2982 ;; Otherwise, parse the -*- line into the RESULT alist.
2983 (while (and (or (not mode-only
)
2986 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2987 (error "Malformed -*- line"))
2988 (goto-char (match-end 0))
2989 ;; There used to be a downcase here,
2990 ;; but the manual didn't say so,
2991 ;; and people want to set var names that aren't all lc.
2992 (let* ((key (intern (match-string 1)))
2993 (val (save-restriction
2994 (narrow-to-region (point) end
)
2995 (let ((read-circle nil
))
2996 (read (current-buffer)))))
2997 ;; It is traditional to ignore
2998 ;; case when checking for `mode' in set-auto-mode,
2999 ;; so we must do that here as well.
3000 ;; That is inconsistent, but we're stuck with it.
3001 ;; The same can be said for `coding' in set-auto-coding.
3002 (keyname (downcase (symbol-name key
))))
3004 (and (equal keyname
"mode")
3006 (intern (concat (downcase (symbol-name val
))
3008 (or (equal keyname
"coding")
3010 (push (cons (if (eq key
'eval
)
3012 (indirect-variable key
))
3015 (skip-chars-forward " \t;")))
3018 (defun hack-local-variables-filter (variables dir-name
)
3019 "Filter local variable settings, querying the user if necessary.
3020 VARIABLES is the alist of variable-value settings. This alist is
3021 filtered based on the values of `ignored-local-variables',
3022 `enable-local-eval', `enable-local-variables', and (if necessary)
3023 user interaction. The results are added to
3024 `file-local-variables-alist', without applying them.
3025 If these settings come from directory-local variables, then
3026 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3027 ;; Find those variables that we may want to save to
3028 ;; `safe-local-variable-values'.
3029 (let (all-vars risky-vars unsafe-vars
)
3030 (dolist (elt variables
)
3031 (let ((var (car elt
))
3033 (cond ((memq var ignored-local-variables
)
3034 ;; Ignore any variable in `ignored-local-variables'.
3036 ;; Obey `enable-local-eval'.
3038 (when enable-local-eval
3040 (or (eq enable-local-eval t
)
3041 (hack-one-local-variable-eval-safep (eval (quote val
)))
3042 (safe-local-variable-p var val
)
3043 (push elt unsafe-vars
))))
3044 ;; Ignore duplicates (except `mode') in the present list.
3045 ((and (assq var all-vars
) (not (eq var
'mode
))) nil
)
3046 ;; Accept known-safe variables.
3047 ((or (memq var
'(mode unibyte coding
))
3048 (safe-local-variable-p var val
))
3049 (push elt all-vars
))
3050 ;; The variable is either risky or unsafe:
3051 ((not (eq enable-local-variables
:safe
))
3053 (if (risky-local-variable-p var val
)
3054 (push elt risky-vars
)
3055 (push elt unsafe-vars
))))))
3057 ;; Query, unless all vars are safe or user wants no querying.
3058 (or (and (eq enable-local-variables t
)
3061 (memq enable-local-variables
'(:all
:safe
))
3062 (hack-local-variables-confirm all-vars unsafe-vars
3063 risky-vars dir-name
))
3064 (dolist (elt all-vars
)
3065 (unless (memq (car elt
) '(eval mode
))
3067 (setq dir-local-variables-alist
3068 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3069 (setq file-local-variables-alist
3070 (assq-delete-all (car elt
) file-local-variables-alist
)))
3071 (push elt file-local-variables-alist
)))))
3073 (defun hack-local-variables (&optional mode-only
)
3074 "Parse and put into effect this buffer's local variables spec.
3075 Uses `hack-local-variables-apply' to apply the variables.
3077 If MODE-ONLY is non-nil, all we do is check whether a \"mode:\"
3078 is specified, and return the corresponding mode symbol, or nil.
3079 In this case, we try to ignore minor-modes, and only return a
3081 (let ((enable-local-variables
3082 (and local-enable-local-variables enable-local-variables
))
3085 (setq file-local-variables-alist nil
)
3086 (report-errors "Directory-local variables error: %s"
3087 (hack-dir-local-variables)))
3088 (when (or mode-only enable-local-variables
)
3089 ;; If MODE-ONLY is non-nil, and the prop line specifies a mode,
3090 ;; then we're done, and have no need to scan further.
3091 (unless (and (setq result
(hack-local-variables-prop-line mode-only
))
3093 ;; Look for "Local variables:" line in last page.
3095 (goto-char (point-max))
3096 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3098 (when (let ((case-fold-search t
))
3099 (search-forward "Local Variables:" nil t
))
3100 (skip-chars-forward " \t")
3101 ;; suffix is what comes after "local variables:" in its line.
3102 ;; prefix is what comes before "local variables:" in its line.
3105 (regexp-quote (buffer-substring (point)
3106 (line-end-position)))
3109 (concat "^" (regexp-quote
3110 (buffer-substring (line-beginning-position)
3111 (match-beginning 0)))))
3115 (let ((startpos (point))
3117 (thisbuf (current-buffer)))
3119 (unless (let ((case-fold-search t
))
3121 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
3123 ;; This used to be an error, but really all it means is
3124 ;; that this may simply not be a local-variables section,
3125 ;; so just ignore it.
3126 (message "Local variables list is not properly terminated"))
3128 (setq endpos
(point)))
3131 (insert-buffer-substring thisbuf startpos endpos
)
3132 (goto-char (point-min))
3133 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
3135 ;; Discard the prefix.
3136 (if (looking-at prefix
)
3137 (delete-region (point) (match-end 0))
3138 (error "Local variables entry is missing the prefix"))
3140 ;; Discard the suffix.
3141 (if (looking-back suffix
)
3142 (delete-region (match-beginning 0) (point))
3143 (error "Local variables entry is missing the suffix"))
3145 (goto-char (point-min))
3147 (while (and (not (eobp))
3150 ;; Find the variable name; strip whitespace.
3151 (skip-chars-forward " \t")
3153 (skip-chars-forward "^:\n")
3154 (if (eolp) (error "Missing colon in local variables entry"))
3155 (skip-chars-backward " \t")
3156 (let* ((str (buffer-substring beg
(point)))
3157 (var (let ((read-circle nil
))
3160 ;; Read the variable value.
3161 (skip-chars-forward "^:")
3163 (let ((read-circle nil
))
3164 (setq val
(read (current-buffer))))
3167 ;; Specifying minor-modes via mode: is
3168 ;; deprecated, but try to reject them anyway.
3171 (setq val2
(downcase (symbol-name val
)))))
3172 (setq result
(intern (concat val2
"-mode"))))
3173 (unless (eq var
'coding
)
3175 (push (cons (if (eq var
'eval
)
3177 (indirect-variable var
))
3180 (forward-line 1)))))))))
3181 ;; Now we've read all the local variables.
3182 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3183 (cond (mode-only result
)
3184 ;; Otherwise, set the variables.
3185 (enable-local-variables
3186 (hack-local-variables-filter result nil
)
3187 (hack-local-variables-apply)))))
3189 (defun hack-local-variables-apply ()
3190 "Apply the elements of `file-local-variables-alist'.
3191 If there are any elements, runs `before-hack-local-variables-hook',
3192 then calls `hack-one-local-variable' to apply the alist elements one by one.
3193 Finishes by running `hack-local-variables-hook', regardless of whether
3194 the alist is empty or not.
3196 Note that this function ignores a `mode' entry if it specifies the same
3197 major mode as the buffer already has."
3198 (when file-local-variables-alist
3199 ;; Any 'evals must run in the Right sequence.
3200 (setq file-local-variables-alist
3201 (nreverse file-local-variables-alist
))
3202 (run-hooks 'before-hack-local-variables-hook
)
3203 (dolist (elt file-local-variables-alist
)
3204 (hack-one-local-variable (car elt
) (cdr elt
))))
3205 (run-hooks 'hack-local-variables-hook
))
3207 (defun safe-local-variable-p (sym val
)
3208 "Non-nil if SYM is safe as a file-local variable with value VAL.
3209 It is safe if any of these conditions are met:
3211 * There is a matching entry (SYM . VAL) in the
3212 `safe-local-variable-values' user option.
3214 * The `safe-local-variable' property of SYM is a function that
3215 evaluates to a non-nil value with VAL as an argument."
3216 (or (member (cons sym val
) safe-local-variable-values
)
3217 (let ((safep (get sym
'safe-local-variable
)))
3218 (and (functionp safep
)
3219 ;; If the function signals an error, that means it
3220 ;; can't assure us that the value is safe.
3221 (with-demoted-errors (funcall safep val
))))))
3223 (defun risky-local-variable-p (sym &optional _ignored
)
3224 "Non-nil if SYM could be dangerous as a file-local variable.
3225 It is dangerous if either of these conditions are met:
3227 * Its `risky-local-variable' property is non-nil.
3229 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3230 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3231 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3232 \"map-alist\", or \"bindat-spec\"."
3233 ;; If this is an alias, check the base name.
3235 (setq sym
(indirect-variable sym
))
3237 (or (get sym
'risky-local-variable
)
3238 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3239 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3240 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3241 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
3243 (defun hack-one-local-variable-quotep (exp)
3244 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
3246 (defun hack-one-local-variable-constantp (exp)
3247 (or (and (not (symbolp exp
)) (not (consp exp
)))
3250 (hack-one-local-variable-quotep exp
)))
3252 (defun hack-one-local-variable-eval-safep (exp)
3253 "Return t if it is safe to eval EXP when it is found in a file."
3254 (or (not (consp exp
))
3255 ;; Detect certain `put' expressions.
3256 (and (eq (car exp
) 'put
)
3257 (hack-one-local-variable-quotep (nth 1 exp
))
3258 (hack-one-local-variable-quotep (nth 2 exp
))
3259 (let ((prop (nth 1 (nth 2 exp
)))
3261 (cond ((memq prop
'(lisp-indent-hook
3262 lisp-indent-function
3263 scheme-indent-function
))
3264 ;; Only allow safe values (not functions).
3266 (and (hack-one-local-variable-quotep val
)
3267 (eq (nth 1 val
) 'defun
))))
3268 ((eq prop
'edebug-form-spec
)
3269 ;; Only allow indirect form specs.
3270 ;; During bootstrapping, edebug-basic-spec might not be
3272 (and (fboundp 'edebug-basic-spec
)
3273 (hack-one-local-variable-quotep val
)
3274 (edebug-basic-spec (nth 1 val
)))))))
3275 ;; Allow expressions that the user requested.
3276 (member exp safe-local-eval-forms
)
3277 ;; Certain functions can be allowed with safe arguments
3278 ;; or can specify verification functions to try.
3279 (and (symbolp (car exp
))
3280 ;; Allow (minor)-modes calls with no arguments.
3281 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3282 (or (and (member (cdr exp
) '(nil (1) (-1)))
3283 (string-match "-mode\\'" (symbol-name (car exp
))))
3284 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
3287 (dolist (arg (cdr exp
))
3288 (unless (hack-one-local-variable-constantp arg
)
3295 (dolist (function prop
)
3296 (if (funcall function exp
)
3300 (defun hack-one-local-variable (var val
)
3301 "Set local variable VAR with value VAL.
3302 If VAR is `mode', call `VAL-mode' as a function unless it's
3303 already the major mode."
3304 (cond ((eq var
'mode
)
3305 (let ((mode (intern (concat (downcase (symbol-name val
))
3307 (unless (eq (indirect-function mode
)
3308 (indirect-function major-mode
))
3309 (if (memq mode minor-mode-list
)
3310 ;; A minor mode must be passed an argument.
3311 ;; Otherwise, if the user enables the minor mode in a
3312 ;; major mode hook, this would toggle it off.
3316 (save-excursion (eval val
)))
3318 ;; Make sure the string has no text properties.
3319 ;; Some text properties can get evaluated in various ways,
3320 ;; so it is risky to put them on with a local variable list.
3322 (set-text-properties 0 (length val
) nil val
))
3323 (set (make-local-variable var
) val
))))
3325 ;;; Handling directory-local variables, aka project settings.
3327 (defvar dir-locals-class-alist
'()
3328 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3330 (defvar dir-locals-directory-cache
'()
3331 "List of cached directory roots for directory-local variable classes.
3332 Each element in this list has the form (DIR CLASS MTIME).
3333 DIR is the name of the directory.
3334 CLASS is the name of a variable class (a symbol).
3335 MTIME is the recorded modification time of the directory-local
3336 variables file associated with this entry. This time is a list
3337 of two integers (the same format as `file-attributes'), and is
3338 used to test whether the cache entry is still valid.
3339 Alternatively, MTIME can be nil, which means the entry is always
3342 (defsubst dir-locals-get-class-variables
(class)
3343 "Return the variable list for CLASS."
3344 (cdr (assq class dir-locals-class-alist
)))
3346 (defun dir-locals-collect-mode-variables (mode-variables variables
)
3347 "Collect directory-local variables from MODE-VARIABLES.
3348 VARIABLES is the initial list of variables.
3349 Returns the new list."
3350 (dolist (pair mode-variables variables
)
3351 (let* ((variable (car pair
))
3353 (slot (assq variable variables
)))
3354 ;; If variables are specified more than once, only use the last. (Why?)
3355 ;; The pseudo-variables mode and eval are different (bug#3430).
3356 (if (and slot
(not (memq variable
'(mode eval
))))
3358 ;; Need a new cons in case we setcdr later.
3359 (push (cons variable value
) variables
)))))
3361 (defun dir-locals-collect-variables (class-variables root variables
)
3362 "Collect entries from CLASS-VARIABLES into VARIABLES.
3363 ROOT is the root directory of the project.
3364 Return the new variables list."
3365 (let* ((file-name (buffer-file-name))
3366 (sub-file-name (if file-name
3367 ;; FIXME: Why not use file-relative-name?
3368 (substring file-name
(length root
)))))
3370 (dolist (entry class-variables variables
)
3371 (let ((key (car entry
)))
3374 ;; Don't include this in the previous condition, because we
3375 ;; want to filter all strings before the next condition.
3376 (when (and sub-file-name
3377 (>= (length sub-file-name
) (length key
))
3378 (string-prefix-p key sub-file-name
))
3379 (setq variables
(dir-locals-collect-variables
3380 (cdr entry
) root variables
))))
3382 (derived-mode-p key
))
3383 (let* ((alist (cdr entry
))
3384 (subdirs (assq 'subdirs alist
)))
3385 (if (or (not subdirs
)
3387 (setq alist
(delq subdirs alist
))
3389 ;; TODO someone might want to extend this to allow
3390 ;; integer values for subdir, where N means
3391 ;; variables apply to this directory and N levels
3392 ;; below it (0 == nil).
3393 (equal root default-directory
))
3394 (setq variables
(dir-locals-collect-mode-variables
3395 alist variables
))))))))
3397 ;; The file's content might be invalid (e.g. have a merge conflict), but
3398 ;; that shouldn't prevent the user from opening the file.
3399 (message ".dir-locals error: %s" (error-message-string err
))
3402 (defun dir-locals-set-directory-class (directory class
&optional mtime
)
3403 "Declare that the DIRECTORY root is an instance of CLASS.
3404 DIRECTORY is the name of a directory, a string.
3405 CLASS is the name of a project class, a symbol.
3406 MTIME is either the modification time of the directory-local
3407 variables file that defined this class, or nil.
3409 When a file beneath DIRECTORY is visited, the mode-specific
3410 variables from CLASS are applied to the buffer. The variables
3411 for a class are defined using `dir-locals-set-class-variables'."
3412 (setq directory
(file-name-as-directory (expand-file-name directory
)))
3413 (unless (assq class dir-locals-class-alist
)
3414 (error "No such class `%s'" (symbol-name class
)))
3415 (push (list directory class mtime
) dir-locals-directory-cache
))
3417 (defun dir-locals-set-class-variables (class variables
)
3418 "Map the type CLASS to a list of variable settings.
3419 CLASS is the project class, a symbol. VARIABLES is a list
3420 that declares directory-local variables for the class.
3421 An element in VARIABLES is either of the form:
3422 (MAJOR-MODE . ALIST)
3426 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3427 whose elements are of the form (VARIABLE . VALUE).
3429 In the second form, DIRECTORY is a directory name (a string), and
3430 LIST is a list of the form accepted by the function.
3432 When a file is visited, the file's class is found. A directory
3433 may be assigned a class using `dir-locals-set-directory-class'.
3434 Then variables are set in the file's buffer according to the
3435 class' LIST. The list is processed in order.
3437 * If the element is of the form (MAJOR-MODE . ALIST), and the
3438 buffer's major mode is derived from MAJOR-MODE (as determined
3439 by `derived-mode-p'), then all the variables in ALIST are
3440 applied. A MAJOR-MODE of nil may be used to match any buffer.
3441 `make-local-variable' is called for each variable before it is
3444 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3445 is an initial substring of the file's directory, then LIST is
3446 applied by recursively following these rules."
3447 (let ((elt (assq class dir-locals-class-alist
)))
3449 (setcdr elt variables
)
3450 (push (cons class variables
) dir-locals-class-alist
))))
3452 (defconst dir-locals-file
".dir-locals.el"
3453 "File that contains directory-local variables.
3454 It has to be constant to enforce uniform values
3455 across different environments and users.")
3457 (defun dir-locals-find-file (file)
3458 "Find the directory-local variables for FILE.
3459 This searches upward in the directory tree from FILE.
3460 It stops at the first directory that has been registered in
3461 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3462 If it finds an entry in the cache, it checks that it is valid.
3463 A cache entry with no modification time element (normally, one that
3464 has been assigned directly using `dir-locals-set-directory-class', not
3465 set from a file) is always valid.
3466 A cache entry based on a `dir-locals-file' is valid if the modification
3467 time stored in the cache matches the current file modification time.
3468 If not, the cache entry is cleared so that the file will be re-read.
3470 This function returns either nil (no directory local variables found),
3471 or the matching entry from `dir-locals-directory-cache' (a list),
3472 or the full path to the `dir-locals-file' (a string) in the case
3473 of no valid cache entry."
3474 (setq file
(expand-file-name file
))
3475 (let* ((dir-locals-file-name
3476 (if (eq system-type
'ms-dos
)
3477 (dosified-file-name dir-locals-file
)
3479 (locals-file (locate-dominating-file file dir-locals-file-name
))
3481 ;; `locate-dominating-file' may have abbreviated the name.
3483 (setq locals-file
(expand-file-name dir-locals-file-name locals-file
)))
3484 ;; Find the best cached value in `dir-locals-directory-cache'.
3485 (dolist (elt dir-locals-directory-cache
)
3486 (when (and (eq t
(compare-strings file nil
(length (car elt
))
3489 '(windows-nt cygwin ms-dos
))))
3490 (> (length (car elt
)) (length (car dir-elt
))))
3491 (setq dir-elt elt
)))
3493 (or (null locals-file
)
3494 (<= (length (file-name-directory locals-file
))
3495 (length (car dir-elt
)))))
3496 ;; Found a potential cache entry. Check validity.
3497 ;; A cache entry with no MTIME is assumed to always be valid
3498 ;; (ie, set directly, not from a dir-locals file).
3499 ;; Note, we don't bother to check that there is a matching class
3500 ;; element in dir-locals-class-alist, since that's done by
3501 ;; dir-locals-set-directory-class.
3502 (if (or (null (nth 2 dir-elt
))
3503 (let ((cached-file (expand-file-name dir-locals-file-name
3505 (and (file-readable-p cached-file
)
3506 (equal (nth 2 dir-elt
)
3507 (nth 5 (file-attributes cached-file
))))))
3508 ;; This cache entry is OK.
3510 ;; This cache entry is invalid; clear it.
3511 (setq dir-locals-directory-cache
3512 (delq dir-elt dir-locals-directory-cache
))
3513 ;; Return the first existing dir-locals file. Might be the same
3514 ;; as dir-elt's, might not (eg latter might have been deleted).
3519 (defun dir-locals-read-from-file (file)
3520 "Load a variables FILE and register a new class and instance.
3521 FILE is the name of the file holding the variables to apply.
3522 The new class name is the same as the directory in which FILE
3523 is found. Returns the new class name."
3525 (insert-file-contents file
)
3526 (let* ((dir-name (file-name-directory file
))
3527 (class-name (intern dir-name
))
3528 (variables (let ((read-circle nil
))
3529 (read (current-buffer)))))
3530 (dir-locals-set-class-variables class-name variables
)
3531 (dir-locals-set-directory-class dir-name class-name
3532 (nth 5 (file-attributes file
)))
3535 (defun hack-dir-local-variables ()
3536 "Read per-directory local variables for the current buffer.
3537 Store the directory-local variables in `dir-local-variables-alist'
3538 and `file-local-variables-alist', without applying them."
3539 (when (and enable-local-variables
3540 (not (file-remote-p (or (buffer-file-name) default-directory
))))
3541 ;; Find the variables file.
3542 (let ((variables-file (dir-locals-find-file (or (buffer-file-name) default-directory
)))
3546 ((stringp variables-file
)
3547 (setq dir-name
(file-name-directory variables-file
)
3548 class
(dir-locals-read-from-file variables-file
)))
3549 ((consp variables-file
)
3550 (setq dir-name
(nth 0 variables-file
))
3551 (setq class
(nth 1 variables-file
))))
3554 (dir-locals-collect-variables
3555 (dir-locals-get-class-variables class
) dir-name nil
)))
3557 (dolist (elt variables
)
3558 (unless (memq (car elt
) '(eval mode
))
3559 (setq dir-local-variables-alist
3560 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3561 (push elt dir-local-variables-alist
))
3562 (hack-local-variables-filter variables dir-name
)))))))
3564 (defun hack-dir-local-variables-non-file-buffer ()
3565 (hack-dir-local-variables)
3566 (hack-local-variables-apply))
3569 (defcustom change-major-mode-with-file-name t
3570 "Non-nil means \\[write-file] should set the major mode from the file name.
3571 However, the mode will not be changed if
3572 \(1) a local variables list or the `-*-' line specifies a major mode, or
3573 \(2) the current major mode is a \"special\" mode,
3574 \ not suitable for ordinary files, or
3575 \(3) the new file name does not particularly specify any mode."
3577 :group
'editing-basics
)
3579 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3580 "Change name of file visited in current buffer to FILENAME.
3581 This also renames the buffer to correspond to the new file.
3582 The next time the buffer is saved it will go in the newly specified file.
3583 FILENAME nil or an empty string means mark buffer as not visiting any file.
3584 Remember to delete the initial contents of the minibuffer
3585 if you wish to pass an empty string as the argument.
3587 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3588 confirmation in the case where another buffer is already visiting FILENAME.
3590 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3591 the old visited file has been renamed to the new name FILENAME."
3592 (interactive "FSet visited file name: ")
3593 (if (buffer-base-buffer)
3594 (error "An indirect buffer cannot visit a file"))
3598 (if (string-equal filename
"")
3600 (expand-file-name filename
))))
3603 (setq truename
(file-truename filename
))
3604 (if find-file-visit-truename
3605 (setq filename truename
))))
3607 (let ((new-name (file-name-nondirectory filename
)))
3608 (if (string= new-name
"")
3609 (error "Empty file name"))))
3610 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3611 (and buffer
(not (eq buffer
(current-buffer)))
3613 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3616 (or (equal filename buffer-file-name
)
3618 (and filename
(lock-buffer filename
))
3620 (setq buffer-file-name filename
)
3621 (if filename
; make buffer name reflect filename.
3622 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3623 (setq default-directory
(file-name-directory buffer-file-name
))
3624 ;; If new-name == old-name, renaming would add a spurious <2>
3625 ;; and it's considered as a feature in rename-buffer.
3626 (or (string= new-name
(buffer-name))
3627 (rename-buffer new-name t
))))
3628 (setq buffer-backed-up nil
)
3630 (clear-visited-file-modtime))
3631 ;; Abbreviate the file names of the buffer.
3634 (setq buffer-file-truename
(abbreviate-file-name truename
))
3635 (if find-file-visit-truename
3636 (setq buffer-file-name truename
))))
3637 (setq buffer-file-number
3639 (nthcdr 10 (file-attributes buffer-file-name
))
3641 ;; write-file-functions is normally used for things like ftp-find-file
3642 ;; that visit things that are not local files as if they were files.
3643 ;; Changing to visit an ordinary local file instead should flush the hook.
3644 (kill-local-variable 'write-file-functions
)
3645 (kill-local-variable 'local-write-file-hooks
)
3646 (kill-local-variable 'revert-buffer-function
)
3647 (kill-local-variable 'backup-inhibited
)
3648 ;; If buffer was read-only because of version control,
3649 ;; that reason is gone now, so make it writable.
3651 (setq buffer-read-only nil
))
3652 (kill-local-variable 'vc-mode
)
3653 ;; Turn off backup files for certain file names.
3654 ;; Since this is a permanent local, the major mode won't eliminate it.
3655 (and buffer-file-name
3656 backup-enable-predicate
3657 (not (funcall backup-enable-predicate buffer-file-name
))
3659 (make-local-variable 'backup-inhibited
)
3660 (setq backup-inhibited t
)))
3661 (let ((oauto buffer-auto-save-file-name
))
3662 ;; If auto-save was not already on, turn it on if appropriate.
3663 (if (not buffer-auto-save-file-name
)
3664 (and buffer-file-name auto-save-default
3666 ;; If auto save is on, start using a new name.
3667 ;; We deliberately don't rename or delete the old auto save
3668 ;; for the old visited file name. This is because perhaps
3669 ;; the user wants to save the new state and then compare with the
3670 ;; previous state from the auto save file.
3671 (setq buffer-auto-save-file-name
3672 (make-auto-save-file-name)))
3673 ;; Rename the old auto save file if any.
3674 (and oauto buffer-auto-save-file-name
3675 (file-exists-p oauto
)
3676 (rename-file oauto buffer-auto-save-file-name t
)))
3677 (and buffer-file-name
3678 (not along-with-file
)
3679 (set-buffer-modified-p t
))
3680 ;; Update the major mode, if the file name determines it.
3682 ;; Don't change the mode if it is special.
3683 (or (not change-major-mode-with-file-name
)
3684 (get major-mode
'mode-class
)
3685 ;; Don't change the mode if the local variable list specifies it.
3686 (hack-local-variables t
)
3690 (defun write-file (filename &optional confirm
)
3691 "Write current buffer into file FILENAME.
3692 This makes the buffer visit that file, and marks it as not modified.
3694 If you specify just a directory name as FILENAME, that means to use
3695 the default file name but in that directory. You can also yank
3696 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3698 If the buffer is not already visiting a file, the default file name
3699 for the output file is the buffer name.
3701 If optional second arg CONFIRM is non-nil, this function
3702 asks for confirmation before overwriting an existing file.
3703 Interactively, confirmation is required unless you supply a prefix argument."
3704 ;; (interactive "FWrite file: ")
3706 (list (if buffer-file-name
3707 (read-file-name "Write file: "
3709 (read-file-name "Write file: " default-directory
3711 (file-name-nondirectory (buffer-name))
3714 (not current-prefix-arg
)))
3715 (or (null filename
) (string-equal filename
"")
3717 ;; If arg is just a directory,
3718 ;; use the default file name, but in that directory.
3719 (if (file-directory-p filename
)
3720 (setq filename
(concat (file-name-as-directory filename
)
3721 (file-name-nondirectory
3722 (or buffer-file-name
(buffer-name))))))
3724 (file-exists-p filename
)
3725 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3726 (error "Canceled")))
3727 (set-visited-file-name filename
(not confirm
))))
3728 (set-buffer-modified-p t
)
3729 ;; Make buffer writable if file is writable.
3730 (and buffer-file-name
3731 (file-writable-p buffer-file-name
)
3732 (setq buffer-read-only nil
))
3734 ;; It's likely that the VC status at the new location is different from
3735 ;; the one at the old location.
3736 (vc-find-file-hook))
3738 (defun backup-buffer ()
3739 "Make a backup of the disk file visited by the current buffer, if appropriate.
3740 This is normally done before saving the buffer the first time.
3742 A backup may be done by renaming or by copying; see documentation of
3743 variable `make-backup-files'. If it's done by renaming, then the file is
3744 no longer accessible under its old name.
3746 The value is non-nil after a backup was made by renaming.
3747 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3748 MODES is the result of `file-modes' on the original
3749 file; this means that the caller, after saving the buffer, should change
3750 the modes of the new file to agree with the old modes.
3751 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3752 file; this means that the caller, after saving the buffer, should change
3753 the SELinux context of the new file to agree with the old context.
3754 BACKUPNAME is the backup file name, which is the old file renamed."
3755 (if (and make-backup-files
(not backup-inhibited
)
3756 (not buffer-backed-up
)
3757 (file-exists-p buffer-file-name
)
3758 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3760 (let ((real-file-name buffer-file-name
)
3761 backup-info backupname targets setmodes
)
3762 ;; If specified name is a symbolic link, chase it to the target.
3763 ;; Thus we make the backups in the directory where the real file is.
3764 (setq real-file-name
(file-chase-links real-file-name
))
3765 (setq backup-info
(find-backup-file-name real-file-name
)
3766 backupname
(car backup-info
)
3767 targets
(cdr backup-info
))
3768 ;; (if (file-directory-p buffer-file-name)
3769 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3772 (let ((delete-old-versions
3773 ;; If have old versions to maybe delete,
3774 ;; ask the user to confirm now, before doing anything.
3775 ;; But don't actually delete til later.
3777 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3778 (or delete-old-versions
3779 (y-or-n-p (format "Delete excess backup versions of %s? "
3781 (modes (file-modes buffer-file-name
))
3782 (context (file-selinux-context buffer-file-name
)))
3783 ;; Actually write the back up file.
3785 (if (or file-precious-flag
3786 ; (file-symlink-p buffer-file-name)
3788 ;; Don't rename a suid or sgid file.
3789 (and modes
(< 0 (logand modes
#o6000
)))
3790 (not (file-writable-p (file-name-directory real-file-name
)))
3791 (and backup-by-copying-when-linked
3792 (> (file-nlinks real-file-name
) 1))
3793 (and (or backup-by-copying-when-mismatch
3794 (integerp backup-by-copying-when-privileged-mismatch
))
3795 (let ((attr (file-attributes real-file-name
)))
3796 (and (or backup-by-copying-when-mismatch
3797 (and (integerp (nth 2 attr
))
3798 (integerp backup-by-copying-when-privileged-mismatch
)
3799 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3801 (not (file-ownership-preserved-p real-file-name
)))))))
3802 (backup-buffer-copy real-file-name backupname modes context
)
3803 ;; rename-file should delete old backup.
3804 (rename-file real-file-name backupname t
)
3805 (setq setmodes
(list modes context backupname
)))
3807 ;; If trouble writing the backup, write it in
3808 ;; .emacs.d/%backup%.
3809 (setq backupname
(locate-user-emacs-file "%backup%~"))
3810 (message "Cannot write backup file; backing up in %s"
3813 (backup-buffer-copy real-file-name backupname modes context
)))
3814 (setq buffer-backed-up t
)
3815 ;; Now delete the old versions, if desired.
3816 (if delete-old-versions
3819 (delete-file (car targets
))
3821 (setq targets
(cdr targets
))))
3823 (file-error nil
))))))
3825 (defun backup-buffer-copy (from-name to-name modes context
)
3826 (let ((umask (default-file-modes)))
3829 ;; Create temp files with strict access rights. It's easy to
3830 ;; loosen them later, whereas it's impossible to close the
3831 ;; time-window of loose permissions otherwise.
3832 (set-default-file-modes ?
\700)
3833 (when (condition-case nil
3834 ;; Try to overwrite old backup first.
3835 (copy-file from-name to-name t t t
)
3837 (while (condition-case nil
3839 (when (file-exists-p to-name
)
3840 (delete-file to-name
))
3841 (copy-file from-name to-name nil t t
)
3843 (file-already-exists t
))
3844 ;; The file was somehow created by someone else between
3845 ;; `delete-file' and `copy-file', so let's try again.
3846 ;; rms says "I think there is also a possible race
3847 ;; condition for making backup files" (emacs-devel 20070821).
3850 (set-default-file-modes umask
)))
3852 (set-file-modes to-name
(logand modes
#o1777
)))
3854 (set-file-selinux-context to-name context
)))
3856 (defvar file-name-version-regexp
3857 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)"
3858 ;; The last ~[[:digit]]+ matches relative versions in git,
3859 ;; e.g. `foo.js.~HEAD~1~'.
3860 "Regular expression matching the backup/version part of a file name.
3861 Used by `file-name-sans-versions'.")
3863 (defun file-name-sans-versions (name &optional keep-backup-version
)
3864 "Return file NAME sans backup versions or strings.
3865 This is a separate procedure so your site-init or startup file can
3867 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3868 we do not remove backup version numbers, only true file version numbers.
3869 See also `file-name-version-regexp'."
3870 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
3872 (funcall handler
'file-name-sans-versions name keep-backup-version
)
3874 (unless keep-backup-version
3875 (string-match (concat file-name-version-regexp
"\\'")
3878 (defun file-ownership-preserved-p (file)
3879 "Return t if deleting FILE and rewriting it would preserve the owner."
3880 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
3882 (funcall handler
'file-ownership-preserved-p file
)
3883 (let ((attributes (file-attributes file
'integer
)))
3884 ;; Return t if the file doesn't exist, since it's true that no
3885 ;; information would be lost by an (attempted) delete and create.
3886 (or (null attributes
)
3887 (= (nth 2 attributes
) (user-uid))
3888 ;; Files created on Windows by Administrator (RID=500)
3889 ;; have the Administrators group (RID=544) recorded as
3890 ;; their owner. Rewriting them will still preserve the
3892 (and (eq system-type
'windows-nt
)
3893 (= (user-uid) 500) (= (nth 2 attributes
) 544)))))))
3895 (defun file-name-sans-extension (filename)
3896 "Return FILENAME sans final \"extension\".
3897 The extension, in a file name, is the part that follows the last `.',
3898 except that a leading `.', if any, doesn't count."
3900 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
3902 (if (and (string-match "\\.[^.]*\\'" file
)
3903 (not (eq 0 (match-beginning 0))))
3904 (if (setq directory
(file-name-directory filename
))
3905 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3906 ;; we don't want to expand it.
3907 (concat directory
(substring file
0 (match-beginning 0)))
3908 (substring file
0 (match-beginning 0)))
3911 (defun file-name-extension (filename &optional period
)
3912 "Return FILENAME's final \"extension\".
3913 The extension, in a file name, is the part that follows the last `.',
3914 excluding version numbers and backup suffixes,
3915 except that a leading `.', if any, doesn't count.
3916 Return nil for extensionless file names such as `foo'.
3917 Return the empty string for file names such as `foo.'.
3919 If PERIOD is non-nil, then the returned value includes the period
3920 that delimits the extension, and if FILENAME has no extension,
3923 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
3924 (if (and (string-match "\\.[^.]*\\'" file
)
3925 (not (eq 0 (match-beginning 0))))
3926 (substring file
(+ (match-beginning 0) (if period
0 1)))
3930 (defcustom make-backup-file-name-function nil
3931 "A function to use instead of the default `make-backup-file-name'.
3932 A value of nil gives the default `make-backup-file-name' behavior.
3934 This could be buffer-local to do something special for specific
3935 files. If you define it, you may need to change `backup-file-name-p'
3936 and `file-name-sans-versions' too.
3938 See also `backup-directory-alist'."
3940 :type
'(choice (const :tag
"Default" nil
)
3941 (function :tag
"Your function")))
3943 (defcustom backup-directory-alist nil
3944 "Alist of filename patterns and backup directory names.
3945 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3946 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3947 relative or absolute. If it is absolute, so that all matching files
3948 are backed up into the same directory, the file names in this
3949 directory will be the full name of the file backed up with all
3950 directory separators changed to `!' to prevent clashes. This will not
3951 work correctly if your filesystem truncates the resulting name.
3953 For the common case of all backups going into one directory, the alist
3954 should contain a single element pairing \".\" with the appropriate
3957 If this variable is nil, or it fails to match a filename, the backup
3958 is made in the original file's directory.
3960 On MS-DOS filesystems without long names this variable is always
3963 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
3964 (directory :tag
"Backup directory name"))))
3966 (defun normal-backup-enable-predicate (name)
3967 "Default `backup-enable-predicate' function.
3968 Checks for files in `temporary-file-directory',
3969 `small-temporary-file-directory', and /tmp."
3970 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
3972 ;; Directory is under temporary-file-directory.
3973 (and (not (eq comp t
))
3974 (< comp
(- (length temporary-file-directory
)))))
3975 (let ((comp (compare-strings "/tmp" 0 nil
3977 ;; Directory is under /tmp.
3978 (and (not (eq comp t
))
3979 (< comp
(- (length "/tmp")))))
3980 (if small-temporary-file-directory
3981 (let ((comp (compare-strings small-temporary-file-directory
3984 ;; Directory is under small-temporary-file-directory.
3985 (and (not (eq comp t
))
3986 (< comp
(- (length small-temporary-file-directory
)))))))))
3988 (defun make-backup-file-name (file)
3989 "Create the non-numeric backup file name for FILE.
3990 Normally this will just be the file's name with `~' appended.
3991 Customization hooks are provided as follows.
3993 If the variable `make-backup-file-name-function' is non-nil, its value
3994 should be a function which will be called with FILE as its argument;
3995 the resulting name is used.
3997 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3998 the documentation of that variable. If the directory for the backup
3999 doesn't exist, it is created."
4000 (if make-backup-file-name-function
4001 (funcall make-backup-file-name-function file
)
4002 (if (and (eq system-type
'ms-dos
)
4003 (not (msdos-long-file-names)))
4004 (let ((fn (file-name-nondirectory file
)))
4005 (concat (file-name-directory file
)
4006 (or (and (string-match "\\`[^.]+\\'" fn
)
4007 (concat (match-string 0 fn
) ".~"))
4008 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
4009 (concat (match-string 0 fn
) "~")))))
4010 (concat (make-backup-file-name-1 file
) "~"))))
4012 (defun make-backup-file-name-1 (file)
4013 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4014 (let ((alist backup-directory-alist
)
4015 elt backup-directory abs-backup-directory
)
4017 (setq elt
(pop alist
))
4018 (if (string-match (car elt
) file
)
4019 (setq backup-directory
(cdr elt
)
4021 ;; If backup-directory is relative, it should be relative to the
4022 ;; file's directory. By expanding explicitly here, we avoid
4023 ;; depending on default-directory.
4024 (if backup-directory
4025 (setq abs-backup-directory
4026 (expand-file-name backup-directory
4027 (file-name-directory file
))))
4028 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
4030 (make-directory abs-backup-directory
'parents
)
4031 (file-error (setq backup-directory nil
4032 abs-backup-directory nil
))))
4033 (if (null backup-directory
)
4035 (if (file-name-absolute-p backup-directory
)
4037 (when (memq system-type
'(windows-nt ms-dos cygwin
))
4038 ;; Normalize DOSish file names: downcase the drive
4039 ;; letter, if any, and replace the leading "x:" with
4041 (or (file-name-absolute-p file
)
4042 (setq file
(expand-file-name file
))) ; make defaults explicit
4043 ;; Replace any invalid file-name characters (for the
4044 ;; case of backing up remote files).
4045 (setq file
(expand-file-name (convert-standard-filename file
)))
4046 (if (eq (aref file
1) ?
:)
4047 (setq file
(concat "/"
4049 (char-to-string (downcase (aref file
0)))
4050 (if (eq (aref file
2) ?
/)
4053 (substring file
2)))))
4054 ;; Make the name unique by substituting directory
4055 ;; separators. It may not really be worth bothering about
4056 ;; doubling `!'s in the original name...
4058 (subst-char-in-string
4060 (replace-regexp-in-string "!" "!!" file
))
4062 (expand-file-name (file-name-nondirectory file
)
4063 (file-name-as-directory abs-backup-directory
))))))
4065 (defun backup-file-name-p (file)
4066 "Return non-nil if FILE is a backup file name (numeric or not).
4067 This is a separate function so you can redefine it for customization.
4068 You may need to redefine `file-name-sans-versions' as well."
4069 (string-match "~\\'" file
))
4071 (defvar backup-extract-version-start
)
4073 ;; This is used in various files.
4074 ;; The usage of backup-extract-version-start is not very clean,
4075 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4076 (defun backup-extract-version (fn)
4077 "Given the name of a numeric backup file, FN, return the backup number.
4078 Uses the free variable `backup-extract-version-start', whose value should be
4079 the index in the name where the version number begins."
4080 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start
)
4081 (= (match-beginning 0) backup-extract-version-start
))
4082 (string-to-number (substring fn backup-extract-version-start -
1))
4085 (defun find-backup-file-name (fn)
4086 "Find a file name for a backup file FN, and suggestions for deletions.
4087 Value is a list whose car is the name for the backup file
4088 and whose cdr is a list of old versions to consider deleting now.
4089 If the value is nil, don't make a backup.
4090 Uses `backup-directory-alist' in the same way as does
4091 `make-backup-file-name'."
4092 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
4093 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4095 (funcall handler
'find-backup-file-name fn
)
4096 (if (or (eq version-control
'never
)
4097 ;; We don't support numbered backups on plain MS-DOS
4098 ;; when long file names are unavailable.
4099 (and (eq system-type
'ms-dos
)
4100 (not (msdos-long-file-names))))
4101 (list (make-backup-file-name fn
))
4102 (let* ((basic-name (make-backup-file-name-1 fn
))
4103 (base-versions (concat (file-name-nondirectory basic-name
)
4105 (backup-extract-version-start (length base-versions
))
4107 (number-to-delete 0)
4108 possibilities deserve-versions-p versions
)
4110 (setq possibilities
(file-name-all-completions
4112 (file-name-directory basic-name
))
4113 versions
(sort (mapcar #'backup-extract-version
4116 high-water-mark
(apply 'max
0 versions
)
4117 deserve-versions-p
(or version-control
4118 (> high-water-mark
0))
4119 number-to-delete
(- (length versions
)
4123 (file-error (setq possibilities nil
)))
4124 (if (not deserve-versions-p
)
4125 (list (make-backup-file-name fn
))
4126 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
4127 (if (and (> number-to-delete
0)
4128 ;; Delete nothing if there is overflow
4129 ;; in the number of versions to keep.
4130 (>= (+ kept-new-versions kept-old-versions -
1) 0))
4132 (format "%s.~%d~" basic-name n
))
4133 (let ((v (nthcdr kept-old-versions versions
)))
4134 (rplacd (nthcdr (1- number-to-delete
) v
) ())
4137 (defun file-nlinks (filename)
4138 "Return number of names file FILENAME has."
4139 (car (cdr (file-attributes filename
))))
4141 ;; (defun file-relative-name (filename &optional directory)
4142 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4143 ;; This function returns a relative file name which is equivalent to FILENAME
4144 ;; when used with that default directory as the default.
4145 ;; If this is impossible (which can happen on MSDOS and Windows
4146 ;; when the file name and directory use different drive names)
4147 ;; then it returns FILENAME."
4149 ;; (let ((fname (expand-file-name filename)))
4150 ;; (setq directory (file-name-as-directory
4151 ;; (expand-file-name (or directory default-directory))))
4152 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4153 ;; ;; drive names, they can't be relative, so return the absolute name.
4154 ;; (if (and (or (eq system-type 'ms-dos)
4155 ;; (eq system-type 'cygwin)
4156 ;; (eq system-type 'windows-nt))
4157 ;; (not (string-equal (substring fname 0 2)
4158 ;; (substring directory 0 2))))
4160 ;; (let ((ancestor ".")
4161 ;; (fname-dir (file-name-as-directory fname)))
4162 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4163 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4164 ;; (setq directory (file-name-directory (substring directory 0 -1))
4165 ;; ancestor (if (equal ancestor ".")
4167 ;; (concat "../" ancestor))))
4168 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4169 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4170 ;; ;; We matched within FNAME's directory part.
4171 ;; ;; Add the rest of FNAME onto ANCESTOR.
4172 ;; (let ((rest (substring fname (match-end 0))))
4173 ;; (if (and (equal ancestor ".")
4174 ;; (not (equal rest "")))
4175 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4177 ;; (concat (file-name-as-directory ancestor) rest)))
4178 ;; ;; We matched FNAME's directory equivalent.
4181 (defun file-relative-name (filename &optional directory
)
4182 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4183 This function returns a relative file name which is equivalent to FILENAME
4184 when used with that default directory as the default.
4185 If FILENAME and DIRECTORY lie on different machines or on different drives
4186 on a DOS/Windows machine, it returns FILENAME in expanded form."
4189 (file-name-as-directory (expand-file-name (or directory
4190 default-directory
))))
4191 (setq filename
(expand-file-name filename
))
4192 (let ((fremote (file-remote-p filename
))
4193 (dremote (file-remote-p directory
)))
4194 (if ;; Conditions for separate trees
4196 ;; Test for different filesystems on DOS/Windows
4198 ;; Should `cygwin' really be included here? --stef
4199 (memq system-type
'(ms-dos cygwin windows-nt
))
4201 ;; Test for different drive letters
4202 (not (eq t
(compare-strings filename
0 2 directory
0 2)))
4203 ;; Test for UNCs on different servers
4204 (not (eq t
(compare-strings
4206 (if (string-match "\\`//\\([^:/]+\\)/" filename
)
4207 (match-string 1 filename
)
4208 ;; Windows file names cannot have ? in
4209 ;; them, so use that to detect when
4210 ;; neither FILENAME nor DIRECTORY is a
4215 (if (string-match "\\`//\\([^:/]+\\)/" directory
)
4216 (match-string 1 directory
)
4219 ;; Test for different remote file system identification
4220 (not (equal fremote dremote
)))
4222 (let ((ancestor ".")
4223 (filename-dir (file-name-as-directory filename
)))
4226 (eq t
(compare-strings filename-dir nil
(length directory
)
4227 directory nil nil case-fold-search
))
4228 (eq t
(compare-strings filename nil
(length directory
)
4229 directory nil nil case-fold-search
))))
4230 (setq directory
(file-name-directory (substring directory
0 -
1))
4231 ancestor
(if (equal ancestor
".")
4233 (concat "../" ancestor
))))
4234 ;; Now ancestor is empty, or .., or ../.., etc.
4235 (if (eq t
(compare-strings filename nil
(length directory
)
4236 directory nil nil case-fold-search
))
4237 ;; We matched within FILENAME's directory part.
4238 ;; Add the rest of FILENAME onto ANCESTOR.
4239 (let ((rest (substring filename
(length directory
))))
4240 (if (and (equal ancestor
".") (not (equal rest
"")))
4241 ;; But don't bother with ANCESTOR if it would give us `./'.
4243 (concat (file-name-as-directory ancestor
) rest
)))
4244 ;; We matched FILENAME's directory equivalent.
4247 (defun save-buffer (&optional args
)
4248 "Save current buffer in visited file if modified.
4249 Variations are described below.
4251 By default, makes the previous version into a backup file
4252 if previously requested or if this is the first save.
4253 Prefixed with one \\[universal-argument], marks this version
4254 to become a backup when the next save is done.
4255 Prefixed with two \\[universal-argument]'s,
4256 unconditionally makes the previous version into a backup file.
4257 Prefixed with three \\[universal-argument]'s, marks this version
4258 to become a backup when the next save is done,
4259 and unconditionally makes the previous version into a backup file.
4261 With a numeric argument of 0, never make the previous version
4264 If a file's name is FOO, the names of its numbered backup versions are
4265 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4266 Numeric backups (rather than FOO~) will be made if value of
4267 `version-control' is not the atom `never' and either there are already
4268 numeric versions of the file being backed up, or `version-control' is
4270 We don't want excessive versions piling up, so there are variables
4271 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4272 and `kept-new-versions', which tells how many newest versions to keep.
4273 Defaults are 2 old versions and 2 new.
4274 `dired-kept-versions' controls dired's clean-directory (.) command.
4275 If `delete-old-versions' is nil, system will query user
4276 before trimming versions. Otherwise it does it silently.
4278 If `vc-make-backup-files' is nil, which is the default,
4279 no backup files are made for files managed by version control.
4280 (This is because the version control system itself records previous versions.)
4282 See the subroutine `basic-save-buffer' for more information."
4284 (let ((modp (buffer-modified-p))
4285 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
4286 (memq args
'(16 64)))))
4287 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
4288 ;; We used to display the message below only for files > 50KB, but
4289 ;; then Rmail-mbox never displays it due to buffer swapping. If
4290 ;; the test is ever re-introduced, be sure to handle saving of
4292 (if (and modp
(buffer-file-name))
4293 (message "Saving file %s..." (buffer-file-name)))
4295 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
4297 (defun delete-auto-save-file-if-necessary (&optional force
)
4298 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4299 Normally delete only if the file was written by this Emacs since
4300 the last real save, but optional arg FORCE non-nil means delete anyway."
4301 (and buffer-auto-save-file-name delete-auto-save-files
4302 (not (string= buffer-file-name buffer-auto-save-file-name
))
4303 (or force
(recent-auto-save-p))
4306 (delete-file buffer-auto-save-file-name
)
4308 (set-buffer-auto-saved))))
4310 (defvar auto-save-hook nil
4311 "Normal hook run just before auto-saving.")
4313 (defcustom before-save-hook nil
4314 "Normal hook that is run before a buffer is saved to its file."
4315 :options
'(copyright-update time-stamp
)
4319 (defcustom after-save-hook nil
4320 "Normal hook that is run after a buffer is saved to its file."
4321 :options
'(executable-make-buffer-file-executable-if-script-p)
4325 (defvar save-buffer-coding-system nil
4326 "If non-nil, use this coding system for saving the buffer.
4327 More precisely, use this coding system in place of the
4328 value of `buffer-file-coding-system', when saving the buffer.
4329 Calling `write-region' for any purpose other than saving the buffer
4330 will still use `buffer-file-coding-system'; this variable has no effect
4333 (make-variable-buffer-local 'save-buffer-coding-system
)
4334 (put 'save-buffer-coding-system
'permanent-local t
)
4336 (defun basic-save-buffer ()
4337 "Save the current buffer in its visited file, if it has been modified.
4338 The hooks `write-contents-functions' and `write-file-functions' get a chance
4339 to do the job of saving; if they do not, then the buffer is saved in
4340 the visited file in the usual way.
4341 Before and after saving the buffer, this function runs
4342 `before-save-hook' and `after-save-hook', respectively."
4344 (save-current-buffer
4345 ;; In an indirect buffer, save its base buffer instead.
4346 (if (buffer-base-buffer)
4347 (set-buffer (buffer-base-buffer)))
4348 (if (or (buffer-modified-p)
4349 ;; handle the case when no modification has been made but
4350 ;; the file disappeared since visited
4351 (and buffer-file-name
4352 (not (file-exists-p buffer-file-name
))))
4353 (let ((recent-save (recent-auto-save-p))
4355 ;; If buffer has no file name, ask user for one.
4356 (or buffer-file-name
4359 (read-file-name "File to save in: ") nil
)))
4360 (if (file-exists-p filename
)
4361 (if (file-directory-p filename
)
4362 ;; Signal an error if the user specified the name of an
4363 ;; existing directory.
4364 (error "%s is a directory" filename
)
4365 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4367 (error "Canceled")))
4368 ;; Signal an error if the specified name refers to a
4369 ;; non-existing directory.
4370 (let ((dir (file-name-directory filename
)))
4371 (unless (file-directory-p dir
)
4372 (if (file-exists-p dir
)
4373 (error "%s is not a directory" dir
)
4374 (error "%s: no such directory" dir
)))))
4375 (set-visited-file-name filename
)))
4376 (or (verify-visited-file-modtime (current-buffer))
4377 (not (file-exists-p buffer-file-name
))
4380 "%s has changed since visited or saved. Save anyway? "
4381 (file-name-nondirectory buffer-file-name
)))
4382 (error "Save not confirmed"))
4386 (and (> (point-max) (point-min))
4387 (not find-file-literally
)
4388 (/= (char-after (1- (point-max))) ?
\n)
4389 (not (and (eq selective-display t
)
4390 (= (char-after (1- (point-max))) ?
\r)))
4391 (or (eq require-final-newline t
)
4392 (eq require-final-newline
'visit-save
)
4393 (and require-final-newline
4395 (format "Buffer %s does not end in newline. Add one? "
4398 (goto-char (point-max))
4400 ;; Support VC version backups.
4402 (run-hooks 'before-save-hook
)
4403 (or (run-hook-with-args-until-success 'write-contents-functions
)
4404 (run-hook-with-args-until-success 'local-write-file-hooks
)
4405 (run-hook-with-args-until-success 'write-file-functions
)
4406 ;; If a hook returned t, file is already "written".
4407 ;; Otherwise, write it the usual way now.
4408 (setq setmodes
(basic-save-buffer-1)))
4409 ;; Now we have saved the current buffer. Let's make sure
4410 ;; that buffer-file-coding-system is fixed to what
4411 ;; actually used for saving by binding it locally.
4412 (if save-buffer-coding-system
4413 (setq save-buffer-coding-system last-coding-system-used
)
4414 (setq buffer-file-coding-system last-coding-system-used
))
4415 (setq buffer-file-number
4416 (nthcdr 10 (file-attributes buffer-file-name
)))
4420 (set-file-modes buffer-file-name
(car setmodes
))
4421 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))
4423 ;; If the auto-save file was recent before this command,
4425 (delete-auto-save-file-if-necessary recent-save
)
4426 ;; Support VC `implicit' locking.
4428 (run-hooks 'after-save-hook
))
4429 (message "(No changes need to be saved)"))))
4431 ;; This does the "real job" of writing a buffer into its visited file
4432 ;; and making a backup file. This is what is normally done
4433 ;; but inhibited if one of write-file-functions returns non-nil.
4434 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4435 (defun basic-save-buffer-1 ()
4437 (if save-buffer-coding-system
4438 (let ((coding-system-for-write save-buffer-coding-system
))
4439 (basic-save-buffer-2))
4440 (basic-save-buffer-2))
4441 (if buffer-file-coding-system-explicit
4442 (setcar buffer-file-coding-system-explicit last-coding-system-used
)
4443 (setq buffer-file-coding-system-explicit
4444 (cons last-coding-system-used nil
)))))
4446 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4447 (defun basic-save-buffer-2 ()
4448 (let (tempsetmodes setmodes
)
4449 (if (not (file-writable-p buffer-file-name
))
4450 (let ((dir (file-name-directory buffer-file-name
)))
4451 (if (not (file-directory-p dir
))
4452 (if (file-exists-p dir
)
4453 (error "%s is not a directory" dir
)
4454 (error "%s: no such directory" dir
))
4455 (if (not (file-exists-p buffer-file-name
))
4456 (error "Directory %s write-protected" dir
)
4459 "File %s is write-protected; try to save anyway? "
4460 (file-name-nondirectory
4462 (setq tempsetmodes t
)
4463 (error "Attempt to save to a file which you aren't allowed to write"))))))
4464 (or buffer-backed-up
4465 (setq setmodes
(backup-buffer)))
4466 (let* ((dir (file-name-directory buffer-file-name
))
4467 (dir-writable (file-writable-p dir
)))
4468 (if (or (and file-precious-flag dir-writable
)
4469 (and break-hardlink-on-save
4470 (file-exists-p buffer-file-name
)
4471 (> (file-nlinks buffer-file-name
) 1)
4473 (error (concat (format
4474 "Directory %s write-protected; " dir
)
4475 "cannot break hardlink when saving")))))
4476 ;; Write temp name, then rename it.
4477 ;; This requires write access to the containing dir,
4478 ;; which is why we don't try it if we don't have that access.
4479 (let ((realname buffer-file-name
)
4481 (umask (default-file-modes))
4482 (old-modtime (visited-file-modtime)))
4483 ;; Create temp files with strict access rights. It's easy to
4484 ;; loosen them later, whereas it's impossible to close the
4485 ;; time-window of loose permissions otherwise.
4488 (clear-visited-file-modtime)
4489 (set-default-file-modes ?
\700)
4490 ;; Try various temporary names.
4491 ;; This code follows the example of make-temp-file,
4492 ;; but it calls write-region in the appropriate way
4493 ;; for saving the buffer.
4494 (while (condition-case ()
4498 (expand-file-name "tmp" dir
)))
4499 ;; Pass in nil&nil rather than point-min&max
4500 ;; cause we're saving the whole buffer.
4501 ;; write-region-annotate-functions may use it.
4502 (write-region nil nil
4503 tempname nil realname
4504 buffer-file-truename
'excl
)
4506 (file-already-exists t
))
4507 ;; The file was somehow created by someone else between
4508 ;; `make-temp-name' and `write-region', let's try again.
4512 (set-default-file-modes umask
)
4513 ;; If we failed, restore the buffer's modtime.
4515 (set-visited-file-modtime old-modtime
)))
4516 ;; Since we have created an entirely new file,
4517 ;; make sure it gets the right permission bits set.
4518 (setq setmodes
(or setmodes
4519 (list (or (file-modes buffer-file-name
)
4520 (logand ?
\666 umask
))
4521 (file-selinux-context buffer-file-name
)
4523 ;; We succeeded in writing the temp file,
4525 (rename-file tempname buffer-file-name t
))
4526 ;; If file not writable, see if we can make it writable
4527 ;; temporarily while we write it.
4528 ;; But no need to do so if we have just backed it up
4529 ;; (setmodes is set) because that says we're superseding.
4530 (cond ((and tempsetmodes
(not setmodes
))
4531 ;; Change the mode back, after writing.
4532 (setq setmodes
(list (file-modes buffer-file-name
)
4533 (file-selinux-context buffer-file-name
)
4535 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))
4536 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))))
4540 ;; Pass in nil&nil rather than point-min&max to indicate
4541 ;; we're saving the buffer rather than just a region.
4542 ;; write-region-annotate-functions may make us of it.
4543 (write-region nil nil
4544 buffer-file-name nil t buffer-file-truename
)
4546 ;; If we get an error writing the new file, and we made
4547 ;; the backup by renaming, undo the backing-up.
4548 (and setmodes
(not success
)
4550 (rename-file (nth 2 setmodes
) buffer-file-name t
)
4551 (setq buffer-backed-up nil
))))))
4554 (declare-function diff-no-select
"diff"
4555 (old new
&optional switches no-async buf
))
4557 (defvar save-some-buffers-action-alist
4560 (if (not enable-recursive-minibuffers
)
4561 (progn (display-buffer buf
)
4562 (setq other-window-scroll-buffer buf
))
4563 (view-buffer buf
(lambda (_) (exit-recursive-edit)))
4565 ;; Return nil to ask about BUF again.
4567 ,(purecopy "view this buffer"))
4569 (if (null (buffer-file-name buf
))
4570 (message "Not applicable: no file")
4571 (require 'diff
) ;for diff-no-select.
4572 (let ((diffbuf (diff-no-select (buffer-file-name buf
) buf
4574 (if (not enable-recursive-minibuffers
)
4575 (progn (display-buffer diffbuf
)
4576 (setq other-window-scroll-buffer diffbuf
))
4577 (view-buffer diffbuf
(lambda (_) (exit-recursive-edit)))
4579 ;; Return nil to ask about BUF again.
4581 ,(purecopy "view changes in this buffer")))
4582 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4583 (put 'save-some-buffers-action-alist
'risky-local-variable t
)
4585 (defvar buffer-save-without-query nil
4586 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4587 (make-variable-buffer-local 'buffer-save-without-query
)
4589 (defun save-some-buffers (&optional arg pred
)
4590 "Save some modified file-visiting buffers. Asks user about each one.
4591 You can answer `y' to save, `n' not to save, `C-r' to look at the
4592 buffer in question with `view-buffer' before deciding or `d' to
4593 view the differences using `diff-buffer-with-file'.
4595 This command first saves any buffers where `buffer-save-without-query' is
4596 non-nil, without asking.
4598 Optional argument (the prefix) non-nil means save all with no questions.
4599 Optional second argument PRED determines which buffers are considered:
4600 If PRED is nil, all the file-visiting buffers are considered.
4601 If PRED is t, then certain non-file buffers will also be considered.
4602 If PRED is a zero-argument function, it indicates for each buffer whether
4603 to consider it or not when called with that buffer current.
4605 See `save-some-buffers-action-alist' if you want to
4606 change the additional actions you can take on files."
4608 (save-window-excursion
4609 (let* (queried autosaved-buffers
4610 files-done abbrevs-done
)
4611 (dolist (buffer (buffer-list))
4612 ;; First save any buffers that we're supposed to save unconditionally.
4613 ;; That way the following code won't ask about them.
4614 (with-current-buffer buffer
4615 (when (and buffer-save-without-query
(buffer-modified-p))
4616 (push (buffer-name) autosaved-buffers
)
4618 ;; Ask about those buffers that merit it,
4619 ;; and record the number thus saved.
4623 ;; Note that killing some buffers may kill others via
4624 ;; hooks (e.g. Rmail and its viewing buffer).
4625 (and (buffer-live-p buffer
)
4626 (buffer-modified-p buffer
)
4627 (not (buffer-base-buffer buffer
))
4629 (buffer-file-name buffer
)
4633 (and buffer-offer-save
(> (buffer-size) 0)))))
4634 (or (not (functionp pred
))
4635 (with-current-buffer buffer
(funcall pred
)))
4639 (if (buffer-file-name buffer
)
4640 (format "Save file %s? "
4641 (buffer-file-name buffer
))
4642 (format "Save buffer %s? "
4643 (buffer-name buffer
))))))
4645 (with-current-buffer buffer
4648 '("buffer" "buffers" "save")
4649 save-some-buffers-action-alist
))
4650 ;; Maybe to save abbrevs, and record whether
4651 ;; we either saved them or asked to.
4652 (and save-abbrevs abbrevs-changed
4655 (eq save-abbrevs
'silently
)
4656 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name
)))
4657 (write-abbrev-file nil
))
4658 ;; Don't keep bothering user if he says no.
4659 (setq abbrevs-changed nil
)
4660 (setq abbrevs-done t
)))
4661 (or queried
(> files-done
0) abbrevs-done
4663 ((null autosaved-buffers
)
4664 (message "(No files need saving)"))
4665 ((= (length autosaved-buffers
) 1)
4666 (message "(Saved %s)" (car autosaved-buffers
)))
4668 (message "(Saved %d files: %s)"
4669 (length autosaved-buffers
)
4670 (mapconcat 'identity autosaved-buffers
", "))))))))
4672 (defun not-modified (&optional arg
)
4673 "Mark current buffer as unmodified, not needing to be saved.
4674 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4676 It is not a good idea to use this function in Lisp programs, because it
4677 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4679 (message (if arg
"Modification-flag set"
4680 "Modification-flag cleared"))
4681 (set-buffer-modified-p arg
))
4683 (defun toggle-read-only (&optional arg
)
4684 "Change whether this buffer is read-only.
4685 With prefix argument ARG, make the buffer read-only if ARG is
4686 positive, otherwise make it writable. If buffer is read-only
4687 and `view-read-only' is non-nil, enter view mode."
4690 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4691 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4695 ((and buffer-read-only view-mode
)
4696 (View-exit-and-edit)
4697 (make-local-variable 'view-read-only
)
4698 (setq view-read-only t
)) ; Must leave view mode.
4699 ((and (not buffer-read-only
) view-read-only
4700 ;; If view-mode is already active, `view-mode-enter' is a nop.
4702 (not (eq (get major-mode
'mode-class
) 'special
)))
4704 (t (setq buffer-read-only
(not buffer-read-only
))
4705 (force-mode-line-update)))
4706 (if (vc-backend buffer-file-name
)
4707 (message "%s" (substitute-command-keys
4708 (concat "File is under version-control; "
4709 "use \\[vc-next-action] to check in/out"))))))
4711 (defun insert-file (filename)
4712 "Insert contents of file FILENAME into buffer after point.
4713 Set mark after the inserted text.
4715 This function is meant for the user to run interactively.
4716 Don't call it from programs! Use `insert-file-contents' instead.
4717 \(Its calling sequence is different; see its documentation)."
4718 (interactive "*fInsert file: ")
4719 (insert-file-1 filename
#'insert-file-contents
))
4721 (defun append-to-file (start end filename
)
4722 "Append the contents of the region to the end of file FILENAME.
4723 When called from a function, expects three arguments,
4724 START, END and FILENAME. START and END are normally buffer positions
4725 specifying the part of the buffer to write.
4726 If START is nil, that means to use the entire buffer contents.
4727 If START is a string, then output that string to the file
4728 instead of any buffer contents; END is ignored.
4730 This does character code conversion and applies annotations
4731 like `write-region' does."
4732 (interactive "r\nFAppend to file: ")
4733 (write-region start end filename t
))
4735 (defun file-newest-backup (filename)
4736 "Return most recent backup file for FILENAME or nil if no backups exist."
4737 ;; `make-backup-file-name' will get us the right directory for
4738 ;; ordinary or numeric backups. It might create a directory for
4739 ;; backups as a side-effect, according to `backup-directory-alist'.
4740 (let* ((filename (file-name-sans-versions
4741 (make-backup-file-name (expand-file-name filename
))))
4742 (file (file-name-nondirectory filename
))
4743 (dir (file-name-directory filename
))
4744 (comp (file-name-all-completions file dir
))
4748 (setq tem
(pop comp
))
4749 (cond ((and (backup-file-name-p tem
)
4750 (string= (file-name-sans-versions tem
) file
))
4751 (setq tem
(concat dir tem
))
4752 (if (or (null newest
)
4753 (file-newer-than-file-p tem newest
))
4754 (setq newest tem
)))))
4757 (defun rename-uniquely ()
4758 "Rename current buffer to a similar name not already taken.
4759 This function is useful for creating multiple shell process buffers
4760 or multiple mail buffers, etc."
4763 (let ((base-name (buffer-name)))
4764 (and (string-match "<[0-9]+>\\'" base-name
)
4765 (not (and buffer-file-name
4767 (file-name-nondirectory buffer-file-name
))))
4768 ;; If the existing buffer name has a <NNN>,
4769 ;; which isn't part of the file name (if any),
4770 ;; then get rid of that.
4771 (setq base-name
(substring base-name
0 (match-beginning 0))))
4772 (rename-buffer (generate-new-buffer-name base-name
))
4773 (force-mode-line-update))))
4775 (defun make-directory (dir &optional parents
)
4776 "Create the directory DIR and optionally any nonexistent parent dirs.
4777 If DIR already exists as a directory, signal an error, unless
4780 Interactively, the default choice of directory to create is the
4781 current buffer's default directory. That is useful when you have
4782 visited a file in a nonexistent directory.
4784 Noninteractively, the second (optional) argument PARENTS, if
4785 non-nil, says whether to create parent directories that don't
4786 exist. Interactively, this happens by default."
4788 (list (read-file-name "Make directory: " default-directory default-directory
4791 ;; If default-directory is a remote directory,
4792 ;; make sure we find its make-directory handler.
4793 (setq dir
(expand-file-name dir
))
4794 (let ((handler (find-file-name-handler dir
'make-directory
)))
4796 (funcall handler
'make-directory dir parents
)
4798 (make-directory-internal dir
)
4799 (let ((dir (directory-file-name (expand-file-name dir
)))
4801 (while (and (not (file-exists-p dir
))
4802 ;; If directory is its own parent, then we can't
4803 ;; keep looping forever
4805 (directory-file-name
4806 (file-name-directory dir
)))))
4807 (setq create-list
(cons dir create-list
)
4808 dir
(directory-file-name (file-name-directory dir
))))
4810 (make-directory-internal (car create-list
))
4811 (setq create-list
(cdr create-list
))))))))
4813 (defconst directory-files-no-dot-files-regexp
4814 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4815 "Regexp matching any file name except \".\" and \"..\".")
4817 (defun delete-directory (directory &optional recursive trash
)
4818 "Delete the directory named DIRECTORY. Does not follow symlinks.
4819 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4820 TRASH non-nil means to trash the directory instead, provided
4821 `delete-by-moving-to-trash' is non-nil.
4823 When called interactively, TRASH is t if no prefix argument is
4824 given. With a prefix argument, TRASH is nil."
4826 (let* ((trashing (and delete-by-moving-to-trash
4827 (null current-prefix-arg
)))
4828 (dir (expand-file-name
4829 (read-directory-name
4831 "Move directory to trash: "
4832 "Delete directory: ")
4833 default-directory default-directory nil nil
))))
4835 (if (directory-files dir nil directory-files-no-dot-files-regexp
)
4837 (format "Directory `%s' is not empty, really %s? "
4838 dir
(if trashing
"trash" "delete")))
4840 (null current-prefix-arg
))))
4841 ;; If default-directory is a remote directory, make sure we find its
4842 ;; delete-directory handler.
4843 (setq directory
(directory-file-name (expand-file-name directory
)))
4844 (let ((handler (find-file-name-handler directory
'delete-directory
)))
4847 (funcall handler
'delete-directory directory recursive
))
4848 ((and delete-by-moving-to-trash trash
)
4849 ;; Only move non-empty dir to trash if recursive deletion was
4850 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4851 ;; case, where the operation fails in delete-directory-internal.
4852 ;; As `move-file-to-trash' trashes directories (empty or
4853 ;; otherwise) as a unit, we do not need to recurse here.
4854 (if (and (not recursive
)
4855 ;; Check if directory is empty apart from "." and "..".
4857 directory
'full directory-files-no-dot-files-regexp
))
4858 (error "Directory is not empty, not moving to trash")
4859 (move-file-to-trash directory
)))
4860 ;; Otherwise, call outselves recursively if needed.
4862 (if (and recursive
(not (file-symlink-p directory
)))
4863 (mapc (lambda (file)
4864 ;; This test is equivalent to
4865 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4866 ;; but more efficient
4867 (if (eq t
(car (file-attributes file
)))
4868 (delete-directory file recursive nil
)
4869 (delete-file file nil
)))
4870 ;; We do not want to delete "." and "..".
4872 directory
'full directory-files-no-dot-files-regexp
)))
4873 (delete-directory-internal directory
)))))
4875 (defun copy-directory (directory newname
&optional keep-time parents copy-contents
)
4876 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4877 This function always sets the file modes of the output files to match
4878 the corresponding input file.
4880 The third arg KEEP-TIME non-nil means give the output files the same
4881 last-modified time as the old ones. (This works on only some systems.)
4883 A prefix arg makes KEEP-TIME non-nil.
4885 Noninteractively, the last argument PARENTS says whether to
4886 create parent directories if they don't exist. Interactively,
4887 this happens by default.
4889 If NEWNAME names an existing directory, copy DIRECTORY as a
4890 subdirectory there. However, if called from Lisp with a non-nil
4891 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
4892 directly into NEWNAME instead."
4894 (let ((dir (read-directory-name
4895 "Copy directory: " default-directory default-directory t nil
)))
4897 (read-directory-name
4898 (format "Copy directory %s to: " dir
)
4899 default-directory default-directory nil nil
)
4900 current-prefix-arg t nil
)))
4901 ;; If default-directory is a remote directory, make sure we find its
4902 ;; copy-directory handler.
4903 (let ((handler (or (find-file-name-handler directory
'copy-directory
)
4904 (find-file-name-handler newname
'copy-directory
))))
4906 (funcall handler
'copy-directory directory newname keep-time parents
)
4908 ;; Compute target name.
4909 (setq directory
(directory-file-name (expand-file-name directory
))
4910 newname
(directory-file-name (expand-file-name newname
)))
4912 (cond ((not (file-directory-p newname
))
4913 ;; If NEWNAME is not an existing directory, create it;
4914 ;; that is where we will copy the files of DIRECTORY.
4915 (make-directory newname parents
))
4916 ;; If NEWNAME is an existing directory and COPY-CONTENTS
4917 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
4918 ((not copy-contents
)
4919 (setq newname
(expand-file-name
4920 (file-name-nondirectory
4921 (directory-file-name directory
))
4923 (and (file-exists-p newname
)
4924 (not (file-directory-p newname
))
4925 (error "Cannot overwrite non-directory %s with a directory"
4927 (make-directory newname t
)))
4929 ;; Copy recursively.
4931 ;; We do not want to copy "." and "..".
4932 (directory-files directory
'full
4933 directory-files-no-dot-files-regexp
))
4934 (if (file-directory-p file
)
4935 (copy-directory file newname keep-time parents
)
4936 (let ((target (expand-file-name (file-name-nondirectory file
) newname
))
4937 (attrs (file-attributes file
)))
4938 (if (stringp (car attrs
)) ; Symbolic link
4939 (make-symbolic-link (car attrs
) target t
)
4940 (copy-file file target t keep-time
)))))
4942 ;; Set directory attributes.
4943 (set-file-modes newname
(file-modes directory
))
4945 (set-file-times newname
(nth 5 (file-attributes directory
)))))))
4947 (put 'revert-buffer-function
'permanent-local t
)
4948 (defvar revert-buffer-function nil
4949 "Function to use to revert this buffer, or nil to do the default.
4950 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4951 which are the arguments that `revert-buffer' received.")
4953 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
4954 (defvar revert-buffer-insert-file-contents-function nil
4955 "Function to use to insert contents when reverting this buffer.
4956 Gets two args, first the nominal file name to use,
4957 and second, t if reading the auto-save file.
4959 The function you specify is responsible for updating (or preserving) point.")
4961 (defvar buffer-stale-function nil
4962 "Function to check whether a non-file buffer needs reverting.
4963 This should be a function with one optional argument NOCONFIRM.
4964 Auto Revert Mode passes t for NOCONFIRM. The function should return
4965 non-nil if the buffer should be reverted. A return value of
4966 `fast' means that the need for reverting was not checked, but
4967 that reverting the buffer is fast. The buffer is current when
4968 this function is called.
4970 The idea behind the NOCONFIRM argument is that it should be
4971 non-nil if the buffer is going to be reverted without asking the
4972 user. In such situations, one has to be careful with potentially
4973 time consuming operations.
4975 For more information on how this variable is used by Auto Revert mode,
4976 see Info node `(emacs)Supporting additional buffers'.")
4978 (defvar before-revert-hook nil
4979 "Normal hook for `revert-buffer' to run before reverting.
4980 If `revert-buffer-function' is used to override the normal revert
4981 mechanism, this hook is not used.")
4983 (defvar after-revert-hook nil
4984 "Normal hook for `revert-buffer' to run after reverting.
4985 Note that the hook value that it runs is the value that was in effect
4986 before reverting; that makes a difference if you have buffer-local
4989 If `revert-buffer-function' is used to override the normal revert
4990 mechanism, this hook is not used.")
4992 (defvar revert-buffer-in-progress-p nil
4993 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
4994 This is true even if a `revert-buffer-function' is being used.")
4996 (defvar revert-buffer-internal-hook
)
4998 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
4999 "Replace current buffer text with the text of the visited file on disk.
5000 This undoes all changes since the file was visited or saved.
5001 With a prefix argument, offer to revert from latest auto-save file, if
5002 that is more recent than the visited file.
5004 This command also implements an interface for special buffers
5005 that contain text which doesn't come from a file, but reflects
5006 some other data instead (e.g. Dired buffers, `buffer-list'
5007 buffers). This is done via the variable `revert-buffer-function'.
5008 In these cases, it should reconstruct the buffer contents from the
5011 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5012 to revert from the auto-save file when this is nil. Note that the
5013 sense of this argument is the reverse of the prefix argument, for the
5014 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5017 Optional second argument NOCONFIRM means don't ask for confirmation
5018 at all. (The variable `revert-without-query' offers another way to
5019 revert buffers without querying for confirmation.)
5021 Optional third argument PRESERVE-MODES non-nil means don't alter
5022 the files modes. Normally we reinitialize them using `normal-mode'.
5024 If the value of `revert-buffer-function' is non-nil, it is called to
5025 do all the work for this command. Otherwise, the hooks
5026 `before-revert-hook' and `after-revert-hook' are run at the beginning
5027 and the end, and if `revert-buffer-insert-file-contents-function' is
5028 non-nil, it is called instead of rereading visited file contents."
5030 ;; I admit it's odd to reverse the sense of the prefix argument, but
5031 ;; there is a lot of code out there which assumes that the first
5032 ;; argument should be t to avoid consulting the auto-save file, and
5033 ;; there's no straightforward way to encourage authors to notice a
5034 ;; reversal of the argument sense. So I'm just changing the user
5035 ;; interface, but leaving the programmatic interface the same.
5036 (interactive (list (not current-prefix-arg
)))
5037 (if revert-buffer-function
5038 (let ((revert-buffer-in-progress-p t
))
5039 (funcall revert-buffer-function ignore-auto noconfirm
))
5040 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5042 (let* ((revert-buffer-in-progress-p t
)
5043 (auto-save-p (and (not ignore-auto
)
5044 (recent-auto-save-p)
5045 buffer-auto-save-file-name
5046 (file-readable-p buffer-auto-save-file-name
)
5048 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5049 (file-name (if auto-save-p
5050 buffer-auto-save-file-name
5052 (cond ((null file-name
)
5053 (error "Buffer does not seem to be associated with any file"))
5055 (and (not (buffer-modified-p))
5057 (dolist (regexp revert-without-query
)
5058 (when (string-match regexp file-name
)
5059 (throw 'found t
)))))
5060 (yes-or-no-p (format "Revert buffer from file %s? "
5062 (run-hooks 'before-revert-hook
)
5063 ;; If file was backed up but has changed since,
5064 ;; we should make another backup.
5065 (and (not auto-save-p
)
5066 (not (verify-visited-file-modtime (current-buffer)))
5067 (setq buffer-backed-up nil
))
5068 ;; Effectively copy the after-revert-hook status,
5069 ;; since after-find-file will clobber it.
5070 (let ((global-hook (default-value 'after-revert-hook
))
5071 (local-hook (when (local-variable-p 'after-revert-hook
)
5073 (inhibit-read-only t
))
5075 (revert-buffer-insert-file-contents-function
5076 (unless (eq buffer-undo-list t
)
5077 ;; Get rid of all undo records for this buffer.
5078 (setq buffer-undo-list nil
))
5079 ;; Don't make undo records for the reversion.
5080 (let ((buffer-undo-list t
))
5081 (funcall revert-buffer-insert-file-contents-function
5082 file-name auto-save-p
)))
5083 ((not (file-exists-p file-name
))
5084 (error (if buffer-file-number
5085 "File %s no longer exists!"
5086 "Cannot revert nonexistent file %s")
5088 ((not (file-readable-p file-name
))
5089 (error (if buffer-file-number
5090 "File %s no longer readable!"
5091 "Cannot revert unreadable file %s")
5094 ;; Bind buffer-file-name to nil
5095 ;; so that we don't try to lock the file.
5096 (let ((buffer-file-name nil
))
5100 (let ((coding-system-for-read
5101 ;; Auto-saved file should be read by Emacs'
5103 (if auto-save-p
'auto-save-coding
5104 (or coding-system-for-read
5106 buffer-file-coding-system-explicit
5107 (car buffer-file-coding-system-explicit
))))))
5108 (if (and (not enable-multibyte-characters
)
5109 coding-system-for-read
5110 (not (memq (coding-system-base
5111 coding-system-for-read
)
5112 '(no-conversion raw-text
))))
5113 ;; As a coding system suitable for multibyte
5114 ;; buffer is specified, make the current
5115 ;; buffer multibyte.
5116 (set-buffer-multibyte t
))
5118 ;; This force after-insert-file-set-coding
5119 ;; (called from insert-file-contents) to set
5120 ;; buffer-file-coding-system to a proper value.
5121 (kill-local-variable 'buffer-file-coding-system
)
5123 ;; Note that this preserves point in an intelligent way.
5125 (let ((buffer-file-format buffer-file-format
))
5126 (insert-file-contents file-name
(not auto-save-p
)
5128 (insert-file-contents file-name
(not auto-save-p
)
5130 ;; Recompute the truename in case changes in symlinks
5131 ;; have changed the truename.
5132 (setq buffer-file-truename
5133 (abbreviate-file-name (file-truename buffer-file-name
)))
5134 (after-find-file nil nil t nil preserve-modes
)
5135 ;; Run after-revert-hook as it was before we reverted.
5136 (setq-default revert-buffer-internal-hook global-hook
)
5138 (set (make-local-variable 'revert-buffer-internal-hook
)
5140 (kill-local-variable 'revert-buffer-internal-hook
))
5141 (run-hooks 'revert-buffer-internal-hook
))
5144 (defun recover-this-file ()
5145 "Recover the visited file--get contents from its last auto-save file."
5147 (recover-file buffer-file-name
))
5149 (defun recover-file (file)
5150 "Visit file FILE, but get contents from its last auto-save file."
5151 ;; Actually putting the file name in the minibuffer should be used
5153 ;; Not just because users often use the default.
5154 (interactive "FRecover file: ")
5155 (setq file
(expand-file-name file
))
5156 (if (auto-save-file-name-p (file-name-nondirectory file
))
5157 (error "%s is an auto-save file" (abbreviate-file-name file
)))
5158 (let ((file-name (let ((buffer-file-name file
))
5159 (make-auto-save-file-name))))
5160 (cond ((if (file-exists-p file
)
5161 (not (file-newer-than-file-p file-name file
))
5162 (not (file-exists-p file-name
)))
5163 (error "Auto-save file %s not current"
5164 (abbreviate-file-name file-name
)))
5165 ((save-window-excursion
5166 (with-output-to-temp-buffer "*Directory*"
5167 (buffer-disable-undo standard-output
)
5169 (let ((switches dired-listing-switches
))
5170 (if (file-symlink-p file
)
5171 (setq switches
(concat switches
" -L")))
5172 (set-buffer standard-output
)
5173 ;; Use insert-directory-safely, not insert-directory,
5174 ;; because these files might not exist. In particular,
5175 ;; FILE might not exist if the auto-save file was for
5176 ;; a buffer that didn't visit a file, such as "*mail*".
5177 ;; The code in v20.x called `ls' directly, so we need
5178 ;; to emulate what `ls' did in that case.
5179 (insert-directory-safely file switches
)
5180 (insert-directory-safely file-name switches
))))
5181 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
5182 (switch-to-buffer (find-file-noselect file t
))
5183 (let ((inhibit-read-only t
)
5184 ;; Keep the current buffer-file-coding-system.
5185 (coding-system buffer-file-coding-system
)
5186 ;; Auto-saved file should be read with special coding.
5187 (coding-system-for-read 'auto-save-coding
))
5189 (insert-file-contents file-name nil
)
5190 (set-buffer-file-coding-system coding-system
))
5191 (after-find-file nil nil t
))
5192 (t (error "Recover-file cancelled")))))
5194 (defun recover-session ()
5195 "Recover auto save files from a previous Emacs session.
5196 This command first displays a Dired buffer showing you the
5197 previous sessions that you could recover from.
5198 To choose one, move point to the proper line and then type C-c C-c.
5199 Then you'll be asked about a number of files to recover."
5201 (if (null auto-save-list-file-prefix
)
5202 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5203 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
5204 (unless (file-directory-p dir
)
5205 (make-directory dir t
))
5206 (unless (directory-files dir nil
5207 (concat "\\`" (regexp-quote
5208 (file-name-nondirectory
5209 auto-save-list-file-prefix
)))
5211 (error "No previous sessions to recover")))
5212 (let ((ls-lisp-support-shell-wildcards t
))
5213 (dired (concat auto-save-list-file-prefix
"*")
5214 (concat dired-listing-switches
" -t")))
5216 (goto-char (point-min))
5217 (or (looking-at " Move to the session you want to recover,")
5218 (let ((inhibit-read-only t
))
5219 ;; Each line starts with a space
5220 ;; so that Font Lock mode won't highlight the first character.
5221 (insert " Move to the session you want to recover,\n"
5222 " then type C-c C-c to select it.\n\n"
5223 " You can also delete some of these files;\n"
5224 " type d on a line to mark that file for deletion.\n\n"))))
5225 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5226 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
5228 (defun recover-session-finish ()
5229 "Choose one saved session to recover auto-save files from.
5230 This command is used in the special Dired buffer created by
5231 \\[recover-session]."
5233 ;; Get the name of the session file to recover from.
5234 (let ((file (dired-get-filename))
5236 (buffer (get-buffer-create " *recover*")))
5238 (dired-do-flagged-delete t
)
5240 (with-current-buffer buffer
5241 ;; Read in the auto-save-list file.
5243 (insert-file-contents file
)
5244 ;; Loop thru the text of that file
5245 ;; and get out the names of the files to recover.
5247 (let (thisfile autofile
)
5249 ;; This is a pair of lines for a non-file-visiting buffer.
5250 ;; Get the auto-save file name and manufacture
5251 ;; a "visited file name" from that.
5254 ;; If there is no auto-save file name, the
5255 ;; auto-save-list file is probably corrupted.
5258 (buffer-substring-no-properties
5260 (line-end-position)))
5264 (file-name-nondirectory autofile
)
5266 (file-name-directory autofile
))))
5268 ;; This pair of lines is a file-visiting
5269 ;; buffer. Use the visited file name.
5272 (buffer-substring-no-properties
5273 (point) (progn (end-of-line) (point))))
5276 (buffer-substring-no-properties
5277 (point) (progn (end-of-line) (point))))
5279 ;; Ignore a file if its auto-save file does not exist now.
5280 (if (and autofile
(file-exists-p autofile
))
5281 (setq files
(cons thisfile files
)))))
5282 (setq files
(nreverse files
))
5283 ;; The file contains a pair of line for each auto-saved buffer.
5284 ;; The first line of the pair contains the visited file name
5285 ;; or is empty if the buffer was not visiting a file.
5286 ;; The second line is the auto-save file name.
5288 (map-y-or-n-p "Recover %s? "
5291 (save-excursion (recover-file file
))
5293 "Failed to recover `%s'" file
)))
5295 '("file" "files" "recover"))
5296 (message "No files can be recovered from this session now")))
5297 (kill-buffer buffer
))))
5299 (defun kill-buffer-ask (buffer)
5300 "Kill BUFFER if confirmed."
5301 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5302 (buffer-name buffer
)
5303 (if (buffer-modified-p buffer
)
5304 "HAS BEEN EDITED" "is unmodified")))
5305 (kill-buffer buffer
)))
5307 (defun kill-some-buffers (&optional list
)
5308 "Kill some buffers. Asks the user whether to kill each one of them.
5309 Non-interactively, if optional argument LIST is non-nil, it
5310 specifies the list of buffers to kill, asking for approval for each one."
5313 (setq list
(buffer-list)))
5315 (let* ((buffer (car list
))
5316 (name (buffer-name buffer
)))
5317 (and name
; Can be nil for an indirect buffer
5318 ; if we killed the base buffer.
5319 (not (string-equal name
""))
5320 (/= (aref name
0) ?\s
)
5321 (kill-buffer-ask buffer
)))
5322 (setq list
(cdr list
))))
5324 (defun kill-matching-buffers (regexp &optional internal-too
)
5325 "Kill buffers whose name matches the specified REGEXP.
5326 The optional second argument indicates whether to kill internal buffers too."
5327 (interactive "sKill buffers matching this regular expression: \nP")
5328 (dolist (buffer (buffer-list))
5329 (let ((name (buffer-name buffer
)))
5330 (when (and name
(not (string-equal name
""))
5331 (or internal-too
(/= (aref name
0) ?\s
))
5332 (string-match regexp name
))
5333 (kill-buffer-ask buffer
)))))
5336 (defun rename-auto-save-file ()
5337 "Adjust current buffer's auto save file name for current conditions.
5338 Also rename any existing auto save file, if it was made in this session."
5339 (let ((osave buffer-auto-save-file-name
))
5340 (setq buffer-auto-save-file-name
5341 (make-auto-save-file-name))
5342 (if (and osave buffer-auto-save-file-name
5343 (not (string= buffer-auto-save-file-name buffer-file-name
))
5344 (not (string= buffer-auto-save-file-name osave
))
5345 (file-exists-p osave
)
5346 (recent-auto-save-p))
5347 (rename-file osave buffer-auto-save-file-name t
))))
5349 (defun make-auto-save-file-name ()
5350 "Return file name to use for auto-saves of current buffer.
5351 Does not consider `auto-save-visited-file-name' as that variable is checked
5352 before calling this function. You can redefine this for customization.
5353 See also `auto-save-file-name-p'."
5354 (if buffer-file-name
5355 (let ((handler (find-file-name-handler buffer-file-name
5356 'make-auto-save-file-name
)))
5358 (funcall handler
'make-auto-save-file-name
)
5359 (let ((list auto-save-file-name-transforms
)
5360 (filename buffer-file-name
)
5362 ;; Apply user-specified translations
5363 ;; to the file name.
5364 (while (and list
(not result
))
5365 (if (string-match (car (car list
)) filename
)
5366 (setq result
(replace-match (cadr (car list
)) t nil
5368 uniq
(car (cddr (car list
)))))
5369 (setq list
(cdr list
)))
5372 (setq filename
(concat
5373 (file-name-directory result
)
5374 (subst-char-in-string
5376 (replace-regexp-in-string "!" "!!"
5378 (setq filename result
)))
5380 (if (and (eq system-type
'ms-dos
)
5381 (not (msdos-long-file-names)))
5382 ;; We truncate the file name to DOS 8+3 limits
5383 ;; before doing anything else, because the regexp
5384 ;; passed to string-match below cannot handle
5385 ;; extensions longer than 3 characters, multiple
5386 ;; dots, and other atrocities.
5387 (let ((fn (dos-8+3-filename
5388 (file-name-nondirectory buffer-file-name
))))
5390 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5392 (concat (file-name-directory buffer-file-name
)
5393 "#" (match-string 1 fn
)
5394 "." (match-string 3 fn
) "#"))
5395 (concat (file-name-directory filename
)
5397 (file-name-nondirectory filename
)
5399 ;; Make sure auto-save file names don't contain characters
5400 ;; invalid for the underlying filesystem.
5401 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5402 ;; Don't modify remote (ange-ftp) filenames
5403 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
5404 (convert-standard-filename result
)
5407 ;; Deal with buffers that don't have any associated files. (Mail
5408 ;; mode tends to create a good number of these.)
5410 (let ((buffer-name (buffer-name))
5413 ;; Restrict the characters used in the file name to those which
5414 ;; are known to be safe on all filesystems, url-encoding the
5416 ;; We do this on all platforms, because even if we are not
5417 ;; running on DOS/Windows, the current directory may be on a
5418 ;; mounted VFAT filesystem, such as a USB memory stick.
5419 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
5420 (let* ((character (aref buffer-name
(match-beginning 0)))
5422 ;; For multibyte characters, this will produce more than
5423 ;; 2 hex digits, so is not true URL encoding.
5424 (format "%%%02X" character
)))
5425 (setq buffer-name
(replace-match replacement t t buffer-name
))
5426 (setq limit
(1+ (match-end 0)))))
5427 ;; Generate the file name.
5432 (format "#%s#" buffer-name
)
5433 ;; Try a few alternative directories, to get one we can
5436 ((file-writable-p default-directory
) default-directory
)
5437 ((file-writable-p "/var/tmp/") "/var/tmp/")
5439 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5440 ;; Don't modify remote (ange-ftp) filenames
5441 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
5442 ;; The call to convert-standard-filename is in case
5443 ;; buffer-name includes characters not allowed by the
5444 ;; DOS/Windows filesystems. make-temp-file writes to the
5445 ;; file it creates, so we must fix the file name _before_
5446 ;; make-temp-file is called.
5447 (convert-standard-filename fname
)
5450 ;; make-temp-file creates the file,
5451 ;; but we don't want it to exist until we do an auto-save.
5453 (delete-file file-name
)
5457 (defun auto-save-file-name-p (filename)
5458 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5459 FILENAME should lack slashes. You can redefine this for customization."
5460 (string-match "^#.*#$" filename
))
5462 (defun wildcard-to-regexp (wildcard)
5463 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5464 The generated regexp will match a filename only if the filename
5465 matches that wildcard according to shell rules. Only wildcards known
5466 by `sh' are supported."
5467 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
5468 ;; Copy the initial run of non-special characters.
5469 (result (substring wildcard
0 i
))
5470 (len (length wildcard
)))
5471 ;; If no special characters, we're almost done.
5474 (let ((ch (aref wildcard i
))
5482 (eq (aref wildcard
(1+ i
)) ?\
]))
5484 ((eq ch ?\
[) ; [...] maps to regexp char class
5489 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
5492 (if (eq (aref wildcard i
) ?\
])
5497 ((eq (aref wildcard i
) ?^
)
5498 ;; Found "[^". Insert a `\0' character
5499 ;; (which cannot happen in a filename)
5500 ;; into the character class, so that `^'
5501 ;; is not the first character after `[',
5502 ;; and thus non-special in a regexp.
5506 ((eq (aref wildcard i
) ?\
])
5507 ;; I don't think `]' can appear in a
5508 ;; character class in a wildcard, but
5509 ;; let's be general here.
5514 (prog1 ; copy everything upto next `]'.
5517 (setq j
(string-match
5519 (setq i
(if j
(1- j
) (1- len
)))))))
5521 ((eq ch ?
*) "[^\000]*")
5525 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
5526 ((eq ch ??
) "[^\000]")
5527 (t (char-to-string ch
)))))
5529 ;; Shell wildcards should match the entire filename,
5530 ;; not its part. Make the regexp say so.
5531 (concat "\\`" result
"\\'")))
5533 (defcustom list-directory-brief-switches
5535 "Switches for `list-directory' to pass to `ls' for brief listing."
5539 (defcustom list-directory-verbose-switches
5541 "Switches for `list-directory' to pass to `ls' for verbose listing."
5545 (defun file-expand-wildcards (pattern &optional full
)
5546 "Expand wildcard pattern PATTERN.
5547 This returns a list of file names which match the pattern.
5549 If PATTERN is written as an absolute file name,
5550 the values are absolute also.
5552 If PATTERN is written as a relative file name, it is interpreted
5553 relative to the current default directory, `default-directory'.
5554 The file names returned are normally also relative to the current
5555 default directory. However, if FULL is non-nil, they are absolute."
5557 (let* ((nondir (file-name-nondirectory pattern
))
5558 (dirpart (file-name-directory pattern
))
5559 ;; A list of all dirs that DIRPART specifies.
5560 ;; This can be more than one dir
5561 ;; if DIRPART contains wildcards.
5562 (dirs (if (and dirpart
5563 (string-match "[[*?]"
5564 (or (file-remote-p dirpart
'localname
)
5566 (mapcar 'file-name-as-directory
5567 (file-expand-wildcards (directory-file-name dirpart
)))
5571 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
5572 (file-directory-p (directory-file-name (car dirs
))))
5573 (let ((this-dir-contents
5574 ;; Filter out "." and ".."
5576 (mapcar #'(lambda (name)
5577 (unless (string-match "\\`\\.\\.?\\'"
5578 (file-name-nondirectory name
))
5580 (directory-files (or (car dirs
) ".") full
5581 (wildcard-to-regexp nondir
))))))
5584 (if (and (car dirs
) (not full
))
5585 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
5589 (setq dirs
(cdr dirs
)))
5592 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5593 (provide 'files
'(remote-wildcards))
5595 (defun list-directory (dirname &optional verbose
)
5596 "Display a list of files in or matching DIRNAME, a la `ls'.
5597 DIRNAME is globbed by the shell if necessary.
5598 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5599 Actions controlled by variables `list-directory-brief-switches'
5600 and `list-directory-verbose-switches'."
5601 (interactive (let ((pfx current-prefix-arg
))
5602 (list (read-directory-name (if pfx
"List directory (verbose): "
5603 "List directory (brief): ")
5604 nil default-directory nil
)
5606 (let ((switches (if verbose list-directory-verbose-switches
5607 list-directory-brief-switches
))
5609 (or dirname
(setq dirname default-directory
))
5610 (setq dirname
(expand-file-name dirname
))
5611 (with-output-to-temp-buffer "*Directory*"
5612 (setq buffer standard-output
)
5613 (buffer-disable-undo standard-output
)
5614 (princ "Directory ")
5617 (with-current-buffer "*Directory*"
5618 (let ((wildcard (not (file-directory-p dirname
))))
5619 (insert-directory dirname switches wildcard
(not wildcard
)))))
5620 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5621 (with-current-buffer buffer
5622 (setq default-directory
5623 (if (file-directory-p dirname
)
5624 (file-name-as-directory dirname
)
5625 (file-name-directory dirname
))))))
5627 (defun shell-quote-wildcard-pattern (pattern)
5628 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5630 PATTERN is assumed to represent a file-name wildcard suitable for the
5631 underlying filesystem. For Unix and GNU/Linux, each character from the
5632 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5633 the parts of the pattern which don't include wildcard characters are
5634 quoted with double quotes.
5636 This function leaves alone existing quote characters (\\ on Unix and \"
5637 on Windows), so PATTERN can use them to quote wildcard characters that
5638 need to be passed verbatim to shell commands."
5641 ((memq system-type
'(ms-dos windows-nt cygwin
))
5642 ;; DOS/Windows don't allow `"' in file names. So if the
5643 ;; argument has quotes, we can safely assume it is already
5644 ;; quoted by the caller.
5645 (if (or (string-match "[\"]" pattern
)
5646 ;; We quote [&()#$'] in case their shell is a port of a
5647 ;; Unixy shell. We quote [,=+] because stock DOS and
5648 ;; Windows shells require that in some cases, such as
5649 ;; passing arguments to batch files that use positional
5650 ;; arguments like %1.
5651 (not (string-match "[ \t;&()#$',=+]" pattern
)))
5656 (while (string-match "[*?]+" pattern beg
)
5657 (setq end
(match-beginning 0)
5658 result
(concat result
(substring pattern beg end
)
5660 (substring pattern end
(match-end 0))
5663 (concat result
(substring pattern beg
) "\""))))
5666 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
5668 (concat (substring pattern
0 (match-beginning 0))
5670 (substring pattern
(match-beginning 0)))
5671 beg
(1+ (match-end 0)))))
5675 (defvar insert-directory-program
(purecopy "ls")
5676 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5678 (defcustom directory-free-space-program
(purecopy "df")
5679 "Program to get the amount of free space on a file system.
5680 We assume the output has the format of `df'.
5681 The value of this variable must be just a command name or file name;
5682 if you want to specify options, use `directory-free-space-args'.
5684 A value of nil disables this feature.
5686 If the function `file-system-info' is defined, it is always used in
5687 preference to the program given by this variable."
5688 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
5691 (defcustom directory-free-space-args
5692 (purecopy (if (eq system-type
'darwin
) "-k" "-Pk"))
5693 "Options to use when running `directory-free-space-program'."
5697 (defun get-free-disk-space (dir)
5698 "Return the amount of free space on directory DIR's file system.
5699 The return value is a string describing the amount of free
5700 space (normally, the number of free 1KB blocks).
5702 This function calls `file-system-info' if it is available, or
5703 invokes the program specified by `directory-free-space-program'
5704 and `directory-free-space-args'. If the system call or program
5705 is unsuccessful, or if DIR is a remote directory, this function
5707 (unless (file-remote-p dir
)
5708 ;; Try to find the number of free blocks. Non-Posix systems don't
5709 ;; always have df, but might have an equivalent system call.
5710 (if (fboundp 'file-system-info
)
5711 (let ((fsinfo (file-system-info dir
)))
5713 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
5714 (setq dir
(expand-file-name dir
))
5717 (when (and directory-free-space-program
5718 ;; Avoid failure if the default directory does
5719 ;; not exist (Bug#2631, Bug#3911).
5720 (let ((default-directory "/"))
5721 (eq (call-process directory-free-space-program
5723 directory-free-space-args
5726 ;; Assume that the "available" column is before the
5727 ;; "capacity" column. Find the "%" and scan backward.
5728 (goto-char (point-min))
5730 (when (re-search-forward
5731 "[[:space:]]+[^[:space:]]+%[^%]*$"
5732 (line-end-position) t
)
5733 (goto-char (match-beginning 0))
5734 (let ((endpt (point)))
5735 (skip-chars-backward "^[:space:]")
5736 (buffer-substring-no-properties (point) endpt
)))))))))
5738 ;; The following expression replaces `dired-move-to-filename-regexp'.
5739 (defvar directory-listing-before-filename-regexp
5740 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5741 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5742 ;; In some locales, month abbreviations are as short as 2 letters,
5743 ;; and they can be followed by ".".
5744 ;; In Breton, a month name can include a quote character.
5745 (month (concat l-or-quote l-or-quote
"+\\.?"))
5747 (yyyy "[0-9][0-9][0-9][0-9]")
5749 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5750 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5751 (zone "[-+][0-2][0-9][0-5][0-9]")
5752 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5753 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5754 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5755 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5756 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5758 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5759 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5760 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5761 ;; omits the Kanji characters after month and day-of-month.
5762 ;; On Mac OS X 10.3, the date format in East Asian locales is
5763 ;; day-of-month digits followed by month digits.
5766 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5767 "\\|" dd s mm s
"+" "\\)"
5768 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5769 ;; The "[0-9]" below requires the previous column to end in a digit.
5770 ;; This avoids recognizing `1 may 1997' as a date in the line:
5771 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5773 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5775 ;; For non-iso date formats, we add the ".*" in order to find
5776 ;; the last possible match. This avoids recognizing
5777 ;; `jservice 10 1024' as a date in the line:
5778 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5780 ;; vc dired listings provide the state or blanks between file
5781 ;; permissions and date. The state is always surrounded by
5783 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5784 ;; This is not supported yet.
5785 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5786 "\\|.*[0-9][BkKMGTPEZY]? "
5787 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\)"
5789 "Regular expression to match up to the file name in a directory listing.
5790 The default value is designed to recognize dates and times
5791 regardless of the language.")
5793 (defvar insert-directory-ls-version
'unknown
)
5796 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5797 ;; FULL-DIRECTORY-P is nil.
5798 ;; The single line of output must display FILE's name as it was
5799 ;; given, namely, an absolute path name.
5800 ;; - must insert exactly one line for each file if WILDCARD or
5801 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5802 ;; before the file lines, plus optional text after the file lines.
5803 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5805 ;; File lines should display the basename.
5806 ;; - must be consistent with
5807 ;; - functions dired-move-to-filename, (these two define what a file line is)
5808 ;; dired-move-to-end-of-filename,
5809 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5810 ;; dired-insert-headerline
5811 ;; dired-after-subdir-garbage (defines what a "total" line is)
5812 ;; - variable dired-subdir-regexp
5813 ;; - may be passed "--dired" as the first argument in SWITCHES.
5814 ;; Filename handlers might have to remove this switch if their
5815 ;; "ls" command does not support it.
5816 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
5817 "Insert directory listing for FILE, formatted according to SWITCHES.
5818 Leaves point after the inserted text.
5819 SWITCHES may be a string of options, or a list of strings
5820 representing individual options.
5821 Optional third arg WILDCARD means treat FILE as shell wildcard.
5822 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5823 switches do not contain `d', so that a full listing is expected.
5825 This works by running a directory listing program
5826 whose name is in the variable `insert-directory-program'.
5827 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5829 When SWITCHES contains the long `--dired' option, this function
5830 treats it specially, for the sake of dired. However, the
5831 normally equivalent short `-D' option is just passed on to
5832 `insert-directory-program', as any other option."
5833 ;; We need the directory in order to find the right handler.
5834 (let ((handler (find-file-name-handler (expand-file-name file
)
5835 'insert-directory
)))
5837 (funcall handler
'insert-directory file switches
5838 wildcard full-directory-p
)
5839 (let (result (beg (point)))
5841 ;; Read the actual directory using `insert-directory-program'.
5842 ;; RESULT gets the status code.
5843 (let* (;; We at first read by no-conversion, then after
5844 ;; putting text property `dired-filename, decode one
5845 ;; bunch by one to preserve that property.
5846 (coding-system-for-read 'no-conversion
)
5847 ;; This is to control encoding the arguments in call-process.
5848 (coding-system-for-write
5849 (and enable-multibyte-characters
5850 (or file-name-coding-system
5851 default-file-name-coding-system
))))
5854 ;; Run ls in the directory part of the file pattern
5855 ;; using the last component as argument.
5856 (let ((default-directory
5857 (if (file-name-absolute-p file
)
5858 (file-name-directory file
)
5859 (file-name-directory (expand-file-name file
))))
5860 (pattern (file-name-nondirectory file
)))
5861 ;; NB since switches is passed to the shell, be
5862 ;; careful of malicious values, eg "-l;reboot".
5863 ;; See eg dired-safe-switches-p.
5865 shell-file-name nil t nil
5867 (concat (if (memq system-type
'(ms-dos windows-nt
))
5869 "\\") ; Disregard Unix shell aliases!
5870 insert-directory-program
5872 (if (stringp switches
)
5874 (mapconcat 'identity switches
" "))
5876 ;; Quote some characters that have
5877 ;; special meanings in shells; but
5878 ;; don't quote the wildcards--we want
5879 ;; them to be special. We also
5880 ;; currently don't quote the quoting
5881 ;; characters in case people want to
5882 ;; use them explicitly to quote
5883 ;; wildcard characters.
5884 (shell-quote-wildcard-pattern pattern
))))
5885 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5886 ;; directory if FILE is a symbolic link.
5887 (unless full-directory-p
5889 (if (stringp switches
)
5890 (concat switches
" -d")
5891 (add-to-list 'switches
"-d" 'append
))))
5892 (apply 'call-process
5893 insert-directory-program nil t nil
5895 (if (listp switches
) switches
5896 (unless (equal switches
"")
5897 ;; Split the switches at any spaces so we can
5898 ;; pass separate options as separate args.
5899 (split-string switches
)))
5900 ;; Avoid lossage if FILE starts with `-'.
5903 (if (string-match "\\`~" file
)
5904 (setq file
(expand-file-name file
)))
5906 (if full-directory-p
5907 (concat (file-name-as-directory file
) ".")
5910 ;; If we got "//DIRED//" in the output, it means we got a real
5911 ;; directory listing, even if `ls' returned nonzero.
5912 ;; So ignore any errors.
5913 (when (if (stringp switches
)
5914 (string-match "--dired\\>" switches
)
5915 (member "--dired" switches
))
5918 (when (looking-at "//SUBDIRED//")
5920 (if (looking-at "//DIRED//")
5923 (when (and (not (eq 0 result
))
5924 (eq insert-directory-ls-version
'unknown
))
5925 ;; The first time ls returns an error,
5926 ;; find the version numbers of ls,
5927 ;; and set insert-directory-ls-version
5928 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5929 ;; is equal or if the info cannot be obtained.
5930 ;; (That can mean it isn't GNU ls.)
5933 (call-process "ls" nil t nil
"--version")
5935 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
5936 (let* ((version (match-string 1 version-out
))
5937 (split (split-string version
"[.]"))
5938 (numbers (mapcar 'string-to-number split
))
5941 (while (and (not comparison
) (or numbers min
))
5943 (setq comparison
'>))
5945 (setq comparison
'<))
5946 ((> (car numbers
) (car min
))
5947 (setq comparison
'>))
5948 ((< (car numbers
) (car min
))
5949 (setq comparison
'<))
5951 (setq numbers
(cdr numbers
)
5953 (setq insert-directory-ls-version
(or comparison
'=)))
5954 (setq insert-directory-ls-version nil
))))
5956 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5957 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
5960 ;; If `insert-directory-program' failed, signal an error.
5961 (unless (eq 0 result
)
5962 ;; Delete the error message it may have output.
5963 (delete-region beg
(point))
5964 ;; On non-Posix systems, we cannot open a directory, so
5965 ;; don't even try, because that will always result in
5966 ;; the ubiquitous "Access denied". Instead, show the
5967 ;; command line so the user can try to guess what went wrong.
5968 (if (and (file-directory-p file
)
5969 (memq system-type
'(ms-dos windows-nt
)))
5971 "Reading directory: \"%s %s -- %s\" exited with status %s"
5972 insert-directory-program
5973 (if (listp switches
) (concat switches
) switches
)
5975 ;; Unix. Access the file to get a suitable error.
5976 (access-file file
"Reading directory")
5977 (error "Listing directory failed but `access-file' worked")))
5979 (when (if (stringp switches
)
5980 (string-match "--dired\\>" switches
)
5981 (member "--dired" switches
))
5982 ;; The following overshoots by one line for an empty
5983 ;; directory listed with "--dired", but without "-a"
5984 ;; switch, where the ls output contains a
5985 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5986 ;; We take care of that case later.
5988 (when (looking-at "//SUBDIRED//")
5989 (delete-region (point) (progn (forward-line 1) (point)))
5991 (if (looking-at "//DIRED//")
5992 (let ((end (line-end-position))
5995 ;; Find all the lines that are error messages,
5996 ;; and record the bounds of each one.
5998 (while (< (point) linebeg
)
5999 (or (eql (following-char) ?\s
)
6000 (push (list (point) (line-end-position)) error-lines
))
6002 (setq error-lines
(nreverse error-lines
))
6003 ;; Now read the numeric positions of file names.
6007 (while (< (point) end
)
6008 (let ((start (insert-directory-adj-pos
6009 (+ beg
(read (current-buffer)))
6011 (end (insert-directory-adj-pos
6012 (+ beg
(read (current-buffer)))
6014 (if (memq (char-after end
) '(?
\n ?\s
))
6015 ;; End is followed by \n or by " -> ".
6016 (put-text-property start end
'dired-filename t
)
6017 ;; It seems that we can't trust ls's output as to
6018 ;; byte positions of filenames.
6019 (put-text-property beg
(point) 'dired-filename nil
)
6023 (delete-region (point) (progn (forward-line 1) (point))))
6024 ;; Take care of the case where the ls output contains a
6025 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6026 ;; and we went one line too far back (see above).
6028 (if (looking-at "//DIRED-OPTIONS//")
6029 (delete-region (point) (progn (forward-line 1) (point)))))
6031 ;; Now decode what read if necessary.
6032 (let ((coding (or coding-system-for-read
6033 file-name-coding-system
6034 default-file-name-coding-system
6038 (when (and enable-multibyte-characters
6039 (not (memq (coding-system-base coding
)
6040 '(raw-text no-conversion
))))
6041 ;; If no coding system is specified or detection is
6042 ;; requested, detect the coding.
6043 (if (eq (coding-system-base coding
) 'undecided
)
6044 (setq coding
(detect-coding-region beg
(point) t
)))
6045 (if (not (eq (coding-system-base coding
) 'undecided
))
6048 (coding-system-change-eol-conversion coding
'unix
))
6049 (narrow-to-region beg
(point))
6050 (goto-char (point-min))
6053 val
(get-text-property (point) 'dired-filename
))
6054 (goto-char (next-single-property-change
6055 (point) 'dired-filename nil
(point-max)))
6056 ;; Force no eol conversion on a file name, so
6057 ;; that CR is preserved.
6058 (decode-coding-region pos
(point)
6059 (if val coding-no-eol coding
))
6061 (put-text-property pos
(point)
6062 'dired-filename t
)))))))
6064 (if full-directory-p
6065 ;; Try to insert the amount of free space.
6068 ;; First find the line to put it on.
6069 (when (re-search-forward "^ *\\(total\\)" nil t
)
6070 (let ((available (get-free-disk-space ".")))
6072 ;; Replace "total" with "used", to avoid confusion.
6073 (replace-match "total used in directory" nil nil nil
1)
6075 (insert " available " available
))))))))))
6077 (defun insert-directory-adj-pos (pos error-lines
)
6078 "Convert `ls --dired' file name position value POS to a buffer position.
6079 File name position values returned in ls --dired output
6080 count only stdout; they don't count the error messages sent to stderr.
6081 So this function converts to them to real buffer positions.
6082 ERROR-LINES is a list of buffer positions of error message lines,
6083 of the form (START END)."
6084 (while (and error-lines
(< (caar error-lines
) pos
))
6085 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
6089 (defun insert-directory-safely (file switches
6090 &optional wildcard full-directory-p
)
6091 "Insert directory listing for FILE, formatted according to SWITCHES.
6093 Like `insert-directory', but if FILE does not exist, it inserts a
6094 message to that effect instead of signaling an error."
6095 (if (file-exists-p file
)
6096 (insert-directory file switches wildcard full-directory-p
)
6097 ;; Simulate the message printed by `ls'.
6098 (insert (format "%s: No such file or directory\n" file
))))
6100 (defvar kill-emacs-query-functions nil
6101 "Functions to call with no arguments to query about killing Emacs.
6102 If any of these functions returns nil, killing Emacs is cancelled.
6103 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6104 the low level primitive, does not. See also `kill-emacs-hook'.")
6106 (defcustom confirm-kill-emacs nil
6107 "How to ask for confirmation when leaving Emacs.
6108 If nil, the default, don't ask at all. If the value is non-nil, it should
6109 be a predicate function such as `yes-or-no-p'."
6110 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
6111 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
6112 (const :tag
"Don't confirm" nil
))
6116 (defun save-buffers-kill-emacs (&optional arg
)
6117 "Offer to save each buffer, then kill this Emacs process.
6118 With prefix ARG, silently save all file-visiting buffers, then kill."
6120 (save-some-buffers arg t
)
6121 (and (or (not (memq t
(mapcar (function
6122 (lambda (buf) (and (buffer-file-name buf
)
6123 (buffer-modified-p buf
))))
6125 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6126 (or (not (fboundp 'process-list
))
6127 ;; process-list is not defined on MSDOS.
6128 (let ((processes (process-list))
6131 (and (memq (process-status (car processes
)) '(run stop open listen
))
6132 (process-query-on-exit-flag (car processes
))
6134 (setq processes
(cdr processes
)))
6136 (progn (list-processes t
)
6137 (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))))
6138 ;; Query the user for other things, perhaps.
6139 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
6140 (or (null confirm-kill-emacs
)
6141 (funcall confirm-kill-emacs
"Really exit Emacs? "))
6144 (defun save-buffers-kill-terminal (&optional arg
)
6145 "Offer to save each buffer, then kill the current connection.
6146 If the current frame has no client, kill Emacs itself.
6148 With prefix ARG, silently save all file-visiting buffers, then kill.
6150 If emacsclient was started with a list of filenames to edit, then
6151 only these files will be asked to be saved."
6153 (if (frame-parameter (selected-frame) 'client
)
6154 (server-save-buffers-kill-terminal arg
)
6155 (save-buffers-kill-emacs arg
)))
6157 ;; We use /: as a prefix to "quote" a file name
6158 ;; so that magic file name handlers will not apply to it.
6160 (setq file-name-handler-alist
6161 (cons (cons (purecopy "\\`/:") 'file-name-non-special
)
6162 file-name-handler-alist
))
6164 ;; We depend on being the last handler on the list,
6165 ;; so that anything else which does need handling
6166 ;; has been handled already.
6167 ;; So it is safe for us to inhibit *all* magic file name handlers.
6169 (defun file-name-non-special (operation &rest arguments
)
6170 (let ((file-name-handler-alist nil
)
6172 (if (eq operation
'insert-directory
)
6173 (directory-file-name
6175 (unhandled-file-name-directory default-directory
)))
6177 ;; Get a list of the indices of the args which are file names.
6179 (cdr (or (assq operation
6180 ;; The first six are special because they
6181 ;; return a file name. We want to include the /:
6182 ;; in the return value.
6183 ;; So just avoid stripping it in the first place.
6184 '((expand-file-name . nil
)
6185 (file-name-directory . nil
)
6186 (file-name-as-directory . nil
)
6187 (directory-file-name . nil
)
6188 (file-name-sans-versions . nil
)
6189 (find-backup-file-name . nil
)
6190 ;; `identity' means just return the first arg
6191 ;; not stripped of its quoting.
6192 (substitute-in-file-name identity
)
6193 ;; `add' means add "/:" to the result.
6194 (file-truename add
0)
6195 (insert-file-contents insert-file-contents
0)
6196 ;; `unquote-then-quote' means set buffer-file-name
6197 ;; temporarily to unquoted filename.
6198 (verify-visited-file-modtime unquote-then-quote
)
6199 ;; List the arguments which are filenames.
6200 (file-name-completion 1)
6201 (file-name-all-completions 1)
6205 (make-symbolic-link 0 1)
6206 (add-name-to-file 0 1)))
6207 ;; For all other operations, treat the first argument only
6208 ;; as the file name.
6211 ;; Copy ARGUMENTS so we can replace elements in it.
6212 (arguments (copy-sequence arguments
)))
6213 (if (symbolp (car file-arg-indices
))
6214 (setq method
(pop file-arg-indices
)))
6215 ;; Strip off the /: from the file names that have it.
6217 (while (consp file-arg-indices
)
6218 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
6220 (string-match "\\`/:" (car pair
))
6222 (if (= (length (car pair
)) 2)
6224 (substring (car pair
) 2)))))
6225 (setq file-arg-indices
(cdr file-arg-indices
))))
6227 (identity (car arguments
))
6228 (add (concat "/:" (apply operation arguments
)))
6229 (insert-file-contents
6230 (let ((visit (nth 1 arguments
)))
6232 (apply operation arguments
)
6233 (when (and visit buffer-file-name
)
6234 (setq buffer-file-name
(concat "/:" buffer-file-name
))))))
6236 (let ((buffer-file-name (substring buffer-file-name
2)))
6237 (apply operation arguments
)))
6239 (apply operation arguments
)))))
6241 ;; Symbolic modes and read-file-modes.
6243 (defun file-modes-char-to-who (char)
6244 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6245 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6246 Others, or All) for whom to produce the mask.
6247 The bit-mask that is returned extracts from mode bits the access rights
6248 for the specified category of users."
6249 (cond ((= char ?u
) #o4700
)
6250 ((= char ?g
) #o2070
)
6251 ((= char ?o
) #o1007
)
6252 ((= char ?a
) #o7777
)
6253 (t (error "%c: bad `who' character" char
))))
6255 (defun file-modes-char-to-right (char &optional from
)
6256 "Convert CHAR to a numeric value of mode bits.
6257 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6258 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6259 (or from
(setq from
0))
6260 (cond ((= char ?r
) #o0444
)
6261 ((= char ?w
) #o0222
)
6262 ((= char ?x
) #o0111
)
6263 ((= char ?s
) #o1000
)
6264 ((= char ?t
) #o6000
)
6265 ;; Rights relative to the previous file modes.
6266 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
6267 ((= char ?u
) (let ((uright (logand #o4700 from
)))
6268 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
6269 ((= char ?g
) (let ((gright (logand #o2070 from
)))
6270 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
6271 ((= char ?o
) (let ((oright (logand #o1007 from
)))
6272 (+ oright
(* oright
#o10
) (* oright
#o100
))))
6273 (t (error "%c: bad right character" char
))))
6275 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
6276 "Convert a symbolic mode string specification to an equivalent number.
6277 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6278 WHO-MASK is the bit-mask specifying the category of users to which to
6279 apply the access permissions. See `file-modes-char-to-who'.
6280 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6281 RIGHTS request to add, remove, or set permissions based on existing ones,
6283 (let* ((num-rights (or from
0))
6284 (list-rights (string-to-list rights
))
6285 (op (pop list-rights
)))
6286 (while (memq op
'(?
+ ?- ?
=))
6289 (while (memq (setq char-right
(pop list-rights
))
6290 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
6293 (file-modes-char-to-right char-right num-rights
))))
6294 (setq num-right
(logand who-mask num-right
)
6296 (cond ((= op ?
+) (logior num-rights num-right
))
6297 ((= op ?-
) (logand num-rights
(lognot num-right
)))
6298 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
6302 (defun file-modes-symbolic-to-number (modes &optional from
)
6303 "Convert symbolic file modes to numeric file modes.
6304 MODES is the string to convert, it should match
6305 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6306 See (info \"(coreutils)File permissions\") for more information on this
6308 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6309 MODES request to add, remove, or set permissions based on existing ones,
6312 (let ((case-fold-search nil
)
6313 (num-modes (or from
0)))
6314 (while (/= (string-to-char modes
) 0)
6315 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes
)
6316 (let ((num-who (apply 'logior
0
6317 (mapcar 'file-modes-char-to-who
6318 (match-string 1 modes
)))))
6320 (setq num-who
(default-file-modes)))
6322 (file-modes-rights-to-number (substring modes
(match-end 1))
6324 modes
(substring modes
(match-end 3))))
6325 (error "Parse error in modes near `%s'" (substring modes
0))))
6328 (defun read-file-modes (&optional prompt orig-file
)
6329 "Read file modes in octal or symbolic notation and return its numeric value.
6330 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6331 ORIG-FILE is the name of a file on whose mode bits to base returned
6332 permissions if what user types requests to add, remove, or set permissions
6333 based on existing mode bits, as in \"og+rX-w\"."
6334 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
6335 (error "File not found")))
6336 (modestr (and (stringp orig-file
)
6337 (nth 8 (file-attributes orig-file
))))
6339 (and (stringp modestr
)
6340 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
6341 (replace-regexp-in-string
6343 (format "u=%s,g=%s,o=%s"
6344 (match-string 1 modestr
)
6345 (match-string 2 modestr
)
6346 (match-string 3 modestr
)))))
6347 (value (read-string (or prompt
"File modes (octal or symbolic): ")
6350 (if (string-match "^[0-7]+" value
)
6351 (string-to-number value
8)
6352 (file-modes-symbolic-to-number value modes
)))))
6355 ;; Trashcan handling.
6356 (defcustom trash-directory nil
6357 "Directory for `move-file-to-trash' to move files and directories to.
6358 This directory is only used when the function `system-move-file-to-trash'
6360 Relative paths are interpreted relative to `default-directory'.
6361 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6362 :type
'(choice (const nil
) directory
)
6366 (defvar trash--hexify-table
)
6368 (declare-function system-move-file-to-trash
"w32fns.c" (filename))
6370 (defun move-file-to-trash (filename)
6371 "Move the file (or directory) named FILENAME to the trash.
6372 When `delete-by-moving-to-trash' is non-nil, this function is
6373 called by `delete-file' and `delete-directory' instead of
6374 deleting files outright.
6376 If the function `system-move-file-to-trash' is defined, call it
6377 with FILENAME as an argument.
6378 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6380 Otherwise, trash FILENAME using the freedesktop.org conventions,
6381 like the GNOME, KDE and XFCE desktop environments. Emacs only
6382 moves files to \"home trash\", ignoring per-volume trashcans."
6383 (interactive "fMove file to trash: ")
6384 (cond (trash-directory
6385 ;; If `trash-directory' is non-nil, move the file there.
6386 (let* ((trash-dir (expand-file-name trash-directory
))
6387 (fn (directory-file-name (expand-file-name filename
)))
6388 (new-fn (expand-file-name (file-name-nondirectory fn
)
6390 ;; We can't trash a parent directory of trash-directory.
6391 (if (string-match fn trash-dir
)
6392 (error "Trash directory `%s' is a subdirectory of `%s'"
6393 trash-dir filename
))
6394 (unless (file-directory-p trash-dir
)
6395 (make-directory trash-dir t
))
6396 ;; Ensure that the trashed file-name is unique.
6397 (if (file-exists-p new-fn
)
6398 (let ((version-control t
)
6399 (backup-directory-alist nil
))
6400 (setq new-fn
(car (find-backup-file-name new-fn
)))))
6401 (let (delete-by-moving-to-trash)
6402 (rename-file fn new-fn
))))
6403 ;; If `system-move-file-to-trash' is defined, use it.
6404 ((fboundp 'system-move-file-to-trash
)
6405 (system-move-file-to-trash filename
))
6406 ;; Otherwise, use the freedesktop.org method, as specified at
6407 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6409 (let* ((xdg-data-dir
6410 (directory-file-name
6411 (expand-file-name "Trash"
6412 (or (getenv "XDG_DATA_HOME")
6413 "~/.local/share"))))
6414 (trash-files-dir (expand-file-name "files" xdg-data-dir
))
6415 (trash-info-dir (expand-file-name "info" xdg-data-dir
))
6416 (fn (directory-file-name (expand-file-name filename
))))
6418 ;; Check if we have permissions to delete.
6419 (unless (file-writable-p (directory-file-name
6420 (file-name-directory fn
)))
6421 (error "Cannot move %s to trash: Permission denied" filename
))
6422 ;; The trashed file cannot be the trash dir or its parent.
6423 (if (string-match fn trash-files-dir
)
6424 (error "The trash directory %s is a subdirectory of %s"
6425 trash-files-dir filename
))
6426 (if (string-match fn trash-info-dir
)
6427 (error "The trash directory %s is a subdirectory of %s"
6428 trash-info-dir filename
))
6430 ;; Ensure that the trash directory exists; otherwise, create it.
6431 (let ((saved-default-file-modes (default-file-modes)))
6432 (set-default-file-modes ?
\700)
6433 (unless (file-exists-p trash-files-dir
)
6434 (make-directory trash-files-dir t
))
6435 (unless (file-exists-p trash-info-dir
)
6436 (make-directory trash-info-dir t
))
6437 (set-default-file-modes saved-default-file-modes
))
6439 ;; Try to move to trash with .trashinfo undo information
6442 (set-buffer-file-coding-system 'utf-8-unix
)
6443 (insert "[Trash Info]\nPath=")
6444 ;; Perform url-encoding on FN. For compatibility with
6445 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6446 ;; for path separators.
6447 (unless (boundp 'trash--hexify-table
)
6448 (setq trash--hexify-table
(make-vector 256 nil
))
6449 (let ((unreserved-chars
6450 (list ?
/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6451 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6452 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6453 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?
0 ?
1 ?
2
6454 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9 ?- ?_ ?. ?
! ?~ ?
* ?
'
6457 (aset trash--hexify-table byte
6458 (if (memq byte unreserved-chars
)
6459 (char-to-string byte
)
6460 (format "%%%02x" byte
))))))
6461 (mapc (lambda (byte)
6462 (insert (aref trash--hexify-table byte
)))
6463 (if (multibyte-string-p fn
)
6464 (encode-coding-string fn
'utf-8
)
6466 (insert "\nDeletionDate="
6467 (format-time-string "%Y-%m-%dT%T")
6470 ;; Attempt to make .trashinfo file, trying up to 5
6471 ;; times. The .trashinfo file is opened with O_EXCL,
6472 ;; as per trash-spec 0.7, even if that can be a problem
6473 ;; on old NFS versions...
6475 (base-fn (expand-file-name
6476 (file-name-nondirectory fn
)
6481 (setq info-fn
(expand-file-name
6482 (concat (file-name-nondirectory new-fn
)
6485 (unless (condition-case nil
6487 (write-region nil nil info-fn nil
6488 'quiet info-fn
'excl
)
6489 (setq tries
0 success t
))
6490 (file-already-exists nil
))
6491 (setq tries
(1- tries
))
6492 ;; Uniqify new-fn. (Some file managers do not
6493 ;; like Emacs-style backup file names---e.g. bug
6494 ;; 170956 in Konqueror bug tracker.)
6495 (setq new-fn
(make-temp-name (concat base-fn
"_")))))
6497 (error "Cannot move %s to trash: Lock failed" filename
))
6499 ;; Finally, try to move the file to the trashcan.
6500 (let ((delete-by-moving-to-trash nil
))
6501 (rename-file fn new-fn
)))))))))
6504 (define-key ctl-x-map
"\C-f" 'find-file
)
6505 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
6506 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
6507 (define-key ctl-x-map
"\C-s" 'save-buffer
)
6508 (define-key ctl-x-map
"s" 'save-some-buffers
)
6509 (define-key ctl-x-map
"\C-w" 'write-file
)
6510 (define-key ctl-x-map
"i" 'insert-file
)
6511 (define-key esc-map
"~" 'not-modified
)
6512 (define-key ctl-x-map
"\C-d" 'list-directory
)
6513 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
6514 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
6516 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
6517 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
6518 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
6519 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
6520 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
6522 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
6523 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
6524 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
6525 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
6526 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
6528 ;;; files.el ends here