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 of the License, or
14 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
26 ;; Defines most of Emacs's file- and directory-handling functions,
27 ;; including basic file visiting, backup generation, link handling,
28 ;; ITS-id version control, load- and write-hook handling, and the like.
32 (defvar font-lock-keywords)
35 "Backups of edited data files."
38 (defgroup find-file nil
43 (defcustom delete-auto-save-files t
44 "Non-nil means delete auto-save file when a buffer is saved or killed.
46 Note that the auto-save file will not be deleted if the buffer is killed
47 when it has unsaved changes."
51 (defcustom directory-abbrev-alist
53 "Alist of abbreviations for file directories.
54 A list of elements of the form (FROM . TO), each meaning to replace
55 FROM with TO when it appears in a directory name. This replacement is
56 done when setting up the default directory of a newly visited file.
57 *Every* FROM string should start with `^'.
59 FROM and TO should be equivalent names, which refer to the
60 same directory. Do not use `~' in the TO strings;
61 they should be ordinary absolute directory names.
63 Use this feature when you have directories which you normally refer to
64 via absolute symbolic links. Make TO the name of the link, and FROM
65 the name it is linked to."
66 :type '(repeat (cons :format "%v"
73 ;; Turn off backup files on VMS since it has version numbers.
74 (defcustom make-backup-files (not (eq system-type 'vax-vms))
75 "Non-nil means make a backup of a file the first time it is saved.
76 This can be done by renaming the file or by copying.
78 Renaming means that Emacs renames the existing file so that it is a
79 backup file, then writes the buffer into a new file. Any other names
80 that the old file had will now refer to the backup file. The new file
81 is owned by you and its group is defaulted.
83 Copying means that Emacs copies the existing file into the backup
84 file, then writes the buffer on top of the existing file. Any other
85 names that the old file had will now refer to the new (edited) file.
86 The file's owner and group are unchanged.
88 The choice of renaming or copying is controlled by the variables
89 `backup-by-copying', `backup-by-copying-when-linked',
90 `backup-by-copying-when-mismatch' and
91 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
95 ;; Do this so that local variables based on the file name
96 ;; are not overridden by the major mode.
97 (defvar backup-inhibited nil
98 "Non-nil means don't make a backup, regardless of the other parameters.
99 This variable is intended for use by making it local to a buffer.
100 But it is local only if you make it local.")
101 (put 'backup-inhibited 'permanent-local t)
103 (defcustom backup-by-copying nil
104 "Non-nil means always use copying to create backup files.
105 See documentation of variable `make-backup-files'."
109 (defcustom backup-by-copying-when-linked nil
110 "Non-nil means use copying to create backups for files with multiple names.
111 This causes the alternate names to refer to the latest version as edited.
112 This variable is relevant only if `backup-by-copying' is nil."
116 (defcustom backup-by-copying-when-mismatch nil
117 "Non-nil means create backups by copying if this preserves owner or group.
118 Renaming may still be used (subject to control of other variables)
119 when it would not result in changing the owner or group of the file;
120 that is, for files which are owned by you and whose group matches
121 the default for a new file created there by you.
122 This variable is relevant only if `backup-by-copying' is nil."
126 (defcustom backup-by-copying-when-privileged-mismatch 200
127 "Non-nil means create backups by copying to preserve a privileged owner.
128 Renaming may still be used (subject to control of other variables)
129 when it would not result in changing the owner of the file or if the owner
130 has a user id greater than the value of this variable. This is useful
131 when low-numbered uid's are used for special system users (such as root)
132 that must maintain ownership of certain files.
133 This variable is relevant only if `backup-by-copying' and
134 `backup-by-copying-when-mismatch' are nil."
135 :type '(choice (const nil) integer)
138 (defvar backup-enable-predicate 'normal-backup-enable-predicate
139 "Predicate that looks at a file name and decides whether to make backups.
140 Called with an absolute file name as argument, it returns t to enable backup.")
142 (defcustom buffer-offer-save nil
143 "Non-nil in a buffer means always offer to save buffer on exit.
144 Do so even if the buffer is not visiting a file.
145 Automatically local in all buffers."
148 (make-variable-buffer-local 'buffer-offer-save)
150 (defcustom find-file-existing-other-name t
151 "Non-nil means find a file under alternative names, in existing buffers.
152 This means if any existing buffer is visiting the file you want
153 under another name, you get the existing buffer instead of a new buffer."
157 (defcustom find-file-visit-truename nil
158 "*Non-nil means visit a file under its truename.
159 The truename of a file is found by chasing all links
160 both at the file level and at the levels of the containing directories."
163 (put 'find-file-visit-truename 'safe-local-variable 'booleanp)
165 (defcustom revert-without-query nil
166 "Specify which files should be reverted without query.
167 The value is a list of regular expressions.
168 If the file name matches one of these regular expressions,
169 then `revert-buffer' reverts the file without querying
170 if the file has changed on disk and you have not edited the buffer."
171 :type '(repeat regexp)
174 (defvar buffer-file-number nil
175 "The device number and file number of the file visited in the current buffer.
176 The value is a list of the form (FILENUM DEVNUM).
177 This pair of numbers uniquely identifies the file.
178 If the buffer is visiting a new file, the value is nil.")
179 (make-variable-buffer-local 'buffer-file-number)
180 (put 'buffer-file-number 'permanent-local t)
182 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
183 "Non-nil means that `buffer-file-number' uniquely identifies files.")
185 (defvar buffer-file-read-only nil
186 "Non-nil if visited file was read-only when visited.")
187 (make-variable-buffer-local 'buffer-file-read-only)
189 (defcustom temporary-file-directory
190 (file-name-as-directory
191 (cond ((memq system-type '(ms-dos windows-nt))
192 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
193 ((memq system-type '(vax-vms axp-vms))
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
196 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
197 "The directory for writing temporary files."
201 (defcustom small-temporary-file-directory
202 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
203 "The directory for writing small temporary files.
204 If non-nil, this directory is used instead of `temporary-file-directory'
205 by programs that create small temporary files. This is for systems that
206 have fast storage with limited space, such as a RAM disk."
208 :type '(choice (const nil) directory))
210 ;; The system null device. (Should reference NULL_DEVICE from C.)
211 (defvar null-device "/dev/null" "The system null device.")
213 (declare-function msdos-long-file-names "msdos.c")
214 (declare-function w32-long-file-name "w32proc.c")
215 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
216 (declare-function dired-unmark "dired" (arg))
217 (declare-function dired-do-flagged-delete "dired" (&optional nomessage))
218 (declare-function dos-8+3-filename "dos-fns" (filename))
219 (declare-function vms-read-directory "vms-patch" (dirname switches buffer))
220 (declare-function view-mode-disable "view" ())
222 (defvar file-name-invalid-regexp
223 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
224 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
225 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
226 "[\000-\037]\\|" ; control characters
227 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
228 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
229 ((memq system-type '(ms-dos windows-nt cygwin))
230 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
231 "[|<>\"?*\000-\037]")) ; invalid characters
233 "Regexp recognizing file names which aren't allowed by the filesystem.")
235 (defcustom file-precious-flag nil
236 "Non-nil means protect against I/O errors while saving files.
237 Some modes set this non-nil in particular buffers.
239 This feature works by writing the new contents into a temporary file
240 and then renaming the temporary file to replace the original.
241 In this way, any I/O error in writing leaves the original untouched,
242 and there is never any instant where the file is nonexistent.
244 Note that this feature forces backups to be made by copying.
245 Yet, at the same time, saving a precious file
246 breaks any hard links between it and other files."
250 (defcustom version-control nil
251 "Control use of version numbers for backup files.
252 When t, make numeric backup versions unconditionally.
253 When nil, make them for files that have some already.
254 The value `never' means do not make them."
255 :type '(choice (const :tag "Never" never)
256 (const :tag "If existing" nil)
257 (other :tag "Always" t))
260 (put 'version-control 'safe-local-variable
261 '(lambda (x) (or (booleanp x) (equal x 'never))))
263 (defcustom dired-kept-versions 2
264 "When cleaning directory, number of versions to keep."
269 (defcustom delete-old-versions nil
270 "If t, delete excess backup versions silently.
271 If nil, ask confirmation. Any other value prevents any trimming."
272 :type '(choice (const :tag "Delete" t)
273 (const :tag "Ask" nil)
274 (other :tag "Leave" other))
277 (defcustom kept-old-versions 2
278 "Number of oldest versions to keep when a new numbered backup is made."
281 (put 'kept-old-versions 'safe-local-variable 'integerp)
283 (defcustom kept-new-versions 2
284 "Number of newest versions to keep when a new numbered backup is made.
285 Includes the new backup. Must be > 0"
288 (put 'kept-new-versions 'safe-local-variable 'integerp)
290 (defcustom require-final-newline nil
291 "Whether to add a newline automatically at the end of the file.
293 A value of t means do this only when the file is about to be saved.
294 A value of `visit' means do this right after the file is visited.
295 A value of `visit-save' means do it at both of those times.
296 Any other non-nil value means ask user whether to add a newline, when saving.
297 A value of nil means don't add newlines.
299 Certain major modes set this locally to the value obtained
300 from `mode-require-final-newline'."
301 :type '(choice (const :tag "When visiting" visit)
302 (const :tag "When saving" t)
303 (const :tag "When visiting or saving" visit-save)
304 (const :tag "Don't add newlines" nil)
305 (other :tag "Ask each time" ask))
306 :group 'editing-basics)
308 (defcustom mode-require-final-newline t
309 "Whether to add a newline at end of file, in certain major modes.
310 Those modes set `require-final-newline' to this value when you enable them.
311 They do so because they are often used for files that are supposed
312 to end in newlines, and the question is how to arrange that.
314 A value of t means do this only when the file is about to be saved.
315 A value of `visit' means do this right after the file is visited.
316 A value of `visit-save' means do it at both of those times.
317 Any other non-nil value means ask user whether to add a newline, when saving.
319 A value of nil means do not add newlines. That is a risky choice in this
320 variable since this value is used for modes for files that ought to have
321 final newlines. So if you set this to nil, you must explicitly check and
322 add a final newline, whenever you save a file that really needs one."
323 :type '(choice (const :tag "When visiting" visit)
324 (const :tag "When saving" t)
325 (const :tag "When visiting or saving" visit-save)
326 (const :tag "Don't add newlines" nil)
327 (other :tag "Ask each time" ask))
328 :group 'editing-basics
331 (defcustom auto-save-default t
332 "Non-nil says by default do auto-saving of every file-visiting buffer."
336 (defcustom auto-save-visited-file-name nil
337 "Non-nil says auto-save a buffer in the file it is visiting, when practical.
338 Normally auto-save files are written under other names."
342 (defcustom auto-save-file-name-transforms
343 `(("\\`/[^/]*:\\([^/]*/\\)*\\([^/]*\\)\\'"
344 ;; Don't put "\\2" inside expand-file-name, since it will be
345 ;; transformed to "/2" on DOS/Windows.
346 ,(concat temporary-file-directory "\\2") t))
347 "Transforms to apply to buffer file name before making auto-save file name.
348 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
349 REGEXP is a regular expression to match against the file name.
350 If it matches, `replace-match' is used to replace the
351 matching part with REPLACEMENT.
352 If the optional element UNIQUIFY is non-nil, the auto-save file name is
353 constructed by taking the directory part of the replaced file-name,
354 concatenated with the buffer file name with all directory separators
355 changed to `!' to prevent clashes. This will not work
356 correctly if your filesystem truncates the resulting name.
358 All the transforms in the list are tried, in the order they are listed.
359 When one transform applies, its result is final;
360 no further transforms are tried.
362 The default value is set up to put the auto-save file into the
363 temporary directory (see the variable `temporary-file-directory') for
364 editing a remote file.
366 On MS-DOS filesystems without long names this variable is always
369 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
370 (boolean :tag "Uniquify")))
373 (defcustom save-abbrevs t
374 "Non-nil means save word abbrevs too when files are saved.
375 If `silently', don't ask the user before saving."
376 :type '(choice (const t) (const nil) (const silently))
379 (defcustom find-file-run-dired t
380 "Non-nil means allow `find-file' to visit directories.
381 To visit the directory, `find-file' runs `find-directory-functions'."
385 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
386 "List of functions to try in sequence to visit a directory.
387 Each function is called with the directory name as the sole argument
388 and should return either a buffer or nil."
389 :type '(hook :options (cvs-dired-noselect dired-noselect))
392 ;;;It is not useful to make this a local variable.
393 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
394 (defvar find-file-not-found-functions nil
395 "List of functions to be called for `find-file' on nonexistent file.
396 These functions are called as soon as the error is detected.
397 Variable `buffer-file-name' is already set up.
398 The functions are called in the order given until one of them returns non-nil.")
399 (define-obsolete-variable-alias 'find-file-not-found-hooks
400 'find-file-not-found-functions "22.1")
402 ;;;It is not useful to make this a local variable.
403 ;;;(put 'find-file-hooks 'permanent-local t)
404 (define-obsolete-variable-alias 'find-file-hooks 'find-file-hook "22.1")
405 (defcustom find-file-hook nil
406 "List of functions to be called after a buffer is loaded from a file.
407 The buffer's local variables (if any) will have been processed before the
408 functions are called."
411 :options '(auto-insert)
414 (defvar write-file-functions nil
415 "List of functions to be called before writing out a buffer to a file.
416 If one of them returns non-nil, the file is considered already written
417 and the rest are not called.
418 These hooks are considered to pertain to the visited file.
419 So any buffer-local binding of this variable is discarded if you change
420 the visited file name with \\[set-visited-file-name], but not when you
421 change the major mode.
423 This hook is not run if any of the functions in
424 `write-contents-functions' returns non-nil. Both hooks pertain
425 to how to save a buffer to file, for instance, choosing a suitable
426 coding system and setting mode bits. (See Info
427 node `(elisp)Saving Buffers'.) To perform various checks or
428 updates before the buffer is saved, use `before-save-hook'.")
429 (put 'write-file-functions 'permanent-local t)
430 (define-obsolete-variable-alias 'write-file-hooks 'write-file-functions "22.1")
432 (defvar local-write-file-hooks nil)
433 (make-variable-buffer-local 'local-write-file-hooks)
434 (put 'local-write-file-hooks 'permanent-local t)
435 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "22.1")
437 (defvar write-contents-functions nil
438 "List of functions to be called before writing out a buffer to a file.
439 If one of them returns non-nil, the file is considered already written
440 and the rest are not called and neither are the functions in
441 `write-file-functions'.
443 This variable is meant to be used for hooks that pertain to the
444 buffer's contents, not to the particular visited file; thus,
445 `set-visited-file-name' does not clear this variable; but changing the
446 major mode does clear it.
448 For hooks that _do_ pertain to the particular visited file, use
449 `write-file-functions'. Both this variable and
450 `write-file-functions' relate to how a buffer is saved to file.
451 To perform various checks or updates before the buffer is saved,
452 use `before-save-hook'.")
453 (make-variable-buffer-local 'write-contents-functions)
454 (define-obsolete-variable-alias 'write-contents-hooks
455 'write-contents-functions "22.1")
457 (defcustom enable-local-variables t
458 "Control use of local variables in files you visit.
459 The value can be t, nil, :safe, :all, or something else.
461 A value of t means file local variables specifications are obeyed
462 if all the specified variable values are safe; if any values are
463 not safe, Emacs queries you, once, whether to set them all.
464 \(When you say yes to certain values, they are remembered as safe.)
466 :safe means set the safe variables, and ignore the rest.
467 :all means set all variables, whether safe or not.
468 (Don't set it permanently to :all.)
469 A value of nil means always ignore the file local variables.
471 Any other value means always query you once whether to set them all.
472 \(When you say yes to certain values, they are remembered as safe, but
473 this has no effect when `enable-local-variables' is \"something else\".)
475 This variable also controls use of major modes specified in
478 The command \\[normal-mode], when used interactively,
479 always obeys file local variable specifications and the -*- line,
480 and ignores this variable."
481 :type '(choice (const :tag "Query Unsafe" t)
482 (const :tag "Safe Only" :safe)
483 (const :tag "Do all" :all)
484 (const :tag "Ignore" nil)
485 (other :tag "Query" other))
488 (defvar local-enable-local-variables t
489 "Like `enable-local-variables' but meant for buffer-local bindings.
490 The meaningful values are nil and non-nil. The default is non-nil.
491 If a major mode sets this to nil, buffer-locally, then any local
492 variables list in the file will be ignored.
494 This variable does not affect the use of major modes
495 specified in a -*- line.")
497 (defcustom enable-local-eval 'maybe
498 "Control processing of the \"variable\" `eval' in a file's local variables.
499 The value can be t, nil or something else.
500 A value of t means obey `eval' variables;
501 A value of nil means ignore them; anything else means query."
502 :type '(choice (const :tag "Obey" t)
503 (const :tag "Ignore" nil)
504 (other :tag "Query" other))
507 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
508 (or (fboundp 'lock-buffer)
509 (defalias 'lock-buffer 'ignore))
510 (or (fboundp 'unlock-buffer)
511 (defalias 'unlock-buffer 'ignore))
512 (or (fboundp 'file-locked-p)
513 (defalias 'file-locked-p 'ignore))
515 (defcustom view-read-only nil
516 "Non-nil means buffers visiting files read-only do so in view mode.
517 In fact, this means that all read-only buffers normally have
518 View mode enabled, including buffers that are read-only because
519 you visit a file you cannot alter, and buffers you make read-only
520 using \\[toggle-read-only]."
524 (defvar file-name-history nil
525 "History list of file names entered in the minibuffer.
527 Maximum length of the history list is determined by the value
528 of `history-length', which see.")
530 (put 'ange-ftp-completion-hook-function 'safe-magic t)
531 (defun ange-ftp-completion-hook-function (op &rest args)
532 "Provides support for ange-ftp host name completion.
533 Runs the usual ange-ftp hook, but only for completion operations."
534 ;; Having this here avoids the need to load ange-ftp when it's not
536 (if (memq op '(file-name-completion file-name-all-completions))
537 (apply 'ange-ftp-hook-function op args)
538 (let ((inhibit-file-name-handlers
539 (cons 'ange-ftp-completion-hook-function
540 (and (eq inhibit-file-name-operation op)
541 inhibit-file-name-handlers)))
542 (inhibit-file-name-operation op))
545 (defun convert-standard-filename (filename)
546 "Convert a standard file's name to something suitable for the OS.
547 This means to guarantee valid names and perhaps to canonicalize
550 FILENAME should be an absolute file name since the conversion rules
551 sometimes vary depending on the position in the file name. E.g. c:/foo
552 is a valid DOS file name, but c:/bar/c:/foo is not.
554 This function's standard definition is trivial; it just returns
555 the argument. However, on Windows and DOS, replace invalid
556 characters. On DOS, make sure to obey the 8.3 limitations.
557 In the native Windows build, turn Cygwin names into native names,
558 and also turn slashes into backslashes if the shell requires it (see
559 `w32-shell-dos-semantics').
561 See Info node `(elisp)Standard File Names' for more details."
562 (if (eq system-type 'cygwin)
563 (let ((name (copy-sequence filename))
565 ;; Replace invalid filename characters with !
566 (while (string-match "[?*:<>|\"\000-\037]" name start)
567 (aset name (match-beginning 0) ?!)
568 (setq start (match-end 0)))
572 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
573 "Read directory name, prompting with PROMPT and completing in directory DIR.
574 Value is not expanded---you must call `expand-file-name' yourself.
575 Default name to DEFAULT-DIRNAME if user exits with the same
576 non-empty string that was inserted by this function.
577 (If DEFAULT-DIRNAME is omitted, DIR combined with INITIAL is used,
578 or just DIR if INITIAL is nil.)
579 If the user exits with an empty minibuffer, this function returns
580 an empty string. (This can only happen if the user erased the
581 pre-inserted contents or if `insert-default-directory' is nil.)
582 Fourth arg MUSTMATCH non-nil means require existing directory's name.
583 Non-nil and non-t means also require confirmation after completion.
584 Fifth arg INITIAL specifies text to start with.
585 DIR should be an absolute directory name. It defaults to
586 the value of `default-directory'."
588 (setq dir default-directory))
589 (read-file-name prompt dir (or default-dirname
590 (if initial (expand-file-name initial dir)
597 "Show the current default directory."
599 (message "Directory %s" default-directory))
602 "Value of the CDPATH environment variable, as a list.
603 Not actually set up until the first time you use it.")
605 (defun parse-colon-path (cd-path)
606 "Explode a search path into a list of directory names.
607 Directories are separated by occurrences of `path-separator'
608 \(which is colon in GNU and GNU-like systems)."
609 ;; We could use split-string here.
611 (let (cd-list (cd-start 0) cd-colon)
612 (setq cd-path (concat cd-path path-separator))
613 (while (setq cd-colon (string-match path-separator cd-path cd-start))
616 (list (if (= cd-start cd-colon)
618 (substitute-in-file-name
619 (file-name-as-directory
620 (substring cd-path cd-start cd-colon)))))))
621 (setq cd-start (+ cd-colon 1)))
624 (defun cd-absolute (dir)
625 "Change current directory to given absolute file name DIR."
626 ;; Put the name into directory syntax now,
627 ;; because otherwise expand-file-name may give some bad results.
628 (if (not (eq system-type 'vax-vms))
629 (setq dir (file-name-as-directory dir)))
630 (setq dir (abbreviate-file-name (expand-file-name dir)))
631 (if (not (file-directory-p dir))
632 (if (file-exists-p dir)
633 (error "%s is not a directory" dir)
634 (error "%s: no such directory" dir))
635 (unless (file-executable-p dir)
636 (error "Cannot cd to %s: Permission denied" dir))
637 (setq default-directory dir)
638 (set (make-local-variable 'list-buffers-directory) dir)))
641 "Make DIR become the current buffer's default directory.
642 If your environment includes a `CDPATH' variable, try each one of
643 that list of directories (separated by occurrences of
644 `path-separator') when resolving a relative directory name.
645 The path separator is colon in GNU and GNU-like systems."
647 (list (read-directory-name "Change default directory: "
648 default-directory default-directory
649 (and (member cd-path '(nil ("./")))
650 (null (getenv "CDPATH"))))))
651 (if (file-name-absolute-p dir)
652 (cd-absolute (expand-file-name dir))
654 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
655 (setq cd-path (or trypath (list "./")))))
656 (if (not (catch 'found
658 (function (lambda (x)
659 (let ((f (expand-file-name (concat x dir))))
660 (if (file-directory-p f)
663 (throw 'found t))))))
666 (error "No such directory found via CDPATH environment variable"))))
668 (defun load-file (file)
669 "Load the Lisp file named FILE."
670 ;; This is a case where .elc makes a lot of sense.
671 (interactive (list (let ((completion-ignored-extensions
672 (remove ".elc" completion-ignored-extensions)))
673 (read-file-name "Load file: "))))
674 (load (expand-file-name file) nil nil t))
676 (defun locate-file (filename path &optional suffixes predicate)
677 "Search for FILENAME through PATH.
678 If found, return the absolute file name of FILENAME, with its suffixes;
679 otherwise return nil.
680 PATH should be a list of directories to look in, like the lists in
681 `exec-path' or `load-path'.
682 If SUFFIXES is non-nil, it should be a list of suffixes to append to
683 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
684 Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
685 If non-nil, PREDICATE is used instead of `file-readable-p'.
686 PREDICATE can also be an integer to pass to the `access' system call,
687 in which case file-name handlers are ignored. This usage is deprecated.
689 For compatibility, PREDICATE can also be one of the symbols
690 `executable', `readable', `writable', or `exists', or a list of
691 one or more of those symbols."
692 (if (and predicate (symbolp predicate) (not (functionp predicate)))
693 (setq predicate (list predicate)))
694 (when (and (consp predicate) (not (functionp predicate)))
696 (logior (if (memq 'executable predicate) 1 0)
697 (if (memq 'writable predicate) 2 0)
698 (if (memq 'readable predicate) 4 0))))
699 (locate-file-internal filename path suffixes predicate))
701 (defun locate-file-completion-table (dirs suffixes string pred action)
702 "Do completion for file names passed to `locate-file'."
703 (if (file-name-absolute-p string)
704 (let ((read-file-name-predicate pred))
705 (read-file-name-internal string nil action))
707 (suffix (concat (regexp-opt suffixes t) "\\'"))
708 (string-dir (file-name-directory string)))
711 (setq dir default-directory))
712 (if string-dir (setq dir (expand-file-name string-dir dir)))
713 (when (file-directory-p dir)
714 (dolist (file (file-name-all-completions
715 (file-name-nondirectory string) dir))
716 (add-to-list 'names (if string-dir (concat string-dir file) file))
717 (when (string-match suffix file)
718 (setq file (substring file 0 (match-beginning 0)))
719 (push (if string-dir (concat string-dir file) file) names)))))
720 (complete-with-action action names string pred))))
722 (defun locate-file-completion (string path-and-suffixes action)
723 "Do completion for file names passed to `locate-file'.
724 PATH-AND-SUFFIXES is a pair of lists, (DIRECTORIES . SUFFIXES)."
725 (locate-file-completion-table (car path-and-suffixes)
726 (cdr path-and-suffixes)
728 (make-obsolete 'locate-file-completion 'locate-file-completion-table "23.1")
730 (defun locate-dominating-file (file regexp)
731 "Look up the directory hierarchy from FILE for a file matching REGEXP."
733 ;; `user' is not initialized yet because `file' may not exist, so we may
734 ;; have to walk up part of the hierarchy before we find the "initial UID".
736 ;; Abbreviate, so as to stop when we cross ~/.
737 (dir (abbreviate-file-name (file-name-as-directory file)))
740 ;; As a heuristic, we stop looking up the hierarchy of
741 ;; directories as soon as we find a directory belonging to
742 ;; another user. This should save us from looking in
743 ;; things like /net and /afs. This assumes that all the
744 ;; files inside a project belong to the same user.
745 (let ((prev-user user))
746 (setq user (nth 2 (file-attributes file)))
747 (or (null prev-user) (equal user prev-user))))
748 (if (setq files (and (file-directory-p dir)
749 (directory-files dir 'full regexp)))
750 (throw 'found (car files))
752 (setq dir (file-name-directory
753 (directory-file-name dir))))
757 (defun executable-find (command)
758 "Search for COMMAND in `exec-path' and return the absolute file name.
759 Return nil if COMMAND is not found anywhere in `exec-path'."
760 ;; Use 1 rather than file-executable-p to better match the behavior of
762 (locate-file command exec-path exec-suffixes 1))
764 (defun load-library (library)
765 "Load the library named LIBRARY.
766 This is an interface to the function `load'."
768 (list (completing-read "Load library: "
769 (apply-partially 'locate-file-completion-table
771 (get-load-suffixes)))))
774 (defun file-remote-p (file &optional identification connected)
775 "Test whether FILE specifies a location on a remote system.
776 Returns nil or a string identifying the remote connection (ideally
777 a prefix of FILE). For example, the remote identification for filename
778 \"/user@host:/foo\" could be \"/user@host:\".
779 A file is considered \"remote\" if accessing it is likely to be slower or
780 less reliable than accessing local files.
781 Furthermore, relative file names do not work across remote connections.
783 IDENTIFICATION specifies which part of the identification shall
784 be returned as string. IDENTIFICATION can be the symbol
785 `method', `user' or `host'; any other value is handled like nil
786 and means to return the complete identification string.
788 If CONNECTED is non-nil, the function returns an identification only
789 if FILE is located on a remote system, and a connection is established
790 to that remote system.
792 `file-remote-p' will never open a connection on its own."
793 (let ((handler (find-file-name-handler file 'file-remote-p)))
795 (funcall handler 'file-remote-p file identification connected)
798 (defun file-local-copy (file)
799 "Copy the file FILE into a temporary file on this machine.
800 Returns the name of the local copy, or nil, if FILE is directly
802 ;; This formerly had an optional BUFFER argument that wasn't used by
804 (let ((handler (find-file-name-handler file 'file-local-copy)))
806 (funcall handler 'file-local-copy file)
809 (defun file-truename (filename &optional counter prev-dirs)
810 "Return the truename of FILENAME, which should be absolute.
811 The truename of a file name is found by chasing symbolic links
812 both at the level of the file and at the level of the directories
813 containing it, until no links are left at any level.
815 \(fn FILENAME)" ;; Don't document the optional arguments.
816 ;; COUNTER and PREV-DIRS are only used in recursive calls.
817 ;; COUNTER can be a cons cell whose car is the count of how many
818 ;; more links to chase before getting an error.
819 ;; PREV-DIRS can be a cons cell whose car is an alist
820 ;; of truenames we've just recently computed.
821 (cond ((or (string= filename "") (string= filename "~"))
822 (setq filename (expand-file-name filename))
823 (if (string= filename "")
824 (setq filename "/")))
825 ((and (string= (substring filename 0 1) "~")
826 (string-match "~[^/]*/?" filename))
828 (substring filename 0 (match-end 0)))
829 (rest (substring filename (match-end 0))))
830 (setq filename (concat (expand-file-name first-part) rest)))))
832 (or counter (setq counter (list 100)))
834 ;; For speed, remove the ange-ftp completion handler from the list.
835 ;; We know it's not needed here.
836 ;; For even more speed, do this only on the outermost call.
837 (file-name-handler-alist
838 (if prev-dirs file-name-handler-alist
839 (let ((tem (copy-sequence file-name-handler-alist)))
840 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
841 (or prev-dirs (setq prev-dirs (list nil)))
843 ;; andrewi@harlequin.co.uk - none of the following code (except for
844 ;; invoking the file-name handler) currently applies on Windows
845 ;; (ie. there are no native symlinks), but there is an issue with
846 ;; case differences being ignored by the OS, and short "8.3 DOS"
847 ;; name aliases existing for all files. (The short names are not
848 ;; reported by directory-files, but can be used to refer to files.)
849 ;; It seems appropriate for file-truename to resolve these issues in
850 ;; the most natural way, which on Windows is to call the function
851 ;; `w32-long-file-name' - this returns the exact name of a file as
852 ;; it is stored on disk (expanding short name aliases with the full
853 ;; name in the process).
854 (if (eq system-type 'windows-nt)
855 (let ((handler (find-file-name-handler filename 'file-truename)))
856 ;; For file name that has a special handler, call handler.
857 ;; This is so that ange-ftp can save time by doing a no-op.
859 (setq filename (funcall handler 'file-truename filename))
860 ;; If filename contains a wildcard, newname will be the old name.
861 (unless (string-match "[[*?]" filename)
862 ;; If filename exists, use the long name. If it doesn't exist,
863 ;; drill down until we find a directory that exists, and use
864 ;; the long name of that, with the extra non-existent path
865 ;; components concatenated.
866 (let ((longname (w32-long-file-name filename))
869 (setq filename longname)
870 ;; include the preceding directory separator in the missing
871 ;; part so subsequent recursion on the rest works.
872 (setq missing (concat "/" (file-name-nondirectory filename)))
873 (setq rest (substring filename 0 (* -1 (length missing))))
874 (setq filename (concat (file-truename rest) missing))))))
877 ;; If this file directly leads to a link, process that iteratively
878 ;; so that we don't use lots of stack.
880 (setcar counter (1- (car counter)))
881 (if (< (car counter) 0)
882 (error "Apparent cycle of symbolic links for %s" filename))
883 (let ((handler (find-file-name-handler filename 'file-truename)))
884 ;; For file name that has a special handler, call handler.
885 ;; This is so that ange-ftp can save time by doing a no-op.
887 (setq filename (funcall handler 'file-truename filename)
889 (let ((dir (or (file-name-directory filename) default-directory))
891 ;; Get the truename of the directory.
892 (setq dirfile (directory-file-name dir))
893 ;; If these are equal, we have the (or a) root directory.
894 (or (string= dir dirfile)
895 ;; If this is the same dir we last got the truename for,
896 ;; save time--don't recalculate.
897 (if (assoc dir (car prev-dirs))
898 (setq dir (cdr (assoc dir (car prev-dirs))))
900 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
901 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
903 (if (equal ".." (file-name-nondirectory filename))
905 (directory-file-name (file-name-directory (directory-file-name dir)))
907 (if (equal "." (file-name-nondirectory filename))
908 (setq filename (directory-file-name dir)
910 ;; Put it back on the file name.
911 (setq filename (concat dir (file-name-nondirectory filename)))
912 ;; Is the file name the name of a link?
913 (setq target (file-symlink-p filename))
915 ;; Yes => chase that link, then start all over
916 ;; since the link may point to a directory name that uses links.
917 ;; We can't safely use expand-file-name here
918 ;; since target might look like foo/../bar where foo
919 ;; is itself a link. Instead, we handle . and .. above.
921 (if (file-name-absolute-p target)
929 (defun file-chase-links (filename &optional limit)
930 "Chase links in FILENAME until a name that is not a link.
931 Unlike `file-truename', this does not check whether a parent
932 directory name is a symbolic link.
933 If the optional argument LIMIT is a number,
934 it means chase no more than that many links and then stop."
935 (let (tem (newname filename)
937 (while (and (or (null limit) (< count limit))
938 (setq tem (file-symlink-p newname)))
940 (if (and (null limit) (= count 100))
941 (error "Apparent cycle of symbolic links for %s" filename))
942 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
943 (while (string-match "//+" tem)
944 (setq tem (replace-match "/" nil nil tem)))
945 ;; Handle `..' by hand, since it needs to work in the
946 ;; target of any directory symlink.
947 ;; This code is not quite complete; it does not handle
948 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
949 (while (string-match "\\`\\.\\./" tem)
950 (setq tem (substring tem 3))
951 (setq newname (expand-file-name newname))
952 ;; Chase links in the default dir of the symlink.
955 (directory-file-name (file-name-directory newname))))
956 ;; Now find the parent of that dir.
957 (setq newname (file-name-directory newname)))
958 (setq newname (expand-file-name tem (file-name-directory newname)))
959 (setq count (1+ count))))
962 (defun make-temp-file (prefix &optional dir-flag suffix)
963 "Create a temporary file.
964 The returned file name (created by appending some random characters at the end
965 of PREFIX, and expanding against `temporary-file-directory' if necessary),
966 is guaranteed to point to a newly created empty file.
967 You can then use `write-region' to write new data into the file.
969 If DIR-FLAG is non-nil, create a new empty directory instead of a file.
971 If SUFFIX is non-nil, add that at the end of the file name."
972 (let ((umask (default-file-modes))
976 ;; Create temp files with strict access rights. It's easy to
977 ;; loosen them later, whereas it's impossible to close the
978 ;; time-window of loose permissions otherwise.
979 (set-default-file-modes ?\700)
980 (while (condition-case ()
984 (expand-file-name prefix temporary-file-directory)))
986 (setq file (concat file suffix)))
988 (make-directory file)
989 (write-region "" nil file nil 'silent nil 'excl))
991 (file-already-exists t))
992 ;; the file was somehow created by someone else between
993 ;; `make-temp-name' and `write-region', let's try again.
997 (set-default-file-modes umask))))
999 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
1000 "Change the encoding of FILE's name from CODING to NEW-CODING.
1001 The value is a new name of FILE.
1002 Signals a `file-already-exists' error if a file of the new name
1003 already exists unless optional fourth argument OK-IF-ALREADY-EXISTS
1004 is non-nil. A number as fourth arg means request confirmation if
1005 the new name already exists. This is what happens in interactive
1008 (let ((default-coding (or file-name-coding-system
1009 default-file-name-coding-system))
1010 (filename (read-file-name "Recode filename: " nil nil t))
1011 from-coding to-coding)
1012 (if (and default-coding
1013 ;; We provide the default coding only when it seems that
1014 ;; the filename is correctly decoded by the default
1016 (let ((charsets (find-charset-string filename)))
1017 (and (not (memq 'eight-bit-control charsets))
1018 (not (memq 'eight-bit-graphic charsets)))))
1019 (setq from-coding (read-coding-system
1020 (format "Recode filename %s from (default %s): "
1021 filename default-coding)
1023 (setq from-coding (read-coding-system
1024 (format "Recode filename %s from: " filename))))
1026 ;; We provide the default coding only when a user is going to
1027 ;; change the encoding not from the default coding.
1028 (if (eq from-coding default-coding)
1029 (setq to-coding (read-coding-system
1030 (format "Recode filename %s from %s to: "
1031 filename from-coding)))
1032 (setq to-coding (read-coding-system
1033 (format "Recode filename %s from %s to (default %s): "
1034 filename from-coding default-coding)
1036 (list filename from-coding to-coding)))
1038 (let* ((default-coding (or file-name-coding-system
1039 default-file-name-coding-system))
1040 ;; FILE should have been decoded by DEFAULT-CODING.
1041 (encoded (encode-coding-string file default-coding))
1042 (newname (decode-coding-string encoded coding))
1043 (new-encoded (encode-coding-string newname new-coding))
1044 ;; Suppress further encoding.
1045 (file-name-coding-system nil)
1046 (default-file-name-coding-system nil)
1047 (locale-coding-system nil))
1048 (rename-file encoded new-encoded ok-if-already-exists)
1051 (defun read-buffer-to-switch (prompt)
1052 "Read the name of a buffer to switch to and return as a string.
1053 It is intended for `switch-to-buffer' family of commands since they
1054 need to omit the name of current buffer from the list of completions
1055 and default values."
1056 (let ((rbts-completion-table (internal-complete-buffer-except)))
1057 (minibuffer-with-setup-hook
1058 (lambda () (setq minibuffer-completion-table rbts-completion-table))
1059 (read-buffer prompt (other-buffer (current-buffer))))))
1061 (defun switch-to-buffer-other-window (buffer &optional norecord)
1062 "Select buffer BUFFER in another window.
1063 If BUFFER does not identify an existing buffer, then this function
1064 creates a buffer with that name.
1066 When called from Lisp, BUFFER can be a buffer, a string \(a buffer name),
1067 or nil. If BUFFER is nil, then this function chooses a buffer
1068 using `other-buffer'.
1069 Optional second arg NORECORD non-nil means
1070 do not put this buffer at the front of the list of recently selected ones.
1071 This function returns the buffer it switched to.
1073 This uses the function `display-buffer' as a subroutine; see its
1074 documentation for additional customization information."
1076 (list (read-buffer-to-switch "Switch to buffer in other window: ")))
1077 (let ((pop-up-windows t)
1078 ;; Don't let these interfere.
1079 same-window-buffer-names same-window-regexps)
1080 (pop-to-buffer buffer t norecord)))
1082 (defun switch-to-buffer-other-frame (buffer &optional norecord)
1083 "Switch to buffer BUFFER in another frame.
1084 Optional second arg NORECORD non-nil means
1085 do not put this buffer at the front of the list of recently selected ones.
1086 This function returns the buffer it switched to.
1088 This uses the function `display-buffer' as a subroutine; see its
1089 documentation for additional customization information."
1091 (list (read-buffer-to-switch "Switch to buffer in other frame: ")))
1092 (let ((pop-up-frames t)
1093 same-window-buffer-names same-window-regexps)
1095 (pop-to-buffer buffer t norecord)
1096 (raise-frame (window-frame (selected-window))))))
1098 (defun display-buffer-other-frame (buffer)
1099 "Switch to buffer BUFFER in another frame.
1100 This uses the function `display-buffer' as a subroutine; see its
1101 documentation for additional customization information."
1102 (interactive "BDisplay buffer in other frame: ")
1103 (let ((pop-up-frames t)
1104 same-window-buffer-names same-window-regexps
1105 (old-window (selected-window))
1107 (setq new-window (display-buffer buffer t))
1108 ;; This may have been here in order to prevent the new frame from hiding
1109 ;; the old frame. But it does more harm than good.
1110 ;; Maybe we should call `raise-window' on the old-frame instead? --Stef
1111 ;;(lower-frame (window-frame new-window))
1113 ;; This may have been here in order to make sure the old-frame gets the
1114 ;; focus. But not only can it cause an annoying flicker, with some
1115 ;; window-managers it just makes the window invisible, with no easy
1116 ;; way to recover it. --Stef
1117 ;;(make-frame-invisible (window-frame old-window))
1118 ;;(make-frame-visible (window-frame old-window))
1121 (defvar find-file-default nil
1122 "Used within `find-file-read-args'.")
1124 (defmacro minibuffer-with-setup-hook (fun &rest body)
1125 "Add FUN to `minibuffer-setup-hook' while executing BODY.
1126 BODY should use the minibuffer at most once.
1127 Recursive uses of the minibuffer will not be affected."
1128 (declare (indent 1) (debug t))
1129 (let ((hook (make-symbol "setup-hook")))
1133 ;; Clear out this hook so it does not interfere
1134 ;; with any recursive minibuffer usage.
1135 (remove-hook 'minibuffer-setup-hook ,hook)
1139 (add-hook 'minibuffer-setup-hook ,hook)
1141 (remove-hook 'minibuffer-setup-hook ,hook)))))
1143 (defcustom find-file-confirm-nonexistent-file nil
1144 "If non-nil, `find-file' requires confirmation before visiting a new file."
1149 (defun find-file-read-args (prompt mustmatch)
1150 (list (let ((find-file-default
1151 (and buffer-file-name
1152 (abbreviate-file-name buffer-file-name))))
1153 (minibuffer-with-setup-hook
1154 (lambda () (setq minibuffer-default find-file-default))
1155 (read-file-name prompt nil default-directory mustmatch)))
1158 (defun find-file (filename &optional wildcards)
1159 "Edit file FILENAME.
1160 Switch to a buffer visiting file FILENAME,
1161 creating one if none already exists.
1162 Interactively, the default if you just type RET is the current directory,
1163 but the visited file name is available through the minibuffer history:
1164 type M-n to pull it into the minibuffer.
1166 You can visit files on remote machines by specifying something
1167 like /ssh:SOME_REMOTE_MACHINE:FILE for the file name. You can
1168 also visit local files as a different user by specifying
1169 /sudo::FILE for the file name.
1170 See the Info node `(tramp)Filename Syntax' in the Tramp Info
1171 manual, for more about this.
1173 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1174 expand wildcards (if any) and visit multiple files. You can
1175 suppress wildcard expansion by setting `find-file-wildcards' to nil.
1177 To visit a file without any kind of conversion and without
1178 automatically choosing a major mode, use \\[find-file-literally]."
1180 (find-file-read-args "Find file: "
1181 (if find-file-confirm-nonexistent-file 'confirm-only)))
1182 (let ((value (find-file-noselect filename nil nil wildcards)))
1184 (mapcar 'switch-to-buffer (nreverse value))
1185 (switch-to-buffer value))))
1187 (defun find-file-other-window (filename &optional wildcards)
1188 "Edit file FILENAME, in another window.
1190 Like \\[find-file] (which see), but creates a new window or reuses
1191 an existing one. See the function `display-buffer'.
1193 Interactively, the default if you just type RET is the current directory,
1194 but the visited file name is available through the minibuffer history:
1195 type M-n to pull it into the minibuffer.
1197 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1198 expand wildcards (if any) and visit multiple files."
1200 (find-file-read-args "Find file in other window: "
1201 (if find-file-confirm-nonexistent-file 'confirm-only)))
1202 (let ((value (find-file-noselect filename nil nil wildcards)))
1205 (setq value (nreverse value))
1206 (cons (switch-to-buffer-other-window (car value))
1207 (mapcar 'switch-to-buffer (cdr value))))
1208 (switch-to-buffer-other-window value))))
1210 (defun find-file-other-frame (filename &optional wildcards)
1211 "Edit file FILENAME, in another frame.
1213 Like \\[find-file] (which see), but creates a new frame or reuses
1214 an existing one. See the function `display-buffer'.
1216 Interactively, the default if you just type RET is the current directory,
1217 but the visited file name is available through the minibuffer history:
1218 type M-n to pull it into the minibuffer.
1220 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1221 expand wildcards (if any) and visit multiple files."
1223 (find-file-read-args "Find file in other frame: "
1224 (if find-file-confirm-nonexistent-file 'confirm-only)))
1225 (let ((value (find-file-noselect filename nil nil wildcards)))
1228 (setq value (nreverse value))
1229 (cons (switch-to-buffer-other-frame (car value))
1230 (mapcar 'switch-to-buffer (cdr value))))
1231 (switch-to-buffer-other-frame value))))
1233 (defun find-file-existing (filename)
1234 "Edit the existing file FILENAME.
1235 Like \\[find-file], but only allow a file that exists, and do not allow
1236 file names with wildcards."
1237 (interactive (nbutlast (find-file-read-args "Find existing file: " t)))
1238 (if (and (not (interactive-p)) (not (file-exists-p filename)))
1239 (error "%s does not exist" filename)
1240 (find-file filename)
1243 (defun find-file-read-only (filename &optional wildcards)
1244 "Edit file FILENAME but don't allow changes.
1245 Like \\[find-file], but marks buffer as read-only.
1246 Use \\[toggle-read-only] to permit editing."
1248 (find-file-read-args "Find file read-only: "
1249 (if find-file-confirm-nonexistent-file 'confirm-only)))
1250 (unless (or (and wildcards find-file-wildcards
1251 (not (string-match "\\`/:" filename))
1252 (string-match "[[*?]" filename))
1253 (file-exists-p filename))
1254 (error "%s does not exist" filename))
1255 (let ((value (find-file filename wildcards)))
1256 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1257 (if (listp value) value (list value)))
1260 (defun find-file-read-only-other-window (filename &optional wildcards)
1261 "Edit file FILENAME in another window but don't allow changes.
1262 Like \\[find-file-other-window], but marks buffer as read-only.
1263 Use \\[toggle-read-only] to permit editing."
1265 (find-file-read-args "Find file read-only other window: "
1266 (if find-file-confirm-nonexistent-file 'confirm-only)))
1267 (unless (or (and wildcards find-file-wildcards
1268 (not (string-match "\\`/:" filename))
1269 (string-match "[[*?]" filename))
1270 (file-exists-p filename))
1271 (error "%s does not exist" filename))
1272 (let ((value (find-file-other-window filename wildcards)))
1273 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1274 (if (listp value) value (list value)))
1277 (defun find-file-read-only-other-frame (filename &optional wildcards)
1278 "Edit file FILENAME in another frame but don't allow changes.
1279 Like \\[find-file-other-frame], but marks buffer as read-only.
1280 Use \\[toggle-read-only] to permit editing."
1282 (find-file-read-args "Find file read-only other frame: "
1283 (if find-file-confirm-nonexistent-file 'confirm-only)))
1284 (unless (or (and wildcards find-file-wildcards
1285 (not (string-match "\\`/:" filename))
1286 (string-match "[[*?]" filename))
1287 (file-exists-p filename))
1288 (error "%s does not exist" filename))
1289 (let ((value (find-file-other-frame filename wildcards)))
1290 (mapc (lambda (b) (with-current-buffer b (toggle-read-only 1)))
1291 (if (listp value) value (list value)))
1294 (defun find-alternate-file-other-window (filename &optional wildcards)
1295 "Find file FILENAME as a replacement for the file in the next window.
1296 This command does not select that window.
1298 See \\[find-file] for the possible forms of the FILENAME argument.
1300 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1301 expand wildcards (if any) and replace the file with multiple files."
1303 (save-selected-window
1305 (let ((file buffer-file-name)
1309 (setq file-name (file-name-nondirectory file)
1310 file-dir (file-name-directory file)))
1311 (list (read-file-name
1312 "Find alternate file: " file-dir nil nil file-name)
1315 (find-file-other-window filename wildcards)
1316 (save-selected-window
1318 (find-alternate-file filename wildcards))))
1320 (defun find-alternate-file (filename &optional wildcards)
1321 "Find file FILENAME, select its buffer, kill previous buffer.
1322 If the current buffer now contains an empty file that you just visited
1323 \(presumably by mistake), use this command to visit the file you really want.
1325 See \\[find-file] for the possible forms of the FILENAME argument.
1327 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
1328 expand wildcards (if any) and replace the file with multiple files.
1330 If the current buffer is an indirect buffer, or the base buffer
1331 for one or more indirect buffers, the other buffer(s) are not
1334 (let ((file buffer-file-name)
1338 (setq file-name (file-name-nondirectory file)
1339 file-dir (file-name-directory file)))
1340 (list (read-file-name
1341 "Find alternate file: " file-dir nil nil file-name)
1343 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
1345 (when (and (buffer-modified-p) (buffer-file-name))
1346 (if (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
1348 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
1351 (let ((obuf (current-buffer))
1352 (ofile buffer-file-name)
1353 (onum buffer-file-number)
1354 (odir dired-directory)
1355 (otrue buffer-file-truename)
1356 (oname (buffer-name)))
1357 (if (get-buffer " **lose**")
1358 (kill-buffer " **lose**"))
1359 (rename-buffer " **lose**")
1363 ;; This prevents us from finding the same buffer
1364 ;; if we specified the same file again.
1365 (setq buffer-file-name nil)
1366 (setq buffer-file-number nil)
1367 (setq buffer-file-truename nil)
1368 ;; Likewise for dired buffers.
1369 (setq dired-directory nil)
1370 (find-file filename wildcards))
1371 (when (eq obuf (current-buffer))
1372 ;; This executes if find-file gets an error
1373 ;; and does not really find anything.
1374 ;; We put things back as they were.
1375 ;; If find-file actually finds something, we kill obuf below.
1376 (setq buffer-file-name ofile)
1377 (setq buffer-file-number onum)
1378 (setq buffer-file-truename otrue)
1379 (setq dired-directory odir)
1381 (rename-buffer oname)))
1382 (unless (eq (current-buffer) obuf)
1383 (with-current-buffer obuf
1384 ;; We already asked; don't ask again.
1385 (let ((kill-buffer-query-functions))
1386 (kill-buffer obuf))))))
1388 (defun create-file-buffer (filename)
1389 "Create a suitably named buffer for visiting FILENAME, and return it.
1390 FILENAME (sans directory) is used unchanged if that name is free;
1391 otherwise a string <2> or <3> or ... is appended to get an unused name.
1392 Spaces at the start of FILENAME (sans directory) are removed."
1393 (let ((lastname (file-name-nondirectory filename)))
1394 (if (string= lastname "")
1395 (setq lastname filename))
1397 (string-match "^ *\\(.*\\)" lastname)
1398 (generate-new-buffer (match-string 1 lastname)))))
1400 (defun generate-new-buffer (name)
1401 "Create and return a buffer with a name based on NAME.
1402 Choose the buffer's name using `generate-new-buffer-name'."
1403 (get-buffer-create (generate-new-buffer-name name)))
1405 (defcustom automount-dir-prefix "^/tmp_mnt/"
1406 "Regexp to match the automounter prefix in a directory name."
1410 (defvar abbreviated-home-dir nil
1411 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1413 (defun abbreviate-file-name (filename)
1414 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1415 This also substitutes \"~\" for the user's home directory (unless the
1416 home directory is a root directory) and removes automounter prefixes
1417 \(see the variable `automount-dir-prefix')."
1418 ;; Get rid of the prefixes added by the automounter.
1420 (if (and automount-dir-prefix
1421 (string-match automount-dir-prefix filename)
1422 (file-exists-p (file-name-directory
1423 (substring filename (1- (match-end 0))))))
1424 (setq filename (substring filename (1- (match-end 0)))))
1425 (let ((tail directory-abbrev-alist))
1426 ;; If any elt of directory-abbrev-alist matches this name,
1427 ;; abbreviate accordingly.
1429 (if (string-match (car (car tail)) filename)
1431 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1432 (setq tail (cdr tail)))
1433 ;; Compute and save the abbreviated homedir name.
1434 ;; We defer computing this until the first time it's needed, to
1435 ;; give time for directory-abbrev-alist to be set properly.
1436 ;; We include a slash at the end, to avoid spurious matches
1437 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1438 (or abbreviated-home-dir
1439 (setq abbreviated-home-dir
1440 (let ((abbreviated-home-dir "$foo"))
1441 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1444 ;; If FILENAME starts with the abbreviated homedir,
1445 ;; make it start with `~' instead.
1446 (if (and (string-match abbreviated-home-dir filename)
1447 ;; If the home dir is just /, don't change it.
1448 (not (and (= (match-end 0) 1)
1449 (= (aref filename 0) ?/)))
1450 ;; MS-DOS root directories can come with a drive letter;
1451 ;; Novell Netware allows drive letters beyond `Z:'.
1452 (not (and (or (eq system-type 'ms-dos)
1453 (eq system-type 'cygwin)
1454 (eq system-type 'windows-nt))
1456 (string-match "^[a-zA-`]:/$" filename)))))
1459 (match-string 1 filename)
1460 (substring filename (match-end 0)))))
1463 (defcustom find-file-not-true-dirname-list nil
1464 "List of logical names for which visiting shouldn't save the true dirname.
1465 On VMS, when you visit a file using a logical name that searches a path,
1466 you may or may not want the visited file name to record the specific
1467 directory where the file was found. If you *do not* want that, add the logical
1468 name to this list as a string."
1469 :type '(repeat (string :tag "Name"))
1472 (defun find-buffer-visiting (filename &optional predicate)
1473 "Return the buffer visiting file FILENAME (a string).
1474 This is like `get-file-buffer', except that it checks for any buffer
1475 visiting the same file, possibly under a different name.
1476 If PREDICATE is non-nil, only buffers satisfying it are eligible,
1477 and others are ignored.
1478 If there is no such live buffer, return nil."
1479 (let ((predicate (or predicate #'identity))
1480 (truename (abbreviate-file-name (file-truename filename))))
1481 (or (let ((buf (get-file-buffer filename)))
1482 (when (and buf (funcall predicate buf)) buf))
1483 (let ((list (buffer-list)) found)
1484 (while (and (not found) list)
1486 (set-buffer (car list))
1487 (if (and buffer-file-name
1488 (string= buffer-file-truename truename)
1489 (funcall predicate (current-buffer)))
1490 (setq found (car list))))
1491 (setq list (cdr list)))
1493 (let* ((attributes (file-attributes truename))
1494 (number (nthcdr 10 attributes))
1495 (list (buffer-list)) found)
1496 (and buffer-file-numbers-unique
1497 (car-safe number) ;Make sure the inode is not just nil.
1498 (while (and (not found) list)
1499 (with-current-buffer (car list)
1500 (if (and buffer-file-name
1501 (equal buffer-file-number number)
1502 ;; Verify this buffer's file number
1503 ;; still belongs to its file.
1504 (file-exists-p buffer-file-name)
1505 (equal (file-attributes buffer-file-truename)
1507 (funcall predicate (current-buffer)))
1508 (setq found (car list))))
1509 (setq list (cdr list))))
1512 (defcustom find-file-wildcards t
1513 "Non-nil means file-visiting commands should handle wildcards.
1514 For example, if you specify `*.c', that would visit all the files
1515 whose names match the pattern."
1520 (defcustom find-file-suppress-same-file-warnings nil
1521 "Non-nil means suppress warning messages for symlinked files.
1522 When nil, Emacs prints a warning when visiting a file that is already
1523 visited, but with a different name. Setting this option to t
1524 suppresses this warning."
1529 (defcustom large-file-warning-threshold 10000000
1530 "Maximum size of file above which a confirmation is requested.
1531 When nil, never request confirmation."
1535 :type '(choice integer (const :tag "Never request confirmation" nil)))
1537 (defun abort-if-file-too-large (size op-type)
1538 "If file SIZE larger than `large-file-warning-threshold', allow user to abort.
1539 OP-TYPE specifies the file operation being performed (for message to user)."
1540 (when (and large-file-warning-threshold size
1541 (> size large-file-warning-threshold)
1543 (format "File %s is large (%dMB), really %s? "
1544 (file-name-nondirectory filename)
1545 (/ size 1048576) op-type))))
1548 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1549 "Read file FILENAME into a buffer and return the buffer.
1550 If a buffer exists visiting FILENAME, return that one, but
1551 verify that the file has not changed since visited or saved.
1552 The buffer is not selected, just returned to the caller.
1553 Optional second arg NOWARN non-nil means suppress any warning messages.
1554 Optional third arg RAWFILE non-nil means the file is read literally.
1555 Optional fourth arg WILDCARDS non-nil means do wildcard processing
1556 and visit all the matching files. When wildcards are actually
1557 used and expanded, return a list of buffers that are visiting
1560 (abbreviate-file-name
1561 (expand-file-name filename)))
1562 (if (file-directory-p filename)
1563 (or (and find-file-run-dired
1564 (run-hook-with-args-until-success
1565 'find-directory-functions
1566 (if find-file-visit-truename
1567 (abbreviate-file-name (file-truename filename))
1569 (error "%s is a directory" filename))
1572 (not (string-match "\\`/:" filename))
1573 (string-match "[[*?]" filename))
1574 (let ((files (condition-case nil
1575 (file-expand-wildcards filename t)
1576 (error (list filename))))
1577 (find-file-wildcards nil))
1579 (find-file-noselect filename)
1580 (mapcar #'find-file-noselect files)))
1581 (let* ((buf (get-file-buffer filename))
1582 (truename (abbreviate-file-name (file-truename filename)))
1583 (attributes (file-attributes truename))
1584 (number (nthcdr 10 attributes))
1585 ;; Find any buffer for a file which has same truename.
1586 (other (and (not buf) (find-buffer-visiting filename))))
1587 ;; Let user know if there is a buffer with the same truename.
1591 find-file-suppress-same-file-warnings
1592 (string-equal filename (buffer-file-name other))
1593 (message "%s and %s are the same file"
1594 filename (buffer-file-name other)))
1595 ;; Optionally also find that buffer.
1596 (if (or find-file-existing-other-name find-file-visit-truename)
1598 ;; Check to see if the file looks uncommonly large.
1599 (when (not (or buf nowarn))
1600 (abort-if-file-too-large (nth 7 attributes) "open"))
1602 ;; We are using an existing buffer.
1605 (verify-visited-file-modtime buf)
1606 (cond ((not (file-exists-p filename))
1607 (setq nonexistent t)
1608 (message "File %s no longer exists!" filename))
1609 ;; Certain files should be reverted automatically
1610 ;; if they have changed on disk and not in the buffer.
1611 ((and (not (buffer-modified-p buf))
1612 (let ((tail revert-without-query)
1615 (if (string-match (car tail) filename)
1617 (setq tail (cdr tail)))
1619 (with-current-buffer buf
1620 (message "Reverting file %s..." filename)
1622 (message "Reverting file %s...done" filename)))
1624 (if (string= (file-name-nondirectory filename)
1627 (if (buffer-modified-p buf)
1628 "File %s changed on disk. Discard your edits? "
1629 "File %s changed on disk. Reread from disk? ")
1630 (file-name-nondirectory filename))
1632 (if (buffer-modified-p buf)
1633 "File %s changed on disk. Discard your edits in %s? "
1634 "File %s changed on disk. Reread from disk into %s? ")
1635 (file-name-nondirectory filename)
1636 (buffer-name buf))))
1637 (with-current-buffer buf
1638 (revert-buffer t t)))))
1639 (with-current-buffer buf
1641 ;; Check if a formerly read-only file has become
1642 ;; writable and vice versa, but if the buffer agrees
1643 ;; with the new state of the file, that is ok too.
1644 (let ((read-only (not (file-writable-p buffer-file-name))))
1645 (unless (or nonexistent
1646 (eq read-only buffer-file-read-only)
1647 (eq read-only buffer-read-only))
1650 (format "File %s is %s on disk. Change buffer mode? "
1652 (if read-only "read-only" "writable"))))
1653 (y-or-n-p question)))
1654 (setq buffer-read-only read-only)))
1655 (setq buffer-file-read-only read-only))
1657 (when (and (not (eq (not (null rawfile))
1658 (not (null find-file-literally))))
1660 ;; It is confusing to ask whether to visit
1661 ;; non-literally if they have the file in
1663 (not (eq major-mode 'hexl-mode)))
1664 (if (buffer-modified-p)
1668 "The file %s is already visited normally,
1669 and you have edited the buffer. Now you have asked to visit it literally,
1670 meaning no coding system handling, format conversion, or local variables.
1671 Emacs can only visit a file in one way at a time.
1673 Do you want to save the file, and visit it literally instead? "
1674 "The file %s is already visited literally,
1675 meaning no coding system handling, format conversion, or local variables.
1676 You have edited the buffer. Now you have asked to visit the file normally,
1677 but Emacs can only visit a file in one way at a time.
1679 Do you want to save the file, and visit it normally instead? ")
1680 (file-name-nondirectory filename)))
1683 (find-file-noselect-1 buf filename nowarn
1684 rawfile truename number))
1689 Do you want to discard your changes, and visit the file literally now? "
1691 Do you want to discard your changes, and visit the file normally now? ")))
1692 (find-file-noselect-1 buf filename nowarn
1693 rawfile truename number)
1694 (error (if rawfile "File already visited non-literally"
1695 "File already visited literally"))))
1699 "The file %s is already visited normally.
1700 You have asked to visit it literally,
1701 meaning no coding system decoding, format conversion, or local variables.
1702 But Emacs can only visit a file in one way at a time.
1704 Do you want to revisit the file literally now? "
1705 "The file %s is already visited literally,
1706 meaning no coding system decoding, format conversion, or local variables.
1707 You have asked to visit it normally,
1708 but Emacs can only visit a file in one way at a time.
1710 Do you want to revisit the file normally now? ")
1711 (file-name-nondirectory filename)))
1712 (find-file-noselect-1 buf filename nowarn
1713 rawfile truename number)
1714 (error (if rawfile "File already visited non-literally"
1715 "File already visited literally"))))))
1716 ;; Return the buffer we are using.
1718 ;; Create a new buffer.
1719 (setq buf (create-file-buffer filename))
1720 ;; find-file-noselect-1 may use a different buffer.
1721 (find-file-noselect-1 buf filename nowarn
1722 rawfile truename number))))))
1724 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1726 (with-current-buffer buf
1727 (kill-local-variable 'find-file-literally)
1728 ;; Needed in case we are re-visiting the file with a different
1729 ;; text representation.
1730 (kill-local-variable 'buffer-file-coding-system)
1731 (kill-local-variable 'cursor-type)
1732 (let ((inhibit-read-only t))
1734 (and (default-value 'enable-multibyte-characters)
1736 (set-buffer-multibyte t))
1739 (let ((inhibit-read-only t))
1740 (insert-file-contents-literally filename t))
1742 (when (and (file-exists-p filename)
1743 (not (file-readable-p filename)))
1745 (signal 'file-error (list "File is not readable"
1747 ;; Unconditionally set error
1750 (let ((inhibit-read-only t))
1751 (insert-file-contents filename t))
1753 (when (and (file-exists-p filename)
1754 (not (file-readable-p filename)))
1756 (signal 'file-error (list "File is not readable"
1758 ;; Run find-file-not-found-functions until one returns non-nil.
1759 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1760 ;; If they fail too, set error.
1762 ;; Record the file's truename, and maybe use that as visited name.
1763 (if (equal filename buffer-file-name)
1764 (setq buffer-file-truename truename)
1765 (setq buffer-file-truename
1766 (abbreviate-file-name (file-truename buffer-file-name))))
1767 (setq buffer-file-number number)
1768 ;; On VMS, we may want to remember which directory in a search list
1769 ;; the file was found in.
1770 (and (eq system-type 'vax-vms)
1772 (if (string-match ":" (file-name-directory filename))
1773 (setq logical (substring (file-name-directory filename)
1774 0 (match-beginning 0))))
1775 (not (member logical find-file-not-true-dirname-list)))
1776 (setq buffer-file-name buffer-file-truename))
1777 (if find-file-visit-truename
1778 (setq buffer-file-name (expand-file-name buffer-file-truename)))
1779 ;; Set buffer's default directory to that of the file.
1780 (setq default-directory (file-name-directory buffer-file-name))
1781 ;; Turn off backup files for certain file names. Since
1782 ;; this is a permanent local, the major mode won't eliminate it.
1783 (and backup-enable-predicate
1784 (not (funcall backup-enable-predicate buffer-file-name))
1786 (make-local-variable 'backup-inhibited)
1787 (setq backup-inhibited t)))
1790 (set-buffer-multibyte nil)
1791 (setq buffer-file-coding-system 'no-conversion)
1792 (set-buffer-major-mode buf)
1793 (make-local-variable 'find-file-literally)
1794 (setq find-file-literally t))
1795 (after-find-file error (not nowarn)))
1798 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1799 "Like `insert-file-contents', but only reads in the file literally.
1800 A buffer may be modified in several ways after reading into the buffer,
1801 to Emacs features such as format decoding, character code
1802 conversion, `find-file-hook', automatic uncompression, etc.
1804 This function ensures that none of these modifications will take place."
1805 (let ((format-alist nil)
1806 (after-insert-file-functions nil)
1807 (coding-system-for-read 'no-conversion)
1808 (coding-system-for-write 'no-conversion)
1809 (find-buffer-file-type-function
1810 (if (fboundp 'find-buffer-file-type)
1811 (symbol-function 'find-buffer-file-type)
1813 (inhibit-file-name-handlers
1814 (append '(jka-compr-handler image-file-handler epa-file-handler)
1815 inhibit-file-name-handlers))
1816 (inhibit-file-name-operation 'insert-file-contents))
1819 (fset 'find-buffer-file-type (lambda (filename) t))
1820 (insert-file-contents filename visit beg end replace))
1821 (if find-buffer-file-type-function
1822 (fset 'find-buffer-file-type find-buffer-file-type-function)
1823 (fmakunbound 'find-buffer-file-type)))))
1825 (defun insert-file-1 (filename insert-func)
1826 (if (file-directory-p filename)
1827 (signal 'file-error (list "Opening input file" "file is a directory"
1829 ;; Check whether the file is uncommonly large
1830 (abort-if-file-too-large (nth 7 (file-attributes filename)) "insert")
1831 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1832 #'buffer-modified-p))
1833 (tem (funcall insert-func filename)))
1834 (push-mark (+ (point) (car (cdr tem))))
1836 (message "File %s already visited and modified in buffer %s"
1837 filename (buffer-name buffer)))))
1839 (defun insert-file-literally (filename)
1840 "Insert contents of file FILENAME into buffer after point with no conversion.
1842 This function is meant for the user to run interactively.
1843 Don't call it from programs! Use `insert-file-contents-literally' instead.
1844 \(Its calling sequence is different; see its documentation)."
1845 (interactive "*fInsert file literally: ")
1846 (insert-file-1 filename #'insert-file-contents-literally))
1848 (defvar find-file-literally nil
1849 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1850 This is a permanent local.")
1851 (put 'find-file-literally 'permanent-local t)
1853 (defun find-file-literally (filename)
1854 "Visit file FILENAME with no conversion of any kind.
1855 Format conversion and character code conversion are both disabled,
1856 and multibyte characters are disabled in the resulting buffer.
1857 The major mode used is Fundamental mode regardless of the file name,
1858 and local variable specifications in the file are ignored.
1859 Automatic uncompression and adding a newline at the end of the
1860 file due to `require-final-newline' is also disabled.
1862 You cannot absolutely rely on this function to result in
1863 visiting the file literally. If Emacs already has a buffer
1864 which is visiting the file, you get the existing buffer,
1865 regardless of whether it was created literally or not.
1867 In a Lisp program, if you want to be sure of accessing a file's
1868 contents literally, you should create a temporary buffer and then read
1869 the file contents into it using `insert-file-contents-literally'."
1870 (interactive "FFind file literally: ")
1871 (switch-to-buffer (find-file-noselect filename nil t)))
1873 (defvar after-find-file-from-revert-buffer nil)
1875 (defun after-find-file (&optional error warn noauto
1876 after-find-file-from-revert-buffer
1878 "Called after finding a file and by the default revert function.
1879 Sets buffer mode, parses local variables.
1880 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1881 error in reading the file. WARN non-nil means warn if there
1882 exists an auto-save file more recent than the visited file.
1883 NOAUTO means don't mess with auto-save mode.
1884 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1885 means this call was from `revert-buffer'.
1886 Fifth arg NOMODES non-nil means don't alter the file's modes.
1887 Finishes by calling the functions in `find-file-hook'
1888 unless NOMODES is non-nil."
1889 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1896 ((and error (file-attributes buffer-file-name))
1897 (setq buffer-read-only t)
1898 "File exists, but cannot be read")
1899 ((not buffer-read-only)
1901 ;; No need to warn if buffer is auto-saved
1902 ;; under the name of the visited file.
1903 (not (and buffer-file-name
1904 auto-save-visited-file-name))
1905 (file-newer-than-file-p (or buffer-auto-save-file-name
1906 (make-auto-save-file-name))
1908 (format "%s has auto save data; consider M-x recover-this-file"
1909 (file-name-nondirectory buffer-file-name))
1910 (setq not-serious t)
1911 (if error "(New file)" nil)))
1913 (setq not-serious t)
1914 "Note: file is write protected")
1915 ((file-attributes (directory-file-name default-directory))
1916 "File not found and directory write-protected")
1917 ((file-exists-p (file-name-directory buffer-file-name))
1918 (setq buffer-read-only nil))
1920 (setq buffer-read-only nil)
1921 "Use M-x make-directory RET RET to create the directory and its parents"))))
1924 (or not-serious (sit-for 1 t))))
1925 (when (and auto-save-default (not noauto))
1926 (auto-save-mode t)))
1927 ;; Make people do a little extra work (C-x C-q)
1928 ;; before altering a backup file.
1929 (when (backup-file-name-p buffer-file-name)
1930 (setq buffer-read-only t))
1931 ;; When a file is marked read-only,
1932 ;; make the buffer read-only even if root is looking at it.
1933 (when (and (file-modes (buffer-file-name))
1934 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1935 (setq buffer-read-only t))
1937 (when (and view-read-only view-mode)
1938 (view-mode-disable))
1940 ;; If requested, add a newline at the end of the file.
1941 (and (memq require-final-newline '(visit visit-save))
1942 (> (point-max) (point-min))
1943 (/= (char-after (1- (point-max))) ?\n)
1944 (not (and (eq selective-display t)
1945 (= (char-after (1- (point-max))) ?\r)))
1947 (goto-char (point-max))
1949 (when (and buffer-read-only
1951 (not (eq (get major-mode 'mode-class) 'special)))
1953 (run-hooks 'find-file-hook)))
1955 (defmacro report-errors (format &rest body)
1956 "Eval BODY and turn any error into a FORMAT message.
1957 FORMAT can have a %s escape which will be replaced with the actual error.
1958 If `debug-on-error' is set, errors are not caught, so that you can
1960 Avoid using a large BODY since it is duplicated."
1961 (declare (debug t) (indent 1))
1966 (error (message ,format (prin1-to-string err))))))
1968 (defun normal-mode (&optional find-file)
1969 "Choose the major mode for this buffer automatically.
1970 Also sets up any specified local variables of the file.
1971 Uses the visited file name, the -*- line, and the local variables spec.
1973 This function is called automatically from `find-file'. In that case,
1974 we may set up the file-specified mode and local variables,
1975 depending on the value of `enable-local-variables'.
1976 In addition, if `local-enable-local-variables' is nil, we do
1977 not set local variables (though we do notice a mode specified with -*-.)
1979 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1980 or from Lisp without specifying the optional argument FIND-FILE;
1981 in that case, this function acts as if `enable-local-variables' were t."
1983 (funcall (or default-major-mode 'fundamental-mode))
1984 (let ((enable-local-variables (or (not find-file) enable-local-variables)))
1985 (report-errors "File mode specification error: %s"
1987 (report-errors "Project local-variables error: %s"
1988 (hack-project-variables))
1989 (report-errors "File local-variables error: %s"
1990 (hack-local-variables)))
1991 ;; Turn font lock off and on, to make sure it takes account of
1992 ;; whatever file local variables are relevant to it.
1993 (when (and font-lock-mode
1994 ;; Font-lock-mode (now in font-core.el) can be ON when
1995 ;; font-lock.el still hasn't been loaded.
1996 (boundp 'font-lock-keywords)
1997 (eq (car font-lock-keywords) t))
1998 (setq font-lock-keywords (cadr font-lock-keywords))
2001 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
2002 (ucs-set-table-for-input)))
2004 (defcustom auto-mode-case-fold nil
2005 "Non-nil means to try second pass through `auto-mode-alist'.
2006 This means that if the first case-sensitive search through the alist fails
2007 to find a matching major mode, a second case-insensitive search is made.
2008 On systems with case-insensitive file names, this variable is ignored,
2009 since only a single case-insensitive search through the alist is made."
2014 (defvar auto-mode-alist
2015 ;; Note: The entries for the modes defined in cc-mode.el (c-mode,
2016 ;; c++-mode, java-mode and more) are added through autoload
2017 ;; directives in that file. That way is discouraged since it
2018 ;; spreads out the definition of the initial value.
2021 (cons (purecopy (car elt)) (cdr elt)))
2022 `(;; do this first, so that .html.pl is Polish html, not Perl
2023 ("\\.s?html?\\(\\.[a-zA-Z_]+\\)?\\'" . html-mode)
2024 ("\\.te?xt\\'" . text-mode)
2025 ("\\.[tT]e[xX]\\'" . tex-mode)
2026 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
2027 ("\\.ltx\\'" . latex-mode)
2028 ("\\.dtx\\'" . doctex-mode)
2029 ("\\.org\\'" . org-mode)
2030 ("\\.el\\'" . emacs-lisp-mode)
2031 ("\\.\\(scm\\|stk\\|ss\\|sch\\)\\'" . scheme-mode)
2032 ("\\.l\\'" . lisp-mode)
2033 ("\\.li?sp\\'" . lisp-mode)
2034 ("\\.[fF]\\'" . fortran-mode)
2035 ("\\.for\\'" . fortran-mode)
2036 ("\\.p\\'" . pascal-mode)
2037 ("\\.pas\\'" . pascal-mode)
2038 ("\\.ad[abs]\\'" . ada-mode)
2039 ("\\.ad[bs].dg\\'" . ada-mode)
2040 ("\\.\\([pP]\\([Llm]\\|erl\\|od\\)\\|al\\)\\'" . perl-mode)
2041 ("Imakefile\\'" . makefile-imake-mode)
2042 ("Makeppfile\\(?:\\.mk\\)?\\'" . makefile-makepp-mode) ; Put this before .mk
2043 ("\\.makepp\\'" . makefile-makepp-mode)
2044 ,@(if (memq system-type '(berkeley-unix next-mach darwin))
2045 '(("\\.mk\\'" . makefile-bsdmake-mode)
2046 ("GNUmakefile\\'" . makefile-gmake-mode)
2047 ("[Mm]akefile\\'" . makefile-bsdmake-mode))
2048 '(("\\.mk\\'" . makefile-gmake-mode) ; Might be any make, give Gnu the host advantage
2049 ("[Mm]akefile\\'" . makefile-gmake-mode)))
2050 ("\\.am\\'" . makefile-automake-mode)
2051 ;; Less common extensions come here
2052 ;; so more common ones above are found faster.
2053 ("\\.texinfo\\'" . texinfo-mode)
2054 ("\\.te?xi\\'" . texinfo-mode)
2055 ("\\.[sS]\\'" . asm-mode)
2056 ("\\.asm\\'" . asm-mode)
2057 ("[cC]hange\\.?[lL]og?\\'" . change-log-mode)
2058 ("[cC]hange[lL]og[-.][0-9]+\\'" . change-log-mode)
2059 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
2060 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
2061 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
2062 ("\\.bash\\'" . sh-mode)
2063 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
2064 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
2065 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
2066 ("\\.m?spec\\'" . sh-mode)
2067 ("\\.m[mes]\\'" . nroff-mode)
2068 ("\\.man\\'" . nroff-mode)
2069 ("\\.sty\\'" . latex-mode)
2070 ("\\.cl[so]\\'" . latex-mode) ;LaTeX 2e class option
2071 ("\\.bbl\\'" . latex-mode)
2072 ("\\.bib\\'" . bibtex-mode)
2073 ("\\.sql\\'" . sql-mode)
2074 ("\\.m[4c]\\'" . m4-mode)
2075 ("\\.mf\\'" . metafont-mode)
2076 ("\\.mp\\'" . metapost-mode)
2077 ("\\.vhdl?\\'" . vhdl-mode)
2078 ("\\.article\\'" . text-mode)
2079 ("\\.letter\\'" . text-mode)
2080 ("\\.i?tcl\\'" . tcl-mode)
2081 ("\\.exp\\'" . tcl-mode)
2082 ("\\.itk\\'" . tcl-mode)
2083 ("\\.icn\\'" . icon-mode)
2084 ("\\.sim\\'" . simula-mode)
2085 ("\\.mss\\'" . scribe-mode)
2086 ("\\.f9[05]\\'" . f90-mode)
2087 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
2088 ("\\.pro\\'" . idlwave-mode)
2089 ("\\.prolog\\'" . prolog-mode)
2090 ("\\.tar\\'" . tar-mode)
2091 ;; The list of archive file extensions should be in sync with
2092 ;; `auto-coding-alist' with `no-conversion' coding system.
2094 arc\\|zip\\|lzh\\|lha\\|zoo\\|[jew]ar\\|xpi\\|rar\\|\
2095 ARC\\|ZIP\\|LZH\\|LHA\\|ZOO\\|[JEW]AR\\|XPI\\|RAR\\)\\'" . archive-mode)
2096 ("\\.\\(sx[dmicw]\\|odt\\)\\'" . archive-mode) ; OpenOffice.org
2097 ("\\.\\(deb\\)\\'" . archive-mode) ; Debian packages.
2098 ;; Mailer puts message to be edited in
2099 ;; /tmp/Re.... or Message
2100 ("\\`/tmp/Re" . text-mode)
2101 ("/Message[0-9]*\\'" . text-mode)
2102 ("\\.zone\\'" . zone-mode)
2103 ;; some news reader is reported to use this
2104 ("\\`/tmp/fol/" . text-mode)
2105 ("\\.oak\\'" . scheme-mode)
2106 ("\\.sgml?\\'" . sgml-mode)
2107 ("\\.x[ms]l\\'" . xml-mode)
2108 ("\\.dtd\\'" . sgml-mode)
2109 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
2110 ("\\.js\\'" . java-mode) ; javascript-mode would be better
2111 ("\\.d?v\\'" . verilog-mode)
2112 ;; .emacs or .gnus or .viper following a directory delimiter in
2113 ;; Unix, MSDOG or VMS syntax.
2114 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
2115 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
2116 ;; _emacs following a directory delimiter
2118 ("[:/]_emacs\\'" . emacs-lisp-mode)
2119 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
2120 ("\\.ml\\'" . lisp-mode)
2121 ;; Common Lisp ASDF package system.
2122 ("\\.asd\\'" . lisp-mode)
2123 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
2124 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
2125 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
2126 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
2127 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
2128 ("\\.\\(?:PDF\\|DVI\\|pdf\\|dvi\\)\\'" . doc-view-mode)
2129 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
2130 ("BROWSE\\'" . ebrowse-tree-mode)
2131 ("\\.ebrowse\\'" . ebrowse-tree-mode)
2132 ("#\\*mail\\*" . mail-mode)
2133 ("\\.g\\'" . antlr-mode)
2134 ("\\.ses\\'" . ses-mode)
2135 ("\\.\\(soa\\|zone\\)\\'" . dns-mode)
2136 ("\\.docbook\\'" . sgml-mode)
2137 ("\\.com\\'" . dcl-mode)
2138 ("/config\\.\\(?:bat\\|log\\)\\'" . fundamental-mode)
2139 ;; Windows candidates may be opened case sensitively on Unix
2140 ("\\.\\(?:[iI][nN][iI]\\|[lL][sS][tT]\\|[rR][eE][gG]\\|[sS][yY][sS]\\)\\'" . conf-mode)
2141 ("\\.\\(?:desktop\\|la\\)\\'" . conf-unix-mode)
2142 ("\\.ppd\\'" . conf-ppd-mode)
2143 ("java.+\\.conf\\'" . conf-javaprop-mode)
2144 ("\\.properties\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-javaprop-mode)
2145 ;; *.cf, *.cfg, *.conf, *.config[.local|.de_DE.UTF8|...], */config
2146 ("[/.]c\\(?:on\\)?f\\(?:i?g\\)?\\(?:\\.[a-zA-Z0-9._-]+\\)?\\'" . conf-mode-maybe)
2147 ("\\`/etc/\\(?:DIR_COLORS\\|ethers\\|.?fstab\\|.*hosts\\|lesskey\\|login\\.?de\\(?:fs\\|vperm\\)\\|magic\\|mtab\\|pam\\.d/.*\\|permissions\\(?:\\.d/.+\\)?\\|protocols\\|rpc\\|services\\)\\'" . conf-space-mode)
2148 ("\\`/etc/\\(?:acpid?/.+\\|aliases\\(?:\\.d/.+\\)?\\|default/.+\\|group-?\\|hosts\\..+\\|inittab\\|ksysguarddrc\\|opera6rc\\|passwd-?\\|shadow-?\\|sysconfig/.+\\)\\'" . conf-mode)
2149 ;; ChangeLog.old etc. Other change-log-mode entries are above;
2150 ;; this has lower priority to avoid matching changelog.sgml etc.
2151 ("[cC]hange[lL]og[-.][-0-9a-z]+\\'" . change-log-mode)
2152 ;; either user's dot-files or under /etc or some such
2153 ("/\\.?\\(?:gnokiirc\\|kde.*rc\\|mime\\.types\\|wgetrc\\)\\'" . conf-mode)
2154 ;; alas not all ~/.*rc files are like this
2155 ("/\\.\\(?:enigma\\|gltron\\|gtk\\|hxplayer\\|net\\|neverball\\|qt/.+\\|realplayer\\|scummvm\\|sversion\\|sylpheed/.+\\|xmp\\)rc\\'" . conf-mode)
2156 ("/\\.\\(?:gdbtkinit\\|grip\\|orbital/.+txt\\|rhosts\\|tuxracer/options\\)\\'" . conf-mode)
2157 ("/\\.?X\\(?:default\\|resource\\|re\\)s\\>" . conf-xdefaults-mode)
2158 ("/X11.+app-defaults/" . conf-xdefaults-mode)
2159 ("/X11.+locale/.+/Compose\\'" . conf-colon-mode)
2160 ;; this contains everything twice, with space and with colon :-(
2161 ("/X11.+locale/compose\\.dir\\'" . conf-javaprop-mode)
2162 ;; Get rid of any trailing .n.m and try again.
2163 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
2164 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
2165 ;; Using mode nil rather than `ignore' would let the search continue
2166 ;; through this list (with the shortened name) rather than start over.
2167 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" nil t)
2168 ;; The following should come after the ChangeLog pattern
2169 ;; for the sake of ChangeLog.1, etc.
2170 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
2171 ("\\.[1-9]\\'" . nroff-mode)
2172 ("\\.\\(?:orig\\|in\\|[bB][aA][kK]\\)\\'" nil t)))
2173 "Alist of filename patterns vs corresponding major mode functions.
2174 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
2175 \(NON-NIL stands for anything that is not nil; the value does not matter.)
2176 Visiting a file whose name matches REGEXP specifies FUNCTION as the
2177 mode function to use. FUNCTION will be called, unless it is nil.
2179 If the element has the form (REGEXP FUNCTION NON-NIL), then after
2180 calling FUNCTION (if it's not nil), we delete the suffix that matched
2181 REGEXP and search the list again for another match.
2183 If the file name matches `inhibit-first-line-modes-regexps',
2184 then `auto-mode-alist' is not processed.
2186 The extensions whose FUNCTION is `archive-mode' should also
2187 appear in `auto-coding-alist' with `no-conversion' coding system.
2189 See also `interpreter-mode-alist', which detects executable script modes
2190 based on the interpreters they specify to run,
2191 and `magic-mode-alist', which determines modes based on file contents.")
2193 (defun conf-mode-maybe ()
2194 "Select Conf mode or XML mode according to start of file."
2198 (goto-char (point-min))
2199 (looking-at "<\\?xml \\|<!-- \\|<!DOCTYPE ")))
2203 (defvar interpreter-mode-alist
2204 ;; Note: The entries for the modes defined in cc-mode.el (awk-mode
2205 ;; and pike-mode) are added through autoload directives in that
2206 ;; file. That way is discouraged since it spreads out the
2207 ;; definition of the initial value.
2210 (cons (purecopy (car l)) (cdr l)))
2211 '(("perl" . perl-mode)
2212 ("perl5" . perl-mode)
2213 ("miniperl" . perl-mode)
2215 ("wishx" . tcl-mode)
2217 ("tclsh" . tcl-mode)
2218 ("scm" . scheme-mode)
2238 ("tail" . text-mode)
2239 ("more" . text-mode)
2240 ("less" . text-mode)
2242 ("make" . makefile-gmake-mode) ; Debian uses this
2243 ("guile" . scheme-mode)
2244 ("clisp" . lisp-mode)))
2245 "Alist mapping interpreter names to major modes.
2246 This is used for files whose first lines match `auto-mode-interpreter-regexp'.
2247 Each element looks like (INTERPRETER . MODE).
2248 If INTERPRETER matches the name of the interpreter specified in the first line
2249 of a script, mode MODE is enabled.
2251 See also `auto-mode-alist'.")
2253 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
2254 "List of regexps; if one matches a file name, don't look for `-*-'.")
2256 (defvar inhibit-first-line-modes-suffixes nil
2257 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
2258 When checking `inhibit-first-line-modes-regexps', we first discard
2259 from the end of the file name anything that matches one of these regexps.")
2261 (defvar auto-mode-interpreter-regexp
2262 "#![ \t]?\\([^ \t\n]*\
2263 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
2264 "Regexp matching interpreters, for file mode determination.
2265 This regular expression is matched against the first line of a file
2266 to determine the file's mode in `set-auto-mode'. If it matches, the file
2267 is assumed to be interpreted by the interpreter matched by the second group
2268 of the regular expression. The mode is then determined as the mode
2269 associated with that interpreter in `interpreter-mode-alist'.")
2271 (defvar magic-mode-alist nil
2272 "Alist of buffer beginnings vs. corresponding major mode functions.
2273 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2274 After visiting a file, if REGEXP matches the text at the beginning of the
2275 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2276 call FUNCTION rather than allowing `auto-mode-alist' to decide the buffer's
2279 If FUNCTION is nil, then it is not called. (That is a way of saying
2280 \"allow `auto-mode-alist' to decide for these files.\")")
2281 (put 'magic-mode-alist 'risky-local-variable t)
2283 (defvar magic-fallback-mode-alist
2284 `((image-type-auto-detected-p . image-mode)
2285 ;; The < comes before the groups (but the first) to reduce backtracking.
2286 ;; TODO: UTF-16 <?xml may be preceded by a BOM 0xff 0xfe or 0xfe 0xff.
2287 ;; We use [ \t\r\n] instead of `\\s ' to make regex overflow less likely.
2288 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2289 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2290 (concat "\\(?:<\\?xml[ \t\r\n]+[^>]*>\\)?[ \t\r\n]*<"
2292 "\\(?:!DOCTYPE[ \t\r\n]+[^>]*>[ \t\r\n]*<[ \t\r\n]*" comment-re "*\\)?"
2293 "[Hh][Tt][Mm][Ll]"))
2295 ("<!DOCTYPE[ \t\r\n]+[Hh][Tt][Mm][Ll]" . html-mode)
2296 ;; These two must come after html, because they are more general:
2297 ("<\\?xml " . xml-mode)
2298 (,(let* ((incomment-re "\\(?:[^-]\\|-[^-]\\)")
2299 (comment-re (concat "\\(?:!--" incomment-re "*-->[ \t\r\n]*<\\)")))
2300 (concat "[ \t\r\n]*<" comment-re "*!DOCTYPE "))
2303 ("# xmcd " . conf-unix-mode))
2304 "Like `magic-mode-alist' but has lower priority than `auto-mode-alist'.
2305 Each element looks like (REGEXP . FUNCTION) or (MATCH-FUNCTION . FUNCTION).
2306 After visiting a file, if REGEXP matches the text at the beginning of the
2307 buffer, or calling MATCH-FUNCTION returns non-nil, `normal-mode' will
2308 call FUNCTION, provided that `magic-mode-alist' and `auto-mode-alist'
2309 have not specified a mode for this file.
2311 If FUNCTION is nil, then it is not called.")
2312 (put 'magic-fallback-mode-alist 'risky-local-variable t)
2314 (defvar magic-mode-regexp-match-limit 4000
2315 "Upper limit on `magic-mode-alist' regexp matches.
2316 Also applies to `magic-fallback-mode-alist'.")
2318 (defun set-auto-mode (&optional keep-mode-if-same)
2319 "Select major mode appropriate for current buffer.
2321 To find the right major mode, this function checks for a -*- mode tag,
2322 checks if it uses an interpreter listed in `interpreter-mode-alist',
2323 matches the buffer beginning against `magic-mode-alist',
2324 compares the filename against the entries in `auto-mode-alist',
2325 then matches the buffer beginning against `magic-fallback-mode-alist'.
2327 It does not check for the `mode:' local variable in the
2328 Local Variables section of the file; for that, use `hack-local-variables'.
2330 If `enable-local-variables' is nil, this function does not check for a
2333 If the optional argument KEEP-MODE-IF-SAME is non-nil, then we
2334 set the major mode only if that would change it. In other words
2335 we don't actually set it to the same mode the buffer already has."
2336 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
2337 (let (end done mode modes)
2338 ;; Find a -*- mode tag
2340 (goto-char (point-min))
2341 (skip-chars-forward " \t\n")
2342 (and enable-local-variables
2343 (setq end (set-auto-mode-1))
2344 (if (save-excursion (search-forward ":" end t))
2345 ;; Find all specifications for the `mode:' variable
2346 ;; and execute them left to right.
2347 (while (let ((case-fold-search t))
2348 (or (and (looking-at "mode:")
2349 (goto-char (match-end 0)))
2350 (re-search-forward "[ \t;]mode:" end t)))
2351 (skip-chars-forward " \t")
2352 (let ((beg (point)))
2353 (if (search-forward ";" end t)
2356 (skip-chars-backward " \t")
2357 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
2359 ;; Simple -*-MODE-*- case.
2360 (push (intern (concat (downcase (buffer-substring (point) end))
2363 ;; If we found modes to use, invoke them now, outside the save-excursion.
2366 (dolist (mode (nreverse modes))
2367 (if (not (functionp mode))
2368 (message "Ignoring unknown mode `%s'" mode)
2370 (or (set-auto-mode-0 mode keep-mode-if-same)
2371 ;; continuing would call minor modes again, toggling them off
2372 (throw 'nop nil))))))
2373 ;; If we didn't, look for an interpreter specified in the first line.
2374 ;; As a special case, allow for things like "#!/bin/env perl", which
2375 ;; finds the interpreter anywhere in $PATH.
2377 (setq mode (save-excursion
2378 (goto-char (point-min))
2379 (if (looking-at auto-mode-interpreter-regexp)
2382 ;; Map interpreter name to a mode, signalling we're done at the
2384 done (assoc (file-name-nondirectory mode)
2385 interpreter-mode-alist))
2386 ;; If we found an interpreter mode to use, invoke it now.
2388 (set-auto-mode-0 (cdr done) keep-mode-if-same)))
2389 ;; Next try matching the buffer beginning against magic-mode-alist.
2391 (if (setq done (save-excursion
2392 (goto-char (point-min))
2394 (narrow-to-region (point-min)
2396 (+ (point-min) magic-mode-regexp-match-limit)))
2397 (assoc-default nil magic-mode-alist
2401 (looking-at re)))))))
2402 (set-auto-mode-0 done keep-mode-if-same)))
2403 ;; Next compare the filename against the entries in auto-mode-alist.
2405 (if buffer-file-name
2406 (let ((name buffer-file-name)
2407 (remote-id (file-remote-p buffer-file-name)))
2408 ;; Remove remote file name identification.
2409 (when (and (stringp remote-id)
2410 (string-match (regexp-quote remote-id) name))
2411 (setq name (substring name (match-end 0))))
2412 ;; Remove backup-suffixes from file name.
2413 (setq name (file-name-sans-versions name))
2415 ;; Find first matching alist entry.
2417 (if (memq system-type '(vax-vms windows-nt cygwin))
2418 ;; System is case-insensitive.
2419 (let ((case-fold-search t))
2420 (assoc-default name auto-mode-alist
2422 ;; System is case-sensitive.
2424 ;; First match case-sensitively.
2425 (let ((case-fold-search nil))
2426 (assoc-default name auto-mode-alist
2428 ;; Fallback to case-insensitive match.
2429 (and auto-mode-case-fold
2430 (let ((case-fold-search t))
2431 (assoc-default name auto-mode-alist
2436 (setq mode (car mode)
2437 name (substring name 0 (match-beginning 0)))
2440 (set-auto-mode-0 mode keep-mode-if-same)
2442 ;; Next try matching the buffer beginning against magic-fallback-mode-alist.
2444 (if (setq done (save-excursion
2445 (goto-char (point-min))
2447 (narrow-to-region (point-min)
2449 (+ (point-min) magic-mode-regexp-match-limit)))
2450 (assoc-default nil magic-fallback-mode-alist
2454 (looking-at re)))))))
2455 (set-auto-mode-0 done keep-mode-if-same)))))
2457 ;; When `keep-mode-if-same' is set, we are working on behalf of
2458 ;; set-visited-file-name. In that case, if the major mode specified is the
2459 ;; same one we already have, don't actually reset it. We don't want to lose
2460 ;; minor modes such as Font Lock.
2461 (defun set-auto-mode-0 (mode &optional keep-mode-if-same)
2462 "Apply MODE and return it.
2463 If optional arg KEEP-MODE-IF-SAME is non-nil, MODE is chased of
2464 any aliases and compared to current major mode. If they are the
2465 same, do nothing and return nil."
2466 (unless (and keep-mode-if-same
2467 (eq (indirect-function mode)
2468 (indirect-function major-mode)))
2473 (defun set-auto-mode-1 ()
2474 "Find the -*- spec in the buffer.
2475 Call with point at the place to start searching from.
2476 If one is found, set point to the beginning
2477 and return the position of the end.
2478 Otherwise, return nil; point may be changed."
2481 ;; Don't look for -*- if this file name matches any
2482 ;; of the regexps in inhibit-first-line-modes-regexps.
2483 (let ((temp inhibit-first-line-modes-regexps)
2484 (name (if buffer-file-name
2485 (file-name-sans-versions buffer-file-name)
2487 (while (let ((sufs inhibit-first-line-modes-suffixes))
2488 (while (and sufs (not (string-match (car sufs) name)))
2489 (setq sufs (cdr sufs)))
2491 (setq name (substring name 0 (match-beginning 0))))
2493 (not (string-match (car temp) name)))
2494 (setq temp (cdr temp)))
2497 (search-forward "-*-" (line-end-position
2498 ;; If the file begins with "#!"
2499 ;; (exec interpreter magic), look
2500 ;; for mode frobs in the first two
2501 ;; lines. You cannot necessarily
2502 ;; put them in the first line of
2503 ;; such a file without screwing up
2504 ;; the interpreter invocation.
2505 ;; The same holds for
2507 ;; in man pages (preprocessor
2508 ;; magic for the `man' program).
2509 (and (looking-at "^\\(#!\\|'\\\\\"\\)") 2)) t)
2511 (skip-chars-forward " \t")
2513 (search-forward "-*-" (line-end-position) t))
2516 (skip-chars-backward " \t")
2521 ;;; Handling file local variables
2523 (defvar ignored-local-variables
2524 '(ignored-local-variables safe-local-variable-values)
2525 "Variables to be ignored in a file's local variable spec.")
2527 (defvar hack-local-variables-hook nil
2528 "Normal hook run after processing a file's local variables specs.
2529 Major modes can use this to examine user-specified local variables
2530 in order to initialize other data structure based on them.")
2532 (defcustom safe-local-variable-values nil
2533 "List variable-value pairs that are considered safe.
2534 Each element is a cons cell (VAR . VAL), where VAR is a variable
2535 symbol and VAL is a value that is considered safe."
2539 (defcustom safe-local-eval-forms '((add-hook 'write-file-hooks 'time-stamp))
2540 "Expressions that are considered safe in an `eval:' local variable.
2541 Add expressions to this list if you want Emacs to evaluate them, when
2542 they appear in an `eval' local variable specification, without first
2543 asking you for confirmation."
2546 :type '(repeat sexp))
2548 ;; Risky local variables:
2549 (mapc (lambda (var) (put var 'risky-local-variable t))
2552 buffer-auto-save-file-name
2554 buffer-file-truename
2556 dabbrev-case-fold-search
2557 dabbrev-case-replace
2559 default-text-properties
2562 enable-local-variables
2566 file-name-handler-alist
2573 ignored-local-variables
2575 imenu-generic-expression
2582 minor-mode-map-alist
2583 minor-mode-overriding-map-alist
2584 mode-line-buffer-identification
2595 overriding-local-map
2596 overriding-terminal-local-map
2599 rmail-output-file-alist
2600 safe-local-variable-values
2601 safe-local-eval-forms
2602 save-some-buffers-action-alist
2603 special-display-buffer-names
2606 unread-command-events
2609 ;; Safe local variables:
2611 ;; For variables defined by major modes, the safety declarations can go into
2612 ;; the major mode's file, since that will be loaded before file variables are
2615 ;; For variables defined by minor modes, put the safety declarations in the
2616 ;; file defining the minor mode after the defcustom/defvar using an autoload
2619 ;; ;;;###autoload(put 'variable 'safe-local-variable 'stringp)
2621 ;; Otherwise, when Emacs visits a file specifying that local variable, the
2622 ;; minor mode file may not be loaded yet.
2624 ;; For variables defined in the C source code the declaration should go here:
2626 (mapc (lambda (pair)
2627 (put (car pair) 'safe-local-variable (cdr pair)))
2628 '((buffer-read-only . booleanp) ;; C source code
2629 (default-directory . stringp) ;; C source code
2630 (fill-column . integerp) ;; C source code
2631 (indent-tabs-mode . booleanp) ;; C source code
2632 (left-margin . integerp) ;; C source code
2633 (no-update-autoloads . booleanp)
2634 (tab-width . integerp) ;; C source code
2635 (truncate-lines . booleanp))) ;; C source code
2637 (put 'c-set-style 'safe-local-eval-function t)
2639 (defun hack-local-variables-confirm (all-vars unsafe-vars risky-vars project)
2640 "Get confirmation before setting up local variable values.
2641 ALL-VARS is the list of all variables to be set up.
2642 UNSAFE-VARS is the list of those that aren't marked as safe or risky.
2643 RISKY-VARS is the list of those that are marked as risky.
2644 PROJECT is a directory name if these settings come from directory-local
2645 settings; nil otherwise."
2648 (let ((name (if buffer-file-name
2649 (file-name-nondirectory buffer-file-name)
2650 (concat "buffer " (buffer-name))))
2651 (offer-save (and (eq enable-local-variables t) unsafe-vars))
2653 (save-window-excursion
2654 (let ((buf (get-buffer-create "*Local Variables*")))
2656 (set (make-local-variable 'cursor-type) nil)
2659 (insert "The local variables list in " (or project name)
2660 "\ncontains values that may not be safe (*)"
2662 ", and variables that are risky (**)."
2665 (insert "The local variables list in " (or project name)
2666 "\ncontains variables that are risky (**).")
2667 (insert "A local variables list is specified in "
2668 (or project name) ".")))
2669 (insert "\n\nDo you want to apply it? You can type
2670 y -- to apply the local variables list.
2671 n -- to ignore the local variables list.")
2674 ! -- to apply the local variables list, and permanently mark these
2675 values (*) as safe (in the future, they will be set automatically.)\n\n")
2677 (dolist (elt all-vars)
2678 (cond ((member elt unsafe-vars)
2680 ((member elt risky-vars)
2684 (princ (car elt) buf)
2686 ;; Make strings with embedded whitespace easier to read.
2687 (let ((print-escape-newlines t))
2688 (prin1 (cdr elt) buf))
2691 (format "Please type %s%s: "
2692 (if offer-save "y, n, or !" "y or n")
2693 (if (< (line-number-at-pos) (window-body-height))
2695 ", or C-v to scroll")))
2696 (goto-char (point-min))
2697 (let ((cursor-in-echo-area t)
2698 (executing-kbd-macro executing-kbd-macro)
2700 (if offer-save '(?! ?y ?n ?\s ?\C-g) '(?y ?n ?\s ?\C-g)))
2703 (message "%s" prompt)
2704 (setq char (read-event))
2706 (cond ((eq char ?\C-v)
2709 (error (goto-char (point-min)))))
2710 ;; read-event returns -1 if we are in a kbd
2711 ;; macro and there are no more events in the
2712 ;; macro. In that case, attempt to get an
2713 ;; event interactively.
2714 ((and executing-kbd-macro (= char -1))
2715 (setq executing-kbd-macro nil))
2716 (t (setq done (memq (downcase char) exit-chars)))))))
2717 (setq char (downcase char))
2718 (when (and offer-save (= char ?!) unsafe-vars)
2719 (dolist (elt unsafe-vars)
2720 (add-to-list 'safe-local-variable-values elt))
2721 ;; When this is called from desktop-restore-file-buffer,
2722 ;; coding-system-for-read may be non-nil. Reset it before
2723 ;; writing to .emacs.
2724 (if (or custom-file user-init-file)
2725 (let ((coding-system-for-read nil))
2726 (customize-save-variable
2727 'safe-local-variable-values
2728 safe-local-variable-values))))
2734 (defun hack-local-variables-prop-line (&optional mode-only)
2735 "Return local variables specified in the -*- line.
2736 Ignore any specification for `mode:' and `coding:';
2737 `set-auto-mode' should already have handled `mode:',
2738 `set-auto-coding' should already have handled `coding:'.
2740 If MODE-ONLY is non-nil, all we do is check whether the major
2741 mode is specified, returning t if it is specified. Otherwise,
2742 return an alist of elements (VAR . VAL), where VAR is a variable
2743 and VAL is the specified value."
2745 (goto-char (point-min))
2746 (let ((end (set-auto-mode-1))
2747 result mode-specified)
2748 ;; Parse the -*- line into the RESULT alist.
2749 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
2752 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
2753 ;; Simple form: "-*- MODENAME -*-". Already handled.
2754 (setq mode-specified t)
2757 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
2758 ;; (last ";" is optional).
2759 (while (< (point) end)
2760 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
2761 (error "Malformed -*- line"))
2762 (goto-char (match-end 0))
2763 ;; There used to be a downcase here,
2764 ;; but the manual didn't say so,
2765 ;; and people want to set var names that aren't all lc.
2766 (let ((key (intern (match-string 1)))
2767 (val (save-restriction
2768 (narrow-to-region (point) end)
2769 (read (current-buffer)))))
2770 ;; It is traditional to ignore
2771 ;; case when checking for `mode' in set-auto-mode,
2772 ;; so we must do that here as well.
2773 ;; That is inconsistent, but we're stuck with it.
2774 ;; The same can be said for `coding' in set-auto-coding.
2775 (or (and (equal (downcase (symbol-name key)) "mode")
2776 (setq mode-specified t))
2777 (equal (downcase (symbol-name key)) "coding")
2779 (push (cons (if (eq key 'eval)
2781 (indirect-variable key))
2784 (skip-chars-forward " \t;")))))
2790 (defun hack-local-variables-apply (result project)
2791 "Apply an alist of local variable settings.
2792 RESULT is the alist.
2793 Will query the user when necessary."
2794 (dolist (ignored ignored-local-variables)
2795 (setq result (assq-delete-all ignored result)))
2796 (if (null enable-local-eval)
2797 (setq result (assq-delete-all 'eval result)))
2799 (setq result (nreverse result))
2800 ;; Find those variables that we may want to save to
2801 ;; `safe-local-variable-values'.
2802 (let (risky-vars unsafe-vars)
2803 (dolist (elt result)
2804 (let ((var (car elt))
2806 ;; Don't query about the fake variables.
2807 (or (memq var '(mode unibyte coding))
2809 (or (eq enable-local-eval t)
2810 (hack-one-local-variable-eval-safep
2811 (eval (quote val)))))
2812 (safe-local-variable-p var val)
2813 (and (risky-local-variable-p var val)
2814 (push elt risky-vars))
2815 (push elt unsafe-vars))))
2816 (if (eq enable-local-variables :safe)
2817 ;; If caller wants only the safe variables,
2818 ;; install only them.
2819 (dolist (elt result)
2820 (unless (or (member elt unsafe-vars)
2821 (member elt risky-vars))
2822 (hack-one-local-variable (car elt) (cdr elt))))
2823 ;; Query, except in the case where all are known safe
2824 ;; if the user wants no query in that case.
2825 (if (or (and (eq enable-local-variables t)
2828 (eq enable-local-variables :all)
2829 (hack-local-variables-confirm
2830 result unsafe-vars risky-vars project))
2831 (dolist (elt result)
2832 (hack-one-local-variable (car elt) (cdr elt))))))))
2834 (defun hack-local-variables (&optional mode-only)
2835 "Parse and put into effect this buffer's local variables spec.
2836 If MODE-ONLY is non-nil, all we do is check whether the major mode
2837 is specified, returning t if it is specified."
2838 (let ((enable-local-variables
2839 (and local-enable-local-variables enable-local-variables))
2841 (when (or mode-only enable-local-variables)
2842 (setq result (hack-local-variables-prop-line mode-only))
2843 ;; Look for "Local variables:" line in last page.
2845 (goto-char (point-max))
2846 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min))
2848 (when (let ((case-fold-search t))
2849 (search-forward "Local Variables:" nil t))
2850 (skip-chars-forward " \t")
2851 ;; suffix is what comes after "local variables:" in its line.
2852 ;; prefix is what comes before "local variables:" in its line.
2855 (regexp-quote (buffer-substring (point)
2856 (line-end-position)))
2859 (concat "^" (regexp-quote
2860 (buffer-substring (line-beginning-position)
2861 (match-beginning 0)))))
2865 (let ((startpos (point))
2867 (thisbuf (current-buffer)))
2869 (unless (let ((case-fold-search t))
2871 (concat prefix "[ \t]*End:[ \t]*" suffix)
2873 ;; This used to be an error, but really all it means is
2874 ;; that this may simply not be a local-variables section,
2875 ;; so just ignore it.
2876 (message "Local variables list is not properly terminated"))
2878 (setq endpos (point)))
2881 (insert-buffer-substring thisbuf startpos endpos)
2882 (goto-char (point-min))
2883 (subst-char-in-region (point) (point-max) ?\^m ?\n)
2885 ;; Discard the prefix.
2886 (if (looking-at prefix)
2887 (delete-region (point) (match-end 0))
2888 (error "Local variables entry is missing the prefix"))
2890 ;; Discard the suffix.
2891 (if (looking-back suffix)
2892 (delete-region (match-beginning 0) (point))
2893 (error "Local variables entry is missing the suffix"))
2895 (goto-char (point-min))
2898 ;; Find the variable name; strip whitespace.
2899 (skip-chars-forward " \t")
2901 (skip-chars-forward "^:\n")
2902 (if (eolp) (error "Missing colon in local variables entry"))
2903 (skip-chars-backward " \t")
2904 (let* ((str (buffer-substring beg (point)))
2907 ;; Read the variable value.
2908 (skip-chars-forward "^:")
2910 (setq val (read (current-buffer)))
2914 (unless (eq var 'coding)
2916 (push (cons (if (eq var 'eval)
2918 (indirect-variable var))
2921 (forward-line 1)))))))
2923 ;; We've read all the local variables. Now, return whether the
2924 ;; mode is specified (if MODE-ONLY is non-nil), or set the
2925 ;; variables (if MODE-ONLY is nil.)
2928 (hack-local-variables-apply result nil)
2929 (run-hooks 'hack-local-variables-hook)))))
2931 (defun safe-local-variable-p (sym val)
2932 "Non-nil if SYM is safe as a file-local variable with value VAL.
2933 It is safe if any of these conditions are met:
2935 * There is a matching entry (SYM . VAL) in the
2936 `safe-local-variable-values' user option.
2938 * The `safe-local-variable' property of SYM is a function that
2939 evaluates to a non-nil value with VAL as an argument."
2940 (or (member (cons sym val) safe-local-variable-values)
2941 (let ((safep (get sym 'safe-local-variable)))
2942 (and (functionp safep) (funcall safep val)))))
2944 (defun risky-local-variable-p (sym &optional ignored)
2945 "Non-nil if SYM could be dangerous as a file-local variable.
2946 It is dangerous if either of these conditions are met:
2948 * Its `risky-local-variable' property is non-nil.
2950 * Its name ends with \"hook(s)\", \"function(s)\", \"form(s)\", \"map\",
2951 \"program\", \"command(s)\", \"predicate(s)\", \"frame-alist\",
2952 \"mode-alist\", \"font-lock-(syntactic-)keyword*\",
2953 \"map-alist\", or \"bindat-spec\"."
2954 ;; If this is an alias, check the base name.
2956 (setq sym (indirect-variable sym))
2958 (or (get sym 'risky-local-variable)
2959 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|\
2960 -commands?$\\|-predicates?$\\|font-lock-keywords$\\|font-lock-keywords\
2961 -[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|\
2962 -map$\\|-map-alist$\\|-bindat-spec$" (symbol-name sym))))
2964 (defun hack-one-local-variable-quotep (exp)
2965 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2967 (defun hack-one-local-variable-constantp (exp)
2968 (or (and (not (symbolp exp)) (not (consp exp)))
2971 (hack-one-local-variable-quotep exp)))
2973 (defun hack-one-local-variable-eval-safep (exp)
2974 "Return t if it is safe to eval EXP when it is found in a file."
2975 (or (not (consp exp))
2976 ;; Detect certain `put' expressions.
2977 (and (eq (car exp) 'put)
2978 (hack-one-local-variable-quotep (nth 1 exp))
2979 (hack-one-local-variable-quotep (nth 2 exp))
2980 (let ((prop (nth 1 (nth 2 exp))) (val (nth 3 exp)))
2981 (cond ((eq prop 'lisp-indent-hook)
2982 ;; Only allow safe values of lisp-indent-hook;
2984 (or (numberp val) (equal val ''defun)))
2985 ((eq prop 'edebug-form-spec)
2986 ;; Only allow indirect form specs.
2987 ;; During bootstrapping, edebug-basic-spec might not be
2989 (and (fboundp 'edebug-basic-spec)
2990 (hack-one-local-variable-quotep val)
2991 (edebug-basic-spec (nth 1 val)))))))
2992 ;; Allow expressions that the user requested.
2993 (member exp safe-local-eval-forms)
2994 ;; Certain functions can be allowed with safe arguments
2995 ;; or can specify verification functions to try.
2996 (and (symbolp (car exp))
2997 (let ((prop (get (car exp) 'safe-local-eval-function)))
3000 (dolist (arg (cdr exp))
3001 (unless (hack-one-local-variable-constantp arg)
3008 (dolist (function prop)
3009 (if (funcall function exp)
3013 (defun hack-one-local-variable (var val)
3014 "Set local variable VAR with value VAL.
3015 If VAR is `mode', call `VAL-mode' as a function unless it's
3016 already the major mode."
3017 (cond ((eq var 'mode)
3018 (let ((mode (intern (concat (downcase (symbol-name val))
3020 (unless (eq (indirect-function mode)
3021 (indirect-function major-mode))
3024 (save-excursion (eval val)))
3026 ;; Make sure the string has no text properties.
3027 ;; Some text properties can get evaluated in various ways,
3028 ;; so it is risky to put them on with a local variable list.
3030 (set-text-properties 0 (length val) nil val))
3031 (set (make-local-variable var) val))))
3033 ;;; Handling directory local variables, aka project settings.
3035 (defvar project-class-alist '()
3036 "Alist mapping project class names (symbols) to project variable lists.")
3038 (defvar project-directory-alist '()
3039 "Alist mapping project directory roots to project classes.")
3041 (defsubst project-get-alist (class)
3042 "Return the project variable list for project CLASS."
3043 (cdr (assq class project-class-alist)))
3045 (defun project-collect-bindings-from-alist (mode-alist settings)
3046 "Collect local variable settings from MODE-ALIST.
3047 SETTINGS is the initial list of bindings.
3048 Returns the new list."
3049 (dolist (pair mode-alist settings)
3050 (let* ((variable (car pair))
3052 (slot (assq variable settings)))
3055 ;; Need a new cons in case we setcdr later.
3056 (push (cons variable value) settings)))))
3058 (defun project-collect-binding-list (binding-list root settings)
3059 "Collect entries from BINDING-LIST into SETTINGS.
3060 ROOT is the root directory of the project.
3061 Return the new settings list."
3062 (let* ((file-name (buffer-file-name))
3063 (sub-file-name (if file-name
3064 (substring file-name (length root)))))
3065 (dolist (entry binding-list settings)
3066 (let ((key (car entry)))
3069 ;; Don't include this in the previous condition, because we
3070 ;; want to filter all strings before the next condition.
3071 (when (and sub-file-name
3072 (>= (length sub-file-name) (length key))
3073 (string= key (substring sub-file-name 0 (length key))))
3074 (setq settings (project-collect-binding-list (cdr entry)
3077 (derived-mode-p key))
3078 (setq settings (project-collect-bindings-from-alist (cdr entry)
3081 (defun set-directory-project (directory class)
3082 "Declare that the project rooted at DIRECTORY is an instance of CLASS.
3083 DIRECTORY is the name of a directory, a string.
3084 CLASS is the name of a project class, a symbol.
3086 When a file beneath DIRECTORY is visited, the mode-specific
3087 settings from CLASS will be applied to the buffer. The settings
3088 for a class are defined using `define-project-bindings'."
3089 (setq directory (file-name-as-directory (expand-file-name directory)))
3090 (unless (assq class project-class-alist)
3091 (error "No such project class `%s'" (symbol-name class)))
3092 (push (cons directory class) project-directory-alist))
3094 (defun define-project-bindings (class list)
3095 "Map the project type CLASS to a list of variable settings.
3096 CLASS is the project class, a symbol.
3097 LIST is a list that declares variable settings for the class.
3098 An element in LIST is either of the form:
3099 (MAJOR-MODE . ALIST)
3103 In the first form, MAJOR-MODE is a symbol, and ALIST is an alist
3104 whose elements are of the form (VARIABLE . VALUE).
3106 In the second form, DIRECTORY is a directory name (a string), and
3107 LIST is a list of the form accepted by the function.
3109 When a file is visited, the file's class is found. A directory
3110 may be assigned a class using `set-directory-project'. Then
3111 variables are set in the file's buffer according to the class'
3112 LIST. The list is processed in order.
3114 * If the element is of the form (MAJOR-MODE . ALIST), and the
3115 buffer's major mode is derived from MAJOR-MODE (as determined
3116 by `derived-mode-p'), then all the settings in ALIST are
3117 applied. A MAJOR-MODE of nil may be used to match any buffer.
3118 `make-local-variable' is called for each variable before it is
3121 * If the element is of the form (DIRECTORY . LIST), and DIRECTORY
3122 is an initial substring of the file's directory, then LIST is
3123 applied by recursively following these rules."
3124 (let ((elt (assq class project-class-alist)))
3127 (push (cons class list) project-class-alist))))
3129 (defun project-find-settings-file (file)
3130 "Find the settings file for FILE.
3131 This searches upward in the directory tree.
3132 If a settings file is found, the file name is returned.
3133 If the file is in a registered project, a cons from
3134 `project-directory-alist' is returned.
3135 Otherwise this returns nil."
3136 (setq file (expand-file-name file))
3137 (let* ((settings (locate-dominating-file file "\\`\\.dir-settings\\.el\\'"))
3139 ;; `locate-dominating-file' may have abbreviated the name.
3140 (if settings (setq settings (expand-file-name settings)))
3141 (dolist (x project-directory-alist)
3142 (when (and (eq t (compare-strings file nil (length (car x))
3144 (> (length (car x)) (length (car pda))))
3146 (if (and settings pda)
3147 (if (> (length (file-name-directory settings))
3150 (or settings pda))))
3152 (defun project-define-from-project-file (settings-file)
3153 "Load a settings file and register a new project class and instance.
3154 SETTINGS-FILE is the name of the file holding the settings to apply.
3155 The new class name is the same as the directory in which SETTINGS-FILE
3156 is found. Returns the new class name."
3158 ;; We should probably store the modtime of SETTINGS-FILE and then
3159 ;; reload it whenever it changes.
3160 (insert-file-contents settings-file)
3161 (let* ((dir-name (file-name-directory settings-file))
3162 (class-name (intern dir-name))
3163 (list (read (current-buffer))))
3164 (define-project-bindings class-name list)
3165 (set-directory-project dir-name class-name)
3168 (declare-function c-postprocess-file-styles "cc-mode" ())
3170 (defun hack-project-variables ()
3171 "Set local variables in a buffer based on project settings."
3172 (when (and (buffer-file-name) (not (file-remote-p (buffer-file-name))))
3173 ;; Find the settings file.
3174 (let ((settings (project-find-settings-file (buffer-file-name)))
3179 (setq root-dir (file-name-directory (buffer-file-name)))
3180 (setq class (project-define-from-project-file settings)))
3182 (setq root-dir (car settings))
3183 (setq class (cdr settings))))
3186 (project-collect-binding-list (project-get-alist class)
3189 (hack-local-variables-apply bindings root-dir)
3190 ;; Special case C and derived modes. Note that CC-based
3191 ;; modes don't work with derived-mode-p. In general I
3192 ;; think modes could use an auxiliary method which is
3193 ;; called after local variables are hacked.
3194 (and (boundp 'c-buffer-is-cc-mode)
3196 (c-postprocess-file-styles))))))))
3199 (defcustom change-major-mode-with-file-name t
3200 "Non-nil means \\[write-file] should set the major mode from the file name.
3201 However, the mode will not be changed if
3202 \(1) a local variables list or the `-*-' line specifies a major mode, or
3203 \(2) the current major mode is a \"special\" mode,
3204 \ not suitable for ordinary files, or
3205 \(3) the new file name does not particularly specify any mode."
3207 :group 'editing-basics)
3209 (defun set-visited-file-name (filename &optional no-query along-with-file)
3210 "Change name of file visited in current buffer to FILENAME.
3211 This also renames the buffer to correspond to the new file.
3212 The next time the buffer is saved it will go in the newly specified file.
3213 FILENAME nil or an empty string means mark buffer as not visiting any file.
3214 Remember to delete the initial contents of the minibuffer
3215 if you wish to pass an empty string as the argument.
3217 The optional second argument NO-QUERY, if non-nil, inhibits asking for
3218 confirmation in the case where another buffer is already visiting FILENAME.
3220 The optional third argument ALONG-WITH-FILE, if non-nil, means that
3221 the old visited file has been renamed to the new name FILENAME."
3222 (interactive "FSet visited file name: ")
3223 (if (buffer-base-buffer)
3224 (error "An indirect buffer cannot visit a file"))
3228 (if (string-equal filename "")
3230 (expand-file-name filename))))
3233 (setq truename (file-truename filename))
3234 (if find-file-visit-truename
3235 (setq filename truename))))
3237 (let ((new-name (file-name-nondirectory filename)))
3238 (if (string= new-name "")
3239 (error "Empty file name"))))
3240 (let ((buffer (and filename (find-buffer-visiting filename))))
3241 (and buffer (not (eq buffer (current-buffer)))
3243 (not (y-or-n-p (format "A buffer is visiting %s; proceed? "
3246 (or (equal filename buffer-file-name)
3248 (and filename (lock-buffer filename))
3250 (setq buffer-file-name filename)
3251 (if filename ; make buffer name reflect filename.
3252 (let ((new-name (file-name-nondirectory buffer-file-name)))
3253 (if (eq system-type 'vax-vms)
3254 (setq new-name (downcase new-name)))
3255 (setq default-directory (file-name-directory buffer-file-name))
3256 ;; If new-name == old-name, renaming would add a spurious <2>
3257 ;; and it's considered as a feature in rename-buffer.
3258 (or (string= new-name (buffer-name))
3259 (rename-buffer new-name t))))
3260 (setq buffer-backed-up nil)
3262 (clear-visited-file-modtime))
3263 ;; Abbreviate the file names of the buffer.
3266 (setq buffer-file-truename (abbreviate-file-name truename))
3267 (if find-file-visit-truename
3268 (setq buffer-file-name truename))))
3269 (setq buffer-file-number
3271 (nthcdr 10 (file-attributes buffer-file-name))
3273 ;; write-file-functions is normally used for things like ftp-find-file
3274 ;; that visit things that are not local files as if they were files.
3275 ;; Changing to visit an ordinary local file instead should flush the hook.
3276 (kill-local-variable 'write-file-functions)
3277 (kill-local-variable 'local-write-file-hooks)
3278 (kill-local-variable 'revert-buffer-function)
3279 (kill-local-variable 'backup-inhibited)
3280 ;; If buffer was read-only because of version control,
3281 ;; that reason is gone now, so make it writable.
3283 (setq buffer-read-only nil))
3284 (kill-local-variable 'vc-mode)
3285 ;; Turn off backup files for certain file names.
3286 ;; Since this is a permanent local, the major mode won't eliminate it.
3287 (and buffer-file-name
3288 backup-enable-predicate
3289 (not (funcall backup-enable-predicate buffer-file-name))
3291 (make-local-variable 'backup-inhibited)
3292 (setq backup-inhibited t)))
3293 (let ((oauto buffer-auto-save-file-name))
3294 ;; If auto-save was not already on, turn it on if appropriate.
3295 (if (not buffer-auto-save-file-name)
3296 (and buffer-file-name auto-save-default
3298 ;; If auto save is on, start using a new name.
3299 ;; We deliberately don't rename or delete the old auto save
3300 ;; for the old visited file name. This is because perhaps
3301 ;; the user wants to save the new state and then compare with the
3302 ;; previous state from the auto save file.
3303 (setq buffer-auto-save-file-name
3304 (make-auto-save-file-name)))
3305 ;; Rename the old auto save file if any.
3306 (and oauto buffer-auto-save-file-name
3307 (file-exists-p oauto)
3308 (rename-file oauto buffer-auto-save-file-name t)))
3309 (and buffer-file-name
3310 (not along-with-file)
3311 (set-buffer-modified-p t))
3312 ;; Update the major mode, if the file name determines it.
3314 ;; Don't change the mode if it is special.
3315 (or (not change-major-mode-with-file-name)
3316 (get major-mode 'mode-class)
3317 ;; Don't change the mode if the local variable list specifies it.
3318 (hack-local-variables t)
3322 (defun write-file (filename &optional confirm)
3323 "Write current buffer into file FILENAME.
3324 This makes the buffer visit that file, and marks it as not modified.
3326 If you specify just a directory name as FILENAME, that means to use
3327 the default file name but in that directory. You can also yank
3328 the default file name into the minibuffer to edit it, using \\<minibuffer-local-map>\\[next-history-element].
3330 If the buffer is not already visiting a file, the default file name
3331 for the output file is the buffer name.
3333 If optional second arg CONFIRM is non-nil, this function
3334 asks for confirmation before overwriting an existing file.
3335 Interactively, confirmation is required unless you supply a prefix argument."
3336 ;; (interactive "FWrite file: ")
3338 (list (if buffer-file-name
3339 (read-file-name "Write file: "
3341 (read-file-name "Write file: " default-directory
3343 (file-name-nondirectory (buffer-name))
3346 (not current-prefix-arg)))
3347 (or (null filename) (string-equal filename "")
3349 ;; If arg is just a directory,
3350 ;; use the default file name, but in that directory.
3351 (if (file-directory-p filename)
3352 (setq filename (concat (file-name-as-directory filename)
3353 (file-name-nondirectory
3354 (or buffer-file-name (buffer-name))))))
3356 (file-exists-p filename)
3357 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
3358 (error "Canceled")))
3359 (set-visited-file-name filename (not confirm))))
3360 (set-buffer-modified-p t)
3361 ;; Make buffer writable if file is writable.
3362 (and buffer-file-name
3363 (file-writable-p buffer-file-name)
3364 (setq buffer-read-only nil))
3366 ;; It's likely that the VC status at the new location is different from
3367 ;; the one at the old location.
3368 (vc-find-file-hook))
3370 (defun backup-buffer ()
3371 "Make a backup of the disk file visited by the current buffer, if appropriate.
3372 This is normally done before saving the buffer the first time.
3374 A backup may be done by renaming or by copying; see documentation of
3375 variable `make-backup-files'. If it's done by renaming, then the file is
3376 no longer accessible under its old name.
3378 The value is non-nil after a backup was made by renaming.
3379 It has the form (MODES . BACKUPNAME).
3380 MODES is the result of `file-modes' on the original
3381 file; this means that the caller, after saving the buffer, should change
3382 the modes of the new file to agree with the old modes.
3383 BACKUPNAME is the backup file name, which is the old file renamed."
3384 (if (and make-backup-files (not backup-inhibited)
3385 (not buffer-backed-up)
3386 (file-exists-p buffer-file-name)
3387 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
3389 (let ((real-file-name buffer-file-name)
3390 backup-info backupname targets setmodes)
3391 ;; If specified name is a symbolic link, chase it to the target.
3392 ;; Thus we make the backups in the directory where the real file is.
3393 (setq real-file-name (file-chase-links real-file-name))
3394 (setq backup-info (find-backup-file-name real-file-name)
3395 backupname (car backup-info)
3396 targets (cdr backup-info))
3397 ;; (if (file-directory-p buffer-file-name)
3398 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
3401 (let ((delete-old-versions
3402 ;; If have old versions to maybe delete,
3403 ;; ask the user to confirm now, before doing anything.
3404 ;; But don't actually delete til later.
3406 (or (eq delete-old-versions t) (eq delete-old-versions nil))
3407 (or delete-old-versions
3408 (y-or-n-p (format "Delete excess backup versions of %s? "
3410 (modes (file-modes buffer-file-name)))
3411 ;; Actually write the back up file.
3413 (if (or file-precious-flag
3414 ; (file-symlink-p buffer-file-name)
3416 ;; Don't rename a suid or sgid file.
3417 (and modes (< 0 (logand modes #o6000)))
3418 (not (file-writable-p (file-name-directory real-file-name)))
3419 (and backup-by-copying-when-linked
3420 (> (file-nlinks real-file-name) 1))
3421 (and (or backup-by-copying-when-mismatch
3422 (integerp backup-by-copying-when-privileged-mismatch))
3423 (let ((attr (file-attributes real-file-name)))
3424 (and (or backup-by-copying-when-mismatch
3425 (and (integerp (nth 2 attr))
3426 (integerp backup-by-copying-when-privileged-mismatch)
3427 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
3429 (not (file-ownership-preserved-p real-file-name)))))))
3430 (backup-buffer-copy real-file-name backupname modes)
3431 ;; rename-file should delete old backup.
3432 (rename-file real-file-name backupname t)
3433 (setq setmodes (cons modes backupname)))
3435 ;; If trouble writing the backup, write it in ~.
3436 (setq backupname (expand-file-name
3437 (convert-standard-filename
3439 (message "Cannot write backup file; backing up in %s"
3442 (backup-buffer-copy real-file-name backupname modes)))
3443 (setq buffer-backed-up t)
3444 ;; Now delete the old versions, if desired.
3445 (if delete-old-versions
3448 (delete-file (car targets))
3450 (setq targets (cdr targets))))
3452 (file-error nil))))))
3454 (defun backup-buffer-copy (from-name to-name modes)
3455 (let ((umask (default-file-modes)))
3458 ;; Create temp files with strict access rights. It's easy to
3459 ;; loosen them later, whereas it's impossible to close the
3460 ;; time-window of loose permissions otherwise.
3461 (set-default-file-modes ?\700)
3462 (when (condition-case nil
3463 ;; Try to overwrite old backup first.
3464 (copy-file from-name to-name t t t)
3466 (while (condition-case nil
3468 (when (file-exists-p to-name)
3469 (delete-file to-name))
3470 (copy-file from-name to-name nil t t)
3472 (file-already-exists t))
3473 ;; The file was somehow created by someone else between
3474 ;; `delete-file' and `copy-file', so let's try again.
3475 ;; rms says "I think there is also a possible race
3476 ;; condition for making backup files" (emacs-devel 20070821).
3479 (set-default-file-modes umask)))
3481 (set-file-modes to-name (logand modes #o1777))))
3483 (defun file-name-sans-versions (name &optional keep-backup-version)
3484 "Return file NAME sans backup versions or strings.
3485 This is a separate procedure so your site-init or startup file can
3487 If the optional argument KEEP-BACKUP-VERSION is non-nil,
3488 we do not remove backup version numbers, only true file version numbers."
3489 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
3491 (funcall handler 'file-name-sans-versions name keep-backup-version)
3493 (if (eq system-type 'vax-vms)
3494 ;; VMS version number is (a) semicolon, optional
3495 ;; sign, zero or more digits or (b) period, option
3496 ;; sign, zero or more digits, provided this is the
3497 ;; second period encountered outside of the
3498 ;; device/directory part of the file name.
3499 (or (string-match ";[-+]?[0-9]*\\'" name)
3500 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
3502 (match-beginning 1))
3504 (if keep-backup-version
3506 (or (string-match "\\.~[-[:alnum:]:#@^._]+~\\'" name)
3507 (string-match "~\\'" name)
3508 (length name))))))))
3510 (defun file-ownership-preserved-p (file)
3511 "Return t if deleting FILE and rewriting it would preserve the owner."
3512 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
3514 (funcall handler 'file-ownership-preserved-p file)
3515 (let ((attributes (file-attributes file)))
3516 ;; Return t if the file doesn't exist, since it's true that no
3517 ;; information would be lost by an (attempted) delete and create.
3518 (or (null attributes)
3519 (= (nth 2 attributes) (user-uid)))))))
3521 (defun file-name-sans-extension (filename)
3522 "Return FILENAME sans final \"extension\".
3523 The extension, in a file name, is the part that follows the last `.',
3524 except that a leading `.', if any, doesn't count."
3526 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
3528 (if (and (string-match "\\.[^.]*\\'" file)
3529 (not (eq 0 (match-beginning 0))))
3530 (if (setq directory (file-name-directory filename))
3531 ;; Don't use expand-file-name here; if DIRECTORY is relative,
3532 ;; we don't want to expand it.
3533 (concat directory (substring file 0 (match-beginning 0)))
3534 (substring file 0 (match-beginning 0)))
3537 (defun file-name-extension (filename &optional period)
3538 "Return FILENAME's final \"extension\".
3539 The extension, in a file name, is the part that follows the last `.',
3540 excluding version numbers and backup suffixes,
3541 except that a leading `.', if any, doesn't count.
3542 Return nil for extensionless file names such as `foo'.
3543 Return the empty string for file names such as `foo.'.
3545 If PERIOD is non-nil, then the returned value includes the period
3546 that delimits the extension, and if FILENAME has no extension,
3549 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
3550 (if (and (string-match "\\.[^.]*\\'" file)
3551 (not (eq 0 (match-beginning 0))))
3552 (substring file (+ (match-beginning 0) (if period 0 1)))
3556 (defcustom make-backup-file-name-function nil
3557 "A function to use instead of the default `make-backup-file-name'.
3558 A value of nil gives the default `make-backup-file-name' behavior.
3560 This could be buffer-local to do something special for specific
3561 files. If you define it, you may need to change `backup-file-name-p'
3562 and `file-name-sans-versions' too.
3564 See also `backup-directory-alist'."
3566 :type '(choice (const :tag "Default" nil)
3567 (function :tag "Your function")))
3569 (defcustom backup-directory-alist nil
3570 "Alist of filename patterns and backup directory names.
3571 Each element looks like (REGEXP . DIRECTORY). Backups of files with
3572 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
3573 relative or absolute. If it is absolute, so that all matching files
3574 are backed up into the same directory, the file names in this
3575 directory will be the full name of the file backed up with all
3576 directory separators changed to `!' to prevent clashes. This will not
3577 work correctly if your filesystem truncates the resulting name.
3579 For the common case of all backups going into one directory, the alist
3580 should contain a single element pairing \".\" with the appropriate
3583 If this variable is nil, or it fails to match a filename, the backup
3584 is made in the original file's directory.
3586 On MS-DOS filesystems without long names this variable is always
3589 :type '(repeat (cons (regexp :tag "Regexp matching filename")
3590 (directory :tag "Backup directory name"))))
3592 (defun normal-backup-enable-predicate (name)
3593 "Default `backup-enable-predicate' function.
3594 Checks for files in `temporary-file-directory',
3595 `small-temporary-file-directory', and /tmp."
3596 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
3598 ;; Directory is under temporary-file-directory.
3599 (and (not (eq comp t))
3600 (< comp (- (length temporary-file-directory)))))
3601 (let ((comp (compare-strings "/tmp" 0 nil
3603 ;; Directory is under /tmp.
3604 (and (not (eq comp t))
3605 (< comp (- (length "/tmp")))))
3606 (if small-temporary-file-directory
3607 (let ((comp (compare-strings small-temporary-file-directory
3610 ;; Directory is under small-temporary-file-directory.
3611 (and (not (eq comp t))
3612 (< comp (- (length small-temporary-file-directory)))))))))
3614 (defun make-backup-file-name (file)
3615 "Create the non-numeric backup file name for FILE.
3616 Normally this will just be the file's name with `~' appended.
3617 Customization hooks are provided as follows.
3619 If the variable `make-backup-file-name-function' is non-nil, its value
3620 should be a function which will be called with FILE as its argument;
3621 the resulting name is used.
3623 Otherwise a match for FILE is sought in `backup-directory-alist'; see
3624 the documentation of that variable. If the directory for the backup
3625 doesn't exist, it is created."
3626 (if make-backup-file-name-function
3627 (funcall make-backup-file-name-function file)
3628 (if (and (eq system-type 'ms-dos)
3629 (not (msdos-long-file-names)))
3630 (let ((fn (file-name-nondirectory file)))
3631 (concat (file-name-directory file)
3632 (or (and (string-match "\\`[^.]+\\'" fn)
3633 (concat (match-string 0 fn) ".~"))
3634 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
3635 (concat (match-string 0 fn) "~")))))
3636 (concat (make-backup-file-name-1 file) "~"))))
3638 (defun make-backup-file-name-1 (file)
3639 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
3640 (let ((alist backup-directory-alist)
3641 elt backup-directory abs-backup-directory)
3643 (setq elt (pop alist))
3644 (if (string-match (car elt) file)
3645 (setq backup-directory (cdr elt)
3647 ;; If backup-directory is relative, it should be relative to the
3648 ;; file's directory. By expanding explicitly here, we avoid
3649 ;; depending on default-directory.
3650 (if backup-directory
3651 (setq abs-backup-directory
3652 (expand-file-name backup-directory
3653 (file-name-directory file))))
3654 (if (and abs-backup-directory (not (file-exists-p abs-backup-directory)))
3656 (make-directory abs-backup-directory 'parents)
3657 (file-error (setq backup-directory nil
3658 abs-backup-directory nil))))
3659 (if (null backup-directory)
3661 (if (file-name-absolute-p backup-directory)
3663 (when (memq system-type '(windows-nt ms-dos cygwin))
3664 ;; Normalize DOSish file names: downcase the drive
3665 ;; letter, if any, and replace the leading "x:" with
3667 (or (file-name-absolute-p file)
3668 (setq file (expand-file-name file))) ; make defaults explicit
3669 ;; Replace any invalid file-name characters (for the
3670 ;; case of backing up remote files).
3671 (setq file (expand-file-name (convert-standard-filename file)))
3672 (if (eq (aref file 1) ?:)
3673 (setq file (concat "/"
3675 (char-to-string (downcase (aref file 0)))
3676 (if (eq (aref file 2) ?/)
3679 (substring file 2)))))
3680 ;; Make the name unique by substituting directory
3681 ;; separators. It may not really be worth bothering about
3682 ;; doubling `!'s in the original name...
3684 (subst-char-in-string
3686 (replace-regexp-in-string "!" "!!" file))
3688 (expand-file-name (file-name-nondirectory file)
3689 (file-name-as-directory abs-backup-directory))))))
3691 (defun backup-file-name-p (file)
3692 "Return non-nil if FILE is a backup file name (numeric or not).
3693 This is a separate function so you can redefine it for customization.
3694 You may need to redefine `file-name-sans-versions' as well."
3695 (string-match "~\\'" file))
3697 (defvar backup-extract-version-start)
3699 ;; This is used in various files.
3700 ;; The usage of backup-extract-version-start is not very clean,
3701 ;; but I can't see a good alternative, so as of now I am leaving it alone.
3702 (defun backup-extract-version (fn)
3703 "Given the name of a numeric backup file, FN, return the backup number.
3704 Uses the free variable `backup-extract-version-start', whose value should be
3705 the index in the name where the version number begins."
3706 (if (and (string-match "[0-9]+~/?$" fn backup-extract-version-start)
3707 (= (match-beginning 0) backup-extract-version-start))
3708 (string-to-number (substring fn backup-extract-version-start -1))
3711 ;; I believe there is no need to alter this behavior for VMS;
3712 ;; since backup files are not made on VMS, it should not get called.
3713 (defun find-backup-file-name (fn)
3714 "Find a file name for a backup file FN, and suggestions for deletions.
3715 Value is a list whose car is the name for the backup file
3716 and whose cdr is a list of old versions to consider deleting now.
3717 If the value is nil, don't make a backup.
3718 Uses `backup-directory-alist' in the same way as does
3719 `make-backup-file-name'."
3720 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
3721 ;; Run a handler for this function so that ange-ftp can refuse to do it.
3723 (funcall handler 'find-backup-file-name fn)
3724 (if (or (eq version-control 'never)
3725 ;; We don't support numbered backups on plain MS-DOS
3726 ;; when long file names are unavailable.
3727 (and (eq system-type 'ms-dos)
3728 (not (msdos-long-file-names))))
3729 (list (make-backup-file-name fn))
3730 (let* ((basic-name (make-backup-file-name-1 fn))
3731 (base-versions (concat (file-name-nondirectory basic-name)
3733 (backup-extract-version-start (length base-versions))
3735 (number-to-delete 0)
3736 possibilities deserve-versions-p versions)
3738 (setq possibilities (file-name-all-completions
3740 (file-name-directory basic-name))
3741 versions (sort (mapcar #'backup-extract-version
3744 high-water-mark (apply 'max 0 versions)
3745 deserve-versions-p (or version-control
3746 (> high-water-mark 0))
3747 number-to-delete (- (length versions)
3751 (file-error (setq possibilities nil)))
3752 (if (not deserve-versions-p)
3753 (list (make-backup-file-name fn))
3754 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
3755 (if (and (> number-to-delete 0)
3756 ;; Delete nothing if there is overflow
3757 ;; in the number of versions to keep.
3758 (>= (+ kept-new-versions kept-old-versions -1) 0))
3760 (format "%s.~%d~" basic-name n))
3761 (let ((v (nthcdr kept-old-versions versions)))
3762 (rplacd (nthcdr (1- number-to-delete) v) ())
3765 (defun file-nlinks (filename)
3766 "Return number of names file FILENAME has."
3767 (car (cdr (file-attributes filename))))
3769 ;; (defun file-relative-name (filename &optional directory)
3770 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3771 ;; This function returns a relative file name which is equivalent to FILENAME
3772 ;; when used with that default directory as the default.
3773 ;; If this is impossible (which can happen on MSDOS and Windows
3774 ;; when the file name and directory use different drive names)
3775 ;; then it returns FILENAME."
3777 ;; (let ((fname (expand-file-name filename)))
3778 ;; (setq directory (file-name-as-directory
3779 ;; (expand-file-name (or directory default-directory))))
3780 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
3781 ;; ;; drive names, they can't be relative, so return the absolute name.
3782 ;; (if (and (or (eq system-type 'ms-dos)
3783 ;; (eq system-type 'cygwin)
3784 ;; (eq system-type 'windows-nt))
3785 ;; (not (string-equal (substring fname 0 2)
3786 ;; (substring directory 0 2))))
3788 ;; (let ((ancestor ".")
3789 ;; (fname-dir (file-name-as-directory fname)))
3790 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
3791 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
3792 ;; (setq directory (file-name-directory (substring directory 0 -1))
3793 ;; ancestor (if (equal ancestor ".")
3795 ;; (concat "../" ancestor))))
3796 ;; ;; Now ancestor is empty, or .., or ../.., etc.
3797 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
3798 ;; ;; We matched within FNAME's directory part.
3799 ;; ;; Add the rest of FNAME onto ANCESTOR.
3800 ;; (let ((rest (substring fname (match-end 0))))
3801 ;; (if (and (equal ancestor ".")
3802 ;; (not (equal rest "")))
3803 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
3805 ;; (concat (file-name-as-directory ancestor) rest)))
3806 ;; ;; We matched FNAME's directory equivalent.
3809 (defun file-relative-name (filename &optional directory)
3810 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
3811 This function returns a relative file name which is equivalent to FILENAME
3812 when used with that default directory as the default.
3813 If FILENAME and DIRECTORY lie on different machines or on different drives
3814 on a DOS/Windows machine, it returns FILENAME in expanded form."
3817 (file-name-as-directory (expand-file-name (or directory
3818 default-directory))))
3819 (setq filename (expand-file-name filename))
3820 (let ((fremote (file-remote-p filename))
3821 (dremote (file-remote-p directory)))
3822 (if ;; Conditions for separate trees
3824 ;; Test for different drives on DOS/Windows
3826 ;; Should `cygwin' really be included here? --stef
3827 (memq system-type '(ms-dos cygwin windows-nt))
3828 (not (eq t (compare-strings filename 0 2 directory 0 2))))
3829 ;; Test for different remote file system identification
3830 (not (equal fremote dremote)))
3832 (let ((ancestor ".")
3833 (filename-dir (file-name-as-directory filename)))
3836 (eq t (compare-strings filename-dir nil (length directory)
3837 directory nil nil case-fold-search))
3838 (eq t (compare-strings filename nil (length directory)
3839 directory nil nil case-fold-search))))
3840 (setq directory (file-name-directory (substring directory 0 -1))
3841 ancestor (if (equal ancestor ".")
3843 (concat "../" ancestor))))
3844 ;; Now ancestor is empty, or .., or ../.., etc.
3845 (if (eq t (compare-strings filename nil (length directory)
3846 directory nil nil case-fold-search))
3847 ;; We matched within FILENAME's directory part.
3848 ;; Add the rest of FILENAME onto ANCESTOR.
3849 (let ((rest (substring filename (length directory))))
3850 (if (and (equal ancestor ".") (not (equal rest "")))
3851 ;; But don't bother with ANCESTOR if it would give us `./'.
3853 (concat (file-name-as-directory ancestor) rest)))
3854 ;; We matched FILENAME's directory equivalent.
3857 (defun save-buffer (&optional args)
3858 "Save current buffer in visited file if modified.
3859 Variations are described below.
3861 By default, makes the previous version into a backup file
3862 if previously requested or if this is the first save.
3863 Prefixed with one \\[universal-argument], marks this version
3864 to become a backup when the next save is done.
3865 Prefixed with two \\[universal-argument]'s,
3866 unconditionally makes the previous version into a backup file.
3867 Prefixed with three \\[universal-argument]'s, marks this version
3868 to become a backup when the next save is done,
3869 and unconditionally makes the previous version into a backup file.
3871 With a numeric argument of 0, never make the previous version
3874 If a file's name is FOO, the names of its numbered backup versions are
3875 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
3876 Numeric backups (rather than FOO~) will be made if value of
3877 `version-control' is not the atom `never' and either there are already
3878 numeric versions of the file being backed up, or `version-control' is
3880 We don't want excessive versions piling up, so there are variables
3881 `kept-old-versions', which tells Emacs how many oldest versions to keep,
3882 and `kept-new-versions', which tells how many newest versions to keep.
3883 Defaults are 2 old versions and 2 new.
3884 `dired-kept-versions' controls dired's clean-directory (.) command.
3885 If `delete-old-versions' is nil, system will query user
3886 before trimming versions. Otherwise it does it silently.
3888 If `vc-make-backup-files' is nil, which is the default,
3889 no backup files are made for files managed by version control.
3890 (This is because the version control system itself records previous versions.)
3892 See the subroutine `basic-save-buffer' for more information."
3894 (let ((modp (buffer-modified-p))
3895 (large (> (buffer-size) 50000))
3896 (make-backup-files (or (and make-backup-files (not (eq args 0)))
3897 (memq args '(16 64)))))
3898 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
3899 (if (and modp large (buffer-file-name))
3900 (message "Saving file %s..." (buffer-file-name)))
3902 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
3904 (defun delete-auto-save-file-if-necessary (&optional force)
3905 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
3906 Normally delete only if the file was written by this Emacs since
3907 the last real save, but optional arg FORCE non-nil means delete anyway."
3908 (and buffer-auto-save-file-name delete-auto-save-files
3909 (not (string= buffer-file-name buffer-auto-save-file-name))
3910 (or force (recent-auto-save-p))
3913 (delete-file buffer-auto-save-file-name)
3915 (set-buffer-auto-saved))))
3917 (defvar auto-save-hook nil
3918 "Normal hook run just before auto-saving.")
3920 (defcustom before-save-hook nil
3921 "Normal hook that is run before a buffer is saved to its file."
3922 :options '(copyright-update time-stamp)
3926 (defcustom after-save-hook nil
3927 "Normal hook that is run after a buffer is saved to its file."
3928 :options '(executable-make-buffer-file-executable-if-script-p)
3932 (defvar save-buffer-coding-system nil
3933 "If non-nil, use this coding system for saving the buffer.
3934 More precisely, use this coding system in place of the
3935 value of `buffer-file-coding-system', when saving the buffer.
3936 Calling `write-region' for any purpose other than saving the buffer
3937 will still use `buffer-file-coding-system'; this variable has no effect
3940 (make-variable-buffer-local 'save-buffer-coding-system)
3941 (put 'save-buffer-coding-system 'permanent-local t)
3943 (defun basic-save-buffer ()
3944 "Save the current buffer in its visited file, if it has been modified.
3945 The hooks `write-contents-functions' and `write-file-functions' get a chance
3946 to do the job of saving; if they do not, then the buffer is saved in
3947 the visited file in the usual way.
3948 Before and after saving the buffer, this function runs
3949 `before-save-hook' and `after-save-hook', respectively."
3951 (save-current-buffer
3952 ;; In an indirect buffer, save its base buffer instead.
3953 (if (buffer-base-buffer)
3954 (set-buffer (buffer-base-buffer)))
3955 (if (buffer-modified-p)
3956 (let ((recent-save (recent-auto-save-p))
3958 ;; On VMS, rename file and buffer to get rid of version number.
3959 (if (and (eq system-type 'vax-vms)
3960 (not (string= buffer-file-name
3961 (file-name-sans-versions buffer-file-name))))
3962 (let (buffer-new-name)
3963 ;; Strip VMS version number before save.
3964 (setq buffer-file-name
3965 (file-name-sans-versions buffer-file-name))
3966 ;; Construct a (unique) buffer name to correspond.
3967 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3968 (setq buffer-new-name (buffer-name buf))
3970 (rename-buffer buffer-new-name)))
3971 ;; If buffer has no file name, ask user for one.
3972 (or buffer-file-name
3975 (read-file-name "File to save in: ") nil)))
3976 (if (file-exists-p filename)
3977 (if (file-directory-p filename)
3978 ;; Signal an error if the user specified the name of an
3979 ;; existing directory.
3980 (error "%s is a directory" filename)
3981 (unless (y-or-n-p (format "File `%s' exists; overwrite? "
3983 (error "Canceled")))
3984 ;; Signal an error if the specified name refers to a
3985 ;; non-existing directory.
3986 (let ((dir (file-name-directory filename)))
3987 (unless (file-directory-p dir)
3988 (if (file-exists-p dir)
3989 (error "%s is not a directory" dir)
3990 (error "%s: no such directory" dir)))))
3991 (set-visited-file-name filename)))
3992 (or (verify-visited-file-modtime (current-buffer))
3993 (not (file-exists-p buffer-file-name))
3995 (format "%s has changed since visited or saved. Save anyway? "
3996 (file-name-nondirectory buffer-file-name)))
3997 (error "Save not confirmed"))
4001 (and (> (point-max) (point-min))
4002 (not find-file-literally)
4003 (/= (char-after (1- (point-max))) ?\n)
4004 (not (and (eq selective-display t)
4005 (= (char-after (1- (point-max))) ?\r)))
4006 (or (eq require-final-newline t)
4007 (eq require-final-newline 'visit-save)
4008 (and require-final-newline
4010 (format "Buffer %s does not end in newline. Add one? "
4013 (goto-char (point-max))
4015 ;; Support VC version backups.
4017 (run-hooks 'before-save-hook)
4018 (or (run-hook-with-args-until-success 'write-contents-functions)
4019 (run-hook-with-args-until-success 'local-write-file-hooks)
4020 (run-hook-with-args-until-success 'write-file-functions)
4021 ;; If a hook returned t, file is already "written".
4022 ;; Otherwise, write it the usual way now.
4023 (setq setmodes (basic-save-buffer-1)))
4024 ;; Now we have saved the current buffer. Let's make sure
4025 ;; that buffer-file-coding-system is fixed to what
4026 ;; actually used for saving by binding it locally.
4027 (if save-buffer-coding-system
4028 (setq save-buffer-coding-system last-coding-system-used)
4029 (setq buffer-file-coding-system last-coding-system-used))
4030 (setq buffer-file-number
4031 (nthcdr 10 (file-attributes buffer-file-name)))
4034 (set-file-modes buffer-file-name (car setmodes))
4036 ;; If the auto-save file was recent before this command,
4038 (delete-auto-save-file-if-necessary recent-save)
4039 ;; Support VC `implicit' locking.
4041 (run-hooks 'after-save-hook))
4042 (message "(No changes need to be saved)"))))
4044 ;; This does the "real job" of writing a buffer into its visited file
4045 ;; and making a backup file. This is what is normally done
4046 ;; but inhibited if one of write-file-functions returns non-nil.
4047 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
4048 (defun basic-save-buffer-1 ()
4050 (if save-buffer-coding-system
4051 (let ((coding-system-for-write save-buffer-coding-system))
4052 (basic-save-buffer-2))
4053 (basic-save-buffer-2))
4054 (setq buffer-file-coding-system-explicit last-coding-system-used)))
4056 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
4057 (defun basic-save-buffer-2 ()
4058 (let (tempsetmodes setmodes)
4059 (if (not (file-writable-p buffer-file-name))
4060 (let ((dir (file-name-directory buffer-file-name)))
4061 (if (not (file-directory-p dir))
4062 (if (file-exists-p dir)
4063 (error "%s is not a directory" dir)
4064 (error "%s: no such directory" dir))
4065 (if (not (file-exists-p buffer-file-name))
4066 (error "Directory %s write-protected" dir)
4068 (format "File %s is write-protected; try to save anyway? "
4069 (file-name-nondirectory
4071 (setq tempsetmodes t)
4072 (error "Attempt to save to a file which you aren't allowed to write"))))))
4073 (or buffer-backed-up
4074 (setq setmodes (backup-buffer)))
4075 (let ((dir (file-name-directory buffer-file-name)))
4076 (if (and file-precious-flag
4077 (file-writable-p dir))
4078 ;; If file is precious, write temp name, then rename it.
4079 ;; This requires write access to the containing dir,
4080 ;; which is why we don't try it if we don't have that access.
4081 (let ((realname buffer-file-name)
4083 (umask (default-file-modes))
4084 (old-modtime (visited-file-modtime)))
4085 ;; Create temp files with strict access rights. It's easy to
4086 ;; loosen them later, whereas it's impossible to close the
4087 ;; time-window of loose permissions otherwise.
4090 (clear-visited-file-modtime)
4091 (set-default-file-modes ?\700)
4092 ;; Try various temporary names.
4093 ;; This code follows the example of make-temp-file,
4094 ;; but it calls write-region in the appropriate way
4095 ;; for saving the buffer.
4096 (while (condition-case ()
4100 (expand-file-name "tmp" dir)))
4101 ;; Pass in nil&nil rather than point-min&max
4102 ;; cause we're saving the whole buffer.
4103 ;; write-region-annotate-functions may use it.
4104 (write-region nil nil
4105 tempname nil realname
4106 buffer-file-truename 'excl)
4108 (file-already-exists t))
4109 ;; The file was somehow created by someone else between
4110 ;; `make-temp-name' and `write-region', let's try again.
4114 (set-default-file-modes umask)
4115 ;; If we failed, restore the buffer's modtime.
4117 (set-visited-file-modtime old-modtime)))
4118 ;; Since we have created an entirely new file,
4119 ;; make sure it gets the right permission bits set.
4120 (setq setmodes (or setmodes
4121 (cons (or (file-modes buffer-file-name)
4122 (logand ?\666 umask))
4124 ;; We succeeded in writing the temp file,
4126 (rename-file tempname buffer-file-name t))
4127 ;; If file not writable, see if we can make it writable
4128 ;; temporarily while we write it.
4129 ;; But no need to do so if we have just backed it up
4130 ;; (setmodes is set) because that says we're superseding.
4131 (cond ((and tempsetmodes (not setmodes))
4132 ;; Change the mode back, after writing.
4133 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
4134 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
4138 ;; Pass in nil&nil rather than point-min&max to indicate
4139 ;; we're saving the buffer rather than just a region.
4140 ;; write-region-annotate-functions may make us of it.
4141 (write-region nil nil
4142 buffer-file-name nil t buffer-file-truename)
4144 ;; If we get an error writing the new file, and we made
4145 ;; the backup by renaming, undo the backing-up.
4146 (and setmodes (not success)
4148 (rename-file (cdr setmodes) buffer-file-name t)
4149 (setq buffer-backed-up nil)))))))
4152 (defun diff-buffer-with-file (&optional buffer)
4153 "View the differences between BUFFER and its associated file.
4154 This requires the external program `diff' to be in your `exec-path'."
4155 (interactive "bBuffer: ")
4156 (with-current-buffer (get-buffer (or buffer (current-buffer)))
4157 (if (and buffer-file-name
4158 (file-exists-p buffer-file-name))
4159 (let ((tempfile (make-temp-file "buffer-content-")))
4162 (write-region nil nil tempfile nil 'nomessage)
4163 (diff buffer-file-name tempfile nil t)
4165 (when (file-exists-p tempfile)
4166 (delete-file tempfile))))
4167 (message "Buffer %s has no associated file on disc" (buffer-name))
4168 ;; Display that message for 1 second so that user can read it
4169 ;; in the minibuffer.
4171 ;; return always nil, so that save-buffers-kill-emacs will not move
4172 ;; over to the next unsaved buffer when calling `d'.
4175 (defvar save-some-buffers-action-alist
4178 (if (not enable-recursive-minibuffers)
4179 (progn (display-buffer buf)
4180 (setq other-window-scroll-buffer buf))
4181 (view-buffer buf (lambda (_) (exit-recursive-edit)))
4183 ;; Return nil to ask about BUF again.
4187 (if (null buffer-file-name)
4188 (message "Not applicable: no file")
4189 (save-window-excursion (diff-buffer-with-file buf))
4190 (if (not enable-recursive-minibuffers)
4191 (progn (display-buffer (get-buffer-create "*Diff*"))
4192 (setq other-window-scroll-buffer "*Diff*"))
4193 (view-buffer (get-buffer-create "*Diff*")
4194 (lambda (_) (exit-recursive-edit)))
4196 ;; Return nil to ask about BUF again.
4198 "view changes in this buffer"))
4199 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
4201 (defvar buffer-save-without-query nil
4202 "Non-nil means `save-some-buffers' should save this buffer without asking.")
4203 (make-variable-buffer-local 'buffer-save-without-query)
4205 (defun save-some-buffers (&optional arg pred)
4206 "Save some modified file-visiting buffers. Asks user about each one.
4207 You can answer `y' to save, `n' not to save, `C-r' to look at the
4208 buffer in question with `view-buffer' before deciding or `d' to
4209 view the differences using `diff-buffer-with-file'.
4211 Optional argument (the prefix) non-nil means save all with no questions.
4212 Optional second argument PRED determines which buffers are considered:
4213 If PRED is nil, all the file-visiting buffers are considered.
4214 If PRED is t, then certain non-file buffers will also be considered.
4215 If PRED is a zero-argument function, it indicates for each buffer whether
4216 to consider it or not when called with that buffer current.
4218 See `save-some-buffers-action-alist' if you want to
4219 change the additional actions you can take on files."
4221 (save-window-excursion
4222 (let* (queried some-automatic
4223 files-done abbrevs-done)
4224 (dolist (buffer (buffer-list))
4225 ;; First save any buffers that we're supposed to save unconditionally.
4226 ;; That way the following code won't ask about them.
4227 (with-current-buffer buffer
4228 (when (and buffer-save-without-query (buffer-modified-p))
4229 (setq some-automatic t)
4231 ;; Ask about those buffers that merit it,
4232 ;; and record the number thus saved.
4236 (and (buffer-modified-p buffer)
4237 (not (buffer-base-buffer buffer))
4239 (buffer-file-name buffer)
4243 (and buffer-offer-save (> (buffer-size) 0)))))
4244 (or (not (functionp pred))
4245 (with-current-buffer buffer (funcall pred)))
4249 (if (buffer-file-name buffer)
4250 (format "Save file %s? "
4251 (buffer-file-name buffer))
4252 (format "Save buffer %s? "
4253 (buffer-name buffer))))))
4255 (with-current-buffer buffer
4258 '("buffer" "buffers" "save")
4259 save-some-buffers-action-alist))
4260 ;; Maybe to save abbrevs, and record whether
4261 ;; we either saved them or asked to.
4262 (and save-abbrevs abbrevs-changed
4265 (eq save-abbrevs 'silently)
4266 (y-or-n-p (format "Save abbrevs in %s? "
4268 (write-abbrev-file nil))
4269 ;; Don't keep bothering user if he says no.
4270 (setq abbrevs-changed nil)
4271 (setq abbrevs-done t)))
4272 (or queried (> files-done 0) abbrevs-done
4273 (message (if some-automatic
4274 "(Some special files were saved without asking)"
4275 "(No files need saving)"))))))
4277 (defun not-modified (&optional arg)
4278 "Mark current buffer as unmodified, not needing to be saved.
4279 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
4281 It is not a good idea to use this function in Lisp programs, because it
4282 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
4284 (message (if arg "Modification-flag set"
4285 "Modification-flag cleared"))
4286 (set-buffer-modified-p arg))
4288 (defun toggle-read-only (&optional arg)
4289 "Change whether this buffer is visiting its file read-only.
4290 With prefix argument ARG, make the buffer read-only if ARG is
4291 positive, otherwise make it writable. If visiting file read-only
4292 and `view-read-only' is non-nil, enter view mode."
4295 (if (> (prefix-numeric-value arg) 0) buffer-read-only
4296 (not buffer-read-only))) ; If buffer-read-only is set correctly,
4300 ((and buffer-read-only view-mode)
4301 (View-exit-and-edit)
4302 (make-local-variable 'view-read-only)
4303 (setq view-read-only t)) ; Must leave view mode.
4304 ((and (not buffer-read-only) view-read-only
4305 ;; If view-mode is already active, `view-mode-enter' is a nop.
4307 (not (eq (get major-mode 'mode-class) 'special)))
4309 (t (setq buffer-read-only (not buffer-read-only))
4310 (force-mode-line-update)))
4311 (if (vc-backend buffer-file-name)
4312 (message "%s" (substitute-command-keys
4313 (concat "File is under version-control; "
4314 "use \\[vc-next-action] to check in/out"))))))
4316 (defun insert-file (filename)
4317 "Insert contents of file FILENAME into buffer after point.
4318 Set mark after the inserted text.
4320 This function is meant for the user to run interactively.
4321 Don't call it from programs! Use `insert-file-contents' instead.
4322 \(Its calling sequence is different; see its documentation)."
4323 (interactive "*fInsert file: ")
4324 (insert-file-1 filename #'insert-file-contents))
4326 (defun append-to-file (start end filename)
4327 "Append the contents of the region to the end of file FILENAME.
4328 When called from a function, expects three arguments,
4329 START, END and FILENAME. START and END are buffer positions
4330 saying what text to write."
4331 (interactive "r\nFAppend to file: ")
4332 (write-region start end filename t))
4334 (defun file-newest-backup (filename)
4335 "Return most recent backup file for FILENAME or nil if no backups exist."
4336 ;; `make-backup-file-name' will get us the right directory for
4337 ;; ordinary or numeric backups. It might create a directory for
4338 ;; backups as a side-effect, according to `backup-directory-alist'.
4339 (let* ((filename (file-name-sans-versions
4340 (make-backup-file-name (expand-file-name filename))))
4341 (file (file-name-nondirectory filename))
4342 (dir (file-name-directory filename))
4343 (comp (file-name-all-completions file dir))
4347 (setq tem (pop comp))
4348 (cond ((and (backup-file-name-p tem)
4349 (string= (file-name-sans-versions tem) file))
4350 (setq tem (concat dir tem))
4351 (if (or (null newest)
4352 (file-newer-than-file-p tem newest))
4353 (setq newest tem)))))
4356 (defun rename-uniquely ()
4357 "Rename current buffer to a similar name not already taken.
4358 This function is useful for creating multiple shell process buffers
4359 or multiple mail buffers, etc."
4362 (let ((base-name (buffer-name)))
4363 (and (string-match "<[0-9]+>\\'" base-name)
4364 (not (and buffer-file-name
4366 (file-name-nondirectory buffer-file-name))))
4367 ;; If the existing buffer name has a <NNN>,
4368 ;; which isn't part of the file name (if any),
4369 ;; then get rid of that.
4370 (setq base-name (substring base-name 0 (match-beginning 0))))
4371 (rename-buffer (generate-new-buffer-name base-name))
4372 (force-mode-line-update))))
4374 (defun make-directory (dir &optional parents)
4375 "Create the directory DIR and any nonexistent parent dirs.
4376 If DIR already exists as a directory, signal an error, unless PARENTS is set.
4378 Interactively, the default choice of directory to create
4379 is the current default directory for file names.
4380 That is useful when you have visited a file in a nonexistent directory.
4382 Noninteractively, the second (optional) argument PARENTS says whether
4383 to create parent directories if they don't exist. Interactively,
4384 this happens by default."
4386 (list (read-file-name "Make directory: " default-directory default-directory
4389 ;; If default-directory is a remote directory,
4390 ;; make sure we find its make-directory handler.
4391 (setq dir (expand-file-name dir))
4392 (let ((handler (find-file-name-handler dir 'make-directory)))
4394 (funcall handler 'make-directory dir parents)
4396 (make-directory-internal dir)
4397 (let ((dir (directory-file-name (expand-file-name dir)))
4399 (while (not (file-exists-p dir))
4400 (setq create-list (cons dir create-list)
4401 dir (directory-file-name (file-name-directory dir))))
4403 (make-directory-internal (car create-list))
4404 (setq create-list (cdr create-list))))))))
4406 (put 'revert-buffer-function 'permanent-local t)
4407 (defvar revert-buffer-function nil
4408 "Function to use to revert this buffer, or nil to do the default.
4409 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
4410 which are the arguments that `revert-buffer' received.")
4412 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
4413 (defvar revert-buffer-insert-file-contents-function nil
4414 "Function to use to insert contents when reverting this buffer.
4415 Gets two args, first the nominal file name to use,
4416 and second, t if reading the auto-save file.
4418 The function you specify is responsible for updating (or preserving) point.")
4420 (defvar buffer-stale-function nil
4421 "Function to check whether a non-file buffer needs reverting.
4422 This should be a function with one optional argument NOCONFIRM.
4423 Auto Revert Mode passes t for NOCONFIRM. The function should return
4424 non-nil if the buffer should be reverted. A return value of
4425 `fast' means that the need for reverting was not checked, but
4426 that reverting the buffer is fast. The buffer is current when
4427 this function is called.
4429 The idea behind the NOCONFIRM argument is that it should be
4430 non-nil if the buffer is going to be reverted without asking the
4431 user. In such situations, one has to be careful with potentially
4432 time consuming operations.
4434 For more information on how this variable is used by Auto Revert mode,
4435 see Info node `(emacs)Supporting additional buffers'.")
4437 (defvar before-revert-hook nil
4438 "Normal hook for `revert-buffer' to run before reverting.
4439 If `revert-buffer-function' is used to override the normal revert
4440 mechanism, this hook is not used.")
4442 (defvar after-revert-hook nil
4443 "Normal hook for `revert-buffer' to run after reverting.
4444 Note that the hook value that it runs is the value that was in effect
4445 before reverting; that makes a difference if you have buffer-local
4448 If `revert-buffer-function' is used to override the normal revert
4449 mechanism, this hook is not used.")
4451 (defvar revert-buffer-internal-hook)
4453 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
4454 "Replace current buffer text with the text of the visited file on disk.
4455 This undoes all changes since the file was visited or saved.
4456 With a prefix argument, offer to revert from latest auto-save file, if
4457 that is more recent than the visited file.
4459 This command also implements an interface for special buffers
4460 that contain text which doesn't come from a file, but reflects
4461 some other data instead (e.g. Dired buffers, `buffer-list'
4462 buffers). This is done via the variable
4463 `revert-buffer-function'. In these cases, it should reconstruct
4464 the buffer contents from the appropriate data.
4466 When called from Lisp, the first argument is IGNORE-AUTO; only offer
4467 to revert from the auto-save file when this is nil. Note that the
4468 sense of this argument is the reverse of the prefix argument, for the
4469 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
4472 Optional second argument NOCONFIRM means don't ask for confirmation at
4473 all. \(The variable `revert-without-query' offers another way to
4474 revert buffers without querying for confirmation.)
4476 Optional third argument PRESERVE-MODES non-nil means don't alter
4477 the files modes. Normally we reinitialize them using `normal-mode'.
4479 If the value of `revert-buffer-function' is non-nil, it is called to
4480 do all the work for this command. Otherwise, the hooks
4481 `before-revert-hook' and `after-revert-hook' are run at the beginning
4482 and the end, and if `revert-buffer-insert-file-contents-function' is
4483 non-nil, it is called instead of rereading visited file contents."
4485 ;; I admit it's odd to reverse the sense of the prefix argument, but
4486 ;; there is a lot of code out there which assumes that the first
4487 ;; argument should be t to avoid consulting the auto-save file, and
4488 ;; there's no straightforward way to encourage authors to notice a
4489 ;; reversal of the argument sense. So I'm just changing the user
4490 ;; interface, but leaving the programmatic interface the same.
4491 (interactive (list (not current-prefix-arg)))
4492 (if revert-buffer-function
4493 (funcall revert-buffer-function ignore-auto noconfirm)
4494 (with-current-buffer (or (buffer-base-buffer (current-buffer))
4496 (let* ((auto-save-p (and (not ignore-auto)
4497 (recent-auto-save-p)
4498 buffer-auto-save-file-name
4499 (file-readable-p buffer-auto-save-file-name)
4501 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
4502 (file-name (if auto-save-p
4503 buffer-auto-save-file-name
4505 (cond ((null file-name)
4506 (error "Buffer does not seem to be associated with any file"))
4508 (and (not (buffer-modified-p))
4510 (dolist (regexp revert-without-query)
4511 (when (string-match regexp file-name)
4512 (throw 'found t)))))
4513 (yes-or-no-p (format "Revert buffer from file %s? "
4515 (run-hooks 'before-revert-hook)
4516 ;; If file was backed up but has changed since,
4517 ;; we shd make another backup.
4518 (and (not auto-save-p)
4519 (not (verify-visited-file-modtime (current-buffer)))
4520 (setq buffer-backed-up nil))
4521 ;; Effectively copy the after-revert-hook status,
4522 ;; since after-find-file will clobber it.
4523 (let ((global-hook (default-value 'after-revert-hook))
4524 (local-hook (when (local-variable-p 'after-revert-hook)
4526 (inhibit-read-only t))
4528 (revert-buffer-insert-file-contents-function
4529 (unless (eq buffer-undo-list t)
4530 ;; Get rid of all undo records for this buffer.
4531 (setq buffer-undo-list nil))
4532 ;; Don't make undo records for the reversion.
4533 (let ((buffer-undo-list t))
4534 (funcall revert-buffer-insert-file-contents-function
4535 file-name auto-save-p)))
4536 ((not (file-exists-p file-name))
4537 (error (if buffer-file-number
4538 "File %s no longer exists!"
4539 "Cannot revert nonexistent file %s")
4541 ((not (file-readable-p file-name))
4542 (error (if buffer-file-number
4543 "File %s no longer readable!"
4544 "Cannot revert unreadable file %s")
4547 ;; Bind buffer-file-name to nil
4548 ;; so that we don't try to lock the file.
4549 (let ((buffer-file-name nil))
4553 (let ((coding-system-for-read
4554 ;; Auto-saved file should be read by Emacs'
4556 (if auto-save-p 'auto-save-coding
4557 (or coding-system-for-read
4558 buffer-file-coding-system-explicit))))
4559 (if (and (not enable-multibyte-characters)
4560 coding-system-for-read
4561 (not (memq (coding-system-base
4562 coding-system-for-read)
4563 '(no-conversion raw-text))))
4564 ;; As a coding system suitable for multibyte
4565 ;; buffer is specified, make the current
4566 ;; buffer multibyte.
4567 (set-buffer-multibyte t))
4569 ;; This force after-insert-file-set-coding
4570 ;; (called from insert-file-contents) to set
4571 ;; buffer-file-coding-system to a proper value.
4572 (kill-local-variable 'buffer-file-coding-system)
4574 ;; Note that this preserves point in an intelligent way.
4576 (let ((buffer-file-format buffer-file-format))
4577 (insert-file-contents file-name (not auto-save-p)
4579 (insert-file-contents file-name (not auto-save-p)
4581 ;; Recompute the truename in case changes in symlinks
4582 ;; have changed the truename.
4583 (setq buffer-file-truename
4584 (abbreviate-file-name (file-truename buffer-file-name)))
4585 (after-find-file nil nil t t preserve-modes)
4586 ;; Run after-revert-hook as it was before we reverted.
4587 (setq-default revert-buffer-internal-hook global-hook)
4589 (set (make-local-variable 'revert-buffer-internal-hook)
4591 (kill-local-variable 'revert-buffer-internal-hook))
4592 (run-hooks 'revert-buffer-internal-hook))
4595 (defun recover-this-file ()
4596 "Recover the visited file--get contents from its last auto-save file."
4598 (recover-file buffer-file-name))
4600 (defun recover-file (file)
4601 "Visit file FILE, but get contents from its last auto-save file."
4602 ;; Actually putting the file name in the minibuffer should be used
4604 ;; Not just because users often use the default.
4605 (interactive "FRecover file: ")
4606 (setq file (expand-file-name file))
4607 (if (auto-save-file-name-p (file-name-nondirectory file))
4608 (error "%s is an auto-save file" (abbreviate-file-name file)))
4609 (let ((file-name (let ((buffer-file-name file))
4610 (make-auto-save-file-name))))
4611 (cond ((if (file-exists-p file)
4612 (not (file-newer-than-file-p file-name file))
4613 (not (file-exists-p file-name)))
4614 (error "Auto-save file %s not current"
4615 (abbreviate-file-name file-name)))
4616 ((save-window-excursion
4617 (with-output-to-temp-buffer "*Directory*"
4618 (buffer-disable-undo standard-output)
4620 (let ((switches dired-listing-switches))
4621 (if (file-symlink-p file)
4622 (setq switches (concat switches "L")))
4623 (set-buffer standard-output)
4624 ;; Use insert-directory-safely, not insert-directory,
4625 ;; because these files might not exist. In particular,
4626 ;; FILE might not exist if the auto-save file was for
4627 ;; a buffer that didn't visit a file, such as "*mail*".
4628 ;; The code in v20.x called `ls' directly, so we need
4629 ;; to emulate what `ls' did in that case.
4630 (insert-directory-safely file switches)
4631 (insert-directory-safely file-name switches))))
4632 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
4633 (switch-to-buffer (find-file-noselect file t))
4634 (let ((inhibit-read-only t)
4635 ;; Keep the current buffer-file-coding-system.
4636 (coding-system buffer-file-coding-system)
4637 ;; Auto-saved file should be read with special coding.
4638 (coding-system-for-read 'auto-save-coding))
4640 (insert-file-contents file-name nil)
4641 (set-buffer-file-coding-system coding-system))
4642 (after-find-file nil nil t))
4643 (t (error "Recover-file cancelled")))))
4645 (defun recover-session ()
4646 "Recover auto save files from a previous Emacs session.
4647 This command first displays a Dired buffer showing you the
4648 previous sessions that you could recover from.
4649 To choose one, move point to the proper line and then type C-c C-c.
4650 Then you'll be asked about a number of files to recover."
4652 (if (null auto-save-list-file-prefix)
4653 (error "You set `auto-save-list-file-prefix' to disable making session files"))
4654 (let ((dir (file-name-directory auto-save-list-file-prefix)))
4655 (unless (file-directory-p dir)
4656 (make-directory dir t))
4657 (unless (directory-files dir nil
4658 (concat "\\`" (regexp-quote
4659 (file-name-nondirectory
4660 auto-save-list-file-prefix)))
4662 (error "No previous sessions to recover")))
4663 (let ((ls-lisp-support-shell-wildcards t))
4664 (dired (concat auto-save-list-file-prefix "*")
4665 (concat dired-listing-switches "t")))
4667 (goto-char (point-min))
4668 (or (looking-at " Move to the session you want to recover,")
4669 (let ((inhibit-read-only t))
4670 ;; Each line starts with a space
4671 ;; so that Font Lock mode won't highlight the first character.
4672 (insert " Move to the session you want to recover,\n"
4673 " then type C-c C-c to select it.\n\n"
4674 " You can also delete some of these files;\n"
4675 " type d on a line to mark that file for deletion.\n\n"))))
4676 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
4677 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
4679 (defun recover-session-finish ()
4680 "Choose one saved session to recover auto-save files from.
4681 This command is used in the special Dired buffer created by
4682 \\[recover-session]."
4684 ;; Get the name of the session file to recover from.
4685 (let ((file (dired-get-filename))
4687 (buffer (get-buffer-create " *recover*")))
4689 (dired-do-flagged-delete t)
4692 ;; Read in the auto-save-list file.
4695 (insert-file-contents file)
4696 ;; Loop thru the text of that file
4697 ;; and get out the names of the files to recover.
4699 (let (thisfile autofile)
4701 ;; This is a pair of lines for a non-file-visiting buffer.
4702 ;; Get the auto-save file name and manufacture
4703 ;; a "visited file name" from that.
4706 ;; If there is no auto-save file name, the
4707 ;; auto-save-list file is probably corrupted.
4710 (buffer-substring-no-properties
4712 (line-end-position)))
4716 (file-name-nondirectory autofile)
4718 (file-name-directory autofile))))
4720 ;; This pair of lines is a file-visiting
4721 ;; buffer. Use the visited file name.
4724 (buffer-substring-no-properties
4725 (point) (progn (end-of-line) (point))))
4728 (buffer-substring-no-properties
4729 (point) (progn (end-of-line) (point))))
4731 ;; Ignore a file if its auto-save file does not exist now.
4732 (if (and autofile (file-exists-p autofile))
4733 (setq files (cons thisfile files)))))
4734 (setq files (nreverse files))
4735 ;; The file contains a pair of line for each auto-saved buffer.
4736 ;; The first line of the pair contains the visited file name
4737 ;; or is empty if the buffer was not visiting a file.
4738 ;; The second line is the auto-save file name.
4740 (map-y-or-n-p "Recover %s? "
4743 (save-excursion (recover-file file))
4745 "Failed to recover `%s'" file)))
4747 '("file" "files" "recover"))
4748 (message "No files can be recovered from this session now")))
4749 (kill-buffer buffer))))
4751 (defun kill-buffer-ask (buffer)
4752 "Kill buffer if confirmed."
4754 (format "Buffer %s %s. Kill? " (buffer-name buffer)
4755 (if (buffer-modified-p buffer)
4756 "HAS BEEN EDITED" "is unmodified")))
4757 (kill-buffer buffer)))
4759 (defun kill-some-buffers (&optional list)
4760 "Kill some buffers. Asks the user whether to kill each one of them.
4761 Non-interactively, if optional argument LIST is non-nil, it
4762 specifies the list of buffers to kill, asking for approval for each one."
4765 (setq list (buffer-list)))
4767 (let* ((buffer (car list))
4768 (name (buffer-name buffer)))
4769 (and name ; Can be nil for an indirect buffer
4770 ; if we killed the base buffer.
4771 (not (string-equal name ""))
4772 (/= (aref name 0) ?\s)
4773 (kill-buffer-ask buffer)))
4774 (setq list (cdr list))))
4776 (defun kill-matching-buffers (regexp &optional internal-too)
4777 "Kill buffers whose name matches the specified regexp.
4778 The optional second argument indicates whether to kill internal buffers too."
4779 (interactive "sKill buffers matching this regular expression: \nP")
4780 (dolist (buffer (buffer-list))
4781 (let ((name (buffer-name buffer)))
4782 (when (and name (not (string-equal name ""))
4783 (or internal-too (/= (aref name 0) ?\s))
4784 (string-match regexp name))
4785 (kill-buffer-ask buffer)))))
4788 (defun auto-save-mode (arg)
4789 "Toggle auto-saving of contents of current buffer.
4790 With prefix argument ARG, turn auto-saving on if positive, else off."
4792 (setq buffer-auto-save-file-name
4794 (or (not buffer-auto-save-file-name)
4795 ;; If auto-save is off because buffer has shrunk,
4796 ;; then toggling should turn it on.
4797 (< buffer-saved-size 0))
4798 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
4799 (if (and buffer-file-name auto-save-visited-file-name
4800 (not buffer-read-only))
4802 (make-auto-save-file-name))))
4803 ;; If -1 was stored here, to temporarily turn off saving,
4805 (and (< buffer-saved-size 0)
4806 (setq buffer-saved-size 0))
4808 (message "Auto-save %s (in this buffer)"
4809 (if buffer-auto-save-file-name "on" "off")))
4810 buffer-auto-save-file-name)
4812 (defun rename-auto-save-file ()
4813 "Adjust current buffer's auto save file name for current conditions.
4814 Also rename any existing auto save file, if it was made in this session."
4815 (let ((osave buffer-auto-save-file-name))
4816 (setq buffer-auto-save-file-name
4817 (make-auto-save-file-name))
4818 (if (and osave buffer-auto-save-file-name
4819 (not (string= buffer-auto-save-file-name buffer-file-name))
4820 (not (string= buffer-auto-save-file-name osave))
4821 (file-exists-p osave)
4822 (recent-auto-save-p))
4823 (rename-file osave buffer-auto-save-file-name t))))
4825 (defun make-auto-save-file-name ()
4826 "Return file name to use for auto-saves of current buffer.
4827 Does not consider `auto-save-visited-file-name' as that variable is checked
4828 before calling this function. You can redefine this for customization.
4829 See also `auto-save-file-name-p'."
4830 (if buffer-file-name
4831 (let ((handler (find-file-name-handler buffer-file-name
4832 'make-auto-save-file-name)))
4834 (funcall handler 'make-auto-save-file-name)
4835 (let ((list auto-save-file-name-transforms)
4836 (filename buffer-file-name)
4838 ;; Apply user-specified translations
4839 ;; to the file name.
4840 (while (and list (not result))
4841 (if (string-match (car (car list)) filename)
4842 (setq result (replace-match (cadr (car list)) t nil
4844 uniq (car (cddr (car list)))))
4845 (setq list (cdr list)))
4848 (setq filename (concat
4849 (file-name-directory result)
4850 (subst-char-in-string
4852 (replace-regexp-in-string "!" "!!"
4854 (setq filename result)))
4856 (if (and (eq system-type 'ms-dos)
4857 (not (msdos-long-file-names)))
4858 ;; We truncate the file name to DOS 8+3 limits
4859 ;; before doing anything else, because the regexp
4860 ;; passed to string-match below cannot handle
4861 ;; extensions longer than 3 characters, multiple
4862 ;; dots, and other atrocities.
4863 (let ((fn (dos-8+3-filename
4864 (file-name-nondirectory buffer-file-name))))
4866 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
4868 (concat (file-name-directory buffer-file-name)
4869 "#" (match-string 1 fn)
4870 "." (match-string 3 fn) "#"))
4871 (concat (file-name-directory filename)
4873 (file-name-nondirectory filename)
4875 ;; Make sure auto-save file names don't contain characters
4876 ;; invalid for the underlying filesystem.
4877 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4878 ;; Don't modify remote (ange-ftp) filenames
4879 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
4880 (convert-standard-filename result)
4883 ;; Deal with buffers that don't have any associated files. (Mail
4884 ;; mode tends to create a good number of these.)
4886 (let ((buffer-name (buffer-name))
4889 ;; Restrict the characters used in the file name to those which
4890 ;; are known to be safe on all filesystems, url-encoding the
4892 ;; We do this on all platforms, because even if we are not
4893 ;; running on DOS/Windows, the current directory may be on a
4894 ;; mounted VFAT filesystem, such as a USB memory stick.
4895 (while (string-match "[^A-Za-z0-9-_.~#+]" buffer-name limit)
4896 (let* ((character (aref buffer-name (match-beginning 0)))
4898 ;; For multibyte characters, this will produce more than
4899 ;; 2 hex digits, so is not true URL encoding.
4900 (format "%%%02X" character)))
4901 (setq buffer-name (replace-match replacement t t buffer-name))
4902 (setq limit (1+ (match-end 0)))))
4903 ;; Generate the file name.
4908 (format "#%s#" buffer-name)
4909 ;; Try a few alternative directories, to get one we can
4912 ((file-writable-p default-directory) default-directory)
4913 ((file-writable-p "/var/tmp/") "/var/tmp/")
4915 (if (and (memq system-type '(ms-dos windows-nt cygwin))
4916 ;; Don't modify remote (ange-ftp) filenames
4917 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
4918 ;; The call to convert-standard-filename is in case
4919 ;; buffer-name includes characters not allowed by the
4920 ;; DOS/Windows filesystems. make-temp-file writes to the
4921 ;; file it creates, so we must fix the file name _before_
4922 ;; make-temp-file is called.
4923 (convert-standard-filename fname)
4926 ;; make-temp-file creates the file,
4927 ;; but we don't want it to exist until we do an auto-save.
4929 (delete-file file-name)
4933 (defun auto-save-file-name-p (filename)
4934 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
4935 FILENAME should lack slashes. You can redefine this for customization."
4936 (string-match "^#.*#$" filename))
4938 (defun wildcard-to-regexp (wildcard)
4939 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
4940 The generated regexp will match a filename only if the filename
4941 matches that wildcard according to shell rules. Only wildcards known
4942 by `sh' are supported."
4943 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
4944 ;; Copy the initial run of non-special characters.
4945 (result (substring wildcard 0 i))
4946 (len (length wildcard)))
4947 ;; If no special characters, we're almost done.
4950 (let ((ch (aref wildcard i))
4958 (eq (aref wildcard (1+ i)) ?\]))
4960 ((eq ch ?\[) ; [...] maps to regexp char class
4965 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
4968 (if (eq (aref wildcard i) ?\])
4973 ((eq (aref wildcard i) ?^)
4974 ;; Found "[^". Insert a `\0' character
4975 ;; (which cannot happen in a filename)
4976 ;; into the character class, so that `^'
4977 ;; is not the first character after `[',
4978 ;; and thus non-special in a regexp.
4982 ((eq (aref wildcard i) ?\])
4983 ;; I don't think `]' can appear in a
4984 ;; character class in a wildcard, but
4985 ;; let's be general here.
4990 (prog1 ; copy everything upto next `]'.
4993 (setq j (string-match
4995 (setq i (if j (1- j) (1- len)))))))
4997 ((eq ch ?*) "[^\000]*")
5001 ((eq ch ?\\) "\\\\") ; probably cannot happen...
5002 ((eq ch ??) "[^\000]")
5003 (t (char-to-string ch)))))
5005 ;; Shell wildcards should match the entire filename,
5006 ;; not its part. Make the regexp say so.
5007 (concat "\\`" result "\\'")))
5009 (defcustom list-directory-brief-switches
5010 (if (eq system-type 'vax-vms) "" "-CF")
5011 "Switches for `list-directory' to pass to `ls' for brief listing."
5015 (defcustom list-directory-verbose-switches
5016 (if (eq system-type 'vax-vms)
5017 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
5019 "Switches for `list-directory' to pass to `ls' for verbose listing."
5023 (defun file-expand-wildcards (pattern &optional full)
5024 "Expand wildcard pattern PATTERN.
5025 This returns a list of file names which match the pattern.
5027 If PATTERN is written as an absolute file name,
5028 the values are absolute also.
5030 If PATTERN is written as a relative file name, it is interpreted
5031 relative to the current default directory, `default-directory'.
5032 The file names returned are normally also relative to the current
5033 default directory. However, if FULL is non-nil, they are absolute."
5035 (let* ((nondir (file-name-nondirectory pattern))
5036 (dirpart (file-name-directory pattern))
5037 ;; A list of all dirs that DIRPART specifies.
5038 ;; This can be more than one dir
5039 ;; if DIRPART contains wildcards.
5040 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
5041 (mapcar 'file-name-as-directory
5042 (file-expand-wildcards (directory-file-name dirpart)))
5046 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
5047 (file-directory-p (directory-file-name (car dirs))))
5048 (let ((this-dir-contents
5049 ;; Filter out "." and ".."
5051 (mapcar #'(lambda (name)
5052 (unless (string-match "\\`\\.\\.?\\'"
5053 (file-name-nondirectory name))
5055 (directory-files (or (car dirs) ".") full
5056 (wildcard-to-regexp nondir))))))
5059 (if (and (car dirs) (not full))
5060 (mapcar (function (lambda (name) (concat (car dirs) name)))
5064 (setq dirs (cdr dirs)))
5067 (defun list-directory (dirname &optional verbose)
5068 "Display a list of files in or matching DIRNAME, a la `ls'.
5069 DIRNAME is globbed by the shell if necessary.
5070 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
5071 Actions controlled by variables `list-directory-brief-switches'
5072 and `list-directory-verbose-switches'."
5073 (interactive (let ((pfx current-prefix-arg))
5074 (list (read-file-name (if pfx "List directory (verbose): "
5075 "List directory (brief): ")
5076 nil default-directory nil)
5078 (let ((switches (if verbose list-directory-verbose-switches
5079 list-directory-brief-switches))
5081 (or dirname (setq dirname default-directory))
5082 (setq dirname (expand-file-name dirname))
5083 (with-output-to-temp-buffer "*Directory*"
5084 (setq buffer standard-output)
5085 (buffer-disable-undo standard-output)
5086 (princ "Directory ")
5090 (set-buffer "*Directory*")
5091 (let ((wildcard (not (file-directory-p dirname))))
5092 (insert-directory dirname switches wildcard (not wildcard)))))
5093 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
5094 (with-current-buffer buffer
5095 (setq default-directory
5096 (if (file-directory-p dirname)
5097 (file-name-as-directory dirname)
5098 (file-name-directory dirname))))))
5100 (defun shell-quote-wildcard-pattern (pattern)
5101 "Quote characters special to the shell in PATTERN, leave wildcards alone.
5103 PATTERN is assumed to represent a file-name wildcard suitable for the
5104 underlying filesystem. For Unix and GNU/Linux, the characters from the
5105 set [ \\t\\n;<>&|()'\"#$] are quoted with a backslash; for DOS/Windows, all
5106 the parts of the pattern which don't include wildcard characters are
5107 quoted with double quotes.
5108 Existing quote characters in PATTERN are left alone, so you can pass
5109 PATTERN that already quotes some of the special characters."
5112 ((memq system-type '(ms-dos windows-nt cygwin))
5113 ;; DOS/Windows don't allow `"' in file names. So if the
5114 ;; argument has quotes, we can safely assume it is already
5115 ;; quoted by the caller.
5116 (if (or (string-match "[\"]" pattern)
5117 ;; We quote [&()#$'] in case their shell is a port of a
5118 ;; Unixy shell. We quote [,=+] because stock DOS and
5119 ;; Windows shells require that in some cases, such as
5120 ;; passing arguments to batch files that use positional
5121 ;; arguments like %1.
5122 (not (string-match "[ \t;&()#$',=+]" pattern)))
5127 (while (string-match "[*?]+" pattern beg)
5128 (setq end (match-beginning 0)
5129 result (concat result (substring pattern beg end)
5131 (substring pattern end (match-end 0))
5134 (concat result (substring pattern beg) "\""))))
5137 (while (string-match "[ \t\n;<>&|()'\"#$]" pattern beg)
5139 (concat (substring pattern 0 (match-beginning 0))
5141 (substring pattern (match-beginning 0)))
5142 beg (1+ (match-end 0)))))
5146 (defvar insert-directory-program "ls"
5147 "Absolute or relative name of the `ls' program used by `insert-directory'.")
5149 (defcustom directory-free-space-program "df"
5150 "Program to get the amount of free space on a file system.
5151 We assume the output has the format of `df'.
5152 The value of this variable must be just a command name or file name;
5153 if you want to specify options, use `directory-free-space-args'.
5155 A value of nil disables this feature.
5157 If the function `file-system-info' is defined, it is always used in
5158 preference to the program given by this variable."
5159 :type '(choice (string :tag "Program") (const :tag "None" nil))
5162 (defcustom directory-free-space-args
5163 (if (eq system-type 'darwin) "-k" "-Pk")
5164 "Options to use when running `directory-free-space-program'."
5168 (defun get-free-disk-space (dir)
5169 "Return the amount of free space on directory DIR's file system.
5170 The result is a string that gives the number of free 1KB blocks,
5171 or nil if the system call or the program which retrieve the information
5172 fail. It returns also nil when DIR is a remote directory.
5174 This function calls `file-system-info' if it is available, or invokes the
5175 program specified by `directory-free-space-program' if that is non-nil."
5176 (when (not (file-remote-p dir))
5177 ;; Try to find the number of free blocks. Non-Posix systems don't
5178 ;; always have df, but might have an equivalent system call.
5179 (if (fboundp 'file-system-info)
5180 (let ((fsinfo (file-system-info dir)))
5182 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
5185 (when (and directory-free-space-program
5186 (eq 0 (call-process directory-free-space-program
5188 directory-free-space-args
5190 ;; Usual format is a header line followed by a line of
5192 (goto-char (point-min))
5196 ;; Move to the end of the "available blocks" number.
5197 (skip-chars-forward "^ \t")
5199 ;; Copy it into AVAILABLE.
5200 (let ((end (point)))
5202 (buffer-substring (point) end))))))))))
5204 ;; The following expression replaces `dired-move-to-filename-regexp'.
5205 (defvar directory-listing-before-filename-regexp
5206 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
5207 (l-or-quote "\\([A-Za-z']\\|[^\0-\177]\\)")
5208 ;; In some locales, month abbreviations are as short as 2 letters,
5209 ;; and they can be followed by ".".
5210 ;; In Breton, a month name can include a quote character.
5211 (month (concat l-or-quote l-or-quote "+\\.?"))
5213 (yyyy "[0-9][0-9][0-9][0-9]")
5215 (HH:MM "[ 0-2][0-9][:.][0-5][0-9]")
5216 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
5217 (zone "[-+][0-2][0-9][0-5][0-9]")
5218 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
5219 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
5220 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
5221 "\\|" yyyy "-" iso-mm-dd "\\)"))
5222 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
5224 "\\(" HH:MM "\\|" yyyy "\\)"))
5225 (western-comma (concat month s "+" dd "," s "+" yyyy))
5226 ;; Japanese MS-Windows ls-lisp has one-digit months, and
5227 ;; omits the Kanji characters after month and day-of-month.
5228 ;; On Mac OS X 10.3, the date format in East Asian locales is
5229 ;; day-of-month digits followed by month digits.
5232 (concat "\\(" mm l "?" s dd l "?" s "+"
5233 "\\|" dd s mm s "+" "\\)"
5234 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
5235 ;; The "[0-9]" below requires the previous column to end in a digit.
5236 ;; This avoids recognizing `1 may 1997' as a date in the line:
5237 ;; -r--r--r-- 1 may 1997 1168 Oct 19 16:49 README
5239 ;; The "[BkKMGTPEZY]?" below supports "ls -alh" output.
5240 ;; The ".*" below finds the last match if there are multiple matches.
5241 ;; This avoids recognizing `jservice 10 1024' as a date in the line:
5242 ;; drwxr-xr-x 3 jservice 10 1024 Jul 2 1997 esg-host
5244 ;; vc dired listings provide the state or blanks between file
5245 ;; permissions and date. The state is always surrounded by
5247 ;; -rw-r--r-- (modified) 2005-10-22 21:25 files.el
5248 ;; This is not supported yet.
5249 (concat ".*[0-9][BkKMGTPEZY]?" s
5250 "\\(" western "\\|" western-comma "\\|" east-asian "\\|" iso "\\)"
5252 "Regular expression to match up to the file name in a directory listing.
5253 The default value is designed to recognize dates and times
5254 regardless of the language.")
5256 (defvar insert-directory-ls-version 'unknown)
5259 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
5260 ;; FULL-DIRECTORY-P is nil.
5261 ;; The single line of output must display FILE's name as it was
5262 ;; given, namely, an absolute path name.
5263 ;; - must insert exactly one line for each file if WILDCARD or
5264 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
5265 ;; before the file lines, plus optional text after the file lines.
5266 ;; Lines are delimited by "\n", so filenames containing "\n" are not
5268 ;; File lines should display the basename.
5269 ;; - must be consistent with
5270 ;; - functions dired-move-to-filename, (these two define what a file line is)
5271 ;; dired-move-to-end-of-filename,
5272 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
5273 ;; dired-insert-headerline
5274 ;; dired-after-subdir-garbage (defines what a "total" line is)
5275 ;; - variable dired-subdir-regexp
5276 ;; - may be passed "--dired" as the first argument in SWITCHES.
5277 ;; Filename handlers might have to remove this switch if their
5278 ;; "ls" command does not support it.
5279 (defun insert-directory (file switches &optional wildcard full-directory-p)
5280 "Insert directory listing for FILE, formatted according to SWITCHES.
5281 Leaves point after the inserted text.
5282 SWITCHES may be a string of options, or a list of strings
5283 representing individual options.
5284 Optional third arg WILDCARD means treat FILE as shell wildcard.
5285 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
5286 switches do not contain `d', so that a full listing is expected.
5288 This works by running a directory listing program
5289 whose name is in the variable `insert-directory-program'.
5290 If WILDCARD, it also runs the shell specified by `shell-file-name'.
5292 When SWITCHES contains the long `--dired' option, this function
5293 treats it specially, for the sake of dired. However, the
5294 normally equivalent short `-D' option is just passed on to
5295 `insert-directory-program', as any other option."
5296 ;; We need the directory in order to find the right handler.
5297 (let ((handler (find-file-name-handler (expand-file-name file)
5298 'insert-directory)))
5300 (funcall handler 'insert-directory file switches
5301 wildcard full-directory-p)
5302 (if (eq system-type 'vax-vms)
5303 (vms-read-directory file switches (current-buffer))
5304 (let (result (beg (point)))
5306 ;; Read the actual directory using `insert-directory-program'.
5307 ;; RESULT gets the status code.
5308 (let* (;; We at first read by no-conversion, then after
5309 ;; putting text property `dired-filename, decode one
5310 ;; bunch by one to preserve that property.
5311 (coding-system-for-read 'no-conversion)
5312 ;; This is to control encoding the arguments in call-process.
5313 (coding-system-for-write
5314 (and enable-multibyte-characters
5315 (or file-name-coding-system
5316 default-file-name-coding-system))))
5319 ;; Run ls in the directory part of the file pattern
5320 ;; using the last component as argument.
5321 (let ((default-directory
5322 (if (file-name-absolute-p file)
5323 (file-name-directory file)
5324 (file-name-directory (expand-file-name file))))
5325 (pattern (file-name-nondirectory file)))
5327 shell-file-name nil t nil
5329 (concat (if (memq system-type '(ms-dos windows-nt))
5331 "\\") ; Disregard Unix shell aliases!
5332 insert-directory-program
5334 (if (stringp switches)
5336 (mapconcat 'identity switches " "))
5338 ;; Quote some characters that have
5339 ;; special meanings in shells; but
5340 ;; don't quote the wildcards--we want
5341 ;; them to be special. We also
5342 ;; currently don't quote the quoting
5343 ;; characters in case people want to
5344 ;; use them explicitly to quote
5345 ;; wildcard characters.
5346 (shell-quote-wildcard-pattern pattern))))
5347 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
5348 ;; directory if FILE is a symbolic link.
5349 (apply 'call-process
5350 insert-directory-program nil t nil
5352 (if (listp switches) switches
5353 (unless (equal switches "")
5354 ;; Split the switches at any spaces so we can
5355 ;; pass separate options as separate args.
5356 (split-string switches)))
5357 ;; Avoid lossage if FILE starts with `-'.
5360 (if (string-match "\\`~" file)
5361 (setq file (expand-file-name file)))
5363 (if full-directory-p
5364 (concat (file-name-as-directory file) ".")
5367 ;; If we got "//DIRED//" in the output, it means we got a real
5368 ;; directory listing, even if `ls' returned nonzero.
5369 ;; So ignore any errors.
5370 (when (if (stringp switches)
5371 (string-match "--dired\\>" switches)
5372 (member "--dired" switches))
5375 (when (looking-at "//SUBDIRED//")
5377 (if (looking-at "//DIRED//")
5380 (when (and (not (eq 0 result))
5381 (eq insert-directory-ls-version 'unknown))
5382 ;; The first time ls returns an error,
5383 ;; find the version numbers of ls,
5384 ;; and set insert-directory-ls-version
5385 ;; to > if it is more than 5.2.1, < if it is less, nil if it
5386 ;; is equal or if the info cannot be obtained.
5387 ;; (That can mean it isn't GNU ls.)
5390 (call-process "ls" nil t nil "--version")
5392 (if (string-match "ls (.*utils) \\([0-9.]*\\)$" version-out)
5393 (let* ((version (match-string 1 version-out))
5394 (split (split-string version "[.]"))
5395 (numbers (mapcar 'string-to-number split))
5398 (while (and (not comparison) (or numbers min))
5400 (setq comparison '>))
5402 (setq comparison '<))
5403 ((> (car numbers) (car min))
5404 (setq comparison '>))
5405 ((< (car numbers) (car min))
5406 (setq comparison '<))
5408 (setq numbers (cdr numbers)
5410 (setq insert-directory-ls-version (or comparison '=)))
5411 (setq insert-directory-ls-version nil))))
5413 ;; For GNU ls versions 5.2.2 and up, ignore minor errors.
5414 (when (and (eq 1 result) (eq insert-directory-ls-version '>))
5417 ;; If `insert-directory-program' failed, signal an error.
5418 (unless (eq 0 result)
5419 ;; Delete the error message it may have output.
5420 (delete-region beg (point))
5421 ;; On non-Posix systems, we cannot open a directory, so
5422 ;; don't even try, because that will always result in
5423 ;; the ubiquitous "Access denied". Instead, show the
5424 ;; command line so the user can try to guess what went wrong.
5425 (if (and (file-directory-p file)
5426 (memq system-type '(ms-dos windows-nt)))
5428 "Reading directory: \"%s %s -- %s\" exited with status %s"
5429 insert-directory-program
5430 (if (listp switches) (concat switches) switches)
5432 ;; Unix. Access the file to get a suitable error.
5433 (access-file file "Reading directory")
5434 (error "Listing directory failed but `access-file' worked")))
5436 (when (if (stringp switches)
5437 (string-match "--dired\\>" switches)
5438 (member "--dired" switches))
5439 ;; The following overshoots by one line for an empty
5440 ;; directory listed with "--dired", but without "-a"
5441 ;; switch, where the ls output contains a
5442 ;; "//DIRED-OPTIONS//" line, but no "//DIRED//" line.
5443 ;; We take care of that case later.
5445 (when (looking-at "//SUBDIRED//")
5446 (delete-region (point) (progn (forward-line 1) (point)))
5448 (if (looking-at "//DIRED//")
5449 (let ((end (line-end-position))
5452 ;; Find all the lines that are error messages,
5453 ;; and record the bounds of each one.
5455 (while (< (point) linebeg)
5456 (or (eql (following-char) ?\s)
5457 (push (list (point) (line-end-position)) error-lines))
5459 (setq error-lines (nreverse error-lines))
5460 ;; Now read the numeric positions of file names.
5464 (while (< (point) end)
5465 (let ((start (insert-directory-adj-pos
5466 (+ beg (read (current-buffer)))
5468 (end (insert-directory-adj-pos
5469 (+ beg (read (current-buffer)))
5471 (if (memq (char-after end) '(?\n ?\s))
5472 ;; End is followed by \n or by " -> ".
5473 (put-text-property start end 'dired-filename t)
5474 ;; It seems that we can't trust ls's output as to
5475 ;; byte positions of filenames.
5476 (put-text-property beg (point) 'dired-filename nil)
5480 (delete-region (point) (progn (forward-line 1) (point))))
5481 ;; Take care of the case where the ls output contains a
5482 ;; "//DIRED-OPTIONS//"-line, but no "//DIRED//"-line
5483 ;; and we went one line too far back (see above).
5485 (if (looking-at "//DIRED-OPTIONS//")
5486 (delete-region (point) (progn (forward-line 1) (point)))))
5488 ;; Now decode what read if necessary.
5489 (let ((coding (or coding-system-for-read
5490 file-name-coding-system
5491 default-file-name-coding-system
5495 (when (and enable-multibyte-characters
5496 (not (memq (coding-system-base coding)
5497 '(raw-text no-conversion))))
5498 ;; If no coding system is specified or detection is
5499 ;; requested, detect the coding.
5500 (if (eq (coding-system-base coding) 'undecided)
5501 (setq coding (detect-coding-region beg (point) t)))
5502 (if (not (eq (coding-system-base coding) 'undecided))
5505 (coding-system-change-eol-conversion coding 'unix))
5506 (narrow-to-region beg (point))
5507 (goto-char (point-min))
5510 val (get-text-property (point) 'dired-filename))
5511 (goto-char (next-single-property-change
5512 (point) 'dired-filename nil (point-max)))
5513 ;; Force no eol conversion on a file name, so
5514 ;; that CR is preserved.
5515 (decode-coding-region pos (point)
5516 (if val coding-no-eol coding))
5518 (put-text-property pos (point)
5519 'dired-filename t)))))))
5521 (if full-directory-p
5522 ;; Try to insert the amount of free space.
5525 ;; First find the line to put it on.
5526 (when (re-search-forward "^ *\\(total\\)" nil t)
5527 (let ((available (get-free-disk-space ".")))
5529 ;; Replace "total" with "used", to avoid confusion.
5530 (replace-match "total used in directory" nil nil nil 1)
5532 (insert " available " available)))))))))))
5534 (defun insert-directory-adj-pos (pos error-lines)
5535 "Convert `ls --dired' file name position value POS to a buffer position.
5536 File name position values returned in ls --dired output
5537 count only stdout; they don't count the error messages sent to stderr.
5538 So this function converts to them to real buffer positions.
5539 ERROR-LINES is a list of buffer positions of error message lines,
5540 of the form (START END)."
5541 (while (and error-lines (< (caar error-lines) pos))
5542 (setq pos (+ pos (- (nth 1 (car error-lines)) (nth 0 (car error-lines)))))
5546 (defun insert-directory-safely (file switches
5547 &optional wildcard full-directory-p)
5548 "Insert directory listing for FILE, formatted according to SWITCHES.
5550 Like `insert-directory', but if FILE does not exist, it inserts a
5551 message to that effect instead of signaling an error."
5552 (if (file-exists-p file)
5553 (insert-directory file switches wildcard full-directory-p)
5554 ;; Simulate the message printed by `ls'.
5555 (insert (format "%s: No such file or directory\n" file))))
5557 (defvar kill-emacs-query-functions nil
5558 "Functions to call with no arguments to query about killing Emacs.
5559 If any of these functions returns nil, killing Emacs is cancelled.
5560 `save-buffers-kill-emacs' calls these functions, but `kill-emacs',
5561 the low level primitive, does not. See also `kill-emacs-hook'.")
5563 (defcustom confirm-kill-emacs nil
5564 "How to ask for confirmation when leaving Emacs.
5565 If nil, the default, don't ask at all. If the value is non-nil, it should
5566 be a predicate function such as `yes-or-no-p'."
5567 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
5568 (const :tag "Ask with y-or-n-p" y-or-n-p)
5569 (const :tag "Don't confirm" nil))
5573 (defun save-buffers-kill-emacs (&optional arg)
5574 "Offer to save each buffer, then kill this Emacs process.
5575 With prefix arg, silently save all file-visiting buffers, then kill."
5577 (save-some-buffers arg t)
5578 (and (or (not (memq t (mapcar (function
5579 (lambda (buf) (and (buffer-file-name buf)
5580 (buffer-modified-p buf))))
5582 (yes-or-no-p "Modified buffers exist; exit anyway? "))
5583 (or (not (fboundp 'process-list))
5584 ;; process-list is not defined on VMS.
5585 (let ((processes (process-list))
5588 (and (memq (process-status (car processes)) '(run stop open listen))
5589 (process-query-on-exit-flag (car processes))
5591 (setq processes (cdr processes)))
5594 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
5595 ;; Query the user for other things, perhaps.
5596 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
5597 (or (null confirm-kill-emacs)
5598 (funcall confirm-kill-emacs "Really exit Emacs? "))
5601 (defun save-buffers-kill-terminal (&optional arg)
5602 "Offer to save each buffer, then kill the current connection.
5603 If the current frame has no client, kill Emacs itself.
5605 With prefix arg, silently save all file-visiting buffers, then kill.
5607 If emacsclient was started with a list of filenames to edit, then
5608 only these files will be asked to be saved."
5610 (let ((proc (frame-parameter (selected-frame) 'client))
5611 (frame (selected-frame)))
5613 (save-buffers-kill-emacs)
5614 (server-save-buffers-kill-terminal proc arg))))
5617 ;; We use /: as a prefix to "quote" a file name
5618 ;; so that magic file name handlers will not apply to it.
5620 (setq file-name-handler-alist
5621 (cons '("\\`/:" . file-name-non-special)
5622 file-name-handler-alist))
5624 ;; We depend on being the last handler on the list,
5625 ;; so that anything else which does need handling
5626 ;; has been handled already.
5627 ;; So it is safe for us to inhibit *all* magic file name handlers.
5629 (defun file-name-non-special (operation &rest arguments)
5630 (let ((file-name-handler-alist nil)
5632 (if (eq operation 'insert-directory)
5633 (directory-file-name
5635 (unhandled-file-name-directory default-directory)))
5637 ;; Get a list of the indices of the args which are file names.
5639 (cdr (or (assq operation
5640 ;; The first six are special because they
5641 ;; return a file name. We want to include the /:
5642 ;; in the return value.
5643 ;; So just avoid stripping it in the first place.
5644 '((expand-file-name . nil)
5645 (file-name-directory . nil)
5646 (file-name-as-directory . nil)
5647 (directory-file-name . nil)
5648 (file-name-sans-versions . nil)
5649 (find-backup-file-name . nil)
5650 ;; `identity' means just return the first arg
5651 ;; not stripped of its quoting.
5652 (substitute-in-file-name identity)
5653 ;; `add' means add "/:" to the result.
5654 (file-truename add 0)
5655 ;; `quote' means add "/:" to buffer-file-name.
5656 (insert-file-contents quote 0)
5657 ;; `unquote-then-quote' means set buffer-file-name
5658 ;; temporarily to unquoted filename.
5659 (verify-visited-file-modtime unquote-then-quote)
5660 ;; List the arguments which are filenames.
5661 (file-name-completion 1)
5662 (file-name-all-completions 1)
5666 (make-symbolic-link 0 1)
5667 (add-name-to-file 0 1)))
5668 ;; For all other operations, treat the first argument only
5669 ;; as the file name.
5672 ;; Copy ARGUMENTS so we can replace elements in it.
5673 (arguments (copy-sequence arguments)))
5674 (if (symbolp (car file-arg-indices))
5675 (setq method (pop file-arg-indices)))
5676 ;; Strip off the /: from the file names that have it.
5678 (while (consp file-arg-indices)
5679 (let ((pair (nthcdr (car file-arg-indices) arguments)))
5681 (string-match "\\`/:" (car pair))
5683 (if (= (length (car pair)) 2)
5685 (substring (car pair) 2)))))
5686 (setq file-arg-indices (cdr file-arg-indices))))
5687 (cond ((eq method 'identity)
5690 (concat "/:" (apply operation arguments)))
5693 (apply operation arguments)
5694 (setq buffer-file-name (concat "/:" buffer-file-name))))
5695 ((eq method 'unquote-then-quote)
5697 (setq buffer-file-name (substring buffer-file-name 2))
5698 (setq res (apply operation arguments))
5699 (setq buffer-file-name (concat "/:" buffer-file-name))
5702 (apply operation arguments)))))
5704 ;; Symbolic modes and read-file-modes.
5706 (defun file-modes-char-to-who (char)
5707 "Convert CHAR to a who-mask from a symbolic mode notation.
5708 CHAR is in [ugoa] and represents the users on which rights are applied."
5709 (cond ((= char ?u) #o4700)
5710 ((= char ?g) #o2070)
5711 ((= char ?o) #o1007)
5712 ((= char ?a) #o7777)
5713 (t (error "%c: bad `who' character" char))))
5715 (defun file-modes-char-to-right (char &optional from)
5716 "Convert CHAR to a right-mask from a symbolic mode notation.
5717 CHAR is in [rwxXstugo] and represents a right.
5718 If CHAR is in [Xugo], the value is extracted from FROM (or 0 if nil)."
5719 (or from (setq from 0))
5720 (cond ((= char ?r) #o0444)
5721 ((= char ?w) #o0222)
5722 ((= char ?x) #o0111)
5723 ((= char ?s) #o1000)
5724 ((= char ?t) #o6000)
5725 ;; Rights relative to the previous file modes.
5726 ((= char ?X) (if (= (logand from #o111) 0) 0 #o0111))
5727 ((= char ?u) (let ((uright (logand #o4700 from)))
5728 (+ uright (/ uright #o10) (/ uright #o100))))
5729 ((= char ?g) (let ((gright (logand #o2070 from)))
5730 (+ gright (/ gright #o10) (* gright #o10))))
5731 ((= char ?o) (let ((oright (logand #o1007 from)))
5732 (+ oright (* oright #o10) (* oright #o100))))
5733 (t (error "%c: bad right character" char))))
5735 (defun file-modes-rights-to-number (rights who-mask &optional from)
5736 "Convert a right string to a right-mask from a symbolic modes notation.
5737 RIGHTS is the right string, it should match \"([+=-][rwxXstugo]+)+\".
5738 WHO-MASK is the mask number of the users on which the rights are to be applied.
5739 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5740 (let* ((num-rights (or from 0))
5741 (list-rights (string-to-list rights))
5742 (op (pop list-rights)))
5743 (while (memq op '(?+ ?- ?=))
5746 (while (memq (setq char-right (pop list-rights))
5747 '(?r ?w ?x ?X ?s ?t ?u ?g ?o))
5750 (file-modes-char-to-right char-right num-rights))))
5751 (setq num-right (logand who-mask num-right)
5753 (cond ((= op ?+) (logior num-rights num-right))
5754 ((= op ?-) (logand num-rights (lognot num-right)))
5755 (t (logior (logand num-rights (lognot who-mask)) num-right)))
5759 (defun file-modes-symbolic-to-number (modes &optional from)
5760 "Convert symbolic file modes to numeric file modes.
5761 MODES is the string to convert, it should match
5762 \"[ugoa]*([+-=][rwxXstugo]+)+,...\".
5763 See (info \"(coreutils)File permissions\") for more information on this
5765 FROM (or 0 if nil) is the orginal modes of the file to be chmod'ed."
5767 (let ((case-fold-search nil)
5768 (num-modes (or from 0)))
5769 (while (/= (string-to-char modes) 0)
5770 (if (string-match "^\\([ugoa]*\\)\\([+=-][rwxXstugo]+\\)+\\(,\\|\\)" modes)
5771 (let ((num-who (apply 'logior 0
5772 (mapcar 'file-modes-char-to-who
5773 (match-string 1 modes)))))
5775 (setq num-who (default-file-modes)))
5777 (file-modes-rights-to-number (substring modes (match-end 1))
5779 modes (substring modes (match-end 3))))
5780 (error "Parse error in modes near `%s'" (substring modes 0))))
5783 (defun read-file-modes (&optional prompt orig-file)
5784 "Read file modes in octal or symbolic notation.
5785 PROMPT is used as the prompt, default to `File modes (octal or symbolic): '.
5786 ORIG-FILE is the original file of which modes will be change."
5787 (let* ((modes (or (if orig-file (file-modes orig-file) 0)
5788 (error "File not found")))
5789 (value (read-string (or prompt "File modes (octal or symbolic): "))))
5791 (if (string-match "^[0-7]+" value)
5792 (string-to-number value 8)
5793 (file-modes-symbolic-to-number value modes)))))
5796 ;; Trash can handling.
5797 (defcustom trash-directory "~/.Trash"
5798 "Directory for `move-file-to-trash' to move files and directories to.
5799 This directory is only used when the function `system-move-file-to-trash' is
5800 not defined. Relative paths are interpreted relative to `default-directory'.
5801 See also `delete-by-moving-to-trash'."
5806 (declare-function system-move-file-to-trash "w32fns.c" (filename))
5808 (defun move-file-to-trash (filename)
5809 "Move file (or directory) name FILENAME to the trash.
5810 This function is called by `delete-file' and `delete-directory' when
5811 `delete-by-moving-to-trash' is non-nil. On platforms that define
5812 `system-move-file-to-trash', that function is used to move FILENAME to the
5813 system trash, otherwise FILENAME is moved to `trash-directory'.
5814 Returns nil on success."
5815 (interactive "fMove file to trash: ")
5817 ((fboundp 'system-move-file-to-trash)
5818 (system-move-file-to-trash filename))
5820 (let* ((trash-dir (expand-file-name trash-directory))
5821 (fn (directory-file-name (expand-file-name filename)))
5822 (fn-nondir (file-name-nondirectory fn))
5823 (new-fn (expand-file-name fn-nondir trash-dir)))
5824 (or (file-directory-p trash-dir)
5825 (make-directory trash-dir t))
5826 (and (file-exists-p new-fn)
5827 ;; make new-fn unique.
5828 ;; example: "~/.Trash/abc.txt" -> "~/.Trash/abc.txt.~1~"
5829 (let ((version-control t))
5830 (setq new-fn (car (find-backup-file-name new-fn)))))
5831 ;; stop processing if fn is same or parent directory of trash-dir.
5832 (and (string-match fn trash-dir)
5833 (error "Filename `%s' is same or parent directory of trash-directory"
5835 (rename-file fn new-fn)))))
5838 (define-key ctl-x-map "\C-f" 'find-file)
5839 (define-key ctl-x-map "\C-r" 'find-file-read-only)
5840 (define-key ctl-x-map "\C-v" 'find-alternate-file)
5841 (define-key ctl-x-map "\C-s" 'save-buffer)
5842 (define-key ctl-x-map "s" 'save-some-buffers)
5843 (define-key ctl-x-map "\C-w" 'write-file)
5844 (define-key ctl-x-map "i" 'insert-file)
5845 (define-key esc-map "~" 'not-modified)
5846 (define-key ctl-x-map "\C-d" 'list-directory)
5847 (define-key ctl-x-map "\C-c" 'save-buffers-kill-terminal)
5848 (define-key ctl-x-map "\C-q" 'toggle-read-only)
5850 (define-key ctl-x-4-map "f" 'find-file-other-window)
5851 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
5852 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
5853 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
5854 (define-key ctl-x-4-map "\C-o" 'display-buffer)
5856 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
5857 (define-key ctl-x-5-map "f" 'find-file-other-frame)
5858 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
5859 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
5860 (define-key ctl-x-5-map "\C-o" 'display-buffer-other-frame)
5862 ;; arch-tag: bc68d3ea-19ca-468b-aac6-3a4a7766101f
5863 ;;; files.el ends here