1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992-2012 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Defines most of Emacs'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
)
154 (put 'buffer-offer-save
'permanent-local t
)
156 (defcustom find-file-existing-other-name t
157 "Non-nil means find a file under alternative names, in existing buffers.
158 This means if any existing buffer is visiting the file you want
159 under another name, you get the existing buffer instead of a new buffer."
163 (defcustom find-file-visit-truename nil
164 "Non-nil means visit a file under its truename.
165 The truename of a file is found by chasing all links
166 both at the file level and at the levels of the containing directories."
169 (put 'find-file-visit-truename
'safe-local-variable
'booleanp
)
171 (defcustom revert-without-query nil
172 "Specify which files should be reverted without query.
173 The value is a list of regular expressions.
174 If the file name matches one of these regular expressions,
175 then `revert-buffer' reverts the file without querying
176 if the file has changed on disk and you have not edited the buffer."
177 :type
'(repeat regexp
)
180 (defvar buffer-file-number nil
181 "The device number and file number of the file visited in the current buffer.
182 The value is a list of the form (FILENUM DEVNUM).
183 This pair of numbers uniquely identifies the file.
184 If the buffer is visiting a new file, the value is nil.")
185 (make-variable-buffer-local 'buffer-file-number
)
186 (put 'buffer-file-number
'permanent-local t
)
188 (defvar buffer-file-numbers-unique
(not (memq system-type
'(windows-nt)))
189 "Non-nil means that `buffer-file-number' uniquely identifies files.")
191 (defvar buffer-file-read-only nil
192 "Non-nil if visited file was read-only when visited.")
193 (make-variable-buffer-local 'buffer-file-read-only
)
195 (defcustom small-temporary-file-directory
196 (if (eq system-type
'ms-dos
) (getenv "TMPDIR"))
197 "The directory for writing small temporary files.
198 If non-nil, this directory is used instead of `temporary-file-directory'
199 by programs that create small temporary files. This is for systems that
200 have fast storage with limited space, such as a RAM disk."
202 :initialize
'custom-initialize-delay
203 :type
'(choice (const nil
) directory
))
205 ;; The system null device. (Should reference NULL_DEVICE from C.)
206 (defvar null-device
(purecopy "/dev/null") "The system null device.")
208 (declare-function msdos-long-file-names
"msdos.c")
209 (declare-function w32-long-file-name
"w32proc.c")
210 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
211 (declare-function dired-unmark
"dired" (arg))
212 (declare-function dired-do-flagged-delete
"dired" (&optional nomessage
))
213 (declare-function dos-8
+3-filename
"dos-fns" (filename))
214 (declare-function view-mode-disable
"view" ())
215 (declare-function dosified-file-name
"dos-fns" (file-name))
217 (defvar file-name-invalid-regexp
218 (cond ((and (eq system-type
'ms-dos
) (not (msdos-long-file-names)))
220 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
221 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
222 "[\000-\037]\\|" ; control characters
223 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
224 "\\(/[^/.]+\\.[^/.]*\\.\\)"))) ; more than a single dot
225 ((memq system-type
'(ms-dos windows-nt cygwin
))
227 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
228 "[|<>\"?*\000-\037]"))) ; invalid characters
229 (t (purecopy "[\000]")))
230 "Regexp recognizing file names which aren't allowed by the filesystem.")
232 (defcustom file-precious-flag nil
233 "Non-nil means protect against I/O errors while saving files.
234 Some modes set this non-nil in particular buffers.
236 This feature works by writing the new contents into a temporary file
237 and then renaming the temporary file to replace the original.
238 In this way, any I/O error in writing leaves the original untouched,
239 and there is never any instant where the file is nonexistent.
241 Note that this feature forces backups to be made by copying.
242 Yet, at the same time, saving a precious file
243 breaks any hard links between it and other files.
245 This feature is advisory: for example, if the directory in which the
246 file is being saved is not writable, Emacs may ignore a non-nil value
247 of `file-precious-flag' and write directly into the file.
249 See also: `break-hardlink-on-save'."
253 (defcustom break-hardlink-on-save nil
254 "Non-nil means when saving a file that exists under several names
255 \(i.e., has multiple hardlinks), break the hardlink associated with
256 `buffer-file-name' and write to a new file, so that the other
257 instances of the file are not affected by the save.
259 If `buffer-file-name' refers to a symlink, do not break the symlink.
261 Unlike `file-precious-flag', `break-hardlink-on-save' is not advisory.
262 For example, if the directory in which a file is being saved is not
263 itself writable, then error instead of saving in some
264 hardlink-nonbreaking way.
266 See also `backup-by-copying' and `backup-by-copying-when-linked'."
271 (defcustom version-control nil
272 "Control use of version numbers for backup files.
273 When t, make numeric backup versions unconditionally.
274 When nil, make them for files that have some already.
275 The value `never' means do not make them."
276 :type
'(choice (const :tag
"Never" never
)
277 (const :tag
"If existing" nil
)
278 (other :tag
"Always" t
))
281 (put 'version-control
'safe-local-variable
282 (lambda (x) (or (booleanp x
) (equal x
'never
))))
284 (defcustom dired-kept-versions
2
285 "When cleaning directory, number of versions to keep."
290 (defcustom delete-old-versions nil
291 "If t, delete excess backup versions silently.
292 If nil, ask confirmation. Any other value prevents any trimming."
293 :type
'(choice (const :tag
"Delete" t
)
294 (const :tag
"Ask" nil
)
295 (other :tag
"Leave" other
))
298 (defcustom kept-old-versions
2
299 "Number of oldest versions to keep when a new numbered backup is made."
302 (put 'kept-old-versions
'safe-local-variable
'integerp
)
304 (defcustom kept-new-versions
2
305 "Number of newest versions to keep when a new numbered backup is made.
306 Includes the new backup. Must be > 0"
309 (put 'kept-new-versions
'safe-local-variable
'integerp
)
311 (defcustom require-final-newline nil
312 "Whether to add a newline automatically at the end of the file.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
318 A value of nil means don't add newlines.
320 Certain major modes set this locally to the value obtained
321 from `mode-require-final-newline'."
322 :type
'(choice (const :tag
"When visiting" visit
)
323 (const :tag
"When saving" t
)
324 (const :tag
"When visiting or saving" visit-save
)
325 (const :tag
"Don't add newlines" nil
)
326 (other :tag
"Ask each time" ask
))
327 :group
'editing-basics
)
329 (defcustom mode-require-final-newline t
330 "Whether to add a newline at end of file, in certain major modes.
331 Those modes set `require-final-newline' to this value when you enable them.
332 They do so because they are often used for files that are supposed
333 to end in newlines, and the question is how to arrange that.
335 A value of t means do this only when the file is about to be saved.
336 A value of `visit' means do this right after the file is visited.
337 A value of `visit-save' means do it at both of those times.
338 Any other non-nil value means ask user whether to add a newline, when saving.
340 A value of nil means do not add newlines. That is a risky choice in this
341 variable since this value is used for modes for files that ought to have
342 final newlines. So if you set this to nil, you must explicitly check and
343 add a final newline, whenever you save a file that really needs one."
344 :type
'(choice (const :tag
"When visiting" visit
)
345 (const :tag
"When saving" t
)
346 (const :tag
"When visiting or saving" visit-save
)
347 (const :tag
"Don't add newlines" nil
)
348 (other :tag
"Ask each time" ask
))
349 :group
'editing-basics
352 (defcustom auto-save-default t
353 "Non-nil says by default do auto-saving of every file-visiting buffer."
357 (defcustom auto-save-file-name-transforms
358 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
359 ;; Don't put "\\2" inside expand-file-name, since it will be
360 ;; transformed to "/2" on DOS/Windows.
361 ,(concat temporary-file-directory
"\\2") t
))
362 "Transforms to apply to buffer file name before making auto-save file name.
363 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
364 REGEXP is a regular expression to match against the file name.
365 If it matches, `replace-match' is used to replace the
366 matching part with REPLACEMENT.
367 If the optional element UNIQUIFY is non-nil, the auto-save file name is
368 constructed by taking the directory part of the replaced file-name,
369 concatenated with the buffer file name with all directory separators
370 changed to `!' to prevent clashes. This will not work
371 correctly if your filesystem truncates the resulting name.
373 All the transforms in the list are tried, in the order they are listed.
374 When one transform applies, its result is final;
375 no further transforms are tried.
377 The default value is set up to put the auto-save file into the
378 temporary directory (see the variable `temporary-file-directory') for
379 editing a remote file.
381 On MS-DOS filesystems without long names this variable is always
384 :type
'(repeat (list (string :tag
"Regexp") (string :tag
"Replacement")
385 (boolean :tag
"Uniquify")))
386 :initialize
'custom-initialize-delay
389 (defcustom save-abbrevs t
390 "Non-nil means save word abbrevs too when files are saved.
391 If `silently', don't ask the user before saving."
392 :type
'(choice (const t
) (const nil
) (const silently
))
395 (defcustom find-file-run-dired t
396 "Non-nil means allow `find-file' to visit directories.
397 To visit the directory, `find-file' runs `find-directory-functions'."
401 (defcustom find-directory-functions
'(cvs-dired-noselect dired-noselect
)
402 "List of functions to try in sequence to visit a directory.
403 Each function is called with the directory name as the sole argument
404 and should return either a buffer or nil."
405 :type
'(hook :options
(cvs-dired-noselect dired-noselect
))
408 ;; FIXME: also add a hook for `(thing-at-point 'filename)'
409 (defcustom file-name-at-point-functions
'(ffap-guess-file-name-at-point)
410 "List of functions to try in sequence to get a file name at point.
411 Each function should return either nil or a file name found at the
412 location of point in the current buffer."
413 :type
'(hook :options
(ffap-guess-file-name-at-point))
416 ;;;It is not useful to make this a local variable.
417 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
418 (defvar find-file-not-found-functions nil
419 "List of functions to be called for `find-file' on nonexistent file.
420 These functions are called as soon as the error is detected.
421 Variable `buffer-file-name' is already set up.
422 The functions are called in the order given until one of them returns non-nil.")
423 (define-obsolete-variable-alias 'find-file-not-found-hooks
424 'find-file-not-found-functions
"22.1")
426 ;;;It is not useful to make this a local variable.
427 ;;;(put 'find-file-hooks 'permanent-local t)
428 (define-obsolete-variable-alias 'find-file-hooks
'find-file-hook
"22.1")
429 (defcustom find-file-hook nil
430 "List of functions to be called after a buffer is loaded from a file.
431 The buffer's local variables (if any) will have been processed before the
432 functions are called."
435 :options
'(auto-insert)
438 (defvar write-file-functions nil
439 "List of functions to be called before writing out a buffer to a file.
440 If one of them returns non-nil, the file is considered already written
441 and the rest are not called.
442 These hooks are considered to pertain to the visited file.
443 So any buffer-local binding of this variable is discarded if you change
444 the visited file name with \\[set-visited-file-name], but not when you
445 change the major mode.
447 This hook is not run if any of the functions in
448 `write-contents-functions' returns non-nil. Both hooks pertain
449 to how to save a buffer to file, for instance, choosing a suitable
450 coding system and setting mode bits. (See Info
451 node `(elisp)Saving Buffers'.) To perform various checks or
452 updates before the buffer is saved, use `before-save-hook'.")
453 (put 'write-file-functions
'permanent-local t
)
454 (define-obsolete-variable-alias 'write-file-hooks
'write-file-functions
"22.1")
456 (defvar local-write-file-hooks nil
)
457 (make-variable-buffer-local 'local-write-file-hooks
)
458 (put 'local-write-file-hooks
'permanent-local t
)
459 (make-obsolete-variable 'local-write-file-hooks
'write-file-functions
"22.1")
461 (defvar write-contents-functions nil
462 "List of functions to be called before writing out a buffer to a file.
463 If one of them returns non-nil, the file is considered already written
464 and the rest are not called and neither are the functions in
465 `write-file-functions'.
467 This variable is meant to be used for hooks that pertain to the
468 buffer's contents, not to the particular visited file; thus,
469 `set-visited-file-name' does not clear this variable; but changing the
470 major mode does clear it.
472 For hooks that _do_ pertain to the particular visited file, use
473 `write-file-functions'. Both this variable and
474 `write-file-functions' relate to how a buffer is saved to file.
475 To perform various checks or updates before the buffer is saved,
476 use `before-save-hook'.")
477 (make-variable-buffer-local 'write-contents-functions
)
478 (define-obsolete-variable-alias 'write-contents-hooks
479 'write-contents-functions
"22.1")
481 (defcustom enable-local-variables t
482 "Control use of local variables in files you visit.
483 The value can be t, nil, :safe, :all, or something else.
485 A value of t means file local variables specifications are obeyed
486 if all the specified variable values are safe; if any values are
487 not safe, Emacs queries you, once, whether to set them all.
488 \(When you say yes to certain values, they are remembered as safe.)
490 :safe means set the safe variables, and ignore the rest.
491 :all means set all variables, whether safe or not.
492 (Don't set it permanently to :all.)
493 A value of nil means always ignore the file local variables.
495 Any other value means always query you once whether to set them all.
496 \(When you say yes to certain values, they are remembered as safe, but
497 this has no effect when `enable-local-variables' is \"something else\".)
499 This variable also controls use of major modes specified in
502 The command \\[normal-mode], when used interactively,
503 always obeys file local variable specifications and the -*- line,
504 and ignores this variable."
506 :type
'(choice (const :tag
"Query Unsafe" t
)
507 (const :tag
"Safe Only" :safe
)
508 (const :tag
"Do all" :all
)
509 (const :tag
"Ignore" nil
)
510 (other :tag
"Query" other
))
513 (defvar local-enable-local-variables t
514 "Like `enable-local-variables' but meant for buffer-local bindings.
515 The meaningful values are nil and non-nil. The default is non-nil.
516 If a major mode sets this to nil, buffer-locally, then any local
517 variables list in the file will be ignored.
519 This variable does not affect the use of major modes
520 specified in a -*- line.")
522 (defcustom enable-local-eval
'maybe
523 "Control processing of the \"variable\" `eval' in a file's local variables.
524 The value can be t, nil or something else.
525 A value of t means obey `eval' variables.
526 A value of nil means ignore them; anything else means query."
528 :type
'(choice (const :tag
"Obey" t
)
529 (const :tag
"Ignore" nil
)
530 (other :tag
"Query" other
))
533 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
534 (or (fboundp 'lock-buffer
)
535 (defalias 'lock-buffer
'ignore
))
536 (or (fboundp 'unlock-buffer
)
537 (defalias 'unlock-buffer
'ignore
))
538 (or (fboundp 'file-locked-p
)
539 (defalias 'file-locked-p
'ignore
))
541 (defcustom view-read-only nil
542 "Non-nil means buffers visiting files read-only do so in view mode.
543 In fact, this means that all read-only buffers normally have
544 View mode enabled, including buffers that are read-only because
545 you visit a file you cannot alter, and buffers you make read-only
546 using \\[toggle-read-only]."
550 (defvar file-name-history nil
551 "History list of file names entered in the minibuffer.
553 Maximum length of the history list is determined by the value
554 of `history-length', which see.")
556 (put 'ange-ftp-completion-hook-function
'safe-magic t
)
557 (defun ange-ftp-completion-hook-function (op &rest args
)
558 "Provides support for ange-ftp host name completion.
559 Runs the usual ange-ftp hook, but only for completion operations."
560 ;; Having this here avoids the need to load ange-ftp when it's not
562 (if (memq op
'(file-name-completion file-name-all-completions
))
563 (apply 'ange-ftp-hook-function op args
)
564 (let ((inhibit-file-name-handlers
565 (cons 'ange-ftp-completion-hook-function
566 (and (eq inhibit-file-name-operation op
)
567 inhibit-file-name-handlers
)))
568 (inhibit-file-name-operation op
))
571 (declare-function dos-convert-standard-filename
"dos-fns.el" (filename))
572 (declare-function w32-convert-standard-filename
"w32-fns.el" (filename))
574 (defun convert-standard-filename (filename)
575 "Convert a standard file's name to something suitable for the OS.
576 This means to guarantee valid names and perhaps to canonicalize
579 FILENAME should be an absolute file name since the conversion rules
580 sometimes vary depending on the position in the file name. E.g. c:/foo
581 is a valid DOS file name, but c:/bar/c:/foo is not.
583 This function's standard definition is trivial; it just returns
584 the argument. However, on Windows and DOS, replace invalid
585 characters. On DOS, make sure to obey the 8.3 limitations.
586 In the native Windows build, turn Cygwin names into native names,
587 and also turn slashes into backslashes if the shell requires it (see
588 `w32-shell-dos-semantics').
590 See Info node `(elisp)Standard File Names' for more details."
592 ((eq system-type
'cygwin
)
593 (let ((name (copy-sequence filename
))
595 ;; Replace invalid filename characters with !
596 (while (string-match "[?*:<>|\"\000-\037]" name start
)
597 (aset name
(match-beginning 0) ?
!)
598 (setq start
(match-end 0)))
600 ((eq system-type
'windows-nt
)
601 (w32-convert-standard-filename filename
))
602 ((eq system-type
'ms-dos
)
603 (dos-convert-standard-filename filename
))
606 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
607 "Read directory name, prompting with PROMPT and completing in directory DIR.
608 Value is not expanded---you must call `expand-file-name' yourself.
609 Default name to DEFAULT-DIRNAME if user exits with the same
610 non-empty string that was inserted by this function.
611 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
612 or just DIR if INITIAL is nil.)
613 If the user exits with an empty minibuffer, this function returns
614 an empty string. (This can only happen if the user erased the
615 pre-inserted contents or if `insert-default-directory' is nil.)
616 Fourth arg MUSTMATCH non-nil means require existing directory's name.
617 Non-nil and non-t means also require confirmation after completion.
618 Fifth arg INITIAL specifies text to start with.
619 DIR should be an absolute directory name. It defaults to
620 the value of `default-directory'."
622 (setq dir default-directory
))
623 (read-file-name prompt dir
(or default-dirname
624 (if initial
(expand-file-name initial dir
)
631 "Show the current default directory."
633 (message "Directory %s" default-directory
))
636 "Value of the CDPATH environment variable, as a list.
637 Not actually set up until the first time you use it.")
639 (defun parse-colon-path (search-path)
640 "Explode a search path into a list of directory names.
641 Directories are separated by occurrences of `path-separator'
642 \(which is colon in GNU and GNU-like systems)."
643 ;; We could use split-string here.
645 (let (cd-list (cd-start 0) cd-colon
)
646 (setq search-path
(concat search-path path-separator
))
647 (while (setq cd-colon
(string-match path-separator search-path cd-start
))
650 (list (if (= cd-start cd-colon
)
652 (substitute-in-file-name
653 (file-name-as-directory
654 (substring search-path cd-start cd-colon
)))))))
655 (setq cd-start
(+ cd-colon
1)))
658 (defun cd-absolute (dir)
659 "Change current directory to given absolute file name DIR."
660 ;; Put the name into directory syntax now,
661 ;; because otherwise expand-file-name may give some bad results.
662 (setq dir
(file-name-as-directory dir
))
663 ;; We used to additionally call abbreviate-file-name here, for an
664 ;; unknown reason. Problem is that most buffers are setup
665 ;; without going through cd-absolute and don't call
666 ;; abbreviate-file-name on their default-directory, so the few that
667 ;; do end up using a superficially different directory.
668 (setq dir
(expand-file-name dir
))
669 (if (not (file-directory-p dir
))
670 (if (file-exists-p dir
)
671 (error "%s is not a directory" dir
)
672 (error "%s: no such directory" dir
))
673 (unless (file-executable-p dir
)
674 (error "Cannot cd to %s: Permission denied" dir
))
675 (setq default-directory dir
)
676 (setq list-buffers-directory dir
)))
679 "Make DIR become the current buffer's default directory.
680 If your environment includes a `CDPATH' variable, try each one of
681 that list of directories (separated by occurrences of
682 `path-separator') when resolving a relative directory name.
683 The path separator is colon in GNU and GNU-like systems."
686 ;; FIXME: There's a subtle bug in the completion below. Seems linked
687 ;; to a fundamental difficulty of implementing `predicate' correctly.
688 ;; The manifestation is that TAB may list non-directories in the case where
689 ;; those files also correspond to valid directories (if your cd-path is (A/
690 ;; B/) and you have A/a a file and B/a a directory, then both `a' and `a/'
691 ;; will be listed as valid completions).
692 ;; This is because `a' (listed because of A/a) is indeed a valid choice
693 ;; (which will lead to the use of B/a).
694 (minibuffer-with-setup-hook
696 (setq minibuffer-completion-table
697 (apply-partially #'locate-file-completion-table
699 (setq minibuffer-completion-predicate
701 (locate-file dir cd-path nil
702 (lambda (f) (and (file-directory-p f
) 'dir-ok
))))))
704 (setq cd-path
(or (parse-colon-path (getenv "CDPATH"))
706 (read-directory-name "Change default directory: "
707 default-directory default-directory
710 (setq cd-path
(or (parse-colon-path (getenv "CDPATH"))
713 (or (locate-file dir cd-path nil
714 (lambda (f) (and (file-directory-p f
) 'dir-ok
)))
715 (error "No such directory found via CDPATH environment variable"))))
717 (defun load-file (file)
718 "Load the Lisp file named FILE."
719 ;; This is a case where .elc makes a lot of sense.
720 (interactive (list (let ((completion-ignored-extensions
721 (remove ".elc" completion-ignored-extensions
)))
722 (read-file-name "Load file: "))))
723 (load (expand-file-name file
) nil nil t
))
725 (defun locate-file (filename path
&optional suffixes predicate
)
726 "Search for FILENAME through PATH.
727 If found, return the absolute file name of FILENAME, with its suffixes;
728 otherwise return nil.
729 PATH should be a list of directories to look in, like the lists in
730 `exec-path' or `load-path'.
731 If SUFFIXES is non-nil, it should be a list of suffixes to append to
732 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
733 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
734 If non-nil, PREDICATE is used instead of `file-readable-p'.
736 This function will normally skip directories, so if you want it to find
737 directories, make sure the PREDICATE function returns `dir-ok' for them.
739 PREDICATE can also be an integer to pass to the `access' system call,
740 in which case file-name handlers are ignored. This usage is deprecated.
741 For compatibility, PREDICATE can also be one of the symbols
742 `executable', `readable', `writable', or `exists', or a list of
743 one or more of those symbols."
744 (if (and predicate
(symbolp predicate
) (not (functionp predicate
)))
745 (setq predicate
(list predicate
)))
746 (when (and (consp predicate
) (not (functionp predicate
)))
748 (logior (if (memq 'executable predicate
) 1 0)
749 (if (memq 'writable predicate
) 2 0)
750 (if (memq 'readable predicate
) 4 0))))
751 (locate-file-internal filename path suffixes predicate
))
753 (defun locate-file-completion-table (dirs suffixes string pred action
)
754 "Do completion for file names passed to `locate-file'."
756 ((file-name-absolute-p string
)
757 ;; FIXME: maybe we should use completion-file-name-table instead,
758 ;; tho at least for `load', the arg is passed through
759 ;; substitute-in-file-name for historical reasons.
760 (read-file-name-internal string pred action
))
761 ((eq (car-safe action
) 'boundaries
)
762 (let ((suffix (cdr action
)))
764 (length (file-name-directory string
))
765 (let ((x (file-name-directory suffix
)))
766 (if x
(1- (length x
)) (length suffix
))))))
769 ;; If we have files like "foo.el" and "foo.elc", we could load one of
770 ;; them with "foo.el", "foo.elc", or "foo", where just "foo" is the
771 ;; preferred way. So if we list all 3, that gives a lot of redundant
772 ;; entries for the poor soul looking just for "foo". OTOH, sometimes
773 ;; the user does want to pay attention to the extension. We try to
774 ;; diffuse this tension by stripping the suffix, except when the
775 ;; result is a single element (i.e. usually we only list "foo" unless
776 ;; it's the only remaining element in the list, in which case we do
777 ;; list "foo", "foo.elc" and "foo.el").
779 (suffix (concat (regexp-opt suffixes t
) "\\'"))
780 (string-dir (file-name-directory string
))
781 (string-file (file-name-nondirectory string
)))
784 (setq dir default-directory
))
785 (if string-dir
(setq dir
(expand-file-name string-dir dir
)))
786 (when (file-directory-p dir
)
787 (dolist (file (file-name-all-completions
789 (if (not (string-match suffix file
))
791 (push file fullnames
)
792 (push (substring file
0 (match-beginning 0)) names
)))))
793 ;; Switching from names to names+fullnames creates a non-monotonicity
794 ;; which can cause problems with things like partial-completion.
795 ;; To minimize the problem, filter out completion-regexp-list, so that
796 ;; M-x load-library RET t/x.e TAB finds some files. Also remove elements
797 ;; from `names' which only matched `string' when they still had
799 (setq names
(all-completions string names
))
800 ;; Remove duplicates of the first element, so that we can easily check
801 ;; if `names' really only contains a single element.
802 (when (cdr names
) (setcdr names
(delete (car names
) (cdr names
))))
804 ;; There's no more than one matching non-suffixed element, so expand
805 ;; the list by adding the suffixed elements as well.
806 (setq names
(nconc names fullnames
)))
807 (completion-table-with-context
808 string-dir names string-file pred action
)))))
810 (defun locate-file-completion (string path-and-suffixes action
)
811 "Do completion for file names passed to `locate-file'.
812 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
813 (locate-file-completion-table (car path-and-suffixes
)
814 (cdr path-and-suffixes
)
816 (make-obsolete 'locate-file-completion
'locate-file-completion-table
"23.1")
818 (defvar locate-dominating-stop-dir-regexp
819 (purecopy "\\`\\(?:[\\/][\\/][^\\/]+[\\/]\\|/\\(?:net\\|afs\\|\\.\\.\\.\\)/\\)\\'")
820 "Regexp of directory names which stop the search in `locate-dominating-file'.
821 Any directory whose name matches this regexp will be treated like
822 a kind of root directory by `locate-dominating-file' which will stop its search
823 when it bumps into it.
824 The default regexp prevents fruitless and time-consuming attempts to find
825 special files in directories in which filenames are interpreted as hostnames,
826 or mount points potentially requiring authentication as a different user.")
828 ;; (defun locate-dominating-files (file regexp)
829 ;; "Look up the directory hierarchy from FILE for a file matching REGEXP.
830 ;; Stop at the first parent where a matching file is found and return the list
831 ;; of files that that match in this directory."
833 ;; ;; `user' is not initialized yet because `file' may not exist, so we may
834 ;; ;; have to walk up part of the hierarchy before we find the "initial UID".
836 ;; ;; Abbreviate, so as to stop when we cross ~/.
837 ;; (dir (abbreviate-file-name (file-name-as-directory file)))
840 ;; ;; As a heuristic, we stop looking up the hierarchy of
841 ;; ;; directories as soon as we find a directory belonging to
842 ;; ;; another user. This should save us from looking in
843 ;; ;; things like /net and /afs. This assumes that all the
844 ;; ;; files inside a project belong to the same user.
845 ;; (let ((prev-user user))
846 ;; (setq user (nth 2 (file-attributes dir)))
847 ;; (or (null prev-user) (equal user prev-user))))
848 ;; (if (setq files (condition-case nil
849 ;; (directory-files dir 'full regexp 'nosort)
851 ;; (throw 'found files)
853 ;; (setq dir (file-name-directory
854 ;; (directory-file-name dir))))
858 (defun locate-dominating-file (file name
)
859 "Look up the directory hierarchy from FILE for a file named NAME.
860 Stop at the first parent directory containing a file NAME,
861 and return the directory. Return nil if not found."
862 ;; We used to use the above locate-dominating-files code, but the
863 ;; directory-files call is very costly, so we're much better off doing
864 ;; multiple calls using the code in here.
866 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
867 ;; `name' in /home or in /.
868 (setq file
(abbreviate-file-name file
))
870 ;; `user' is not initialized outside the loop because
871 ;; `file' may not exist, so we may have to walk up part of the
872 ;; hierarchy before we find the "initial UID". Note: currently unused
877 ;; FIXME: Disabled this heuristic because it is sometimes
879 ;; As a heuristic, we stop looking up the hierarchy of
880 ;; directories as soon as we find a directory belonging
881 ;; to another user. This should save us from looking in
882 ;; things like /net and /afs. This assumes that all the
883 ;; files inside a project belong to the same user.
884 ;; (let ((prev-user user))
885 ;; (setq user (nth 2 (file-attributes file)))
886 ;; (and prev-user (not (equal user prev-user))))
887 (string-match locate-dominating-stop-dir-regexp file
)))
888 (setq try
(file-exists-p (expand-file-name name file
)))
889 (cond (try (setq root file
))
890 ((equal file
(setq file
(file-name-directory
891 (directory-file-name file
))))
896 (defun executable-find (command)
897 "Search for COMMAND in `exec-path' and return the absolute file name.
898 Return nil if COMMAND is not found anywhere in `exec-path'."
899 ;; Use 1 rather than file-executable-p to better match the behavior of
901 (locate-file command exec-path exec-suffixes
1))
903 (defun load-library (library)
904 "Load the Emacs Lisp library named LIBRARY.
905 This is an interface to the function `load'. LIBRARY is searched
906 for in `load-path', both with and without `load-suffixes' (as
907 well as `load-file-rep-suffixes').
909 See Info node `(emacs)Lisp Libraries' for more details.
910 See `load-file' for a different interface to `load'."
912 (list (completing-read "Load library: "
913 (apply-partially 'locate-file-completion-table
915 (get-load-suffixes)))))
918 (defun file-remote-p (file &optional identification connected
)
919 "Test whether FILE specifies a location on a remote system.
920 A file is considered remote if accessing it is likely to
921 be slower or less reliable than accessing local files.
923 `file-remote-p' never opens a new remote connection. It can
924 only reuse a connection that is already open.
926 Return nil or a string identifying the remote connection
927 \(ideally a prefix of FILE). Return nil if FILE is a relative
930 When IDENTIFICATION is nil, the returned string is a complete
931 remote identifier: with components method, user, and host. The
932 components are those present in FILE, with defaults filled in for
933 any that are missing.
935 IDENTIFICATION can specify which part of the identification to
936 return. IDENTIFICATION can be the symbol `method', `user',
937 `host', or `localname'. Any other value is handled like nil and
938 means to return the complete identification. The string returned
939 for IDENTIFICATION `localname' can differ depending on whether
940 there is an existing connection.
942 If CONNECTED is non-nil, return an identification only if FILE is
943 located on a remote system and a connection is established to
946 Tip: You can use this expansion of remote identifier components
947 to derive a new remote file name from an existing one. For
948 example, if FILE is \"/sudo::/path/to/file\" then
950 \(concat \(file-remote-p FILE) \"/bin/sh\")
952 returns a remote file name for file \"/bin/sh\" that has the
953 same remote identifier as FILE but expanded; a name such as
954 \"/sudo:root@myhost:/bin/sh\"."
955 (let ((handler (find-file-name-handler file
'file-remote-p
)))
957 (funcall handler
'file-remote-p file identification connected
)
960 (defcustom remote-file-name-inhibit-cache
10
961 "Whether to use the remote file-name cache for read access.
963 When `nil', always use the cached values.
964 When `t', never use them.
965 A number means use them for that amount of seconds since they were
968 File attributes of remote files are cached for better performance.
969 If they are changed out of Emacs' control, the cached values
970 become invalid, and must be invalidated.
972 In case a remote file is checked regularly, it might be
973 reasonable to let-bind this variable to a value less then the
974 time period between two checks.
977 (defun display-time-file-nonempty-p (file)
978 (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
979 (and (file-exists-p file)
980 (< 0 (nth 7 (file-attributes (file-chase-links file)))))))"
984 (const :tag
"Do not inhibit file name cache" nil
)
985 (const :tag
"Do not use file name cache" t
)
986 (integer :tag
"Do not use file name cache"
987 :format
"Do not use file name cache older then %v seconds"
990 (defun file-local-copy (file)
991 "Copy the file FILE into a temporary file on this machine.
992 Returns the name of the local copy, or nil, if FILE is directly
994 ;; This formerly had an optional BUFFER argument that wasn't used by
996 (let ((handler (find-file-name-handler file
'file-local-copy
)))
998 (funcall handler
'file-local-copy file
)
1001 (defun file-truename (filename &optional counter prev-dirs
)
1002 "Return the truename of FILENAME.
1003 If FILENAME is not absolute, first expands it against `default-directory'.
1004 The truename of a file name is found by chasing symbolic links
1005 both at the level of the file and at the level of the directories
1006 containing it, until no links are left at any level.
1008 \(fn FILENAME)" ;; Don't document the optional arguments.
1009 ;; COUNTER and PREV-DIRS are only used in recursive calls.
1010 ;; COUNTER can be a cons cell whose car is the count of how many
1011 ;; more links to chase before getting an error.
1012 ;; PREV-DIRS can be a cons cell whose car is an alist
1013 ;; of truenames we've just recently computed.
1014 (cond ((or (string= filename
"") (string= filename
"~"))
1015 (setq filename
(expand-file-name filename
))
1016 (if (string= filename
"")
1017 (setq filename
"/")))
1018 ((and (string= (substring filename
0 1) "~")
1019 (string-match "~[^/]*/?" filename
))
1021 (substring filename
0 (match-end 0)))
1022 (rest (substring filename
(match-end 0))))
1023 (setq filename
(concat (expand-file-name first-part
) rest
)))))
1025 (or counter
(setq counter
(list 100)))
1027 ;; For speed, remove the ange-ftp completion handler from the list.
1028 ;; We know it's not needed here.
1029 ;; For even more speed, do this only on the outermost call.
1030 (file-name-handler-alist
1031 (if prev-dirs file-name-handler-alist
1032 (let ((tem (copy-sequence file-name-handler-alist
)))
1033 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
1034 (or prev-dirs
(setq prev-dirs
(list nil
)))
1036 ;; andrewi@harlequin.co.uk - none of the following code (except for
1037 ;; invoking the file-name handler) currently applies on Windows
1038 ;; (ie. there are no native symlinks), but there is an issue with
1039 ;; case differences being ignored by the OS, and short "8.3 DOS"
1040 ;; name aliases existing for all files. (The short names are not
1041 ;; reported by directory-files, but can be used to refer to files.)
1042 ;; It seems appropriate for file-truename to resolve these issues in
1043 ;; the most natural way, which on Windows is to call the function
1044 ;; `w32-long-file-name' - this returns the exact name of a file as
1045 ;; it is stored on disk (expanding short name aliases with the full
1046 ;; name in the process).
1047 (if (eq system-type
'windows-nt
)
1048 (let ((handler (find-file-name-handler filename
'file-truename
)))
1049 ;; For file name that has a special handler, call handler.
1050 ;; This is so that ange-ftp can save time by doing a no-op.
1052 (setq filename
(funcall handler
'file-truename filename
))
1053 ;; If filename contains a wildcard, newname will be the old name.
1054 (unless (string-match "[[*?]" filename
)
1055 ;; If filename exists, use the long name. If it doesn't exist,
1056 ;; drill down until we find a directory that exists, and use
1057 ;; the long name of that, with the extra non-existent path
1058 ;; components concatenated.
1059 (let ((longname (w32-long-file-name filename
))
1062 (setq filename longname
)
1063 ;; Include the preceding directory separator in the missing
1064 ;; part so subsequent recursion on the rest works.
1065 (setq missing
(concat "/" (file-name-nondirectory filename
)))
1066 (let ((length (length missing
)))
1068 (if (> length
(length filename
))
1070 (substring filename
0 (- length
)))))
1071 (setq filename
(concat (file-truename rest
) missing
))))))
1074 ;; If this file directly leads to a link, process that iteratively
1075 ;; so that we don't use lots of stack.
1077 (setcar counter
(1- (car counter
)))
1078 (if (< (car counter
) 0)
1079 (error "Apparent cycle of symbolic links for %s" filename
))
1080 (let ((handler (find-file-name-handler filename
'file-truename
)))
1081 ;; For file name that has a special handler, call handler.
1082 ;; This is so that ange-ftp can save time by doing a no-op.
1084 (setq filename
(funcall handler
'file-truename filename
)
1086 (let ((dir (or (file-name-directory filename
) default-directory
))
1088 ;; Get the truename of the directory.
1089 (setq dirfile
(directory-file-name dir
))
1090 ;; If these are equal, we have the (or a) root directory.
1091 (or (string= dir dirfile
)
1092 ;; If this is the same dir we last got the truename for,
1093 ;; save time--don't recalculate.
1094 (if (assoc dir
(car prev-dirs
))
1095 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
1097 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
1098 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
1100 (if (equal ".." (file-name-nondirectory filename
))
1102 (directory-file-name (file-name-directory (directory-file-name dir
)))
1104 (if (equal "." (file-name-nondirectory filename
))
1105 (setq filename
(directory-file-name dir
)
1107 ;; Put it back on the file name.
1108 (setq filename
(concat dir
(file-name-nondirectory filename
)))
1109 ;; Is the file name the name of a link?
1110 (setq target
(file-symlink-p filename
))
1112 ;; Yes => chase that link, then start all over
1113 ;; since the link may point to a directory name that uses links.
1114 ;; We can't safely use expand-file-name here
1115 ;; since target might look like foo/../bar where foo
1116 ;; is itself a link. Instead, we handle . and .. above.
1118 (if (file-name-absolute-p target
)
1120 (concat dir target
))
1123 (setq done t
))))))))
1126 (defun file-chase-links (filename &optional limit
)
1127 "Chase links in FILENAME until a name that is not a link.
1128 Unlike `file-truename', this does not check whether a parent
1129 directory name is a symbolic link.
1130 If the optional argument LIMIT is a number,
1131 it means chase no more than that many links and then stop."
1132 (let (tem (newname filename
)
1134 (while (and (or (null limit
) (< count limit
))
1135 (setq tem
(file-symlink-p newname
)))
1137 (if (and (null limit
) (= count
100))
1138 (error "Apparent cycle of symbolic links for %s" filename
))
1139 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
1140 (while (string-match "//+" tem
)
1141 (setq tem
(replace-match "/" nil nil tem
)))
1142 ;; Handle `..' by hand, since it needs to work in the
1143 ;; target of any directory symlink.
1144 ;; This code is not quite complete; it does not handle
1145 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
1146 (while (string-match "\\`\\.\\./" tem
)
1147 (setq tem
(substring tem
3))
1148 (setq newname
(expand-file-name newname
))
1149 ;; Chase links in the default dir of the symlink.
1152 (directory-file-name (file-name-directory newname
))))
1153 ;; Now find the parent of that dir.
1154 (setq newname
(file-name-directory newname
)))
1155 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
1156 (setq count
(1+ count
))))
1159 ;; A handy function to display file sizes in human-readable form.
1160 ;; See http://en.wikipedia.org/wiki/Kibibyte for the reference.
1161 (defun file-size-human-readable (file-size &optional flavor
)
1162 "Produce a string showing FILE-SIZE in human-readable form.
1164 Optional second argument FLAVOR controls the units and the display format:
1166 If FLAVOR is nil or omitted, each kilobyte is 1024 bytes and the produced
1167 suffixes are \"k\", \"M\", \"G\", \"T\", etc.
1168 If FLAVOR is `si', each kilobyte is 1000 bytes and the produced suffixes
1169 are \"k\", \"M\", \"G\", \"T\", etc.
1170 If FLAVOR is `iec', each kilobyte is 1024 bytes and the produced suffixes
1171 are \"KiB\", \"MiB\", \"GiB\", \"TiB\", etc."
1172 (let ((power (if (or (null flavor
) (eq flavor
'iec
))
1176 ;; none, kilo, mega, giga, tera, peta, exa, zetta, yotta
1177 (list "" "k" "M" "G" "T" "P" "E" "Z" "Y")))
1178 (while (and (>= file-size power
) (cdr post-fixes
))
1179 (setq file-size
(/ file-size power
)
1180 post-fixes
(cdr post-fixes
)))
1181 (format (if (> (mod file-size
1.0) 0.05)
1185 (if (and (eq flavor
'iec
) (string= (car post-fixes
) "k"))
1188 (if (eq flavor
'iec
) "iB" ""))))
1190 (defun make-temp-file (prefix &optional dir-flag suffix
)
1191 "Create a temporary file.
1192 The returned file name (created by appending some random characters at the end
1193 of PREFIX, and expanding against `temporary-file-directory' if necessary),
1194 is guaranteed to point to a newly created empty file.
1195 You can then use `write-region' to write new data into the file.
1197 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
1199 If SUFFIX is non-nil, add that at the end of the file name."
1200 (let ((umask (default-file-modes))
1204 ;; Create temp files with strict access rights. It's easy to
1205 ;; loosen them later, whereas it's impossible to close the
1206 ;; time-window of loose permissions otherwise.
1207 (set-default-file-modes ?
\700)
1208 (while (condition-case ()
1212 (if (zerop (length prefix
))
1213 (file-name-as-directory
1214 temporary-file-directory
)
1215 (expand-file-name prefix
1216 temporary-file-directory
))))
1218 (setq file
(concat file suffix
)))
1220 (make-directory file
)
1221 (write-region "" nil file nil
'silent nil
'excl
))
1223 (file-already-exists t
))
1224 ;; the file was somehow created by someone else between
1225 ;; `make-temp-name' and `write-region', let's try again.
1229 (set-default-file-modes umask
))))
1231 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
1232 "Change the encoding of FILE's name from CODING to NEW-CODING.
1233 The value is a new name of FILE.
1234 Signals a `file-already-exists' error if a file of the new name
1235 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1236 is non-nil. A number as fourth arg means request confirmation if
1237 the new name already exists. This is what happens in interactive
1240 (let ((default-coding (or file-name-coding-system
1241 default-file-name-coding-system
))
1242 (filename (read-file-name "Recode filename: " nil nil t
))
1243 from-coding to-coding
)
1244 (if (and default-coding
1245 ;; We provide the default coding only when it seems that
1246 ;; the filename is correctly decoded by the default
1248 (let ((charsets (find-charset-string filename
)))
1249 (and (not (memq 'eight-bit-control charsets
))
1250 (not (memq 'eight-bit-graphic charsets
)))))
1251 (setq from-coding
(read-coding-system
1252 (format "Recode filename %s from (default %s): "
1253 filename default-coding
)
1255 (setq from-coding
(read-coding-system
1256 (format "Recode filename %s from: " filename
))))
1258 ;; We provide the default coding only when a user is going to
1259 ;; change the encoding not from the default coding.
1260 (if (eq from-coding default-coding
)
1261 (setq to-coding
(read-coding-system
1262 (format "Recode filename %s from %s to: "
1263 filename from-coding
)))
1264 (setq to-coding
(read-coding-system
1265 (format "Recode filename %s from %s to (default %s): "
1266 filename from-coding default-coding
)
1268 (list filename from-coding to-coding
)))
1270 (let* ((default-coding (or file-name-coding-system
1271 default-file-name-coding-system
))
1272 ;; FILE should have been decoded by DEFAULT-CODING.
1273 (encoded (encode-coding-string file default-coding
))
1274 (newname (decode-coding-string encoded coding
))
1275 (new-encoded (encode-coding-string newname new-coding
))
1276 ;; Suppress further encoding.
1277 (file-name-coding-system nil
)
1278 (default-file-name-coding-system nil
)
1279 (locale-coding-system nil
))
1280 (rename-file encoded new-encoded ok-if-already-exists
)
1283 (defcustom confirm-nonexistent-file-or-buffer
'after-completion
1284 "Whether confirmation is requested before visiting a new file or buffer.
1285 If nil, confirmation is not requested.
1286 If the value is `after-completion', confirmation is only
1287 requested if the user called `minibuffer-complete' right before
1288 `minibuffer-complete-and-exit'.
1289 Any other non-nil value means to request confirmation.
1291 This affects commands like `switch-to-buffer' and `find-file'."
1294 :type
'(choice (const :tag
"After completion" after-completion
)
1295 (const :tag
"Never" nil
)
1296 (other :tag
"Always" t
)))
1298 (defun confirm-nonexistent-file-or-buffer ()
1299 "Whether to request confirmation before visiting a new file or buffer.
1300 The variable `confirm-nonexistent-file-or-buffer' determines the
1301 return value, which may be passed as the REQUIRE-MATCH arg to
1302 `read-buffer' or `find-file-read-args'."
1303 (cond ((eq confirm-nonexistent-file-or-buffer
'after-completion
)
1304 'confirm-after-completion
)
1305 (confirm-nonexistent-file-or-buffer
1309 (defmacro minibuffer-with-setup-hook
(fun &rest body
)
1310 "Temporarily add FUN to `minibuffer-setup-hook' while executing BODY.
1311 BODY should use the minibuffer at most once.
1312 Recursive uses of the minibuffer are unaffected (FUN is not
1313 called additional times).
1315 This macro actually adds an auxiliary function that calls FUN,
1316 rather than FUN itself, to `minibuffer-setup-hook'."
1317 (declare (indent 1) (debug t
))
1318 (let ((hook (make-symbol "setup-hook")))
1322 ;; Clear out this hook so it does not interfere
1323 ;; with any recursive minibuffer usage.
1324 (remove-hook 'minibuffer-setup-hook
,hook
)
1328 (add-hook 'minibuffer-setup-hook
,hook
)
1330 (remove-hook 'minibuffer-setup-hook
,hook
)))))
1332 (defun find-file-read-args (prompt mustmatch
)
1333 (list (read-file-name prompt nil default-directory mustmatch
)
1336 (defun find-file (filename &optional wildcards
)
1337 "Edit file FILENAME.
1338 Switch to a buffer visiting file FILENAME,
1339 creating one if none already exists.
1340 Interactively, the default if you just type RET is the current directory,
1341 but the visited file name is available through the minibuffer history:
1342 type M-n to pull it into the minibuffer.
1344 You can visit files on remote machines by specifying something
1345 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1346 also visit local files as a different user by specifying
1347 /sudo::FILE for the file name.
1348 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1349 manual, for more about this.
1351 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1352 expand wildcards (if any) and visit multiple files. You can
1353 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1355 To visit a file without any kind of conversion and without
1356 automatically choosing a major mode, use \\[find-file-literally]."
1358 (find-file-read-args "Find file: "
1359 (confirm-nonexistent-file-or-buffer)))
1360 (let ((value (find-file-noselect filename nil nil wildcards
)))
1362 (mapcar 'switch-to-buffer
(nreverse value
))
1363 (switch-to-buffer value
))))
1365 (defun find-file-other-window (filename &optional wildcards
)
1366 "Edit file FILENAME, in another window.
1368 Like \\[find-file] (which see), but creates a new window or reuses
1369 an existing one. See the function `display-buffer'.
1371 Interactively, the default if you just type RET is the current directory,
1372 but the visited file name is available through the minibuffer history:
1373 type M-n to pull it into the minibuffer.
1375 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1376 expand wildcards (if any) and visit multiple files."
1378 (find-file-read-args "Find file in other window: "
1379 (confirm-nonexistent-file-or-buffer)))
1380 (let ((value (find-file-noselect filename nil nil wildcards
)))
1383 (setq value
(nreverse value
))
1384 (cons (switch-to-buffer-other-window (car value
))
1385 (mapcar 'switch-to-buffer
(cdr value
))))
1386 (switch-to-buffer-other-window value
))))
1388 (defun find-file-other-frame (filename &optional wildcards
)
1389 "Edit file FILENAME, in another frame.
1391 Like \\[find-file] (which see), but creates a new frame or reuses
1392 an existing one. See the function `display-buffer'.
1394 Interactively, the default if you just type RET is the current directory,
1395 but the visited file name is available through the minibuffer history:
1396 type M-n to pull it into the minibuffer.
1398 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1399 expand wildcards (if any) and visit multiple files."
1401 (find-file-read-args "Find file in other frame: "
1402 (confirm-nonexistent-file-or-buffer)))
1403 (let ((value (find-file-noselect filename nil nil wildcards
)))
1406 (setq value
(nreverse value
))
1407 (cons (switch-to-buffer-other-frame (car value
))
1408 (mapcar 'switch-to-buffer
(cdr value
))))
1409 (switch-to-buffer-other-frame value
))))
1411 (defun find-file-existing (filename)
1412 "Edit the existing file FILENAME.
1413 Like \\[find-file], but only allow a file that exists, and do not allow
1414 file names with wildcards."
1415 (interactive (nbutlast (find-file-read-args "Find existing file: " t
)))
1416 (if (and (not (called-interactively-p 'interactive
))
1417 (not (file-exists-p filename
)))
1418 (error "%s does not exist" filename
)
1419 (find-file filename
)
1422 (defun find-file-read-only (filename &optional wildcards
)
1423 "Edit file FILENAME but don't allow changes.
1424 Like \\[find-file], but marks buffer as read-only.
1425 Use \\[toggle-read-only] to permit editing."
1427 (find-file-read-args "Find file read-only: "
1428 (confirm-nonexistent-file-or-buffer)))
1429 (unless (or (and wildcards find-file-wildcards
1430 (not (string-match "\\`/:" filename
))
1431 (string-match "[[*?]" filename
))
1432 (file-exists-p filename
))
1433 (error "%s does not exist" filename
))
1434 (let ((value (find-file filename wildcards
)))
1435 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1436 (if (listp value
) value
(list value
)))
1439 (defun find-file-read-only-other-window (filename &optional wildcards
)
1440 "Edit file FILENAME in another window but don't allow changes.
1441 Like \\[find-file-other-window], but marks buffer as read-only.
1442 Use \\[toggle-read-only] to permit editing."
1444 (find-file-read-args "Find file read-only other window: "
1445 (confirm-nonexistent-file-or-buffer)))
1446 (unless (or (and wildcards find-file-wildcards
1447 (not (string-match "\\`/:" filename
))
1448 (string-match "[[*?]" filename
))
1449 (file-exists-p filename
))
1450 (error "%s does not exist" filename
))
1451 (let ((value (find-file-other-window filename wildcards
)))
1452 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1453 (if (listp value
) value
(list value
)))
1456 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1457 "Edit file FILENAME in another frame but don't allow changes.
1458 Like \\[find-file-other-frame], but marks buffer as read-only.
1459 Use \\[toggle-read-only] to permit editing."
1461 (find-file-read-args "Find file read-only other frame: "
1462 (confirm-nonexistent-file-or-buffer)))
1463 (unless (or (and wildcards find-file-wildcards
1464 (not (string-match "\\`/:" filename
))
1465 (string-match "[[*?]" filename
))
1466 (file-exists-p filename
))
1467 (error "%s does not exist" filename
))
1468 (let ((value (find-file-other-frame filename wildcards
)))
1469 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1470 (if (listp value
) value
(list value
)))
1473 (defun find-alternate-file-other-window (filename &optional wildcards
)
1474 "Find file FILENAME as a replacement for the file in the next window.
1475 This command does not select that window.
1477 See \\[find-file] for the possible forms of the FILENAME argument.
1479 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1480 expand wildcards (if any) and replace the file with multiple files."
1482 (save-selected-window
1484 (let ((file buffer-file-name
)
1488 (setq file-name
(file-name-nondirectory file
)
1489 file-dir
(file-name-directory file
)))
1490 (list (read-file-name
1491 "Find alternate file: " file-dir nil
1492 (confirm-nonexistent-file-or-buffer) file-name
)
1495 (find-file-other-window filename wildcards
)
1496 (save-selected-window
1498 (find-alternate-file filename wildcards
))))
1500 (defvar kill-buffer-hook
) ; from buffer.c
1502 (defun find-alternate-file (filename &optional wildcards
)
1503 "Find file FILENAME, select its buffer, kill previous buffer.
1504 If the current buffer now contains an empty file that you just visited
1505 \(presumably by mistake), use this command to visit the file you really want.
1507 See \\[find-file] for the possible forms of the FILENAME argument.
1509 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1510 expand wildcards (if any) and replace the file with multiple files.
1512 If the current buffer is an indirect buffer, or the base buffer
1513 for one or more indirect buffers, the other buffer(s) are not
1516 (let ((file buffer-file-name
)
1520 (setq file-name
(file-name-nondirectory file
)
1521 file-dir
(file-name-directory file
)))
1522 (list (read-file-name
1523 "Find alternate file: " file-dir nil
1524 (confirm-nonexistent-file-or-buffer) file-name
)
1526 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1528 (when (and (buffer-modified-p) buffer-file-name
)
1529 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
1532 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1533 (error "Aborted"))))
1534 (let ((obuf (current-buffer))
1535 (ofile buffer-file-name
)
1536 (onum buffer-file-number
)
1537 (odir dired-directory
)
1538 (otrue buffer-file-truename
)
1539 (oname (buffer-name)))
1540 ;; Run `kill-buffer-hook' here. It needs to happen before
1541 ;; variables like `buffer-file-name' etc are set to nil below,
1542 ;; because some of the hooks that could be invoked
1543 ;; (e.g., `save-place-to-alist') depend on those variables.
1545 ;; Note that `kill-buffer-hook' is not what queries whether to
1546 ;; save a modified buffer visiting a file. Rather, `kill-buffer'
1547 ;; asks that itself. Thus, there's no need to temporarily do
1548 ;; `(set-buffer-modified-p nil)' before running this hook.
1549 (run-hooks 'kill-buffer-hook
)
1550 ;; Okay, now we can end-of-life the old buffer.
1551 (if (get-buffer " **lose**")
1552 (kill-buffer " **lose**"))
1553 (rename-buffer " **lose**")
1557 ;; This prevents us from finding the same buffer
1558 ;; if we specified the same file again.
1559 (setq buffer-file-name nil
)
1560 (setq buffer-file-number nil
)
1561 (setq buffer-file-truename nil
)
1562 ;; Likewise for dired buffers.
1563 (setq dired-directory nil
)
1564 (find-file filename wildcards
))
1565 (when (eq obuf
(current-buffer))
1566 ;; This executes if find-file gets an error
1567 ;; and does not really find anything.
1568 ;; We put things back as they were.
1569 ;; If find-file actually finds something, we kill obuf below.
1570 (setq buffer-file-name ofile
)
1571 (setq buffer-file-number onum
)
1572 (setq buffer-file-truename otrue
)
1573 (setq dired-directory odir
)
1575 (rename-buffer oname
)))
1576 (unless (eq (current-buffer) obuf
)
1577 (with-current-buffer obuf
1578 ;; We already ran these; don't run them again.
1579 (let (kill-buffer-query-functions kill-buffer-hook
)
1580 (kill-buffer obuf
))))))
1582 (defun create-file-buffer (filename)
1583 "Create a suitably named buffer for visiting FILENAME, and return it.
1584 FILENAME (sans directory) is used unchanged if that name is free;
1585 otherwise a string <2> or <3> or ... is appended to get an unused name.
1586 Spaces at the start of FILENAME (sans directory) are removed."
1587 (let ((lastname (file-name-nondirectory filename
)))
1588 (if (string= lastname
"")
1589 (setq lastname filename
))
1591 (string-match "^ *\\(.*\\)" lastname
)
1592 (generate-new-buffer (match-string 1 lastname
)))))
1594 (defun generate-new-buffer (name)
1595 "Create and return a buffer with a name based on NAME.
1596 Choose the buffer's name using `generate-new-buffer-name'."
1597 (get-buffer-create (generate-new-buffer-name name
)))
1599 (defcustom automount-dir-prefix
(purecopy "^/tmp_mnt/")
1600 "Regexp to match the automounter prefix in a directory name."
1604 (defvar abbreviated-home-dir nil
1605 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1607 (defun abbreviate-file-name (filename)
1608 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1609 This also substitutes \"~\" for the user's home directory (unless the
1610 home directory is a root directory) and removes automounter prefixes
1611 \(see the variable `automount-dir-prefix')."
1612 ;; Get rid of the prefixes added by the automounter.
1614 (if (and automount-dir-prefix
1615 (string-match automount-dir-prefix filename
)
1616 (file-exists-p (file-name-directory
1617 (substring filename
(1- (match-end 0))))))
1618 (setq filename
(substring filename
(1- (match-end 0)))))
1619 ;; Avoid treating /home/foo as /home/Foo during `~' substitution.
1620 ;; To fix this right, we need a `file-name-case-sensitive-p'
1621 ;; function, but we don't have that yet, so just guess.
1622 (let ((case-fold-search
1623 (memq system-type
'(ms-dos windows-nt darwin cygwin
))))
1624 ;; If any elt of directory-abbrev-alist matches this name,
1625 ;; abbreviate accordingly.
1626 (dolist (dir-abbrev directory-abbrev-alist
)
1627 (if (string-match (car dir-abbrev
) filename
)
1629 (concat (cdr dir-abbrev
)
1630 (substring filename
(match-end 0))))))
1631 ;; Compute and save the abbreviated homedir name.
1632 ;; We defer computing this until the first time it's needed, to
1633 ;; give time for directory-abbrev-alist to be set properly.
1634 ;; We include a slash at the end, to avoid spurious matches
1635 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1636 (or abbreviated-home-dir
1637 (setq abbreviated-home-dir
1638 (let ((abbreviated-home-dir "$foo"))
1639 (concat "\\`" (abbreviate-file-name (expand-file-name "~"))
1642 ;; If FILENAME starts with the abbreviated homedir,
1643 ;; make it start with `~' instead.
1644 (if (and (string-match abbreviated-home-dir filename
)
1645 ;; If the home dir is just /, don't change it.
1646 (not (and (= (match-end 0) 1)
1647 (= (aref filename
0) ?
/)))
1648 ;; MS-DOS root directories can come with a drive letter;
1649 ;; Novell Netware allows drive letters beyond `Z:'.
1650 (not (and (memq system-type
'(ms-dos windows-nt cygwin
))
1652 (string-match "^[a-zA-`]:/$" filename
)))))
1655 (match-string 1 filename
)
1656 (substring filename
(match-end 0)))))
1659 (defun find-buffer-visiting (filename &optional predicate
)
1660 "Return the buffer visiting file FILENAME (a string).
1661 This is like `get-file-buffer', except that it checks for any buffer
1662 visiting the same file, possibly under a different name.
1663 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1664 and others are ignored.
1665 If there is no such live buffer, return nil."
1666 (let ((predicate (or predicate
#'identity
))
1667 (truename (abbreviate-file-name (file-truename filename
))))
1668 (or (let ((buf (get-file-buffer filename
)))
1669 (when (and buf
(funcall predicate buf
)) buf
))
1670 (let ((list (buffer-list)) found
)
1671 (while (and (not found
) list
)
1672 (with-current-buffer (car list
)
1673 (if (and buffer-file-name
1674 (string= buffer-file-truename truename
)
1675 (funcall predicate
(current-buffer)))
1676 (setq found
(car list
))))
1677 (setq list
(cdr list
)))
1679 (let* ((attributes (file-attributes truename
))
1680 (number (nthcdr 10 attributes
))
1681 (list (buffer-list)) found
)
1682 (and buffer-file-numbers-unique
1683 (car-safe number
) ;Make sure the inode is not just nil.
1684 (while (and (not found
) list
)
1685 (with-current-buffer (car list
)
1686 (if (and buffer-file-name
1687 (equal buffer-file-number number
)
1688 ;; Verify this buffer's file number
1689 ;; still belongs to its file.
1690 (file-exists-p buffer-file-name
)
1691 (equal (file-attributes buffer-file-truename
)
1693 (funcall predicate
(current-buffer)))
1694 (setq found
(car list
))))
1695 (setq list
(cdr list
))))
1698 (defcustom find-file-wildcards t
1699 "Non-nil means file-visiting commands should handle wildcards.
1700 For example, if you specify `*.c', that would visit all the files
1701 whose names match the pattern."
1706 (defcustom find-file-suppress-same-file-warnings nil
1707 "Non-nil means suppress warning messages for symlinked files.
1708 When nil, Emacs prints a warning when visiting a file that is already
1709 visited, but with a different name. Setting this option to t
1710 suppresses this warning."
1715 (defcustom large-file-warning-threshold
10000000
1716 "Maximum size of file above which a confirmation is requested.
1717 When nil, never request confirmation."
1721 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1723 (defun abort-if-file-too-large (size op-type filename
)
1724 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1725 OP-TYPE specifies the file operation being performed (for message to user)."
1726 (when (and large-file-warning-threshold size
1727 (> size large-file-warning-threshold
)
1728 (not (y-or-n-p (format "File %s is large (%dMB), really %s? "
1729 (file-name-nondirectory filename
)
1730 (/ size
1048576) op-type
))))
1733 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1734 "Read file FILENAME into a buffer and return the buffer.
1735 If a buffer exists visiting FILENAME, return that one, but
1736 verify that the file has not changed since visited or saved.
1737 The buffer is not selected, just returned to the caller.
1738 Optional second arg NOWARN non-nil means suppress any warning messages.
1739 Optional third arg RAWFILE non-nil means the file is read literally.
1740 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1741 and visit all the matching files. When wildcards are actually
1742 used and expanded, return a list of buffers that are visiting
1745 (abbreviate-file-name
1746 (expand-file-name filename
)))
1747 (if (file-directory-p filename
)
1748 (or (and find-file-run-dired
1749 (run-hook-with-args-until-success
1750 'find-directory-functions
1751 (if find-file-visit-truename
1752 (abbreviate-file-name (file-truename filename
))
1754 (error "%s is a directory" filename
))
1757 (not (string-match "\\`/:" filename
))
1758 (string-match "[[*?]" filename
))
1759 (let ((files (condition-case nil
1760 (file-expand-wildcards filename t
)
1761 (error (list filename
))))
1762 (find-file-wildcards nil
))
1764 (find-file-noselect filename
)
1765 (mapcar #'find-file-noselect files
)))
1766 (let* ((buf (get-file-buffer filename
))
1767 (truename (abbreviate-file-name (file-truename filename
)))
1768 (attributes (file-attributes truename
))
1769 (number (nthcdr 10 attributes
))
1770 ;; Find any buffer for a file which has same truename.
1771 (other (and (not buf
) (find-buffer-visiting filename
))))
1772 ;; Let user know if there is a buffer with the same truename.
1776 find-file-suppress-same-file-warnings
1777 (string-equal filename
(buffer-file-name other
))
1778 (message "%s and %s are the same file"
1779 filename
(buffer-file-name other
)))
1780 ;; Optionally also find that buffer.
1781 (if (or find-file-existing-other-name find-file-visit-truename
)
1783 ;; Check to see if the file looks uncommonly large.
1784 (when (not (or buf nowarn
))
1785 (abort-if-file-too-large (nth 7 attributes
) "open" filename
))
1787 ;; We are using an existing buffer.
1790 (verify-visited-file-modtime buf
)
1791 (cond ((not (file-exists-p filename
))
1792 (setq nonexistent t
)
1793 (message "File %s no longer exists!" filename
))
1794 ;; Certain files should be reverted automatically
1795 ;; if they have changed on disk and not in the buffer.
1796 ((and (not (buffer-modified-p buf
))
1797 (let ((tail revert-without-query
)
1800 (if (string-match (car tail
) filename
)
1802 (setq tail
(cdr tail
)))
1804 (with-current-buffer buf
1805 (message "Reverting file %s..." filename
)
1807 (message "Reverting file %s...done" filename
)))
1809 (if (string= (file-name-nondirectory filename
)
1812 (if (buffer-modified-p buf
)
1813 "File %s changed on disk. Discard your edits? "
1814 "File %s changed on disk. Reread from disk? ")
1815 (file-name-nondirectory filename
))
1817 (if (buffer-modified-p buf
)
1818 "File %s changed on disk. Discard your edits in %s? "
1819 "File %s changed on disk. Reread from disk into %s? ")
1820 (file-name-nondirectory filename
)
1821 (buffer-name buf
))))
1822 (with-current-buffer buf
1823 (revert-buffer t t
)))))
1824 (with-current-buffer buf
1826 ;; Check if a formerly read-only file has become
1827 ;; writable and vice versa, but if the buffer agrees
1828 ;; with the new state of the file, that is ok too.
1829 (let ((read-only (not (file-writable-p buffer-file-name
))))
1830 (unless (or nonexistent
1831 (eq read-only buffer-file-read-only
)
1832 (eq read-only buffer-read-only
))
1835 (format "File %s is %s on disk. Change buffer mode? "
1837 (if read-only
"read-only" "writable"))))
1838 (y-or-n-p question
)))
1839 (setq buffer-read-only read-only
)))
1840 (setq buffer-file-read-only read-only
))
1842 (when (and (not (eq (not (null rawfile
))
1843 (not (null find-file-literally
))))
1845 ;; It is confusing to ask whether to visit
1846 ;; non-literally if they have the file in
1847 ;; hexl-mode or image-mode.
1848 (not (memq major-mode
'(hexl-mode image-mode
))))
1849 (if (buffer-modified-p)
1853 "The file %s is already visited normally,
1854 and you have edited the buffer. Now you have asked to visit it literally,
1855 meaning no coding system handling, format conversion, or local variables.
1856 Emacs can only visit a file in one way at a time.
1858 Do you want to save the file, and visit it literally instead? "
1859 "The file %s is already visited literally,
1860 meaning no coding system handling, format conversion, or local variables.
1861 You have edited the buffer. Now you have asked to visit the file normally,
1862 but Emacs can only visit a file in one way at a time.
1864 Do you want to save the file, and visit it normally instead? ")
1865 (file-name-nondirectory filename
)))
1868 (find-file-noselect-1 buf filename nowarn
1869 rawfile truename number
))
1874 Do you want to discard your changes, and visit the file literally now? "
1876 Do you want to discard your changes, and visit the file normally now? ")))
1877 (find-file-noselect-1 buf filename nowarn
1878 rawfile truename number
)
1879 (error (if rawfile
"File already visited non-literally"
1880 "File already visited literally"))))
1884 "The file %s is already visited normally.
1885 You have asked to visit it literally,
1886 meaning no coding system decoding, format conversion, or local variables.
1887 But Emacs can only visit a file in one way at a time.
1889 Do you want to revisit the file literally now? "
1890 "The file %s is already visited literally,
1891 meaning no coding system decoding, format conversion, or local variables.
1892 You have asked to visit it normally,
1893 but Emacs can only visit a file in one way at a time.
1895 Do you want to revisit the file normally now? ")
1896 (file-name-nondirectory filename
)))
1897 (find-file-noselect-1 buf filename nowarn
1898 rawfile truename number
)
1899 (error (if rawfile
"File already visited non-literally"
1900 "File already visited literally"))))))
1901 ;; Return the buffer we are using.
1903 ;; Create a new buffer.
1904 (setq buf
(create-file-buffer filename
))
1905 ;; find-file-noselect-1 may use a different buffer.
1906 (find-file-noselect-1 buf filename nowarn
1907 rawfile truename number
))))))
1909 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1911 (with-current-buffer buf
1912 (kill-local-variable 'find-file-literally
)
1913 ;; Needed in case we are re-visiting the file with a different
1914 ;; text representation.
1915 (kill-local-variable 'buffer-file-coding-system
)
1916 (kill-local-variable 'cursor-type
)
1917 (let ((inhibit-read-only t
))
1919 (and (default-value 'enable-multibyte-characters
)
1921 (set-buffer-multibyte t
))
1924 (let ((inhibit-read-only t
))
1925 (insert-file-contents-literally filename t
))
1927 (when (and (file-exists-p filename
)
1928 (not (file-readable-p filename
)))
1930 (signal 'file-error
(list "File is not readable"
1932 ;; Unconditionally set error
1935 (let ((inhibit-read-only t
))
1936 (insert-file-contents filename t
))
1938 (when (and (file-exists-p filename
)
1939 (not (file-readable-p filename
)))
1941 (signal 'file-error
(list "File is not readable"
1943 ;; Run find-file-not-found-functions until one returns non-nil.
1944 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1945 ;; If they fail too, set error.
1947 ;; Record the file's truename, and maybe use that as visited name.
1948 (if (equal filename buffer-file-name
)
1949 (setq buffer-file-truename truename
)
1950 (setq buffer-file-truename
1951 (abbreviate-file-name (file-truename buffer-file-name
))))
1952 (setq buffer-file-number number
)
1953 (if find-file-visit-truename
1954 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
1955 ;; Set buffer's default directory to that of the file.
1956 (setq default-directory
(file-name-directory buffer-file-name
))
1957 ;; Turn off backup files for certain file names. Since
1958 ;; this is a permanent local, the major mode won't eliminate it.
1959 (and backup-enable-predicate
1960 (not (funcall backup-enable-predicate buffer-file-name
))
1962 (make-local-variable 'backup-inhibited
)
1963 (setq backup-inhibited t
)))
1966 (set-buffer-multibyte nil
)
1967 (setq buffer-file-coding-system
'no-conversion
)
1968 (set-buffer-major-mode buf
)
1969 (make-local-variable 'find-file-literally
)
1970 (setq find-file-literally t
))
1971 (after-find-file error
(not nowarn
)))
1974 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
1975 "Like `insert-file-contents', but only reads in the file literally.
1976 A buffer may be modified in several ways after reading into the buffer,
1977 to Emacs features such as format decoding, character code
1978 conversion, `find-file-hook', automatic uncompression, etc.
1980 This function ensures that none of these modifications will take place."
1981 (let ((format-alist nil
)
1982 (after-insert-file-functions nil
)
1983 (coding-system-for-read 'no-conversion
)
1984 (coding-system-for-write 'no-conversion
)
1985 (find-buffer-file-type-function
1986 (if (fboundp 'find-buffer-file-type
)
1987 (symbol-function 'find-buffer-file-type
)
1989 (inhibit-file-name-handlers
1990 (append '(jka-compr-handler image-file-handler epa-file-handler
)
1991 inhibit-file-name-handlers
))
1992 (inhibit-file-name-operation 'insert-file-contents
))
1995 (fset 'find-buffer-file-type
(lambda (_filename) t
))
1996 (insert-file-contents filename visit beg end replace
))
1997 (if find-buffer-file-type-function
1998 (fset 'find-buffer-file-type find-buffer-file-type-function
)
1999 (fmakunbound 'find-buffer-file-type
)))))
2001 (defun insert-file-1 (filename insert-func
)
2002 (if (file-directory-p filename
)
2003 (signal 'file-error
(list "Opening input file" "file is a directory"
2005 ;; Check whether the file is uncommonly large
2006 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert" filename
)
2007 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
2008 #'buffer-modified-p
))
2009 (tem (funcall insert-func filename
)))
2010 (push-mark (+ (point) (car (cdr tem
))))
2012 (message "File %s already visited and modified in buffer %s"
2013 filename
(buffer-name buffer
)))))
2015 (defun insert-file-literally (filename)
2016 "Insert contents of file FILENAME into buffer after point with no conversion.
2018 This function is meant for the user to run interactively.
2019 Don't call it from programs! Use `insert-file-contents-literally' instead.
2020 \(Its calling sequence is different; see its documentation)."
2021 (interactive "*fInsert file literally: ")
2022 (insert-file-1 filename
#'insert-file-contents-literally
))
2024 (defvar find-file-literally nil
2025 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
2026 This has the `permanent-local' property, which takes effect if you
2027 make the variable buffer-local.")
2028 (put 'find-file-literally
'permanent-local t
)
2030 (defun find-file-literally (filename)
2031 "Visit file FILENAME with no conversion of any kind.
2032 Format conversion and character code conversion are both disabled,
2033 and multibyte characters are disabled in the resulting buffer.
2034 The major mode used is Fundamental mode regardless of the file name,
2035 and local variable specifications in the file are ignored.
2036 Automatic uncompression and adding a newline at the end of the
2037 file due to `require-final-newline' is also disabled.
2039 You cannot absolutely rely on this function to result in
2040 visiting the file literally. If Emacs already has a buffer
2041 which is visiting the file, you get the existing buffer,
2042 regardless of whether it was created literally or not.
2044 In a Lisp program, if you want to be sure of accessing a file's
2045 contents literally, you should create a temporary buffer and then read
2046 the file contents into it using `insert-file-contents-literally'."
2048 (list (read-file-name
2049 "Find file literally: " nil default-directory
2050 (confirm-nonexistent-file-or-buffer))))
2051 (switch-to-buffer (find-file-noselect filename nil t
)))
2053 (defun after-find-file (&optional error warn noauto
2054 _after-find-file-from-revert-buffer
2056 "Called after finding a file and by the default revert function.
2057 Sets buffer mode, parses local variables.
2058 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
2059 error in reading the file. WARN non-nil means warn if there
2060 exists an auto-save file more recent than the visited file.
2061 NOAUTO means don't mess with auto-save mode.
2062 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER is ignored
2063 \(see `revert-buffer-in-progress-p' for similar functionality).
2064 Fifth arg NOMODES non-nil means don't alter the file's modes.
2065 Finishes by calling the functions in `find-file-hook'
2066 unless NOMODES is non-nil."
2067 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
2074 ((and error
(file-attributes buffer-file-name
))
2075 (setq buffer-read-only t
)
2076 (if (and (file-symlink-p buffer-file-name
)
2078 (file-chase-links buffer-file-name
))))
2079 "Symbolic link that points to nonexistent file"
2080 "File exists, but cannot be read"))
2081 ((not buffer-read-only
)
2083 ;; No need to warn if buffer is auto-saved
2084 ;; under the name of the visited file.
2085 (not (and buffer-file-name
2086 auto-save-visited-file-name
))
2087 (file-newer-than-file-p (or buffer-auto-save-file-name
2088 (make-auto-save-file-name))
2090 (format "%s has auto save data; consider M-x recover-this-file"
2091 (file-name-nondirectory buffer-file-name
))
2092 (setq not-serious t
)
2093 (if error
"(New file)" nil
)))
2095 (setq not-serious t
)
2096 "Note: file is write protected")
2097 ((file-attributes (directory-file-name default-directory
))
2098 "File not found and directory write-protected")
2099 ((file-exists-p (file-name-directory buffer-file-name
))
2100 (setq buffer-read-only nil
))
2102 (setq buffer-read-only nil
)
2103 "Use M-x make-directory RET RET to create the directory and its parents"))))
2106 (or not-serious
(sit-for 1 t
))))
2107 (when (and auto-save-default
(not noauto
))
2108 (auto-save-mode 1)))
2109 ;; Make people do a little extra work (C-x C-q)
2110 ;; before altering a backup file.
2111 (when (backup-file-name-p buffer-file-name
)
2112 (setq buffer-read-only t
))
2113 ;; When a file is marked read-only,
2114 ;; make the buffer read-only even if root is looking at it.
2115 (when (and (file-modes (buffer-file-name))
2116 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
2117 (setq buffer-read-only t
))
2119 (when (and view-read-only view-mode
)
2120 (view-mode-disable))
2122 ;; If requested, add a newline at the end of the file.
2123 (and (memq require-final-newline
'(visit visit-save
))
2124 (> (point-max) (point-min))
2125 (/= (char-after (1- (point-max))) ?
\n)
2126 (not (and (eq selective-display t
)
2127 (= (char-after (1- (point-max))) ?
\r)))
2129 (goto-char (point-max))
2131 (when (and buffer-read-only
2133 (not (eq (get major-mode
'mode-class
) 'special
)))
2135 (run-hooks 'find-file-hook
)))
2137 (defmacro report-errors
(format &rest body
)
2138 "Eval BODY and turn any error into a FORMAT message.
2139 FORMAT can have a %s escape which will be replaced with the actual error.
2140 If `debug-on-error' is set, errors are not caught, so that you can
2142 Avoid using a large BODY since it is duplicated."
2143 (declare (debug t
) (indent 1))
2148 (error (message ,format
(prin1-to-string err
))))))
2150 (defun normal-mode (&optional find-file
)
2151 "Choose the major mode for this buffer automatically.
2152 Also sets up any specified local variables of the file.
2153 Uses the visited file name, the -*- line, and the local variables spec.
2155 This function is called automatically from `find-file'. In that case,
2156 we may set up the file-specified mode and local variables,
2157 depending on the value of `enable-local-variables'.
2158 In addition, if `local-enable-local-variables' is nil, we do
2159 not set local variables (though we do notice a mode specified with -*-.)
2161 `enable-local-variables' is ignored if you run `normal-mode' interactively,
2162 or from Lisp without specifying the optional argument FIND-FILE;
2163 in that case, this function acts as if `enable-local-variables' were t."
2165 (funcall (or (default-value 'major-mode
) 'fundamental-mode
))
2166 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
2167 ;; FIXME this is less efficient than it could be, since both
2168 ;; s-a-m and h-l-v may parse the same regions, looking for "mode:".
2169 (report-errors "File mode specification error: %s"
2171 (report-errors "File local-variables error: %s"
2172 (hack-local-variables)))
2173 ;; Turn font lock off and on, to make sure it takes account of
2174 ;; whatever file local variables are relevant to it.
2175 (when (and font-lock-mode
2176 ;; Font-lock-mode (now in font-core.el) can be ON when
2177 ;; font-lock.el still hasn't been loaded.
2178 (boundp 'font-lock-keywords
)
2179 (eq (car font-lock-keywords
) t
))
2180 (setq font-lock-keywords
(cadr font-lock-keywords
))
2183 (if (fboundp 'ucs-set-table-for-input
) ; don't lose when building
2184 (ucs-set-table-for-input)))
2186 (defcustom auto-mode-case-fold t
2187 "Non-nil means to try second pass through `auto-mode-alist'.
2188 This means that if the first case-sensitive search through the alist fails
2189 to find a matching major mode, a second case-insensitive search is made.
2190 On systems with case-insensitive file names, this variable is ignored,
2191 since only a single case-insensitive search through the alist is made."
2196 (defvar auto-mode-alist
2197 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2198 ;; c++-mode, java-mode and more) are added through autoload
2199 ;; directives in that file. That way is discouraged since it
2200 ;; spreads out the definition of the initial value.
2203 (cons (purecopy (car elt
)) (cdr elt
)))
2204 `(;; do this first, so that .html.pl is Polish html, not Perl
2205 ("\\.[sx]?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2206 ("\\.svgz?\\'" . image-mode
)
2207 ("\\.svgz?\\'" . xml-mode
)
2208 ("\\.x[bp]m\\'" . image-mode
)
2209 ("\\.x[bp]m\\'" . c-mode
)
2210 ("\\.p[bpgn]m\\'" . image-mode
)
2211 ("\\.tiff?\\'" . image-mode
)
2212 ("\\.gif\\'" . image-mode
)
2213 ("\\.png\\'" . image-mode
)
2214 ("\\.jpe?g\\'" . image-mode
)
2215 ("\\.te?xt\\'" . text-mode
)
2216 ("\\.[tT]e[xX]\\'" . tex-mode
)
2217 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2218 ("\\.ltx\\'" . latex-mode
)
2219 ("\\.dtx\\'" . doctex-mode
)
2220 ("\\.org\\'" . org-mode
)
2221 ("\\.el\\'" . emacs-lisp-mode
)
2222 ("Project\\.ede\\'" . emacs-lisp-mode
)
2223 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2224 ("\\.l\\'" . lisp-mode
)
2225 ("\\.li?sp\\'" . lisp-mode
)
2226 ("\\.[fF]\\'" . fortran-mode
)
2227 ("\\.for\\'" . fortran-mode
)
2228 ("\\.p\\'" . pascal-mode
)
2229 ("\\.pas\\'" . pascal-mode
)
2230 ("\\.\\(dpr\\|DPR\\)\\'" . delphi-mode
)
2231 ("\\.ad[abs]\\'" . ada-mode
)
2232 ("\\.ad[bs].dg\\'" . ada-mode
)
2233 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2234 ("Imakefile\\'" . makefile-imake-mode
)
2235 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2236 ("\\.makepp\\'" . makefile-makepp-mode
)
2237 ,@(if (memq system-type
'(berkeley-unix darwin
))
2238 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2239 ("GNUmakefile\\'" . makefile-gmake-mode
)
2240 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2241 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2242 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2243 ("\\.am\\'" . makefile-automake-mode
)
2244 ;; Less common extensions come here
2245 ;; so more common ones above are found faster.
2246 ("\\.texinfo\\'" . texinfo-mode
)
2247 ("\\.te?xi\\'" . texinfo-mode
)
2248 ("\\.[sS]\\'" . asm-mode
)
2249 ("\\.asm\\'" . asm-mode
)
2250 ("\\.css\\'" . css-mode
)
2251 ("\\.mixal\\'" . mixal-mode
)
2252 ("\\.gcov\\'" . compilation-mode
)
2253 ;; Besides .gdbinit, gdb documents other names to be usable for init
2254 ;; files, cross-debuggers can use something like
2255 ;; .PROCESSORNAME-gdbinit so that the host and target gdbinit files
2256 ;; don't interfere with each other.
2257 ("/\\.[a-z0-9-]*gdbinit" . gdb-script-mode
)
2258 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2259 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2260 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2261 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2262 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2263 ("\\.bash\\'" . sh-mode
)
2264 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2265 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2266 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2267 ("\\.m?spec\\'" . sh-mode
)
2268 ("\\.m[mes]\\'" . nroff-mode
)
2269 ("\\.man\\'" . nroff-mode
)
2270 ("\\.sty\\'" . latex-mode
)
2271 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2272 ("\\.bbl\\'" . latex-mode
)
2273 ("\\.bib\\'" . bibtex-mode
)
2274 ("\\.bst\\'" . bibtex-style-mode
)
2275 ("\\.sql\\'" . sql-mode
)
2276 ("\\.m[4c]\\'" . m4-mode
)
2277 ("\\.mf\\'" . metafont-mode
)
2278 ("\\.mp\\'" . metapost-mode
)
2279 ("\\.vhdl?\\'" . vhdl-mode
)
2280 ("\\.article\\'" . text-mode
)
2281 ("\\.letter\\'" . text-mode
)
2282 ("\\.i?tcl\\'" . tcl-mode
)
2283 ("\\.exp\\'" . tcl-mode
)
2284 ("\\.itk\\'" . tcl-mode
)
2285 ("\\.icn\\'" . icon-mode
)
2286 ("\\.sim\\'" . simula-mode
)
2287 ("\\.mss\\'" . scribe-mode
)
2288 ;; The Fortran standard does not say anything about file extensions.
2289 ;; .f90 was widely used for F90, now we seem to be trapped into
2290 ;; using a different extension for each language revision.
2291 ;; Anyway, the following extensions are supported by gfortran.
2292 ("\\.f9[05]\\'" . f90-mode
)
2293 ("\\.f0[38]\\'" . f90-mode
)
2294 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2295 ("\\.\\(pro\\|PRO\\)\\'" . idlwave-mode
)
2296 ("\\.srt\\'" . srecode-template-mode
)
2297 ("\\.prolog\\'" . prolog-mode
)
2298 ("\\.tar\\'" . tar-mode
)
2299 ;; The list of archive file extensions should be in sync with
2300 ;; `auto-coding-alist' with `no-conversion' coding system.
2302 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|7z\\|\
2303 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\|7Z\\)\\'" . archive-mode
)
2304 ("\\.\\(sx[dmicw]\\|od[fgpst]\\|oxt\\)\\'" . archive-mode
) ;OpenOffice.org
2305 ("\\.\\(deb\\|[oi]pk\\)\\'" . archive-mode
) ; Debian/Opkg packages.
2306 ;; Mailer puts message to be edited in
2307 ;; /tmp/Re.... or Message
2308 ("\\`/tmp/Re" . text-mode
)
2309 ("/Message[0-9]*\\'" . text-mode
)
2310 ;; some news reader is reported to use this
2311 ("\\`/tmp/fol/" . text-mode
)
2312 ("\\.oak\\'" . scheme-mode
)
2313 ("\\.sgml?\\'" . sgml-mode
)
2314 ("\\.x[ms]l\\'" . xml-mode
)
2315 ("\\.dbk\\'" . xml-mode
)
2316 ("\\.dtd\\'" . sgml-mode
)
2317 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2318 ("\\.js\\'" . js-mode
) ; javascript-mode would be better
2319 ("\\.json\\'" . js-mode
)
2320 ("\\.[ds]?vh?\\'" . verilog-mode
)
2321 ;; .emacs or .gnus or .viper following a directory delimiter in
2322 ;; Unix, MSDOG or VMS syntax.
2323 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2324 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2325 ;; _emacs following a directory delimiter
2327 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2328 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2329 ("\\.ml\\'" . lisp-mode
)
2330 ;; Linux-2.6.9 uses some different suffix for linker scripts:
2331 ;; "ld", "lds", "lds.S", "lds.in", "ld.script", and "ld.script.balo".
2332 ;; eCos uses "ld" and "ldi". Netbsd uses "ldscript.*".
2333 ("\\.ld[si]?\\'" . ld-script-mode
)
2334 ("ld\\.?script\\'" . ld-script-mode
)
2335 ;; .xs is also used for ld scripts, but seems to be more commonly
2336 ;; associated with Perl .xs files (C with Perl bindings). (Bug#7071)
2337 ("\\.xs\\'" . c-mode
)
2338 ;; Explained in binutils ld/genscripts.sh. Eg:
2339 ;; A .x script file is the default script.
2340 ;; A .xr script is for linking without relocation (-r flag). Etc.
2341 ("\\.x[abdsru]?[cnw]?\\'" . ld-script-mode
)
2342 ("\\.zone\\'" . dns-mode
)
2343 ("\\.soa\\'" . dns-mode
)
2344 ;; Common Lisp ASDF package system.
2345 ("\\.asd\\'" . lisp-mode
)
2346 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2347 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2348 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2349 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2350 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2351 ("\\.\\(?:PDF\\|DVI\\|OD[FGPST]\\|DOCX?\\|XLSX?\\|PPTX?\\|pdf\\|dvi\\|od[fgpst]\\|docx?\\|xlsx?\\|pptx?\\)\\'" . doc-view-mode-maybe
)
2352 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2353 ("\\.s\\(v\\|iv\\|ieve\\)\\'" . sieve-mode
)
2354 ("BROWSE\\'" . ebrowse-tree-mode
)
2355 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2356 ("#\\*mail\\*" . mail-mode
)
2357 ("\\.g\\'" . antlr-mode
)
2358 ("\\.mod\\'" . m2-mode
)
2359 ("\\.ses\\'" . ses-mode
)
2360 ("\\.docbook\\'" . sgml-mode
)
2361 ("\\.com\\'" . dcl-mode
)
2362 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2363 ;; Windows candidates may be opened case sensitively on Unix
2364 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2365 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2366 ("\\.ppd\\'" . conf-ppd-mode
)
2367 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2368 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2369 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2370 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2371 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2372 ;; this has lower priority to avoid matching changelog.sgml etc.
2373 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2374 ;; either user's dot-files or under /etc or some such
2375 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2376 ;; alas not all ~/.*rc files are like this
2377 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2378 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2379 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2380 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2381 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2382 ;; this contains everything twice, with space and with colon :-(
2383 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2384 ;; Get rid of any trailing .n.m and try again.
2385 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2386 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2387 ;; Using mode nil rather than `ignore' would let the search continue
2388 ;; through this list (with the shortened name) rather than start over.
2389 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2390 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)
2391 ;; This should come after "in" stripping (e.g. config.h.in).
2392 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2393 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2394 ;; The following should come after the ChangeLog pattern
2395 ;; for the sake of ChangeLog.1, etc.
2396 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2397 ("\\.[1-9]\\'" . nroff-mode
)))
2398 "Alist of filename patterns vs corresponding major mode functions.
2399 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2400 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2401 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2402 mode function to use. FUNCTION will be called, unless it is nil.
2404 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2405 calling FUNCTION (if it's not nil), we delete the suffix that matched
2406 REGEXP and search the list again for another match.
2408 The extensions whose FUNCTION is `archive-mode' should also
2409 appear in `auto-coding-alist' with `no-conversion' coding system.
2411 See also `interpreter-mode-alist', which detects executable script modes
2412 based on the interpreters they specify to run,
2413 and `magic-mode-alist', which determines modes based on file contents.")
2414 (put 'auto-mode-alist
'risky-local-variable t
)
2416 (defun conf-mode-maybe ()
2417 "Select Conf mode or XML mode according to start of file."
2421 (goto-char (point-min))
2422 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2426 (defvar interpreter-mode-alist
2427 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2428 ;; and pike-mode) are added through autoload directives in that
2429 ;; file. That way is discouraged since it spreads out the
2430 ;; definition of the initial value.
2433 (cons (purecopy (car l
)) (cdr l
)))
2434 '(("perl" . perl-mode
)
2435 ("perl5" . perl-mode
)
2436 ("miniperl" . perl-mode
)
2438 ("wishx" . tcl-mode
)
2440 ("tclsh" . tcl-mode
)
2441 ("scm" . scheme-mode
)
2462 ("tail" . text-mode
)
2463 ("more" . text-mode
)
2464 ("less" . text-mode
)
2466 ("make" . makefile-gmake-mode
) ; Debian uses this
2467 ("guile" . scheme-mode
)
2468 ("clisp" . lisp-mode
)
2469 ("emacs" . emacs-lisp-mode
)))
2470 "Alist mapping interpreter names to major modes.
2471 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2472 Each element looks like (INTERPRETER . MODE).
2473 If INTERPRETER matches the name of the interpreter specified in the first line
2474 of a script, mode MODE is enabled.
2476 See also `auto-mode-alist'.")
2478 (defvar inhibit-first-line-modes-regexps
2479 (mapcar 'purecopy
'("\\.tar\\'" "\\.tgz\\'" "\\.tiff?\\'"
2480 "\\.gif\\'" "\\.png\\'" "\\.jpe?g\\'"))
2481 "List of regexps; if one matches a file name, don't look for `-*-'.
2482 See also `inhibit-first-line-modes-suffixes'.")
2484 (defvar inhibit-first-line-modes-suffixes nil
2485 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2486 When checking `inhibit-first-line-modes-regexps', we first discard
2487 from the end of the file name anything that matches one of these regexps.")
2489 (defvar auto-mode-interpreter-regexp
2490 (purecopy "#![ \t]?\\([^ \t\n]*\
2491 /bin/env[ \t]\\)?\\([^ \t\n]+\\)")
2492 "Regexp matching interpreters, for file mode determination.
2493 This regular expression is matched against the first line of a file
2494 to determine the file's mode in `set-auto-mode'. If it matches, the file
2495 is assumed to be interpreted by the interpreter matched by the second group
2496 of the regular expression. The mode is then determined as the mode
2497 associated with that interpreter in `interpreter-mode-alist'.")
2499 (defvar magic-mode-alist nil
2500 "Alist of buffer beginnings vs. corresponding major mode functions.
2501 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2502 After visiting a file, if REGEXP matches the text at the beginning of the
2503 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2504 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2507 If FUNCTION is nil, then it is not called. (That is a way of saying
2508 \"allow `auto-mode-alist' to decide for these files.\")")
2509 (put 'magic-mode-alist
'risky-local-variable t
)
2511 (defvar magic-fallback-mode-alist
2513 `((image-type-auto-detected-p . image-mode
)
2514 ("\\(PK00\\)?[P]K\003\004" . archive-mode
) ; zip
2515 ;; The < comes before the groups (but the first) to reduce backtracking.
2516 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2517 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2518 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2519 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2520 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2522 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2523 "[Hh][Tt][Mm][Ll]"))
2525 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2526 ;; These two must come after html, because they are more general:
2527 ("<\\?xml " . xml-mode
)
2528 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2529 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2530 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2533 ("# xmcd " . conf-unix-mode
)))
2534 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2535 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2536 After visiting a file, if REGEXP matches the text at the beginning of the
2537 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2538 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2539 have not specified a mode for this file.
2541 If FUNCTION is nil, then it is not called.")
2542 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2544 (defvar magic-mode-regexp-match-limit
4000
2545 "Upper limit on `magic-mode-alist' regexp matches.
2546 Also applies to `magic-fallback-mode-alist'.")
2548 (defun set-auto-mode (&optional keep-mode-if-same
)
2549 "Select major mode appropriate for current buffer.
2551 To find the right major mode, this function checks for a -*- mode tag
2552 \(unless `inhibit-first-line-modes-regexps' says not to),
2553 checks for a `mode:' entry in the Local Variables section of the file,
2554 checks if it uses an interpreter listed in `interpreter-mode-alist',
2555 matches the buffer beginning against `magic-mode-alist',
2556 compares the filename against the entries in `auto-mode-alist',
2557 then matches the buffer beginning against `magic-fallback-mode-alist'.
2559 If `enable-local-variables' is nil, this function does not check for
2560 any mode: tag anywhere in the file.
2562 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2563 set the major mode only if that would change it. In other words
2564 we don't actually set it to the same mode the buffer already has."
2565 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2566 (let (end done mode modes
)
2567 ;; Once we drop the deprecated feature where mode: is also allowed to
2568 ;; specify minor-modes (ie, there can be more than one "mode:"), we can
2569 ;; remove this section and just let (hack-local-variables t) handle it.
2570 ;; Find a -*- mode tag.
2572 (goto-char (point-min))
2573 (skip-chars-forward " \t\n")
2574 (and enable-local-variables
2575 (setq end
(set-auto-mode-1))
2576 (if (save-excursion (search-forward ":" end t
))
2577 ;; Find all specifications for the `mode:' variable
2578 ;; and execute them left to right.
2579 (while (let ((case-fold-search t
))
2580 (or (and (looking-at "mode:")
2581 (goto-char (match-end 0)))
2582 (re-search-forward "[ \t;]mode:" end t
)))
2583 (skip-chars-forward " \t")
2584 (let ((beg (point)))
2585 (if (search-forward ";" end t
)
2588 (skip-chars-backward " \t")
2589 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2591 ;; Simple -*-MODE-*- case.
2592 (push (intern (concat (downcase (buffer-substring (point) end
))
2595 ;; If we found modes to use, invoke them now, outside the save-excursion.
2598 (dolist (mode (nreverse modes
))
2599 (if (not (functionp mode
))
2600 (message "Ignoring unknown mode `%s'" mode
)
2602 (or (set-auto-mode-0 mode keep-mode-if-same
)
2603 ;; continuing would call minor modes again, toggling them off
2604 (throw 'nop nil
))))))
2606 enable-local-variables
2607 (setq mode
(hack-local-variables t
))
2608 (not (memq mode modes
)) ; already tried and failed
2609 (if (not (functionp mode
))
2610 (message "Ignoring unknown mode `%s'" mode
)
2612 (set-auto-mode-0 mode keep-mode-if-same
)))
2613 ;; If we didn't, look for an interpreter specified in the first line.
2614 ;; As a special case, allow for things like "#!/bin/env perl", which
2615 ;; finds the interpreter anywhere in $PATH.
2617 (setq mode
(save-excursion
2618 (goto-char (point-min))
2619 (if (looking-at auto-mode-interpreter-regexp
)
2622 ;; Map interpreter name to a mode, signaling we're done at the
2624 done
(assoc (file-name-nondirectory mode
)
2625 interpreter-mode-alist
))
2626 ;; If we found an interpreter mode to use, invoke it now.
2628 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2629 ;; Next try matching the buffer beginning against magic-mode-alist.
2631 (if (setq done
(save-excursion
2632 (goto-char (point-min))
2634 (narrow-to-region (point-min)
2636 (+ (point-min) magic-mode-regexp-match-limit
)))
2637 (assoc-default nil magic-mode-alist
2641 (looking-at re
)))))))
2642 (set-auto-mode-0 done keep-mode-if-same
)))
2643 ;; Next compare the filename against the entries in auto-mode-alist.
2645 (if buffer-file-name
2646 (let ((name buffer-file-name
)
2647 (remote-id (file-remote-p buffer-file-name
)))
2648 ;; Remove backup-suffixes from file name.
2649 (setq name
(file-name-sans-versions name
))
2650 ;; Remove remote file name identification.
2651 (when (and (stringp remote-id
)
2652 (string-match (regexp-quote remote-id
) name
))
2653 (setq name
(substring name
(match-end 0))))
2655 ;; Find first matching alist entry.
2657 (if (memq system-type
'(windows-nt cygwin
))
2658 ;; System is case-insensitive.
2659 (let ((case-fold-search t
))
2660 (assoc-default name auto-mode-alist
2662 ;; System is case-sensitive.
2664 ;; First match case-sensitively.
2665 (let ((case-fold-search nil
))
2666 (assoc-default name auto-mode-alist
2668 ;; Fallback to case-insensitive match.
2669 (and auto-mode-case-fold
2670 (let ((case-fold-search t
))
2671 (assoc-default name auto-mode-alist
2676 (setq mode
(car mode
)
2677 name
(substring name
0 (match-beginning 0)))
2680 (set-auto-mode-0 mode keep-mode-if-same
)
2682 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2684 (if (setq done
(save-excursion
2685 (goto-char (point-min))
2687 (narrow-to-region (point-min)
2689 (+ (point-min) magic-mode-regexp-match-limit
)))
2690 (assoc-default nil magic-fallback-mode-alist
2694 (looking-at re
)))))))
2695 (set-auto-mode-0 done keep-mode-if-same
)))))
2697 ;; When `keep-mode-if-same' is set, we are working on behalf of
2698 ;; set-visited-file-name. In that case, if the major mode specified is the
2699 ;; same one we already have, don't actually reset it. We don't want to lose
2700 ;; minor modes such as Font Lock.
2701 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2702 "Apply MODE and return it.
2703 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2704 any aliases and compared to current major mode. If they are the
2705 same, do nothing and return nil."
2706 (unless (and keep-mode-if-same
2707 (eq (indirect-function mode
)
2708 (indirect-function major-mode
)))
2713 (defun set-auto-mode-1 ()
2714 "Find the -*- spec in the buffer.
2715 Call with point at the place to start searching from.
2716 If one is found, set point to the beginning
2717 and return the position of the end.
2718 Otherwise, return nil; point may be changed."
2721 ;; Don't look for -*- if this file name matches any
2722 ;; of the regexps in inhibit-first-line-modes-regexps.
2723 (let ((temp inhibit-first-line-modes-regexps
)
2724 (name (if buffer-file-name
2725 (file-name-sans-versions buffer-file-name
)
2727 (while (let ((sufs inhibit-first-line-modes-suffixes
))
2728 (while (and sufs
(not (string-match (car sufs
) name
)))
2729 (setq sufs
(cdr sufs
)))
2731 (setq name
(substring name
0 (match-beginning 0))))
2733 (not (string-match (car temp
) name
)))
2734 (setq temp
(cdr temp
)))
2737 (search-forward "-*-" (line-end-position
2738 ;; If the file begins with "#!"
2739 ;; (exec interpreter magic), look
2740 ;; for mode frobs in the first two
2741 ;; lines. You cannot necessarily
2742 ;; put them in the first line of
2743 ;; such a file without screwing up
2744 ;; the interpreter invocation.
2745 ;; The same holds for
2747 ;; in man pages (preprocessor
2748 ;; magic for the `man' program).
2749 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t
)
2751 (skip-chars-forward " \t")
2753 (search-forward "-*-" (line-end-position) t
))
2756 (skip-chars-backward " \t")
2761 ;;; Handling file local variables
2763 (defvar ignored-local-variables
2764 '(ignored-local-variables safe-local-variable-values
2765 file-local-variables-alist dir-local-variables-alist
)
2766 "Variables to be ignored in a file's local variable spec.")
2767 (put 'ignored-local-variables
'risky-local-variable t
)
2769 (defvar hack-local-variables-hook nil
2770 "Normal hook run after processing a file's local variables specs.
2771 Major modes can use this to examine user-specified local variables
2772 in order to initialize other data structure based on them.")
2774 (defcustom safe-local-variable-values nil
2775 "List variable-value pairs that are considered safe.
2776 Each element is a cons cell (VAR . VAL), where VAR is a variable
2777 symbol and VAL is a value that is considered safe."
2782 (defcustom safe-local-eval-forms
2783 ;; This should be here at least as long as Emacs supports write-file-hooks.
2784 '((add-hook 'write-file-hooks
'time-stamp
)
2785 (add-hook 'write-file-functions
'time-stamp
)
2786 (add-hook 'before-save-hook
'time-stamp
))
2787 "Expressions that are considered safe in an `eval:' local variable.
2788 Add expressions to this list if you want Emacs to evaluate them, when
2789 they appear in an `eval' local variable specification, without first
2790 asking you for confirmation."
2793 :version
"24.1" ; added write-file-hooks
2794 :type
'(repeat sexp
))
2796 ;; Risky local variables:
2797 (mapc (lambda (var) (put var
'risky-local-variable t
))
2799 buffer-auto-save-file-name
2801 buffer-file-truename
2804 default-text-properties
2808 file-name-handler-alist
2817 minor-mode-map-alist
2818 minor-mode-overriding-map-alist
2821 overriding-local-map
2822 overriding-terminal-local-map
2826 unread-command-events
))
2828 ;; Safe local variables:
2830 ;; For variables defined by major modes, the safety declarations can go into
2831 ;; the major mode's file, since that will be loaded before file variables are
2834 ;; For variables defined by minor modes, put the safety declarations in the
2835 ;; file defining the minor mode after the defcustom/defvar using an autoload
2838 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2840 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2841 ;; minor mode file may not be loaded yet.
2843 ;; For variables defined in the C source code the declaration should go here:
2846 '((buffer-read-only . booleanp
) ;; C source code
2847 (default-directory . stringp
) ;; C source code
2848 (fill-column . integerp
) ;; C source code
2849 (indent-tabs-mode . booleanp
) ;; C source code
2850 (left-margin . integerp
) ;; C source code
2851 (no-update-autoloads . booleanp
)
2852 (lexical-binding . booleanp
) ;; C source code
2853 (tab-width . integerp
) ;; C source code
2854 (truncate-lines . booleanp
) ;; C source code
2855 (word-wrap . booleanp
) ;; C source code
2856 (bidi-display-reordering . booleanp
))) ;; C source code
2857 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2859 (put 'bidi-paragraph-direction
'safe-local-variable
2860 (lambda (v) (memq v
'(nil right-to-left left-to-right
))))
2862 (put 'c-set-style
'safe-local-eval-function t
)
2864 (defvar file-local-variables-alist nil
2865 "Alist of file-local variable settings in the current buffer.
2866 Each element in this list has the form (VAR . VALUE), where VAR
2867 is a file-local variable (a symbol) and VALUE is the value
2868 specified. The actual value in the buffer may differ from VALUE,
2869 if it is changed by the major or minor modes, or by the user.")
2870 (make-variable-buffer-local 'file-local-variables-alist
)
2871 (put 'file-local-variables-alist
'permanent-local t
)
2873 (defvar dir-local-variables-alist nil
2874 "Alist of directory-local variable settings in the current buffer.
2875 Each element in this list has the form (VAR . VALUE), where VAR
2876 is a directory-local variable (a symbol) and VALUE is the value
2877 specified in .dir-locals.el. The actual value in the buffer
2878 may differ from VALUE, if it is changed by the major or minor modes,
2880 (make-variable-buffer-local 'dir-local-variables-alist
)
2882 (defvar before-hack-local-variables-hook nil
2883 "Normal hook run before setting file-local variables.
2884 It is called after checking for unsafe/risky variables and
2885 setting `file-local-variables-alist', and before applying the
2886 variables stored in `file-local-variables-alist'. A hook
2887 function is allowed to change the contents of this alist.
2889 This hook is called only if there is at least one file-local
2892 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars dir-name
)
2893 "Get confirmation before setting up local variable values.
2894 ALL-VARS is the list of all variables to be set up.
2895 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2896 RISKY-VARS is the list of those that are marked as risky.
2897 If these settings come from directory-local variables, then
2898 DIR-NAME is the name of the associated directory. Otherwise it is nil."
2901 (save-window-excursion
2902 (let* ((name (or dir-name
2903 (if buffer-file-name
2904 (file-name-nondirectory buffer-file-name
)
2905 (concat "buffer " (buffer-name)))))
2906 (offer-save (and (eq enable-local-variables t
)
2909 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2910 (buf (pop-to-buffer "*Local Variables*"))
2912 (set (make-local-variable 'cursor-type
) nil
)
2916 (insert "The local variables list in " name
2917 "\ncontains values that may not be safe (*)"
2919 ", and variables that are risky (**)."
2922 (insert "The local variables list in " name
2923 "\ncontains variables that are risky (**)."))
2925 (insert "A local variables list is specified in " name
".")))
2926 (insert "\n\nDo you want to apply it? You can type
2927 y -- to apply the local variables list.
2928 n -- to ignore the local variables list.")
2931 ! -- to apply the local variables list, and permanently mark these
2932 values (*) as safe (in the future, they will be set automatically.)\n\n")
2934 (dolist (elt all-vars
)
2935 (cond ((member elt unsafe-vars
)
2937 ((member elt risky-vars
)
2941 (princ (car elt
) buf
)
2943 ;; Make strings with embedded whitespace easier to read.
2944 (let ((print-escape-newlines t
))
2945 (prin1 (cdr elt
) buf
))
2948 (format "Please type %s%s: "
2949 (if offer-save
"y, n, or !" "y or n")
2950 (if (< (line-number-at-pos) (window-body-height))
2952 (push ?\C-v exit-chars
)
2953 ", or C-v to scroll")))
2954 (goto-char (point-min))
2956 (setq char
(read-char-choice prompt exit-chars t
))
2957 (when (eq char ?\C-v
)
2960 (error (goto-char (point-min))))
2963 (when (and offer-save
(= char ?
!) unsafe-vars
)
2964 (customize-push-and-save 'safe-local-variable-values unsafe-vars
))
2965 (memq char
'(?
! ?\s ?y
))))))
2967 (defun hack-local-variables-prop-line (&optional mode-only
)
2968 "Return local variables specified in the -*- line.
2969 Returns an alist of elements (VAR . VAL), where VAR is a variable
2970 and VAL is the specified value. Ignores any specification for
2971 `mode:' and `coding:' (which should have already been handled
2972 by `set-auto-mode' and `set-auto-coding', respectively).
2973 Return nil if the -*- line is malformed.
2975 If MODE-ONLY is non-nil, just returns the symbol specifying the
2976 mode, if there is one, otherwise nil."
2977 (catch 'malformed-line
2979 (goto-char (point-min))
2980 (let ((end (set-auto-mode-1))
2984 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2985 ;; Simple form: "-*- MODENAME -*-".
2987 (intern (concat (match-string 1) "-mode"))))
2989 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2990 ;; (last ";" is optional).
2991 ;; If MODE-ONLY, just check for `mode'.
2992 ;; Otherwise, parse the -*- line into the RESULT alist.
2993 (while (and (or (not mode-only
)
2996 (unless (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2997 (message "Malformed mode-line")
2998 (throw 'malformed-line nil
))
2999 (goto-char (match-end 0))
3000 ;; There used to be a downcase here,
3001 ;; but the manual didn't say so,
3002 ;; and people want to set var names that aren't all lc.
3003 (let* ((key (intern (match-string 1)))
3004 (val (save-restriction
3005 (narrow-to-region (point) end
)
3006 (let ((read-circle nil
))
3007 (read (current-buffer)))))
3008 ;; It is traditional to ignore
3009 ;; case when checking for `mode' in set-auto-mode,
3010 ;; so we must do that here as well.
3011 ;; That is inconsistent, but we're stuck with it.
3012 ;; The same can be said for `coding' in set-auto-coding.
3013 (keyname (downcase (symbol-name key
))))
3015 (and (equal keyname
"mode")
3017 (intern (concat (downcase (symbol-name val
))
3019 (or (equal keyname
"coding")
3021 (push (cons (cond ((eq key
'eval
) 'eval
)
3022 ;; Downcase "Mode:".
3023 ((equal keyname
"mode") 'mode
)
3024 (t (indirect-variable key
)))
3027 (skip-chars-forward " \t;")))
3030 (defun hack-local-variables-filter (variables dir-name
)
3031 "Filter local variable settings, querying the user if necessary.
3032 VARIABLES is the alist of variable-value settings. This alist is
3033 filtered based on the values of `ignored-local-variables',
3034 `enable-local-eval', `enable-local-variables', and (if necessary)
3035 user interaction. The results are added to
3036 `file-local-variables-alist', without applying them.
3037 If these settings come from directory-local variables, then
3038 DIR-NAME is the name of the associated directory. Otherwise it is nil."
3039 ;; Find those variables that we may want to save to
3040 ;; `safe-local-variable-values'.
3041 (let (all-vars risky-vars unsafe-vars
)
3042 (dolist (elt variables
)
3043 (let ((var (car elt
))
3045 (cond ((memq var ignored-local-variables
)
3046 ;; Ignore any variable in `ignored-local-variables'.
3048 ;; Obey `enable-local-eval'.
3050 (when enable-local-eval
3052 (or (eq enable-local-eval t
)
3053 (hack-one-local-variable-eval-safep (eval (quote val
)))
3054 (safe-local-variable-p var val
)
3055 (push elt unsafe-vars
))))
3056 ;; Ignore duplicates (except `mode') in the present list.
3057 ((and (assq var all-vars
) (not (eq var
'mode
))) nil
)
3058 ;; Accept known-safe variables.
3059 ((or (memq var
'(mode unibyte coding
))
3060 (safe-local-variable-p var val
))
3061 (push elt all-vars
))
3062 ;; The variable is either risky or unsafe:
3063 ((not (eq enable-local-variables
:safe
))
3065 (if (risky-local-variable-p var val
)
3066 (push elt risky-vars
)
3067 (push elt unsafe-vars
))))))
3069 ;; Query, unless all vars are safe or user wants no querying.
3070 (or (and (eq enable-local-variables t
)
3073 (memq enable-local-variables
'(:all
:safe
))
3074 (hack-local-variables-confirm all-vars unsafe-vars
3075 risky-vars dir-name
))
3076 (dolist (elt all-vars
)
3077 (unless (memq (car elt
) '(eval mode
))
3079 (setq dir-local-variables-alist
3080 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3081 (setq file-local-variables-alist
3082 (assq-delete-all (car elt
) file-local-variables-alist
)))
3083 (push elt file-local-variables-alist
)))))
3085 (defun hack-local-variables (&optional mode-only
)
3086 "Parse and put into effect this buffer's local variables spec.
3087 Uses `hack-local-variables-apply' to apply the variables.
3089 If MODE-ONLY is non-nil, all we do is check whether a \"mode:\"
3090 is specified, and return the corresponding mode symbol, or nil.
3091 In this case, we try to ignore minor-modes, and only return a
3093 (let ((enable-local-variables
3094 (and local-enable-local-variables enable-local-variables
))
3097 (setq file-local-variables-alist nil
)
3098 (report-errors "Directory-local variables error: %s"
3099 (hack-dir-local-variables)))
3100 (when (or mode-only enable-local-variables
)
3101 ;; If MODE-ONLY is non-nil, and the prop line specifies a mode,
3102 ;; then we're done, and have no need to scan further.
3103 (unless (and (setq result
(hack-local-variables-prop-line mode-only
))
3105 ;; Look for "Local variables:" line in last page.
3107 (goto-char (point-max))
3108 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
3110 (when (let ((case-fold-search t
))
3111 (search-forward "Local Variables:" nil t
))
3112 (skip-chars-forward " \t")
3113 ;; suffix is what comes after "local variables:" in its line.
3114 ;; prefix is what comes before "local variables:" in its line.
3117 (regexp-quote (buffer-substring (point)
3118 (line-end-position)))
3121 (concat "^" (regexp-quote
3122 (buffer-substring (line-beginning-position)
3123 (match-beginning 0)))))
3127 (let ((startpos (point))
3129 (thisbuf (current-buffer)))
3131 (unless (let ((case-fold-search t
))
3133 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
3135 ;; This used to be an error, but really all it means is
3136 ;; that this may simply not be a local-variables section,
3137 ;; so just ignore it.
3138 (message "Local variables list is not properly terminated"))
3140 (setq endpos
(point)))
3143 (insert-buffer-substring thisbuf startpos endpos
)
3144 (goto-char (point-min))
3145 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
3147 ;; Discard the prefix.
3148 (if (looking-at prefix
)
3149 (delete-region (point) (match-end 0))
3150 (error "Local variables entry is missing the prefix"))
3152 ;; Discard the suffix.
3153 (if (looking-back suffix
)
3154 (delete-region (match-beginning 0) (point))
3155 (error "Local variables entry is missing the suffix"))
3157 (goto-char (point-min))
3159 (while (and (not (eobp))
3162 ;; Find the variable name; strip whitespace.
3163 (skip-chars-forward " \t")
3165 (skip-chars-forward "^:\n")
3166 (if (eolp) (error "Missing colon in local variables entry"))
3167 (skip-chars-backward " \t")
3168 (let* ((str (buffer-substring beg
(point)))
3169 (var (let ((read-circle nil
))
3172 (and (equal (downcase (symbol-name var
)) "mode")
3174 ;; Read the variable value.
3175 (skip-chars-forward "^:")
3177 (let ((read-circle nil
))
3178 (setq val
(read (current-buffer))))
3181 ;; Specifying minor-modes via mode: is
3182 ;; deprecated, but try to reject them anyway.
3185 (setq val2
(downcase (symbol-name val
)))))
3186 (setq result
(intern (concat val2
"-mode"))))
3187 (unless (eq var
'coding
)
3189 (push (cons (if (eq var
'eval
)
3191 (indirect-variable var
))
3194 (forward-line 1)))))))))
3195 ;; Now we've read all the local variables.
3196 ;; If MODE-ONLY is non-nil, return whether the mode was specified.
3197 (cond (mode-only result
)
3198 ;; Otherwise, set the variables.
3199 (enable-local-variables
3200 (hack-local-variables-filter result nil
)
3201 (hack-local-variables-apply)))))
3203 (defun hack-local-variables-apply ()
3204 "Apply the elements of `file-local-variables-alist'.
3205 If there are any elements, runs `before-hack-local-variables-hook',
3206 then calls `hack-one-local-variable' to apply the alist elements one by one.
3207 Finishes by running `hack-local-variables-hook', regardless of whether
3208 the alist is empty or not.
3210 Note that this function ignores a `mode' entry if it specifies the same
3211 major mode as the buffer already has."
3212 (when file-local-variables-alist
3213 ;; Any 'evals must run in the Right sequence.
3214 (setq file-local-variables-alist
3215 (nreverse file-local-variables-alist
))
3216 (run-hooks 'before-hack-local-variables-hook
)
3217 (dolist (elt file-local-variables-alist
)
3218 (hack-one-local-variable (car elt
) (cdr elt
))))
3219 (run-hooks 'hack-local-variables-hook
))
3221 (defun safe-local-variable-p (sym val
)
3222 "Non-nil if SYM is safe as a file-local variable with value VAL.
3223 It is safe if any of these conditions are met:
3225 * There is a matching entry (SYM . VAL) in the
3226 `safe-local-variable-values' user option.
3228 * The `safe-local-variable' property of SYM is a function that
3229 evaluates to a non-nil value with VAL as an argument."
3230 (or (member (cons sym val
) safe-local-variable-values
)
3231 (let ((safep (get sym
'safe-local-variable
)))
3232 (and (functionp safep
)
3233 ;; If the function signals an error, that means it
3234 ;; can't assure us that the value is safe.
3235 (with-demoted-errors (funcall safep val
))))))
3237 (defun risky-local-variable-p (sym &optional _ignored
)
3238 "Non-nil if SYM could be dangerous as a file-local variable.
3239 It is dangerous if either of these conditions are met:
3241 * Its `risky-local-variable' property is non-nil.
3243 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
3244 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
3245 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
3246 \"map-alist\", or \"bindat-spec\"."
3247 ;; If this is an alias, check the base name.
3249 (setq sym
(indirect-variable sym
))
3251 (or (get sym
'risky-local-variable
)
3252 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
3253 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
3254 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
3255 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
3257 (defun hack-one-local-variable-quotep (exp)
3258 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
3260 (defun hack-one-local-variable-constantp (exp)
3261 (or (and (not (symbolp exp
)) (not (consp exp
)))
3264 (hack-one-local-variable-quotep exp
)))
3266 (defun hack-one-local-variable-eval-safep (exp)
3267 "Return t if it is safe to eval EXP when it is found in a file."
3268 (or (not (consp exp
))
3269 ;; Detect certain `put' expressions.
3270 (and (eq (car exp
) 'put
)
3271 (hack-one-local-variable-quotep (nth 1 exp
))
3272 (hack-one-local-variable-quotep (nth 2 exp
))
3273 (let ((prop (nth 1 (nth 2 exp
)))
3275 (cond ((memq prop
'(lisp-indent-hook
3276 lisp-indent-function
3277 scheme-indent-function
))
3278 ;; Only allow safe values (not functions).
3280 (and (hack-one-local-variable-quotep val
)
3281 (eq (nth 1 val
) 'defun
))))
3282 ((eq prop
'edebug-form-spec
)
3283 ;; Only allow indirect form specs.
3284 ;; During bootstrapping, edebug-basic-spec might not be
3286 (and (fboundp 'edebug-basic-spec
)
3287 (hack-one-local-variable-quotep val
)
3288 (edebug-basic-spec (nth 1 val
)))))))
3289 ;; Allow expressions that the user requested.
3290 (member exp safe-local-eval-forms
)
3291 ;; Certain functions can be allowed with safe arguments
3292 ;; or can specify verification functions to try.
3293 (and (symbolp (car exp
))
3294 ;; Allow (minor)-modes calls with no arguments.
3295 ;; This obsoletes the use of "mode:" for such things. (Bug#8613)
3296 (or (and (member (cdr exp
) '(nil (1) (0) (-1)))
3297 (string-match "-mode\\'" (symbol-name (car exp
))))
3298 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
3301 (dolist (arg (cdr exp
))
3302 (unless (hack-one-local-variable-constantp arg
)
3309 (dolist (function prop
)
3310 (if (funcall function exp
)
3314 (defun hack-one-local-variable (var val
)
3315 "Set local variable VAR with value VAL.
3316 If VAR is `mode', call `VAL-mode' as a function unless it's
3317 already the major mode."
3318 (cond ((eq var
'mode
)
3319 (let ((mode (intern (concat (downcase (symbol-name val
))
3321 (unless (eq (indirect-function mode
)
3322 (indirect-function major-mode
))
3323 (if (memq mode minor-mode-list
)
3324 ;; A minor mode must be passed an argument.
3325 ;; Otherwise, if the user enables the minor mode in a
3326 ;; major mode hook, this would toggle it off.
3330 (save-excursion (eval val
)))
3332 ;; Make sure the string has no text properties.
3333 ;; Some text properties can get evaluated in various ways,
3334 ;; so it is risky to put them on with a local variable list.
3336 (set-text-properties 0 (length val
) nil val
))
3337 (set (make-local-variable var
) val
))))
3339 ;;; Handling directory-local variables, aka project settings.
3341 (defvar dir-locals-class-alist
'()
3342 "Alist mapping directory-local variable classes (symbols) to variable lists.")
3344 (defvar dir-locals-directory-cache
'()
3345 "List of cached directory roots for directory-local variable classes.
3346 Each element in this list has the form (DIR CLASS MTIME).
3347 DIR is the name of the directory.
3348 CLASS is the name of a variable class (a symbol).
3349 MTIME is the recorded modification time of the directory-local
3350 variables file associated with this entry. This time is a list
3351 of two integers (the same format as `file-attributes'), and is
3352 used to test whether the cache entry is still valid.
3353 Alternatively, MTIME can be nil, which means the entry is always
3356 (defsubst dir-locals-get-class-variables
(class)
3357 "Return the variable list for CLASS."
3358 (cdr (assq class dir-locals-class-alist
)))
3360 (defun dir-locals-collect-mode-variables (mode-variables variables
)
3361 "Collect directory-local variables from MODE-VARIABLES.
3362 VARIABLES is the initial list of variables.
3363 Returns the new list."
3364 (dolist (pair mode-variables variables
)
3365 (let* ((variable (car pair
))
3367 (slot (assq variable variables
)))
3368 ;; If variables are specified more than once, only use the last. (Why?)
3369 ;; The pseudo-variables mode and eval are different (bug#3430).
3370 (if (and slot
(not (memq variable
'(mode eval
))))
3372 ;; Need a new cons in case we setcdr later.
3373 (push (cons variable value
) variables
)))))
3375 (defun dir-locals-collect-variables (class-variables root variables
)
3376 "Collect entries from CLASS-VARIABLES into VARIABLES.
3377 ROOT is the root directory of the project.
3378 Return the new variables list."
3379 (let* ((file-name (buffer-file-name))
3380 (sub-file-name (if file-name
3381 ;; FIXME: Why not use file-relative-name?
3382 (substring file-name
(length root
)))))
3384 (dolist (entry class-variables variables
)
3385 (let ((key (car entry
)))
3388 ;; Don't include this in the previous condition, because we
3389 ;; want to filter all strings before the next condition.
3390 (when (and sub-file-name
3391 (>= (length sub-file-name
) (length key
))
3392 (string-prefix-p key sub-file-name
))
3393 (setq variables
(dir-locals-collect-variables
3394 (cdr entry
) root variables
))))
3396 (derived-mode-p key
))
3397 (let* ((alist (cdr entry
))
3398 (subdirs (assq 'subdirs alist
)))
3399 (if (or (not subdirs
)
3401 (setq alist
(delq subdirs alist
))
3403 ;; TODO someone might want to extend this to allow
3404 ;; integer values for subdir, where N means
3405 ;; variables apply to this directory and N levels
3406 ;; below it (0 == nil).
3407 (equal root default-directory
))
3408 (setq variables
(dir-locals-collect-mode-variables
3409 alist variables
))))))))
3411 ;; The file's content might be invalid (e.g. have a merge conflict), but
3412 ;; that shouldn't prevent the user from opening the file.
3413 (message ".dir-locals error: %s" (error-message-string err
))
3416 (defun dir-locals-set-directory-class (directory class
&optional mtime
)
3417 "Declare that the DIRECTORY root is an instance of CLASS.
3418 DIRECTORY is the name of a directory, a string.
3419 CLASS is the name of a project class, a symbol.
3420 MTIME is either the modification time of the directory-local
3421 variables file that defined this class, or nil.
3423 When a file beneath DIRECTORY is visited, the mode-specific
3424 variables from CLASS are applied to the buffer. The variables
3425 for a class are defined using `dir-locals-set-class-variables'."
3426 (setq directory
(file-name-as-directory (expand-file-name directory
)))
3427 (unless (assq class dir-locals-class-alist
)
3428 (error "No such class `%s'" (symbol-name class
)))
3429 (push (list directory class mtime
) dir-locals-directory-cache
))
3431 (defun dir-locals-set-class-variables (class variables
)
3432 "Map the type CLASS to a list of variable settings.
3433 CLASS is the project class, a symbol. VARIABLES is a list
3434 that declares directory-local variables for the class.
3435 An element in VARIABLES is either of the form:
3436 (MAJOR-MODE . ALIST)
3440 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3441 whose elements are of the form (VARIABLE . VALUE).
3443 In the second form, DIRECTORY is a directory name (a string), and
3444 LIST is a list of the form accepted by the function.
3446 When a file is visited, the file's class is found. A directory
3447 may be assigned a class using `dir-locals-set-directory-class'.
3448 Then variables are set in the file's buffer according to the
3449 class' LIST. The list is processed in order.
3451 * If the element is of the form (MAJOR-MODE . ALIST), and the
3452 buffer's major mode is derived from MAJOR-MODE (as determined
3453 by `derived-mode-p'), then all the variables in ALIST are
3454 applied. A MAJOR-MODE of nil may be used to match any buffer.
3455 `make-local-variable' is called for each variable before it is
3458 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3459 is an initial substring of the file's directory, then LIST is
3460 applied by recursively following these rules."
3461 (let ((elt (assq class dir-locals-class-alist
)))
3463 (setcdr elt variables
)
3464 (push (cons class variables
) dir-locals-class-alist
))))
3466 (defconst dir-locals-file
".dir-locals.el"
3467 "File that contains directory-local variables.
3468 It has to be constant to enforce uniform values
3469 across different environments and users.")
3471 (defun dir-locals-find-file (file)
3472 "Find the directory-local variables for FILE.
3473 This searches upward in the directory tree from FILE.
3474 It stops at the first directory that has been registered in
3475 `dir-locals-directory-cache' or contains a `dir-locals-file'.
3476 If it finds an entry in the cache, it checks that it is valid.
3477 A cache entry with no modification time element (normally, one that
3478 has been assigned directly using `dir-locals-set-directory-class', not
3479 set from a file) is always valid.
3480 A cache entry based on a `dir-locals-file' is valid if the modification
3481 time stored in the cache matches the current file modification time.
3482 If not, the cache entry is cleared so that the file will be re-read.
3484 This function returns either nil (no directory local variables found),
3485 or the matching entry from `dir-locals-directory-cache' (a list),
3486 or the full path to the `dir-locals-file' (a string) in the case
3487 of no valid cache entry."
3488 (setq file
(expand-file-name file
))
3489 (let* ((dir-locals-file-name
3490 (if (eq system-type
'ms-dos
)
3491 (dosified-file-name dir-locals-file
)
3493 (locals-file (locate-dominating-file file dir-locals-file-name
))
3495 ;; `locate-dominating-file' may have abbreviated the name.
3497 (setq locals-file
(expand-file-name dir-locals-file-name locals-file
)))
3498 ;; Find the best cached value in `dir-locals-directory-cache'.
3499 (dolist (elt dir-locals-directory-cache
)
3500 (when (and (eq t
(compare-strings file nil
(length (car elt
))
3503 '(windows-nt cygwin ms-dos
))))
3504 (> (length (car elt
)) (length (car dir-elt
))))
3505 (setq dir-elt elt
)))
3507 (or (null locals-file
)
3508 (<= (length (file-name-directory locals-file
))
3509 (length (car dir-elt
)))))
3510 ;; Found a potential cache entry. Check validity.
3511 ;; A cache entry with no MTIME is assumed to always be valid
3512 ;; (ie, set directly, not from a dir-locals file).
3513 ;; Note, we don't bother to check that there is a matching class
3514 ;; element in dir-locals-class-alist, since that's done by
3515 ;; dir-locals-set-directory-class.
3516 (if (or (null (nth 2 dir-elt
))
3517 (let ((cached-file (expand-file-name dir-locals-file-name
3519 (and (file-readable-p cached-file
)
3520 (equal (nth 2 dir-elt
)
3521 (nth 5 (file-attributes cached-file
))))))
3522 ;; This cache entry is OK.
3524 ;; This cache entry is invalid; clear it.
3525 (setq dir-locals-directory-cache
3526 (delq dir-elt dir-locals-directory-cache
))
3527 ;; Return the first existing dir-locals file. Might be the same
3528 ;; as dir-elt's, might not (eg latter might have been deleted).
3533 (defun dir-locals-read-from-file (file)
3534 "Load a variables FILE and register a new class and instance.
3535 FILE is the name of the file holding the variables to apply.
3536 The new class name is the same as the directory in which FILE
3537 is found. Returns the new class name."
3539 (insert-file-contents file
)
3540 (let* ((dir-name (file-name-directory file
))
3541 (class-name (intern dir-name
))
3542 (variables (let ((read-circle nil
))
3543 (read (current-buffer)))))
3544 (dir-locals-set-class-variables class-name variables
)
3545 (dir-locals-set-directory-class dir-name class-name
3546 (nth 5 (file-attributes file
)))
3549 (defun hack-dir-local-variables ()
3550 "Read per-directory local variables for the current buffer.
3551 Store the directory-local variables in `dir-local-variables-alist'
3552 and `file-local-variables-alist', without applying them."
3553 (when (and enable-local-variables
3554 (not (file-remote-p (or (buffer-file-name) default-directory
))))
3555 ;; Find the variables file.
3556 (let ((variables-file (dir-locals-find-file (or (buffer-file-name) default-directory
)))
3560 ((stringp variables-file
)
3561 (setq dir-name
(file-name-directory variables-file
)
3562 class
(dir-locals-read-from-file variables-file
)))
3563 ((consp variables-file
)
3564 (setq dir-name
(nth 0 variables-file
))
3565 (setq class
(nth 1 variables-file
))))
3568 (dir-locals-collect-variables
3569 (dir-locals-get-class-variables class
) dir-name nil
)))
3571 (dolist (elt variables
)
3572 (unless (memq (car elt
) '(eval mode
))
3573 (setq dir-local-variables-alist
3574 (assq-delete-all (car elt
) dir-local-variables-alist
)))
3575 (push elt dir-local-variables-alist
))
3576 (hack-local-variables-filter variables dir-name
)))))))
3578 (defun hack-dir-local-variables-non-file-buffer ()
3579 "Apply directory-local variables to a non-file buffer.
3580 For non-file buffers, such as Dired buffers, directory-local
3581 variables are looked for in `default-directory' and its parent
3583 (hack-dir-local-variables)
3584 (hack-local-variables-apply))
3587 (defcustom change-major-mode-with-file-name t
3588 "Non-nil means \\[write-file] should set the major mode from the file name.
3589 However, the mode will not be changed if
3590 \(1) a local variables list or the `-*-' line specifies a major mode, or
3591 \(2) the current major mode is a \"special\" mode,
3592 \ not suitable for ordinary files, or
3593 \(3) the new file name does not particularly specify any mode."
3595 :group
'editing-basics
)
3597 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3598 "Change name of file visited in current buffer to FILENAME.
3599 This also renames the buffer to correspond to the new file.
3600 The next time the buffer is saved it will go in the newly specified file.
3601 FILENAME nil or an empty string means mark buffer as not visiting any file.
3602 Remember to delete the initial contents of the minibuffer
3603 if you wish to pass an empty string as the argument.
3605 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3606 confirmation in the case where another buffer is already visiting FILENAME.
3608 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3609 the old visited file has been renamed to the new name FILENAME."
3610 (interactive "FSet visited file name: ")
3611 (if (buffer-base-buffer)
3612 (error "An indirect buffer cannot visit a file"))
3616 (if (string-equal filename
"")
3618 (expand-file-name filename
))))
3621 (setq truename
(file-truename filename
))
3622 (if find-file-visit-truename
3623 (setq filename truename
))))
3625 (let ((new-name (file-name-nondirectory filename
)))
3626 (if (string= new-name
"")
3627 (error "Empty file name"))))
3628 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3629 (and buffer
(not (eq buffer
(current-buffer)))
3631 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3634 (or (equal filename buffer-file-name
)
3636 (and filename
(lock-buffer filename
))
3638 (setq buffer-file-name filename
)
3639 (if filename
; make buffer name reflect filename.
3640 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3641 (setq default-directory
(file-name-directory buffer-file-name
))
3642 ;; If new-name == old-name, renaming would add a spurious <2>
3643 ;; and it's considered as a feature in rename-buffer.
3644 (or (string= new-name
(buffer-name))
3645 (rename-buffer new-name t
))))
3646 (setq buffer-backed-up nil
)
3648 (clear-visited-file-modtime))
3649 ;; Abbreviate the file names of the buffer.
3652 (setq buffer-file-truename
(abbreviate-file-name truename
))
3653 (if find-file-visit-truename
3654 (setq buffer-file-name truename
))))
3655 (setq buffer-file-number
3657 (nthcdr 10 (file-attributes buffer-file-name
))
3659 ;; write-file-functions is normally used for things like ftp-find-file
3660 ;; that visit things that are not local files as if they were files.
3661 ;; Changing to visit an ordinary local file instead should flush the hook.
3662 (kill-local-variable 'write-file-functions
)
3663 (kill-local-variable 'local-write-file-hooks
)
3664 (kill-local-variable 'revert-buffer-function
)
3665 (kill-local-variable 'backup-inhibited
)
3666 ;; If buffer was read-only because of version control,
3667 ;; that reason is gone now, so make it writable.
3669 (setq buffer-read-only nil
))
3670 (kill-local-variable 'vc-mode
)
3671 ;; Turn off backup files for certain file names.
3672 ;; Since this is a permanent local, the major mode won't eliminate it.
3673 (and buffer-file-name
3674 backup-enable-predicate
3675 (not (funcall backup-enable-predicate buffer-file-name
))
3677 (make-local-variable 'backup-inhibited
)
3678 (setq backup-inhibited t
)))
3679 (let ((oauto buffer-auto-save-file-name
))
3680 ;; If auto-save was not already on, turn it on if appropriate.
3681 (if (not buffer-auto-save-file-name
)
3682 (and buffer-file-name auto-save-default
3684 ;; If auto save is on, start using a new name.
3685 ;; We deliberately don't rename or delete the old auto save
3686 ;; for the old visited file name. This is because perhaps
3687 ;; the user wants to save the new state and then compare with the
3688 ;; previous state from the auto save file.
3689 (setq buffer-auto-save-file-name
3690 (make-auto-save-file-name)))
3691 ;; Rename the old auto save file if any.
3692 (and oauto buffer-auto-save-file-name
3693 (file-exists-p oauto
)
3694 (rename-file oauto buffer-auto-save-file-name t
)))
3695 (and buffer-file-name
3696 (not along-with-file
)
3697 (set-buffer-modified-p t
))
3698 ;; Update the major mode, if the file name determines it.
3700 ;; Don't change the mode if it is special.
3701 (or (not change-major-mode-with-file-name
)
3702 (get major-mode
'mode-class
)
3703 ;; Don't change the mode if the local variable list specifies it.
3704 (hack-local-variables t
)
3705 ;; TODO consider making normal-mode handle this case.
3706 (let ((old major-mode
))
3708 (or (eq old major-mode
)
3709 (hack-local-variables))))
3712 (defun write-file (filename &optional confirm
)
3713 "Write current buffer into file FILENAME.
3714 This makes the buffer visit that file, and marks it as not modified.
3716 If you specify just a directory name as FILENAME, that means to use
3717 the default file name but in that directory. You can also yank
3718 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3720 If the buffer is not already visiting a file, the default file name
3721 for the output file is the buffer name.
3723 If optional second arg CONFIRM is non-nil, this function
3724 asks for confirmation before overwriting an existing file.
3725 Interactively, confirmation is required unless you supply a prefix argument."
3726 ;; (interactive "FWrite file: ")
3728 (list (if buffer-file-name
3729 (read-file-name "Write file: "
3731 (read-file-name "Write file: " default-directory
3733 (file-name-nondirectory (buffer-name))
3736 (not current-prefix-arg
)))
3737 (or (null filename
) (string-equal filename
"")
3739 ;; If arg is just a directory,
3740 ;; use the default file name, but in that directory.
3741 (if (file-directory-p filename
)
3742 (setq filename
(concat (file-name-as-directory filename
)
3743 (file-name-nondirectory
3744 (or buffer-file-name
(buffer-name))))))
3746 (file-exists-p filename
)
3747 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3748 (error "Canceled")))
3749 (set-visited-file-name filename
(not confirm
))))
3750 (set-buffer-modified-p t
)
3751 ;; Make buffer writable if file is writable.
3752 (and buffer-file-name
3753 (file-writable-p buffer-file-name
)
3754 (setq buffer-read-only nil
))
3756 ;; It's likely that the VC status at the new location is different from
3757 ;; the one at the old location.
3758 (vc-find-file-hook))
3760 (defun backup-buffer ()
3761 "Make a backup of the disk file visited by the current buffer, if appropriate.
3762 This is normally done before saving the buffer the first time.
3764 A backup may be done by renaming or by copying; see documentation of
3765 variable `make-backup-files'. If it's done by renaming, then the file is
3766 no longer accessible under its old name.
3768 The value is non-nil after a backup was made by renaming.
3769 It has the form (MODES SELINUXCONTEXT BACKUPNAME).
3770 MODES is the result of `file-modes' on the original
3771 file; this means that the caller, after saving the buffer, should change
3772 the modes of the new file to agree with the old modes.
3773 SELINUXCONTEXT is the result of `file-selinux-context' on the original
3774 file; this means that the caller, after saving the buffer, should change
3775 the SELinux context of the new file to agree with the old context.
3776 BACKUPNAME is the backup file name, which is the old file renamed."
3777 (if (and make-backup-files
(not backup-inhibited
)
3778 (not buffer-backed-up
)
3779 (file-exists-p buffer-file-name
)
3780 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3782 (let ((real-file-name buffer-file-name
)
3783 backup-info backupname targets setmodes
)
3784 ;; If specified name is a symbolic link, chase it to the target.
3785 ;; Thus we make the backups in the directory where the real file is.
3786 (setq real-file-name
(file-chase-links real-file-name
))
3787 (setq backup-info
(find-backup-file-name real-file-name
)
3788 backupname
(car backup-info
)
3789 targets
(cdr backup-info
))
3790 ;; (if (file-directory-p buffer-file-name)
3791 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3794 (let ((delete-old-versions
3795 ;; If have old versions to maybe delete,
3796 ;; ask the user to confirm now, before doing anything.
3797 ;; But don't actually delete til later.
3799 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3800 (or delete-old-versions
3801 (y-or-n-p (format "Delete excess backup versions of %s? "
3803 (modes (file-modes buffer-file-name
))
3804 (context (file-selinux-context buffer-file-name
)))
3805 ;; Actually write the back up file.
3807 (if (or file-precious-flag
3808 ; (file-symlink-p buffer-file-name)
3810 ;; Don't rename a suid or sgid file.
3811 (and modes
(< 0 (logand modes
#o6000
)))
3812 (not (file-writable-p (file-name-directory real-file-name
)))
3813 (and backup-by-copying-when-linked
3814 (> (file-nlinks real-file-name
) 1))
3815 (and (or backup-by-copying-when-mismatch
3816 (integerp backup-by-copying-when-privileged-mismatch
))
3817 (let ((attr (file-attributes real-file-name
)))
3818 (and (or backup-by-copying-when-mismatch
3819 (and (integerp (nth 2 attr
))
3820 (integerp backup-by-copying-when-privileged-mismatch
)
3821 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3823 (not (file-ownership-preserved-p real-file-name
)))))))
3824 (backup-buffer-copy real-file-name backupname modes context
)
3825 ;; rename-file should delete old backup.
3826 (rename-file real-file-name backupname t
)
3827 (setq setmodes
(list modes context backupname
)))
3829 ;; If trouble writing the backup, write it in
3830 ;; .emacs.d/%backup%.
3831 (setq backupname
(locate-user-emacs-file "%backup%~"))
3832 (message "Cannot write backup file; backing up in %s"
3835 (backup-buffer-copy real-file-name backupname modes context
)))
3836 (setq buffer-backed-up t
)
3837 ;; Now delete the old versions, if desired.
3838 (if delete-old-versions
3841 (delete-file (car targets
))
3843 (setq targets
(cdr targets
))))
3845 (file-error nil
))))))
3847 (defun backup-buffer-copy (from-name to-name modes context
)
3848 (let ((umask (default-file-modes)))
3851 ;; Create temp files with strict access rights. It's easy to
3852 ;; loosen them later, whereas it's impossible to close the
3853 ;; time-window of loose permissions otherwise.
3854 (set-default-file-modes ?
\700)
3855 (when (condition-case nil
3856 ;; Try to overwrite old backup first.
3857 (copy-file from-name to-name t t t
)
3859 (while (condition-case nil
3861 (when (file-exists-p to-name
)
3862 (delete-file to-name
))
3863 (copy-file from-name to-name nil t t
)
3865 (file-already-exists t
))
3866 ;; The file was somehow created by someone else between
3867 ;; `delete-file' and `copy-file', so let's try again.
3868 ;; rms says "I think there is also a possible race
3869 ;; condition for making backup files" (emacs-devel 20070821).
3872 (set-default-file-modes umask
)))
3874 (set-file-modes to-name
(logand modes
#o1777
)))
3876 (set-file-selinux-context to-name context
)))
3878 (defvar file-name-version-regexp
3879 "\\(?:~\\|\\.~[-[:alnum:]:#@^._]+\\(?:~[[:digit:]]+\\)?~\\)"
3880 ;; The last ~[[:digit]]+ matches relative versions in git,
3881 ;; e.g. `foo.js.~HEAD~1~'.
3882 "Regular expression matching the backup/version part of a file name.
3883 Used by `file-name-sans-versions'.")
3885 (defun file-name-sans-versions (name &optional keep-backup-version
)
3886 "Return file NAME sans backup versions or strings.
3887 This is a separate procedure so your site-init or startup file can
3889 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3890 we do not remove backup version numbers, only true file version numbers.
3891 See also `file-name-version-regexp'."
3892 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
3894 (funcall handler
'file-name-sans-versions name keep-backup-version
)
3896 (unless keep-backup-version
3897 (string-match (concat file-name-version-regexp
"\\'")
3900 (defun file-ownership-preserved-p (file)
3901 "Return t if deleting FILE and rewriting it would preserve the owner."
3902 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
3904 (funcall handler
'file-ownership-preserved-p file
)
3905 (let ((attributes (file-attributes file
'integer
)))
3906 ;; Return t if the file doesn't exist, since it's true that no
3907 ;; information would be lost by an (attempted) delete and create.
3908 (or (null attributes
)
3909 (= (nth 2 attributes
) (user-uid))
3910 ;; Files created on Windows by Administrator (RID=500)
3911 ;; have the Administrators group (RID=544) recorded as
3912 ;; their owner. Rewriting them will still preserve the
3914 (and (eq system-type
'windows-nt
)
3915 (= (user-uid) 500) (= (nth 2 attributes
) 544)))))))
3917 (defun file-name-sans-extension (filename)
3918 "Return FILENAME sans final \"extension\".
3919 The extension, in a file name, is the part that follows the last `.',
3920 except that a leading `.', if any, doesn't count."
3922 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
3924 (if (and (string-match "\\.[^.]*\\'" file
)
3925 (not (eq 0 (match-beginning 0))))
3926 (if (setq directory
(file-name-directory filename
))
3927 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3928 ;; we don't want to expand it.
3929 (concat directory
(substring file
0 (match-beginning 0)))
3930 (substring file
0 (match-beginning 0)))
3933 (defun file-name-extension (filename &optional period
)
3934 "Return FILENAME's final \"extension\".
3935 The extension, in a file name, is the part that follows the last `.',
3936 excluding version numbers and backup suffixes,
3937 except that a leading `.', if any, doesn't count.
3938 Return nil for extensionless file names such as `foo'.
3939 Return the empty string for file names such as `foo.'.
3941 If PERIOD is non-nil, then the returned value includes the period
3942 that delimits the extension, and if FILENAME has no extension,
3945 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
3946 (if (and (string-match "\\.[^.]*\\'" file
)
3947 (not (eq 0 (match-beginning 0))))
3948 (substring file
(+ (match-beginning 0) (if period
0 1)))
3952 (defcustom make-backup-file-name-function nil
3953 "A function to use instead of the default `make-backup-file-name'.
3954 A value of nil gives the default `make-backup-file-name' behavior.
3956 This could be buffer-local to do something special for specific
3957 files. If you define it, you may need to change `backup-file-name-p'
3958 and `file-name-sans-versions' too.
3960 See also `backup-directory-alist'."
3962 :type
'(choice (const :tag
"Default" nil
)
3963 (function :tag
"Your function")))
3965 (defcustom backup-directory-alist nil
3966 "Alist of filename patterns and backup directory names.
3967 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3968 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3969 relative or absolute. If it is absolute, so that all matching files
3970 are backed up into the same directory, the file names in this
3971 directory will be the full name of the file backed up with all
3972 directory separators changed to `!' to prevent clashes. This will not
3973 work correctly if your filesystem truncates the resulting name.
3975 For the common case of all backups going into one directory, the alist
3976 should contain a single element pairing \".\" with the appropriate
3979 If this variable is nil, or it fails to match a filename, the backup
3980 is made in the original file's directory.
3982 On MS-DOS filesystems without long names this variable is always
3985 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
3986 (directory :tag
"Backup directory name"))))
3988 (defun normal-backup-enable-predicate (name)
3989 "Default `backup-enable-predicate' function.
3990 Checks for files in `temporary-file-directory',
3991 `small-temporary-file-directory', and /tmp."
3992 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
3994 ;; Directory is under temporary-file-directory.
3995 (and (not (eq comp t
))
3996 (< comp
(- (length temporary-file-directory
)))))
3997 (let ((comp (compare-strings "/tmp" 0 nil
3999 ;; Directory is under /tmp.
4000 (and (not (eq comp t
))
4001 (< comp
(- (length "/tmp")))))
4002 (if small-temporary-file-directory
4003 (let ((comp (compare-strings small-temporary-file-directory
4006 ;; Directory is under small-temporary-file-directory.
4007 (and (not (eq comp t
))
4008 (< comp
(- (length small-temporary-file-directory
)))))))))
4010 (defun make-backup-file-name (file)
4011 "Create the non-numeric backup file name for FILE.
4012 Normally this will just be the file's name with `~' appended.
4013 Customization hooks are provided as follows.
4015 If the variable `make-backup-file-name-function' is non-nil, its value
4016 should be a function which will be called with FILE as its argument;
4017 the resulting name is used.
4019 Otherwise a match for FILE is sought in `backup-directory-alist'; see
4020 the documentation of that variable. If the directory for the backup
4021 doesn't exist, it is created."
4022 (if make-backup-file-name-function
4023 (funcall make-backup-file-name-function file
)
4024 (if (and (eq system-type
'ms-dos
)
4025 (not (msdos-long-file-names)))
4026 (let ((fn (file-name-nondirectory file
)))
4027 (concat (file-name-directory file
)
4028 (or (and (string-match "\\`[^.]+\\'" fn
)
4029 (concat (match-string 0 fn
) ".~"))
4030 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
4031 (concat (match-string 0 fn
) "~")))))
4032 (concat (make-backup-file-name-1 file
) "~"))))
4034 (defun make-backup-file-name-1 (file)
4035 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
4036 (let ((alist backup-directory-alist
)
4037 elt backup-directory abs-backup-directory
)
4039 (setq elt
(pop alist
))
4040 (if (string-match (car elt
) file
)
4041 (setq backup-directory
(cdr elt
)
4043 ;; If backup-directory is relative, it should be relative to the
4044 ;; file's directory. By expanding explicitly here, we avoid
4045 ;; depending on default-directory.
4046 (if backup-directory
4047 (setq abs-backup-directory
4048 (expand-file-name backup-directory
4049 (file-name-directory file
))))
4050 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
4052 (make-directory abs-backup-directory
'parents
)
4053 (file-error (setq backup-directory nil
4054 abs-backup-directory nil
))))
4055 (if (null backup-directory
)
4057 (if (file-name-absolute-p backup-directory
)
4059 (when (memq system-type
'(windows-nt ms-dos cygwin
))
4060 ;; Normalize DOSish file names: downcase the drive
4061 ;; letter, if any, and replace the leading "x:" with
4063 (or (file-name-absolute-p file
)
4064 (setq file
(expand-file-name file
))) ; make defaults explicit
4065 ;; Replace any invalid file-name characters (for the
4066 ;; case of backing up remote files).
4067 (setq file
(expand-file-name (convert-standard-filename file
)))
4068 (if (eq (aref file
1) ?
:)
4069 (setq file
(concat "/"
4071 (char-to-string (downcase (aref file
0)))
4072 (if (eq (aref file
2) ?
/)
4075 (substring file
2)))))
4076 ;; Make the name unique by substituting directory
4077 ;; separators. It may not really be worth bothering about
4078 ;; doubling `!'s in the original name...
4080 (subst-char-in-string
4082 (replace-regexp-in-string "!" "!!" file
))
4084 (expand-file-name (file-name-nondirectory file
)
4085 (file-name-as-directory abs-backup-directory
))))))
4087 (defun backup-file-name-p (file)
4088 "Return non-nil if FILE is a backup file name (numeric or not).
4089 This is a separate function so you can redefine it for customization.
4090 You may need to redefine `file-name-sans-versions' as well."
4091 (string-match "~\\'" file
))
4093 (defvar backup-extract-version-start
)
4095 ;; This is used in various files.
4096 ;; The usage of backup-extract-version-start is not very clean,
4097 ;; but I can't see a good alternative, so as of now I am leaving it alone.
4098 (defun backup-extract-version (fn)
4099 "Given the name of a numeric backup file, FN, return the backup number.
4100 Uses the free variable `backup-extract-version-start', whose value should be
4101 the index in the name where the version number begins."
4102 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start
)
4103 (= (match-beginning 0) backup-extract-version-start
))
4104 (string-to-number (substring fn backup-extract-version-start -
1))
4107 (defun find-backup-file-name (fn)
4108 "Find a file name for a backup file FN, and suggestions for deletions.
4109 Value is a list whose car is the name for the backup file
4110 and whose cdr is a list of old versions to consider deleting now.
4111 If the value is nil, don't make a backup.
4112 Uses `backup-directory-alist' in the same way as does
4113 `make-backup-file-name'."
4114 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
4115 ;; Run a handler for this function so that ange-ftp can refuse to do it.
4117 (funcall handler
'find-backup-file-name fn
)
4118 (if (or (eq version-control
'never
)
4119 ;; We don't support numbered backups on plain MS-DOS
4120 ;; when long file names are unavailable.
4121 (and (eq system-type
'ms-dos
)
4122 (not (msdos-long-file-names))))
4123 (list (make-backup-file-name fn
))
4124 (let* ((basic-name (make-backup-file-name-1 fn
))
4125 (base-versions (concat (file-name-nondirectory basic-name
)
4127 (backup-extract-version-start (length base-versions
))
4129 (number-to-delete 0)
4130 possibilities deserve-versions-p versions
)
4132 (setq possibilities
(file-name-all-completions
4134 (file-name-directory basic-name
))
4135 versions
(sort (mapcar #'backup-extract-version
4138 high-water-mark
(apply 'max
0 versions
)
4139 deserve-versions-p
(or version-control
4140 (> high-water-mark
0))
4141 number-to-delete
(- (length versions
)
4145 (file-error (setq possibilities nil
)))
4146 (if (not deserve-versions-p
)
4147 (list (make-backup-file-name fn
))
4148 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
4149 (if (and (> number-to-delete
0)
4150 ;; Delete nothing if there is overflow
4151 ;; in the number of versions to keep.
4152 (>= (+ kept-new-versions kept-old-versions -
1) 0))
4154 (format "%s.~%d~" basic-name n
))
4155 (let ((v (nthcdr kept-old-versions versions
)))
4156 (rplacd (nthcdr (1- number-to-delete
) v
) ())
4159 (defun file-nlinks (filename)
4160 "Return number of names file FILENAME has."
4161 (car (cdr (file-attributes filename
))))
4163 ;; (defun file-relative-name (filename &optional directory)
4164 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4165 ;; This function returns a relative file name which is equivalent to FILENAME
4166 ;; when used with that default directory as the default.
4167 ;; If this is impossible (which can happen on MSDOS and Windows
4168 ;; when the file name and directory use different drive names)
4169 ;; then it returns FILENAME."
4171 ;; (let ((fname (expand-file-name filename)))
4172 ;; (setq directory (file-name-as-directory
4173 ;; (expand-file-name (or directory default-directory))))
4174 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
4175 ;; ;; drive names, they can't be relative, so return the absolute name.
4176 ;; (if (and (or (eq system-type 'ms-dos)
4177 ;; (eq system-type 'cygwin)
4178 ;; (eq system-type 'windows-nt))
4179 ;; (not (string-equal (substring fname 0 2)
4180 ;; (substring directory 0 2))))
4182 ;; (let ((ancestor ".")
4183 ;; (fname-dir (file-name-as-directory fname)))
4184 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
4185 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
4186 ;; (setq directory (file-name-directory (substring directory 0 -1))
4187 ;; ancestor (if (equal ancestor ".")
4189 ;; (concat "../" ancestor))))
4190 ;; ;; Now ancestor is empty, or .., or ../.., etc.
4191 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
4192 ;; ;; We matched within FNAME's directory part.
4193 ;; ;; Add the rest of FNAME onto ANCESTOR.
4194 ;; (let ((rest (substring fname (match-end 0))))
4195 ;; (if (and (equal ancestor ".")
4196 ;; (not (equal rest "")))
4197 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
4199 ;; (concat (file-name-as-directory ancestor) rest)))
4200 ;; ;; We matched FNAME's directory equivalent.
4203 (defun file-relative-name (filename &optional directory
)
4204 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
4205 This function returns a relative file name which is equivalent to FILENAME
4206 when used with that default directory as the default.
4207 If FILENAME and DIRECTORY lie on different machines or on different drives
4208 on a DOS/Windows machine, it returns FILENAME in expanded form."
4211 (file-name-as-directory (expand-file-name (or directory
4212 default-directory
))))
4213 (setq filename
(expand-file-name filename
))
4214 (let ((fremote (file-remote-p filename
))
4215 (dremote (file-remote-p directory
)))
4216 (if ;; Conditions for separate trees
4218 ;; Test for different filesystems on DOS/Windows
4220 ;; Should `cygwin' really be included here? --stef
4221 (memq system-type
'(ms-dos cygwin windows-nt
))
4223 ;; Test for different drive letters
4224 (not (eq t
(compare-strings filename
0 2 directory
0 2)))
4225 ;; Test for UNCs on different servers
4226 (not (eq t
(compare-strings
4228 (if (string-match "\\`//\\([^:/]+\\)/" filename
)
4229 (match-string 1 filename
)
4230 ;; Windows file names cannot have ? in
4231 ;; them, so use that to detect when
4232 ;; neither FILENAME nor DIRECTORY is a
4237 (if (string-match "\\`//\\([^:/]+\\)/" directory
)
4238 (match-string 1 directory
)
4241 ;; Test for different remote file system identification
4242 (not (equal fremote dremote
)))
4244 (let ((ancestor ".")
4245 (filename-dir (file-name-as-directory filename
)))
4248 (eq t
(compare-strings filename-dir nil
(length directory
)
4249 directory nil nil case-fold-search
))
4250 (eq t
(compare-strings filename nil
(length directory
)
4251 directory nil nil case-fold-search
))))
4252 (setq directory
(file-name-directory (substring directory
0 -
1))
4253 ancestor
(if (equal ancestor
".")
4255 (concat "../" ancestor
))))
4256 ;; Now ancestor is empty, or .., or ../.., etc.
4257 (if (eq t
(compare-strings filename nil
(length directory
)
4258 directory nil nil case-fold-search
))
4259 ;; We matched within FILENAME's directory part.
4260 ;; Add the rest of FILENAME onto ANCESTOR.
4261 (let ((rest (substring filename
(length directory
))))
4262 (if (and (equal ancestor
".") (not (equal rest
"")))
4263 ;; But don't bother with ANCESTOR if it would give us `./'.
4265 (concat (file-name-as-directory ancestor
) rest
)))
4266 ;; We matched FILENAME's directory equivalent.
4269 (defun save-buffer (&optional args
)
4270 "Save current buffer in visited file if modified.
4271 Variations are described below.
4273 By default, makes the previous version into a backup file
4274 if previously requested or if this is the first save.
4275 Prefixed with one \\[universal-argument], marks this version
4276 to become a backup when the next save is done.
4277 Prefixed with two \\[universal-argument]'s,
4278 unconditionally makes the previous version into a backup file.
4279 Prefixed with three \\[universal-argument]'s, marks this version
4280 to become a backup when the next save is done,
4281 and unconditionally makes the previous version into a backup file.
4283 With a numeric argument of 0, never make the previous version
4286 If a file's name is FOO, the names of its numbered backup versions are
4287 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
4288 Numeric backups (rather than FOO~) will be made if value of
4289 `version-control' is not the atom `never' and either there are already
4290 numeric versions of the file being backed up, or `version-control' is
4292 We don't want excessive versions piling up, so there are variables
4293 `kept-old-versions', which tells Emacs how many oldest versions to keep,
4294 and `kept-new-versions', which tells how many newest versions to keep.
4295 Defaults are 2 old versions and 2 new.
4296 `dired-kept-versions' controls dired's clean-directory (.) command.
4297 If `delete-old-versions' is nil, system will query user
4298 before trimming versions. Otherwise it does it silently.
4300 If `vc-make-backup-files' is nil, which is the default,
4301 no backup files are made for files managed by version control.
4302 (This is because the version control system itself records previous versions.)
4304 See the subroutine `basic-save-buffer' for more information."
4306 (let ((modp (buffer-modified-p))
4307 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
4308 (memq args
'(16 64)))))
4309 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
4310 ;; We used to display the message below only for files > 50KB, but
4311 ;; then Rmail-mbox never displays it due to buffer swapping. If
4312 ;; the test is ever re-introduced, be sure to handle saving of
4314 (if (and modp
(buffer-file-name))
4315 (message "Saving file %s..." (buffer-file-name)))
4317 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
4319 (defun delete-auto-save-file-if-necessary (&optional force
)
4320 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
4321 Normally delete only if the file was written by this Emacs since
4322 the last real save, but optional arg FORCE non-nil means delete anyway."
4323 (and buffer-auto-save-file-name delete-auto-save-files
4324 (not (string= buffer-file-name buffer-auto-save-file-name
))
4325 (or force
(recent-auto-save-p))
4328 (delete-file buffer-auto-save-file-name
)
4330 (set-buffer-auto-saved))))
4332 (defvar auto-save-hook nil
4333 "Normal hook run just before auto-saving.")
4335 (defcustom before-save-hook nil
4336 "Normal hook that is run before a buffer is saved to its file."
4337 :options
'(copyright-update time-stamp
)
4341 (defcustom after-save-hook nil
4342 "Normal hook that is run after a buffer is saved to its file."
4343 :options
'(executable-make-buffer-file-executable-if-script-p)
4347 (defvar save-buffer-coding-system nil
4348 "If non-nil, use this coding system for saving the buffer.
4349 More precisely, use this coding system in place of the
4350 value of `buffer-file-coding-system', when saving the buffer.
4351 Calling `write-region' for any purpose other than saving the buffer
4352 will still use `buffer-file-coding-system'; this variable has no effect
4355 (make-variable-buffer-local 'save-buffer-coding-system
)
4356 (put 'save-buffer-coding-system
'permanent-local t
)
4358 (defun basic-save-buffer ()
4359 "Save the current buffer in its visited file, if it has been modified.
4360 The hooks `write-contents-functions' and `write-file-functions' get a chance
4361 to do the job of saving; if they do not, then the buffer is saved in
4362 the visited file in the usual way.
4363 Before and after saving the buffer, this function runs
4364 `before-save-hook' and `after-save-hook', respectively."
4366 (save-current-buffer
4367 ;; In an indirect buffer, save its base buffer instead.
4368 (if (buffer-base-buffer)
4369 (set-buffer (buffer-base-buffer)))
4370 (if (or (buffer-modified-p)
4371 ;; handle the case when no modification has been made but
4372 ;; the file disappeared since visited
4373 (and buffer-file-name
4374 (not (file-exists-p buffer-file-name
))))
4375 (let ((recent-save (recent-auto-save-p))
4377 ;; If buffer has no file name, ask user for one.
4378 (or buffer-file-name
4381 (read-file-name "File to save in: ") nil
)))
4382 (if (file-exists-p filename
)
4383 (if (file-directory-p filename
)
4384 ;; Signal an error if the user specified the name of an
4385 ;; existing directory.
4386 (error "%s is a directory" filename
)
4387 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
4389 (error "Canceled")))
4390 ;; Signal an error if the specified name refers to a
4391 ;; non-existing directory.
4392 (let ((dir (file-name-directory filename
)))
4393 (unless (file-directory-p dir
)
4394 (if (file-exists-p dir
)
4395 (error "%s is not a directory" dir
)
4396 (error "%s: no such directory" dir
)))))
4397 (set-visited-file-name filename
)))
4398 (or (verify-visited-file-modtime (current-buffer))
4399 (not (file-exists-p buffer-file-name
))
4402 "%s has changed since visited or saved. Save anyway? "
4403 (file-name-nondirectory buffer-file-name
)))
4404 (error "Save not confirmed"))
4408 (and (> (point-max) (point-min))
4409 (not find-file-literally
)
4410 (/= (char-after (1- (point-max))) ?
\n)
4411 (not (and (eq selective-display t
)
4412 (= (char-after (1- (point-max))) ?
\r)))
4413 (or (eq require-final-newline t
)
4414 (eq require-final-newline
'visit-save
)
4415 (and require-final-newline
4417 (format "Buffer %s does not end in newline. Add one? "
4420 (goto-char (point-max))
4422 ;; Support VC version backups.
4424 (run-hooks 'before-save-hook
)
4425 (or (run-hook-with-args-until-success 'write-contents-functions
)
4426 (run-hook-with-args-until-success 'local-write-file-hooks
)
4427 (run-hook-with-args-until-success 'write-file-functions
)
4428 ;; If a hook returned t, file is already "written".
4429 ;; Otherwise, write it the usual way now.
4430 (setq setmodes
(basic-save-buffer-1)))
4431 ;; Now we have saved the current buffer. Let's make sure
4432 ;; that buffer-file-coding-system is fixed to what
4433 ;; actually used for saving by binding it locally.
4434 (if save-buffer-coding-system
4435 (setq save-buffer-coding-system last-coding-system-used
)
4436 (setq buffer-file-coding-system last-coding-system-used
))
4437 (setq buffer-file-number
4438 (nthcdr 10 (file-attributes buffer-file-name
)))
4442 (set-file-modes buffer-file-name
(car setmodes
))
4443 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))
4445 ;; If the auto-save file was recent before this command,
4447 (delete-auto-save-file-if-necessary recent-save
)
4448 ;; Support VC `implicit' locking.
4450 (run-hooks 'after-save-hook
))
4451 (message "(No changes need to be saved)"))))
4453 ;; This does the "real job" of writing a buffer into its visited file
4454 ;; and making a backup file. This is what is normally done
4455 ;; but inhibited if one of write-file-functions returns non-nil.
4456 ;; It returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4457 (defun basic-save-buffer-1 ()
4459 (if save-buffer-coding-system
4460 (let ((coding-system-for-write save-buffer-coding-system
))
4461 (basic-save-buffer-2))
4462 (basic-save-buffer-2))
4463 (if buffer-file-coding-system-explicit
4464 (setcar buffer-file-coding-system-explicit last-coding-system-used
)
4465 (setq buffer-file-coding-system-explicit
4466 (cons last-coding-system-used nil
)))))
4468 ;; This returns a value (MODES SELINUXCONTEXT BACKUPNAME), like backup-buffer.
4469 (defun basic-save-buffer-2 ()
4470 (let (tempsetmodes setmodes
)
4471 (if (not (file-writable-p buffer-file-name
))
4472 (let ((dir (file-name-directory buffer-file-name
)))
4473 (if (not (file-directory-p dir
))
4474 (if (file-exists-p dir
)
4475 (error "%s is not a directory" dir
)
4476 (error "%s: no such directory" dir
))
4477 (if (not (file-exists-p buffer-file-name
))
4478 (error "Directory %s write-protected" dir
)
4481 "File %s is write-protected; try to save anyway? "
4482 (file-name-nondirectory
4484 (setq tempsetmodes t
)
4485 (error "Attempt to save to a file which you aren't allowed to write"))))))
4486 (or buffer-backed-up
4487 (setq setmodes
(backup-buffer)))
4488 (let* ((dir (file-name-directory buffer-file-name
))
4489 (dir-writable (file-writable-p dir
)))
4490 (if (or (and file-precious-flag dir-writable
)
4491 (and break-hardlink-on-save
4492 (file-exists-p buffer-file-name
)
4493 (> (file-nlinks buffer-file-name
) 1)
4495 (error (concat (format
4496 "Directory %s write-protected; " dir
)
4497 "cannot break hardlink when saving")))))
4498 ;; Write temp name, then rename it.
4499 ;; This requires write access to the containing dir,
4500 ;; which is why we don't try it if we don't have that access.
4501 (let ((realname buffer-file-name
)
4503 (umask (default-file-modes))
4504 (old-modtime (visited-file-modtime)))
4505 ;; Create temp files with strict access rights. It's easy to
4506 ;; loosen them later, whereas it's impossible to close the
4507 ;; time-window of loose permissions otherwise.
4510 (clear-visited-file-modtime)
4511 (set-default-file-modes ?
\700)
4512 ;; Try various temporary names.
4513 ;; This code follows the example of make-temp-file,
4514 ;; but it calls write-region in the appropriate way
4515 ;; for saving the buffer.
4516 (while (condition-case ()
4520 (expand-file-name "tmp" dir
)))
4521 ;; Pass in nil&nil rather than point-min&max
4522 ;; cause we're saving the whole buffer.
4523 ;; write-region-annotate-functions may use it.
4524 (write-region nil nil
4525 tempname nil realname
4526 buffer-file-truename
'excl
)
4528 (file-already-exists t
))
4529 ;; The file was somehow created by someone else between
4530 ;; `make-temp-name' and `write-region', let's try again.
4534 (set-default-file-modes umask
)
4535 ;; If we failed, restore the buffer's modtime.
4537 (set-visited-file-modtime old-modtime
)))
4538 ;; Since we have created an entirely new file,
4539 ;; make sure it gets the right permission bits set.
4540 (setq setmodes
(or setmodes
4541 (list (or (file-modes buffer-file-name
)
4542 (logand ?
\666 umask
))
4543 (file-selinux-context buffer-file-name
)
4545 ;; We succeeded in writing the temp file,
4547 (rename-file tempname buffer-file-name t
))
4548 ;; If file not writable, see if we can make it writable
4549 ;; temporarily while we write it.
4550 ;; But no need to do so if we have just backed it up
4551 ;; (setmodes is set) because that says we're superseding.
4552 (cond ((and tempsetmodes
(not setmodes
))
4553 ;; Change the mode back, after writing.
4554 (setq setmodes
(list (file-modes buffer-file-name
)
4555 (file-selinux-context buffer-file-name
)
4557 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))
4558 (set-file-selinux-context buffer-file-name
(nth 1 setmodes
)))))
4562 ;; Pass in nil&nil rather than point-min&max to indicate
4563 ;; we're saving the buffer rather than just a region.
4564 ;; write-region-annotate-functions may make us of it.
4565 (write-region nil nil
4566 buffer-file-name nil t buffer-file-truename
)
4568 ;; If we get an error writing the new file, and we made
4569 ;; the backup by renaming, undo the backing-up.
4570 (and setmodes
(not success
)
4572 (rename-file (nth 2 setmodes
) buffer-file-name t
)
4573 (setq buffer-backed-up nil
))))))
4576 (declare-function diff-no-select
"diff"
4577 (old new
&optional switches no-async buf
))
4579 (defvar save-some-buffers-action-alist
4582 (if (not enable-recursive-minibuffers
)
4583 (progn (display-buffer buf
)
4584 (setq other-window-scroll-buffer buf
))
4585 (view-buffer buf
(lambda (_) (exit-recursive-edit)))
4587 ;; Return nil to ask about BUF again.
4589 ,(purecopy "view this buffer"))
4591 (if (null (buffer-file-name buf
))
4592 (message "Not applicable: no file")
4593 (require 'diff
) ;for diff-no-select.
4594 (let ((diffbuf (diff-no-select (buffer-file-name buf
) buf
4596 (if (not enable-recursive-minibuffers
)
4597 (progn (display-buffer diffbuf
)
4598 (setq other-window-scroll-buffer diffbuf
))
4599 (view-buffer diffbuf
(lambda (_) (exit-recursive-edit)))
4601 ;; Return nil to ask about BUF again.
4603 ,(purecopy "view changes in this buffer")))
4604 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4605 (put 'save-some-buffers-action-alist
'risky-local-variable t
)
4607 (defvar buffer-save-without-query nil
4608 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4609 (make-variable-buffer-local 'buffer-save-without-query
)
4611 (defun save-some-buffers (&optional arg pred
)
4612 "Save some modified file-visiting buffers. Asks user about each one.
4613 You can answer `y' to save, `n' not to save, `C-r' to look at the
4614 buffer in question with `view-buffer' before deciding or `d' to
4615 view the differences using `diff-buffer-with-file'.
4617 This command first saves any buffers where `buffer-save-without-query' is
4618 non-nil, without asking.
4620 Optional argument (the prefix) non-nil means save all with no questions.
4621 Optional second argument PRED determines which buffers are considered:
4622 If PRED is nil, all the file-visiting buffers are considered.
4623 If PRED is t, then certain non-file buffers will also be considered.
4624 If PRED is a zero-argument function, it indicates for each buffer whether
4625 to consider it or not when called with that buffer current.
4627 See `save-some-buffers-action-alist' if you want to
4628 change the additional actions you can take on files."
4630 (save-window-excursion
4631 (let* (queried autosaved-buffers
4632 files-done abbrevs-done
)
4633 (dolist (buffer (buffer-list))
4634 ;; First save any buffers that we're supposed to save unconditionally.
4635 ;; That way the following code won't ask about them.
4636 (with-current-buffer buffer
4637 (when (and buffer-save-without-query
(buffer-modified-p))
4638 (push (buffer-name) autosaved-buffers
)
4640 ;; Ask about those buffers that merit it,
4641 ;; and record the number thus saved.
4645 ;; Note that killing some buffers may kill others via
4646 ;; hooks (e.g. Rmail and its viewing buffer).
4647 (and (buffer-live-p buffer
)
4648 (buffer-modified-p buffer
)
4649 (not (buffer-base-buffer buffer
))
4651 (buffer-file-name buffer
)
4655 (and buffer-offer-save
(> (buffer-size) 0)))))
4656 (or (not (functionp pred
))
4657 (with-current-buffer buffer
(funcall pred
)))
4661 (if (buffer-file-name buffer
)
4662 (format "Save file %s? "
4663 (buffer-file-name buffer
))
4664 (format "Save buffer %s? "
4665 (buffer-name buffer
))))))
4667 (with-current-buffer buffer
4670 '("buffer" "buffers" "save")
4671 save-some-buffers-action-alist
))
4672 ;; Maybe to save abbrevs, and record whether
4673 ;; we either saved them or asked to.
4674 (and save-abbrevs abbrevs-changed
4677 (eq save-abbrevs
'silently
)
4678 (y-or-n-p (format "Save abbrevs in %s? " abbrev-file-name
)))
4679 (write-abbrev-file nil
))
4680 ;; Don't keep bothering user if he says no.
4681 (setq abbrevs-changed nil
)
4682 (setq abbrevs-done t
)))
4683 (or queried
(> files-done
0) abbrevs-done
4685 ((null autosaved-buffers
)
4686 (message "(No files need saving)"))
4687 ((= (length autosaved-buffers
) 1)
4688 (message "(Saved %s)" (car autosaved-buffers
)))
4690 (message "(Saved %d files: %s)"
4691 (length autosaved-buffers
)
4692 (mapconcat 'identity autosaved-buffers
", "))))))))
4694 (defun not-modified (&optional arg
)
4695 "Mark current buffer as unmodified, not needing to be saved.
4696 With prefix ARG, mark buffer as modified, so \\[save-buffer] will save.
4698 It is not a good idea to use this function in Lisp programs, because it
4699 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4701 (message (if arg
"Modification-flag set"
4702 "Modification-flag cleared"))
4703 (set-buffer-modified-p arg
))
4705 (defun toggle-read-only (&optional arg
)
4706 "Change whether this buffer is read-only.
4707 With prefix argument ARG, make the buffer read-only if ARG is
4708 positive, otherwise make it writable. If buffer is read-only
4709 and `view-read-only' is non-nil, enter view mode.
4711 This function is usually the wrong thing to use in a Lisp program.
4712 It can have side-effects beyond changing the read-only status of a buffer
4713 \(e.g., enabling view mode), and does not affect read-only regions that
4714 are caused by text properties. To make a buffer read-only in Lisp code,
4715 set `buffer-read-only'. To ignore read-only status (whether due to text
4716 properties or buffer state) and make changes, temporarily bind
4717 `inhibit-read-only'."
4720 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4721 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4725 ((and buffer-read-only view-mode
)
4726 (View-exit-and-edit)
4727 (make-local-variable 'view-read-only
)
4728 (setq view-read-only t
)) ; Must leave view mode.
4729 ((and (not buffer-read-only
) view-read-only
4730 ;; If view-mode is already active, `view-mode-enter' is a nop.
4732 (not (eq (get major-mode
'mode-class
) 'special
)))
4734 (t (setq buffer-read-only
(not buffer-read-only
))
4735 (force-mode-line-update)))))
4737 (defun insert-file (filename)
4738 "Insert contents of file FILENAME into buffer after point.
4739 Set mark after the inserted text.
4741 This function is meant for the user to run interactively.
4742 Don't call it from programs! Use `insert-file-contents' instead.
4743 \(Its calling sequence is different; see its documentation)."
4744 (interactive "*fInsert file: ")
4745 (insert-file-1 filename
#'insert-file-contents
))
4747 (defun append-to-file (start end filename
)
4748 "Append the contents of the region to the end of file FILENAME.
4749 When called from a function, expects three arguments,
4750 START, END and FILENAME. START and END are normally buffer positions
4751 specifying the part of the buffer to write.
4752 If START is nil, that means to use the entire buffer contents.
4753 If START is a string, then output that string to the file
4754 instead of any buffer contents; END is ignored.
4756 This does character code conversion and applies annotations
4757 like `write-region' does."
4758 (interactive "r\nFAppend to file: ")
4759 (write-region start end filename t
))
4761 (defun file-newest-backup (filename)
4762 "Return most recent backup file for FILENAME or nil if no backups exist."
4763 ;; `make-backup-file-name' will get us the right directory for
4764 ;; ordinary or numeric backups. It might create a directory for
4765 ;; backups as a side-effect, according to `backup-directory-alist'.
4766 (let* ((filename (file-name-sans-versions
4767 (make-backup-file-name (expand-file-name filename
))))
4768 (file (file-name-nondirectory filename
))
4769 (dir (file-name-directory filename
))
4770 (comp (file-name-all-completions file dir
))
4774 (setq tem
(pop comp
))
4775 (cond ((and (backup-file-name-p tem
)
4776 (string= (file-name-sans-versions tem
) file
))
4777 (setq tem
(concat dir tem
))
4778 (if (or (null newest
)
4779 (file-newer-than-file-p tem newest
))
4780 (setq newest tem
)))))
4783 (defun rename-uniquely ()
4784 "Rename current buffer to a similar name not already taken.
4785 This function is useful for creating multiple shell process buffers
4786 or multiple mail buffers, etc."
4789 (let ((base-name (buffer-name)))
4790 (and (string-match "<[0-9]+>\\'" base-name
)
4791 (not (and buffer-file-name
4793 (file-name-nondirectory buffer-file-name
))))
4794 ;; If the existing buffer name has a <NNN>,
4795 ;; which isn't part of the file name (if any),
4796 ;; then get rid of that.
4797 (setq base-name
(substring base-name
0 (match-beginning 0))))
4798 (rename-buffer (generate-new-buffer-name base-name
))
4799 (force-mode-line-update))))
4801 (defun make-directory (dir &optional parents
)
4802 "Create the directory DIR and optionally any nonexistent parent dirs.
4803 If DIR already exists as a directory, signal an error, unless
4806 Interactively, the default choice of directory to create is the
4807 current buffer's default directory. That is useful when you have
4808 visited a file in a nonexistent directory.
4810 Noninteractively, the second (optional) argument PARENTS, if
4811 non-nil, says whether to create parent directories that don't
4812 exist. Interactively, this happens by default.
4814 If creating the directory or directories fail, an error will be
4817 (list (read-file-name "Make directory: " default-directory default-directory
4820 ;; If default-directory is a remote directory,
4821 ;; make sure we find its make-directory handler.
4822 (setq dir
(expand-file-name dir
))
4823 (let ((handler (find-file-name-handler dir
'make-directory
)))
4825 (funcall handler
'make-directory dir parents
)
4827 (make-directory-internal dir
)
4828 (let ((dir (directory-file-name (expand-file-name dir
)))
4830 (while (and (not (file-exists-p dir
))
4831 ;; If directory is its own parent, then we can't
4832 ;; keep looping forever
4834 (directory-file-name
4835 (file-name-directory dir
)))))
4836 (setq create-list
(cons dir create-list
)
4837 dir
(directory-file-name (file-name-directory dir
))))
4839 (make-directory-internal (car create-list
))
4840 (setq create-list
(cdr create-list
))))))))
4842 (defconst directory-files-no-dot-files-regexp
4843 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*"
4844 "Regexp matching any file name except \".\" and \"..\".")
4846 (defun delete-directory (directory &optional recursive trash
)
4847 "Delete the directory named DIRECTORY. Does not follow symlinks.
4848 If RECURSIVE is non-nil, all files in DIRECTORY are deleted as well.
4849 TRASH non-nil means to trash the directory instead, provided
4850 `delete-by-moving-to-trash' is non-nil.
4852 When called interactively, TRASH is t if no prefix argument is
4853 given. With a prefix argument, TRASH is nil."
4855 (let* ((trashing (and delete-by-moving-to-trash
4856 (null current-prefix-arg
)))
4857 (dir (expand-file-name
4858 (read-directory-name
4860 "Move directory to trash: "
4861 "Delete directory: ")
4862 default-directory default-directory nil nil
))))
4864 (if (directory-files dir nil directory-files-no-dot-files-regexp
)
4866 (format "Directory `%s' is not empty, really %s? "
4867 dir
(if trashing
"trash" "delete")))
4869 (null current-prefix-arg
))))
4870 ;; If default-directory is a remote directory, make sure we find its
4871 ;; delete-directory handler.
4872 (setq directory
(directory-file-name (expand-file-name directory
)))
4873 (let ((handler (find-file-name-handler directory
'delete-directory
)))
4876 (funcall handler
'delete-directory directory recursive
))
4877 ((and delete-by-moving-to-trash trash
)
4878 ;; Only move non-empty dir to trash if recursive deletion was
4879 ;; requested. This mimics the non-`delete-by-moving-to-trash'
4880 ;; case, where the operation fails in delete-directory-internal.
4881 ;; As `move-file-to-trash' trashes directories (empty or
4882 ;; otherwise) as a unit, we do not need to recurse here.
4883 (if (and (not recursive
)
4884 ;; Check if directory is empty apart from "." and "..".
4886 directory
'full directory-files-no-dot-files-regexp
))
4887 (error "Directory is not empty, not moving to trash")
4888 (move-file-to-trash directory
)))
4889 ;; Otherwise, call ourselves recursively if needed.
4891 (if (and recursive
(not (file-symlink-p directory
)))
4892 (mapc (lambda (file)
4893 ;; This test is equivalent to
4894 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
4895 ;; but more efficient
4896 (if (eq t
(car (file-attributes file
)))
4897 (delete-directory file recursive nil
)
4898 (delete-file file nil
)))
4899 ;; We do not want to delete "." and "..".
4901 directory
'full directory-files-no-dot-files-regexp
)))
4902 (delete-directory-internal directory
)))))
4904 (defun copy-directory (directory newname
&optional keep-time parents copy-contents
)
4905 "Copy DIRECTORY to NEWNAME. Both args must be strings.
4906 This function always sets the file modes of the output files to match
4907 the corresponding input file.
4909 The third arg KEEP-TIME non-nil means give the output files the same
4910 last-modified time as the old ones. (This works on only some systems.)
4912 A prefix arg makes KEEP-TIME non-nil.
4914 Noninteractively, the last argument PARENTS says whether to
4915 create parent directories if they don't exist. Interactively,
4916 this happens by default.
4918 If NEWNAME names an existing directory, copy DIRECTORY as a
4919 subdirectory there. However, if called from Lisp with a non-nil
4920 optional argument COPY-CONTENTS, copy the contents of DIRECTORY
4921 directly into NEWNAME instead."
4923 (let ((dir (read-directory-name
4924 "Copy directory: " default-directory default-directory t nil
)))
4926 (read-directory-name
4927 (format "Copy directory %s to: " dir
)
4928 default-directory default-directory nil nil
)
4929 current-prefix-arg t nil
)))
4930 ;; If default-directory is a remote directory, make sure we find its
4931 ;; copy-directory handler.
4932 (let ((handler (or (find-file-name-handler directory
'copy-directory
)
4933 (find-file-name-handler newname
'copy-directory
))))
4935 (funcall handler
'copy-directory directory newname keep-time parents
)
4937 ;; Compute target name.
4938 (setq directory
(directory-file-name (expand-file-name directory
))
4939 newname
(directory-file-name (expand-file-name newname
)))
4941 (cond ((not (file-directory-p newname
))
4942 ;; If NEWNAME is not an existing directory, create it;
4943 ;; that is where we will copy the files of DIRECTORY.
4944 (make-directory newname parents
))
4945 ;; If NEWNAME is an existing directory and COPY-CONTENTS
4946 ;; is nil, copy into NEWNAME/[DIRECTORY-BASENAME].
4947 ((not copy-contents
)
4948 (setq newname
(expand-file-name
4949 (file-name-nondirectory
4950 (directory-file-name directory
))
4952 (and (file-exists-p newname
)
4953 (not (file-directory-p newname
))
4954 (error "Cannot overwrite non-directory %s with a directory"
4956 (make-directory newname t
)))
4958 ;; Copy recursively.
4960 ;; We do not want to copy "." and "..".
4961 (directory-files directory
'full
4962 directory-files-no-dot-files-regexp
))
4963 (if (file-directory-p file
)
4964 (copy-directory file newname keep-time parents
)
4965 (let ((target (expand-file-name (file-name-nondirectory file
) newname
))
4966 (attrs (file-attributes file
)))
4967 (if (stringp (car attrs
)) ; Symbolic link
4968 (make-symbolic-link (car attrs
) target t
)
4969 (copy-file file target t keep-time
)))))
4971 ;; Set directory attributes.
4972 (let ((modes (file-modes directory
))
4973 (times (and keep-time
(nth 5 (file-attributes directory
)))))
4974 (if modes
(set-file-modes newname modes
))
4975 (if times
(set-file-times newname times
))))))
4977 (put 'revert-buffer-function
'permanent-local t
)
4978 (defvar revert-buffer-function nil
4979 "Function to use to revert this buffer, or nil to do the default.
4980 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4981 which are the arguments that `revert-buffer' received.")
4983 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
4984 (defvar revert-buffer-insert-file-contents-function nil
4985 "Function to use to insert contents when reverting this buffer.
4986 Gets two args, first the nominal file name to use,
4987 and second, t if reading the auto-save file.
4989 The function you specify is responsible for updating (or preserving) point.")
4991 (defvar buffer-stale-function nil
4992 "Function to check whether a non-file buffer needs reverting.
4993 This should be a function with one optional argument NOCONFIRM.
4994 Auto Revert Mode passes t for NOCONFIRM. The function should return
4995 non-nil if the buffer should be reverted. A return value of
4996 `fast' means that the need for reverting was not checked, but
4997 that reverting the buffer is fast. The buffer is current when
4998 this function is called.
5000 The idea behind the NOCONFIRM argument is that it should be
5001 non-nil if the buffer is going to be reverted without asking the
5002 user. In such situations, one has to be careful with potentially
5003 time consuming operations.
5005 For more information on how this variable is used by Auto Revert mode,
5006 see Info node `(emacs)Supporting additional buffers'.")
5008 (defvar before-revert-hook nil
5009 "Normal hook for `revert-buffer' to run before reverting.
5010 If `revert-buffer-function' is used to override the normal revert
5011 mechanism, this hook is not used.")
5013 (defvar after-revert-hook nil
5014 "Normal hook for `revert-buffer' to run after reverting.
5015 Note that the hook value that it runs is the value that was in effect
5016 before reverting; that makes a difference if you have buffer-local
5019 If `revert-buffer-function' is used to override the normal revert
5020 mechanism, this hook is not used.")
5022 (defvar revert-buffer-in-progress-p nil
5023 "Non-nil if a `revert-buffer' operation is in progress, nil otherwise.
5024 This is true even if a `revert-buffer-function' is being used.")
5026 (defvar revert-buffer-internal-hook
)
5028 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
5029 "Replace current buffer text with the text of the visited file on disk.
5030 This undoes all changes since the file was visited or saved.
5031 With a prefix argument, offer to revert from latest auto-save file, if
5032 that is more recent than the visited file.
5034 This command also implements an interface for special buffers
5035 that contain text which doesn't come from a file, but reflects
5036 some other data instead (e.g. Dired buffers, `buffer-list'
5037 buffers). This is done via the variable `revert-buffer-function'.
5038 In these cases, it should reconstruct the buffer contents from the
5041 When called from Lisp, the first argument is IGNORE-AUTO; only offer
5042 to revert from the auto-save file when this is nil. Note that the
5043 sense of this argument is the reverse of the prefix argument, for the
5044 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
5047 Optional second argument NOCONFIRM means don't ask for confirmation
5048 at all. (The variable `revert-without-query' offers another way to
5049 revert buffers without querying for confirmation.)
5051 Optional third argument PRESERVE-MODES non-nil means don't alter
5052 the files modes. Normally we reinitialize them using `normal-mode'.
5054 If the value of `revert-buffer-function' is non-nil, it is called to
5055 do all the work for this command. Otherwise, the hooks
5056 `before-revert-hook' and `after-revert-hook' are run at the beginning
5057 and the end, and if `revert-buffer-insert-file-contents-function' is
5058 non-nil, it is called instead of rereading visited file contents."
5060 ;; I admit it's odd to reverse the sense of the prefix argument, but
5061 ;; there is a lot of code out there which assumes that the first
5062 ;; argument should be t to avoid consulting the auto-save file, and
5063 ;; there's no straightforward way to encourage authors to notice a
5064 ;; reversal of the argument sense. So I'm just changing the user
5065 ;; interface, but leaving the programmatic interface the same.
5066 (interactive (list (not current-prefix-arg
)))
5067 (if revert-buffer-function
5068 (let ((revert-buffer-in-progress-p t
))
5069 (funcall revert-buffer-function ignore-auto noconfirm
))
5070 (with-current-buffer (or (buffer-base-buffer (current-buffer))
5072 (let* ((revert-buffer-in-progress-p t
)
5073 (auto-save-p (and (not ignore-auto
)
5074 (recent-auto-save-p)
5075 buffer-auto-save-file-name
5076 (file-readable-p buffer-auto-save-file-name
)
5078 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
5079 (file-name (if auto-save-p
5080 buffer-auto-save-file-name
5082 (cond ((null file-name
)
5083 (error "Buffer does not seem to be associated with any file"))
5085 (and (not (buffer-modified-p))
5087 (dolist (regexp revert-without-query
)
5088 (when (string-match regexp file-name
)
5089 (throw 'found t
)))))
5090 (yes-or-no-p (format "Revert buffer from file %s? "
5092 (run-hooks 'before-revert-hook
)
5093 ;; If file was backed up but has changed since,
5094 ;; we should make another backup.
5095 (and (not auto-save-p
)
5096 (not (verify-visited-file-modtime (current-buffer)))
5097 (setq buffer-backed-up nil
))
5098 ;; Effectively copy the after-revert-hook status,
5099 ;; since after-find-file will clobber it.
5100 (let ((global-hook (default-value 'after-revert-hook
))
5101 (local-hook (when (local-variable-p 'after-revert-hook
)
5103 (inhibit-read-only t
))
5105 (revert-buffer-insert-file-contents-function
5106 (unless (eq buffer-undo-list t
)
5107 ;; Get rid of all undo records for this buffer.
5108 (setq buffer-undo-list nil
))
5109 ;; Don't make undo records for the reversion.
5110 (let ((buffer-undo-list t
))
5111 (funcall revert-buffer-insert-file-contents-function
5112 file-name auto-save-p
)))
5113 ((not (file-exists-p file-name
))
5114 (error (if buffer-file-number
5115 "File %s no longer exists!"
5116 "Cannot revert nonexistent file %s")
5118 ((not (file-readable-p file-name
))
5119 (error (if buffer-file-number
5120 "File %s no longer readable!"
5121 "Cannot revert unreadable file %s")
5124 ;; Bind buffer-file-name to nil
5125 ;; so that we don't try to lock the file.
5126 (let ((buffer-file-name nil
))
5130 (let ((coding-system-for-read
5131 ;; Auto-saved file should be read by Emacs'
5133 (if auto-save-p
'auto-save-coding
5134 (or coding-system-for-read
5136 buffer-file-coding-system-explicit
5137 (car buffer-file-coding-system-explicit
))))))
5138 (if (and (not enable-multibyte-characters
)
5139 coding-system-for-read
5140 (not (memq (coding-system-base
5141 coding-system-for-read
)
5142 '(no-conversion raw-text
))))
5143 ;; As a coding system suitable for multibyte
5144 ;; buffer is specified, make the current
5145 ;; buffer multibyte.
5146 (set-buffer-multibyte t
))
5148 ;; This force after-insert-file-set-coding
5149 ;; (called from insert-file-contents) to set
5150 ;; buffer-file-coding-system to a proper value.
5151 (kill-local-variable 'buffer-file-coding-system
)
5153 ;; Note that this preserves point in an intelligent way.
5155 (let ((buffer-file-format buffer-file-format
))
5156 (insert-file-contents file-name
(not auto-save-p
)
5158 (insert-file-contents file-name
(not auto-save-p
)
5160 ;; Recompute the truename in case changes in symlinks
5161 ;; have changed the truename.
5162 (setq buffer-file-truename
5163 (abbreviate-file-name (file-truename buffer-file-name
)))
5164 (after-find-file nil nil t nil preserve-modes
)
5165 ;; Run after-revert-hook as it was before we reverted.
5166 (setq-default revert-buffer-internal-hook global-hook
)
5168 (set (make-local-variable 'revert-buffer-internal-hook
)
5170 (kill-local-variable 'revert-buffer-internal-hook
))
5171 (run-hooks 'revert-buffer-internal-hook
))
5174 (defun recover-this-file ()
5175 "Recover the visited file--get contents from its last auto-save file."
5177 (recover-file buffer-file-name
))
5179 (defun recover-file (file)
5180 "Visit file FILE, but get contents from its last auto-save file."
5181 ;; Actually putting the file name in the minibuffer should be used
5183 ;; Not just because users often use the default.
5184 (interactive "FRecover file: ")
5185 (setq file
(expand-file-name file
))
5186 (if (auto-save-file-name-p (file-name-nondirectory file
))
5187 (error "%s is an auto-save file" (abbreviate-file-name file
)))
5188 (let ((file-name (let ((buffer-file-name file
))
5189 (make-auto-save-file-name))))
5190 (cond ((if (file-exists-p file
)
5191 (not (file-newer-than-file-p file-name file
))
5192 (not (file-exists-p file-name
)))
5193 (error "Auto-save file %s not current"
5194 (abbreviate-file-name file-name
)))
5195 ((save-window-excursion
5196 (with-output-to-temp-buffer "*Directory*"
5197 (buffer-disable-undo standard-output
)
5199 (let ((switches dired-listing-switches
))
5200 (if (file-symlink-p file
)
5201 (setq switches
(concat switches
" -L")))
5202 (set-buffer standard-output
)
5203 ;; Use insert-directory-safely, not insert-directory,
5204 ;; because these files might not exist. In particular,
5205 ;; FILE might not exist if the auto-save file was for
5206 ;; a buffer that didn't visit a file, such as "*mail*".
5207 ;; The code in v20.x called `ls' directly, so we need
5208 ;; to emulate what `ls' did in that case.
5209 (insert-directory-safely file switches
)
5210 (insert-directory-safely file-name switches
))))
5211 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
5212 (switch-to-buffer (find-file-noselect file t
))
5213 (let ((inhibit-read-only t
)
5214 ;; Keep the current buffer-file-coding-system.
5215 (coding-system buffer-file-coding-system
)
5216 ;; Auto-saved file should be read with special coding.
5217 (coding-system-for-read 'auto-save-coding
))
5219 (insert-file-contents file-name nil
)
5220 (set-buffer-file-coding-system coding-system
))
5221 (after-find-file nil nil t
))
5222 (t (error "Recover-file cancelled")))))
5224 (defun recover-session ()
5225 "Recover auto save files from a previous Emacs session.
5226 This command first displays a Dired buffer showing you the
5227 previous sessions that you could recover from.
5228 To choose one, move point to the proper line and then type C-c C-c.
5229 Then you'll be asked about a number of files to recover."
5231 (if (null auto-save-list-file-prefix
)
5232 (error "You set `auto-save-list-file-prefix' to disable making session files"))
5233 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
5234 (unless (file-directory-p dir
)
5235 (make-directory dir t
))
5236 (unless (directory-files dir nil
5237 (concat "\\`" (regexp-quote
5238 (file-name-nondirectory
5239 auto-save-list-file-prefix
)))
5241 (error "No previous sessions to recover")))
5242 (let ((ls-lisp-support-shell-wildcards t
))
5243 (dired (concat auto-save-list-file-prefix
"*")
5244 (concat dired-listing-switches
" -t")))
5246 (goto-char (point-min))
5247 (or (looking-at " Move to the session you want to recover,")
5248 (let ((inhibit-read-only t
))
5249 ;; Each line starts with a space
5250 ;; so that Font Lock mode won't highlight the first character.
5251 (insert " Move to the session you want to recover,\n"
5252 " then type C-c C-c to select it.\n\n"
5253 " You can also delete some of these files;\n"
5254 " type d on a line to mark that file for deletion.\n\n"))))
5255 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
5256 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
5258 (defun recover-session-finish ()
5259 "Choose one saved session to recover auto-save files from.
5260 This command is used in the special Dired buffer created by
5261 \\[recover-session]."
5263 ;; Get the name of the session file to recover from.
5264 (let ((file (dired-get-filename))
5266 (buffer (get-buffer-create " *recover*")))
5268 (dired-do-flagged-delete t
)
5270 (with-current-buffer buffer
5271 ;; Read in the auto-save-list file.
5273 (insert-file-contents file
)
5274 ;; Loop thru the text of that file
5275 ;; and get out the names of the files to recover.
5277 (let (thisfile autofile
)
5279 ;; This is a pair of lines for a non-file-visiting buffer.
5280 ;; Get the auto-save file name and manufacture
5281 ;; a "visited file name" from that.
5284 ;; If there is no auto-save file name, the
5285 ;; auto-save-list file is probably corrupted.
5288 (buffer-substring-no-properties
5290 (line-end-position)))
5294 (file-name-nondirectory autofile
)
5296 (file-name-directory autofile
))))
5298 ;; This pair of lines is a file-visiting
5299 ;; buffer. Use the visited file name.
5302 (buffer-substring-no-properties
5303 (point) (progn (end-of-line) (point))))
5306 (buffer-substring-no-properties
5307 (point) (progn (end-of-line) (point))))
5309 ;; Ignore a file if its auto-save file does not exist now.
5310 (if (and autofile
(file-exists-p autofile
))
5311 (setq files
(cons thisfile files
)))))
5312 (setq files
(nreverse files
))
5313 ;; The file contains a pair of line for each auto-saved buffer.
5314 ;; The first line of the pair contains the visited file name
5315 ;; or is empty if the buffer was not visiting a file.
5316 ;; The second line is the auto-save file name.
5318 (map-y-or-n-p "Recover %s? "
5321 (save-excursion (recover-file file
))
5323 "Failed to recover `%s'" file
)))
5325 '("file" "files" "recover"))
5326 (message "No files can be recovered from this session now")))
5327 (kill-buffer buffer
))))
5329 (defun kill-buffer-ask (buffer)
5330 "Kill BUFFER if confirmed."
5331 (when (yes-or-no-p (format "Buffer %s %s. Kill? "
5332 (buffer-name buffer
)
5333 (if (buffer-modified-p buffer
)
5334 "HAS BEEN EDITED" "is unmodified")))
5335 (kill-buffer buffer
)))
5337 (defun kill-some-buffers (&optional list
)
5338 "Kill some buffers. Asks the user whether to kill each one of them.
5339 Non-interactively, if optional argument LIST is non-nil, it
5340 specifies the list of buffers to kill, asking for approval for each one."
5343 (setq list
(buffer-list)))
5345 (let* ((buffer (car list
))
5346 (name (buffer-name buffer
)))
5347 (and name
; Can be nil for an indirect buffer
5348 ; if we killed the base buffer.
5349 (not (string-equal name
""))
5350 (/= (aref name
0) ?\s
)
5351 (kill-buffer-ask buffer
)))
5352 (setq list
(cdr list
))))
5354 (defun kill-matching-buffers (regexp &optional internal-too
)
5355 "Kill buffers whose name matches the specified REGEXP.
5356 The optional second argument indicates whether to kill internal buffers too."
5357 (interactive "sKill buffers matching this regular expression: \nP")
5358 (dolist (buffer (buffer-list))
5359 (let ((name (buffer-name buffer
)))
5360 (when (and name
(not (string-equal name
""))
5361 (or internal-too
(/= (aref name
0) ?\s
))
5362 (string-match regexp name
))
5363 (kill-buffer-ask buffer
)))))
5366 (defun rename-auto-save-file ()
5367 "Adjust current buffer's auto save file name for current conditions.
5368 Also rename any existing auto save file, if it was made in this session."
5369 (let ((osave buffer-auto-save-file-name
))
5370 (setq buffer-auto-save-file-name
5371 (make-auto-save-file-name))
5372 (if (and osave buffer-auto-save-file-name
5373 (not (string= buffer-auto-save-file-name buffer-file-name
))
5374 (not (string= buffer-auto-save-file-name osave
))
5375 (file-exists-p osave
)
5376 (recent-auto-save-p))
5377 (rename-file osave buffer-auto-save-file-name t
))))
5379 (defun make-auto-save-file-name ()
5380 "Return file name to use for auto-saves of current buffer.
5381 Does not consider `auto-save-visited-file-name' as that variable is checked
5382 before calling this function. You can redefine this for customization.
5383 See also `auto-save-file-name-p'."
5384 (if buffer-file-name
5385 (let ((handler (find-file-name-handler buffer-file-name
5386 'make-auto-save-file-name
)))
5388 (funcall handler
'make-auto-save-file-name
)
5389 (let ((list auto-save-file-name-transforms
)
5390 (filename buffer-file-name
)
5392 ;; Apply user-specified translations
5393 ;; to the file name.
5394 (while (and list
(not result
))
5395 (if (string-match (car (car list
)) filename
)
5396 (setq result
(replace-match (cadr (car list
)) t nil
5398 uniq
(car (cddr (car list
)))))
5399 (setq list
(cdr list
)))
5402 (setq filename
(concat
5403 (file-name-directory result
)
5404 (subst-char-in-string
5406 (replace-regexp-in-string "!" "!!"
5408 (setq filename result
)))
5410 (if (and (eq system-type
'ms-dos
)
5411 (not (msdos-long-file-names)))
5412 ;; We truncate the file name to DOS 8+3 limits
5413 ;; before doing anything else, because the regexp
5414 ;; passed to string-match below cannot handle
5415 ;; extensions longer than 3 characters, multiple
5416 ;; dots, and other atrocities.
5417 (let ((fn (dos-8+3-filename
5418 (file-name-nondirectory buffer-file-name
))))
5420 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
5422 (concat (file-name-directory buffer-file-name
)
5423 "#" (match-string 1 fn
)
5424 "." (match-string 3 fn
) "#"))
5425 (concat (file-name-directory filename
)
5427 (file-name-nondirectory filename
)
5429 ;; Make sure auto-save file names don't contain characters
5430 ;; invalid for the underlying filesystem.
5431 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5432 ;; Don't modify remote (ange-ftp) filenames
5433 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
5434 (convert-standard-filename result
)
5437 ;; Deal with buffers that don't have any associated files. (Mail
5438 ;; mode tends to create a good number of these.)
5440 (let ((buffer-name (buffer-name))
5443 ;; Restrict the characters used in the file name to those which
5444 ;; are known to be safe on all filesystems, url-encoding the
5446 ;; We do this on all platforms, because even if we are not
5447 ;; running on DOS/Windows, the current directory may be on a
5448 ;; mounted VFAT filesystem, such as a USB memory stick.
5449 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
5450 (let* ((character (aref buffer-name
(match-beginning 0)))
5452 ;; For multibyte characters, this will produce more than
5453 ;; 2 hex digits, so is not true URL encoding.
5454 (format "%%%02X" character
)))
5455 (setq buffer-name
(replace-match replacement t t buffer-name
))
5456 (setq limit
(1+ (match-end 0)))))
5457 ;; Generate the file name.
5462 (format "#%s#" buffer-name
)
5463 ;; Try a few alternative directories, to get one we can
5466 ((file-writable-p default-directory
) default-directory
)
5467 ((file-writable-p "/var/tmp/") "/var/tmp/")
5469 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
5470 ;; Don't modify remote (ange-ftp) filenames
5471 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
5472 ;; The call to convert-standard-filename is in case
5473 ;; buffer-name includes characters not allowed by the
5474 ;; DOS/Windows filesystems. make-temp-file writes to the
5475 ;; file it creates, so we must fix the file name _before_
5476 ;; make-temp-file is called.
5477 (convert-standard-filename fname
)
5480 ;; make-temp-file creates the file,
5481 ;; but we don't want it to exist until we do an auto-save.
5483 (delete-file file-name
)
5487 (defun auto-save-file-name-p (filename)
5488 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
5489 FILENAME should lack slashes. You can redefine this for customization."
5490 (string-match "^#.*#$" filename
))
5492 (defun wildcard-to-regexp (wildcard)
5493 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
5494 The generated regexp will match a filename only if the filename
5495 matches that wildcard according to shell rules. Only wildcards known
5496 by `sh' are supported."
5497 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
5498 ;; Copy the initial run of non-special characters.
5499 (result (substring wildcard
0 i
))
5500 (len (length wildcard
)))
5501 ;; If no special characters, we're almost done.
5504 (let ((ch (aref wildcard i
))
5512 (eq (aref wildcard
(1+ i
)) ?\
]))
5514 ((eq ch ?\
[) ; [...] maps to regexp char class
5519 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
5522 (if (eq (aref wildcard i
) ?\
])
5527 ((eq (aref wildcard i
) ?^
)
5528 ;; Found "[^". Insert a `\0' character
5529 ;; (which cannot happen in a filename)
5530 ;; into the character class, so that `^'
5531 ;; is not the first character after `[',
5532 ;; and thus non-special in a regexp.
5536 ((eq (aref wildcard i
) ?\
])
5537 ;; I don't think `]' can appear in a
5538 ;; character class in a wildcard, but
5539 ;; let's be general here.
5544 (prog1 ; copy everything upto next `]'.
5547 (setq j
(string-match
5549 (setq i
(if j
(1- j
) (1- len
)))))))
5551 ((eq ch ?
*) "[^\000]*")
5555 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
5556 ((eq ch ??
) "[^\000]")
5557 (t (char-to-string ch
)))))
5559 ;; Shell wildcards should match the entire filename,
5560 ;; not its part. Make the regexp say so.
5561 (concat "\\`" result
"\\'")))
5563 (defcustom list-directory-brief-switches
5565 "Switches for `list-directory' to pass to `ls' for brief listing."
5569 (defcustom list-directory-verbose-switches
5571 "Switches for `list-directory' to pass to `ls' for verbose listing."
5575 (defun file-expand-wildcards (pattern &optional full
)
5576 "Expand wildcard pattern PATTERN.
5577 This returns a list of file names which match the pattern.
5579 If PATTERN is written as an absolute file name,
5580 the values are absolute also.
5582 If PATTERN is written as a relative file name, it is interpreted
5583 relative to the current default directory, `default-directory'.
5584 The file names returned are normally also relative to the current
5585 default directory. However, if FULL is non-nil, they are absolute."
5587 (let* ((nondir (file-name-nondirectory pattern
))
5588 (dirpart (file-name-directory pattern
))
5589 ;; A list of all dirs that DIRPART specifies.
5590 ;; This can be more than one dir
5591 ;; if DIRPART contains wildcards.
5592 (dirs (if (and dirpart
5593 (string-match "[[*?]"
5594 (or (file-remote-p dirpart
'localname
)
5596 (mapcar 'file-name-as-directory
5597 (file-expand-wildcards (directory-file-name dirpart
)))
5601 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
5602 (and (file-directory-p (directory-file-name (car dirs
)))
5603 (file-readable-p (car dirs
))))
5604 (let ((this-dir-contents
5605 ;; Filter out "." and ".."
5607 (mapcar #'(lambda (name)
5608 (unless (string-match "\\`\\.\\.?\\'"
5609 (file-name-nondirectory name
))
5611 (directory-files (or (car dirs
) ".") full
5612 (wildcard-to-regexp nondir
))))))
5615 (if (and (car dirs
) (not full
))
5616 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
5620 (setq dirs
(cdr dirs
)))
5623 ;; Let Tramp know that `file-expand-wildcards' does not need an advice.
5624 (provide 'files
'(remote-wildcards))
5626 (defun list-directory (dirname &optional verbose
)
5627 "Display a list of files in or matching DIRNAME, a la `ls'.
5628 DIRNAME is globbed by the shell if necessary.
5629 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5630 Actions controlled by variables `list-directory-brief-switches'
5631 and `list-directory-verbose-switches'."
5632 (interactive (let ((pfx current-prefix-arg
))
5633 (list (read-directory-name (if pfx
"List directory (verbose): "
5634 "List directory (brief): ")
5635 nil default-directory nil
)
5637 (let ((switches (if verbose list-directory-verbose-switches
5638 list-directory-brief-switches
))
5640 (or dirname
(setq dirname default-directory
))
5641 (setq dirname
(expand-file-name dirname
))
5642 (with-output-to-temp-buffer "*Directory*"
5643 (setq buffer standard-output
)
5644 (buffer-disable-undo standard-output
)
5645 (princ "Directory ")
5648 (with-current-buffer "*Directory*"
5649 (let ((wildcard (not (file-directory-p dirname
))))
5650 (insert-directory dirname switches wildcard
(not wildcard
)))))
5651 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5652 (with-current-buffer buffer
5653 (setq default-directory
5654 (if (file-directory-p dirname
)
5655 (file-name-as-directory dirname
)
5656 (file-name-directory dirname
))))))
5658 (defun shell-quote-wildcard-pattern (pattern)
5659 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5661 PATTERN is assumed to represent a file-name wildcard suitable for the
5662 underlying filesystem. For Unix and GNU/Linux, each character from the
5663 set [ \\t\\n;<>&|()'\"#$] is quoted with a backslash; for DOS/Windows, all
5664 the parts of the pattern which don't include wildcard characters are
5665 quoted with double quotes.
5667 This function leaves alone existing quote characters (\\ on Unix and \"
5668 on Windows), so PATTERN can use them to quote wildcard characters that
5669 need to be passed verbatim to shell commands."
5672 ((memq system-type
'(ms-dos windows-nt cygwin
))
5673 ;; DOS/Windows don't allow `"' in file names. So if the
5674 ;; argument has quotes, we can safely assume it is already
5675 ;; quoted by the caller.
5676 (if (or (string-match "[\"]" pattern
)
5677 ;; We quote [&()#$'] in case their shell is a port of a
5678 ;; Unixy shell. We quote [,=+] because stock DOS and
5679 ;; Windows shells require that in some cases, such as
5680 ;; passing arguments to batch files that use positional
5681 ;; arguments like %1.
5682 (not (string-match "[ \t;&()#$',=+]" pattern
)))
5687 (while (string-match "[*?]+" pattern beg
)
5688 (setq end
(match-beginning 0)
5689 result
(concat result
(substring pattern beg end
)
5691 (substring pattern end
(match-end 0))
5694 (concat result
(substring pattern beg
) "\""))))
5697 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
5699 (concat (substring pattern
0 (match-beginning 0))
5701 (substring pattern
(match-beginning 0)))
5702 beg
(1+ (match-end 0)))))
5706 (defvar insert-directory-program
(purecopy "ls")
5707 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5709 (defcustom directory-free-space-program
(purecopy "df")
5710 "Program to get the amount of free space on a file system.
5711 We assume the output has the format of `df'.
5712 The value of this variable must be just a command name or file name;
5713 if you want to specify options, use `directory-free-space-args'.
5715 A value of nil disables this feature.
5717 If the function `file-system-info' is defined, it is always used in
5718 preference to the program given by this variable."
5719 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
5722 (defcustom directory-free-space-args
5723 (purecopy (if (eq system-type
'darwin
) "-k" "-Pk"))
5724 "Options to use when running `directory-free-space-program'."
5728 (defun get-free-disk-space (dir)
5729 "Return the amount of free space on directory DIR's file system.
5730 The return value is a string describing the amount of free
5731 space (normally, the number of free 1KB blocks).
5733 This function calls `file-system-info' if it is available, or
5734 invokes the program specified by `directory-free-space-program'
5735 and `directory-free-space-args'. If the system call or program
5736 is unsuccessful, or if DIR is a remote directory, this function
5738 (unless (file-remote-p dir
)
5739 ;; Try to find the number of free blocks. Non-Posix systems don't
5740 ;; always have df, but might have an equivalent system call.
5741 (if (fboundp 'file-system-info
)
5742 (let ((fsinfo (file-system-info dir
)))
5744 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
5745 (setq dir
(expand-file-name dir
))
5748 (when (and directory-free-space-program
5749 ;; Avoid failure if the default directory does
5750 ;; not exist (Bug#2631, Bug#3911).
5751 (let ((default-directory "/"))
5752 (eq (call-process directory-free-space-program
5754 directory-free-space-args
5757 ;; Assume that the "available" column is before the
5758 ;; "capacity" column. Find the "%" and scan backward.
5759 (goto-char (point-min))
5761 (when (re-search-forward
5762 "[[:space:]]+[^[:space:]]+%[^%]*$"
5763 (line-end-position) t
)
5764 (goto-char (match-beginning 0))
5765 (let ((endpt (point)))
5766 (skip-chars-backward "^[:space:]")
5767 (buffer-substring-no-properties (point) endpt
)))))))))
5769 ;; The following expression replaces `dired-move-to-filename-regexp'.
5770 (defvar directory-listing-before-filename-regexp
5771 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5772 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5773 ;; In some locales, month abbreviations are as short as 2 letters,
5774 ;; and they can be followed by ".".
5775 ;; In Breton, a month name can include a quote character.
5776 (month (concat l-or-quote l-or-quote
"+\\.?"))
5778 (yyyy "[0-9][0-9][0-9][0-9]")
5780 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5781 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5782 (zone "[-+][0-2][0-9][0-5][0-9]")
5783 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5784 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5785 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5786 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5787 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5789 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5790 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5791 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5792 ;; omits the Kanji characters after month and day-of-month.
5793 ;; On Mac OS X 10.3, the date format in East Asian locales is
5794 ;; day-of-month digits followed by month digits.
5797 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5798 "\\|" dd s mm s
"+" "\\)"
5799 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5800 ;; The "[0-9]" below requires the previous column to end in a digit.
5801 ;; This avoids recognizing `1 may 1997' as a date in the line:
5802 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5804 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5806 ;; For non-iso date formats, we add the ".*" in order to find
5807 ;; the last possible match. This avoids recognizing
5808 ;; `jservice 10 1024' as a date in the line:
5809 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5811 ;; vc dired listings provide the state or blanks between file
5812 ;; permissions and date. The state is always surrounded by
5814 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5815 ;; This is not supported yet.
5816 (purecopy (concat "\\([0-9][BkKMGTPEZY]? " iso
5817 "\\|.*[0-9][BkKMGTPEZY]? "
5818 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\)"
5820 "Regular expression to match up to the file name in a directory listing.
5821 The default value is designed to recognize dates and times
5822 regardless of the language.")
5824 (defvar insert-directory-ls-version
'unknown
)
5827 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5828 ;; FULL-DIRECTORY-P is nil.
5829 ;; The single line of output must display FILE's name as it was
5830 ;; given, namely, an absolute path name.
5831 ;; - must insert exactly one line for each file if WILDCARD or
5832 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5833 ;; before the file lines, plus optional text after the file lines.
5834 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5836 ;; File lines should display the basename.
5837 ;; - must be consistent with
5838 ;; - functions dired-move-to-filename, (these two define what a file line is)
5839 ;; dired-move-to-end-of-filename,
5840 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5841 ;; dired-insert-headerline
5842 ;; dired-after-subdir-garbage (defines what a "total" line is)
5843 ;; - variable dired-subdir-regexp
5844 ;; - may be passed "--dired" as the first argument in SWITCHES.
5845 ;; Filename handlers might have to remove this switch if their
5846 ;; "ls" command does not support it.
5847 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
5848 "Insert directory listing for FILE, formatted according to SWITCHES.
5849 Leaves point after the inserted text.
5850 SWITCHES may be a string of options, or a list of strings
5851 representing individual options.
5852 Optional third arg WILDCARD means treat FILE as shell wildcard.
5853 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5854 switches do not contain `d', so that a full listing is expected.
5856 This works by running a directory listing program
5857 whose name is in the variable `insert-directory-program'.
5858 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5860 When SWITCHES contains the long `--dired' option, this function
5861 treats it specially, for the sake of dired. However, the
5862 normally equivalent short `-D' option is just passed on to
5863 `insert-directory-program', as any other option."
5864 ;; We need the directory in order to find the right handler.
5865 (let ((handler (find-file-name-handler (expand-file-name file
)
5866 'insert-directory
)))
5868 (funcall handler
'insert-directory file switches
5869 wildcard full-directory-p
)
5870 (let (result (beg (point)))
5872 ;; Read the actual directory using `insert-directory-program'.
5873 ;; RESULT gets the status code.
5874 (let* (;; We at first read by no-conversion, then after
5875 ;; putting text property `dired-filename, decode one
5876 ;; bunch by one to preserve that property.
5877 (coding-system-for-read 'no-conversion
)
5878 ;; This is to control encoding the arguments in call-process.
5879 (coding-system-for-write
5880 (and enable-multibyte-characters
5881 (or file-name-coding-system
5882 default-file-name-coding-system
))))
5885 ;; Run ls in the directory part of the file pattern
5886 ;; using the last component as argument.
5887 (let ((default-directory
5888 (if (file-name-absolute-p file
)
5889 (file-name-directory file
)
5890 (file-name-directory (expand-file-name file
))))
5891 (pattern (file-name-nondirectory file
)))
5892 ;; NB since switches is passed to the shell, be
5893 ;; careful of malicious values, eg "-l;reboot".
5894 ;; See eg dired-safe-switches-p.
5896 shell-file-name nil t nil
5898 (concat (if (memq system-type
'(ms-dos windows-nt
))
5900 "\\") ; Disregard Unix shell aliases!
5901 insert-directory-program
5903 (if (stringp switches
)
5905 (mapconcat 'identity switches
" "))
5907 ;; Quote some characters that have
5908 ;; special meanings in shells; but
5909 ;; don't quote the wildcards--we want
5910 ;; them to be special. We also
5911 ;; currently don't quote the quoting
5912 ;; characters in case people want to
5913 ;; use them explicitly to quote
5914 ;; wildcard characters.
5915 (shell-quote-wildcard-pattern pattern
))))
5916 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5917 ;; directory if FILE is a symbolic link.
5918 (unless full-directory-p
5920 (if (stringp switches
)
5921 (concat switches
" -d")
5922 (add-to-list 'switches
"-d" 'append
))))
5923 (apply 'call-process
5924 insert-directory-program nil t nil
5926 (if (listp switches
) switches
5927 (unless (equal switches
"")
5928 ;; Split the switches at any spaces so we can
5929 ;; pass separate options as separate args.
5930 (split-string switches
)))
5931 ;; Avoid lossage if FILE starts with `-'.
5934 (if (string-match "\\`~" file
)
5935 (setq file
(expand-file-name file
)))
5937 (if full-directory-p
5938 (concat (file-name-as-directory file
) ".")
5941 ;; If we got "//DIRED//" in the output, it means we got a real
5942 ;; directory listing, even if `ls' returned nonzero.
5943 ;; So ignore any errors.
5944 (when (if (stringp switches
)
5945 (string-match "--dired\\>" switches
)
5946 (member "--dired" switches
))
5949 (when (looking-at "//SUBDIRED//")
5951 (if (looking-at "//DIRED//")
5954 (when (and (not (eq 0 result
))
5955 (eq insert-directory-ls-version
'unknown
))
5956 ;; The first time ls returns an error,
5957 ;; find the version numbers of ls,
5958 ;; and set insert-directory-ls-version
5959 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5960 ;; is equal or if the info cannot be obtained.
5961 ;; (That can mean it isn't GNU ls.)
5964 (call-process "ls" nil t nil
"--version")
5966 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
5967 (let* ((version (match-string 1 version-out
))
5968 (split (split-string version
"[.]"))
5969 (numbers (mapcar 'string-to-number split
))
5972 (while (and (not comparison
) (or numbers min
))
5974 (setq comparison
'>))
5976 (setq comparison
'<))
5977 ((> (car numbers
) (car min
))
5978 (setq comparison
'>))
5979 ((< (car numbers
) (car min
))
5980 (setq comparison
'<))
5982 (setq numbers
(cdr numbers
)
5984 (setq insert-directory-ls-version
(or comparison
'=)))
5985 (setq insert-directory-ls-version nil
))))
5987 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5988 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
5991 ;; If `insert-directory-program' failed, signal an error.
5992 (unless (eq 0 result
)
5993 ;; Delete the error message it may have output.
5994 (delete-region beg
(point))
5995 ;; On non-Posix systems, we cannot open a directory, so
5996 ;; don't even try, because that will always result in
5997 ;; the ubiquitous "Access denied". Instead, show the
5998 ;; command line so the user can try to guess what went wrong.
5999 (if (and (file-directory-p file
)
6000 (memq system-type
'(ms-dos windows-nt
)))
6002 "Reading directory: \"%s %s -- %s\" exited with status %s"
6003 insert-directory-program
6004 (if (listp switches
) (concat switches
) switches
)
6006 ;; Unix. Access the file to get a suitable error.
6007 (access-file file
"Reading directory")
6008 (error "Listing directory failed but `access-file' worked")))
6010 (when (if (stringp switches
)
6011 (string-match "--dired\\>" switches
)
6012 (member "--dired" switches
))
6013 ;; The following overshoots by one line for an empty
6014 ;; directory listed with "--dired", but without "-a"
6015 ;; switch, where the ls output contains a
6016 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
6017 ;; We take care of that case later.
6019 (when (looking-at "//SUBDIRED//")
6020 (delete-region (point) (progn (forward-line 1) (point)))
6022 (if (looking-at "//DIRED//")
6023 (let ((end (line-end-position))
6026 ;; Find all the lines that are error messages,
6027 ;; and record the bounds of each one.
6029 (while (< (point) linebeg
)
6030 (or (eql (following-char) ?\s
)
6031 (push (list (point) (line-end-position)) error-lines
))
6033 (setq error-lines
(nreverse error-lines
))
6034 ;; Now read the numeric positions of file names.
6038 (while (< (point) end
)
6039 (let ((start (insert-directory-adj-pos
6040 (+ beg
(read (current-buffer)))
6042 (end (insert-directory-adj-pos
6043 (+ beg
(read (current-buffer)))
6045 (if (memq (char-after end
) '(?
\n ?\s
))
6046 ;; End is followed by \n or by " -> ".
6047 (put-text-property start end
'dired-filename t
)
6048 ;; It seems that we can't trust ls's output as to
6049 ;; byte positions of filenames.
6050 (put-text-property beg
(point) 'dired-filename nil
)
6054 (delete-region (point) (progn (forward-line 1) (point))))
6055 ;; Take care of the case where the ls output contains a
6056 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
6057 ;; and we went one line too far back (see above).
6059 (if (looking-at "//DIRED-OPTIONS//")
6060 (delete-region (point) (progn (forward-line 1) (point)))))
6062 ;; Now decode what read if necessary.
6063 (let ((coding (or coding-system-for-read
6064 file-name-coding-system
6065 default-file-name-coding-system
6069 (when (and enable-multibyte-characters
6070 (not (memq (coding-system-base coding
)
6071 '(raw-text no-conversion
))))
6072 ;; If no coding system is specified or detection is
6073 ;; requested, detect the coding.
6074 (if (eq (coding-system-base coding
) 'undecided
)
6075 (setq coding
(detect-coding-region beg
(point) t
)))
6076 (if (not (eq (coding-system-base coding
) 'undecided
))
6079 (coding-system-change-eol-conversion coding
'unix
))
6080 (narrow-to-region beg
(point))
6081 (goto-char (point-min))
6084 val
(get-text-property (point) 'dired-filename
))
6085 (goto-char (next-single-property-change
6086 (point) 'dired-filename nil
(point-max)))
6087 ;; Force no eol conversion on a file name, so
6088 ;; that CR is preserved.
6089 (decode-coding-region pos
(point)
6090 (if val coding-no-eol coding
))
6092 (put-text-property pos
(point)
6093 'dired-filename t
)))))))
6095 (if full-directory-p
6096 ;; Try to insert the amount of free space.
6099 ;; First find the line to put it on.
6100 (when (re-search-forward "^ *\\(total\\)" nil t
)
6101 (let ((available (get-free-disk-space ".")))
6103 ;; Replace "total" with "used", to avoid confusion.
6104 (replace-match "total used in directory" nil nil nil
1)
6106 (insert " available " available
))))))))))
6108 (defun insert-directory-adj-pos (pos error-lines
)
6109 "Convert `ls --dired' file name position value POS to a buffer position.
6110 File name position values returned in ls --dired output
6111 count only stdout; they don't count the error messages sent to stderr.
6112 So this function converts to them to real buffer positions.
6113 ERROR-LINES is a list of buffer positions of error message lines,
6114 of the form (START END)."
6115 (while (and error-lines
(< (caar error-lines
) pos
))
6116 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
6120 (defun insert-directory-safely (file switches
6121 &optional wildcard full-directory-p
)
6122 "Insert directory listing for FILE, formatted according to SWITCHES.
6124 Like `insert-directory', but if FILE does not exist, it inserts a
6125 message to that effect instead of signaling an error."
6126 (if (file-exists-p file
)
6127 (insert-directory file switches wildcard full-directory-p
)
6128 ;; Simulate the message printed by `ls'.
6129 (insert (format "%s: No such file or directory\n" file
))))
6131 (defvar kill-emacs-query-functions nil
6132 "Functions to call with no arguments to query about killing Emacs.
6133 If any of these functions returns nil, killing Emacs is canceled.
6134 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
6135 the low level primitive, does not. See also `kill-emacs-hook'.")
6137 (defcustom confirm-kill-emacs nil
6138 "How to ask for confirmation when leaving Emacs.
6139 If nil, the default, don't ask at all. If the value is non-nil, it should
6140 be a predicate function such as `yes-or-no-p'."
6141 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
6142 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
6143 (const :tag
"Don't confirm" nil
))
6147 (defun save-buffers-kill-emacs (&optional arg
)
6148 "Offer to save each buffer, then kill this Emacs process.
6149 With prefix ARG, silently save all file-visiting buffers, then kill."
6151 (save-some-buffers arg t
)
6152 (and (or (not (memq t
(mapcar (function
6153 (lambda (buf) (and (buffer-file-name buf
)
6154 (buffer-modified-p buf
))))
6156 (yes-or-no-p "Modified buffers exist; exit anyway? "))
6157 (or (not (fboundp 'process-list
))
6158 ;; process-list is not defined on MSDOS.
6159 (let ((processes (process-list))
6162 (and (memq (process-status (car processes
)) '(run stop open listen
))
6163 (process-query-on-exit-flag (car processes
))
6165 (setq processes
(cdr processes
)))
6167 (progn (list-processes t
)
6168 (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))))
6169 ;; Query the user for other things, perhaps.
6170 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
6171 (or (null confirm-kill-emacs
)
6172 (funcall confirm-kill-emacs
"Really exit Emacs? "))
6175 (defun save-buffers-kill-terminal (&optional arg
)
6176 "Offer to save each buffer, then kill the current connection.
6177 If the current frame has no client, kill Emacs itself.
6179 With prefix ARG, silently save all file-visiting buffers, then kill.
6181 If emacsclient was started with a list of filenames to edit, then
6182 only these files will be asked to be saved."
6184 (if (frame-parameter (selected-frame) 'client
)
6185 (server-save-buffers-kill-terminal arg
)
6186 (save-buffers-kill-emacs arg
)))
6188 ;; We use /: as a prefix to "quote" a file name
6189 ;; so that magic file name handlers will not apply to it.
6191 (setq file-name-handler-alist
6192 (cons (cons (purecopy "\\`/:") 'file-name-non-special
)
6193 file-name-handler-alist
))
6195 ;; We depend on being the last handler on the list,
6196 ;; so that anything else which does need handling
6197 ;; has been handled already.
6198 ;; So it is safe for us to inhibit *all* magic file name handlers.
6200 (defun file-name-non-special (operation &rest arguments
)
6201 (let ((file-name-handler-alist nil
)
6203 (if (eq operation
'insert-directory
)
6204 (directory-file-name
6206 (unhandled-file-name-directory default-directory
)))
6208 ;; Get a list of the indices of the args which are file names.
6210 (cdr (or (assq operation
6211 ;; The first six are special because they
6212 ;; return a file name. We want to include the /:
6213 ;; in the return value.
6214 ;; So just avoid stripping it in the first place.
6215 '((expand-file-name . nil
)
6216 (file-name-directory . nil
)
6217 (file-name-as-directory . nil
)
6218 (directory-file-name . nil
)
6219 (file-name-sans-versions . nil
)
6220 (find-backup-file-name . nil
)
6221 ;; `identity' means just return the first arg
6222 ;; not stripped of its quoting.
6223 (substitute-in-file-name identity
)
6224 ;; `add' means add "/:" to the result.
6225 (file-truename add
0)
6226 (insert-file-contents insert-file-contents
0)
6227 ;; `unquote-then-quote' means set buffer-file-name
6228 ;; temporarily to unquoted filename.
6229 (verify-visited-file-modtime unquote-then-quote
)
6230 ;; List the arguments which are filenames.
6231 (file-name-completion 1)
6232 (file-name-all-completions 1)
6236 (make-symbolic-link 0 1)
6237 (add-name-to-file 0 1)))
6238 ;; For all other operations, treat the first argument only
6239 ;; as the file name.
6242 ;; Copy ARGUMENTS so we can replace elements in it.
6243 (arguments (copy-sequence arguments
)))
6244 (if (symbolp (car file-arg-indices
))
6245 (setq method
(pop file-arg-indices
)))
6246 ;; Strip off the /: from the file names that have it.
6248 (while (consp file-arg-indices
)
6249 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
6251 (string-match "\\`/:" (car pair
))
6253 (if (= (length (car pair
)) 2)
6255 (substring (car pair
) 2)))))
6256 (setq file-arg-indices
(cdr file-arg-indices
))))
6258 (identity (car arguments
))
6259 (add (concat "/:" (apply operation arguments
)))
6260 (insert-file-contents
6261 (let ((visit (nth 1 arguments
)))
6263 (apply operation arguments
)
6264 (when (and visit buffer-file-name
)
6265 (setq buffer-file-name
(concat "/:" buffer-file-name
))))))
6267 (let ((buffer-file-name (substring buffer-file-name
2)))
6268 (apply operation arguments
)))
6270 (apply operation arguments
)))))
6272 ;; Symbolic modes and read-file-modes.
6274 (defun file-modes-char-to-who (char)
6275 "Convert CHAR to a numeric bit-mask for extracting mode bits.
6276 CHAR is in [ugoa] and represents the category of users (Owner, Group,
6277 Others, or All) for whom to produce the mask.
6278 The bit-mask that is returned extracts from mode bits the access rights
6279 for the specified category of users."
6280 (cond ((= char ?u
) #o4700
)
6281 ((= char ?g
) #o2070
)
6282 ((= char ?o
) #o1007
)
6283 ((= char ?a
) #o7777
)
6284 (t (error "%c: bad `who' character" char
))))
6286 (defun file-modes-char-to-right (char &optional from
)
6287 "Convert CHAR to a numeric value of mode bits.
6288 CHAR is in [rwxXstugo] and represents symbolic access permissions.
6289 If CHAR is in [Xugo], the value is taken from FROM (or 0 if omitted)."
6290 (or from
(setq from
0))
6291 (cond ((= char ?r
) #o0444
)
6292 ((= char ?w
) #o0222
)
6293 ((= char ?x
) #o0111
)
6294 ((= char ?s
) #o1000
)
6295 ((= char ?t
) #o6000
)
6296 ;; Rights relative to the previous file modes.
6297 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
6298 ((= char ?u
) (let ((uright (logand #o4700 from
)))
6299 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
6300 ((= char ?g
) (let ((gright (logand #o2070 from
)))
6301 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
6302 ((= char ?o
) (let ((oright (logand #o1007 from
)))
6303 (+ oright
(* oright
#o10
) (* oright
#o100
))))
6304 (t (error "%c: bad right character" char
))))
6306 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
6307 "Convert a symbolic mode string specification to an equivalent number.
6308 RIGHTS is the symbolic mode spec, it should match \"([+=-][rwxXstugo]*)+\".
6309 WHO-MASK is the bit-mask specifying the category of users to which to
6310 apply the access permissions. See `file-modes-char-to-who'.
6311 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6312 RIGHTS request to add, remove, or set permissions based on existing ones,
6314 (let* ((num-rights (or from
0))
6315 (list-rights (string-to-list rights
))
6316 (op (pop list-rights
)))
6317 (while (memq op
'(?
+ ?- ?
=))
6320 (while (memq (setq char-right
(pop list-rights
))
6321 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
6324 (file-modes-char-to-right char-right num-rights
))))
6325 (setq num-right
(logand who-mask num-right
)
6327 (cond ((= op ?
+) (logior num-rights num-right
))
6328 ((= op ?-
) (logand num-rights
(lognot num-right
)))
6329 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
6333 (defun file-modes-symbolic-to-number (modes &optional from
)
6334 "Convert symbolic file modes to numeric file modes.
6335 MODES is the string to convert, it should match
6336 \"[ugoa]*([+-=][rwxXstugo]*)+,...\".
6337 See Info node `(coreutils)File permissions' for more information on this
6339 FROM (or 0 if nil) gives the mode bits on which to base permissions if
6340 MODES request to add, remove, or set permissions based on existing ones,
6343 (let ((case-fold-search nil
)
6344 (num-modes (or from
0)))
6345 (while (/= (string-to-char modes
) 0)
6346 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]*\\)+\\(,\\|\\)" modes
)
6347 (let ((num-who (apply 'logior
0
6348 (mapcar 'file-modes-char-to-who
6349 (match-string 1 modes
)))))
6351 (setq num-who
(default-file-modes)))
6353 (file-modes-rights-to-number (substring modes
(match-end 1))
6355 modes
(substring modes
(match-end 3))))
6356 (error "Parse error in modes near `%s'" (substring modes
0))))
6359 (defun read-file-modes (&optional prompt orig-file
)
6360 "Read file modes in octal or symbolic notation and return its numeric value.
6361 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
6362 ORIG-FILE is the name of a file on whose mode bits to base returned
6363 permissions if what user types requests to add, remove, or set permissions
6364 based on existing mode bits, as in \"og+rX-w\"."
6365 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
6366 (error "File not found")))
6367 (modestr (and (stringp orig-file
)
6368 (nth 8 (file-attributes orig-file
))))
6370 (and (stringp modestr
)
6371 (string-match "^.\\(...\\)\\(...\\)\\(...\\)$" modestr
)
6372 (replace-regexp-in-string
6374 (format "u=%s,g=%s,o=%s"
6375 (match-string 1 modestr
)
6376 (match-string 2 modestr
)
6377 (match-string 3 modestr
)))))
6378 (value (read-string (or prompt
"File modes (octal or symbolic): ")
6381 (if (string-match "^[0-7]+" value
)
6382 (string-to-number value
8)
6383 (file-modes-symbolic-to-number value modes
)))))
6386 ;; Trashcan handling.
6387 (defcustom trash-directory nil
6388 "Directory for `move-file-to-trash' to move files and directories to.
6389 This directory is only used when the function `system-move-file-to-trash'
6391 Relative paths are interpreted relative to `default-directory'.
6392 If the value is nil, Emacs uses a freedesktop.org-style trashcan."
6393 :type
'(choice (const nil
) directory
)
6397 (defvar trash--hexify-table
)
6399 (declare-function system-move-file-to-trash
"w32fns.c" (filename))
6401 (defun move-file-to-trash (filename)
6402 "Move the file (or directory) named FILENAME to the trash.
6403 When `delete-by-moving-to-trash' is non-nil, this function is
6404 called by `delete-file' and `delete-directory' instead of
6405 deleting files outright.
6407 If the function `system-move-file-to-trash' is defined, call it
6408 with FILENAME as an argument.
6409 Otherwise, if `trash-directory' is non-nil, move FILENAME to that
6411 Otherwise, trash FILENAME using the freedesktop.org conventions,
6412 like the GNOME, KDE and XFCE desktop environments. Emacs only
6413 moves files to \"home trash\", ignoring per-volume trashcans."
6414 (interactive "fMove file to trash: ")
6415 (cond (trash-directory
6416 ;; If `trash-directory' is non-nil, move the file there.
6417 (let* ((trash-dir (expand-file-name trash-directory
))
6418 (fn (directory-file-name (expand-file-name filename
)))
6419 (new-fn (expand-file-name (file-name-nondirectory fn
)
6421 ;; We can't trash a parent directory of trash-directory.
6422 (if (string-match fn trash-dir
)
6423 (error "Trash directory `%s' is a subdirectory of `%s'"
6424 trash-dir filename
))
6425 (unless (file-directory-p trash-dir
)
6426 (make-directory trash-dir t
))
6427 ;; Ensure that the trashed file-name is unique.
6428 (if (file-exists-p new-fn
)
6429 (let ((version-control t
)
6430 (backup-directory-alist nil
))
6431 (setq new-fn
(car (find-backup-file-name new-fn
)))))
6432 (let (delete-by-moving-to-trash)
6433 (rename-file fn new-fn
))))
6434 ;; If `system-move-file-to-trash' is defined, use it.
6435 ((fboundp 'system-move-file-to-trash
)
6436 (system-move-file-to-trash filename
))
6437 ;; Otherwise, use the freedesktop.org method, as specified at
6438 ;; http://freedesktop.org/wiki/Specifications/trash-spec
6440 (let* ((xdg-data-dir
6441 (directory-file-name
6442 (expand-file-name "Trash"
6443 (or (getenv "XDG_DATA_HOME")
6444 "~/.local/share"))))
6445 (trash-files-dir (expand-file-name "files" xdg-data-dir
))
6446 (trash-info-dir (expand-file-name "info" xdg-data-dir
))
6447 (fn (directory-file-name (expand-file-name filename
))))
6449 ;; Check if we have permissions to delete.
6450 (unless (file-writable-p (directory-file-name
6451 (file-name-directory fn
)))
6452 (error "Cannot move %s to trash: Permission denied" filename
))
6453 ;; The trashed file cannot be the trash dir or its parent.
6454 (if (string-match fn trash-files-dir
)
6455 (error "The trash directory %s is a subdirectory of %s"
6456 trash-files-dir filename
))
6457 (if (string-match fn trash-info-dir
)
6458 (error "The trash directory %s is a subdirectory of %s"
6459 trash-info-dir filename
))
6461 ;; Ensure that the trash directory exists; otherwise, create it.
6462 (let ((saved-default-file-modes (default-file-modes)))
6465 (set-default-file-modes #o700
)
6466 (unless (file-exists-p trash-files-dir
)
6467 (make-directory trash-files-dir t
))
6468 (unless (file-exists-p trash-info-dir
)
6469 (make-directory trash-info-dir t
)))
6470 (set-default-file-modes saved-default-file-modes
)))
6472 ;; Try to move to trash with .trashinfo undo information
6475 (set-buffer-file-coding-system 'utf-8-unix
)
6476 (insert "[Trash Info]\nPath=")
6477 ;; Perform url-encoding on FN. For compatibility with
6478 ;; other programs (e.g. XFCE Thunar), allow literal "/"
6479 ;; for path separators.
6480 (unless (boundp 'trash--hexify-table
)
6481 (setq trash--hexify-table
(make-vector 256 nil
))
6482 (let ((unreserved-chars
6483 (list ?
/ ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m
6484 ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z ?A
6485 ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O
6486 ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z ?
0 ?
1 ?
2
6487 ?
3 ?
4 ?
5 ?
6 ?
7 ?
8 ?
9 ?- ?_ ?. ?
! ?~ ?
* ?
'
6490 (aset trash--hexify-table byte
6491 (if (memq byte unreserved-chars
)
6492 (char-to-string byte
)
6493 (format "%%%02x" byte
))))))
6494 (mapc (lambda (byte)
6495 (insert (aref trash--hexify-table byte
)))
6496 (if (multibyte-string-p fn
)
6497 (encode-coding-string fn
'utf-8
)
6499 (insert "\nDeletionDate="
6500 (format-time-string "%Y-%m-%dT%T")
6503 ;; Attempt to make .trashinfo file, trying up to 5
6504 ;; times. The .trashinfo file is opened with O_EXCL,
6505 ;; as per trash-spec 0.7, even if that can be a problem
6506 ;; on old NFS versions...
6508 (base-fn (expand-file-name
6509 (file-name-nondirectory fn
)
6514 (setq info-fn
(expand-file-name
6515 (concat (file-name-nondirectory new-fn
)
6518 (unless (condition-case nil
6520 (write-region nil nil info-fn nil
6521 'quiet info-fn
'excl
)
6522 (setq tries
0 success t
))
6523 (file-already-exists nil
))
6524 (setq tries
(1- tries
))
6525 ;; Uniquify new-fn. (Some file managers do not
6526 ;; like Emacs-style backup file names---e.g. bug
6527 ;; 170956 in Konqueror bug tracker.)
6528 (setq new-fn
(make-temp-name (concat base-fn
"_")))))
6530 (error "Cannot move %s to trash: Lock failed" filename
))
6532 ;; Finally, try to move the file to the trashcan.
6533 (let ((delete-by-moving-to-trash nil
))
6534 (rename-file fn new-fn
)))))))))
6537 (define-key ctl-x-map
"\C-f" 'find-file
)
6538 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
6539 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
6540 (define-key ctl-x-map
"\C-s" 'save-buffer
)
6541 (define-key ctl-x-map
"s" 'save-some-buffers
)
6542 (define-key ctl-x-map
"\C-w" 'write-file
)
6543 (define-key ctl-x-map
"i" 'insert-file
)
6544 (define-key esc-map
"~" 'not-modified
)
6545 (define-key ctl-x-map
"\C-d" 'list-directory
)
6546 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
6547 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
6549 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
6550 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
6551 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
6552 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
6553 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
6555 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
6556 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
6557 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
6558 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
6559 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
6561 ;;; files.el ends here