1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
5 ;; 2006, 2007, 2008 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; Defines most of Emacs's file- and directory-handling functions,
29 ;; including basic file visiting, backup generation, link handling,
30 ;; ITS-id version control, load- and write-hook handling, and the like.
34 (defvar font-lock-keywords
)
38 "Backups of edited data files."
41 (defgroup find-file nil
46 (defcustom delete-auto-save-files t
47 "Non-nil means delete auto-save file when a buffer is saved or killed.
49 Note that the auto-save file will not be deleted if the buffer is killed
50 when it has unsaved changes."
54 (defcustom directory-abbrev-alist
56 "Alist of abbreviations for file directories.
57 A list of elements of the form (FROM . TO), each meaning to replace
58 FROM with TO when it appears in a directory name. This replacement is
59 done when setting up the default directory of a newly visited file.
60 *Every* FROM string should start with `^'.
62 FROM and TO should be equivalent names, which refer to the
63 same directory. Do not use `~' in the TO strings;
64 they should be ordinary absolute directory names.
66 Use this feature when you have directories which you normally refer to
67 via absolute symbolic links. Make TO the name of the link, and FROM
68 the name it is linked to."
69 :type
'(repeat (cons :format
"%v"
76 ;; Turn off backup files on VMS since it has version numbers.
77 (defcustom make-backup-files
(not (eq system-type
'vax-vms
))
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 nil
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 (defcustom backup-by-copying-when-privileged-mismatch
200
130 "Non-nil means create backups by copying to preserve a privileged owner.
131 Renaming may still be used (subject to control of other variables)
132 when it would not result in changing the owner of the file or if the owner
133 has a user id greater than the value of this variable. This is useful
134 when low-numbered uid's are used for special system users (such as root)
135 that must maintain ownership of certain files.
136 This variable is relevant only if `backup-by-copying' and
137 `backup-by-copying-when-mismatch' are nil."
138 :type
'(choice (const nil
) integer
)
141 (defvar backup-enable-predicate
'normal-backup-enable-predicate
142 "Predicate that looks at a file name and decides whether to make backups.
143 Called with an absolute file name as argument, it returns t to enable backup.")
145 (defcustom buffer-offer-save nil
146 "Non-nil in a buffer means always offer to save buffer on exit.
147 Do so even if the buffer is not visiting a file.
148 Automatically local in all buffers."
151 (make-variable-buffer-local 'buffer-offer-save
)
153 (defcustom find-file-existing-other-name t
154 "Non-nil means find a file under alternative names, in existing buffers.
155 This means if any existing buffer is visiting the file you want
156 under another name, you get the existing buffer instead of a new buffer."
160 (defcustom find-file-visit-truename nil
161 "*Non-nil means visit a file under its truename.
162 The truename of a file is found by chasing all links
163 both at the file level and at the levels of the containing directories."
166 (put 'find-file-visit-truename
'safe-local-variable
'booleanp
)
168 (defcustom revert-without-query nil
169 "Specify which files should be reverted without query.
170 The value is a list of regular expressions.
171 If the file name matches one of these regular expressions,
172 then `revert-buffer' reverts the file without querying
173 if the file has changed on disk and you have not edited the buffer."
174 :type
'(repeat regexp
)
177 (defvar buffer-file-number nil
178 "The device number and file number of the file visited in the current buffer.
179 The value is a list of the form (FILENUM DEVNUM).
180 This pair of numbers uniquely identifies the file.
181 If the buffer is visiting a new file, the value is nil.")
182 (make-variable-buffer-local 'buffer-file-number
)
183 (put 'buffer-file-number
'permanent-local t
)
185 (defvar buffer-file-numbers-unique
(not (memq system-type
'(windows-nt)))
186 "Non-nil means that `buffer-file-number' uniquely identifies files.")
188 (defvar buffer-file-read-only nil
189 "Non-nil if visited file was read-only when visited.")
190 (make-variable-buffer-local 'buffer-file-read-only
)
192 (defcustom temporary-file-directory
193 (file-name-as-directory
194 (cond ((memq system-type
'(ms-dos windows-nt
))
195 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
196 ((memq system-type
'(vax-vms axp-vms
))
197 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
199 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
200 "The directory for writing temporary files."
204 (defcustom small-temporary-file-directory
205 (if (eq system-type
'ms-dos
) (getenv "TMPDIR"))
206 "The directory for writing small temporary files.
207 If non-nil, this directory is used instead of `temporary-file-directory'
208 by programs that create small temporary files. This is for systems that
209 have fast storage with limited space, such as a RAM disk."
211 :type
'(choice (const nil
) directory
))
213 ;; The system null device. (Should reference NULL_DEVICE from C.)
214 (defvar null-device
"/dev/null" "The system null device.")
216 (declare-function msdos-long-file-names
"msdos.c")
217 (declare-function w32-long-file-name
"w32proc.c")
218 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
219 (declare-function dired-unmark
"dired" (arg))
220 (declare-function dired-do-flagged-delete
"dired" (&optional nomessage
))
221 (declare-function dos-8
+3-filename
"dos-fns" (filename))
222 (declare-function vms-read-directory
"vms-patch" (dirname switches buffer
))
223 (declare-function view-mode-disable
"view" ())
225 (defvar file-name-invalid-regexp
226 (cond ((and (eq system-type
'ms-dos
) (not (msdos-long-file-names)))
227 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
228 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
229 "[\000-\037]\\|" ; control characters
230 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
231 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
232 ((memq system-type
'(ms-dos windows-nt cygwin
))
233 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
234 "[|<>\"?*\000-\037]")) ; invalid characters
236 "Regexp recognizing file names which aren't allowed by the filesystem.")
238 (defcustom file-precious-flag nil
239 "Non-nil means protect against I/O errors while saving files.
240 Some modes set this non-nil in particular buffers.
242 This feature works by writing the new contents into a temporary file
243 and then renaming the temporary file to replace the original.
244 In this way, any I/O error in writing leaves the original untouched,
245 and there is never any instant where the file is nonexistent.
247 Note that this feature forces backups to be made by copying.
248 Yet, at the same time, saving a precious file
249 breaks any hard links between it and other files."
253 (defcustom version-control nil
254 "Control use of version numbers for backup files.
255 When t, make numeric backup versions unconditionally.
256 When nil, make them for files that have some already.
257 The value `never' means do not make them."
258 :type
'(choice (const :tag
"Never" never
)
259 (const :tag
"If existing" nil
)
260 (other :tag
"Always" t
))
263 (put 'version-control
'safe-local-variable
264 '(lambda (x) (or (booleanp x
) (equal x
'never
))))
266 (defcustom dired-kept-versions
2
267 "When cleaning directory, number of versions to keep."
272 (defcustom delete-old-versions nil
273 "If t, delete excess backup versions silently.
274 If nil, ask confirmation. Any other value prevents any trimming."
275 :type
'(choice (const :tag
"Delete" t
)
276 (const :tag
"Ask" nil
)
277 (other :tag
"Leave" other
))
280 (defcustom kept-old-versions
2
281 "Number of oldest versions to keep when a new numbered backup is made."
284 (put 'kept-old-versions
'safe-local-variable
'integerp
)
286 (defcustom kept-new-versions
2
287 "Number of newest versions to keep when a new numbered backup is made.
288 Includes the new backup. Must be > 0"
291 (put 'kept-new-versions
'safe-local-variable
'integerp
)
293 (defcustom require-final-newline nil
294 "Whether to add a newline automatically at the end of the file.
296 A value of t means do this only when the file is about to be saved.
297 A value of `visit' means do this right after the file is visited.
298 A value of `visit-save' means do it at both of those times.
299 Any other non-nil value means ask user whether to add a newline, when saving.
300 A value of nil means don't add newlines.
302 Certain major modes set this locally to the value obtained
303 from `mode-require-final-newline'."
304 :type
'(choice (const :tag
"When visiting" visit
)
305 (const :tag
"When saving" t
)
306 (const :tag
"When visiting or saving" visit-save
)
307 (const :tag
"Don't add newlines" nil
)
308 (other :tag
"Ask each time" ask
))
309 :group
'editing-basics
)
311 (defcustom mode-require-final-newline t
312 "Whether to add a newline at end of file, in certain major modes.
313 Those modes set `require-final-newline' to this value when you enable them.
314 They do so because they are often used for files that are supposed
315 to end in newlines, and the question is how to arrange that.
317 A value of t means do this only when the file is about to be saved.
318 A value of `visit' means do this right after the file is visited.
319 A value of `visit-save' means do it at both of those times.
320 Any other non-nil value means ask user whether to add a newline, when saving.
322 A value of nil means do not add newlines. That is a risky choice in this
323 variable since this value is used for modes for files that ought to have
324 final newlines. So if you set this to nil, you must explicitly check and
325 add a final newline, whenever you save a file that really needs one."
326 :type
'(choice (const :tag
"When visiting" visit
)
327 (const :tag
"When saving" t
)
328 (const :tag
"When visiting or saving" visit-save
)
329 (const :tag
"Don't add newlines" nil
)
330 (other :tag
"Ask each time" ask
))
331 :group
'editing-basics
334 (defcustom auto-save-default t
335 "Non-nil says by default do auto-saving of every file-visiting buffer."
339 (defcustom auto-save-visited-file-name nil
340 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
341 Normally auto-save files are written under other names."
345 (defcustom auto-save-file-name-transforms
346 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
347 ;; Don't put "\\2" inside expand-file-name, since it will be
348 ;; transformed to "/2" on DOS/Windows.
349 ,(concat temporary-file-directory
"\\2") t
))
350 "Transforms to apply to buffer file name before making auto-save file name.
351 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
352 REGEXP is a regular expression to match against the file name.
353 If it matches, `replace-match' is used to replace the
354 matching part with REPLACEMENT.
355 If the optional element UNIQUIFY is non-nil, the auto-save file name is
356 constructed by taking the directory part of the replaced file-name,
357 concatenated with the buffer file name with all directory separators
358 changed to `!' to prevent clashes. This will not work
359 correctly if your filesystem truncates the resulting name.
361 All the transforms in the list are tried, in the order they are listed.
362 When one transform applies, its result is final;
363 no further transforms are tried.
365 The default value is set up to put the auto-save file into the
366 temporary directory (see the variable `temporary-file-directory') for
367 editing a remote file.
369 On MS-DOS filesystems without long names this variable is always
372 :type
'(repeat (list (string :tag
"Regexp") (string :tag
"Replacement")
373 (boolean :tag
"Uniquify")))
376 (defcustom save-abbrevs t
377 "Non-nil means save word abbrevs too when files are saved.
378 If `silently', don't ask the user before saving."
379 :type
'(choice (const t
) (const nil
) (const silently
))
382 (defcustom find-file-run-dired t
383 "Non-nil means allow `find-file' to visit directories.
384 To visit the directory, `find-file' runs `find-directory-functions'."
388 (defcustom find-directory-functions
'(cvs-dired-noselect dired-noselect
)
389 "List of functions to try in sequence to visit a directory.
390 Each function is called with the directory name as the sole argument
391 and should return either a buffer or nil."
392 :type
'(hook :options
(cvs-dired-noselect dired-noselect
))
395 ;;;It is not useful to make this a local variable.
396 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
397 (defvar find-file-not-found-functions nil
398 "List of functions to be called for `find-file' on nonexistent file.
399 These functions are called as soon as the error is detected.
400 Variable `buffer-file-name' is already set up.
401 The functions are called in the order given until one of them returns non-nil.")
402 (define-obsolete-variable-alias 'find-file-not-found-hooks
403 'find-file-not-found-functions
"22.1")
405 ;;;It is not useful to make this a local variable.
406 ;;;(put 'find-file-hooks 'permanent-local t)
407 (define-obsolete-variable-alias 'find-file-hooks
'find-file-hook
"22.1")
408 (defcustom find-file-hook nil
409 "List of functions to be called after a buffer is loaded from a file.
410 The buffer's local variables (if any) will have been processed before the
411 functions are called."
414 :options
'(auto-insert)
417 (defvar write-file-functions nil
418 "List of functions to be called before writing out a buffer to a file.
419 If one of them returns non-nil, the file is considered already written
420 and the rest are not called.
421 These hooks are considered to pertain to the visited file.
422 So any buffer-local binding of this variable is discarded if you change
423 the visited file name with \\[set-visited-file-name], but not when you
424 change the major mode.
426 This hook is not run if any of the functions in
427 `write-contents-functions' returns non-nil. Both hooks pertain
428 to how to save a buffer to file, for instance, choosing a suitable
429 coding system and setting mode bits. (See Info
430 node `(elisp)Saving Buffers'.) To perform various checks or
431 updates before the buffer is saved, use `before-save-hook'.")
432 (put 'write-file-functions
'permanent-local t
)
433 (define-obsolete-variable-alias 'write-file-hooks
'write-file-functions
"22.1")
435 (defvar local-write-file-hooks nil
)
436 (make-variable-buffer-local 'local-write-file-hooks
)
437 (put 'local-write-file-hooks
'permanent-local t
)
438 (make-obsolete-variable 'local-write-file-hooks
'write-file-functions
"22.1")
440 (defvar write-contents-functions nil
441 "List of functions to be called before writing out a buffer to a file.
442 If one of them returns non-nil, the file is considered already written
443 and the rest are not called and neither are the functions in
444 `write-file-functions'.
446 This variable is meant to be used for hooks that pertain to the
447 buffer's contents, not to the particular visited file; thus,
448 `set-visited-file-name' does not clear this variable; but changing the
449 major mode does clear it.
451 For hooks that _do_ pertain to the particular visited file, use
452 `write-file-functions'. Both this variable and
453 `write-file-functions' relate to how a buffer is saved to file.
454 To perform various checks or updates before the buffer is saved,
455 use `before-save-hook'.")
456 (make-variable-buffer-local 'write-contents-functions
)
457 (define-obsolete-variable-alias 'write-contents-hooks
458 'write-contents-functions
"22.1")
460 (defcustom enable-local-variables t
461 "Control use of local variables in files you visit.
462 The value can be t, nil, :safe, :all, or something else.
464 A value of t means file local variables specifications are obeyed
465 if all the specified variable values are safe; if any values are
466 not safe, Emacs queries you, once, whether to set them all.
467 \(When you say yes to certain values, they are remembered as safe.)
469 :safe means set the safe variables, and ignore the rest.
470 :all means set all variables, whether safe or not.
471 (Don't set it permanently to :all.)
472 A value of nil means always ignore the file local variables.
474 Any other value means always query you once whether to set them all.
475 \(When you say yes to certain values, they are remembered as safe, but
476 this has no effect when `enable-local-variables' is \"something else\".)
478 This variable also controls use of major modes specified in
481 The command \\[normal-mode], when used interactively,
482 always obeys file local variable specifications and the -*- line,
483 and ignores this variable."
484 :type
'(choice (const :tag
"Query Unsafe" t
)
485 (const :tag
"Safe Only" :safe
)
486 (const :tag
"Do all" :all
)
487 (const :tag
"Ignore" nil
)
488 (other :tag
"Query" other
))
491 (defvar local-enable-local-variables t
492 "Like `enable-local-variables' but meant for buffer-local bindings.
493 The meaningful values are nil and non-nil. The default is non-nil.
494 If a major mode sets this to nil, buffer-locally, then any local
495 variables list in the file will be ignored.
497 This variable does not affect the use of major modes
498 specified in a -*- line.")
500 (defcustom enable-local-eval
'maybe
501 "Control processing of the \"variable\" `eval' in a file's local variables.
502 The value can be t, nil or something else.
503 A value of t means obey `eval' variables;
504 A value of nil means ignore them; anything else means query."
505 :type
'(choice (const :tag
"Obey" t
)
506 (const :tag
"Ignore" nil
)
507 (other :tag
"Query" other
))
510 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
511 (or (fboundp 'lock-buffer
)
512 (defalias 'lock-buffer
'ignore
))
513 (or (fboundp 'unlock-buffer
)
514 (defalias 'unlock-buffer
'ignore
))
515 (or (fboundp 'file-locked-p
)
516 (defalias 'file-locked-p
'ignore
))
518 (defcustom view-read-only nil
519 "Non-nil means buffers visiting files read-only do so in view mode.
520 In fact, this means that all read-only buffers normally have
521 View mode enabled, including buffers that are read-only because
522 you visit a file you cannot alter, and buffers you make read-only
523 using \\[toggle-read-only]."
527 (defvar file-name-history nil
528 "History list of file names entered in the minibuffer.
530 Maximum length of the history list is determined by the value
531 of `history-length', which see.")
533 (put 'ange-ftp-completion-hook-function
'safe-magic t
)
534 (defun ange-ftp-completion-hook-function (op &rest args
)
535 "Provides support for ange-ftp host name completion.
536 Runs the usual ange-ftp hook, but only for completion operations."
537 ;; Having this here avoids the need to load ange-ftp when it's not
539 (if (memq op
'(file-name-completion file-name-all-completions
))
540 (apply 'ange-ftp-hook-function op args
)
541 (let ((inhibit-file-name-handlers
542 (cons 'ange-ftp-completion-hook-function
543 (and (eq inhibit-file-name-operation op
)
544 inhibit-file-name-handlers
)))
545 (inhibit-file-name-operation op
))
548 (defun convert-standard-filename (filename)
549 "Convert a standard file's name to something suitable for the OS.
550 This means to guarantee valid names and perhaps to canonicalize
553 FILENAME should be an absolute file name since the conversion rules
554 sometimes vary depending on the position in the file name. E.g. c:/foo
555 is a valid DOS file name, but c:/bar/c:/foo is not.
557 This function's standard definition is trivial; it just returns
558 the argument. However, on Windows and DOS, replace invalid
559 characters. On DOS, make sure to obey the 8.3 limitations.
560 In the native Windows build, turn Cygwin names into native names,
561 and also turn slashes into backslashes if the shell requires it (see
562 `w32-shell-dos-semantics').
564 See Info node `(elisp)Standard File Names' for more details."
565 (if (eq system-type
'cygwin
)
566 (let ((name (copy-sequence filename
))
568 ;; Replace invalid filename characters with !
569 (while (string-match "[?*:<>|\"\000-\037]" name start
)
570 (aset name
(match-beginning 0) ?
!)
571 (setq start
(match-end 0)))
575 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial
)
576 "Read directory name, prompting with PROMPT and completing in directory DIR.
577 Value is not expanded---you must call `expand-file-name' yourself.
578 Default name to DEFAULT-DIRNAME if user exits with the same
579 non-empty string that was inserted by this function.
580 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
581 or just DIR if INITIAL is nil.)
582 If the user exits with an empty minibuffer, this function returns
583 an empty string. (This can only happen if the user erased the
584 pre-inserted contents or if `insert-default-directory' is nil.)
585 Fourth arg MUSTMATCH non-nil means require existing directory's name.
586 Non-nil and non-t means also require confirmation after completion.
587 Fifth arg INITIAL specifies text to start with.
588 DIR should be an absolute directory name. It defaults to
589 the value of `default-directory'."
591 (setq dir default-directory
))
592 (read-file-name prompt dir
(or default-dirname
593 (if initial
(expand-file-name initial dir
)
600 "Show the current default directory."
602 (message "Directory %s" default-directory
))
605 "Value of the CDPATH environment variable, as a list.
606 Not actually set up until the first time you use it.")
608 (defun parse-colon-path (cd-path)
609 "Explode a search path into a list of directory names.
610 Directories are separated by occurrences of `path-separator'
611 \(which is colon in GNU and GNU-like systems)."
612 ;; We could use split-string here.
614 (let (cd-list (cd-start 0) cd-colon
)
615 (setq cd-path
(concat cd-path path-separator
))
616 (while (setq cd-colon
(string-match path-separator cd-path cd-start
))
619 (list (if (= cd-start cd-colon
)
621 (substitute-in-file-name
622 (file-name-as-directory
623 (substring cd-path cd-start cd-colon
)))))))
624 (setq cd-start
(+ cd-colon
1)))
627 (defun cd-absolute (dir)
628 "Change current directory to given absolute file name DIR."
629 ;; Put the name into directory syntax now,
630 ;; because otherwise expand-file-name may give some bad results.
631 (if (not (eq system-type
'vax-vms
))
632 (setq dir
(file-name-as-directory dir
)))
633 (setq dir
(abbreviate-file-name (expand-file-name dir
)))
634 (if (not (file-directory-p dir
))
635 (if (file-exists-p dir
)
636 (error "%s is not a directory" dir
)
637 (error "%s: no such directory" dir
))
638 (unless (file-executable-p dir
)
639 (error "Cannot cd to %s: Permission denied" dir
))
640 (setq default-directory dir
)
641 (set (make-local-variable 'list-buffers-directory
) dir
)))
644 "Make DIR become the current buffer's default directory.
645 If your environment includes a `CDPATH' variable, try each one of
646 that list of directories (separated by occurrences of
647 `path-separator') when resolving a relative directory name.
648 The path separator is colon in GNU and GNU-like systems."
650 (list (read-directory-name "Change default directory: "
651 default-directory default-directory
652 (and (member cd-path
'(nil ("./")))
653 (null (getenv "CDPATH"))))))
654 (if (file-name-absolute-p dir
)
655 (cd-absolute (expand-file-name dir
))
657 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
658 (setq cd-path
(or trypath
(list "./")))))
659 (if (not (catch 'found
661 (function (lambda (x)
662 (let ((f (expand-file-name (concat x dir
))))
663 (if (file-directory-p f
)
666 (throw 'found t
))))))
669 (error "No such directory found via CDPATH environment variable"))))
671 (defun load-file (file)
672 "Load the Lisp file named FILE."
673 ;; This is a case where .elc makes a lot of sense.
674 (interactive (list (let ((completion-ignored-extensions
675 (remove ".elc" completion-ignored-extensions
)))
676 (read-file-name "Load file: "))))
677 (load (expand-file-name file
) nil nil t
))
679 (defun locate-file (filename path
&optional suffixes predicate
)
680 "Search for FILENAME through PATH.
681 If found, return the absolute file name of FILENAME, with its suffixes;
682 otherwise return nil.
683 PATH should be a list of directories to look in, like the lists in
684 `exec-path' or `load-path'.
685 If SUFFIXES is non-nil, it should be a list of suffixes to append to
686 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
687 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
688 If non-nil, PREDICATE is used instead of `file-readable-p'.
689 PREDICATE can also be an integer to pass to the `access' system call,
690 in which case file-name handlers are ignored. This usage is deprecated.
692 For compatibility, PREDICATE can also be one of the symbols
693 `executable', `readable', `writable', or `exists', or a list of
694 one or more of those symbols."
695 (if (and predicate
(symbolp predicate
) (not (functionp predicate
)))
696 (setq predicate
(list predicate
)))
697 (when (and (consp predicate
) (not (functionp predicate
)))
699 (logior (if (memq 'executable predicate
) 1 0)
700 (if (memq 'writable predicate
) 2 0)
701 (if (memq 'readable predicate
) 4 0))))
702 (locate-file-internal filename path suffixes predicate
))
704 (defun locate-file-completion-table (dirs suffixes string pred action
)
705 "Do completion for file names passed to `locate-file'."
706 (if (file-name-absolute-p string
)
707 (let ((read-file-name-predicate pred
))
708 (read-file-name-internal string nil action
))
710 (suffix (concat (regexp-opt suffixes t
) "\\'"))
711 (string-dir (file-name-directory string
)))
714 (setq dir default-directory
))
715 (if string-dir
(setq dir
(expand-file-name string-dir dir
)))
716 (when (file-directory-p dir
)
717 (dolist (file (file-name-all-completions
718 (file-name-nondirectory string
) dir
))
719 (add-to-list 'names
(if string-dir
(concat string-dir file
) file
))
720 (when (string-match suffix file
)
721 (setq file
(substring file
0 (match-beginning 0)))
722 (push (if string-dir
(concat string-dir file
) file
) names
)))))
723 (complete-with-action action names string pred
))))
725 (defun locate-file-completion (string path-and-suffixes action
)
726 "Do completion for file names passed to `locate-file'.
727 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
728 (locate-file-completion-table (car path-and-suffixes
)
729 (cdr path-and-suffixes
)
731 (make-obsolete 'locate-file-completion
'locate-file-completion-table
"23.1")
733 (defun locate-dominating-file (file regexp
)
734 "Look up the directory hierarchy from FILE for a file matching REGEXP."
736 ;; `user' is not initialized yet because `file' may not exist, so we may
737 ;; have to walk up part of the hierarchy before we find the "initial UID".
739 ;; Abbreviate, so as to stop when we cross ~/.
740 (dir (abbreviate-file-name (file-name-as-directory file
)))
743 ;; As a heuristic, we stop looking up the hierarchy of
744 ;; directories as soon as we find a directory belonging to
745 ;; another user. This should save us from looking in
746 ;; things like /net and /afs. This assumes that all the
747 ;; files inside a project belong to the same user.
748 (let ((prev-user user
))
749 (setq user
(nth 2 (file-attributes file
)))
750 (or (null prev-user
) (equal user prev-user
))))
751 (if (setq files
(directory-files dir
'full regexp
))
752 (throw 'found
(car files
))
754 (setq dir
(file-name-directory
755 (directory-file-name dir
))))
759 (defun executable-find (command)
760 "Search for COMMAND in `exec-path' and return the absolute file name.
761 Return nil if COMMAND is not found anywhere in `exec-path'."
762 ;; Use 1 rather than file-executable-p to better match the behavior of
764 (locate-file command exec-path exec-suffixes
1))
766 (defun load-library (library)
767 "Load the library named LIBRARY.
768 This is an interface to the function `load'."
770 (list (completing-read "Load library: "
771 (apply-partially 'locate-file-completion-table
773 (get-load-suffixes)))))
776 (defun file-remote-p (file &optional identification connected
)
777 "Test whether FILE specifies a location on a remote system.
778 Returns nil or a string identifying the remote connection (ideally
779 a prefix of FILE). For example, the remote identification for filename
780 \"/user@host:/foo\" could be \"/user@host:\".
781 A file is considered \"remote\" if accessing it is likely to be slower or
782 less reliable than accessing local files.
783 Furthermore, relative file names do not work across remote connections.
785 IDENTIFICATION specifies which part of the identification shall
786 be returned as string. IDENTIFICATION can be the symbol
787 `method', `user' or `host'; any other value is handled like nil
788 and means to return the complete identification string.
790 If CONNECTED is non-nil, the function returns an identification only
791 if FILE is located on a remote system, and a connection is established
792 to that remote system.
794 `file-remote-p' will never open a connection on its own."
795 (let ((handler (find-file-name-handler file
'file-remote-p
)))
797 (funcall handler
'file-remote-p file identification connected
)
800 (defun file-local-copy (file)
801 "Copy the file FILE into a temporary file on this machine.
802 Returns the name of the local copy, or nil, if FILE is directly
804 ;; This formerly had an optional BUFFER argument that wasn't used by
806 (let ((handler (find-file-name-handler file
'file-local-copy
)))
808 (funcall handler
'file-local-copy file
)
811 (defun file-truename (filename &optional counter prev-dirs
)
812 "Return the truename of FILENAME, which should be absolute.
813 The truename of a file name is found by chasing symbolic links
814 both at the level of the file and at the level of the directories
815 containing it, until no links are left at any level.
817 \(fn FILENAME)" ;; Don't document the optional arguments.
818 ;; COUNTER and PREV-DIRS are only used in recursive calls.
819 ;; COUNTER can be a cons cell whose car is the count of how many
820 ;; more links to chase before getting an error.
821 ;; PREV-DIRS can be a cons cell whose car is an alist
822 ;; of truenames we've just recently computed.
823 (cond ((or (string= filename
"") (string= filename
"~"))
824 (setq filename
(expand-file-name filename
))
825 (if (string= filename
"")
826 (setq filename
"/")))
827 ((and (string= (substring filename
0 1) "~")
828 (string-match "~[^/]*/?" filename
))
830 (substring filename
0 (match-end 0)))
831 (rest (substring filename
(match-end 0))))
832 (setq filename
(concat (expand-file-name first-part
) rest
)))))
834 (or counter
(setq counter
(list 100)))
836 ;; For speed, remove the ange-ftp completion handler from the list.
837 ;; We know it's not needed here.
838 ;; For even more speed, do this only on the outermost call.
839 (file-name-handler-alist
840 (if prev-dirs file-name-handler-alist
841 (let ((tem (copy-sequence file-name-handler-alist
)))
842 (delq (rassq 'ange-ftp-completion-hook-function tem
) tem
)))))
843 (or prev-dirs
(setq prev-dirs
(list nil
)))
845 ;; andrewi@harlequin.co.uk - none of the following code (except for
846 ;; invoking the file-name handler) currently applies on Windows
847 ;; (ie. there are no native symlinks), but there is an issue with
848 ;; case differences being ignored by the OS, and short "8.3 DOS"
849 ;; name aliases existing for all files. (The short names are not
850 ;; reported by directory-files, but can be used to refer to files.)
851 ;; It seems appropriate for file-truename to resolve these issues in
852 ;; the most natural way, which on Windows is to call the function
853 ;; `w32-long-file-name' - this returns the exact name of a file as
854 ;; it is stored on disk (expanding short name aliases with the full
855 ;; name in the process).
856 (if (eq system-type
'windows-nt
)
857 (let ((handler (find-file-name-handler filename
'file-truename
)))
858 ;; For file name that has a special handler, call handler.
859 ;; This is so that ange-ftp can save time by doing a no-op.
861 (setq filename
(funcall handler
'file-truename filename
))
862 ;; If filename contains a wildcard, newname will be the old name.
863 (unless (string-match "[[*?]" filename
)
864 ;; If filename exists, use the long name
865 (setq filename
(or (w32-long-file-name filename
) filename
))))
868 ;; If this file directly leads to a link, process that iteratively
869 ;; so that we don't use lots of stack.
871 (setcar counter
(1- (car counter
)))
872 (if (< (car counter
) 0)
873 (error "Apparent cycle of symbolic links for %s" filename
))
874 (let ((handler (find-file-name-handler filename
'file-truename
)))
875 ;; For file name that has a special handler, call handler.
876 ;; This is so that ange-ftp can save time by doing a no-op.
878 (setq filename
(funcall handler
'file-truename filename
)
880 (let ((dir (or (file-name-directory filename
) default-directory
))
882 ;; Get the truename of the directory.
883 (setq dirfile
(directory-file-name dir
))
884 ;; If these are equal, we have the (or a) root directory.
885 (or (string= dir dirfile
)
886 ;; If this is the same dir we last got the truename for,
887 ;; save time--don't recalculate.
888 (if (assoc dir
(car prev-dirs
))
889 (setq dir
(cdr (assoc dir
(car prev-dirs
))))
891 (new (file-name-as-directory (file-truename dirfile counter prev-dirs
))))
892 (setcar prev-dirs
(cons (cons old new
) (car prev-dirs
)))
894 (if (equal ".." (file-name-nondirectory filename
))
896 (directory-file-name (file-name-directory (directory-file-name dir
)))
898 (if (equal "." (file-name-nondirectory filename
))
899 (setq filename
(directory-file-name dir
)
901 ;; Put it back on the file name.
902 (setq filename
(concat dir
(file-name-nondirectory filename
)))
903 ;; Is the file name the name of a link?
904 (setq target
(file-symlink-p filename
))
906 ;; Yes => chase that link, then start all over
907 ;; since the link may point to a directory name that uses links.
908 ;; We can't safely use expand-file-name here
909 ;; since target might look like foo/../bar where foo
910 ;; is itself a link. Instead, we handle . and .. above.
912 (if (file-name-absolute-p target
)
920 (defun file-chase-links (filename &optional limit
)
921 "Chase links in FILENAME until a name that is not a link.
922 Unlike `file-truename', this does not check whether a parent
923 directory name is a symbolic link.
924 If the optional argument LIMIT is a number,
925 it means chase no more than that many links and then stop."
926 (let (tem (newname filename
)
928 (while (and (or (null limit
) (< count limit
))
929 (setq tem
(file-symlink-p newname
)))
931 (if (and (null limit
) (= count
100))
932 (error "Apparent cycle of symbolic links for %s" filename
))
933 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
934 (while (string-match "//+" tem
)
935 (setq tem
(replace-match "/" nil nil tem
)))
936 ;; Handle `..' by hand, since it needs to work in the
937 ;; target of any directory symlink.
938 ;; This code is not quite complete; it does not handle
939 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
940 (while (string-match "\\`\\.\\./" tem
)
941 (setq tem
(substring tem
3))
942 (setq newname
(expand-file-name newname
))
943 ;; Chase links in the default dir of the symlink.
946 (directory-file-name (file-name-directory newname
))))
947 ;; Now find the parent of that dir.
948 (setq newname
(file-name-directory newname
)))
949 (setq newname
(expand-file-name tem
(file-name-directory newname
)))
950 (setq count
(1+ count
))))
953 (defun make-temp-file (prefix &optional dir-flag suffix
)
954 "Create a temporary file.
955 The returned file name (created by appending some random characters at the end
956 of PREFIX, and expanding against `temporary-file-directory' if necessary),
957 is guaranteed to point to a newly created empty file.
958 You can then use `write-region' to write new data into the file.
960 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
962 If SUFFIX is non-nil, add that at the end of the file name."
963 (let ((umask (default-file-modes))
967 ;; Create temp files with strict access rights. It's easy to
968 ;; loosen them later, whereas it's impossible to close the
969 ;; time-window of loose permissions otherwise.
970 (set-default-file-modes ?
\700)
971 (while (condition-case ()
975 (expand-file-name prefix temporary-file-directory
)))
977 (setq file
(concat file suffix
)))
979 (make-directory file
)
980 (write-region "" nil file nil
'silent nil
'excl
))
982 (file-already-exists t
))
983 ;; the file was somehow created by someone else between
984 ;; `make-temp-name' and `write-region', let's try again.
988 (set-default-file-modes umask
))))
990 (defun recode-file-name (file coding new-coding
&optional ok-if-already-exists
)
991 "Change the encoding of FILE's name from CODING to NEW-CODING.
992 The value is a new name of FILE.
993 Signals a `file-already-exists' error if a file of the new name
994 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
995 is non-nil. A number as fourth arg means request confirmation if
996 the new name already exists. This is what happens in interactive
999 (let ((default-coding (or file-name-coding-system
1000 default-file-name-coding-system
))
1001 (filename (read-file-name "Recode filename: " nil nil t
))
1002 from-coding to-coding
)
1003 (if (and default-coding
1004 ;; We provide the default coding only when it seems that
1005 ;; the filename is correctly decoded by the default
1007 (let ((charsets (find-charset-string filename
)))
1008 (and (not (memq 'eight-bit-control charsets
))
1009 (not (memq 'eight-bit-graphic charsets
)))))
1010 (setq from-coding
(read-coding-system
1011 (format "Recode filename %s from (default %s): "
1012 filename default-coding
)
1014 (setq from-coding
(read-coding-system
1015 (format "Recode filename %s from: " filename
))))
1017 ;; We provide the default coding only when a user is going to
1018 ;; change the encoding not from the default coding.
1019 (if (eq from-coding default-coding
)
1020 (setq to-coding
(read-coding-system
1021 (format "Recode filename %s from %s to: "
1022 filename from-coding
)))
1023 (setq to-coding
(read-coding-system
1024 (format "Recode filename %s from %s to (default %s): "
1025 filename from-coding default-coding
)
1027 (list filename from-coding to-coding
)))
1029 (let* ((default-coding (or file-name-coding-system
1030 default-file-name-coding-system
))
1031 ;; FILE should have been decoded by DEFAULT-CODING.
1032 (encoded (encode-coding-string file default-coding
))
1033 (newname (decode-coding-string encoded coding
))
1034 (new-encoded (encode-coding-string newname new-coding
))
1035 ;; Suppress further encoding.
1036 (file-name-coding-system nil
)
1037 (default-file-name-coding-system nil
)
1038 (locale-coding-system nil
))
1039 (rename-file encoded new-encoded ok-if-already-exists
)
1042 (defun read-buffer-to-switch (prompt)
1043 "Read the name of a buffer to switch to and return as a string.
1044 It is intended for `switch-to-buffer' family of commands since they
1045 need to omit the name of current buffer from the list of complations
1046 and default values."
1047 (minibuffer-with-setup-hook
1049 (set (make-local-variable 'minibuffer-completion-table
)
1050 (internal-complete-buffer-except (other-buffer (current-buffer) t
))))
1051 (read-buffer prompt
(other-buffer (current-buffer)))))
1053 (defun switch-to-buffer-other-window (buffer &optional norecord
)
1054 "Select buffer BUFFER in another window.
1055 If BUFFER does not identify an existing buffer, then this function
1056 creates a buffer with that name.
1058 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1059 or nil. If BUFFER is nil, then this function chooses a buffer
1060 using `other-buffer'.
1061 Optional second arg NORECORD non-nil means
1062 do not put this buffer at the front of the list of recently selected ones.
1063 This function returns the buffer it switched to.
1065 This uses the function `display-buffer' as a subroutine; see its
1066 documentation for additional customization information."
1068 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1069 (let ((pop-up-windows t
)
1070 ;; Don't let these interfere.
1071 same-window-buffer-names same-window-regexps
)
1072 (pop-to-buffer buffer t norecord
)))
1074 (defun switch-to-buffer-other-frame (buffer &optional norecord
)
1075 "Switch to buffer BUFFER in another frame.
1076 Optional second arg NORECORD non-nil means
1077 do not put this buffer at the front of the list of recently selected ones.
1078 This function returns the buffer it switched to.
1080 This uses the function `display-buffer' as a subroutine; see its
1081 documentation for additional customization information."
1083 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1084 (let ((pop-up-frames t
)
1085 same-window-buffer-names same-window-regexps
)
1087 (pop-to-buffer buffer t norecord
)
1088 (raise-frame (window-frame (selected-window))))))
1090 (defun display-buffer-other-frame (buffer)
1091 "Switch to buffer BUFFER in another frame.
1092 This uses the function `display-buffer' as a subroutine; see its
1093 documentation for additional customization information."
1094 (interactive "BDisplay buffer in other frame: ")
1095 (let ((pop-up-frames t
)
1096 same-window-buffer-names same-window-regexps
1097 (old-window (selected-window))
1099 (setq new-window
(display-buffer buffer t
))
1100 ;; This may have been here in order to prevent the new frame from hiding
1101 ;; the old frame. But it does more harm than good.
1102 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1103 ;;(lower-frame (window-frame new-window))
1105 ;; This may have been here in order to make sure the old-frame gets the
1106 ;; focus. But not only can it cause an annoying flicker, with some
1107 ;; window-managers it just makes the window invisible, with no easy
1108 ;; way to recover it. --Stef
1109 ;;(make-frame-invisible (window-frame old-window))
1110 ;;(make-frame-visible (window-frame old-window))
1113 (defvar find-file-default nil
1114 "Used within `find-file-read-args'.")
1116 (defmacro minibuffer-with-setup-hook
(fun &rest body
)
1117 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1118 BODY should use the minibuffer at most once.
1119 Recursive uses of the minibuffer will not be affected."
1120 (declare (indent 1) (debug t
))
1121 (let ((hook (make-symbol "setup-hook")))
1125 ;; Clear out this hook so it does not interfere
1126 ;; with any recursive minibuffer usage.
1127 (remove-hook 'minibuffer-setup-hook
,hook
)
1131 (add-hook 'minibuffer-setup-hook
,hook
)
1133 (remove-hook 'minibuffer-setup-hook
,hook
)))))
1135 (defcustom find-file-confirm-nonexistent-file nil
1136 "If non-nil, `find-file' requires confirmation before visiting a new file."
1141 (defun find-file-read-args (prompt mustmatch
)
1142 (list (let ((find-file-default
1143 (and buffer-file-name
1144 (abbreviate-file-name buffer-file-name
))))
1145 (minibuffer-with-setup-hook
1146 (lambda () (setq minibuffer-default find-file-default
))
1147 (read-file-name prompt nil default-directory mustmatch
)))
1150 (defun find-file (filename &optional wildcards
)
1151 "Edit file FILENAME.
1152 Switch to a buffer visiting file FILENAME,
1153 creating one if none already exists.
1154 Interactively, the default if you just type RET is the current directory,
1155 but the visited file name is available through the minibuffer history:
1156 type M-n to pull it into the minibuffer.
1158 You can visit files on remote machines by specifying something
1159 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1160 also visit local files as a different user by specifying
1161 /sudo::FILE for the file name.
1162 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1163 manual, for more about this.
1165 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1166 expand wildcards (if any) and visit multiple files. You can
1167 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1169 To visit a file without any kind of conversion and without
1170 automatically choosing a major mode, use \\[find-file-literally]."
1172 (find-file-read-args "Find file: "
1173 (if find-file-confirm-nonexistent-file
'confirm-only
)))
1174 (let ((value (find-file-noselect filename nil nil wildcards
)))
1176 (mapcar 'switch-to-buffer
(nreverse value
))
1177 (switch-to-buffer value
))))
1179 (defun find-file-other-window (filename &optional wildcards
)
1180 "Edit file FILENAME, in another window.
1182 Like \\[find-file] (which see), but creates a new window or reuses
1183 an existing one. See the function `display-buffer'.
1185 Interactively, the default if you just type RET is the current directory,
1186 but the visited file name is available through the minibuffer history:
1187 type M-n to pull it into the minibuffer.
1189 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1190 expand wildcards (if any) and visit multiple files."
1192 (find-file-read-args "Find file in other window: "
1193 (if find-file-confirm-nonexistent-file
'confirm-only
)))
1194 (let ((value (find-file-noselect filename nil nil wildcards
)))
1197 (setq value
(nreverse value
))
1198 (cons (switch-to-buffer-other-window (car value
))
1199 (mapcar 'switch-to-buffer
(cdr value
))))
1200 (switch-to-buffer-other-window value
))))
1202 (defun find-file-other-frame (filename &optional wildcards
)
1203 "Edit file FILENAME, in another frame.
1205 Like \\[find-file] (which see), but creates a new frame or reuses
1206 an existing one. See the function `display-buffer'.
1208 Interactively, the default if you just type RET is the current directory,
1209 but the visited file name is available through the minibuffer history:
1210 type M-n to pull it into the minibuffer.
1212 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1213 expand wildcards (if any) and visit multiple files."
1215 (find-file-read-args "Find file in other frame: "
1216 (if find-file-confirm-nonexistent-file
'confirm-only
)))
1217 (let ((value (find-file-noselect filename nil nil wildcards
)))
1220 (setq value
(nreverse value
))
1221 (cons (switch-to-buffer-other-frame (car value
))
1222 (mapcar 'switch-to-buffer
(cdr value
))))
1223 (switch-to-buffer-other-frame value
))))
1225 (defun find-file-existing (filename)
1226 "Edit the existing file FILENAME.
1227 Like \\[find-file], but only allow a file that exists, and do not allow
1228 file names with wildcards."
1229 (interactive (nbutlast (find-file-read-args "Find existing file: " t
)))
1230 (if (and (not (interactive-p)) (not (file-exists-p filename
)))
1231 (error "%s does not exist" filename
)
1232 (find-file filename
)
1235 (defun find-file-read-only (filename &optional wildcards
)
1236 "Edit file FILENAME but don't allow changes.
1237 Like \\[find-file], but marks buffer as read-only.
1238 Use \\[toggle-read-only] to permit editing."
1240 (find-file-read-args "Find file read-only: "
1241 (if find-file-confirm-nonexistent-file
'confirm-only
)))
1242 (unless (or (and wildcards find-file-wildcards
1243 (not (string-match "\\`/:" filename
))
1244 (string-match "[[*?]" filename
))
1245 (file-exists-p filename
))
1246 (error "%s does not exist" filename
))
1247 (let ((value (find-file filename wildcards
)))
1248 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1249 (if (listp value
) value
(list value
)))
1252 (defun find-file-read-only-other-window (filename &optional wildcards
)
1253 "Edit file FILENAME in another window but don't allow changes.
1254 Like \\[find-file-other-window], but marks buffer as read-only.
1255 Use \\[toggle-read-only] to permit editing."
1257 (find-file-read-args "Find file read-only other window: "
1258 (if find-file-confirm-nonexistent-file
'confirm-only
)))
1259 (unless (or (and wildcards find-file-wildcards
1260 (not (string-match "\\`/:" filename
))
1261 (string-match "[[*?]" filename
))
1262 (file-exists-p filename
))
1263 (error "%s does not exist" filename
))
1264 (let ((value (find-file-other-window filename wildcards
)))
1265 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1266 (if (listp value
) value
(list value
)))
1269 (defun find-file-read-only-other-frame (filename &optional wildcards
)
1270 "Edit file FILENAME in another frame but don't allow changes.
1271 Like \\[find-file-other-frame], but marks buffer as read-only.
1272 Use \\[toggle-read-only] to permit editing."
1274 (find-file-read-args "Find file read-only other frame: "
1275 (if find-file-confirm-nonexistent-file
'confirm-only
)))
1276 (unless (or (and wildcards find-file-wildcards
1277 (not (string-match "\\`/:" filename
))
1278 (string-match "[[*?]" filename
))
1279 (file-exists-p filename
))
1280 (error "%s does not exist" filename
))
1281 (let ((value (find-file-other-frame filename wildcards
)))
1282 (mapc (lambda (b) (with-current-buffer b
(toggle-read-only 1)))
1283 (if (listp value
) value
(list value
)))
1286 (defun find-alternate-file-other-window (filename &optional wildcards
)
1287 "Find file FILENAME as a replacement for the file in the next window.
1288 This command does not select that window.
1290 See \\[find-file] for the possible forms of the FILENAME argument.
1292 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1293 expand wildcards (if any) and replace the file with multiple files."
1295 (save-selected-window
1297 (let ((file buffer-file-name
)
1301 (setq file-name
(file-name-nondirectory file
)
1302 file-dir
(file-name-directory file
)))
1303 (list (read-file-name
1304 "Find alternate file: " file-dir nil nil file-name
)
1307 (find-file-other-window filename wildcards
)
1308 (save-selected-window
1310 (find-alternate-file filename wildcards
))))
1312 (defun find-alternate-file (filename &optional wildcards
)
1313 "Find file FILENAME, select its buffer, kill previous buffer.
1314 If the current buffer now contains an empty file that you just visited
1315 \(presumably by mistake), use this command to visit the file you really want.
1317 See \\[find-file] for the possible forms of the FILENAME argument.
1319 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1320 expand wildcards (if any) and replace the file with multiple files.
1322 If the current buffer is an indirect buffer, or the base buffer
1323 for one or more indirect buffers, the other buffer(s) are not
1326 (let ((file buffer-file-name
)
1330 (setq file-name
(file-name-nondirectory file
)
1331 file-dir
(file-name-directory file
)))
1332 (list (read-file-name
1333 "Find alternate file: " file-dir nil nil file-name
)
1335 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions
)
1337 (when (and (buffer-modified-p) (buffer-file-name))
1338 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1340 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1343 (let ((obuf (current-buffer))
1344 (ofile buffer-file-name
)
1345 (onum buffer-file-number
)
1346 (odir dired-directory
)
1347 (otrue buffer-file-truename
)
1348 (oname (buffer-name)))
1349 (if (get-buffer " **lose**")
1350 (kill-buffer " **lose**"))
1351 (rename-buffer " **lose**")
1355 ;; This prevents us from finding the same buffer
1356 ;; if we specified the same file again.
1357 (setq buffer-file-name nil
)
1358 (setq buffer-file-number nil
)
1359 (setq buffer-file-truename nil
)
1360 ;; Likewise for dired buffers.
1361 (setq dired-directory nil
)
1362 (find-file filename wildcards
))
1363 (when (eq obuf
(current-buffer))
1364 ;; This executes if find-file gets an error
1365 ;; and does not really find anything.
1366 ;; We put things back as they were.
1367 ;; If find-file actually finds something, we kill obuf below.
1368 (setq buffer-file-name ofile
)
1369 (setq buffer-file-number onum
)
1370 (setq buffer-file-truename otrue
)
1371 (setq dired-directory odir
)
1373 (rename-buffer oname
)))
1374 (unless (eq (current-buffer) obuf
)
1375 (with-current-buffer obuf
1376 ;; We already asked; don't ask again.
1377 (let ((kill-buffer-query-functions))
1378 (kill-buffer obuf
))))))
1380 (defun create-file-buffer (filename)
1381 "Create a suitably named buffer for visiting FILENAME, and return it.
1382 FILENAME (sans directory) is used unchanged if that name is free;
1383 otherwise a string <2> or <3> or ... is appended to get an unused name.
1384 Spaces at the start of FILENAME (sans directory) are removed."
1385 (let ((lastname (file-name-nondirectory filename
)))
1386 (if (string= lastname
"")
1387 (setq lastname filename
))
1389 (string-match "^ *\\(.*\\)" lastname
)
1390 (generate-new-buffer (match-string 1 lastname
)))))
1392 (defun generate-new-buffer (name)
1393 "Create and return a buffer with a name based on NAME.
1394 Choose the buffer's name using `generate-new-buffer-name'."
1395 (get-buffer-create (generate-new-buffer-name name
)))
1397 (defcustom automount-dir-prefix
"^/tmp_mnt/"
1398 "Regexp to match the automounter prefix in a directory name."
1402 (defvar abbreviated-home-dir nil
1403 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1405 (defun abbreviate-file-name (filename)
1406 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1407 This also substitutes \"~\" for the user's home directory (unless the
1408 home directory is a root directory) and removes automounter prefixes
1409 \(see the variable `automount-dir-prefix')."
1410 ;; Get rid of the prefixes added by the automounter.
1412 (if (and automount-dir-prefix
1413 (string-match automount-dir-prefix filename
)
1414 (file-exists-p (file-name-directory
1415 (substring filename
(1- (match-end 0))))))
1416 (setq filename
(substring filename
(1- (match-end 0)))))
1417 (let ((tail directory-abbrev-alist
))
1418 ;; If any elt of directory-abbrev-alist matches this name,
1419 ;; abbreviate accordingly.
1421 (if (string-match (car (car tail
)) filename
)
1423 (concat (cdr (car tail
)) (substring filename
(match-end 0)))))
1424 (setq tail
(cdr tail
)))
1425 ;; Compute and save the abbreviated homedir name.
1426 ;; We defer computing this until the first time it's needed, to
1427 ;; give time for directory-abbrev-alist to be set properly.
1428 ;; We include a slash at the end, to avoid spurious matches
1429 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1430 (or abbreviated-home-dir
1431 (setq abbreviated-home-dir
1432 (let ((abbreviated-home-dir "$foo"))
1433 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1436 ;; If FILENAME starts with the abbreviated homedir,
1437 ;; make it start with `~' instead.
1438 (if (and (string-match abbreviated-home-dir filename
)
1439 ;; If the home dir is just /, don't change it.
1440 (not (and (= (match-end 0) 1)
1441 (= (aref filename
0) ?
/)))
1442 ;; MS-DOS root directories can come with a drive letter;
1443 ;; Novell Netware allows drive letters beyond `Z:'.
1444 (not (and (or (eq system-type
'ms-dos
)
1445 (eq system-type
'cygwin
)
1446 (eq system-type
'windows-nt
))
1448 (string-match "^[a-zA-`]:/$" filename
)))))
1451 (match-string 1 filename
)
1452 (substring filename
(match-end 0)))))
1455 (defcustom find-file-not-true-dirname-list nil
1456 "List of logical names for which visiting shouldn't save the true dirname.
1457 On VMS, when you visit a file using a logical name that searches a path,
1458 you may or may not want the visited file name to record the specific
1459 directory where the file was found. If you *do not* want that, add the logical
1460 name to this list as a string."
1461 :type
'(repeat (string :tag
"Name"))
1464 (defun find-buffer-visiting (filename &optional predicate
)
1465 "Return the buffer visiting file FILENAME (a string).
1466 This is like `get-file-buffer', except that it checks for any buffer
1467 visiting the same file, possibly under a different name.
1468 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1469 and others are ignored.
1470 If there is no such live buffer, return nil."
1471 (let ((predicate (or predicate
#'identity
))
1472 (truename (abbreviate-file-name (file-truename filename
))))
1473 (or (let ((buf (get-file-buffer filename
)))
1474 (when (and buf
(funcall predicate buf
)) buf
))
1475 (let ((list (buffer-list)) found
)
1476 (while (and (not found
) list
)
1478 (set-buffer (car list
))
1479 (if (and buffer-file-name
1480 (string= buffer-file-truename truename
)
1481 (funcall predicate
(current-buffer)))
1482 (setq found
(car list
))))
1483 (setq list
(cdr list
)))
1485 (let* ((attributes (file-attributes truename
))
1486 (number (nthcdr 10 attributes
))
1487 (list (buffer-list)) found
)
1488 (and buffer-file-numbers-unique
1489 (car-safe number
) ;Make sure the inode is not just nil.
1490 (while (and (not found
) list
)
1491 (with-current-buffer (car list
)
1492 (if (and buffer-file-name
1493 (equal buffer-file-number number
)
1494 ;; Verify this buffer's file number
1495 ;; still belongs to its file.
1496 (file-exists-p buffer-file-name
)
1497 (equal (file-attributes buffer-file-truename
)
1499 (funcall predicate
(current-buffer)))
1500 (setq found
(car list
))))
1501 (setq list
(cdr list
))))
1504 (defcustom find-file-wildcards t
1505 "Non-nil means file-visiting commands should handle wildcards.
1506 For example, if you specify `*.c', that would visit all the files
1507 whose names match the pattern."
1512 (defcustom find-file-suppress-same-file-warnings nil
1513 "Non-nil means suppress warning messages for symlinked files.
1514 When nil, Emacs prints a warning when visiting a file that is already
1515 visited, but with a different name. Setting this option to t
1516 suppresses this warning."
1521 (defcustom large-file-warning-threshold
10000000
1522 "Maximum size of file above which a confirmation is requested.
1523 When nil, never request confirmation."
1527 :type
'(choice integer
(const :tag
"Never request confirmation" nil
)))
1529 (defun abort-if-file-too-large (size op-type
)
1530 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1531 OP-TYPE specifies the file operation being performed (for message to user)."
1532 (when (and large-file-warning-threshold size
1533 (> size large-file-warning-threshold
)
1535 (format "File %s is large (%dMB), really %s? "
1536 (file-name-nondirectory filename
)
1537 (/ size
1048576) op-type
))))
1540 (defun find-file-noselect (filename &optional nowarn rawfile wildcards
)
1541 "Read file FILENAME into a buffer and return the buffer.
1542 If a buffer exists visiting FILENAME, return that one, but
1543 verify that the file has not changed since visited or saved.
1544 The buffer is not selected, just returned to the caller.
1545 Optional second arg NOWARN non-nil means suppress any warning messages.
1546 Optional third arg RAWFILE non-nil means the file is read literally.
1547 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1548 and visit all the matching files. When wildcards are actually
1549 used and expanded, return a list of buffers that are visiting
1552 (abbreviate-file-name
1553 (expand-file-name filename
)))
1554 (if (file-directory-p filename
)
1555 (or (and find-file-run-dired
1556 (run-hook-with-args-until-success
1557 'find-directory-functions
1558 (if find-file-visit-truename
1559 (abbreviate-file-name (file-truename filename
))
1561 (error "%s is a directory" filename
))
1564 (not (string-match "\\`/:" filename
))
1565 (string-match "[[*?]" filename
))
1566 (let ((files (condition-case nil
1567 (file-expand-wildcards filename t
)
1568 (error (list filename
))))
1569 (find-file-wildcards nil
))
1571 (find-file-noselect filename
)
1572 (mapcar #'find-file-noselect files
)))
1573 (let* ((buf (get-file-buffer filename
))
1574 (truename (abbreviate-file-name (file-truename filename
)))
1575 (attributes (file-attributes truename
))
1576 (number (nthcdr 10 attributes
))
1577 ;; Find any buffer for a file which has same truename.
1578 (other (and (not buf
) (find-buffer-visiting filename
))))
1579 ;; Let user know if there is a buffer with the same truename.
1583 find-file-suppress-same-file-warnings
1584 (string-equal filename
(buffer-file-name other
))
1585 (message "%s and %s are the same file"
1586 filename
(buffer-file-name other
)))
1587 ;; Optionally also find that buffer.
1588 (if (or find-file-existing-other-name find-file-visit-truename
)
1590 ;; Check to see if the file looks uncommonly large.
1591 (when (not (or buf nowarn
))
1592 (abort-if-file-too-large (nth 7 attributes
) "open"))
1594 ;; We are using an existing buffer.
1597 (verify-visited-file-modtime buf
)
1598 (cond ((not (file-exists-p filename
))
1599 (setq nonexistent t
)
1600 (message "File %s no longer exists!" filename
))
1601 ;; Certain files should be reverted automatically
1602 ;; if they have changed on disk and not in the buffer.
1603 ((and (not (buffer-modified-p buf
))
1604 (let ((tail revert-without-query
)
1607 (if (string-match (car tail
) filename
)
1609 (setq tail
(cdr tail
)))
1611 (with-current-buffer buf
1612 (message "Reverting file %s..." filename
)
1614 (message "Reverting file %s...done" filename
)))
1616 (if (string= (file-name-nondirectory filename
)
1619 (if (buffer-modified-p buf
)
1620 "File %s changed on disk. Discard your edits? "
1621 "File %s changed on disk. Reread from disk? ")
1622 (file-name-nondirectory filename
))
1624 (if (buffer-modified-p buf
)
1625 "File %s changed on disk. Discard your edits in %s? "
1626 "File %s changed on disk. Reread from disk into %s? ")
1627 (file-name-nondirectory filename
)
1628 (buffer-name buf
))))
1629 (with-current-buffer buf
1630 (revert-buffer t t
)))))
1631 (with-current-buffer buf
1633 ;; Check if a formerly read-only file has become
1634 ;; writable and vice versa, but if the buffer agrees
1635 ;; with the new state of the file, that is ok too.
1636 (let ((read-only (not (file-writable-p buffer-file-name
))))
1637 (unless (or nonexistent
1638 (eq read-only buffer-file-read-only
)
1639 (eq read-only buffer-read-only
))
1642 (format "File %s is %s on disk. Change buffer mode? "
1644 (if read-only
"read-only" "writable"))))
1645 (y-or-n-p question
)))
1646 (setq buffer-read-only read-only
)))
1647 (setq buffer-file-read-only read-only
))
1649 (when (and (not (eq (not (null rawfile
))
1650 (not (null find-file-literally
))))
1652 ;; It is confusing to ask whether to visit
1653 ;; non-literally if they have the file in
1655 (not (eq major-mode
'hexl-mode
)))
1656 (if (buffer-modified-p)
1660 "The file %s is already visited normally,
1661 and you have edited the buffer. Now you have asked to visit it literally,
1662 meaning no coding system handling, format conversion, or local variables.
1663 Emacs can only visit a file in one way at a time.
1665 Do you want to save the file, and visit it literally instead? "
1666 "The file %s is already visited literally,
1667 meaning no coding system handling, format conversion, or local variables.
1668 You have edited the buffer. Now you have asked to visit the file normally,
1669 but Emacs can only visit a file in one way at a time.
1671 Do you want to save the file, and visit it normally instead? ")
1672 (file-name-nondirectory filename
)))
1675 (find-file-noselect-1 buf filename nowarn
1676 rawfile truename number
))
1681 Do you want to discard your changes, and visit the file literally now? "
1683 Do you want to discard your changes, and visit the file normally now? ")))
1684 (find-file-noselect-1 buf filename nowarn
1685 rawfile truename number
)
1686 (error (if rawfile
"File already visited non-literally"
1687 "File already visited literally"))))
1691 "The file %s is already visited normally.
1692 You have asked to visit it literally,
1693 meaning no coding system decoding, format conversion, or local variables.
1694 But Emacs can only visit a file in one way at a time.
1696 Do you want to revisit the file literally now? "
1697 "The file %s is already visited literally,
1698 meaning no coding system decoding, format conversion, or local variables.
1699 You have asked to visit it normally,
1700 but Emacs can only visit a file in one way at a time.
1702 Do you want to revisit the file normally now? ")
1703 (file-name-nondirectory filename
)))
1704 (find-file-noselect-1 buf filename nowarn
1705 rawfile truename number
)
1706 (error (if rawfile
"File already visited non-literally"
1707 "File already visited literally"))))))
1708 ;; Return the buffer we are using.
1710 ;; Create a new buffer.
1711 (setq buf
(create-file-buffer filename
))
1712 ;; find-file-noselect-1 may use a different buffer.
1713 (find-file-noselect-1 buf filename nowarn
1714 rawfile truename number
))))))
1716 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number
)
1718 (with-current-buffer buf
1719 (kill-local-variable 'find-file-literally
)
1720 ;; Needed in case we are re-visiting the file with a different
1721 ;; text representation.
1722 (kill-local-variable 'buffer-file-coding-system
)
1723 (kill-local-variable 'cursor-type
)
1724 (let ((inhibit-read-only t
))
1726 (and (default-value 'enable-multibyte-characters
)
1728 (set-buffer-multibyte t
))
1731 (let ((inhibit-read-only t
))
1732 (insert-file-contents-literally filename t
))
1734 (when (and (file-exists-p filename
)
1735 (not (file-readable-p filename
)))
1737 (signal 'file-error
(list "File is not readable"
1739 ;; Unconditionally set error
1742 (let ((inhibit-read-only t
))
1743 (insert-file-contents filename t
))
1745 (when (and (file-exists-p filename
)
1746 (not (file-readable-p filename
)))
1748 (signal 'file-error
(list "File is not readable"
1750 ;; Run find-file-not-found-functions until one returns non-nil.
1751 (or (run-hook-with-args-until-success 'find-file-not-found-functions
)
1752 ;; If they fail too, set error.
1754 ;; Record the file's truename, and maybe use that as visited name.
1755 (if (equal filename buffer-file-name
)
1756 (setq buffer-file-truename truename
)
1757 (setq buffer-file-truename
1758 (abbreviate-file-name (file-truename buffer-file-name
))))
1759 (setq buffer-file-number number
)
1760 ;; On VMS, we may want to remember which directory in a search list
1761 ;; the file was found in.
1762 (and (eq system-type
'vax-vms
)
1764 (if (string-match ":" (file-name-directory filename
))
1765 (setq logical
(substring (file-name-directory filename
)
1766 0 (match-beginning 0))))
1767 (not (member logical find-file-not-true-dirname-list
)))
1768 (setq buffer-file-name buffer-file-truename
))
1769 (if find-file-visit-truename
1770 (setq buffer-file-name
(expand-file-name buffer-file-truename
)))
1771 ;; Set buffer's default directory to that of the file.
1772 (setq default-directory
(file-name-directory buffer-file-name
))
1773 ;; Turn off backup files for certain file names. Since
1774 ;; this is a permanent local, the major mode won't eliminate it.
1775 (and backup-enable-predicate
1776 (not (funcall backup-enable-predicate buffer-file-name
))
1778 (make-local-variable 'backup-inhibited
)
1779 (setq backup-inhibited t
)))
1782 (set-buffer-multibyte nil
)
1783 (setq buffer-file-coding-system
'no-conversion
)
1784 (set-buffer-major-mode buf
)
1785 (make-local-variable 'find-file-literally
)
1786 (setq find-file-literally t
))
1787 (after-find-file error
(not nowarn
)))
1790 (defun insert-file-contents-literally (filename &optional visit beg end replace
)
1791 "Like `insert-file-contents', but only reads in the file literally.
1792 A buffer may be modified in several ways after reading into the buffer,
1793 to Emacs features such as format decoding, character code
1794 conversion, `find-file-hook', automatic uncompression, etc.
1796 This function ensures that none of these modifications will take place."
1797 (let ((format-alist nil
)
1798 (after-insert-file-functions nil
)
1799 (coding-system-for-read 'no-conversion
)
1800 (coding-system-for-write 'no-conversion
)
1801 (find-buffer-file-type-function
1802 (if (fboundp 'find-buffer-file-type
)
1803 (symbol-function 'find-buffer-file-type
)
1805 (inhibit-file-name-handlers
1806 (append '(jka-compr-handler image-file-handler
)
1807 inhibit-file-name-handlers
))
1808 (inhibit-file-name-operation 'insert-file-contents
))
1811 (fset 'find-buffer-file-type
(lambda (filename) t
))
1812 (insert-file-contents filename visit beg end replace
))
1813 (if find-buffer-file-type-function
1814 (fset 'find-buffer-file-type find-buffer-file-type-function
)
1815 (fmakunbound 'find-buffer-file-type
)))))
1817 (defun insert-file-1 (filename insert-func
)
1818 (if (file-directory-p filename
)
1819 (signal 'file-error
(list "Opening input file" "file is a directory"
1821 ;; Check whether the file is uncommonly large
1822 (abort-if-file-too-large (nth 7 (file-attributes filename
)) "insert")
1823 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename
))
1824 #'buffer-modified-p
))
1825 (tem (funcall insert-func filename
)))
1826 (push-mark (+ (point) (car (cdr tem
))))
1828 (message "File %s already visited and modified in buffer %s"
1829 filename
(buffer-name buffer
)))))
1831 (defun insert-file-literally (filename)
1832 "Insert contents of file FILENAME into buffer after point with no conversion.
1834 This function is meant for the user to run interactively.
1835 Don't call it from programs! Use `insert-file-contents-literally' instead.
1836 \(Its calling sequence is different; see its documentation)."
1837 (interactive "*fInsert file literally: ")
1838 (insert-file-1 filename
#'insert-file-contents-literally
))
1840 (defvar find-file-literally nil
1841 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1842 This is a permanent local.")
1843 (put 'find-file-literally
'permanent-local t
)
1845 (defun find-file-literally (filename)
1846 "Visit file FILENAME with no conversion of any kind.
1847 Format conversion and character code conversion are both disabled,
1848 and multibyte characters are disabled in the resulting buffer.
1849 The major mode used is Fundamental mode regardless of the file name,
1850 and local variable specifications in the file are ignored.
1851 Automatic uncompression and adding a newline at the end of the
1852 file due to `require-final-newline' is also disabled.
1854 You cannot absolutely rely on this function to result in
1855 visiting the file literally. If Emacs already has a buffer
1856 which is visiting the file, you get the existing buffer,
1857 regardless of whether it was created literally or not.
1859 In a Lisp program, if you want to be sure of accessing a file's
1860 contents literally, you should create a temporary buffer and then read
1861 the file contents into it using `insert-file-contents-literally'."
1862 (interactive "FFind file literally: ")
1863 (switch-to-buffer (find-file-noselect filename nil t
)))
1865 (defvar after-find-file-from-revert-buffer nil
)
1867 (defun after-find-file (&optional error warn noauto
1868 after-find-file-from-revert-buffer
1870 "Called after finding a file and by the default revert function.
1871 Sets buffer mode, parses local variables.
1872 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1873 error in reading the file. WARN non-nil means warn if there
1874 exists an auto-save file more recent than the visited file.
1875 NOAUTO means don't mess with auto-save mode.
1876 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1877 means this call was from `revert-buffer'.
1878 Fifth arg NOMODES non-nil means don't alter the file's modes.
1879 Finishes by calling the functions in `find-file-hook'
1880 unless NOMODES is non-nil."
1881 (setq buffer-read-only
(not (file-writable-p buffer-file-name
)))
1888 ((and error
(file-attributes buffer-file-name
))
1889 (setq buffer-read-only t
)
1890 "File exists, but cannot be read")
1891 ((not buffer-read-only
)
1893 ;; No need to warn if buffer is auto-saved
1894 ;; under the name of the visited file.
1895 (not (and buffer-file-name
1896 auto-save-visited-file-name
))
1897 (file-newer-than-file-p (or buffer-auto-save-file-name
1898 (make-auto-save-file-name))
1900 (format "%s has auto save data; consider M-x recover-this-file"
1901 (file-name-nondirectory buffer-file-name
))
1902 (setq not-serious t
)
1903 (if error
"(New file)" nil
)))
1905 (setq not-serious t
)
1906 "Note: file is write protected")
1907 ((file-attributes (directory-file-name default-directory
))
1908 "File not found and directory write-protected")
1909 ((file-exists-p (file-name-directory buffer-file-name
))
1910 (setq buffer-read-only nil
))
1912 (setq buffer-read-only nil
)
1913 "Use M-x make-directory RET RET to create the directory and its parents"))))
1916 (or not-serious
(sit-for 1 t
))))
1917 (when (and auto-save-default
(not noauto
))
1918 (auto-save-mode t
)))
1919 ;; Make people do a little extra work (C-x C-q)
1920 ;; before altering a backup file.
1921 (when (backup-file-name-p buffer-file-name
)
1922 (setq buffer-read-only t
))
1923 ;; When a file is marked read-only,
1924 ;; make the buffer read-only even if root is looking at it.
1925 (when (and (file-modes (buffer-file-name))
1926 (zerop (logand (file-modes (buffer-file-name)) #o222
)))
1927 (setq buffer-read-only t
))
1929 (when (and view-read-only view-mode
)
1930 (view-mode-disable))
1932 ;; If requested, add a newline at the end of the file.
1933 (and (memq require-final-newline
'(visit visit-save
))
1934 (> (point-max) (point-min))
1935 (/= (char-after (1- (point-max))) ?
\n)
1936 (not (and (eq selective-display t
)
1937 (= (char-after (1- (point-max))) ?
\r)))
1939 (goto-char (point-max))
1941 (when (and buffer-read-only
1943 (not (eq (get major-mode
'mode-class
) 'special
)))
1945 (run-hooks 'find-file-hook
)))
1947 (defmacro report-errors
(format &rest body
)
1948 "Eval BODY and turn any error into a FORMAT message.
1949 FORMAT can have a %s escape which will be replaced with the actual error.
1950 If `debug-on-error' is set, errors are not caught, so that you can
1952 Avoid using a large BODY since it is duplicated."
1953 (declare (debug t
) (indent 1))
1958 (error (message ,format
(prin1-to-string err
))))))
1960 (defun normal-mode (&optional find-file
)
1961 "Choose the major mode for this buffer automatically.
1962 Also sets up any specified local variables of the file.
1963 Uses the visited file name, the -*- line, and the local variables spec.
1965 This function is called automatically from `find-file'. In that case,
1966 we may set up the file-specified mode and local variables,
1967 depending on the value of `enable-local-variables'.
1968 In addition, if `local-enable-local-variables' is nil, we do
1969 not set local variables (though we do notice a mode specified with -*-.)
1971 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1972 or from Lisp without specifying the optional argument FIND-FILE;
1973 in that case, this function acts as if `enable-local-variables' were t."
1975 (funcall (or default-major-mode
'fundamental-mode
))
1976 (let ((enable-local-variables (or (not find-file
) enable-local-variables
)))
1977 (report-errors "File mode specification error: %s"
1979 (report-errors "File local-variables error: %s"
1980 (hack-local-variables)))
1981 ;; Turn font lock off and on, to make sure it takes account of
1982 ;; whatever file local variables are relevant to it.
1983 (when (and font-lock-mode
1984 ;; Font-lock-mode (now in font-core.el) can be ON when
1985 ;; font-lock.el still hasn't been loaded.
1986 (boundp 'font-lock-keywords
)
1987 (eq (car font-lock-keywords
) t
))
1988 (setq font-lock-keywords
(cadr font-lock-keywords
))
1991 (if (fboundp 'ucs-set-table-for-input
) ; don't lose when building
1992 (ucs-set-table-for-input)))
1994 (defcustom auto-mode-case-fold nil
1995 "Non-nil means to try second pass through `auto-mode-alist'.
1996 This means that if the first case-sensitive search through the alist fails
1997 to find a matching major mode, a second case-insensitive search is made.
1998 On systems with case-insensitive file names, this variable is ignored,
1999 since only a single case-insensitive search through the alist is made."
2004 (defvar auto-mode-alist
2005 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2006 ;; c++-mode, java-mode and more) are added through autoload
2007 ;; directives in that file. That way is discouraged since it
2008 ;; spreads out the definition of the initial value.
2011 (cons (purecopy (car elt
)) (cdr elt
)))
2012 `(;; do this first, so that .html.pl is Polish html, not Perl
2013 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode
)
2014 ("\\.te?xt\\'" . text-mode
)
2015 ("\\.[tT]e[xX]\\'" . tex-mode
)
2016 ("\\.ins\\'" . tex-mode
) ;Installation files for TeX packages.
2017 ("\\.ltx\\'" . latex-mode
)
2018 ("\\.dtx\\'" . doctex-mode
)
2019 ("\\.org\\'" . org-mode
)
2020 ("\\.el\\'" . emacs-lisp-mode
)
2021 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode
)
2022 ("\\.l\\'" . lisp-mode
)
2023 ("\\.li?sp\\'" . lisp-mode
)
2024 ("\\.[fF]\\'" . fortran-mode
)
2025 ("\\.for\\'" . fortran-mode
)
2026 ("\\.p\\'" . pascal-mode
)
2027 ("\\.pas\\'" . pascal-mode
)
2028 ("\\.ad[abs]\\'" . ada-mode
)
2029 ("\\.ad[bs].dg\\'" . ada-mode
)
2030 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode
)
2031 ("Imakefile\\'" . makefile-imake-mode
)
2032 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode
) ; Put this before .mk
2033 ("\\.makepp\\'" . makefile-makepp-mode
)
2034 ,@(if (memq system-type
'(berkeley-unix next-mach darwin
))
2035 '(("\\.mk\\'" . makefile-bsdmake-mode
)
2036 ("GNUmakefile\\'" . makefile-gmake-mode
)
2037 ("[Mm]akefile\\'" . makefile-bsdmake-mode
))
2038 '(("\\.mk\\'" . makefile-gmake-mode
) ; Might be any make, give Gnu the host advantage
2039 ("[Mm]akefile\\'" . makefile-gmake-mode
)))
2040 ("\\.am\\'" . makefile-automake-mode
)
2041 ;; Less common extensions come here
2042 ;; so more common ones above are found faster.
2043 ("\\.texinfo\\'" . texinfo-mode
)
2044 ("\\.te?xi\\'" . texinfo-mode
)
2045 ("\\.[sS]\\'" . asm-mode
)
2046 ("\\.asm\\'" . asm-mode
)
2047 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode
)
2048 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode
)
2049 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode
)
2050 ("\\.scm\\.[0-9]*\\'" . scheme-mode
)
2051 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode
)
2052 ("\\.bash\\'" . sh-mode
)
2053 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode
)
2054 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode
)
2055 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode
)
2056 ("\\.m?spec\\'" . sh-mode
)
2057 ("\\.m[mes]\\'" . nroff-mode
)
2058 ("\\.man\\'" . nroff-mode
)
2059 ("\\.sty\\'" . latex-mode
)
2060 ("\\.cl[so]\\'" . latex-mode
) ;LaTeX 2e class option
2061 ("\\.bbl\\'" . latex-mode
)
2062 ("\\.bib\\'" . bibtex-mode
)
2063 ("\\.sql\\'" . sql-mode
)
2064 ("\\.m[4c]\\'" . m4-mode
)
2065 ("\\.mf\\'" . metafont-mode
)
2066 ("\\.mp\\'" . metapost-mode
)
2067 ("\\.vhdl?\\'" . vhdl-mode
)
2068 ("\\.article\\'" . text-mode
)
2069 ("\\.letter\\'" . text-mode
)
2070 ("\\.i?tcl\\'" . tcl-mode
)
2071 ("\\.exp\\'" . tcl-mode
)
2072 ("\\.itk\\'" . tcl-mode
)
2073 ("\\.icn\\'" . icon-mode
)
2074 ("\\.sim\\'" . simula-mode
)
2075 ("\\.mss\\'" . scribe-mode
)
2076 ("\\.f9[05]\\'" . f90-mode
)
2077 ("\\.indent\\.pro\\'" . fundamental-mode
) ; to avoid idlwave-mode
2078 ("\\.pro\\'" . idlwave-mode
)
2079 ("\\.prolog\\'" . prolog-mode
)
2080 ("\\.tar\\'" . tar-mode
)
2081 ;; The list of archive file extensions should be in sync with
2082 ;; `auto-coding-alist' with `no-conversion' coding system.
2084 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2085 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode
)
2086 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode
) ; OpenOffice.org
2087 ("\\.\\(deb\\)\\'" . archive-mode
) ; Debian packages.
2088 ;; Mailer puts message to be edited in
2089 ;; /tmp/Re.... or Message
2090 ("\\`/tmp/Re" . text-mode
)
2091 ("/Message[0-9]*\\'" . text-mode
)
2092 ("\\.zone\\'" . zone-mode
)
2093 ;; some news reader is reported to use this
2094 ("\\`/tmp/fol/" . text-mode
)
2095 ("\\.oak\\'" . scheme-mode
)
2096 ("\\.sgml?\\'" . sgml-mode
)
2097 ("\\.x[ms]l\\'" . xml-mode
)
2098 ("\\.dtd\\'" . sgml-mode
)
2099 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode
)
2100 ("\\.js\\'" . java-mode
) ; javascript-mode would be better
2101 ("\\.d?v\\'" . verilog-mode
)
2102 ;; .emacs or .gnus or .viper following a directory delimiter in
2103 ;; Unix, MSDOG or VMS syntax.
2104 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode
)
2105 ("\\`\\..*emacs\\'" . emacs-lisp-mode
)
2106 ;; _emacs following a directory delimiter
2108 ("[:/]_emacs\\'" . emacs-lisp-mode
)
2109 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode
)
2110 ("\\.ml\\'" . lisp-mode
)
2111 ;; Common Lisp ASDF package system.
2112 ("\\.asd\\'" . lisp-mode
)
2113 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode
)
2114 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode
)
2115 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode
)
2116 ("\\.\\(dif\\|pat\\)\\'" . diff-mode
) ; for MSDOG
2117 ("\\.[eE]?[pP][sS]\\'" . ps-mode
)
2118 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode
)
2119 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode
)
2120 ("BROWSE\\'" . ebrowse-tree-mode
)
2121 ("\\.ebrowse\\'" . ebrowse-tree-mode
)
2122 ("#\\*mail\\*" . mail-mode
)
2123 ("\\.g\\'" . antlr-mode
)
2124 ("\\.ses\\'" . ses-mode
)
2125 ("\\.\\(soa\\|zone\\)\\'" . dns-mode
)
2126 ("\\.docbook\\'" . sgml-mode
)
2127 ("\\.com\\'" . dcl-mode
)
2128 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode
)
2129 ;; Windows candidates may be opened case sensitively on Unix
2130 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode
)
2131 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode
)
2132 ("\\.ppd\\'" . conf-ppd-mode
)
2133 ("java.+\\.conf\\'" . conf-javaprop-mode
)
2134 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode
)
2135 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2136 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe
)
2137 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode
)
2138 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode
)
2139 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2140 ;; this has lower priority to avoid matching changelog.sgml etc.
2141 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode
)
2142 ;; either user's dot-files or under /etc or some such
2143 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode
)
2144 ;; alas not all ~/.*rc files are like this
2145 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode
)
2146 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode
)
2147 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode
)
2148 ("/X11.+app-defaults/" . conf-xdefaults-mode
)
2149 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode
)
2150 ;; this contains everything twice, with space and with colon :-(
2151 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode
)
2152 ;; Get rid of any trailing .n.m and try again.
2153 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2154 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2155 ;; Using mode nil rather than `ignore' would let the search continue
2156 ;; through this list (with the shortened name) rather than start over.
2157 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t
)
2158 ;; The following should come after the ChangeLog pattern
2159 ;; for the sake of ChangeLog.1, etc.
2160 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2161 ("\\.[1-9]\\'" . nroff-mode
)
2162 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t
)))
2163 "Alist of filename patterns vs corresponding major mode functions.
2164 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2165 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2166 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2167 mode function to use. FUNCTION will be called, unless it is nil.
2169 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2170 calling FUNCTION (if it's not nil), we delete the suffix that matched
2171 REGEXP and search the list again for another match.
2173 If the file name matches `inhibit-first-line-modes-regexps',
2174 then `auto-mode-alist' is not processed.
2176 The extensions whose FUNCTION is `archive-mode' should also
2177 appear in `auto-coding-alist' with `no-conversion' coding system.
2179 See also `interpreter-mode-alist', which detects executable script modes
2180 based on the interpreters they specify to run,
2181 and `magic-mode-alist', which determines modes based on file contents.")
2183 (defun conf-mode-maybe ()
2184 "Select Conf mode or XML mode according to start of file."
2188 (goto-char (point-min))
2189 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2193 (defvar interpreter-mode-alist
2194 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2195 ;; and pike-mode) are added through autoload directives in that
2196 ;; file. That way is discouraged since it spreads out the
2197 ;; definition of the initial value.
2200 (cons (purecopy (car l
)) (cdr l
)))
2201 '(("perl" . perl-mode
)
2202 ("perl5" . perl-mode
)
2203 ("miniperl" . perl-mode
)
2205 ("wishx" . tcl-mode
)
2207 ("tclsh" . tcl-mode
)
2208 ("scm" . scheme-mode
)
2228 ("tail" . text-mode
)
2229 ("more" . text-mode
)
2230 ("less" . text-mode
)
2232 ("make" . makefile-gmake-mode
) ; Debian uses this
2233 ("guile" . scheme-mode
)
2234 ("clisp" . lisp-mode
)))
2235 "Alist mapping interpreter names to major modes.
2236 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2237 Each element looks like (INTERPRETER . MODE).
2238 If INTERPRETER matches the name of the interpreter specified in the first line
2239 of a script, mode MODE is enabled.
2241 See also `auto-mode-alist'.")
2243 (defvar inhibit-first-line-modes-regexps
'("\\.tar\\'" "\\.tgz\\'")
2244 "List of regexps; if one matches a file name, don't look for `-*-'.")
2246 (defvar inhibit-first-line-modes-suffixes nil
2247 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2248 When checking `inhibit-first-line-modes-regexps', we first discard
2249 from the end of the file name anything that matches one of these regexps.")
2251 (defvar auto-mode-interpreter-regexp
2252 "#![ \t]?\\([^ \t\n]*\
2253 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2254 "Regexp matching interpreters, for file mode determination.
2255 This regular expression is matched against the first line of a file
2256 to determine the file's mode in `set-auto-mode'. If it matches, the file
2257 is assumed to be interpreted by the interpreter matched by the second group
2258 of the regular expression. The mode is then determined as the mode
2259 associated with that interpreter in `interpreter-mode-alist'.")
2261 (defvar magic-mode-alist nil
2262 "Alist of buffer beginnings vs. corresponding major mode functions.
2263 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2264 After visiting a file, if REGEXP matches the text at the beginning of the
2265 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2266 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2269 If FUNCTION is nil, then it is not called. (That is a way of saying
2270 \"allow `auto-mode-alist' to decide for these files.\")")
2271 (put 'magic-mode-alist
'risky-local-variable t
)
2273 (defvar magic-fallback-mode-alist
2274 `((image-type-auto-detected-p . image-mode
)
2275 ;; The < comes before the groups (but the first) to reduce backtracking.
2276 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2277 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2278 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2279 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2280 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2282 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re
"*\\)?"
2283 "[Hh][Tt][Mm][Ll]"))
2285 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode
)
2286 ;; These two must come after html, because they are more general:
2287 ("<\\?xml " . xml-mode
)
2288 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2289 (comment-re (concat "\\(?:!--" incomment-re
"*-->[ \t\r\n]*<\\)")))
2290 (concat "[ \t\r\n]*<" comment-re
"*!DOCTYPE "))
2293 ("# xmcd " . conf-unix-mode
))
2294 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2295 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2296 After visiting a file, if REGEXP matches the text at the beginning of the
2297 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2298 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2299 have not specified a mode for this file.
2301 If FUNCTION is nil, then it is not called.")
2302 (put 'magic-fallback-mode-alist
'risky-local-variable t
)
2304 (defvar magic-mode-regexp-match-limit
4000
2305 "Upper limit on `magic-mode-alist' regexp matches.
2306 Also applies to `magic-fallback-mode-alist'.")
2308 (defun set-auto-mode (&optional keep-mode-if-same
)
2309 "Select major mode appropriate for current buffer.
2311 To find the right major mode, this function checks for a -*- mode tag,
2312 checks if it uses an interpreter listed in `interpreter-mode-alist',
2313 matches the buffer beginning against `magic-mode-alist',
2314 compares the filename against the entries in `auto-mode-alist',
2315 then matches the buffer beginning against `magic-fallback-mode-alist'.
2317 It does not check for the `mode:' local variable in the
2318 Local Variables section of the file; for that, use `hack-local-variables'.
2320 If `enable-local-variables' is nil, this function does not check for a
2323 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2324 set the major mode only if that would change it. In other words
2325 we don't actually set it to the same mode the buffer already has."
2326 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2327 (let (end done mode modes
)
2328 ;; Find a -*- mode tag
2330 (goto-char (point-min))
2331 (skip-chars-forward " \t\n")
2332 (and enable-local-variables
2333 (setq end
(set-auto-mode-1))
2334 (if (save-excursion (search-forward ":" end t
))
2335 ;; Find all specifications for the `mode:' variable
2336 ;; and execute them left to right.
2337 (while (let ((case-fold-search t
))
2338 (or (and (looking-at "mode:")
2339 (goto-char (match-end 0)))
2340 (re-search-forward "[ \t;]mode:" end t
)))
2341 (skip-chars-forward " \t")
2342 (let ((beg (point)))
2343 (if (search-forward ";" end t
)
2346 (skip-chars-backward " \t")
2347 (push (intern (concat (downcase (buffer-substring beg
(point))) "-mode"))
2349 ;; Simple -*-MODE-*- case.
2350 (push (intern (concat (downcase (buffer-substring (point) end
))
2353 ;; If we found modes to use, invoke them now, outside the save-excursion.
2356 (dolist (mode (nreverse modes
))
2357 (if (not (functionp mode
))
2358 (message "Ignoring unknown mode `%s'" mode
)
2360 (or (set-auto-mode-0 mode keep-mode-if-same
)
2361 ;; continuing would call minor modes again, toggling them off
2362 (throw 'nop nil
))))))
2363 ;; If we didn't, look for an interpreter specified in the first line.
2364 ;; As a special case, allow for things like "#!/bin/env perl", which
2365 ;; finds the interpreter anywhere in $PATH.
2367 (setq mode
(save-excursion
2368 (goto-char (point-min))
2369 (if (looking-at auto-mode-interpreter-regexp
)
2372 ;; Map interpreter name to a mode, signalling we're done at the
2374 done
(assoc (file-name-nondirectory mode
)
2375 interpreter-mode-alist
))
2376 ;; If we found an interpreter mode to use, invoke it now.
2378 (set-auto-mode-0 (cdr done
) keep-mode-if-same
)))
2379 ;; Next try matching the buffer beginning against magic-mode-alist.
2381 (if (setq done
(save-excursion
2382 (goto-char (point-min))
2384 (narrow-to-region (point-min)
2386 (+ (point-min) magic-mode-regexp-match-limit
)))
2387 (assoc-default nil magic-mode-alist
2391 (looking-at re
)))))))
2392 (set-auto-mode-0 done keep-mode-if-same
)))
2393 ;; Next compare the filename against the entries in auto-mode-alist.
2395 (if buffer-file-name
2396 (let ((name buffer-file-name
)
2397 (remote-id (file-remote-p buffer-file-name
)))
2398 ;; Remove remote file name identification.
2399 (when (and (stringp remote-id
)
2400 (string-match (regexp-quote remote-id
) name
))
2401 (setq name
(substring name
(match-end 0))))
2402 ;; Remove backup-suffixes from file name.
2403 (setq name
(file-name-sans-versions name
))
2405 ;; Find first matching alist entry.
2407 (if (memq system-type
'(vax-vms windows-nt cygwin
))
2408 ;; System is case-insensitive.
2409 (let ((case-fold-search t
))
2410 (assoc-default name auto-mode-alist
2412 ;; System is case-sensitive.
2414 ;; First match case-sensitively.
2415 (let ((case-fold-search nil
))
2416 (assoc-default name auto-mode-alist
2418 ;; Fallback to case-insensitive match.
2419 (and auto-mode-case-fold
2420 (let ((case-fold-search t
))
2421 (assoc-default name auto-mode-alist
2426 (setq mode
(car mode
)
2427 name
(substring name
0 (match-beginning 0)))
2430 (set-auto-mode-0 mode keep-mode-if-same
)
2432 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2434 (if (setq done
(save-excursion
2435 (goto-char (point-min))
2437 (narrow-to-region (point-min)
2439 (+ (point-min) magic-mode-regexp-match-limit
)))
2440 (assoc-default nil magic-fallback-mode-alist
2444 (looking-at re
)))))))
2445 (set-auto-mode-0 done keep-mode-if-same
)))))
2447 ;; When `keep-mode-if-same' is set, we are working on behalf of
2448 ;; set-visited-file-name. In that case, if the major mode specified is the
2449 ;; same one we already have, don't actually reset it. We don't want to lose
2450 ;; minor modes such as Font Lock.
2451 (defun set-auto-mode-0 (mode &optional keep-mode-if-same
)
2452 "Apply MODE and return it.
2453 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2454 any aliases and compared to current major mode. If they are the
2455 same, do nothing and return nil."
2456 (unless (and keep-mode-if-same
2457 (eq (indirect-function mode
)
2458 (indirect-function major-mode
)))
2463 (defun set-auto-mode-1 ()
2464 "Find the -*- spec in the buffer.
2465 Call with point at the place to start searching from.
2466 If one is found, set point to the beginning
2467 and return the position of the end.
2468 Otherwise, return nil; point may be changed."
2471 ;; Don't look for -*- if this file name matches any
2472 ;; of the regexps in inhibit-first-line-modes-regexps.
2473 (let ((temp inhibit-first-line-modes-regexps
)
2474 (name (if buffer-file-name
2475 (file-name-sans-versions buffer-file-name
)
2477 (while (let ((sufs inhibit-first-line-modes-suffixes
))
2478 (while (and sufs
(not (string-match (car sufs
) name
)))
2479 (setq sufs
(cdr sufs
)))
2481 (setq name
(substring name
0 (match-beginning 0))))
2483 (not (string-match (car temp
) name
)))
2484 (setq temp
(cdr temp
)))
2487 (search-forward "-*-" (line-end-position
2488 ;; If the file begins with "#!"
2489 ;; (exec interpreter magic), look
2490 ;; for mode frobs in the first two
2491 ;; lines. You cannot necessarily
2492 ;; put them in the first line of
2493 ;; such a file without screwing up
2494 ;; the interpreter invocation.
2495 ;; The same holds for
2497 ;; in man pages (preprocessor
2498 ;; magic for the `man' program).
2499 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t
)
2501 (skip-chars-forward " \t")
2503 (search-forward "-*-" (line-end-position) t
))
2506 (skip-chars-backward " \t")
2511 ;;; Handling file local variables
2513 (defvar ignored-local-variables
2514 '(ignored-local-variables safe-local-variable-values
)
2515 "Variables to be ignored in a file's local variable spec.")
2517 (defvar hack-local-variables-hook nil
2518 "Normal hook run after processing a file's local variables specs.
2519 Major modes can use this to examine user-specified local variables
2520 in order to initialize other data structure based on them.")
2522 (defcustom safe-local-variable-values nil
2523 "List variable-value pairs that are considered safe.
2524 Each element is a cons cell (VAR . VAL), where VAR is a variable
2525 symbol and VAL is a value that is considered safe."
2529 (defcustom safe-local-eval-forms
'((add-hook 'write-file-hooks
'time-stamp
))
2530 "Expressions that are considered safe in an `eval:' local variable.
2531 Add expressions to this list if you want Emacs to evaluate them, when
2532 they appear in an `eval' local variable specification, without first
2533 asking you for confirmation."
2536 :type
'(repeat sexp
))
2538 ;; Risky local variables:
2539 (mapc (lambda (var) (put var
'risky-local-variable t
))
2542 buffer-auto-save-file-name
2544 buffer-file-truename
2546 dabbrev-case-fold-search
2547 dabbrev-case-replace
2549 default-text-properties
2552 enable-local-variables
2556 file-name-handler-alist
2563 ignored-local-variables
2565 imenu-generic-expression
2572 minor-mode-map-alist
2573 minor-mode-overriding-map-alist
2574 mode-line-buffer-identification
2585 overriding-local-map
2586 overriding-terminal-local-map
2589 rmail-output-file-alist
2590 safe-local-variable-values
2591 safe-local-eval-forms
2592 save-some-buffers-action-alist
2593 special-display-buffer-names
2596 unread-command-events
2599 ;; Safe local variables:
2601 ;; For variables defined by major modes, the safety declarations can go into
2602 ;; the major mode's file, since that will be loaded before file variables are
2605 ;; For variables defined by minor modes, put the safety declarations in the
2606 ;; file defining the minor mode after the defcustom/defvar using an autoload
2609 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2611 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2612 ;; minor mode file may not be loaded yet.
2614 ;; For variables defined in the C source code the declaration should go here:
2616 (mapc (lambda (pair)
2617 (put (car pair
) 'safe-local-variable
(cdr pair
)))
2618 '((buffer-read-only . booleanp
) ;; C source code
2619 (default-directory . stringp
) ;; C source code
2620 (fill-column . integerp
) ;; C source code
2621 (indent-tabs-mode . booleanp
) ;; C source code
2622 (left-margin . integerp
) ;; C source code
2623 (no-update-autoloads . booleanp
)
2624 (tab-width . integerp
) ;; C source code
2625 (truncate-lines . booleanp
))) ;; C source code
2627 (put 'c-set-style
'safe-local-eval-function t
)
2629 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars
)
2630 "Get confirmation before setting up local variable values.
2631 ALL-VARS is the list of all variables to be set up.
2632 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2633 RISKY-VARS is the list of those that are marked as risky."
2636 (let ((name (if buffer-file-name
2637 (file-name-nondirectory buffer-file-name
)
2638 (concat "buffer " (buffer-name))))
2639 (offer-save (and (eq enable-local-variables t
) unsafe-vars
))
2641 (save-window-excursion
2642 (let ((buf (get-buffer-create "*Local Variables*")))
2644 (set (make-local-variable 'cursor-type
) nil
)
2647 (insert "The local variables list in " name
2648 "\ncontains values that may not be safe (*)"
2650 ", and variables that are risky (**)."
2653 (insert "The local variables list in " name
2654 "\ncontains variables that are risky (**).")
2655 (insert "A local variables list is specified in " name
".")))
2656 (insert "\n\nDo you want to apply it? You can type
2657 y -- to apply the local variables list.
2658 n -- to ignore the local variables list.")
2661 ! -- to apply the local variables list, and permanently mark these
2662 values (*) as safe (in the future, they will be set automatically.)\n\n")
2664 (dolist (elt all-vars
)
2665 (cond ((member elt unsafe-vars
)
2667 ((member elt risky-vars
)
2671 (princ (car elt
) buf
)
2673 ;; Make strings with embedded whitespace easier to read.
2674 (let ((print-escape-newlines t
))
2675 (prin1 (cdr elt
) buf
))
2678 (format "Please type %s%s: "
2679 (if offer-save
"y, n, or !" "y or n")
2680 (if (< (line-number-at-pos) (window-body-height))
2682 ", or C-v to scroll")))
2683 (goto-char (point-min))
2684 (let ((cursor-in-echo-area t
)
2685 (executing-kbd-macro executing-kbd-macro
)
2687 (if offer-save
'(?
! ?y ?n ?\s ?\C-g
) '(?y ?n ?\s ?\C-g
)))
2690 (message "%s" prompt
)
2691 (setq char
(read-event))
2693 (cond ((eq char ?\C-v
)
2696 (error (goto-char (point-min)))))
2697 ;; read-event returns -1 if we are in a kbd
2698 ;; macro and there are no more events in the
2699 ;; macro. In that case, attempt to get an
2700 ;; event interactively.
2701 ((and executing-kbd-macro
(= char -
1))
2702 (setq executing-kbd-macro nil
))
2703 (t (setq done
(memq (downcase char
) exit-chars
)))))))
2704 (setq char
(downcase char
))
2705 (when (and offer-save
(= char ?
!) unsafe-vars
)
2706 (dolist (elt unsafe-vars
)
2707 (add-to-list 'safe-local-variable-values elt
))
2708 ;; When this is called from desktop-restore-file-buffer,
2709 ;; coding-system-for-read may be non-nil. Reset it before
2710 ;; writing to .emacs.
2711 (if (or custom-file user-init-file
)
2712 (let ((coding-system-for-read nil
))
2713 (customize-save-variable
2714 'safe-local-variable-values
2715 safe-local-variable-values
))))
2721 (defun hack-local-variables-prop-line (&optional mode-only
)
2722 "Return local variables specified in the -*- line.
2723 Ignore any specification for `mode:' and `coding:';
2724 `set-auto-mode' should already have handled `mode:',
2725 `set-auto-coding' should already have handled `coding:'.
2727 If MODE-ONLY is non-nil, all we do is check whether the major
2728 mode is specified, returning t if it is specified. Otherwise,
2729 return an alist of elements (VAR . VAL), where VAR is a variable
2730 and VAL is the specified value."
2732 (goto-char (point-min))
2733 (let ((end (set-auto-mode-1))
2734 result mode-specified
)
2735 ;; Parse the -*- line into the RESULT alist.
2736 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2739 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2740 ;; Simple form: "-*- MODENAME -*-". Already handled.
2741 (setq mode-specified t
)
2744 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2745 ;; (last ";" is optional).
2746 (while (< (point) end
)
2747 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2748 (error "Malformed -*- line"))
2749 (goto-char (match-end 0))
2750 ;; There used to be a downcase here,
2751 ;; but the manual didn't say so,
2752 ;; and people want to set var names that aren't all lc.
2753 (let ((key (intern (match-string 1)))
2754 (val (save-restriction
2755 (narrow-to-region (point) end
)
2756 (read (current-buffer)))))
2757 ;; It is traditional to ignore
2758 ;; case when checking for `mode' in set-auto-mode,
2759 ;; so we must do that here as well.
2760 ;; That is inconsistent, but we're stuck with it.
2761 ;; The same can be said for `coding' in set-auto-coding.
2762 (or (and (equal (downcase (symbol-name key
)) "mode")
2763 (setq mode-specified t
))
2764 (equal (downcase (symbol-name key
)) "coding")
2766 (push (cons (if (eq key
'eval
)
2768 (indirect-variable key
))
2771 (skip-chars-forward " \t;")))))
2777 (defun hack-local-variables (&optional mode-only
)
2778 "Parse and put into effect this buffer's local variables spec.
2779 If MODE-ONLY is non-nil, all we do is check whether the major mode
2780 is specified, returning t if it is specified."
2781 (let ((enable-local-variables
2782 (and local-enable-local-variables enable-local-variables
))
2784 (when (or mode-only enable-local-variables
)
2785 (setq result
(hack-local-variables-prop-line mode-only
))
2786 ;; Look for "Local variables:" line in last page.
2788 (goto-char (point-max))
2789 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2791 (when (let ((case-fold-search t
))
2792 (search-forward "Local Variables:" nil t
))
2793 (skip-chars-forward " \t")
2794 ;; suffix is what comes after "local variables:" in its line.
2795 ;; prefix is what comes before "local variables:" in its line.
2798 (regexp-quote (buffer-substring (point)
2799 (line-end-position)))
2802 (concat "^" (regexp-quote
2803 (buffer-substring (line-beginning-position)
2804 (match-beginning 0)))))
2808 (let ((startpos (point))
2810 (thisbuf (current-buffer)))
2812 (unless (let ((case-fold-search t
))
2814 (concat prefix
"[ \t]*End:[ \t]*" suffix
)
2816 (error "Local variables list is not properly terminated"))
2818 (setq endpos
(point)))
2821 (insert-buffer-substring thisbuf startpos endpos
)
2822 (goto-char (point-min))
2823 (subst-char-in-region (point) (point-max) ?\^m ?
\n)
2825 ;; Discard the prefix.
2826 (if (looking-at prefix
)
2827 (delete-region (point) (match-end 0))
2828 (error "Local variables entry is missing the prefix"))
2830 ;; Discard the suffix.
2831 (if (looking-back suffix
)
2832 (delete-region (match-beginning 0) (point))
2833 (error "Local variables entry is missing the suffix"))
2835 (goto-char (point-min))
2838 ;; Find the variable name; strip whitespace.
2839 (skip-chars-forward " \t")
2841 (skip-chars-forward "^:\n")
2842 (if (eolp) (error "Missing colon in local variables entry"))
2843 (skip-chars-backward " \t")
2844 (let* ((str (buffer-substring beg
(point)))
2847 ;; Read the variable value.
2848 (skip-chars-forward "^:")
2850 (setq val
(read (current-buffer)))
2854 (unless (eq var
'coding
)
2856 (push (cons (if (eq var
'eval
)
2858 (indirect-variable var
))
2861 (forward-line 1)))))))
2863 ;; We've read all the local variables. Now, return whether the
2864 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2865 ;; variables (if MODE-ONLY is nil.)
2868 (dolist (ignored ignored-local-variables
)
2869 (setq result
(assq-delete-all ignored result
)))
2870 (if (null enable-local-eval
)
2871 (setq result
(assq-delete-all 'eval result
)))
2873 (setq result
(nreverse result
))
2874 ;; Find those variables that we may want to save to
2875 ;; `safe-local-variable-values'.
2876 (let (risky-vars unsafe-vars
)
2877 (dolist (elt result
)
2878 (let ((var (car elt
))
2880 ;; Don't query about the fake variables.
2881 (or (memq var
'(mode unibyte coding
))
2883 (or (eq enable-local-eval t
)
2884 (hack-one-local-variable-eval-safep
2885 (eval (quote val
)))))
2886 (safe-local-variable-p var val
)
2887 (and (risky-local-variable-p var val
)
2888 (push elt risky-vars
))
2889 (push elt unsafe-vars
))))
2890 (if (eq enable-local-variables
:safe
)
2891 ;; If caller wants only the safe variables,
2892 ;; install only them.
2893 (dolist (elt result
)
2894 (unless (or (member elt unsafe-vars
)
2895 (member elt risky-vars
))
2896 (hack-one-local-variable (car elt
) (cdr elt
))))
2897 ;; Query, except in the case where all are known safe
2898 ;; if the user wants no quuery in that case.
2899 (if (or (and (eq enable-local-variables t
)
2902 (eq enable-local-variables
:all
)
2903 (hack-local-variables-confirm
2904 result unsafe-vars risky-vars
))
2905 (dolist (elt result
)
2906 (hack-one-local-variable (car elt
) (cdr elt
)))))))
2907 (run-hooks 'hack-local-variables-hook
)))))
2909 (defun safe-local-variable-p (sym val
)
2910 "Non-nil if SYM is safe as a file-local variable with value VAL.
2911 It is safe if any of these conditions are met:
2913 * There is a matching entry (SYM . VAL) in the
2914 `safe-local-variable-values' user option.
2916 * The `safe-local-variable' property of SYM is a function that
2917 evaluates to a non-nil value with VAL as an argument."
2918 (or (member (cons sym val
) safe-local-variable-values
)
2919 (let ((safep (get sym
'safe-local-variable
)))
2920 (and (functionp safep
) (funcall safep val
)))))
2922 (defun risky-local-variable-p (sym &optional ignored
)
2923 "Non-nil if SYM could be dangerous as a file-local variable.
2924 It is dangerous if either of these conditions are met:
2926 * Its `risky-local-variable' property is non-nil.
2928 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2929 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
2930 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2931 \"map-alist\", or \"bindat-spec\"."
2932 ;; If this is an alias, check the base name.
2934 (setq sym
(indirect-variable sym
))
2936 (or (get sym
'risky-local-variable
)
2937 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2938 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2939 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
2940 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym
))))
2942 (defun hack-one-local-variable-quotep (exp)
2943 (and (consp exp
) (eq (car exp
) 'quote
) (consp (cdr exp
))))
2945 (defun hack-one-local-variable-constantp (exp)
2946 (or (and (not (symbolp exp
)) (not (consp exp
)))
2949 (hack-one-local-variable-quotep exp
)))
2951 (defun hack-one-local-variable-eval-safep (exp)
2952 "Return t if it is safe to eval EXP when it is found in a file."
2953 (or (not (consp exp
))
2954 ;; Detect certain `put' expressions.
2955 (and (eq (car exp
) 'put
)
2956 (hack-one-local-variable-quotep (nth 1 exp
))
2957 (hack-one-local-variable-quotep (nth 2 exp
))
2958 (let ((prop (nth 1 (nth 2 exp
))) (val (nth 3 exp
)))
2959 (cond ((eq prop
'lisp-indent-hook
)
2960 ;; Only allow safe values of lisp-indent-hook;
2962 (or (numberp val
) (equal val
''defun
)))
2963 ((eq prop
'edebug-form-spec
)
2964 ;; Only allow indirect form specs.
2965 ;; During bootstrapping, edebug-basic-spec might not be
2967 (and (fboundp 'edebug-basic-spec
)
2968 (hack-one-local-variable-quotep val
)
2969 (edebug-basic-spec (nth 1 val
)))))))
2970 ;; Allow expressions that the user requested.
2971 (member exp safe-local-eval-forms
)
2972 ;; Certain functions can be allowed with safe arguments
2973 ;; or can specify verification functions to try.
2974 (and (symbolp (car exp
))
2975 (let ((prop (get (car exp
) 'safe-local-eval-function
)))
2978 (dolist (arg (cdr exp
))
2979 (unless (hack-one-local-variable-constantp arg
)
2986 (dolist (function prop
)
2987 (if (funcall function exp
)
2991 (defun hack-one-local-variable (var val
)
2992 "Set local variable VAR with value VAL.
2993 If VAR is `mode', call `VAL-mode' as a function unless it's
2994 already the major mode."
2995 (cond ((eq var
'mode
)
2996 (let ((mode (intern (concat (downcase (symbol-name val
))
2998 (unless (eq (indirect-function mode
)
2999 (indirect-function major-mode
))
3002 (save-excursion (eval val
)))
3004 ;; Make sure the string has no text properties.
3005 ;; Some text properties can get evaluated in various ways,
3006 ;; so it is risky to put them on with a local variable list.
3008 (set-text-properties 0 (length val
) nil val
))
3009 (set (make-local-variable var
) val
))))
3012 (defcustom change-major-mode-with-file-name t
3013 "Non-nil means \\[write-file] should set the major mode from the file name.
3014 However, the mode will not be changed if
3015 \(1) a local variables list or the `-*-' line specifies a major mode, or
3016 \(2) the current major mode is a \"special\" mode,
3017 \ not suitable for ordinary files, or
3018 \(3) the new file name does not particularly specify any mode."
3020 :group
'editing-basics
)
3022 (defun set-visited-file-name (filename &optional no-query along-with-file
)
3023 "Change name of file visited in current buffer to FILENAME.
3024 This also renames the buffer to correspond to the new file.
3025 The next time the buffer is saved it will go in the newly specified file.
3026 FILENAME nil or an empty string means mark buffer as not visiting any file.
3027 Remember to delete the initial contents of the minibuffer
3028 if you wish to pass an empty string as the argument.
3030 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3031 confirmation in the case where another buffer is already visiting FILENAME.
3033 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3034 the old visited file has been renamed to the new name FILENAME."
3035 (interactive "FSet visited file name: ")
3036 (if (buffer-base-buffer)
3037 (error "An indirect buffer cannot visit a file"))
3041 (if (string-equal filename
"")
3043 (expand-file-name filename
))))
3046 (setq truename
(file-truename filename
))
3047 (if find-file-visit-truename
3048 (setq filename truename
))))
3050 (let ((new-name (file-name-nondirectory filename
)))
3051 (if (string= new-name
"")
3052 (error "Empty file name"))))
3053 (let ((buffer (and filename
(find-buffer-visiting filename
))))
3054 (and buffer
(not (eq buffer
(current-buffer)))
3056 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3059 (or (equal filename buffer-file-name
)
3061 (and filename
(lock-buffer filename
))
3063 (setq buffer-file-name filename
)
3064 (if filename
; make buffer name reflect filename.
3065 (let ((new-name (file-name-nondirectory buffer-file-name
)))
3066 (if (eq system-type
'vax-vms
)
3067 (setq new-name
(downcase new-name
)))
3068 (setq default-directory
(file-name-directory buffer-file-name
))
3069 ;; If new-name == old-name, renaming would add a spurious <2>
3070 ;; and it's considered as a feature in rename-buffer.
3071 (or (string= new-name
(buffer-name))
3072 (rename-buffer new-name t
))))
3073 (setq buffer-backed-up nil
)
3075 (clear-visited-file-modtime))
3076 ;; Abbreviate the file names of the buffer.
3079 (setq buffer-file-truename
(abbreviate-file-name truename
))
3080 (if find-file-visit-truename
3081 (setq buffer-file-name truename
))))
3082 (setq buffer-file-number
3084 (nthcdr 10 (file-attributes buffer-file-name
))
3086 ;; write-file-functions is normally used for things like ftp-find-file
3087 ;; that visit things that are not local files as if they were files.
3088 ;; Changing to visit an ordinary local file instead should flush the hook.
3089 (kill-local-variable 'write-file-functions
)
3090 (kill-local-variable 'local-write-file-hooks
)
3091 (kill-local-variable 'revert-buffer-function
)
3092 (kill-local-variable 'backup-inhibited
)
3093 ;; If buffer was read-only because of version control,
3094 ;; that reason is gone now, so make it writable.
3096 (setq buffer-read-only nil
))
3097 (kill-local-variable 'vc-mode
)
3098 ;; Turn off backup files for certain file names.
3099 ;; Since this is a permanent local, the major mode won't eliminate it.
3100 (and buffer-file-name
3101 backup-enable-predicate
3102 (not (funcall backup-enable-predicate buffer-file-name
))
3104 (make-local-variable 'backup-inhibited
)
3105 (setq backup-inhibited t
)))
3106 (let ((oauto buffer-auto-save-file-name
))
3107 ;; If auto-save was not already on, turn it on if appropriate.
3108 (if (not buffer-auto-save-file-name
)
3109 (and buffer-file-name auto-save-default
3111 ;; If auto save is on, start using a new name.
3112 ;; We deliberately don't rename or delete the old auto save
3113 ;; for the old visited file name. This is because perhaps
3114 ;; the user wants to save the new state and then compare with the
3115 ;; previous state from the auto save file.
3116 (setq buffer-auto-save-file-name
3117 (make-auto-save-file-name)))
3118 ;; Rename the old auto save file if any.
3119 (and oauto buffer-auto-save-file-name
3120 (file-exists-p oauto
)
3121 (rename-file oauto buffer-auto-save-file-name t
)))
3122 (and buffer-file-name
3123 (not along-with-file
)
3124 (set-buffer-modified-p t
))
3125 ;; Update the major mode, if the file name determines it.
3127 ;; Don't change the mode if it is special.
3128 (or (not change-major-mode-with-file-name
)
3129 (get major-mode
'mode-class
)
3130 ;; Don't change the mode if the local variable list specifies it.
3131 (hack-local-variables t
)
3135 (defun write-file (filename &optional confirm
)
3136 "Write current buffer into file FILENAME.
3137 This makes the buffer visit that file, and marks it as not modified.
3139 If you specify just a directory name as FILENAME, that means to use
3140 the default file name but in that directory. You can also yank
3141 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3143 If the buffer is not already visiting a file, the default file name
3144 for the output file is the buffer name.
3146 If optional second arg CONFIRM is non-nil, this function
3147 asks for confirmation before overwriting an existing file.
3148 Interactively, confirmation is required unless you supply a prefix argument."
3149 ;; (interactive "FWrite file: ")
3151 (list (if buffer-file-name
3152 (read-file-name "Write file: "
3154 (read-file-name "Write file: " default-directory
3156 (file-name-nondirectory (buffer-name))
3159 (not current-prefix-arg
)))
3160 (or (null filename
) (string-equal filename
"")
3162 ;; If arg is just a directory,
3163 ;; use the default file name, but in that directory.
3164 (if (file-directory-p filename
)
3165 (setq filename
(concat (file-name-as-directory filename
)
3166 (file-name-nondirectory
3167 (or buffer-file-name
(buffer-name))))))
3169 (file-exists-p filename
)
3170 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename
))
3171 (error "Canceled")))
3172 (set-visited-file-name filename
(not confirm
))))
3173 (set-buffer-modified-p t
)
3174 ;; Make buffer writable if file is writable.
3175 (and buffer-file-name
3176 (file-writable-p buffer-file-name
)
3177 (setq buffer-read-only nil
))
3179 ;; It's likely that the VC status at the new location is different from
3180 ;; the one at the old location.
3181 (vc-find-file-hook))
3183 (defun backup-buffer ()
3184 "Make a backup of the disk file visited by the current buffer, if appropriate.
3185 This is normally done before saving the buffer the first time.
3187 A backup may be done by renaming or by copying; see documentation of
3188 variable `make-backup-files'. If it's done by renaming, then the file is
3189 no longer accessible under its old name.
3191 The value is non-nil after a backup was made by renaming.
3192 It has the form (MODES . BACKUPNAME).
3193 MODES is the result of `file-modes' on the original
3194 file; this means that the caller, after saving the buffer, should change
3195 the modes of the new file to agree with the old modes.
3196 BACKUPNAME is the backup file name, which is the old file renamed."
3197 (if (and make-backup-files
(not backup-inhibited
)
3198 (not buffer-backed-up
)
3199 (file-exists-p buffer-file-name
)
3200 (memq (aref (elt (file-attributes buffer-file-name
) 8) 0)
3202 (let ((real-file-name buffer-file-name
)
3203 backup-info backupname targets setmodes
)
3204 ;; If specified name is a symbolic link, chase it to the target.
3205 ;; Thus we make the backups in the directory where the real file is.
3206 (setq real-file-name
(file-chase-links real-file-name
))
3207 (setq backup-info
(find-backup-file-name real-file-name
)
3208 backupname
(car backup-info
)
3209 targets
(cdr backup-info
))
3210 ;; (if (file-directory-p buffer-file-name)
3211 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3214 (let ((delete-old-versions
3215 ;; If have old versions to maybe delete,
3216 ;; ask the user to confirm now, before doing anything.
3217 ;; But don't actually delete til later.
3219 (or (eq delete-old-versions t
) (eq delete-old-versions nil
))
3220 (or delete-old-versions
3221 (y-or-n-p (format "Delete excess backup versions of %s? "
3223 (modes (file-modes buffer-file-name
)))
3224 ;; Actually write the back up file.
3226 (if (or file-precious-flag
3227 ; (file-symlink-p buffer-file-name)
3229 ;; Don't rename a suid or sgid file.
3230 (and modes
(< 0 (logand modes
#o6000
)))
3231 (not (file-writable-p (file-name-directory real-file-name
)))
3232 (and backup-by-copying-when-linked
3233 (> (file-nlinks real-file-name
) 1))
3234 (and (or backup-by-copying-when-mismatch
3235 (integerp backup-by-copying-when-privileged-mismatch
))
3236 (let ((attr (file-attributes real-file-name
)))
3237 (and (or backup-by-copying-when-mismatch
3238 (and (integerp (nth 2 attr
))
3239 (integerp backup-by-copying-when-privileged-mismatch
)
3240 (<= (nth 2 attr
) backup-by-copying-when-privileged-mismatch
)))
3242 (not (file-ownership-preserved-p real-file-name
)))))))
3243 (backup-buffer-copy real-file-name backupname modes
)
3244 ;; rename-file should delete old backup.
3245 (rename-file real-file-name backupname t
)
3246 (setq setmodes
(cons modes backupname
)))
3248 ;; If trouble writing the backup, write it in ~.
3249 (setq backupname
(expand-file-name
3250 (convert-standard-filename
3252 (message "Cannot write backup file; backing up in %s"
3255 (backup-buffer-copy real-file-name backupname modes
)))
3256 (setq buffer-backed-up t
)
3257 ;; Now delete the old versions, if desired.
3258 (if delete-old-versions
3261 (delete-file (car targets
))
3263 (setq targets
(cdr targets
))))
3265 (file-error nil
))))))
3267 (defun backup-buffer-copy (from-name to-name modes
)
3268 (let ((umask (default-file-modes)))
3271 ;; Create temp files with strict access rights. It's easy to
3272 ;; loosen them later, whereas it's impossible to close the
3273 ;; time-window of loose permissions otherwise.
3274 (set-default-file-modes ?
\700)
3275 (when (condition-case nil
3276 ;; Try to overwrite old backup first.
3277 (copy-file from-name to-name t t t
)
3279 (while (condition-case nil
3281 (when (file-exists-p to-name
)
3282 (delete-file to-name
))
3283 (copy-file from-name to-name nil t t
)
3285 (file-already-exists t
))
3286 ;; The file was somehow created by someone else between
3287 ;; `delete-file' and `copy-file', so let's try again.
3288 ;; rms says "I think there is also a possible race
3289 ;; condition for making backup files" (emacs-devel 20070821).
3292 (set-default-file-modes umask
)))
3294 (set-file-modes to-name
(logand modes
#o1777
))))
3296 (defun file-name-sans-versions (name &optional keep-backup-version
)
3297 "Return file NAME sans backup versions or strings.
3298 This is a separate procedure so your site-init or startup file can
3300 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3301 we do not remove backup version numbers, only true file version numbers."
3302 (let ((handler (find-file-name-handler name
'file-name-sans-versions
)))
3304 (funcall handler
'file-name-sans-versions name keep-backup-version
)
3306 (if (eq system-type
'vax-vms
)
3307 ;; VMS version number is (a) semicolon, optional
3308 ;; sign, zero or more digits or (b) period, option
3309 ;; sign, zero or more digits, provided this is the
3310 ;; second period encountered outside of the
3311 ;; device/directory part of the file name.
3312 (or (string-match ";[-+]?[0-9]*\\'" name
)
3313 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
3315 (match-beginning 1))
3317 (if keep-backup-version
3319 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name
)
3320 (string-match "~\\'" name
)
3321 (length name
))))))))
3323 (defun file-ownership-preserved-p (file)
3324 "Return t if deleting FILE and rewriting it would preserve the owner."
3325 (let ((handler (find-file-name-handler file
'file-ownership-preserved-p
)))
3327 (funcall handler
'file-ownership-preserved-p file
)
3328 (let ((attributes (file-attributes file
)))
3329 ;; Return t if the file doesn't exist, since it's true that no
3330 ;; information would be lost by an (attempted) delete and create.
3331 (or (null attributes
)
3332 (= (nth 2 attributes
) (user-uid)))))))
3334 (defun file-name-sans-extension (filename)
3335 "Return FILENAME sans final \"extension\".
3336 The extension, in a file name, is the part that follows the last `.',
3337 except that a leading `.', if any, doesn't count."
3339 (let ((file (file-name-sans-versions (file-name-nondirectory filename
)))
3341 (if (and (string-match "\\.[^.]*\\'" file
)
3342 (not (eq 0 (match-beginning 0))))
3343 (if (setq directory
(file-name-directory filename
))
3344 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3345 ;; we don't want to expand it.
3346 (concat directory
(substring file
0 (match-beginning 0)))
3347 (substring file
0 (match-beginning 0)))
3350 (defun file-name-extension (filename &optional period
)
3351 "Return FILENAME's final \"extension\".
3352 The extension, in a file name, is the part that follows the last `.',
3353 excluding version numbers and backup suffixes,
3354 except that a leading `.', if any, doesn't count.
3355 Return nil for extensionless file names such as `foo'.
3356 Return the empty string for file names such as `foo.'.
3358 If PERIOD is non-nil, then the returned value includes the period
3359 that delimits the extension, and if FILENAME has no extension,
3362 (let ((file (file-name-sans-versions (file-name-nondirectory filename
))))
3363 (if (and (string-match "\\.[^.]*\\'" file
)
3364 (not (eq 0 (match-beginning 0))))
3365 (substring file
(+ (match-beginning 0) (if period
0 1)))
3369 (defcustom make-backup-file-name-function nil
3370 "A function to use instead of the default `make-backup-file-name'.
3371 A value of nil gives the default `make-backup-file-name' behavior.
3373 This could be buffer-local to do something special for specific
3374 files. If you define it, you may need to change `backup-file-name-p'
3375 and `file-name-sans-versions' too.
3377 See also `backup-directory-alist'."
3379 :type
'(choice (const :tag
"Default" nil
)
3380 (function :tag
"Your function")))
3382 (defcustom backup-directory-alist nil
3383 "Alist of filename patterns and backup directory names.
3384 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3385 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3386 relative or absolute. If it is absolute, so that all matching files
3387 are backed up into the same directory, the file names in this
3388 directory will be the full name of the file backed up with all
3389 directory separators changed to `!' to prevent clashes. This will not
3390 work correctly if your filesystem truncates the resulting name.
3392 For the common case of all backups going into one directory, the alist
3393 should contain a single element pairing \".\" with the appropriate
3396 If this variable is nil, or it fails to match a filename, the backup
3397 is made in the original file's directory.
3399 On MS-DOS filesystems without long names this variable is always
3402 :type
'(repeat (cons (regexp :tag
"Regexp matching filename")
3403 (directory :tag
"Backup directory name"))))
3405 (defun normal-backup-enable-predicate (name)
3406 "Default `backup-enable-predicate' function.
3407 Checks for files in `temporary-file-directory',
3408 `small-temporary-file-directory', and /tmp."
3409 (not (or (let ((comp (compare-strings temporary-file-directory
0 nil
3411 ;; Directory is under temporary-file-directory.
3412 (and (not (eq comp t
))
3413 (< comp
(- (length temporary-file-directory
)))))
3414 (let ((comp (compare-strings "/tmp" 0 nil
3416 ;; Directory is under /tmp.
3417 (and (not (eq comp t
))
3418 (< comp
(- (length "/tmp")))))
3419 (if small-temporary-file-directory
3420 (let ((comp (compare-strings small-temporary-file-directory
3423 ;; Directory is under small-temporary-file-directory.
3424 (and (not (eq comp t
))
3425 (< comp
(- (length small-temporary-file-directory
)))))))))
3427 (defun make-backup-file-name (file)
3428 "Create the non-numeric backup file name for FILE.
3429 Normally this will just be the file's name with `~' appended.
3430 Customization hooks are provided as follows.
3432 If the variable `make-backup-file-name-function' is non-nil, its value
3433 should be a function which will be called with FILE as its argument;
3434 the resulting name is used.
3436 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3437 the documentation of that variable. If the directory for the backup
3438 doesn't exist, it is created."
3439 (if make-backup-file-name-function
3440 (funcall make-backup-file-name-function file
)
3441 (if (and (eq system-type
'ms-dos
)
3442 (not (msdos-long-file-names)))
3443 (let ((fn (file-name-nondirectory file
)))
3444 (concat (file-name-directory file
)
3445 (or (and (string-match "\\`[^.]+\\'" fn
)
3446 (concat (match-string 0 fn
) ".~"))
3447 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn
)
3448 (concat (match-string 0 fn
) "~")))))
3449 (concat (make-backup-file-name-1 file
) "~"))))
3451 (defun make-backup-file-name-1 (file)
3452 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3453 (let ((alist backup-directory-alist
)
3454 elt backup-directory abs-backup-directory
)
3456 (setq elt
(pop alist
))
3457 (if (string-match (car elt
) file
)
3458 (setq backup-directory
(cdr elt
)
3460 ;; If backup-directory is relative, it should be relative to the
3461 ;; file's directory. By expanding explicitly here, we avoid
3462 ;; depending on default-directory.
3463 (if backup-directory
3464 (setq abs-backup-directory
3465 (expand-file-name backup-directory
3466 (file-name-directory file
))))
3467 (if (and abs-backup-directory
(not (file-exists-p abs-backup-directory
)))
3469 (make-directory abs-backup-directory
'parents
)
3470 (file-error (setq backup-directory nil
3471 abs-backup-directory nil
))))
3472 (if (null backup-directory
)
3474 (if (file-name-absolute-p backup-directory
)
3476 (when (memq system-type
'(windows-nt ms-dos cygwin
))
3477 ;; Normalize DOSish file names: downcase the drive
3478 ;; letter, if any, and replace the leading "x:" with
3480 (or (file-name-absolute-p file
)
3481 (setq file
(expand-file-name file
))) ; make defaults explicit
3482 ;; Replace any invalid file-name characters (for the
3483 ;; case of backing up remote files).
3484 (setq file
(expand-file-name (convert-standard-filename file
)))
3485 (if (eq (aref file
1) ?
:)
3486 (setq file
(concat "/"
3488 (char-to-string (downcase (aref file
0)))
3489 (if (eq (aref file
2) ?
/)
3492 (substring file
2)))))
3493 ;; Make the name unique by substituting directory
3494 ;; separators. It may not really be worth bothering about
3495 ;; doubling `!'s in the original name...
3497 (subst-char-in-string
3499 (replace-regexp-in-string "!" "!!" file
))
3501 (expand-file-name (file-name-nondirectory file
)
3502 (file-name-as-directory abs-backup-directory
))))))
3504 (defun backup-file-name-p (file)
3505 "Return non-nil if FILE is a backup file name (numeric or not).
3506 This is a separate function so you can redefine it for customization.
3507 You may need to redefine `file-name-sans-versions' as well."
3508 (string-match "~\\'" file
))
3510 (defvar backup-extract-version-start
)
3512 ;; This is used in various files.
3513 ;; The usage of backup-extract-version-start is not very clean,
3514 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3515 (defun backup-extract-version (fn)
3516 "Given the name of a numeric backup file, FN, return the backup number.
3517 Uses the free variable `backup-extract-version-start', whose value should be
3518 the index in the name where the version number begins."
3519 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start
)
3520 (= (match-beginning 0) backup-extract-version-start
))
3521 (string-to-number (substring fn backup-extract-version-start -
1))
3524 ;; I believe there is no need to alter this behavior for VMS;
3525 ;; since backup files are not made on VMS, it should not get called.
3526 (defun find-backup-file-name (fn)
3527 "Find a file name for a backup file FN, and suggestions for deletions.
3528 Value is a list whose car is the name for the backup file
3529 and whose cdr is a list of old versions to consider deleting now.
3530 If the value is nil, don't make a backup.
3531 Uses `backup-directory-alist' in the same way as does
3532 `make-backup-file-name'."
3533 (let ((handler (find-file-name-handler fn
'find-backup-file-name
)))
3534 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3536 (funcall handler
'find-backup-file-name fn
)
3537 (if (or (eq version-control
'never
)
3538 ;; We don't support numbered backups on plain MS-DOS
3539 ;; when long file names are unavailable.
3540 (and (eq system-type
'ms-dos
)
3541 (not (msdos-long-file-names))))
3542 (list (make-backup-file-name fn
))
3543 (let* ((basic-name (make-backup-file-name-1 fn
))
3544 (base-versions (concat (file-name-nondirectory basic-name
)
3546 (backup-extract-version-start (length base-versions
))
3548 (number-to-delete 0)
3549 possibilities deserve-versions-p versions
)
3551 (setq possibilities
(file-name-all-completions
3553 (file-name-directory basic-name
))
3554 versions
(sort (mapcar #'backup-extract-version
3557 high-water-mark
(apply 'max
0 versions
)
3558 deserve-versions-p
(or version-control
3559 (> high-water-mark
0))
3560 number-to-delete
(- (length versions
)
3564 (file-error (setq possibilities nil
)))
3565 (if (not deserve-versions-p
)
3566 (list (make-backup-file-name fn
))
3567 (cons (format "%s.~%d~" basic-name
(1+ high-water-mark
))
3568 (if (and (> number-to-delete
0)
3569 ;; Delete nothing if there is overflow
3570 ;; in the number of versions to keep.
3571 (>= (+ kept-new-versions kept-old-versions -
1) 0))
3573 (format "%s.~%d~" basic-name n
))
3574 (let ((v (nthcdr kept-old-versions versions
)))
3575 (rplacd (nthcdr (1- number-to-delete
) v
) ())
3578 (defun file-nlinks (filename)
3579 "Return number of names file FILENAME has."
3580 (car (cdr (file-attributes filename
))))
3582 ;; (defun file-relative-name (filename &optional directory)
3583 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3584 ;; This function returns a relative file name which is equivalent to FILENAME
3585 ;; when used with that default directory as the default.
3586 ;; If this is impossible (which can happen on MSDOS and Windows
3587 ;; when the file name and directory use different drive names)
3588 ;; then it returns FILENAME."
3590 ;; (let ((fname (expand-file-name filename)))
3591 ;; (setq directory (file-name-as-directory
3592 ;; (expand-file-name (or directory default-directory))))
3593 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3594 ;; ;; drive names, they can't be relative, so return the absolute name.
3595 ;; (if (and (or (eq system-type 'ms-dos)
3596 ;; (eq system-type 'cygwin)
3597 ;; (eq system-type 'windows-nt))
3598 ;; (not (string-equal (substring fname 0 2)
3599 ;; (substring directory 0 2))))
3601 ;; (let ((ancestor ".")
3602 ;; (fname-dir (file-name-as-directory fname)))
3603 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3604 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3605 ;; (setq directory (file-name-directory (substring directory 0 -1))
3606 ;; ancestor (if (equal ancestor ".")
3608 ;; (concat "../" ancestor))))
3609 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3610 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3611 ;; ;; We matched within FNAME's directory part.
3612 ;; ;; Add the rest of FNAME onto ANCESTOR.
3613 ;; (let ((rest (substring fname (match-end 0))))
3614 ;; (if (and (equal ancestor ".")
3615 ;; (not (equal rest "")))
3616 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3618 ;; (concat (file-name-as-directory ancestor) rest)))
3619 ;; ;; We matched FNAME's directory equivalent.
3622 (defun file-relative-name (filename &optional directory
)
3623 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3624 This function returns a relative file name which is equivalent to FILENAME
3625 when used with that default directory as the default.
3626 If FILENAME and DIRECTORY lie on different machines or on different drives
3627 on a DOS/Windows machine, it returns FILENAME in expanded form."
3630 (file-name-as-directory (expand-file-name (or directory
3631 default-directory
))))
3632 (setq filename
(expand-file-name filename
))
3633 (let ((fremote (file-remote-p filename
))
3634 (dremote (file-remote-p directory
)))
3635 (if ;; Conditions for separate trees
3637 ;; Test for different drives on DOS/Windows
3639 ;; Should `cygwin' really be included here? --stef
3640 (memq system-type
'(ms-dos cygwin windows-nt
))
3641 (not (eq t
(compare-strings filename
0 2 directory
0 2))))
3642 ;; Test for different remote file system identification
3643 (not (equal fremote dremote
)))
3645 (let ((ancestor ".")
3646 (filename-dir (file-name-as-directory filename
)))
3649 (eq t
(compare-strings filename-dir nil
(length directory
)
3650 directory nil nil case-fold-search
))
3651 (eq t
(compare-strings filename nil
(length directory
)
3652 directory nil nil case-fold-search
))))
3653 (setq directory
(file-name-directory (substring directory
0 -
1))
3654 ancestor
(if (equal ancestor
".")
3656 (concat "../" ancestor
))))
3657 ;; Now ancestor is empty, or .., or ../.., etc.
3658 (if (eq t
(compare-strings filename nil
(length directory
)
3659 directory nil nil case-fold-search
))
3660 ;; We matched within FILENAME's directory part.
3661 ;; Add the rest of FILENAME onto ANCESTOR.
3662 (let ((rest (substring filename
(length directory
))))
3663 (if (and (equal ancestor
".") (not (equal rest
"")))
3664 ;; But don't bother with ANCESTOR if it would give us `./'.
3666 (concat (file-name-as-directory ancestor
) rest
)))
3667 ;; We matched FILENAME's directory equivalent.
3670 (defun save-buffer (&optional args
)
3671 "Save current buffer in visited file if modified.
3672 Variations are described below.
3674 By default, makes the previous version into a backup file
3675 if previously requested or if this is the first save.
3676 Prefixed with one \\[universal-argument], marks this version
3677 to become a backup when the next save is done.
3678 Prefixed with two \\[universal-argument]'s,
3679 unconditionally makes the previous version into a backup file.
3680 Prefixed with three \\[universal-argument]'s, marks this version
3681 to become a backup when the next save is done,
3682 and unconditionally makes the previous version into a backup file.
3684 With a numeric argument of 0, never make the previous version
3687 If a file's name is FOO, the names of its numbered backup versions are
3688 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3689 Numeric backups (rather than FOO~) will be made if value of
3690 `version-control' is not the atom `never' and either there are already
3691 numeric versions of the file being backed up, or `version-control' is
3693 We don't want excessive versions piling up, so there are variables
3694 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3695 and `kept-new-versions', which tells how many newest versions to keep.
3696 Defaults are 2 old versions and 2 new.
3697 `dired-kept-versions' controls dired's clean-directory (.) command.
3698 If `delete-old-versions' is nil, system will query user
3699 before trimming versions. Otherwise it does it silently.
3701 If `vc-make-backup-files' is nil, which is the default,
3702 no backup files are made for files managed by version control.
3703 (This is because the version control system itself records previous versions.)
3705 See the subroutine `basic-save-buffer' for more information."
3707 (let ((modp (buffer-modified-p))
3708 (large (> (buffer-size) 50000))
3709 (make-backup-files (or (and make-backup-files
(not (eq args
0)))
3710 (memq args
'(16 64)))))
3711 (and modp
(memq args
'(16 64)) (setq buffer-backed-up nil
))
3712 (if (and modp large
(buffer-file-name))
3713 (message "Saving file %s..." (buffer-file-name)))
3715 (and modp
(memq args
'(4 64)) (setq buffer-backed-up nil
))))
3717 (defun delete-auto-save-file-if-necessary (&optional force
)
3718 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3719 Normally delete only if the file was written by this Emacs since
3720 the last real save, but optional arg FORCE non-nil means delete anyway."
3721 (and buffer-auto-save-file-name delete-auto-save-files
3722 (not (string= buffer-file-name buffer-auto-save-file-name
))
3723 (or force
(recent-auto-save-p))
3726 (delete-file buffer-auto-save-file-name
)
3728 (set-buffer-auto-saved))))
3730 (defvar auto-save-hook nil
3731 "Normal hook run just before auto-saving.")
3733 (defcustom before-save-hook nil
3734 "Normal hook that is run before a buffer is saved to its file."
3735 :options
'(copyright-update time-stamp
)
3739 (defcustom after-save-hook nil
3740 "Normal hook that is run after a buffer is saved to its file."
3741 :options
'(executable-make-buffer-file-executable-if-script-p)
3745 (defvar save-buffer-coding-system nil
3746 "If non-nil, use this coding system for saving the buffer.
3747 More precisely, use this coding system in place of the
3748 value of `buffer-file-coding-system', when saving the buffer.
3749 Calling `write-region' for any purpose other than saving the buffer
3750 will still use `buffer-file-coding-system'; this variable has no effect
3753 (make-variable-buffer-local 'save-buffer-coding-system
)
3754 (put 'save-buffer-coding-system
'permanent-local t
)
3756 (defun basic-save-buffer ()
3757 "Save the current buffer in its visited file, if it has been modified.
3758 The hooks `write-contents-functions' and `write-file-functions' get a chance
3759 to do the job of saving; if they do not, then the buffer is saved in
3760 the visited file in the usual way.
3761 Before and after saving the buffer, this function runs
3762 `before-save-hook' and `after-save-hook', respectively."
3764 (save-current-buffer
3765 ;; In an indirect buffer, save its base buffer instead.
3766 (if (buffer-base-buffer)
3767 (set-buffer (buffer-base-buffer)))
3768 (if (buffer-modified-p)
3769 (let ((recent-save (recent-auto-save-p))
3771 ;; On VMS, rename file and buffer to get rid of version number.
3772 (if (and (eq system-type
'vax-vms
)
3773 (not (string= buffer-file-name
3774 (file-name-sans-versions buffer-file-name
))))
3775 (let (buffer-new-name)
3776 ;; Strip VMS version number before save.
3777 (setq buffer-file-name
3778 (file-name-sans-versions buffer-file-name
))
3779 ;; Construct a (unique) buffer name to correspond.
3780 (let ((buf (create-file-buffer (downcase buffer-file-name
))))
3781 (setq buffer-new-name
(buffer-name buf
))
3783 (rename-buffer buffer-new-name
)))
3784 ;; If buffer has no file name, ask user for one.
3785 (or buffer-file-name
3788 (read-file-name "File to save in: ") nil
)))
3789 (if (file-exists-p filename
)
3790 (if (file-directory-p filename
)
3791 ;; Signal an error if the user specified the name of an
3792 ;; existing directory.
3793 (error "%s is a directory" filename
)
3794 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3796 (error "Canceled")))
3797 ;; Signal an error if the specified name refers to a
3798 ;; non-existing directory.
3799 (let ((dir (file-name-directory filename
)))
3800 (unless (file-directory-p dir
)
3801 (if (file-exists-p dir
)
3802 (error "%s is not a directory" dir
)
3803 (error "%s: no such directory" dir
)))))
3804 (set-visited-file-name filename
)))
3805 (or (verify-visited-file-modtime (current-buffer))
3806 (not (file-exists-p buffer-file-name
))
3808 (format "%s has changed since visited or saved. Save anyway? "
3809 (file-name-nondirectory buffer-file-name
)))
3810 (error "Save not confirmed"))
3814 (and (> (point-max) (point-min))
3815 (not find-file-literally
)
3816 (/= (char-after (1- (point-max))) ?
\n)
3817 (not (and (eq selective-display t
)
3818 (= (char-after (1- (point-max))) ?
\r)))
3819 (or (eq require-final-newline t
)
3820 (eq require-final-newline
'visit-save
)
3821 (and require-final-newline
3823 (format "Buffer %s does not end in newline. Add one? "
3826 (goto-char (point-max))
3828 ;; Support VC version backups.
3830 (run-hooks 'before-save-hook
)
3831 (or (run-hook-with-args-until-success 'write-contents-functions
)
3832 (run-hook-with-args-until-success 'local-write-file-hooks
)
3833 (run-hook-with-args-until-success 'write-file-functions
)
3834 ;; If a hook returned t, file is already "written".
3835 ;; Otherwise, write it the usual way now.
3836 (setq setmodes
(basic-save-buffer-1)))
3837 ;; Now we have saved the current buffer. Let's make sure
3838 ;; that buffer-file-coding-system is fixed to what
3839 ;; actually used for saving by binding it locally.
3840 (if save-buffer-coding-system
3841 (setq save-buffer-coding-system last-coding-system-used
)
3842 (setq buffer-file-coding-system last-coding-system-used
))
3843 (setq buffer-file-number
3844 (nthcdr 10 (file-attributes buffer-file-name
)))
3847 (set-file-modes buffer-file-name
(car setmodes
))
3849 ;; If the auto-save file was recent before this command,
3851 (delete-auto-save-file-if-necessary recent-save
)
3852 ;; Support VC `implicit' locking.
3854 (run-hooks 'after-save-hook
))
3855 (message "(No changes need to be saved)"))))
3857 ;; This does the "real job" of writing a buffer into its visited file
3858 ;; and making a backup file. This is what is normally done
3859 ;; but inhibited if one of write-file-functions returns non-nil.
3860 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3861 (defun basic-save-buffer-1 ()
3863 (if save-buffer-coding-system
3864 (let ((coding-system-for-write save-buffer-coding-system
))
3865 (basic-save-buffer-2))
3866 (basic-save-buffer-2))
3867 (setq buffer-file-coding-system-explicit last-coding-system-used
)))
3869 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3870 (defun basic-save-buffer-2 ()
3871 (let (tempsetmodes setmodes
)
3872 (if (not (file-writable-p buffer-file-name
))
3873 (let ((dir (file-name-directory buffer-file-name
)))
3874 (if (not (file-directory-p dir
))
3875 (if (file-exists-p dir
)
3876 (error "%s is not a directory" dir
)
3877 (error "%s: no such directory" dir
))
3878 (if (not (file-exists-p buffer-file-name
))
3879 (error "Directory %s write-protected" dir
)
3881 (format "File %s is write-protected; try to save anyway? "
3882 (file-name-nondirectory
3884 (setq tempsetmodes t
)
3885 (error "Attempt to save to a file which you aren't allowed to write"))))))
3886 (or buffer-backed-up
3887 (setq setmodes
(backup-buffer)))
3888 (let ((dir (file-name-directory buffer-file-name
)))
3889 (if (and file-precious-flag
3890 (file-writable-p dir
))
3891 ;; If file is precious, write temp name, then rename it.
3892 ;; This requires write access to the containing dir,
3893 ;; which is why we don't try it if we don't have that access.
3894 (let ((realname buffer-file-name
)
3896 (umask (default-file-modes))
3897 (old-modtime (visited-file-modtime)))
3898 ;; Create temp files with strict access rights. It's easy to
3899 ;; loosen them later, whereas it's impossible to close the
3900 ;; time-window of loose permissions otherwise.
3903 (clear-visited-file-modtime)
3904 (set-default-file-modes ?
\700)
3905 ;; Try various temporary names.
3906 ;; This code follows the example of make-temp-file,
3907 ;; but it calls write-region in the appropriate way
3908 ;; for saving the buffer.
3909 (while (condition-case ()
3913 (expand-file-name "tmp" dir
)))
3914 (write-region (point-min) (point-max)
3915 tempname nil realname
3916 buffer-file-truename
'excl
)
3918 (file-already-exists t
))
3919 ;; The file was somehow created by someone else between
3920 ;; `make-temp-name' and `write-region', let's try again.
3924 (set-default-file-modes umask
)
3925 ;; If we failed, restore the buffer's modtime.
3927 (set-visited-file-modtime old-modtime
)))
3928 ;; Since we have created an entirely new file,
3929 ;; make sure it gets the right permission bits set.
3930 (setq setmodes
(or setmodes
3931 (cons (or (file-modes buffer-file-name
)
3932 (logand ?
\666 umask
))
3934 ;; We succeeded in writing the temp file,
3936 (rename-file tempname buffer-file-name t
))
3937 ;; If file not writable, see if we can make it writable
3938 ;; temporarily while we write it.
3939 ;; But no need to do so if we have just backed it up
3940 ;; (setmodes is set) because that says we're superseding.
3941 (cond ((and tempsetmodes
(not setmodes
))
3942 ;; Change the mode back, after writing.
3943 (setq setmodes
(cons (file-modes buffer-file-name
) buffer-file-name
))
3944 (set-file-modes buffer-file-name
(logior (car setmodes
) 128))))
3948 (write-region (point-min) (point-max)
3949 buffer-file-name nil t buffer-file-truename
)
3951 ;; If we get an error writing the new file, and we made
3952 ;; the backup by renaming, undo the backing-up.
3953 (and setmodes
(not success
)
3955 (rename-file (cdr setmodes
) buffer-file-name t
)
3956 (setq buffer-backed-up nil
)))))))
3959 (defun diff-buffer-with-file (&optional buffer
)
3960 "View the differences between BUFFER and its associated file.
3961 This requires the external program `diff' to be in your `exec-path'."
3962 (interactive "bBuffer: ")
3963 (with-current-buffer (get-buffer (or buffer
(current-buffer)))
3964 (if (and buffer-file-name
3965 (file-exists-p buffer-file-name
))
3966 (let ((tempfile (make-temp-file "buffer-content-")))
3970 (write-region (point-min) (point-max) tempfile nil
'nomessage
)
3971 (diff buffer-file-name tempfile nil t
)
3973 (when (file-exists-p tempfile
)
3974 (delete-file tempfile
))))
3975 (message "Buffer %s has no associated file on disc" (buffer-name))
3976 ;; Display that message for 1 second so that user can read it
3977 ;; in the minibuffer.
3979 ;; return always nil, so that save-buffers-kill-emacs will not move
3980 ;; over to the next unsaved buffer when calling `d'.
3983 (defvar save-some-buffers-action-alist
3988 (exit-recursive-edit)))
3990 ;; Return nil to ask about BUF again.
3994 (save-window-excursion
3995 (diff-buffer-with-file buf
))
3996 (view-buffer (get-buffer-create "*Diff*")
3997 (lambda (ignore) (exit-recursive-edit)))
4000 "view changes in this buffer"))
4001 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4003 (defvar buffer-save-without-query nil
4004 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4005 (make-variable-buffer-local 'buffer-save-without-query
)
4007 (defun save-some-buffers (&optional arg pred
)
4008 "Save some modified file-visiting buffers. Asks user about each one.
4009 You can answer `y' to save, `n' not to save, `C-r' to look at the
4010 buffer in question with `view-buffer' before deciding or `d' to
4011 view the differences using `diff-buffer-with-file'.
4013 Optional argument (the prefix) non-nil means save all with no questions.
4014 Optional second argument PRED determines which buffers are considered:
4015 If PRED is nil, all the file-visiting buffers are considered.
4016 If PRED is t, then certain non-file buffers will also be considered.
4017 If PRED is a zero-argument function, it indicates for each buffer whether
4018 to consider it or not when called with that buffer current.
4020 See `save-some-buffers-action-alist' if you want to
4021 change the additional actions you can take on files."
4023 (save-window-excursion
4024 (let* (queried some-automatic
4025 files-done abbrevs-done
)
4026 (dolist (buffer (buffer-list))
4027 ;; First save any buffers that we're supposed to save unconditionally.
4028 ;; That way the following code won't ask about them.
4029 (with-current-buffer buffer
4030 (when (and buffer-save-without-query
(buffer-modified-p))
4031 (setq some-automatic t
)
4033 ;; Ask about those buffers that merit it,
4034 ;; and record the number thus saved.
4039 (and (buffer-modified-p buffer
)
4040 (not (buffer-base-buffer buffer
))
4042 (buffer-file-name buffer
)
4046 (and buffer-offer-save
(> (buffer-size) 0)))))
4047 (or (not (functionp pred
))
4048 (with-current-buffer buffer
(funcall pred
)))
4052 (if (buffer-file-name buffer
)
4053 (format "Save file %s? "
4054 (buffer-file-name buffer
))
4055 (format "Save buffer %s? "
4056 (buffer-name buffer
)))))))
4062 '("buffer" "buffers" "save")
4063 save-some-buffers-action-alist
))
4064 ;; Maybe to save abbrevs, and record whether
4065 ;; we either saved them or asked to.
4066 (and save-abbrevs abbrevs-changed
4069 (eq save-abbrevs
'silently
)
4070 (y-or-n-p (format "Save abbrevs in %s? "
4072 (write-abbrev-file nil
))
4073 ;; Don't keep bothering user if he says no.
4074 (setq abbrevs-changed nil
)
4075 (setq abbrevs-done t
)))
4076 (or queried
(> files-done
0) abbrevs-done
4077 (message (if some-automatic
4078 "(Some special files were saved without asking)"
4079 "(No files need saving)"))))))
4081 (defun not-modified (&optional arg
)
4082 "Mark current buffer as unmodified, not needing to be saved.
4083 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
4085 It is not a good idea to use this function in Lisp programs, because it
4086 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4088 (message (if arg
"Modification-flag set"
4089 "Modification-flag cleared"))
4090 (set-buffer-modified-p arg
))
4092 (defun toggle-read-only (&optional arg
)
4093 "Change whether this buffer is visiting its file read-only.
4094 With prefix argument ARG, make the buffer read-only if ARG is
4095 positive, otherwise make it writable. If visiting file read-only
4096 and `view-read-only' is non-nil, enter view mode."
4099 (if (> (prefix-numeric-value arg
) 0) buffer-read-only
4100 (not buffer-read-only
))) ; If buffer-read-only is set correctly,
4104 ((and buffer-read-only view-mode
)
4105 (View-exit-and-edit)
4106 (make-local-variable 'view-read-only
)
4107 (setq view-read-only t
)) ; Must leave view mode.
4108 ((and (not buffer-read-only
) view-read-only
4109 ;; If view-mode is already active, `view-mode-enter' is a nop.
4111 (not (eq (get major-mode
'mode-class
) 'special
)))
4113 (t (setq buffer-read-only
(not buffer-read-only
))
4114 (force-mode-line-update)))
4115 (if (vc-backend buffer-file-name
)
4116 (message "%s" (substitute-command-keys
4117 (concat "File is under version-control; "
4118 "use \\[vc-next-action] to check in/out"))))))
4120 (defun insert-file (filename)
4121 "Insert contents of file FILENAME into buffer after point.
4122 Set mark after the inserted text.
4124 This function is meant for the user to run interactively.
4125 Don't call it from programs! Use `insert-file-contents' instead.
4126 \(Its calling sequence is different; see its documentation)."
4127 (interactive "*fInsert file: ")
4128 (insert-file-1 filename
#'insert-file-contents
))
4130 (defun append-to-file (start end filename
)
4131 "Append the contents of the region to the end of file FILENAME.
4132 When called from a function, expects three arguments,
4133 START, END and FILENAME. START and END are buffer positions
4134 saying what text to write."
4135 (interactive "r\nFAppend to file: ")
4136 (write-region start end filename t
))
4138 (defun file-newest-backup (filename)
4139 "Return most recent backup file for FILENAME or nil if no backups exist."
4140 ;; `make-backup-file-name' will get us the right directory for
4141 ;; ordinary or numeric backups. It might create a directory for
4142 ;; backups as a side-effect, according to `backup-directory-alist'.
4143 (let* ((filename (file-name-sans-versions
4144 (make-backup-file-name (expand-file-name filename
))))
4145 (file (file-name-nondirectory filename
))
4146 (dir (file-name-directory filename
))
4147 (comp (file-name-all-completions file dir
))
4151 (setq tem
(pop comp
))
4152 (cond ((and (backup-file-name-p tem
)
4153 (string= (file-name-sans-versions tem
) file
))
4154 (setq tem
(concat dir tem
))
4155 (if (or (null newest
)
4156 (file-newer-than-file-p tem newest
))
4157 (setq newest tem
)))))
4160 (defun rename-uniquely ()
4161 "Rename current buffer to a similar name not already taken.
4162 This function is useful for creating multiple shell process buffers
4163 or multiple mail buffers, etc."
4166 (let ((base-name (buffer-name)))
4167 (and (string-match "<[0-9]+>\\'" base-name
)
4168 (not (and buffer-file-name
4170 (file-name-nondirectory buffer-file-name
))))
4171 ;; If the existing buffer name has a <NNN>,
4172 ;; which isn't part of the file name (if any),
4173 ;; then get rid of that.
4174 (setq base-name
(substring base-name
0 (match-beginning 0))))
4175 (rename-buffer (generate-new-buffer-name base-name
))
4176 (force-mode-line-update))))
4178 (defun make-directory (dir &optional parents
)
4179 "Create the directory DIR and any nonexistent parent dirs.
4180 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4182 Interactively, the default choice of directory to create
4183 is the current default directory for file names.
4184 That is useful when you have visited a file in a nonexistent directory.
4186 Noninteractively, the second (optional) argument PARENTS says whether
4187 to create parent directories if they don't exist. Interactively,
4188 this happens by default."
4190 (list (read-file-name "Make directory: " default-directory default-directory
4193 ;; If default-directory is a remote directory,
4194 ;; make sure we find its make-directory handler.
4195 (setq dir
(expand-file-name dir
))
4196 (let ((handler (find-file-name-handler dir
'make-directory
)))
4198 (funcall handler
'make-directory dir parents
)
4200 (make-directory-internal dir
)
4201 (let ((dir (directory-file-name (expand-file-name dir
)))
4203 (while (not (file-exists-p dir
))
4204 (setq create-list
(cons dir create-list
)
4205 dir
(directory-file-name (file-name-directory dir
))))
4207 (make-directory-internal (car create-list
))
4208 (setq create-list
(cdr create-list
))))))))
4210 (put 'revert-buffer-function
'permanent-local t
)
4211 (defvar revert-buffer-function nil
4212 "Function to use to revert this buffer, or nil to do the default.
4213 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4214 which are the arguments that `revert-buffer' received.")
4216 (put 'revert-buffer-insert-file-contents-function
'permanent-local t
)
4217 (defvar revert-buffer-insert-file-contents-function nil
4218 "Function to use to insert contents when reverting this buffer.
4219 Gets two args, first the nominal file name to use,
4220 and second, t if reading the auto-save file.
4222 The function you specify is responsible for updating (or preserving) point.")
4224 (defvar buffer-stale-function nil
4225 "Function to check whether a non-file buffer needs reverting.
4226 This should be a function with one optional argument NOCONFIRM.
4227 Auto Revert Mode passes t for NOCONFIRM. The function should return
4228 non-nil if the buffer should be reverted. A return value of
4229 `fast' means that the need for reverting was not checked, but
4230 that reverting the buffer is fast. The buffer is current when
4231 this function is called.
4233 The idea behind the NOCONFIRM argument is that it should be
4234 non-nil if the buffer is going to be reverted without asking the
4235 user. In such situations, one has to be careful with potentially
4236 time consuming operations.
4238 For more information on how this variable is used by Auto Revert mode,
4239 see Info node `(emacs)Supporting additional buffers'.")
4241 (defvar before-revert-hook nil
4242 "Normal hook for `revert-buffer' to run before reverting.
4243 If `revert-buffer-function' is used to override the normal revert
4244 mechanism, this hook is not used.")
4246 (defvar after-revert-hook nil
4247 "Normal hook for `revert-buffer' to run after reverting.
4248 Note that the hook value that it runs is the value that was in effect
4249 before reverting; that makes a difference if you have buffer-local
4252 If `revert-buffer-function' is used to override the normal revert
4253 mechanism, this hook is not used.")
4255 (defvar revert-buffer-internal-hook
)
4257 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes
)
4258 "Replace current buffer text with the text of the visited file on disk.
4259 This undoes all changes since the file was visited or saved.
4260 With a prefix argument, offer to revert from latest auto-save file, if
4261 that is more recent than the visited file.
4263 This command also implements an interface for special buffers
4264 that contain text which doesn't come from a file, but reflects
4265 some other data instead (e.g. Dired buffers, `buffer-list'
4266 buffers). This is done via the variable
4267 `revert-buffer-function'. In these cases, it should reconstruct
4268 the buffer contents from the appropriate data.
4270 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4271 to revert from the auto-save file when this is nil. Note that the
4272 sense of this argument is the reverse of the prefix argument, for the
4273 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4276 Optional second argument NOCONFIRM means don't ask for confirmation at
4277 all. \(The variable `revert-without-query' offers another way to
4278 revert buffers without querying for confirmation.)
4280 Optional third argument PRESERVE-MODES non-nil means don't alter
4281 the files modes. Normally we reinitialize them using `normal-mode'.
4283 If the value of `revert-buffer-function' is non-nil, it is called to
4284 do all the work for this command. Otherwise, the hooks
4285 `before-revert-hook' and `after-revert-hook' are run at the beginning
4286 and the end, and if `revert-buffer-insert-file-contents-function' is
4287 non-nil, it is called instead of rereading visited file contents."
4289 ;; I admit it's odd to reverse the sense of the prefix argument, but
4290 ;; there is a lot of code out there which assumes that the first
4291 ;; argument should be t to avoid consulting the auto-save file, and
4292 ;; there's no straightforward way to encourage authors to notice a
4293 ;; reversal of the argument sense. So I'm just changing the user
4294 ;; interface, but leaving the programmatic interface the same.
4295 (interactive (list (not current-prefix-arg
)))
4296 (if revert-buffer-function
4297 (funcall revert-buffer-function ignore-auto noconfirm
)
4298 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4300 (let* ((auto-save-p (and (not ignore-auto
)
4301 (recent-auto-save-p)
4302 buffer-auto-save-file-name
4303 (file-readable-p buffer-auto-save-file-name
)
4305 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4306 (file-name (if auto-save-p
4307 buffer-auto-save-file-name
4309 (cond ((null file-name
)
4310 (error "Buffer does not seem to be associated with any file"))
4312 (and (not (buffer-modified-p))
4314 (dolist (regexp revert-without-query
)
4315 (when (string-match regexp file-name
)
4316 (throw 'found t
)))))
4317 (yes-or-no-p (format "Revert buffer from file %s? "
4319 (run-hooks 'before-revert-hook
)
4320 ;; If file was backed up but has changed since,
4321 ;; we shd make another backup.
4322 (and (not auto-save-p
)
4323 (not (verify-visited-file-modtime (current-buffer)))
4324 (setq buffer-backed-up nil
))
4325 ;; Effectively copy the after-revert-hook status,
4326 ;; since after-find-file will clobber it.
4327 (let ((global-hook (default-value 'after-revert-hook
))
4328 (local-hook (when (local-variable-p 'after-revert-hook
)
4330 (inhibit-read-only t
))
4332 (revert-buffer-insert-file-contents-function
4333 (unless (eq buffer-undo-list t
)
4334 ;; Get rid of all undo records for this buffer.
4335 (setq buffer-undo-list nil
))
4336 ;; Don't make undo records for the reversion.
4337 (let ((buffer-undo-list t
))
4338 (funcall revert-buffer-insert-file-contents-function
4339 file-name auto-save-p
)))
4340 ((not (file-exists-p file-name
))
4341 (error (if buffer-file-number
4342 "File %s no longer exists!"
4343 "Cannot revert nonexistent file %s")
4345 ((not (file-readable-p file-name
))
4346 (error (if buffer-file-number
4347 "File %s no longer readable!"
4348 "Cannot revert unreadable file %s")
4351 ;; Bind buffer-file-name to nil
4352 ;; so that we don't try to lock the file.
4353 (let ((buffer-file-name nil
))
4357 (let ((coding-system-for-read
4358 ;; Auto-saved file should be read by Emacs'
4360 (if auto-save-p
'auto-save-coding
4361 (or coding-system-for-read
4362 buffer-file-coding-system-explicit
))))
4363 (if (and (not enable-multibyte-characters
)
4364 coding-system-for-read
4365 (not (memq (coding-system-base
4366 coding-system-for-read
)
4367 '(no-conversion raw-text
))))
4368 ;; As a coding system suitable for multibyte
4369 ;; buffer is specified, make the current
4370 ;; buffer multibyte.
4371 (set-buffer-multibyte t
))
4373 ;; This force after-insert-file-set-coding
4374 ;; (called from insert-file-contents) to set
4375 ;; buffer-file-coding-system to a proper value.
4376 (kill-local-variable 'buffer-file-coding-system
)
4378 ;; Note that this preserves point in an intelligent way.
4380 (let ((buffer-file-format buffer-file-format
))
4381 (insert-file-contents file-name
(not auto-save-p
)
4383 (insert-file-contents file-name
(not auto-save-p
)
4385 ;; Recompute the truename in case changes in symlinks
4386 ;; have changed the truename.
4387 (setq buffer-file-truename
4388 (abbreviate-file-name (file-truename buffer-file-name
)))
4389 (after-find-file nil nil t t preserve-modes
)
4390 ;; Run after-revert-hook as it was before we reverted.
4391 (setq-default revert-buffer-internal-hook global-hook
)
4393 (set (make-local-variable 'revert-buffer-internal-hook
)
4395 (kill-local-variable 'revert-buffer-internal-hook
))
4396 (run-hooks 'revert-buffer-internal-hook
))
4399 (defun recover-this-file ()
4400 "Recover the visited file--get contents from its last auto-save file."
4402 (recover-file buffer-file-name
))
4404 (defun recover-file (file)
4405 "Visit file FILE, but get contents from its last auto-save file."
4406 ;; Actually putting the file name in the minibuffer should be used
4408 ;; Not just because users often use the default.
4409 (interactive "FRecover file: ")
4410 (setq file
(expand-file-name file
))
4411 (if (auto-save-file-name-p (file-name-nondirectory file
))
4412 (error "%s is an auto-save file" (abbreviate-file-name file
)))
4413 (let ((file-name (let ((buffer-file-name file
))
4414 (make-auto-save-file-name))))
4415 (cond ((if (file-exists-p file
)
4416 (not (file-newer-than-file-p file-name file
))
4417 (not (file-exists-p file-name
)))
4418 (error "Auto-save file %s not current"
4419 (abbreviate-file-name file-name
)))
4420 ((save-window-excursion
4421 (with-output-to-temp-buffer "*Directory*"
4422 (buffer-disable-undo standard-output
)
4424 (let ((switches dired-listing-switches
))
4425 (if (file-symlink-p file
)
4426 (setq switches
(concat switches
"L")))
4427 (set-buffer standard-output
)
4428 ;; Use insert-directory-safely, not insert-directory,
4429 ;; because these files might not exist. In particular,
4430 ;; FILE might not exist if the auto-save file was for
4431 ;; a buffer that didn't visit a file, such as "*mail*".
4432 ;; The code in v20.x called `ls' directly, so we need
4433 ;; to emulate what `ls' did in that case.
4434 (insert-directory-safely file switches
)
4435 (insert-directory-safely file-name switches
))))
4436 (yes-or-no-p (format "Recover auto save file %s? " file-name
)))
4437 (switch-to-buffer (find-file-noselect file t
))
4438 (let ((inhibit-read-only t
)
4439 ;; Keep the current buffer-file-coding-system.
4440 (coding-system buffer-file-coding-system
)
4441 ;; Auto-saved file should be read with special coding.
4442 (coding-system-for-read 'auto-save-coding
))
4444 (insert-file-contents file-name nil
)
4445 (set-buffer-file-coding-system coding-system
))
4446 (after-find-file nil nil t
))
4447 (t (error "Recover-file cancelled")))))
4449 (defun recover-session ()
4450 "Recover auto save files from a previous Emacs session.
4451 This command first displays a Dired buffer showing you the
4452 previous sessions that you could recover from.
4453 To choose one, move point to the proper line and then type C-c C-c.
4454 Then you'll be asked about a number of files to recover."
4456 (if (null auto-save-list-file-prefix
)
4457 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4458 (let ((dir (file-name-directory auto-save-list-file-prefix
)))
4459 (unless (file-directory-p dir
)
4460 (make-directory dir t
))
4461 (unless (directory-files dir nil
4462 (concat "\\`" (regexp-quote
4463 (file-name-nondirectory
4464 auto-save-list-file-prefix
)))
4466 (error "No previous sessions to recover")))
4467 (let ((ls-lisp-support-shell-wildcards t
))
4468 (dired (concat auto-save-list-file-prefix
"*")
4469 (concat dired-listing-switches
"t")))
4471 (goto-char (point-min))
4472 (or (looking-at " Move to the session you want to recover,")
4473 (let ((inhibit-read-only t
))
4474 ;; Each line starts with a space
4475 ;; so that Font Lock mode won't highlight the first character.
4476 (insert " Move to the session you want to recover,\n"
4477 " then type C-c C-c to select it.\n\n"
4478 " You can also delete some of these files;\n"
4479 " type d on a line to mark that file for deletion.\n\n"))))
4480 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4481 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish
))
4483 (defun recover-session-finish ()
4484 "Choose one saved session to recover auto-save files from.
4485 This command is used in the special Dired buffer created by
4486 \\[recover-session]."
4488 ;; Get the name of the session file to recover from.
4489 (let ((file (dired-get-filename))
4491 (buffer (get-buffer-create " *recover*")))
4493 (dired-do-flagged-delete t
)
4496 ;; Read in the auto-save-list file.
4499 (insert-file-contents file
)
4500 ;; Loop thru the text of that file
4501 ;; and get out the names of the files to recover.
4503 (let (thisfile autofile
)
4505 ;; This is a pair of lines for a non-file-visiting buffer.
4506 ;; Get the auto-save file name and manufacture
4507 ;; a "visited file name" from that.
4510 ;; If there is no auto-save file name, the
4511 ;; auto-save-list file is probably corrupted.
4514 (buffer-substring-no-properties
4516 (line-end-position)))
4520 (file-name-nondirectory autofile
)
4522 (file-name-directory autofile
))))
4524 ;; This pair of lines is a file-visiting
4525 ;; buffer. Use the visited file name.
4528 (buffer-substring-no-properties
4529 (point) (progn (end-of-line) (point))))
4532 (buffer-substring-no-properties
4533 (point) (progn (end-of-line) (point))))
4535 ;; Ignore a file if its auto-save file does not exist now.
4536 (if (and autofile
(file-exists-p autofile
))
4537 (setq files
(cons thisfile files
)))))
4538 (setq files
(nreverse files
))
4539 ;; The file contains a pair of line for each auto-saved buffer.
4540 ;; The first line of the pair contains the visited file name
4541 ;; or is empty if the buffer was not visiting a file.
4542 ;; The second line is the auto-save file name.
4544 (map-y-or-n-p "Recover %s? "
4547 (save-excursion (recover-file file
))
4549 "Failed to recover `%s'" file
)))
4551 '("file" "files" "recover"))
4552 (message "No files can be recovered from this session now")))
4553 (kill-buffer buffer
))))
4555 (defun kill-buffer-ask (buffer)
4556 "Kill buffer if confirmed."
4558 (format "Buffer %s %s. Kill? " (buffer-name buffer
)
4559 (if (buffer-modified-p buffer
)
4560 "HAS BEEN EDITED" "is unmodified")))
4561 (kill-buffer buffer
)))
4563 (defun kill-some-buffers (&optional list
)
4564 "Kill some buffers. Asks the user whether to kill each one of them.
4565 Non-interactively, if optional argument LIST is non-nil, it
4566 specifies the list of buffers to kill, asking for approval for each one."
4569 (setq list
(buffer-list)))
4571 (let* ((buffer (car list
))
4572 (name (buffer-name buffer
)))
4573 (and name
; Can be nil for an indirect buffer
4574 ; if we killed the base buffer.
4575 (not (string-equal name
""))
4576 (/= (aref name
0) ?\s
)
4577 (kill-buffer-ask buffer
)))
4578 (setq list
(cdr list
))))
4580 (defun kill-matching-buffers (regexp &optional internal-too
)
4581 "Kill buffers whose name matches the specified regexp.
4582 The optional second argument indicates whether to kill internal buffers too."
4583 (interactive "sKill buffers matching this regular expression: \nP")
4584 (dolist (buffer (buffer-list))
4585 (let ((name (buffer-name buffer
)))
4586 (when (and name
(not (string-equal name
""))
4587 (or internal-too
(/= (aref name
0) ?\s
))
4588 (string-match regexp name
))
4589 (kill-buffer-ask buffer
)))))
4592 (defun auto-save-mode (arg)
4593 "Toggle auto-saving of contents of current buffer.
4594 With prefix argument ARG, turn auto-saving on if positive, else off."
4596 (setq buffer-auto-save-file-name
4598 (or (not buffer-auto-save-file-name
)
4599 ;; If auto-save is off because buffer has shrunk,
4600 ;; then toggling should turn it on.
4601 (< buffer-saved-size
0))
4602 (or (eq arg t
) (listp arg
) (and (integerp arg
) (> arg
0))))
4603 (if (and buffer-file-name auto-save-visited-file-name
4604 (not buffer-read-only
))
4606 (make-auto-save-file-name))))
4607 ;; If -1 was stored here, to temporarily turn off saving,
4609 (and (< buffer-saved-size
0)
4610 (setq buffer-saved-size
0))
4612 (message "Auto-save %s (in this buffer)"
4613 (if buffer-auto-save-file-name
"on" "off")))
4614 buffer-auto-save-file-name
)
4616 (defun rename-auto-save-file ()
4617 "Adjust current buffer's auto save file name for current conditions.
4618 Also rename any existing auto save file, if it was made in this session."
4619 (let ((osave buffer-auto-save-file-name
))
4620 (setq buffer-auto-save-file-name
4621 (make-auto-save-file-name))
4622 (if (and osave buffer-auto-save-file-name
4623 (not (string= buffer-auto-save-file-name buffer-file-name
))
4624 (not (string= buffer-auto-save-file-name osave
))
4625 (file-exists-p osave
)
4626 (recent-auto-save-p))
4627 (rename-file osave buffer-auto-save-file-name t
))))
4629 (defun make-auto-save-file-name ()
4630 "Return file name to use for auto-saves of current buffer.
4631 Does not consider `auto-save-visited-file-name' as that variable is checked
4632 before calling this function. You can redefine this for customization.
4633 See also `auto-save-file-name-p'."
4634 (if buffer-file-name
4635 (let ((handler (find-file-name-handler buffer-file-name
4636 'make-auto-save-file-name
)))
4638 (funcall handler
'make-auto-save-file-name
)
4639 (let ((list auto-save-file-name-transforms
)
4640 (filename buffer-file-name
)
4642 ;; Apply user-specified translations
4643 ;; to the file name.
4644 (while (and list
(not result
))
4645 (if (string-match (car (car list
)) filename
)
4646 (setq result
(replace-match (cadr (car list
)) t nil
4648 uniq
(car (cddr (car list
)))))
4649 (setq list
(cdr list
)))
4652 (setq filename
(concat
4653 (file-name-directory result
)
4654 (subst-char-in-string
4656 (replace-regexp-in-string "!" "!!"
4658 (setq filename result
)))
4660 (if (and (eq system-type
'ms-dos
)
4661 (not (msdos-long-file-names)))
4662 ;; We truncate the file name to DOS 8+3 limits
4663 ;; before doing anything else, because the regexp
4664 ;; passed to string-match below cannot handle
4665 ;; extensions longer than 3 characters, multiple
4666 ;; dots, and other atrocities.
4667 (let ((fn (dos-8+3-filename
4668 (file-name-nondirectory buffer-file-name
))))
4670 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4672 (concat (file-name-directory buffer-file-name
)
4673 "#" (match-string 1 fn
)
4674 "." (match-string 3 fn
) "#"))
4675 (concat (file-name-directory filename
)
4677 (file-name-nondirectory filename
)
4679 ;; Make sure auto-save file names don't contain characters
4680 ;; invalid for the underlying filesystem.
4681 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
4682 ;; Don't modify remote (ange-ftp) filenames
4683 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result
)))
4684 (convert-standard-filename result
)
4687 ;; Deal with buffers that don't have any associated files. (Mail
4688 ;; mode tends to create a good number of these.)
4690 (let ((buffer-name (buffer-name))
4693 ;; Restrict the characters used in the file name to those which
4694 ;; are known to be safe on all filesystems, url-encoding the
4696 ;; We do this on all platforms, because even if we are not
4697 ;; running on DOS/Windows, the current directory may be on a
4698 ;; mounted VFAT filesystem, such as a USB memory stick.
4699 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit
)
4700 (let* ((character (aref buffer-name
(match-beginning 0)))
4702 ;; For multibyte characters, this will produce more than
4703 ;; 2 hex digits, so is not true URL encoding.
4704 (format "%%%02X" character
)))
4705 (setq buffer-name
(replace-match replacement t t buffer-name
))
4706 (setq limit
(1+ (match-end 0)))))
4707 ;; Generate the file name.
4712 (format "#%s#" buffer-name
)
4713 ;; Try a few alternative directories, to get one we can
4716 ((file-writable-p default-directory
) default-directory
)
4717 ((file-writable-p "/var/tmp/") "/var/tmp/")
4719 (if (and (memq system-type
'(ms-dos windows-nt cygwin
))
4720 ;; Don't modify remote (ange-ftp) filenames
4721 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname
)))
4722 ;; The call to convert-standard-filename is in case
4723 ;; buffer-name includes characters not allowed by the
4724 ;; DOS/Windows filesystems. make-temp-file writes to the
4725 ;; file it creates, so we must fix the file name _before_
4726 ;; make-temp-file is called.
4727 (convert-standard-filename fname
)
4730 ;; make-temp-file creates the file,
4731 ;; but we don't want it to exist until we do an auto-save.
4733 (delete-file file-name
)
4737 (defun auto-save-file-name-p (filename)
4738 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4739 FILENAME should lack slashes. You can redefine this for customization."
4740 (string-match "^#.*#$" filename
))
4742 (defun wildcard-to-regexp (wildcard)
4743 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4744 The generated regexp will match a filename only if the filename
4745 matches that wildcard according to shell rules. Only wildcards known
4746 by `sh' are supported."
4747 (let* ((i (string-match "[[.*+\\^$?]" wildcard
))
4748 ;; Copy the initial run of non-special characters.
4749 (result (substring wildcard
0 i
))
4750 (len (length wildcard
)))
4751 ;; If no special characters, we're almost done.
4754 (let ((ch (aref wildcard i
))
4762 (eq (aref wildcard
(1+ i
)) ?\
]))
4764 ((eq ch ?\
[) ; [...] maps to regexp char class
4769 ((eq (aref wildcard i
) ?
!) ; [!...] -> [^...]
4772 (if (eq (aref wildcard i
) ?\
])
4777 ((eq (aref wildcard i
) ?^
)
4778 ;; Found "[^". Insert a `\0' character
4779 ;; (which cannot happen in a filename)
4780 ;; into the character class, so that `^'
4781 ;; is not the first character after `[',
4782 ;; and thus non-special in a regexp.
4786 ((eq (aref wildcard i
) ?\
])
4787 ;; I don't think `]' can appear in a
4788 ;; character class in a wildcard, but
4789 ;; let's be general here.
4794 (prog1 ; copy everything upto next `]'.
4797 (setq j
(string-match
4799 (setq i
(if j
(1- j
) (1- len
)))))))
4801 ((eq ch ?
*) "[^\000]*")
4805 ((eq ch ?
\\) "\\\\") ; probably cannot happen...
4806 ((eq ch ??
) "[^\000]")
4807 (t (char-to-string ch
)))))
4809 ;; Shell wildcards should match the entire filename,
4810 ;; not its part. Make the regexp say so.
4811 (concat "\\`" result
"\\'")))
4813 (defcustom list-directory-brief-switches
4814 (if (eq system-type
'vax-vms
) "" "-CF")
4815 "Switches for `list-directory' to pass to `ls' for brief listing."
4819 (defcustom list-directory-verbose-switches
4820 (if (eq system-type
'vax-vms
)
4821 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
4823 "Switches for `list-directory' to pass to `ls' for verbose listing."
4827 (defun file-expand-wildcards (pattern &optional full
)
4828 "Expand wildcard pattern PATTERN.
4829 This returns a list of file names which match the pattern.
4831 If PATTERN is written as an absolute file name,
4832 the values are absolute also.
4834 If PATTERN is written as a relative file name, it is interpreted
4835 relative to the current default directory, `default-directory'.
4836 The file names returned are normally also relative to the current
4837 default directory. However, if FULL is non-nil, they are absolute."
4839 (let* ((nondir (file-name-nondirectory pattern
))
4840 (dirpart (file-name-directory pattern
))
4841 ;; A list of all dirs that DIRPART specifies.
4842 ;; This can be more than one dir
4843 ;; if DIRPART contains wildcards.
4844 (dirs (if (and dirpart
(string-match "[[*?]" dirpart
))
4845 (mapcar 'file-name-as-directory
4846 (file-expand-wildcards (directory-file-name dirpart
)))
4850 (when (or (null (car dirs
)) ; Possible if DIRPART is not wild.
4851 (file-directory-p (directory-file-name (car dirs
))))
4852 (let ((this-dir-contents
4853 ;; Filter out "." and ".."
4855 (mapcar #'(lambda (name)
4856 (unless (string-match "\\`\\.\\.?\\'"
4857 (file-name-nondirectory name
))
4859 (directory-files (or (car dirs
) ".") full
4860 (wildcard-to-regexp nondir
))))))
4863 (if (and (car dirs
) (not full
))
4864 (mapcar (function (lambda (name) (concat (car dirs
) name
)))
4868 (setq dirs
(cdr dirs
)))
4871 (defun list-directory (dirname &optional verbose
)
4872 "Display a list of files in or matching DIRNAME, a la `ls'.
4873 DIRNAME is globbed by the shell if necessary.
4874 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
4875 Actions controlled by variables `list-directory-brief-switches'
4876 and `list-directory-verbose-switches'."
4877 (interactive (let ((pfx current-prefix-arg
))
4878 (list (read-file-name (if pfx
"List directory (verbose): "
4879 "List directory (brief): ")
4880 nil default-directory nil
)
4882 (let ((switches (if verbose list-directory-verbose-switches
4883 list-directory-brief-switches
))
4885 (or dirname
(setq dirname default-directory
))
4886 (setq dirname
(expand-file-name dirname
))
4887 (with-output-to-temp-buffer "*Directory*"
4888 (setq buffer standard-output
)
4889 (buffer-disable-undo standard-output
)
4890 (princ "Directory ")
4894 (set-buffer "*Directory*")
4895 (let ((wildcard (not (file-directory-p dirname
))))
4896 (insert-directory dirname switches wildcard
(not wildcard
)))))
4897 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4898 (with-current-buffer buffer
4899 (setq default-directory
4900 (if (file-directory-p dirname
)
4901 (file-name-as-directory dirname
)
4902 (file-name-directory dirname
))))))
4904 (defun shell-quote-wildcard-pattern (pattern)
4905 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4907 PATTERN is assumed to represent a file-name wildcard suitable for the
4908 underlying filesystem. For Unix and GNU/Linux, the characters from the
4909 set [ \\t\\n;<>&|()'\"#$] are quoted with a backslash; for DOS/Windows, all
4910 the parts of the pattern which don't include wildcard characters are
4911 quoted with double quotes.
4912 Existing quote characters in PATTERN are left alone, so you can pass
4913 PATTERN that already quotes some of the special characters."
4916 ((memq system-type
'(ms-dos windows-nt cygwin
))
4917 ;; DOS/Windows don't allow `"' in file names. So if the
4918 ;; argument has quotes, we can safely assume it is already
4919 ;; quoted by the caller.
4920 (if (or (string-match "[\"]" pattern
)
4921 ;; We quote [&()#$'] in case their shell is a port of a
4922 ;; Unixy shell. We quote [,=+] because stock DOS and
4923 ;; Windows shells require that in some cases, such as
4924 ;; passing arguments to batch files that use positional
4925 ;; arguments like %1.
4926 (not (string-match "[ \t;&()#$',=+]" pattern
)))
4931 (while (string-match "[*?]+" pattern beg
)
4932 (setq end
(match-beginning 0)
4933 result
(concat result
(substring pattern beg end
)
4935 (substring pattern end
(match-end 0))
4938 (concat result
(substring pattern beg
) "\""))))
4941 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg
)
4943 (concat (substring pattern
0 (match-beginning 0))
4945 (substring pattern
(match-beginning 0)))
4946 beg
(1+ (match-end 0)))))
4950 (defvar insert-directory-program
"ls"
4951 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4953 (defcustom directory-free-space-program
"df"
4954 "Program to get the amount of free space on a file system.
4955 We assume the output has the format of `df'.
4956 The value of this variable must be just a command name or file name;
4957 if you want to specify options, use `directory-free-space-args'.
4959 A value of nil disables this feature.
4961 If the function `file-system-info' is defined, it is always used in
4962 preference to the program given by this variable."
4963 :type
'(choice (string :tag
"Program") (const :tag
"None" nil
))
4966 (defcustom directory-free-space-args
4967 (if (eq system-type
'darwin
) "-k" "-Pk")
4968 "Options to use when running `directory-free-space-program'."
4972 (defun get-free-disk-space (dir)
4973 "Return the amount of free space on directory DIR's file system.
4974 The result is a string that gives the number of free 1KB blocks,
4975 or nil if the system call or the program which retrieve the information
4976 fail. It returns also nil when DIR is a remote directory.
4978 This function calls `file-system-info' if it is available, or invokes the
4979 program specified by `directory-free-space-program' if that is non-nil."
4980 (when (not (file-remote-p dir
))
4981 ;; Try to find the number of free blocks. Non-Posix systems don't
4982 ;; always have df, but might have an equivalent system call.
4983 (if (fboundp 'file-system-info
)
4984 (let ((fsinfo (file-system-info dir
)))
4986 (format "%.0f" (/ (nth 2 fsinfo
) 1024))))
4989 (when (and directory-free-space-program
4990 (eq 0 (call-process directory-free-space-program
4992 directory-free-space-args
4994 ;; Usual format is a header line followed by a line of
4996 (goto-char (point-min))
5000 ;; Move to the end of the "available blocks" number.
5001 (skip-chars-forward "^ \t")
5003 ;; Copy it into AVAILABLE.
5004 (let ((end (point)))
5006 (buffer-substring (point) end
))))))))))
5008 ;; The following expression replaces `dired-move-to-filename-regexp'.
5009 (defvar directory-listing-before-filename-regexp
5010 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5011 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5012 ;; In some locales, month abbreviations are as short as 2 letters,
5013 ;; and they can be followed by ".".
5014 ;; In Breton, a month name can include a quote character.
5015 (month (concat l-or-quote l-or-quote
"+\\.?"))
5017 (yyyy "[0-9][0-9][0-9][0-9]")
5019 (HH:MM
"[ 0-2][0-9][:.][0-5][0-9]")
5020 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5021 (zone "[-+][0-2][0-9][0-5][0-9]")
5022 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5023 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
5024 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
5025 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
5026 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
5028 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
5029 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
5030 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5031 ;; omits the Kanji characters after month and day-of-month.
5032 ;; On Mac OS X 10.3, the date format in East Asian locales is
5033 ;; day-of-month digits followed by month digits.
5036 (concat "\\(" mm l
"?" s dd l
"?" s
"+"
5037 "\\|" dd s mm s
"+" "\\)"
5038 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
5039 ;; The "[0-9]" below requires the previous column to end in a digit.
5040 ;; This avoids recognizing `1 may 1997' as a date in the line:
5041 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5043 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5044 ;; The ".*" below finds the last match if there are multiple matches.
5045 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5046 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5048 ;; vc dired listings provide the state or blanks between file
5049 ;; permissions and date. The state is always surrounded by
5051 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5052 ;; This is not supported yet.
5053 (concat ".*[0-9][BkKMGTPEZY]?" s
5054 "\\(" western
"\\|" western-comma
"\\|" east-asian
"\\|" iso
"\\)"
5056 "Regular expression to match up to the file name in a directory listing.
5057 The default value is designed to recognize dates and times
5058 regardless of the language.")
5060 (defvar insert-directory-ls-version
'unknown
)
5063 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5064 ;; FULL-DIRECTORY-P is nil.
5065 ;; The single line of output must display FILE's name as it was
5066 ;; given, namely, an absolute path name.
5067 ;; - must insert exactly one line for each file if WILDCARD or
5068 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5069 ;; before the file lines, plus optional text after the file lines.
5070 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5072 ;; File lines should display the basename.
5073 ;; - must be consistent with
5074 ;; - functions dired-move-to-filename, (these two define what a file line is)
5075 ;; dired-move-to-end-of-filename,
5076 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5077 ;; dired-insert-headerline
5078 ;; dired-after-subdir-garbage (defines what a "total" line is)
5079 ;; - variable dired-subdir-regexp
5080 ;; - may be passed "--dired" as the first argument in SWITCHES.
5081 ;; Filename handlers might have to remove this switch if their
5082 ;; "ls" command does not support it.
5083 (defun insert-directory (file switches
&optional wildcard full-directory-p
)
5084 "Insert directory listing for FILE, formatted according to SWITCHES.
5085 Leaves point after the inserted text.
5086 SWITCHES may be a string of options, or a list of strings
5087 representing individual options.
5088 Optional third arg WILDCARD means treat FILE as shell wildcard.
5089 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5090 switches do not contain `d', so that a full listing is expected.
5092 This works by running a directory listing program
5093 whose name is in the variable `insert-directory-program'.
5094 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5096 When SWITCHES contains the long `--dired' option, this function
5097 treats it specially, for the sake of dired. However, the
5098 normally equivalent short `-D' option is just passed on to
5099 `insert-directory-program', as any other option."
5100 ;; We need the directory in order to find the right handler.
5101 (let ((handler (find-file-name-handler (expand-file-name file
)
5102 'insert-directory
)))
5104 (funcall handler
'insert-directory file switches
5105 wildcard full-directory-p
)
5106 (if (eq system-type
'vax-vms
)
5107 (vms-read-directory file switches
(current-buffer))
5108 (let (result (beg (point)))
5110 ;; Read the actual directory using `insert-directory-program'.
5111 ;; RESULT gets the status code.
5112 (let* (;; We at first read by no-conversion, then after
5113 ;; putting text property `dired-filename, decode one
5114 ;; bunch by one to preserve that property.
5115 (coding-system-for-read 'no-conversion
)
5116 ;; This is to control encoding the arguments in call-process.
5117 (coding-system-for-write
5118 (and enable-multibyte-characters
5119 (or file-name-coding-system
5120 default-file-name-coding-system
))))
5123 ;; Run ls in the directory part of the file pattern
5124 ;; using the last component as argument.
5125 (let ((default-directory
5126 (if (file-name-absolute-p file
)
5127 (file-name-directory file
)
5128 (file-name-directory (expand-file-name file
))))
5129 (pattern (file-name-nondirectory file
)))
5131 shell-file-name nil t nil
5133 (concat (if (memq system-type
'(ms-dos windows-nt
))
5135 "\\") ; Disregard Unix shell aliases!
5136 insert-directory-program
5138 (if (stringp switches
)
5140 (mapconcat 'identity switches
" "))
5142 ;; Quote some characters that have
5143 ;; special meanings in shells; but
5144 ;; don't quote the wildcards--we want
5145 ;; them to be special. We also
5146 ;; currently don't quote the quoting
5147 ;; characters in case people want to
5148 ;; use them explicitly to quote
5149 ;; wildcard characters.
5150 (shell-quote-wildcard-pattern pattern
))))
5151 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5152 ;; directory if FILE is a symbolic link.
5153 (apply 'call-process
5154 insert-directory-program nil t nil
5156 (if (listp switches
) switches
5157 (unless (equal switches
"")
5158 ;; Split the switches at any spaces so we can
5159 ;; pass separate options as separate args.
5160 (split-string switches
)))
5161 ;; Avoid lossage if FILE starts with `-'.
5164 (if (string-match "\\`~" file
)
5165 (setq file
(expand-file-name file
)))
5167 (if full-directory-p
5168 (concat (file-name-as-directory file
) ".")
5171 ;; If we got "//DIRED//" in the output, it means we got a real
5172 ;; directory listing, even if `ls' returned nonzero.
5173 ;; So ignore any errors.
5174 (when (if (stringp switches
)
5175 (string-match "--dired\\>" switches
)
5176 (member "--dired" switches
))
5179 (when (looking-at "//SUBDIRED//")
5181 (if (looking-at "//DIRED//")
5184 (when (and (not (eq 0 result
))
5185 (eq insert-directory-ls-version
'unknown
))
5186 ;; The first time ls returns an error,
5187 ;; find the version numbers of ls,
5188 ;; and set insert-directory-ls-version
5189 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5190 ;; is equal or if the info cannot be obtained.
5191 ;; (That can mean it isn't GNU ls.)
5194 (call-process "ls" nil t nil
"--version")
5196 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out
)
5197 (let* ((version (match-string 1 version-out
))
5198 (split (split-string version
"[.]"))
5199 (numbers (mapcar 'string-to-number split
))
5202 (while (and (not comparison
) (or numbers min
))
5204 (setq comparison
'>))
5206 (setq comparison
'<))
5207 ((> (car numbers
) (car min
))
5208 (setq comparison
'>))
5209 ((< (car numbers
) (car min
))
5210 (setq comparison
'<))
5212 (setq numbers
(cdr numbers
)
5214 (setq insert-directory-ls-version
(or comparison
'=)))
5215 (setq insert-directory-ls-version nil
))))
5217 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5218 (when (and (eq 1 result
) (eq insert-directory-ls-version
'>))
5221 ;; If `insert-directory-program' failed, signal an error.
5222 (unless (eq 0 result
)
5223 ;; Delete the error message it may have output.
5224 (delete-region beg
(point))
5225 ;; On non-Posix systems, we cannot open a directory, so
5226 ;; don't even try, because that will always result in
5227 ;; the ubiquitous "Access denied". Instead, show the
5228 ;; command line so the user can try to guess what went wrong.
5229 (if (and (file-directory-p file
)
5230 (memq system-type
'(ms-dos windows-nt
)))
5232 "Reading directory: \"%s %s -- %s\" exited with status %s"
5233 insert-directory-program
5234 (if (listp switches
) (concat switches
) switches
)
5236 ;; Unix. Access the file to get a suitable error.
5237 (access-file file
"Reading directory")
5238 (error "Listing directory failed but `access-file' worked")))
5240 (when (if (stringp switches
)
5241 (string-match "--dired\\>" switches
)
5242 (member "--dired" switches
))
5243 ;; The following overshoots by one line for an empty
5244 ;; directory listed with "--dired", but without "-a"
5245 ;; switch, where the ls output contains a
5246 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5247 ;; We take care of that case later.
5249 (when (looking-at "//SUBDIRED//")
5250 (delete-region (point) (progn (forward-line 1) (point)))
5252 (if (looking-at "//DIRED//")
5253 (let ((end (line-end-position))
5256 ;; Find all the lines that are error messages,
5257 ;; and record the bounds of each one.
5259 (while (< (point) linebeg
)
5260 (or (eql (following-char) ?\s
)
5261 (push (list (point) (line-end-position)) error-lines
))
5263 (setq error-lines
(nreverse error-lines
))
5264 ;; Now read the numeric positions of file names.
5268 (while (< (point) end
)
5269 (let ((start (insert-directory-adj-pos
5270 (+ beg
(read (current-buffer)))
5272 (end (insert-directory-adj-pos
5273 (+ beg
(read (current-buffer)))
5275 (if (memq (char-after end
) '(?
\n ?\s
))
5276 ;; End is followed by \n or by " -> ".
5277 (put-text-property start end
'dired-filename t
)
5278 ;; It seems that we can't trust ls's output as to
5279 ;; byte positions of filenames.
5280 (put-text-property beg
(point) 'dired-filename nil
)
5284 (delete-region (point) (progn (forward-line 1) (point))))
5285 ;; Take care of the case where the ls output contains a
5286 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5287 ;; and we went one line too far back (see above).
5289 (if (looking-at "//DIRED-OPTIONS//")
5290 (delete-region (point) (progn (forward-line 1) (point)))))
5292 ;; Now decode what read if necessary.
5293 (let ((coding (or coding-system-for-read
5294 file-name-coding-system
5295 default-file-name-coding-system
5299 (when (and enable-multibyte-characters
5300 (not (memq (coding-system-base coding
)
5301 '(raw-text no-conversion
))))
5302 ;; If no coding system is specified or detection is
5303 ;; requested, detect the coding.
5304 (if (eq (coding-system-base coding
) 'undecided
)
5305 (setq coding
(detect-coding-region beg
(point) t
)))
5306 (if (not (eq (coding-system-base coding
) 'undecided
))
5309 (coding-system-change-eol-conversion coding
'unix
))
5310 (narrow-to-region beg
(point))
5311 (goto-char (point-min))
5314 val
(get-text-property (point) 'dired-filename
))
5315 (goto-char (next-single-property-change
5316 (point) 'dired-filename nil
(point-max)))
5317 ;; Force no eol conversion on a file name, so
5318 ;; that CR is preserved.
5319 (decode-coding-region pos
(point)
5320 (if val coding-no-eol coding
))
5322 (put-text-property pos
(point)
5323 'dired-filename t
)))))))
5325 (if full-directory-p
5326 ;; Try to insert the amount of free space.
5329 ;; First find the line to put it on.
5330 (when (re-search-forward "^ *\\(total\\)" nil t
)
5331 (let ((available (get-free-disk-space ".")))
5333 ;; Replace "total" with "used", to avoid confusion.
5334 (replace-match "total used in directory" nil nil nil
1)
5336 (insert " available " available
)))))))))))
5338 (defun insert-directory-adj-pos (pos error-lines
)
5339 "Convert `ls --dired' file name position value POS to a buffer position.
5340 File name position values returned in ls --dired output
5341 count only stdout; they don't count the error messages sent to stderr.
5342 So this function converts to them to real buffer positions.
5343 ERROR-LINES is a list of buffer positions of error message lines,
5344 of the form (START END)."
5345 (while (and error-lines
(< (caar error-lines
) pos
))
5346 (setq pos
(+ pos
(- (nth 1 (car error-lines
)) (nth 0 (car error-lines
)))))
5350 (defun insert-directory-safely (file switches
5351 &optional wildcard full-directory-p
)
5352 "Insert directory listing for FILE, formatted according to SWITCHES.
5354 Like `insert-directory', but if FILE does not exist, it inserts a
5355 message to that effect instead of signaling an error."
5356 (if (file-exists-p file
)
5357 (insert-directory file switches wildcard full-directory-p
)
5358 ;; Simulate the message printed by `ls'.
5359 (insert (format "%s: No such file or directory\n" file
))))
5361 (defvar kill-emacs-query-functions nil
5362 "Functions to call with no arguments to query about killing Emacs.
5363 If any of these functions returns nil, killing Emacs is cancelled.
5364 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5365 the low level primitive, does not. See also `kill-emacs-hook'.")
5367 (defcustom confirm-kill-emacs nil
5368 "How to ask for confirmation when leaving Emacs.
5369 If nil, the default, don't ask at all. If the value is non-nil, it should
5370 be a predicate function such as `yes-or-no-p'."
5371 :type
'(choice (const :tag
"Ask with yes-or-no-p" yes-or-no-p
)
5372 (const :tag
"Ask with y-or-n-p" y-or-n-p
)
5373 (const :tag
"Don't confirm" nil
))
5377 (defun save-buffers-kill-emacs (&optional arg
)
5378 "Offer to save each buffer, then kill this Emacs process.
5379 With prefix arg, silently save all file-visiting buffers, then kill."
5381 (save-some-buffers arg t
)
5382 (and (or (not (memq t
(mapcar (function
5383 (lambda (buf) (and (buffer-file-name buf
)
5384 (buffer-modified-p buf
))))
5386 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5387 (or (not (fboundp 'process-list
))
5388 ;; process-list is not defined on VMS.
5389 (let ((processes (process-list))
5392 (and (memq (process-status (car processes
)) '(run stop open listen
))
5393 (process-query-on-exit-flag (car processes
))
5395 (setq processes
(cdr processes
)))
5398 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5399 ;; Query the user for other things, perhaps.
5400 (run-hook-with-args-until-failure 'kill-emacs-query-functions
)
5401 (or (null confirm-kill-emacs
)
5402 (funcall confirm-kill-emacs
"Really exit Emacs? "))
5405 (defun save-buffers-kill-terminal (&optional arg
)
5406 "Offer to save each buffer, then kill the current connection.
5407 If the current frame has no client, kill Emacs itself.
5409 With prefix arg, silently save all file-visiting buffers, then kill.
5411 If emacsclient was started with a list of filenames to edit, then
5412 only these files will be asked to be saved."
5414 (let ((proc (frame-parameter (selected-frame) 'client
))
5415 (frame (selected-frame)))
5417 (save-buffers-kill-emacs)
5418 (server-save-buffers-kill-terminal proc arg
))))
5421 ;; We use /: as a prefix to "quote" a file name
5422 ;; so that magic file name handlers will not apply to it.
5424 (setq file-name-handler-alist
5425 (cons '("\\`/:" . file-name-non-special
)
5426 file-name-handler-alist
))
5428 ;; We depend on being the last handler on the list,
5429 ;; so that anything else which does need handling
5430 ;; has been handled already.
5431 ;; So it is safe for us to inhibit *all* magic file name handlers.
5433 (defun file-name-non-special (operation &rest arguments
)
5434 (let ((file-name-handler-alist nil
)
5436 (if (eq operation
'insert-directory
)
5437 (directory-file-name
5439 (unhandled-file-name-directory default-directory
)))
5441 ;; Get a list of the indices of the args which are file names.
5443 (cdr (or (assq operation
5444 ;; The first six are special because they
5445 ;; return a file name. We want to include the /:
5446 ;; in the return value.
5447 ;; So just avoid stripping it in the first place.
5448 '((expand-file-name . nil
)
5449 (file-name-directory . nil
)
5450 (file-name-as-directory . nil
)
5451 (directory-file-name . nil
)
5452 (file-name-sans-versions . nil
)
5453 (find-backup-file-name . nil
)
5454 ;; `identity' means just return the first arg
5455 ;; not stripped of its quoting.
5456 (substitute-in-file-name identity
)
5457 ;; `add' means add "/:" to the result.
5458 (file-truename add
0)
5459 ;; `quote' means add "/:" to buffer-file-name.
5460 (insert-file-contents quote
0)
5461 ;; `unquote-then-quote' means set buffer-file-name
5462 ;; temporarily to unquoted filename.
5463 (verify-visited-file-modtime unquote-then-quote
)
5464 ;; List the arguments which are filenames.
5465 (file-name-completion 1)
5466 (file-name-all-completions 1)
5470 (make-symbolic-link 0 1)
5471 (add-name-to-file 0 1)))
5472 ;; For all other operations, treat the first argument only
5473 ;; as the file name.
5476 ;; Copy ARGUMENTS so we can replace elements in it.
5477 (arguments (copy-sequence arguments
)))
5478 (if (symbolp (car file-arg-indices
))
5479 (setq method
(pop file-arg-indices
)))
5480 ;; Strip off the /: from the file names that have it.
5482 (while (consp file-arg-indices
)
5483 (let ((pair (nthcdr (car file-arg-indices
) arguments
)))
5485 (string-match "\\`/:" (car pair
))
5487 (if (= (length (car pair
)) 2)
5489 (substring (car pair
) 2)))))
5490 (setq file-arg-indices
(cdr file-arg-indices
))))
5491 (cond ((eq method
'identity
)
5494 (concat "/:" (apply operation arguments
)))
5497 (apply operation arguments
)
5498 (setq buffer-file-name
(concat "/:" buffer-file-name
))))
5499 ((eq method
'unquote-then-quote
)
5501 (setq buffer-file-name
(substring buffer-file-name
2))
5502 (setq res
(apply operation arguments
))
5503 (setq buffer-file-name
(concat "/:" buffer-file-name
))
5506 (apply operation arguments
)))))
5508 ;; Symbolic modes and read-file-modes.
5510 (defun file-modes-char-to-who (char)
5511 "Convert CHAR to a who-mask from a symbolic mode notation.
5512 CHAR is in [ugoa] and represents the users on which rights are applied."
5513 (cond ((= char ?u
) #o4700
)
5514 ((= char ?g
) #o2070
)
5515 ((= char ?o
) #o1007
)
5516 ((= char ?a
) #o7777
)
5517 (t (error "%c: bad `who' character" char
))))
5519 (defun file-modes-char-to-right (char &optional from
)
5520 "Convert CHAR to a right-mask from a symbolic mode notation.
5521 CHAR is in [rwxXstugo] and represents a right.
5522 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5523 (or from
(setq from
0))
5524 (cond ((= char ?r
) #o0444
)
5525 ((= char ?w
) #o0222
)
5526 ((= char ?x
) #o0111
)
5527 ((= char ?s
) #o1000
)
5528 ((= char ?t
) #o6000
)
5529 ;; Rights relative to the previous file modes.
5530 ((= char ?X
) (if (= (logand from
#o111
) 0) 0 #o0111
))
5531 ((= char ?u
) (let ((uright (logand #o4700 from
)))
5532 (+ uright
(/ uright
#o10
) (/ uright
#o100
))))
5533 ((= char ?g
) (let ((gright (logand #o2070 from
)))
5534 (+ gright
(/ gright
#o10
) (* gright
#o10
))))
5535 ((= char ?o
) (let ((oright (logand #o1007 from
)))
5536 (+ oright
(* oright
#o10
) (* oright
#o100
))))
5537 (t (error "%c: bad right character" char
))))
5539 (defun file-modes-rights-to-number (rights who-mask
&optional from
)
5540 "Convert a right string to a right-mask from a symbolic modes notation.
5541 RIGHTS is the right string, it should match \"([+=-][rwxXstugo]+)+\".
5542 WHO-MASK is the mask number of the users on which the rights are to be applied.
5543 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5544 (let* ((num-rights (or from
0))
5545 (list-rights (string-to-list rights
))
5546 (op (pop list-rights
)))
5547 (while (memq op
'(?
+ ?- ?
=))
5550 (while (memq (setq char-right
(pop list-rights
))
5551 '(?r ?w ?x ?X ?s ?t ?u ?g ?o
))
5554 (file-modes-char-to-right char-right num-rights
))))
5555 (setq num-right
(logand who-mask num-right
)
5557 (cond ((= op ?
+) (logior num-rights num-right
))
5558 ((= op ?-
) (logand num-rights
(lognot num-right
)))
5559 (t (logior (logand num-rights
(lognot who-mask
)) num-right
)))
5563 (defun file-modes-symbolic-to-number (modes &optional from
)
5564 "Convert symbolic file modes to numeric file modes.
5565 MODES is the string to convert, it should match
5566 \"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5567 See (info \"(coreutils)File permissions\") for more information on this
5569 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5571 (let ((case-fold-search nil
)
5572 (num-modes (or from
0)))
5573 (while (/= (string-to-char modes
) 0)
5574 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes
)
5575 (let ((num-who (apply 'logior
0
5576 (mapcar 'file-modes-char-to-who
5577 (match-string 1 modes
)))))
5579 (setq num-who
(default-file-modes)))
5581 (file-modes-rights-to-number (substring modes
(match-end 1))
5583 modes
(substring modes
(match-end 3))))
5584 (error "Parse error in modes near `%s'" (substring modes
0))))
5587 (defun read-file-modes (&optional prompt orig-file
)
5588 "Read file modes in octal or symbolic notation.
5589 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5590 ORIG-FILE is the original file of which modes will be change."
5591 (let* ((modes (or (if orig-file
(file-modes orig-file
) 0)
5592 (error "File not found")))
5593 (value (read-string (or prompt
"File modes (octal or symbolic): "))))
5595 (if (string-match "^[0-7]+" value
)
5596 (string-to-number value
8)
5597 (file-modes-symbolic-to-number value modes
)))))
5600 (define-key ctl-x-map
"\C-f" 'find-file
)
5601 (define-key ctl-x-map
"\C-r" 'find-file-read-only
)
5602 (define-key ctl-x-map
"\C-v" 'find-alternate-file
)
5603 (define-key ctl-x-map
"\C-s" 'save-buffer
)
5604 (define-key ctl-x-map
"s" 'save-some-buffers
)
5605 (define-key ctl-x-map
"\C-w" 'write-file
)
5606 (define-key ctl-x-map
"i" 'insert-file
)
5607 (define-key esc-map
"~" 'not-modified
)
5608 (define-key ctl-x-map
"\C-d" 'list-directory
)
5609 (define-key ctl-x-map
"\C-c" 'save-buffers-kill-terminal
)
5610 (define-key ctl-x-map
"\C-q" 'toggle-read-only
)
5612 (define-key ctl-x-4-map
"f" 'find-file-other-window
)
5613 (define-key ctl-x-4-map
"r" 'find-file-read-only-other-window
)
5614 (define-key ctl-x-4-map
"\C-f" 'find-file-other-window
)
5615 (define-key ctl-x-4-map
"b" 'switch-to-buffer-other-window
)
5616 (define-key ctl-x-4-map
"\C-o" 'display-buffer
)
5618 (define-key ctl-x-5-map
"b" 'switch-to-buffer-other-frame
)
5619 (define-key ctl-x-5-map
"f" 'find-file-other-frame
)
5620 (define-key ctl-x-5-map
"\C-f" 'find-file-other-frame
)
5621 (define-key ctl-x-5-map
"r" 'find-file-read-only-other-frame
)
5622 (define-key ctl-x-5-map
"\C-o" 'display-buffer-other-frame
)
5624 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5625 ;;; files.el ends here