(font-lock-multiline, font-lock-fontified)
[emacs.git] / lisp / files.el
blob9bb2de41993ab71a7114ea444da41f1891294152
1 ;;; files.el --- file input and output commands for Emacs
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002
4 ;;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
25 ;;; Commentary:
27 ;; Defines most of Emacs's file- and directory-handling functions,
28 ;; including basic file visiting, backup generation, link handling,
29 ;; ITS-id version control, load- and write-hook handling, and the like.
31 ;;; Code:
33 (defgroup backup nil
34 "Backups of edited data files."
35 :group 'files)
37 (defgroup find-file nil
38 "Finding files."
39 :group 'files)
42 (defcustom delete-auto-save-files t
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
45 Note that auto-save file will not be deleted if the buffer is killed
46 when it has unsaved changes."
47 :type 'boolean
48 :group 'auto-save)
50 (defcustom directory-abbrev-alist
51 nil
52 "*Alist of abbreviations for file directories.
53 A list of elements of the form (FROM . TO), each meaning to replace
54 FROM with TO when it appears in a directory name. This replacement is
55 done when setting up the default directory of a newly visited file.
56 *Every* FROM string should start with `^'.
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
61 Use this feature when you have directories which you normally refer to
62 via absolute symbolic links. Make TO the name of the link, and FROM
63 the name it is linked to."
64 :type '(repeat (cons :format "%v"
65 :value ("" . "")
66 (regexp :tag "From")
67 (regexp :tag "To")))
68 :group 'abbrev
69 :group 'find-file)
71 ;; Turn off backup files on VMS since it has version numbers.
72 (defcustom make-backup-files (not (eq system-type 'vax-vms))
73 "*Non-nil means make a backup of a file the first time it is saved.
74 This can be done by renaming the file or by copying.
76 Renaming means that Emacs renames the existing file so that it is a
77 backup file, then writes the buffer into a new file. Any other names
78 that the old file had will now refer to the backup file. The new file
79 is owned by you and its group is defaulted.
81 Copying means that Emacs copies the existing file into the backup
82 file, then writes the buffer on top of the existing file. Any other
83 names that the old file had will now refer to the new (edited) file.
84 The file's owner and group are unchanged.
86 The choice of renaming or copying is controlled by the variables
87 `backup-by-copying', `backup-by-copying-when-linked',
88 `backup-by-copying-when-mismatch' and
89 `backup-by-copying-when-privileged-mismatch'. See also `backup-inhibited'."
90 :type 'boolean
91 :group 'backup)
93 ;; Do this so that local variables based on the file name
94 ;; are not overridden by the major mode.
95 (defvar backup-inhibited nil
96 "Non-nil means don't make a backup, regardless of the other parameters.
97 This variable is intended for use by making it local to a buffer.
98 But it is local only if you make it local.")
99 (put 'backup-inhibited 'permanent-local t)
101 (defcustom backup-by-copying nil
102 "*Non-nil means always use copying to create backup files.
103 See documentation of variable `make-backup-files'."
104 :type 'boolean
105 :group 'backup)
107 (defcustom backup-by-copying-when-linked nil
108 "*Non-nil means use copying to create backups for files with multiple names.
109 This causes the alternate names to refer to the latest version as edited.
110 This variable is relevant only if `backup-by-copying' is nil."
111 :type 'boolean
112 :group 'backup)
114 (defcustom backup-by-copying-when-mismatch nil
115 "*Non-nil means create backups by copying if this preserves owner or group.
116 Renaming may still be used (subject to control of other variables)
117 when it would not result in changing the owner or group of the file;
118 that is, for files which are owned by you and whose group matches
119 the default for a new file created there by you.
120 This variable is relevant only if `backup-by-copying' is nil."
121 :type 'boolean
122 :group 'backup)
124 (defcustom backup-by-copying-when-privileged-mismatch 200
125 "*Non-nil means create backups by copying to preserve a privileged owner.
126 Renaming may still be used (subject to control of other variables)
127 when it would not result in changing the owner of the file or if the owner
128 has a user id greater than the value of this variable. This is useful
129 when low-numbered uid's are used for special system users (such as root)
130 that must maintain ownership of certain files.
131 This variable is relevant only if `backup-by-copying' and
132 `backup-by-copying-when-mismatch' are nil."
133 :type '(choice (const nil) integer)
134 :group 'backup)
136 (defvar backup-enable-predicate 'normal-backup-enable-predicate
137 "Predicate that looks at a file name and decides whether to make backups.
138 Called with an absolute file name as argument, it returns t to enable backup.")
140 (defcustom buffer-offer-save nil
141 "*Non-nil in a buffer means always offer to save buffer on exit.
142 Do so even if the buffer is not visiting a file.
143 Automatically local in all buffers."
144 :type 'boolean
145 :group 'backup)
146 (make-variable-buffer-local 'buffer-offer-save)
148 (defcustom find-file-existing-other-name t
149 "*Non-nil means find a file under alternative names, in existing buffers.
150 This means if any existing buffer is visiting the file you want
151 under another name, you get the existing buffer instead of a new buffer."
152 :type 'boolean
153 :group 'find-file)
155 (defcustom find-file-visit-truename nil
156 "*Non-nil means visit a file under its truename.
157 The truename of a file is found by chasing all links
158 both at the file level and at the levels of the containing directories."
159 :type 'boolean
160 :group 'find-file)
162 (defcustom revert-without-query
164 "*Specify which files should be reverted without query.
165 The value is a list of regular expressions.
166 If the file name matches one of these regular expressions,
167 then `revert-buffer' reverts the file without querying
168 if the file has changed on disk and you have not edited the buffer."
169 :type '(repeat regexp)
170 :group 'find-file)
172 (defvar buffer-file-number nil
173 "The device number and file number of the file visited in the current buffer.
174 The value is a list of the form (FILENUM DEVNUM).
175 This pair of numbers uniquely identifies the file.
176 If the buffer is visiting a new file, the value is nil.")
177 (make-variable-buffer-local 'buffer-file-number)
178 (put 'buffer-file-number 'permanent-local t)
180 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
183 (defvar buffer-file-read-only nil
184 "Non-nil if visited file was read-only when visited.")
185 (make-variable-buffer-local 'buffer-file-read-only)
187 (defcustom temporary-file-directory
188 (file-name-as-directory
189 (cond ((memq system-type '(ms-dos windows-nt))
190 (or (getenv "TEMP") (getenv "TMPDIR") (getenv "TMP") "c:/temp"))
191 ((memq system-type '(vax-vms axp-vms))
192 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "SYS$SCRATCH:"))
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 "The directory for writing temporary files."
196 :group 'files
197 :type 'directory)
199 (defcustom small-temporary-file-directory
200 (if (eq system-type 'ms-dos) (getenv "TMPDIR"))
201 "The directory for writing small temporary files.
202 If non-nil, this directory is used instead of `temporary-file-directory'
203 by programs that create small temporary files. This is for systems that
204 have fast storage with limited space, such as a RAM disk."
205 :group 'files
206 :type '(choice (const nil) directory))
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
209 (defvar null-device "/dev/null" "The system null device.")
211 (defvar file-name-invalid-regexp
212 (cond ((and (eq system-type 'ms-dos) (not (msdos-long-file-names)))
213 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
214 "[+, ;=|<>\"?*]\\|\\[\\|\\]\\|" ; invalid characters
215 "[\000-\031]\\|" ; control characters
216 "\\(/\\.\\.?[^/]\\)\\|" ; leading dots
217 "\\(/[^/.]+\\.[^/.]*\\.\\)")) ; more than a single dot
218 ((memq system-type '(ms-dos windows-nt cygwin))
219 (concat "^\\([^A-Z[-`a-z]\\|..+\\)?:\\|" ; colon except after drive
220 "[|<>\"?*\000-\031]")) ; invalid characters
221 (t "[\000]"))
222 "Regexp recognizing file names which aren't allowed by the filesystem.")
224 (defcustom file-precious-flag nil
225 "*Non-nil means protect against I/O errors while saving files.
226 Some modes set this non-nil in particular buffers.
228 This feature works by writing the new contents into a temporary file
229 and then renaming the temporary file to replace the original.
230 In this way, any I/O error in writing leaves the original untouched,
231 and there is never any instant where the file is nonexistent.
233 Note that this feature forces backups to be made by copying.
234 Yet, at the same time, saving a precious file
235 breaks any hard links between it and other files."
236 :type 'boolean
237 :group 'backup)
239 (defcustom version-control nil
240 "*Control use of version numbers for backup files.
241 t means make numeric backup versions unconditionally.
242 nil means make them for files that have some already.
243 `never' means do not make them."
244 :type '(choice (const :tag "Never" never)
245 (const :tag "If existing" nil)
246 (other :tag "Always" t))
247 :group 'backup
248 :group 'vc)
250 (defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
252 :type 'integer
253 :group 'backup
254 :group 'dired)
256 (defcustom delete-old-versions nil
257 "*If t, delete excess backup versions silently.
258 If nil, ask confirmation. Any other value prevents any trimming."
259 :type '(choice (const :tag "Delete" t)
260 (const :tag "Ask" nil)
261 (other :tag "Leave" other))
262 :group 'backup)
264 (defcustom kept-old-versions 2
265 "*Number of oldest versions to keep when a new numbered backup is made."
266 :type 'integer
267 :group 'backup)
269 (defcustom kept-new-versions 2
270 "*Number of newest versions to keep when a new numbered backup is made.
271 Includes the new backup. Must be > 0"
272 :type 'integer
273 :group 'backup)
275 (defcustom require-final-newline nil
276 "*Value of t says silently ensure a file ends in a newline when it is saved.
277 Non-nil but not t says ask user whether to add a newline when there isn't one.
278 nil means don't add newlines."
279 :type '(choice (const :tag "Off" nil)
280 (const :tag "Add" t)
281 (other :tag "Ask" ask))
282 :group 'editing-basics)
284 (defcustom auto-save-default t
285 "*Non-nil says by default do auto-saving of every file-visiting buffer."
286 :type 'boolean
287 :group 'auto-save)
289 (defcustom auto-save-visited-file-name nil
290 "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
291 Normally auto-save files are written under other names."
292 :type 'boolean
293 :group 'auto-save)
295 (defcustom auto-save-file-name-transforms
296 `(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)"
297 ;; Don't put "\\2" inside expand-file-name, since it will be
298 ;; transformed to "/2" on DOS/Windows.
299 ,(concat temporary-file-directory "\\2") t))
300 "*Transforms to apply to buffer file name before making auto-save file name.
301 Each transform is a list (REGEXP REPLACEMENT UNIQUIFY):
302 REGEXP is a regular expression to match against the file name.
303 If it matches, `replace-match' is used to replace the
304 matching part with REPLACEMENT.
305 If the optional element UNIQUIFY is non-nil, the auto-save file name is
306 constructed by taking the directory part of the replaced file-name,
307 concatenated with the buffer file name with all directory separators
308 changed to `!' to prevent clashes. This will not work
309 correctly if your filesystem truncates the resulting name.
311 All the transforms in the list are tried, in the order they are listed.
312 When one transform applies, its result is final;
313 no further transforms are tried.
315 The default value is set up to put the auto-save file into the
316 temporary directory (see the variable `temporary-file-directory') for
317 editing a remote file.
319 On MS-DOS filesystems without long names this variable is always
320 ignored."
321 :group 'auto-save
322 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")
323 (boolean :tag "Uniquify")))
324 :version "21.1")
326 (defcustom save-abbrevs t
327 "*Non-nil means save word abbrevs too when files are saved.
328 If `silently', don't ask the user before saving."
329 :type '(choice (const t) (const nil) (const silently))
330 :group 'abbrev)
332 (defcustom find-file-run-dired t
333 "*Non-nil means allow `find-file' to visit directories.
334 To visit the directory, `find-file' runs `find-directory-functions'."
335 :type 'boolean
336 :group 'find-file)
338 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
339 "*List of functions to try in sequence to visit a directory.
340 Each function is called with the directory name as the sole argument
341 and should return either a buffer or nil."
342 :type '(hook :options (cvs-dired-noselect dired-noselect))
343 :group 'find-file)
345 ;;;It is not useful to make this a local variable.
346 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
347 (defvar find-file-not-found-functions nil
348 "List of functions to be called for `find-file' on nonexistent file.
349 These functions are called as soon as the error is detected.
350 Variable `buffer-file-name' is already set up.
351 The functions are called in the order given until one of them returns non-nil.")
352 (defvaralias 'find-file-not-found-hooks 'find-file-not-found-functions)
353 (make-obsolete-variable
354 'find-file-not-found-hooks 'find-file-not-found-functions "21.4")
356 ;;;It is not useful to make this a local variable.
357 ;;;(put 'find-file-hooks 'permanent-local t)
358 (defvar find-file-hook nil
359 "List of functions to be called after a buffer is loaded from a file.
360 The buffer's local variables (if any) will have been processed before the
361 functions are called.")
362 (defvaralias 'find-file-hooks 'find-file-hook)
363 (make-obsolete-variable 'find-file-hooks 'find-file-hook "21.4")
365 (defvar write-file-functions nil
366 "List of functions to be called before writing out a buffer to a file.
367 If one of them returns non-nil, the file is considered already written
368 and the rest are not called.
369 These hooks are considered to pertain to the visited file.
370 So any buffer-local binding of this variable is discarded if you change
371 the visited file name with \\[set-visited-file-name], but not when you
372 change the major mode.
374 See also `write-contents-functions'.")
375 (put 'write-file-functions 'permanent-local t)
376 (defvaralias 'write-file-hooks 'write-file-functions)
377 (make-obsolete-variable 'write-file-hooks 'write-file-functions "21.4")
379 (defvar local-write-file-hooks nil)
380 (make-variable-buffer-local 'local-write-file-hooks)
381 (put 'local-write-file-hooks 'permanent-local t)
382 (make-obsolete-variable 'local-write-file-hooks 'write-file-functions "21.4")
384 (defvar write-contents-functions nil
385 "List of functions to be called before writing out a buffer to a file.
386 If one of them returns non-nil, the file is considered already written
387 and the rest are not called.
389 This variable is meant to be used for hooks that pertain to the
390 buffer's contents, not to the particular visited file; thus,
391 `set-visited-file-name' does not clear this variable; but changing the
392 major mode does clear it.
394 See also `write-file-functions'.")
395 (make-variable-buffer-local 'write-contents-functions)
396 (defvaralias 'write-contents-hooks 'write-contents-functions)
397 (make-obsolete-variable 'write-contents-hooks 'write-contents-functions "21.4")
399 (defcustom enable-local-variables t
400 "*Control use of local variables in files you visit.
401 The value can be t, nil or something else.
402 A value of t means file local variables specifications are obeyed;
403 nil means they are ignored; anything else means query.
404 This variable also controls use of major modes specified in
405 a -*- line.
407 The command \\[normal-mode], when used interactively,
408 always obeys file local variable specifications and the -*- line,
409 and ignores this variable."
410 :type '(choice (const :tag "Obey" t)
411 (const :tag "Ignore" nil)
412 (other :tag "Query" other))
413 :group 'find-file)
415 (defvar local-enable-local-variables t
416 "Like `enable-local-variables' but meant for buffer-local bindings.
417 The meaningful values are nil and non-nil. The default is non-nil.
418 If a major mode sets this to nil, buffer-locally, then any local
419 variables list in the file will be ignored.
421 This variable does not affect the use of major modes
422 specified in a -*- line.")
424 (defcustom enable-local-eval 'maybe
425 "*Control processing of the \"variable\" `eval' in a file's local variables.
426 The value can be t, nil or something else.
427 A value of t means obey `eval' variables;
428 nil means ignore them; anything else means query.
430 The command \\[normal-mode] always obeys local-variables lists
431 and ignores this variable."
432 :type '(choice (const :tag "Obey" t)
433 (const :tag "Ignore" nil)
434 (other :tag "Query" other))
435 :group 'find-file)
437 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
438 (or (fboundp 'lock-buffer)
439 (defalias 'lock-buffer 'ignore))
440 (or (fboundp 'unlock-buffer)
441 (defalias 'unlock-buffer 'ignore))
442 (or (fboundp 'file-locked-p)
443 (defalias 'file-locked-p 'ignore))
445 (defvar view-read-only nil
446 "*Non-nil means buffers visiting files read-only, do it in view mode.")
448 (put 'ange-ftp-completion-hook-function 'safe-magic t)
449 (defun ange-ftp-completion-hook-function (op &rest args)
450 "Provides support for ange-ftp host name completion.
451 Runs the usual ange-ftp hook, but only for completion operations."
452 ;; Having this here avoids the need to load ange-ftp when it's not
453 ;; really in use.
454 (if (memq op '(file-name-completion file-name-all-completions))
455 (apply 'ange-ftp-hook-function op args)
456 (let ((inhibit-file-name-handlers
457 (cons 'ange-ftp-completion-hook-function
458 (and (eq inhibit-file-name-operation op)
459 inhibit-file-name-handlers)))
460 (inhibit-file-name-operation op))
461 (apply op args))))
463 (defun convert-standard-filename (filename)
464 "Convert a standard file's name to something suitable for the current OS.
465 This function's standard definition is trivial; it just returns the argument.
466 However, on some systems, the function is redefined with a definition
467 that really does change some file names to canonicalize certain
468 patterns and to guarantee valid names."
469 filename)
471 (defun read-directory-name (prompt &optional dir default-dirname mustmatch initial)
472 "Read directory name, prompting with PROMPT and completing in directory DIR.
473 Value is not expanded---you must call `expand-file-name' yourself.
474 Default name to DEFAULT-DIRNAME if user enters a null string.
475 (If DEFAULT-DIRNAME is omitted, the current buffer's directory is used,
476 except that if INITIAL is specified, that combined with DIR is used.)
477 Fourth arg MUSTMATCH non-nil means require existing directory's name.
478 Non-nil and non-t means also require confirmation after completion.
479 Fifth arg INITIAL specifies text to start with.
480 DIR defaults to current buffer's directory default."
481 (unless dir
482 (setq dir default-directory))
483 (unless default-dirname
484 (setq default-dirname
485 (if initial (concat dir initial) default-directory)))
486 (read-file-name prompt dir default-dirname mustmatch initial
487 'file-directory-p))
490 (defun pwd ()
491 "Show the current default directory."
492 (interactive nil)
493 (message "Directory %s" default-directory))
495 (defvar cd-path nil
496 "Value of the CDPATH environment variable, as a list.
497 Not actually set up until the first time you use it.")
499 (defun parse-colon-path (cd-path)
500 "Explode a colon-separated search path into a list of directory names.
501 \(For values of `colon' equal to `path-separator'.)"
502 ;; We could use split-string here.
503 (and cd-path
504 (let (cd-prefix cd-list (cd-start 0) cd-colon)
505 (setq cd-path (concat cd-path path-separator))
506 (while (setq cd-colon (string-match path-separator cd-path cd-start))
507 (setq cd-list
508 (nconc cd-list
509 (list (if (= cd-start cd-colon)
511 (substitute-in-file-name
512 (file-name-as-directory
513 (substring cd-path cd-start cd-colon)))))))
514 (setq cd-start (+ cd-colon 1)))
515 cd-list)))
517 (defun cd-absolute (dir)
518 "Change current directory to given absolute file name DIR."
519 ;; Put the name into directory syntax now,
520 ;; because otherwise expand-file-name may give some bad results.
521 (if (not (eq system-type 'vax-vms))
522 (setq dir (file-name-as-directory dir)))
523 (setq dir (abbreviate-file-name (expand-file-name dir)))
524 (if (not (file-directory-p dir))
525 (if (file-exists-p dir)
526 (error "%s is not a directory" dir)
527 (error "%s: no such directory" dir))
528 (if (file-executable-p dir)
529 (setq default-directory dir)
530 (error "Cannot cd to %s: Permission denied" dir))))
532 (defun cd (dir)
533 "Make DIR become the current buffer's default directory.
534 If your environment includes a `CDPATH' variable, try each one of that
535 colon-separated list of directories when resolving a relative directory name."
536 (interactive
537 (list (read-directory-name "Change default directory: "
538 default-directory default-directory
539 (and (member cd-path '(nil ("./")))
540 (null (getenv "CDPATH"))))))
541 (if (file-name-absolute-p dir)
542 (cd-absolute (expand-file-name dir))
543 (if (null cd-path)
544 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
545 (setq cd-path (or trypath (list "./")))))
546 (if (not (catch 'found
547 (mapcar
548 (function (lambda (x)
549 (let ((f (expand-file-name (concat x dir))))
550 (if (file-directory-p f)
551 (progn
552 (cd-absolute f)
553 (throw 'found t))))))
554 cd-path)
555 nil))
556 (error "No such directory found via CDPATH environment variable"))))
558 (defun load-file (file)
559 "Load the Lisp file named FILE."
560 ;; This is a case where .elc makes a lot of sense.
561 (interactive (list (let ((completion-ignored-extensions
562 (remove ".elc" completion-ignored-extensions)))
563 (read-file-name "Load file: "))))
564 (load (expand-file-name file) nil nil t))
566 (defun locate-file (filename path &optional suffixes predicate)
567 "Search for FILENAME through PATH.
568 If SUFFIXES is non-nil, it should be a list of suffixes to append to
569 file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
570 If non-nil, PREDICATE is used instead of `file-readable-p'.
571 PREDICATE can also be an integer to pass to the `access' system call,
572 in which case file-name handlers are ignored. This usage is deprecated.
574 For compatibility, PREDICATE can also be one of the symbols
575 `executable', `readable', `writable', or `exists', or a list of
576 one or more of those symbols."
577 (if (and predicate (symbolp predicate) (not (functionp predicate)))
578 (setq predicate (list predicate)))
579 (when (and (consp predicate) (not (functionp predicate)))
580 (setq predicate
581 (logior (if (memq 'executable predicate) 1 0)
582 (if (memq 'writable predicate) 2 0)
583 (if (memq 'readable predicate) 4 0))))
584 (locate-file-internal filename path suffixes predicate))
586 (defun locate-file-completion (string path-and-suffixes action)
587 "Do completion for file names passed to `locate-file'.
588 PATH-AND-SUFFIXES is a pair of lists (DIRECTORIES . SUFFIXES)."
589 (if (file-name-absolute-p string)
590 (read-file-name-internal string nil action)
591 (let ((names nil)
592 (suffix (concat (regexp-opt (cdr path-and-suffixes) t) "\\'"))
593 (string-dir (file-name-directory string)))
594 (dolist (dir (car path-and-suffixes))
595 (if string-dir (setq dir (expand-file-name string-dir dir)))
596 (when (file-directory-p dir)
597 (dolist (file (file-name-all-completions
598 (file-name-nondirectory string) dir))
599 (push (if string-dir (concat string-dir file) file) names)
600 (when (string-match suffix file)
601 (setq file (substring file 0 (match-beginning 0)))
602 (push (if string-dir (concat string-dir file) file) names)))))
603 (cond
604 ((eq action t) (all-completions string names))
605 ((null action) (try-completion string names))
606 (t (test-completion string names))))))
608 (defun load-library (library)
609 "Load the library named LIBRARY.
610 This is an interface to the function `load'."
611 (interactive
612 (list (completing-read "Load library: "
613 'locate-file-completion
614 (cons load-path load-suffixes))))
615 (load library))
617 (defun file-remote-p (file)
618 "Test whether FILE specifies a location on a remote system."
619 (let ((handler (find-file-name-handler file 'file-local-copy)))
620 (if handler
621 (get handler 'file-remote-p))))
623 (defun file-local-copy (file)
624 "Copy the file FILE into a temporary file on this machine.
625 Returns the name of the local copy, or nil, if FILE is directly
626 accessible."
627 ;; This formerly had an optional BUFFER argument that wasn't used by
628 ;; anything.
629 (let ((handler (find-file-name-handler file 'file-local-copy)))
630 (if handler
631 (funcall handler 'file-local-copy file)
632 nil)))
634 (defun file-truename (filename &optional counter prev-dirs)
635 "Return the truename of FILENAME, which should be absolute.
636 The truename of a file name is found by chasing symbolic links
637 both at the level of the file and at the level of the directories
638 containing it, until no links are left at any level.
640 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
641 Do not specify them in other calls."
642 ;; COUNTER can be a cons cell whose car is the count of how many more links
643 ;; to chase before getting an error.
644 ;; PREV-DIRS can be a cons cell whose car is an alist
645 ;; of truenames we've just recently computed.
647 ;; The last test looks dubious, maybe `+' is meant here? --simon.
648 (if (or (string= filename "") (string= filename "~")
649 (and (string= (substring filename 0 1) "~")
650 (string-match "~[^/]*" filename)))
651 (progn
652 (setq filename (expand-file-name filename))
653 (if (string= filename "")
654 (setq filename "/"))))
655 (or counter (setq counter (list 100)))
656 (let (done
657 ;; For speed, remove the ange-ftp completion handler from the list.
658 ;; We know it's not needed here.
659 ;; For even more speed, do this only on the outermost call.
660 (file-name-handler-alist
661 (if prev-dirs file-name-handler-alist
662 (let ((tem (copy-sequence file-name-handler-alist)))
663 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
664 (or prev-dirs (setq prev-dirs (list nil)))
666 ;; andrewi@harlequin.co.uk - none of the following code (except for
667 ;; invoking the file-name handler) currently applies on Windows
668 ;; (ie. there are no native symlinks), but there is an issue with
669 ;; case differences being ignored by the OS, and short "8.3 DOS"
670 ;; name aliases existing for all files. (The short names are not
671 ;; reported by directory-files, but can be used to refer to files.)
672 ;; It seems appropriate for file-truename to resolve these issues in
673 ;; the most natural way, which on Windows is to call the function
674 ;; `w32-long-file-name' - this returns the exact name of a file as
675 ;; it is stored on disk (expanding short name aliases with the full
676 ;; name in the process).
677 (if (eq system-type 'windows-nt)
678 (let ((handler (find-file-name-handler filename 'file-truename)))
679 ;; For file name that has a special handler, call handler.
680 ;; This is so that ange-ftp can save time by doing a no-op.
681 (if handler
682 (setq filename (funcall handler 'file-truename filename))
683 ;; If filename contains a wildcard, newname will be the old name.
684 (unless (string-match "[[*?]" filename)
685 ;; If filename exists, use the long name
686 (setq filename (or (w32-long-file-name filename) filename))))
687 (setq done t)))
689 ;; If this file directly leads to a link, process that iteratively
690 ;; so that we don't use lots of stack.
691 (while (not done)
692 (setcar counter (1- (car counter)))
693 (if (< (car counter) 0)
694 (error "Apparent cycle of symbolic links for %s" filename))
695 (let ((handler (find-file-name-handler filename 'file-truename)))
696 ;; For file name that has a special handler, call handler.
697 ;; This is so that ange-ftp can save time by doing a no-op.
698 (if handler
699 (setq filename (funcall handler 'file-truename filename)
700 done t)
701 (let ((dir (or (file-name-directory filename) default-directory))
702 target dirfile)
703 ;; Get the truename of the directory.
704 (setq dirfile (directory-file-name dir))
705 ;; If these are equal, we have the (or a) root directory.
706 (or (string= dir dirfile)
707 ;; If this is the same dir we last got the truename for,
708 ;; save time--don't recalculate.
709 (if (assoc dir (car prev-dirs))
710 (setq dir (cdr (assoc dir (car prev-dirs))))
711 (let ((old dir)
712 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
713 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
714 (setq dir new))))
715 (if (equal ".." (file-name-nondirectory filename))
716 (setq filename
717 (directory-file-name (file-name-directory (directory-file-name dir)))
718 done t)
719 (if (equal "." (file-name-nondirectory filename))
720 (setq filename (directory-file-name dir)
721 done t)
722 ;; Put it back on the file name.
723 (setq filename (concat dir (file-name-nondirectory filename)))
724 ;; Is the file name the name of a link?
725 (setq target (file-symlink-p filename))
726 (if target
727 ;; Yes => chase that link, then start all over
728 ;; since the link may point to a directory name that uses links.
729 ;; We can't safely use expand-file-name here
730 ;; since target might look like foo/../bar where foo
731 ;; is itself a link. Instead, we handle . and .. above.
732 (setq filename
733 (if (file-name-absolute-p target)
734 target
735 (concat dir target))
736 done nil)
737 ;; No, we are done!
738 (setq done t))))))))
739 filename))
741 (defun file-chase-links (filename &optional limit)
742 "Chase links in FILENAME until a name that is not a link.
743 Unlike `file-truename', this does not check whether a parent
744 directory name is a symbolic link.
745 If the optional argument LIMIT is a number,
746 it means chase no more than that many links and then stop."
747 (let (tem (newname filename)
748 (count 0))
749 (while (and (or (null limit) (< count limit))
750 (setq tem (file-symlink-p newname)))
751 (save-match-data
752 (if (and (null limit) (= count 100))
753 (error "Apparent cycle of symbolic links for %s" filename))
754 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
755 (while (string-match "//+" tem)
756 (setq tem (replace-match "/" nil nil tem)))
757 ;; Handle `..' by hand, since it needs to work in the
758 ;; target of any directory symlink.
759 ;; This code is not quite complete; it does not handle
760 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
761 (while (string-match "\\`\\.\\./" tem)
762 (setq tem (substring tem 3))
763 (setq newname (expand-file-name newname))
764 ;; Chase links in the default dir of the symlink.
765 (setq newname
766 (file-chase-links
767 (directory-file-name (file-name-directory newname))))
768 ;; Now find the parent of that dir.
769 (setq newname (file-name-directory newname)))
770 (setq newname (expand-file-name tem (file-name-directory newname)))
771 (setq count (1+ count))))
772 newname))
774 (defun recode-file-name (file coding new-coding &optional ok-if-already-exists)
775 "Change the encoding of FILE's name from CODING to NEW-CODING.
776 The value is a new name of FILE.
777 Signals a `file-already-exists' error if a file of the new name
778 already exists unless optional third argument OK-IF-ALREADY-EXISTS
779 is non-nil. A number as third arg means request confirmation if
780 the new name already exists. This is what happens in interactive
781 use with M-x."
782 (interactive
783 (let ((default-coding (or file-name-coding-system
784 default-file-name-coding-system))
785 (filename (read-file-name "Recode filename: " nil nil t))
786 from-coding to-coding)
787 (if (and default-coding
788 ;; We provide the default coding only when it seems that
789 ;; the filename is correctly decoded by the default
790 ;; coding.
791 (let ((charsets (find-charset-string filename)))
792 (and (not (memq 'eight-bit-control charsets))
793 (not (memq 'eight-bit-graphic charsets)))))
794 (setq from-coding (read-coding-system
795 (format "Recode filename %s from (default %s): "
796 filename default-coding)
797 default-coding))
798 (setq from-coding (read-coding-system
799 (format "Recode filename %s from: " filename))))
801 ;; We provide the default coding only when a user is going to
802 ;; change the encoding not from the default coding.
803 (if (eq from-coding default-coding)
804 (setq to-coding (read-coding-system
805 (format "Recode filename %s from %s to: "
806 filename from-coding)))
807 (setq to-coding (read-coding-system
808 (format "Recode filename %s from %s to (default %s): "
809 filename from-coding default-coding)
810 default-coding)))
811 (list filename from-coding to-coding)))
813 (let* ((default-coding (or file-name-coding-system
814 default-file-name-coding-system))
815 ;; FILE should have been decoded by DEFAULT-CODING.
816 (encoded (encode-coding-string file default-coding))
817 (newname (decode-coding-string encoded coding))
818 (new-encoded (encode-coding-string newname new-coding))
819 ;; Suppress further encoding.
820 (file-name-coding-system nil)
821 (default-file-name-coding-system nil)
822 (locale-coding-system nil))
823 (rename-file encoded new-encoded ok-if-already-exists)
824 newname))
826 (defun switch-to-buffer-other-window (buffer &optional norecord)
827 "Select buffer BUFFER in another window.
828 Optional second arg NORECORD non-nil means
829 do not put this buffer at the front of the list of recently selected ones.
831 This uses the function `display-buffer' as a subroutine; see its
832 documentation for additional customization information."
833 (interactive "BSwitch to buffer in other window: ")
834 (let ((pop-up-windows t))
835 (pop-to-buffer buffer t norecord)))
837 (defun switch-to-buffer-other-frame (buffer &optional norecord)
838 "Switch to buffer BUFFER in another frame.
839 Optional second arg NORECORD non-nil means
840 do not put this buffer at the front of the list of recently selected ones.
842 This uses the function `display-buffer' as a subroutine; see its
843 documentation for additional customization information."
844 (interactive "BSwitch to buffer in other frame: ")
845 (let ((pop-up-frames t))
846 (pop-to-buffer buffer t norecord)
847 (raise-frame (window-frame (selected-window)))))
849 (defvar find-file-default nil
850 "Used within `find-file-read-args'.")
852 (defun find-file-read-args (prompt mustmatch)
853 (list (let ((find-file-default
854 (and buffer-file-name
855 (abbreviate-file-name buffer-file-name)))
856 (munge-default-fun
857 (lambda ()
858 (setq minibuffer-default find-file-default)
859 ;; Clear out this hook so it does not interfere
860 ;; with any recursive minibuffer usage.
861 (pop minibuffer-setup-hook)))
862 (minibuffer-setup-hook
863 minibuffer-setup-hook))
864 (add-hook 'minibuffer-setup-hook munge-default-fun)
865 (read-file-name prompt nil default-directory mustmatch))
868 (defun find-file (filename &optional wildcards)
869 "Edit file FILENAME.
870 Switch to a buffer visiting file FILENAME,
871 creating one if none already exists.
872 Interactively, the default if you just type RET is the current directory,
873 but the visited file name is available through the minibuffer history:
874 type M-n to pull it into the minibuffer.
876 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
877 expand wildcards (if any) and visit multiple files. Wildcard expansion
878 can be suppressed by setting `find-file-wildcards'."
879 (interactive
880 (find-file-read-args "Find file: " nil))
881 (let ((value (find-file-noselect filename nil nil wildcards)))
882 (if (listp value)
883 (mapcar 'switch-to-buffer (nreverse value))
884 (switch-to-buffer value))))
886 (defun find-file-other-window (filename &optional wildcards)
887 "Edit file FILENAME, in another window.
888 May create a new window, or reuse an existing one.
889 See the function `display-buffer'.
891 Interactively, the default if you just type RET is the current directory,
892 but the visited file name is available through the minibuffer history:
893 type M-n to pull it into the minibuffer.
895 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
896 expand wildcards (if any) and visit multiple files."
897 (interactive (find-file-read-args "Find file in other window: " nil))
898 (let ((value (find-file-noselect filename nil nil wildcards)))
899 (if (listp value)
900 (progn
901 (setq value (nreverse value))
902 (switch-to-buffer-other-window (car value))
903 (mapcar 'switch-to-buffer (cdr value)))
904 (switch-to-buffer-other-window value))))
906 (defun find-file-other-frame (filename &optional wildcards)
907 "Edit file FILENAME, in another frame.
908 May create a new frame, or reuse an existing one.
909 See the function `display-buffer'.
911 Interactively, the default if you just type RET is the current directory,
912 but the visited file name is available through the minibuffer history:
913 type M-n to pull it into the minibuffer.
915 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
916 expand wildcards (if any) and visit multiple files."
917 (interactive (find-file-read-args "Find file in other frame: " nil))
918 (let ((value (find-file-noselect filename nil nil wildcards)))
919 (if (listp value)
920 (progn
921 (setq value (nreverse value))
922 (switch-to-buffer-other-frame (car value))
923 (mapcar 'switch-to-buffer (cdr value)))
924 (switch-to-buffer-other-frame value))))
926 (defun find-file-read-only (filename &optional wildcards)
927 "Edit file FILENAME but don't allow changes.
928 Like \\[find-file] but marks buffer as read-only.
929 Use \\[toggle-read-only] to permit editing."
930 (interactive (find-file-read-args "Find file read-only: " t))
931 (find-file filename wildcards)
932 (toggle-read-only 1)
933 (current-buffer))
935 (defun find-file-read-only-other-window (filename &optional wildcards)
936 "Edit file FILENAME in another window but don't allow changes.
937 Like \\[find-file-other-window] but marks buffer as read-only.
938 Use \\[toggle-read-only] to permit editing."
939 (interactive (find-file-read-args "Find file read-only other window: " t))
940 (find-file-other-window filename wildcards)
941 (toggle-read-only 1)
942 (current-buffer))
944 (defun find-file-read-only-other-frame (filename &optional wildcards)
945 "Edit file FILENAME in another frame but don't allow changes.
946 Like \\[find-file-other-frame] but marks buffer as read-only.
947 Use \\[toggle-read-only] to permit editing."
948 (interactive (find-file-read-args "Find file read-only other frame: " t))
949 (find-file-other-frame filename wildcards)
950 (toggle-read-only 1)
951 (current-buffer))
953 (defun find-alternate-file-other-window (filename)
954 "Find file FILENAME as a replacement for the file in the next window.
955 This command does not select that window."
956 (interactive
957 (save-selected-window
958 (other-window 1)
959 (let ((file buffer-file-name)
960 (file-name nil)
961 (file-dir nil))
962 (and file
963 (setq file-name (file-name-nondirectory file)
964 file-dir (file-name-directory file)))
965 (list (read-file-name
966 "Find alternate file: " file-dir nil nil file-name)))))
967 (if (one-window-p)
968 (find-file-other-window filename)
969 (save-selected-window
970 (other-window 1)
971 (find-alternate-file filename))))
973 (defun find-alternate-file (filename)
974 "Find file FILENAME, select its buffer, kill previous buffer.
975 If the current buffer now contains an empty file that you just visited
976 \(presumably by mistake), use this command to visit the file you really want."
977 (interactive
978 (let ((file buffer-file-name)
979 (file-name nil)
980 (file-dir nil))
981 (and file
982 (setq file-name (file-name-nondirectory file)
983 file-dir (file-name-directory file)))
984 (list (read-file-name
985 "Find alternate file: " file-dir nil nil file-name))))
986 (unless (run-hook-with-args-until-failure 'kill-buffer-query-functions)
987 (error "Aborted"))
988 (when (and (buffer-modified-p) (buffer-file-name))
989 (if (yes-or-no-p (format "Buffer %s is modified; save it first? "
990 (buffer-name)))
991 (save-buffer)
992 (unless (yes-or-no-p "Kill and replace the buffer without saving it? ")
993 (error "Aborted"))))
994 (let ((obuf (current-buffer))
995 (ofile buffer-file-name)
996 (onum buffer-file-number)
997 (odir dired-directory)
998 (otrue buffer-file-truename)
999 (oname (buffer-name)))
1000 (if (get-buffer " **lose**")
1001 (kill-buffer " **lose**"))
1002 (rename-buffer " **lose**")
1003 (unwind-protect
1004 (progn
1005 (unlock-buffer)
1006 ;; This prevents us from finding the same buffer
1007 ;; if we specified the same file again.
1008 (setq buffer-file-name nil)
1009 (setq buffer-file-number nil)
1010 (setq buffer-file-truename nil)
1011 ;; Likewise for dired buffers.
1012 (setq dired-directory nil)
1013 (find-file filename))
1014 (when (eq obuf (current-buffer))
1015 ;; This executes if find-file gets an error
1016 ;; and does not really find anything.
1017 ;; We put things back as they were.
1018 ;; If find-file actually finds something, we kill obuf below.
1019 (setq buffer-file-name ofile)
1020 (setq buffer-file-number onum)
1021 (setq buffer-file-truename otrue)
1022 (setq dired-directory odir)
1023 (lock-buffer)
1024 (rename-buffer oname)))
1025 (unless (eq (current-buffer) obuf)
1026 (with-current-buffer obuf
1027 ;; We already asked; don't ask again.
1028 (let ((kill-buffer-query-functions))
1029 (kill-buffer obuf))))))
1031 (defun create-file-buffer (filename)
1032 "Create a suitably named buffer for visiting FILENAME, and return it.
1033 FILENAME (sans directory) is used unchanged if that name is free;
1034 otherwise a string <2> or <3> or ... is appended to get an unused name."
1035 (let ((lastname (file-name-nondirectory filename)))
1036 (if (string= lastname "")
1037 (setq lastname filename))
1038 (generate-new-buffer lastname)))
1040 (defun generate-new-buffer (name)
1041 "Create and return a buffer with a name based on NAME.
1042 Choose the buffer's name using `generate-new-buffer-name'."
1043 (get-buffer-create (generate-new-buffer-name name)))
1045 (defcustom automount-dir-prefix "^/tmp_mnt/"
1046 "Regexp to match the automounter prefix in a directory name."
1047 :group 'files
1048 :type 'regexp)
1050 (defvar abbreviated-home-dir nil
1051 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
1053 (defun abbreviate-file-name (filename)
1054 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
1055 This also substitutes \"~\" for the user's home directory and
1056 removes automounter prefixes (see the variable `automount-dir-prefix')."
1057 ;; Get rid of the prefixes added by the automounter.
1058 (if (and automount-dir-prefix
1059 (string-match automount-dir-prefix filename)
1060 (file-exists-p (file-name-directory
1061 (substring filename (1- (match-end 0))))))
1062 (setq filename (substring filename (1- (match-end 0)))))
1063 (let ((tail directory-abbrev-alist))
1064 ;; If any elt of directory-abbrev-alist matches this name,
1065 ;; abbreviate accordingly.
1066 (while tail
1067 (if (string-match (car (car tail)) filename)
1068 (setq filename
1069 (concat (cdr (car tail)) (substring filename (match-end 0)))))
1070 (setq tail (cdr tail)))
1071 ;; Compute and save the abbreviated homedir name.
1072 ;; We defer computing this until the first time it's needed, to
1073 ;; give time for directory-abbrev-alist to be set properly.
1074 ;; We include a slash at the end, to avoid spurious matches
1075 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
1076 (or abbreviated-home-dir
1077 (setq abbreviated-home-dir
1078 (let ((abbreviated-home-dir "$foo"))
1079 (concat "^" (abbreviate-file-name (expand-file-name "~"))
1080 "\\(/\\|$\\)"))))
1082 ;; If FILENAME starts with the abbreviated homedir,
1083 ;; make it start with `~' instead.
1084 (if (and (string-match abbreviated-home-dir filename)
1085 ;; If the home dir is just /, don't change it.
1086 (not (and (= (match-end 0) 1)
1087 (= (aref filename 0) ?/)))
1088 ;; MS-DOS root directories can come with a drive letter;
1089 ;; Novell Netware allows drive letters beyond `Z:'.
1090 (not (and (or (eq system-type 'ms-dos)
1091 (eq system-type 'cygwin)
1092 (eq system-type 'windows-nt))
1093 (save-match-data
1094 (string-match "^[a-zA-`]:/$" filename)))))
1095 (setq filename
1096 (concat "~"
1097 (substring filename (match-beginning 1) (match-end 1))
1098 (substring filename (match-end 0)))))
1099 filename))
1101 (defcustom find-file-not-true-dirname-list nil
1102 "*List of logical names for which visiting shouldn't save the true dirname.
1103 On VMS, when you visit a file using a logical name that searches a path,
1104 you may or may not want the visited file name to record the specific
1105 directory where the file was found. If you *do not* want that, add the logical
1106 name to this list as a string."
1107 :type '(repeat (string :tag "Name"))
1108 :group 'find-file)
1110 (defun find-buffer-visiting (filename &optional predicate)
1111 "Return the buffer visiting file FILENAME (a string).
1112 This is like `get-file-buffer', except that it checks for any buffer
1113 visiting the same file, possibly under a different name.
1114 If PREDICATE is non-nil, only a buffer satisfying it can be returned.
1115 If there is no such live buffer, return nil."
1116 (let ((predicate (or predicate #'identity))
1117 (truename (abbreviate-file-name (file-truename filename))))
1118 (or (let ((buf (get-file-buffer filename)))
1119 (when (and buf (funcall predicate buf)) buf))
1120 (let ((list (buffer-list)) found)
1121 (while (and (not found) list)
1122 (save-excursion
1123 (set-buffer (car list))
1124 (if (and buffer-file-name
1125 (string= buffer-file-truename truename)
1126 (funcall predicate (current-buffer)))
1127 (setq found (car list))))
1128 (setq list (cdr list)))
1129 found)
1130 (let* ((attributes (file-attributes truename))
1131 (number (nthcdr 10 attributes))
1132 (list (buffer-list)) found)
1133 (and buffer-file-numbers-unique
1134 number
1135 (while (and (not found) list)
1136 (with-current-buffer (car list)
1137 (if (and buffer-file-name
1138 (equal buffer-file-number number)
1139 ;; Verify this buffer's file number
1140 ;; still belongs to its file.
1141 (file-exists-p buffer-file-name)
1142 (equal (file-attributes buffer-file-truename)
1143 attributes)
1144 (funcall predicate (current-buffer)))
1145 (setq found (car list))))
1146 (setq list (cdr list))))
1147 found))))
1149 (defcustom find-file-wildcards t
1150 "*Non-nil means file-visiting commands should handle wildcards.
1151 For example, if you specify `*.c', that would visit all the files
1152 whose names match the pattern."
1153 :group 'files
1154 :version "20.4"
1155 :type 'boolean)
1157 (defcustom find-file-suppress-same-file-warnings nil
1158 "*Non-nil means suppress warning messages for symlinked files.
1159 When nil, Emacs prints a warning when visiting a file that is already
1160 visited, but with a different name. Setting this option to t
1161 suppresses this warning."
1162 :group 'files
1163 :version "21.1"
1164 :type 'boolean)
1166 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
1167 "Read file FILENAME into a buffer and return the buffer.
1168 If a buffer exists visiting FILENAME, return that one, but
1169 verify that the file has not changed since visited or saved.
1170 The buffer is not selected, just returned to the caller.
1171 Optional first arg NOWARN non-nil means suppress any warning messages.
1172 Optional second arg RAWFILE non-nil means the file is read literally.
1173 Optional third arg WILDCARDS non-nil means do wildcard processing
1174 and visit all the matching files. When wildcards are actually
1175 used and expanded, the value is a list of buffers
1176 that are visiting the various files."
1177 (setq filename
1178 (abbreviate-file-name
1179 (expand-file-name filename)))
1180 (if (file-directory-p filename)
1181 (or (and find-file-run-dired
1182 (run-hook-with-args-until-success
1183 'find-directory-functions
1184 (if find-file-visit-truename
1185 (abbreviate-file-name (file-truename filename))
1186 filename)))
1187 (error "%s is a directory" filename))
1188 (if (and wildcards
1189 find-file-wildcards
1190 (not (string-match "\\`/:" filename))
1191 (string-match "[[*?]" filename))
1192 (let ((files (condition-case nil
1193 (file-expand-wildcards filename t)
1194 (error (list filename))))
1195 (find-file-wildcards nil))
1196 (if (null files)
1197 (find-file-noselect filename)
1198 (mapcar #'find-file-noselect files)))
1199 (let* ((buf (get-file-buffer filename))
1200 (truename (abbreviate-file-name (file-truename filename)))
1201 (number (nthcdr 10 (file-attributes truename)))
1202 ;; Find any buffer for a file which has same truename.
1203 (other (and (not buf) (find-buffer-visiting filename))))
1204 ;; Let user know if there is a buffer with the same truename.
1205 (if other
1206 (progn
1207 (or nowarn
1208 find-file-suppress-same-file-warnings
1209 (string-equal filename (buffer-file-name other))
1210 (message "%s and %s are the same file"
1211 filename (buffer-file-name other)))
1212 ;; Optionally also find that buffer.
1213 (if (or find-file-existing-other-name find-file-visit-truename)
1214 (setq buf other))))
1215 (if buf
1216 ;; We are using an existing buffer.
1217 (progn
1218 (or nowarn
1219 (verify-visited-file-modtime buf)
1220 (cond ((not (file-exists-p filename))
1221 (error "File %s no longer exists!" filename))
1222 ;; Certain files should be reverted automatically
1223 ;; if they have changed on disk and not in the buffer.
1224 ((and (not (buffer-modified-p buf))
1225 (let ((tail revert-without-query)
1226 (found nil))
1227 (while tail
1228 (if (string-match (car tail) filename)
1229 (setq found t))
1230 (setq tail (cdr tail)))
1231 found))
1232 (with-current-buffer buf
1233 (message "Reverting file %s..." filename)
1234 (revert-buffer t t)
1235 (message "Reverting file %s...done" filename)))
1236 ((yes-or-no-p
1237 (if (string= (file-name-nondirectory filename)
1238 (buffer-name buf))
1239 (format
1240 (if (buffer-modified-p buf)
1241 "File %s changed on disk. Discard your edits? "
1242 "File %s changed on disk. Reread from disk? ")
1243 (file-name-nondirectory filename))
1244 (format
1245 (if (buffer-modified-p buf)
1246 "File %s changed on disk. Discard your edits in %s? "
1247 "File %s changed on disk. Reread from disk into %s? ")
1248 (file-name-nondirectory filename)
1249 (buffer-name buf))))
1250 (with-current-buffer buf
1251 (revert-buffer t t)))))
1252 (with-current-buffer buf
1254 ;; Check if a formerly read-only file has become
1255 ;; writable and vice versa, but if the buffer agrees
1256 ;; with the new state of the file, that is ok too.
1257 (let ((read-only (not (file-writable-p buffer-file-name))))
1258 (unless (or (eq read-only buffer-file-read-only)
1259 (eq read-only buffer-read-only))
1260 (when (or nowarn
1261 (let ((question
1262 (format "File %s is %s on disk. Change buffer mode? "
1263 buffer-file-name
1264 (if read-only "read-only" "writable"))))
1265 (y-or-n-p question)))
1266 (setq buffer-read-only read-only)))
1267 (setq buffer-file-read-only read-only))
1269 (when (and (not (eq (not (null rawfile))
1270 (not (null find-file-literally))))
1271 ;; It is confusing to ask whether to visit
1272 ;; non-literally if they have the file in
1273 ;; hexl-mode.
1274 (not (eq major-mode 'hexl-mode)))
1275 (if (buffer-modified-p)
1276 (if (y-or-n-p (if rawfile
1277 "Save file and revisit literally? "
1278 "Save file and revisit non-literally? "))
1279 (progn
1280 (save-buffer)
1281 (find-file-noselect-1 buf filename nowarn
1282 rawfile truename number))
1283 (if (y-or-n-p (if rawfile
1284 "Discard your edits and revisit file literally? "
1285 "Discard your edits and revisit file non-literally? "))
1286 (find-file-noselect-1 buf filename nowarn
1287 rawfile truename number)
1288 (error (if rawfile "File already visited non-literally"
1289 "File already visited literally"))))
1290 (if (y-or-n-p (if rawfile
1291 "Revisit file literally? "
1292 "Revisit file non-literally? "))
1293 (find-file-noselect-1 buf filename nowarn
1294 rawfile truename number)
1295 (error (if rawfile "File already visited non-literally"
1296 "File already visited literally"))))))
1297 ;; Return the buffer we are using.
1298 buf)
1299 ;; Create a new buffer.
1300 (setq buf (create-file-buffer filename))
1301 (set-buffer-major-mode buf)
1302 ;; find-file-noselect-1 may use a different buffer.
1303 (find-file-noselect-1 buf filename nowarn
1304 rawfile truename number))))))
1306 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1307 (let ((inhibit-read-only t)
1308 error)
1309 (with-current-buffer buf
1310 (kill-local-variable 'find-file-literally)
1311 ;; Needed in case we are re-visiting the file with a different
1312 ;; text representation.
1313 (kill-local-variable 'buffer-file-coding-system)
1314 (kill-local-variable 'cursor-type)
1315 (erase-buffer)
1316 (and (default-value 'enable-multibyte-characters)
1317 (not rawfile)
1318 (set-buffer-multibyte t))
1319 (if rawfile
1320 (condition-case ()
1321 (insert-file-contents-literally filename t)
1322 (file-error
1323 (when (and (file-exists-p filename)
1324 (not (file-readable-p filename)))
1325 (kill-buffer buf)
1326 (signal 'file-error (list "File is not readable"
1327 filename)))
1328 ;; Unconditionally set error
1329 (setq error t)))
1330 (condition-case ()
1331 (insert-file-contents filename t)
1332 (file-error
1333 (when (and (file-exists-p filename)
1334 (not (file-readable-p filename)))
1335 (kill-buffer buf)
1336 (signal 'file-error (list "File is not readable"
1337 filename)))
1338 ;; Run find-file-not-found-hooks until one returns non-nil.
1339 (or (run-hook-with-args-until-success 'find-file-not-found-functions)
1340 ;; If they fail too, set error.
1341 (setq error t)))))
1342 ;; Record the file's truename, and maybe use that as visited name.
1343 (if (equal filename buffer-file-name)
1344 (setq buffer-file-truename truename)
1345 (setq buffer-file-truename
1346 (abbreviate-file-name (file-truename buffer-file-name))))
1347 (setq buffer-file-number number)
1348 ;; On VMS, we may want to remember which directory in a search list
1349 ;; the file was found in.
1350 (and (eq system-type 'vax-vms)
1351 (let (logical)
1352 (if (string-match ":" (file-name-directory filename))
1353 (setq logical (substring (file-name-directory filename)
1354 0 (match-beginning 0))))
1355 (not (member logical find-file-not-true-dirname-list)))
1356 (setq buffer-file-name buffer-file-truename))
1357 (if find-file-visit-truename
1358 (setq buffer-file-name
1359 (setq filename
1360 (expand-file-name buffer-file-truename))))
1361 ;; Set buffer's default directory to that of the file.
1362 (setq default-directory (file-name-directory buffer-file-name))
1363 ;; Turn off backup files for certain file names. Since
1364 ;; this is a permanent local, the major mode won't eliminate it.
1365 (and (not (funcall backup-enable-predicate buffer-file-name))
1366 (progn
1367 (make-local-variable 'backup-inhibited)
1368 (setq backup-inhibited t)))
1369 (if rawfile
1370 (progn
1371 (set-buffer-multibyte nil)
1372 (setq buffer-file-coding-system 'no-conversion)
1373 (make-local-variable 'find-file-literally)
1374 (setq find-file-literally t))
1375 (after-find-file error (not nowarn)))
1376 (current-buffer))))
1378 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1379 "Like `insert-file-contents', but only reads in the file literally.
1380 A buffer may be modified in several ways after reading into the buffer,
1381 to Emacs features such as format decoding, character code
1382 conversion, `find-file-hook', automatic uncompression, etc.
1384 This function ensures that none of these modifications will take place."
1385 (let ((format-alist nil)
1386 (after-insert-file-functions nil)
1387 (coding-system-for-read 'no-conversion)
1388 (coding-system-for-write 'no-conversion)
1389 (find-buffer-file-type-function
1390 (if (fboundp 'find-buffer-file-type)
1391 (symbol-function 'find-buffer-file-type)
1392 nil))
1393 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1394 (inhibit-file-name-operation 'insert-file-contents))
1395 (unwind-protect
1396 (progn
1397 (fset 'find-buffer-file-type (lambda (filename) t))
1398 (insert-file-contents filename visit beg end replace))
1399 (if find-buffer-file-type-function
1400 (fset 'find-buffer-file-type find-buffer-file-type-function)
1401 (fmakunbound 'find-buffer-file-type)))))
1403 (defun insert-file-1 (filename insert-func)
1404 (if (file-directory-p filename)
1405 (signal 'file-error (list "Opening input file" "file is a directory"
1406 filename)))
1407 (let* ((buffer (find-buffer-visiting (abbreviate-file-name (file-truename filename))
1408 #'buffer-modified-p))
1409 (tem (funcall insert-func filename)))
1410 (push-mark (+ (point) (car (cdr tem))))
1411 (when buffer
1412 (message "File %s already visited and modified in buffer %s"
1413 filename (buffer-name buffer)))))
1415 (defun insert-file-literally (filename)
1416 "Insert contents of file FILENAME into buffer after point with no conversion.
1418 This function is meant for the user to run interactively.
1419 Don't call it from programs! Use `insert-file-contents-literally' instead.
1420 \(Its calling sequence is different; see its documentation)."
1421 (interactive "*fInsert file literally: ")
1422 (insert-file-1 filename #'insert-file-contents-literally))
1424 (defvar find-file-literally nil
1425 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1426 This is a permanent local.")
1427 (put 'find-file-literally 'permanent-local t)
1429 (defun find-file-literally (filename)
1430 "Visit file FILENAME with no conversion of any kind.
1431 Format conversion and character code conversion are both disabled,
1432 and multibyte characters are disabled in the resulting buffer.
1433 The major mode used is Fundamental mode regardless of the file name,
1434 and local variable specifications in the file are ignored.
1435 Automatic uncompression and adding a newline at the end of the
1436 file due to `require-final-newline' is also disabled.
1438 You cannot absolutely rely on this function to result in
1439 visiting the file literally. If Emacs already has a buffer
1440 which is visiting the file, you get the existing buffer,
1441 regardless of whether it was created literally or not.
1443 In a Lisp program, if you want to be sure of accessing a file's
1444 contents literally, you should create a temporary buffer and then read
1445 the file contents into it using `insert-file-contents-literally'."
1446 (interactive "FFind file literally: ")
1447 (switch-to-buffer (find-file-noselect filename nil t)))
1449 (defvar after-find-file-from-revert-buffer nil)
1451 (defun after-find-file (&optional error warn noauto
1452 after-find-file-from-revert-buffer
1453 nomodes)
1454 "Called after finding a file and by the default revert function.
1455 Sets buffer mode, parses local variables.
1456 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1457 error in reading the file. WARN non-nil means warn if there
1458 exists an auto-save file more recent than the visited file.
1459 NOAUTO means don't mess with auto-save mode.
1460 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1461 means this call was from `revert-buffer'.
1462 Fifth arg NOMODES non-nil means don't alter the file's modes.
1463 Finishes by calling the functions in `find-file-hook'
1464 unless NOMODES is non-nil."
1465 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1466 (if noninteractive
1468 (let* (not-serious
1469 (msg
1470 (cond
1471 ((not warn) nil)
1472 ((and error (file-attributes buffer-file-name))
1473 (setq buffer-read-only t)
1474 "File exists, but cannot be read")
1475 ((not buffer-read-only)
1476 (if (and warn
1477 ;; No need to warn if buffer is auto-saved
1478 ;; under the name of the visited file.
1479 (not (and buffer-file-name
1480 auto-save-visited-file-name))
1481 (file-newer-than-file-p (or buffer-auto-save-file-name
1482 (make-auto-save-file-name))
1483 buffer-file-name))
1484 (format "%s has auto save data; consider M-x recover-this-file"
1485 (file-name-nondirectory buffer-file-name))
1486 (setq not-serious t)
1487 (if error "(New file)" nil)))
1488 ((not error)
1489 (setq not-serious t)
1490 "Note: file is write protected")
1491 ((file-attributes (directory-file-name default-directory))
1492 "File not found and directory write-protected")
1493 ((file-exists-p (file-name-directory buffer-file-name))
1494 (setq buffer-read-only nil))
1496 (setq buffer-read-only nil)
1497 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1498 "Use M-x make-directory RET RET to create the directory"
1499 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1500 (when msg
1501 (message "%s" msg)
1502 (or not-serious (sit-for 1 nil t))))
1503 (when (and auto-save-default (not noauto))
1504 (auto-save-mode t)))
1505 ;; Make people do a little extra work (C-x C-q)
1506 ;; before altering a backup file.
1507 (when (backup-file-name-p buffer-file-name)
1508 (setq buffer-read-only t))
1509 ;; When a file is marked read-only,
1510 ;; make the buffer read-only even if root is looking at it.
1511 (when (and (file-modes (buffer-file-name))
1512 (zerop (logand (file-modes (buffer-file-name)) #o222)))
1513 (setq buffer-read-only t))
1514 (unless nomodes
1515 (when (and view-read-only view-mode)
1516 (view-mode-disable))
1517 (normal-mode t)
1518 (when (and buffer-read-only
1519 view-read-only
1520 (not (eq (get major-mode 'mode-class) 'special)))
1521 (view-mode-enter))
1522 (run-hooks 'find-file-hook)))
1524 (defun normal-mode (&optional find-file)
1525 "Choose the major mode for this buffer automatically.
1526 Also sets up any specified local variables of the file.
1527 Uses the visited file name, the -*- line, and the local variables spec.
1529 This function is called automatically from `find-file'. In that case,
1530 we may set up the file-specified mode and local variables,
1531 depending on the value of `enable-local-variables': if it is t, we do;
1532 if it is nil, we don't; otherwise, we query.
1533 In addition, if `local-enable-local-variables' is nil, we do
1534 not set local variables (though we do notice a mode specified with -*-.)
1536 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1537 or from Lisp without specifying the optional argument FIND-FILE;
1538 in that case, this function acts as if `enable-local-variables' were t."
1539 (interactive)
1540 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1541 (condition-case err
1542 (set-auto-mode)
1543 (error (message "File mode specification error: %s"
1544 (prin1-to-string err))))
1545 (condition-case err
1546 (let ((enable-local-variables (or (not find-file)
1547 enable-local-variables)))
1548 (hack-local-variables))
1549 (error (message "File local-variables error: %s"
1550 (prin1-to-string err))))
1551 (if (fboundp 'ucs-set-table-for-input) ; don't lose when building
1552 (ucs-set-table-for-input)))
1554 (defvar auto-mode-alist
1555 (mapc
1556 (lambda (elt)
1557 (cons (purecopy (car elt)) (cdr elt)))
1558 '(("\\.te?xt\\'" . text-mode)
1559 ("\\.c\\'" . c-mode)
1560 ("\\.h\\'" . c-mode)
1561 ("\\.tex\\'" . tex-mode)
1562 ("\\.ins\\'" . tex-mode) ;Installation files for TeX packages.
1563 ("\\.ltx\\'" . latex-mode)
1564 ("\\.dtx\\'" . doctex-mode)
1565 ("\\.el\\'" . emacs-lisp-mode)
1566 ("\\.scm\\'" . scheme-mode)
1567 ("\\.l\\'" . lisp-mode)
1568 ("\\.lisp\\'" . lisp-mode)
1569 ("\\.f\\'" . fortran-mode)
1570 ("\\.F\\'" . fortran-mode)
1571 ("\\.for\\'" . fortran-mode)
1572 ("\\.p\\'" . pascal-mode)
1573 ("\\.pas\\'" . pascal-mode)
1574 ("\\.ad[abs]\\'" . ada-mode)
1575 ("\\.ad[bs].dg\\'" . ada-mode)
1576 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
1577 ("\\.s?html?\\'" . html-mode)
1578 ("\\.cc\\'" . c++-mode)
1579 ("\\.hh\\'" . c++-mode)
1580 ("\\.hpp\\'" . c++-mode)
1581 ("\\.C\\'" . c++-mode)
1582 ("\\.H\\'" . c++-mode)
1583 ("\\.cpp\\'" . c++-mode)
1584 ("\\.cxx\\'" . c++-mode)
1585 ("\\.hxx\\'" . c++-mode)
1586 ("\\.c\\+\\+\\'" . c++-mode)
1587 ("\\.h\\+\\+\\'" . c++-mode)
1588 ("\\.m\\'" . objc-mode)
1589 ("\\.java\\'" . java-mode)
1590 ("\\.mk\\'" . makefile-mode)
1591 ("\\(M\\|m\\|GNUm\\)akefile\\'" . makefile-mode)
1592 ("\\.am\\'" . makefile-mode) ;For Automake.
1593 ;; Less common extensions come here
1594 ;; so more common ones above are found faster.
1595 ("\\.texinfo\\'" . texinfo-mode)
1596 ("\\.te?xi\\'" . texinfo-mode)
1597 ("\\.s\\'" . asm-mode)
1598 ("\\.S\\'" . asm-mode)
1599 ("\\.asm\\'" . asm-mode)
1600 ("ChangeLog\\'" . change-log-mode)
1601 ("change\\.log\\'" . change-log-mode)
1602 ("changelo\\'" . change-log-mode)
1603 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1604 ;; for MSDOS and MS-Windows (which are case-insensitive)
1605 ("changelog\\'" . change-log-mode)
1606 ("changelog\\.[0-9]+\\'" . change-log-mode)
1607 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1608 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1609 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1610 ("\\.bash\\'" . sh-mode)
1611 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1612 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1613 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1614 ("\\.m?spec\\'" . sh-mode)
1615 ("\\.mm\\'" . nroff-mode)
1616 ("\\.me\\'" . nroff-mode)
1617 ("\\.ms\\'" . nroff-mode)
1618 ("\\.man\\'" . nroff-mode)
1619 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
1620 ("\\.TeX\\'" . tex-mode)
1621 ("\\.sty\\'" . latex-mode)
1622 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1623 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1624 ("\\.bbl\\'" . latex-mode)
1625 ("\\.bib\\'" . bibtex-mode)
1626 ("\\.sql\\'" . sql-mode)
1627 ("\\.m4\\'" . m4-mode)
1628 ("\\.mc\\'" . m4-mode)
1629 ("\\.mf\\'" . metafont-mode)
1630 ("\\.mp\\'" . metapost-mode)
1631 ("\\.vhdl?\\'" . vhdl-mode)
1632 ("\\.article\\'" . text-mode)
1633 ("\\.letter\\'" . text-mode)
1634 ("\\.tcl\\'" . tcl-mode)
1635 ("\\.exp\\'" . tcl-mode)
1636 ("\\.itcl\\'" . tcl-mode)
1637 ("\\.itk\\'" . tcl-mode)
1638 ("\\.icn\\'" . icon-mode)
1639 ("\\.sim\\'" . simula-mode)
1640 ("\\.mss\\'" . scribe-mode)
1641 ("\\.f90\\'" . f90-mode)
1642 ("\\.f95\\'" . f90-mode)
1643 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1644 ("\\.pro\\'" . idlwave-mode)
1645 ("\\.lsp\\'" . lisp-mode)
1646 ("\\.awk\\'" . awk-mode)
1647 ("\\.prolog\\'" . prolog-mode)
1648 ("\\.tar\\'" . tar-mode)
1649 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|ear\\|jar\\|war\\)\\'" . archive-mode)
1650 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|EAR\\|JAR\\|WAR\\)\\'" . archive-mode)
1651 ("\\.sx[dmicw]\\'" . archive-mode) ; OpenOffice.org
1652 ;; Mailer puts message to be edited in
1653 ;; /tmp/Re.... or Message
1654 ("\\`/tmp/Re" . text-mode)
1655 ("/Message[0-9]*\\'" . text-mode)
1656 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1657 ("\\.zone\\'" . zone-mode)
1658 ;; some news reader is reported to use this
1659 ("\\`/tmp/fol/" . text-mode)
1660 ("\\.y\\'" . c-mode)
1661 ("\\.lex\\'" . c-mode)
1662 ("\\.oak\\'" . scheme-mode)
1663 ("\\.sgml?\\'" . sgml-mode)
1664 ("\\.xml\\'" . sgml-mode)
1665 ("\\.xsl\\'" . sgml-mode)
1666 ("\\.dtd\\'" . sgml-mode)
1667 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1668 ("\\.idl\\'" . idl-mode)
1669 ;; .emacs or .gnus or .viper following a directory delimiter in
1670 ;; Unix, MSDOG or VMS syntax.
1671 ("[]>:/\\]\\..*\\(emacs\\|gnus\\|viper\\)\\'" . emacs-lisp-mode)
1672 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1673 ;; _emacs following a directory delimiter
1674 ;; in MsDos syntax
1675 ("[:/]_emacs\\'" . emacs-lisp-mode)
1676 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1677 ("\\.ml\\'" . lisp-mode)
1678 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1679 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1680 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1681 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1682 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1683 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1684 ("BROWSE\\'" . ebrowse-tree-mode)
1685 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1686 ("#\\*mail\\*" . mail-mode)
1687 ;; Get rid of any trailing .n.m and try again.
1688 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1689 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1690 ;; Using mode nil rather than `ignore' would let the search continue
1691 ;; through this list (with the shortened name) rather than start over.
1692 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1693 ;; The following should come after the ChangeLog pattern
1694 ;; for the sake of ChangeLog.1, etc.
1695 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1696 ("\\.[1-9]\\'" . nroff-mode)
1697 ("\\.g\\'" . antlr-mode)
1698 ("\\.ses\\'" . ses-mode)
1699 ("\\.in\\'" nil t)))
1700 "Alist of filename patterns vs corresponding major mode functions.
1701 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1702 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1703 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1704 mode function to use. FUNCTION will be called, unless it is nil.
1706 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1707 calling FUNCTION (if it's not nil), we delete the suffix that matched
1708 REGEXP and search the list again for another match.")
1711 (defvar interpreter-mode-alist
1712 (mapc
1713 (lambda (l)
1714 (cons (purecopy (car l)) (cdr l)))
1715 '(("perl" . perl-mode)
1716 ("perl5" . perl-mode)
1717 ("miniperl" . perl-mode)
1718 ("wish" . tcl-mode)
1719 ("wishx" . tcl-mode)
1720 ("tcl" . tcl-mode)
1721 ("tclsh" . tcl-mode)
1722 ("awk" . awk-mode)
1723 ("mawk" . awk-mode)
1724 ("nawk" . awk-mode)
1725 ("gawk" . awk-mode)
1726 ("scm" . scheme-mode)
1727 ("ash" . sh-mode)
1728 ("bash" . sh-mode)
1729 ("bash2" . sh-mode)
1730 ("csh" . sh-mode)
1731 ("dtksh" . sh-mode)
1732 ("es" . sh-mode)
1733 ("itcsh" . sh-mode)
1734 ("jsh" . sh-mode)
1735 ("ksh" . sh-mode)
1736 ("oash" . sh-mode)
1737 ("pdksh" . sh-mode)
1738 ("rc" . sh-mode)
1739 ("rpm" . sh-mode)
1740 ("sh" . sh-mode)
1741 ("sh5" . sh-mode)
1742 ("tcsh" . sh-mode)
1743 ("wksh" . sh-mode)
1744 ("wsh" . sh-mode)
1745 ("zsh" . sh-mode)
1746 ("tail" . text-mode)
1747 ("more" . text-mode)
1748 ("less" . text-mode)
1749 ("pg" . text-mode)
1750 ("make" . makefile-mode) ; Debian uses this
1751 ("guile" . scheme-mode)
1752 ("clisp" . lisp-mode)))
1753 "Alist mapping interpreter names to major modes.
1754 This alist applies to files whose first line starts with `#!'.
1755 Each element looks like (INTERPRETER . MODE).
1756 The car of each element is compared with
1757 the name of the interpreter specified in the first line.
1758 If it matches, mode MODE is selected.")
1760 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1761 "List of regexps; if one matches a file name, don't look for `-*-'.")
1763 (defvar inhibit-first-line-modes-suffixes nil
1764 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1765 When checking `inhibit-first-line-modes-regexps', we first discard
1766 from the end of the file name anything that matches one of these regexps.")
1768 (defvar auto-mode-interpreter-regexp
1769 "#![ \t]?\\([^ \t\n]*\
1770 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1771 "Regular expression matching interpreters, for file mode determination.
1772 This regular expression is matched against the first line of a file
1773 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1774 a mode from the file's name. If it matches, the file is assumed to
1775 be interpreted by the interpreter matched by the second group of the
1776 regular expression. The mode is then determined as the mode associated
1777 with that interpreter in `interpreter-mode-alist'.")
1779 (defun set-auto-mode (&optional just-from-file-name)
1780 "Select major mode appropriate for current buffer.
1781 This checks for a -*- mode tag in the buffer's text,
1782 compares the filename against the entries in `auto-mode-alist',
1783 or checks the interpreter that runs this file against
1784 `interpreter-mode-alist'.
1786 It does not check for the `mode:' local variable in the
1787 Local Variables section of the file; for that, use `hack-local-variables'.
1789 If `enable-local-variables' is nil, this function does not check for a
1790 -*- mode tag.
1792 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1793 then we do not set anything but the major mode,
1794 and we don't even do that unless it would come from the file name."
1795 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1796 (let (end done modes)
1797 (save-excursion
1798 (goto-char (point-min))
1799 (skip-chars-forward " \t\n")
1800 (and enable-local-variables
1801 (setq end (set-auto-mode-1))
1802 (if (save-excursion (search-forward ":" end t))
1803 ;; Find all specifications for the `mode:' variable
1804 ;; and execute them left to right.
1805 (while (let ((case-fold-search t))
1806 (or (and (looking-at "mode:")
1807 (goto-char (match-end 0)))
1808 (re-search-forward "[ \t;]mode:" end t)))
1809 (skip-chars-forward " \t")
1810 (let ((beg (point)))
1811 (if (search-forward ";" end t)
1812 (forward-char -1)
1813 (goto-char end))
1814 (skip-chars-backward " \t")
1815 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1816 modes)))
1817 ;; Simple -*-MODE-*- case.
1818 (push (intern (concat (downcase (buffer-substring (point) end))
1819 "-mode"))
1820 modes))))
1821 ;; If we found modes to use, invoke them now,
1822 ;; outside the save-excursion.
1823 (unless just-from-file-name
1824 (dolist (mode (nreverse modes))
1825 (if (not (functionp mode))
1826 (message "Ignoring unknown mode `%s'" mode)
1827 (setq done t)
1828 (funcall mode))))
1829 ;; If we didn't find a mode from a -*- line, try using the file name.
1830 (if (and (not done) buffer-file-name)
1831 (let ((name buffer-file-name)
1832 (keep-going t))
1833 ;; Remove backup-suffixes from file name.
1834 (setq name (file-name-sans-versions name))
1835 (while keep-going
1836 (setq keep-going nil)
1837 (let ((alist auto-mode-alist)
1838 (mode nil))
1839 ;; Find first matching alist entry.
1840 (let ((case-fold-search
1841 (memq system-type '(vax-vms windows-nt cygwin))))
1842 (while (and (not mode) alist)
1843 (if (string-match (car (car alist)) name)
1844 (if (and (consp (cdr (car alist)))
1845 (nth 2 (car alist)))
1846 (setq mode (car (cdr (car alist)))
1847 name (substring name 0 (match-beginning 0))
1848 keep-going t)
1849 (setq mode (cdr (car alist))
1850 keep-going nil)))
1851 (setq alist (cdr alist))))
1852 (if mode
1853 ;; When JUST-FROM-FILE-NAME is set,
1854 ;; we are working on behalf of set-visited-file-name.
1855 ;; In that case, if the major mode specified is the
1856 ;; same one we already have, don't actually reset it.
1857 ;; We don't want to lose minor modes such as Font Lock.
1858 (unless (and just-from-file-name (eq mode major-mode))
1859 (funcall mode))
1860 ;; If we can't deduce a mode from the file name,
1861 ;; look for an interpreter specified in the first line.
1862 ;; As a special case, allow for things like "#!/bin/env perl",
1863 ;; which finds the interpreter anywhere in $PATH.
1864 (let ((interpreter
1865 (save-excursion
1866 (goto-char (point-min))
1867 (if (looking-at auto-mode-interpreter-regexp)
1868 (match-string 2)
1869 "")))
1870 elt)
1871 ;; Map interpreter name to a mode.
1872 (setq elt (assoc (file-name-nondirectory interpreter)
1873 interpreter-mode-alist))
1874 (unless just-from-file-name
1875 (if elt
1876 (funcall (cdr elt))))))))))))
1879 (defun set-auto-mode-1 ()
1880 "Find the -*- spec in the buffer.
1881 Call with point at the place to start searching from.
1882 If one is found, set point to the beginning
1883 and return the position of the end.
1884 Otherwise, return nil; point may be changed."
1885 (let (beg end)
1886 (and
1887 ;; Don't look for -*- if this file name matches any
1888 ;; of the regexps in inhibit-first-line-modes-regexps.
1889 (let ((temp inhibit-first-line-modes-regexps)
1890 (name (if buffer-file-name
1891 (file-name-sans-versions buffer-file-name)
1892 (buffer-name))))
1893 (while (let ((sufs inhibit-first-line-modes-suffixes))
1894 (while (and sufs (not (string-match (car sufs) name)))
1895 (setq sufs (cdr sufs)))
1896 sufs)
1897 (setq name (substring name 0 (match-beginning 0))))
1898 (while (and temp
1899 (not (string-match (car temp) name)))
1900 (setq temp (cdr temp)))
1901 (not temp))
1903 (search-forward "-*-" (save-excursion
1904 ;; If the file begins with "#!"
1905 ;; (exec interpreter magic), look
1906 ;; for mode frobs in the first two
1907 ;; lines. You cannot necessarily
1908 ;; put them in the first line of
1909 ;; such a file without screwing up
1910 ;; the interpreter invocation.
1911 (end-of-line (and (looking-at "^#!") 2))
1912 (point)) t)
1913 (progn
1914 (skip-chars-forward " \t")
1915 (setq beg (point))
1916 (search-forward "-*-"
1917 (save-excursion (end-of-line) (point))
1919 (progn
1920 (forward-char -3)
1921 (skip-chars-backward " \t")
1922 (setq end (point))
1923 (goto-char beg)
1924 end))))
1926 (defun hack-local-variables-prop-line (&optional mode-only)
1927 "Set local variables specified in the -*- line.
1928 Ignore any specification for `mode:' and `coding:';
1929 `set-auto-mode' should already have handled `mode:',
1930 `set-auto-coding' should already have handled `coding:'.
1931 If MODE-ONLY is non-nil, all we do is check whether the major mode
1932 is specified, returning t if it is specified."
1933 (save-excursion
1934 (goto-char (point-min))
1935 (let ((result nil)
1936 (end (set-auto-mode-1))
1937 mode-specified
1938 (enable-local-variables
1939 (and local-enable-local-variables enable-local-variables)))
1940 ;; Parse the -*- line into the RESULT alist.
1941 ;; Also set MODE-SPECIFIED if we see a spec or `mode'.
1942 (cond ((not end)
1943 nil)
1944 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1945 ;; Simple form: "-*- MODENAME -*-". Already handled.
1946 (setq mode-specified t)
1947 nil)
1949 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1950 ;; (last ";" is optional).
1951 (while (< (point) end)
1952 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1953 (error "Malformed -*- line"))
1954 (goto-char (match-end 0))
1955 ;; There used to be a downcase here,
1956 ;; but the manual didn't say so,
1957 ;; and people want to set var names that aren't all lc.
1958 (let ((key (intern (buffer-substring
1959 (match-beginning 1)
1960 (match-end 1))))
1961 (val (save-restriction
1962 (narrow-to-region (point) end)
1963 (read (current-buffer)))))
1964 ;; It is traditional to ignore
1965 ;; case when checking for `mode' in set-auto-mode,
1966 ;; so we must do that here as well.
1967 ;; That is inconsistent, but we're stuck with it.
1968 ;; The same can be said for `coding' in set-auto-coding.
1969 (or (equal (downcase (symbol-name key)) "mode")
1970 (equal (downcase (symbol-name key)) "coding")
1971 (setq result (cons (cons key val) result)))
1972 (if (equal (downcase (symbol-name key)) "mode")
1973 (setq mode-specified t))
1974 (skip-chars-forward " \t;")))
1975 (setq result (nreverse result))))
1977 (if mode-only mode-specified
1978 (if (and result
1979 (or mode-only
1980 (eq enable-local-variables t)
1981 (and enable-local-variables
1982 (save-window-excursion
1983 (condition-case nil
1984 (switch-to-buffer (current-buffer))
1985 (error
1986 ;; If we fail to switch in the selected window,
1987 ;; it is probably a minibuffer.
1988 ;; So try another window.
1989 (condition-case nil
1990 (switch-to-buffer-other-window (current-buffer))
1991 (error
1992 (switch-to-buffer-other-frame (current-buffer))))))
1993 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1994 (file-name-nondirectory buffer-file-name)))))))
1995 (let ((enable-local-eval enable-local-eval))
1996 (while result
1997 (hack-one-local-variable (car (car result)) (cdr (car result)))
1998 (setq result (cdr result)))))
1999 nil))))
2001 (defvar hack-local-variables-hook nil
2002 "Normal hook run after processing a file's local variables specs.
2003 Major modes can use this to examine user-specified local variables
2004 in order to initialize other data structure based on them.")
2006 (defun hack-local-variables (&optional mode-only)
2007 "Parse and put into effect this buffer's local variables spec.
2008 If MODE-ONLY is non-nil, all we do is check whether the major mode
2009 is specified, returning t if it is specified."
2010 (let ((mode-specified
2011 ;; If MODE-ONLY is t, we check here for specifying the mode
2012 ;; in the -*- line. If MODE-ONLY is nil, we process
2013 ;; the -*- line here.
2014 (hack-local-variables-prop-line mode-only))
2015 (enable-local-variables
2016 (and local-enable-local-variables enable-local-variables)))
2017 ;; Look for "Local variables:" line in last page.
2018 (save-excursion
2019 (goto-char (point-max))
2020 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
2021 (if (let ((case-fold-search t))
2022 (and (search-forward "Local Variables:" nil t)
2023 (or (eq enable-local-variables t)
2024 mode-only
2025 (and enable-local-variables
2026 (save-window-excursion
2027 (switch-to-buffer (current-buffer))
2028 (save-excursion
2029 (beginning-of-line)
2030 (set-window-start (selected-window) (point)))
2031 (y-or-n-p (format "Set local variables as specified at end of %s? "
2032 (if buffer-file-name
2033 (file-name-nondirectory
2034 buffer-file-name)
2035 (concat "buffer "
2036 (buffer-name))))))))))
2037 (let ((continue t)
2038 prefix prefixlen suffix beg
2039 mode-specified
2040 (enable-local-eval enable-local-eval))
2041 ;; The prefix is what comes before "local variables:" in its line.
2042 ;; The suffix is what comes after "local variables:" in its line.
2043 (skip-chars-forward " \t")
2044 (or (eolp)
2045 (setq suffix (buffer-substring (point)
2046 (progn (end-of-line) (point)))))
2047 (goto-char (match-beginning 0))
2048 (or (bolp)
2049 (setq prefix
2050 (buffer-substring (point)
2051 (progn (beginning-of-line) (point)))))
2053 (if prefix (setq prefixlen (length prefix)
2054 prefix (regexp-quote prefix)))
2055 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
2056 (while continue
2057 ;; Look at next local variable spec.
2058 (if selective-display (re-search-forward "[\n\C-m]")
2059 (forward-line 1))
2060 ;; Skip the prefix, if any.
2061 (if prefix
2062 (if (looking-at prefix)
2063 (forward-char prefixlen)
2064 (error "Local variables entry is missing the prefix")))
2065 ;; Find the variable name; strip whitespace.
2066 (skip-chars-forward " \t")
2067 (setq beg (point))
2068 (skip-chars-forward "^:\n")
2069 (if (eolp) (error "Missing colon in local variables entry"))
2070 (skip-chars-backward " \t")
2071 (let* ((str (buffer-substring beg (point)))
2072 (var (read str))
2073 val)
2074 ;; Setting variable named "end" means end of list.
2075 (if (string-equal (downcase str) "end")
2076 (setq continue nil)
2077 ;; Otherwise read the variable value.
2078 (skip-chars-forward "^:")
2079 (forward-char 1)
2080 (setq val (read (current-buffer)))
2081 (skip-chars-backward "\n")
2082 (skip-chars-forward " \t")
2083 (or (if suffix (looking-at suffix) (eolp))
2084 (error "Local variables entry is terminated incorrectly"))
2085 (if mode-only
2086 (if (eq var 'mode)
2087 (setq mode-specified t))
2088 ;; Set the variable. "Variables" mode and eval are funny.
2089 (hack-one-local-variable var val))))))))
2090 (unless mode-only
2091 (run-hooks 'hack-local-variables-hook))
2092 mode-specified))
2094 (defvar ignored-local-variables
2095 '(enable-local-eval)
2096 "Variables to be ignored in a file's local variable spec.")
2098 ;; Get confirmation before setting these variables as locals in a file.
2099 (put 'debugger 'risky-local-variable t)
2100 (put 'enable-local-eval 'risky-local-variable t)
2101 (put 'ignored-local-variables 'risky-local-variable t)
2102 (put 'eval 'risky-local-variable t)
2103 (put 'file-name-handler-alist 'risky-local-variable t)
2104 (put 'inhibit-quit 'risky-local-variable t)
2105 (put 'minor-mode-alist 'risky-local-variable t)
2106 (put 'minor-mode-map-alist 'risky-local-variable t)
2107 (put 'minor-mode-overriding-map-alist 'risky-local-variable t)
2108 (put 'overriding-local-map 'risky-local-variable t)
2109 (put 'overriding-terminal-local-map 'risky-local-variable t)
2110 (put 'auto-mode-alist 'risky-local-variable t)
2111 (put 'after-load-alist 'risky-local-variable t)
2112 (put 'buffer-file-name 'risky-local-variable t)
2113 (put 'buffer-undo-list 'risky-local-variable t)
2114 (put 'buffer-auto-save-file-name 'risky-local-variable t)
2115 (put 'buffer-file-truename 'risky-local-variable t)
2116 (put 'default-text-properties 'risky-local-variable t)
2117 (put 'exec-path 'risky-local-variable t)
2118 (put 'load-path 'risky-local-variable t)
2119 (put 'exec-directory 'risky-local-variable t)
2120 (put 'process-environment 'risky-local-variable t)
2121 (put 'dabbrev-case-fold-search 'risky-local-variable t)
2122 (put 'dabbrev-case-replace 'risky-local-variable t)
2123 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
2124 (put 'outline-level 'risky-local-variable t)
2125 (put 'rmail-output-file-alist 'risky-local-variable t)
2126 (put 'font-lock-defaults 'risky-local-variable t)
2127 (put 'special-display-buffer-names 'risky-local-variable t)
2128 (put 'frame-title-format 'risky-local-variable t)
2129 (put 'global-mode-string 'risky-local-variable t)
2130 (put 'header-line-format 'risky-local-variable t)
2131 (put 'icon-title-format 'risky-local-variable t)
2132 (put 'input-method-alist 'risky-local-variable t)
2133 (put 'format-alist 'risky-local-variable t)
2134 (put 'vc-mode 'risky-local-variable t)
2135 (put 'imenu-generic-expression 'risky-local-variable t)
2136 (put 'imenu-index-alist 'risky-local-variable t)
2137 (put 'standard-input 'risky-local-variable t)
2138 (put 'standard-output 'risky-local-variable t)
2139 (put 'unread-command-events 'risky-local-variable t)
2140 (put 'max-lisp-eval-depth 'risky-local-variable t)
2141 (put 'max-specpdl-size 'risky-local-variable t)
2142 (put 'mode-line-format 'risky-local-variable t)
2143 (put 'mode-line-modified 'risky-local-variable t)
2144 (put 'mode-line-mule-info 'risky-local-variable t)
2145 (put 'mode-line-buffer-identification 'risky-local-variable t)
2146 (put 'mode-line-modes 'risky-local-variable t)
2147 (put 'mode-line-position 'risky-local-variable t)
2148 (put 'mode-line-process 'risky-local-variable t)
2149 (put 'mode-name 'risky-local-variable t)
2150 (put 'display-time-string 'risky-local-variable t)
2151 (put 'parse-time-rules 'risky-local-variable t)
2153 ;; This case is safe because the user gets to check it before it is used.
2154 (put 'compile-command 'safe-local-variable 'stringp)
2156 (defun risky-local-variable-p (sym val)
2157 "Non-nil if SYM could be dangerous as a file-local variable with value VAL.
2158 If VAL is nil, the question is whether any value might be dangerous."
2159 (let ((safep (get sym 'safe-local-variable)))
2160 (or (memq sym ignored-local-variables)
2161 (get sym 'risky-local-variable)
2162 (and (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$\\|font-lock-keywords$\\|font-lock-keywords-[0-9]+$\\|font-lock-syntactic-keywords$\\|-frame-alist$\\|-mode-alist$\\|-map$\\|-map-alist$"
2163 (symbol-name sym))
2164 (not safep))
2165 ;; If the safe-local-variable property isn't t or nil,
2166 ;; then it must return non-nil on the proposed value to be safe.
2167 (and (not (memq safep '(t nil)))
2168 (or (null val)
2169 (not (funcall safep val)))))))
2171 (defcustom safe-local-eval-forms nil
2172 "*Expressions that are considered \"safe\" in an `eval:' local variable.
2173 Add expressions to this list if you want Emacs to evaluate them, when
2174 they appear in an `eval' local variable specification, without first
2175 asking you for confirmation."
2176 :group 'find-file
2177 :version "21.4"
2178 :type '(repeat sexp))
2180 (put 'c-set-style 'safe-local-eval-function t)
2182 (defun hack-one-local-variable-quotep (exp)
2183 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
2185 (defun hack-one-local-variable-constantp (exp)
2186 (or (and (not (symbolp exp)) (not (consp exp)))
2187 (memq exp '(t nil))
2188 (keywordp exp)
2189 (hack-one-local-variable-quotep exp)))
2191 (defun hack-one-local-variable-eval-safep (exp)
2192 "Return t if it is safe to eval EXP when it is found in a file."
2193 (or (not (consp exp))
2194 ;; Detect certain `put' expressions.
2195 (and (eq (car exp) 'put)
2196 (hack-one-local-variable-quotep (nth 1 exp))
2197 (hack-one-local-variable-quotep (nth 2 exp))
2198 (memq (nth 1 (nth 2 exp))
2199 '(lisp-indent-hook))
2200 ;; Only allow safe values of lisp-indent-hook;
2201 ;; not functions.
2202 (or (numberp (nth 3 exp))
2203 (equal (nth 3 exp) ''defun)))
2204 ;; Allow expressions that the user requested.
2205 (member exp safe-local-eval-forms)
2206 ;; Certain functions can be allowed with safe arguments
2207 ;; or can specify verification functions to try.
2208 (and (symbolp (car exp))
2209 (let ((prop (get (car exp) 'safe-local-eval-function)))
2210 (cond ((eq prop t)
2211 (let ((ok t))
2212 (dolist (arg (cdr exp))
2213 (unless (hack-one-local-variable-constantp arg)
2214 (setq ok nil)))
2215 ok))
2216 ((functionp prop)
2217 (funcall prop exp))
2218 ((listp prop)
2219 (let ((ok nil))
2220 (dolist (function prop)
2221 (if (funcall function exp)
2222 (setq ok t)))
2223 ok)))))))
2225 (defun hack-one-local-variable (var val)
2226 "\"Set\" one variable in a local variables spec.
2227 A few patterns are specified so that any name which matches one
2228 is considered risky."
2229 (cond ((eq var 'mode)
2230 (funcall (intern (concat (downcase (symbol-name val))
2231 "-mode"))))
2232 ((eq var 'coding)
2233 ;; We have already handled coding: tag in set-auto-coding.
2234 nil)
2235 ;; "Setting" eval means either eval it or do nothing.
2236 ;; Likewise for setting hook variables.
2237 ((risky-local-variable-p var val)
2238 ;; Permit evalling a put of a harmless property.
2239 ;; if the args do nothing tricky.
2240 (if (or (and (eq var 'eval)
2241 (hack-one-local-variable-eval-safep val))
2242 ;; Permit eval if not root and user says ok.
2243 (and (not (zerop (user-uid)))
2244 (or (eq enable-local-eval t)
2245 (and enable-local-eval
2246 (save-window-excursion
2247 (switch-to-buffer (current-buffer))
2248 (save-excursion
2249 (beginning-of-line)
2250 (set-window-start (selected-window) (point)))
2251 (setq enable-local-eval
2252 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
2253 (if buffer-file-name
2254 (concat "file " (file-name-nondirectory buffer-file-name))
2255 (concat "buffer " (buffer-name)))))))))))
2256 (if (eq var 'eval)
2257 (save-excursion (eval val))
2258 (make-local-variable var)
2259 (set var val))
2260 (message "Ignoring risky spec in the local variables list")))
2261 ;; Ordinary variable, really set it.
2262 (t (make-local-variable var)
2263 ;; Make sure the string has no text properties.
2264 ;; Some text properties can get evaluated in various ways,
2265 ;; so it is risky to put them on with a local variable list.
2266 (if (stringp val)
2267 (set-text-properties 0 (length val) nil val))
2268 (set var val))))
2271 (defcustom change-major-mode-with-file-name t
2272 "*Non-nil means \\[write-file] should set the major mode from the file name.
2273 However, the mode will not be changed if
2274 \(1) a local variables list or the `-*-' line specifies a major mode, or
2275 \(2) the current major mode is a \"special\" mode,
2276 \ not suitable for ordinary files, or
2277 \(3) the new file name does not particularly specify any mode."
2278 :type 'boolean
2279 :group 'editing-basics)
2281 (defun set-visited-file-name (filename &optional no-query along-with-file)
2282 "Change name of file visited in current buffer to FILENAME.
2283 The next time the buffer is saved it will go in the newly specified file.
2284 nil or empty string as argument means make buffer not be visiting any file.
2285 Remember to delete the initial contents of the minibuffer
2286 if you wish to pass an empty string as the argument.
2288 The optional second argument NO-QUERY, if non-nil, inhibits asking for
2289 confirmation in the case where another buffer is already visiting FILENAME.
2291 The optional third argument ALONG-WITH-FILE, if non-nil, means that
2292 the old visited file has been renamed to the new name FILENAME."
2293 (interactive "FSet visited file name: ")
2294 (if (buffer-base-buffer)
2295 (error "An indirect buffer cannot visit a file"))
2296 (let (truename)
2297 (if filename
2298 (setq filename
2299 (if (string-equal filename "")
2301 (expand-file-name filename))))
2302 (if filename
2303 (progn
2304 (setq truename (file-truename filename))
2305 (if find-file-visit-truename
2306 (setq filename truename))))
2307 (let ((buffer (and filename (find-buffer-visiting filename))))
2308 (and buffer (not (eq buffer (current-buffer)))
2309 (not no-query)
2310 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
2311 filename)))
2312 (error "Aborted")))
2313 (or (equal filename buffer-file-name)
2314 (progn
2315 (and filename (lock-buffer filename))
2316 (unlock-buffer)))
2317 (setq buffer-file-name filename)
2318 (if filename ; make buffer name reflect filename.
2319 (let ((new-name (file-name-nondirectory buffer-file-name)))
2320 (if (string= new-name "")
2321 (error "Empty file name"))
2322 (if (eq system-type 'vax-vms)
2323 (setq new-name (downcase new-name)))
2324 (setq default-directory (file-name-directory buffer-file-name))
2325 (or (string= new-name (buffer-name))
2326 (rename-buffer new-name t))))
2327 (setq buffer-backed-up nil)
2328 (or along-with-file
2329 (clear-visited-file-modtime))
2330 ;; Abbreviate the file names of the buffer.
2331 (if truename
2332 (progn
2333 (setq buffer-file-truename (abbreviate-file-name truename))
2334 (if find-file-visit-truename
2335 (setq buffer-file-name buffer-file-truename))))
2336 (setq buffer-file-number
2337 (if filename
2338 (nthcdr 10 (file-attributes buffer-file-name))
2339 nil)))
2340 ;; write-file-functions is normally used for things like ftp-find-file
2341 ;; that visit things that are not local files as if they were files.
2342 ;; Changing to visit an ordinary local file instead should flush the hook.
2343 (kill-local-variable 'write-file-functions)
2344 (kill-local-variable 'local-write-file-hooks)
2345 (kill-local-variable 'revert-buffer-function)
2346 (kill-local-variable 'backup-inhibited)
2347 ;; If buffer was read-only because of version control,
2348 ;; that reason is gone now, so make it writable.
2349 (if vc-mode
2350 (setq buffer-read-only nil))
2351 (kill-local-variable 'vc-mode)
2352 ;; Turn off backup files for certain file names.
2353 ;; Since this is a permanent local, the major mode won't eliminate it.
2354 (and buffer-file-name
2355 (not (funcall backup-enable-predicate buffer-file-name))
2356 (progn
2357 (make-local-variable 'backup-inhibited)
2358 (setq backup-inhibited t)))
2359 (let ((oauto buffer-auto-save-file-name))
2360 ;; If auto-save was not already on, turn it on if appropriate.
2361 (if (not buffer-auto-save-file-name)
2362 (and buffer-file-name auto-save-default
2363 (auto-save-mode t))
2364 ;; If auto save is on, start using a new name.
2365 ;; We deliberately don't rename or delete the old auto save
2366 ;; for the old visited file name. This is because perhaps
2367 ;; the user wants to save the new state and then compare with the
2368 ;; previous state from the auto save file.
2369 (setq buffer-auto-save-file-name
2370 (make-auto-save-file-name)))
2371 ;; Rename the old auto save file if any.
2372 (and oauto buffer-auto-save-file-name
2373 (file-exists-p oauto)
2374 (rename-file oauto buffer-auto-save-file-name t)))
2375 (and buffer-file-name
2376 (not along-with-file)
2377 (set-buffer-modified-p t))
2378 ;; Update the major mode, if the file name determines it.
2379 (condition-case nil
2380 ;; Don't change the mode if it is special.
2381 (or (not change-major-mode-with-file-name)
2382 (get major-mode 'mode-class)
2383 ;; Don't change the mode if the local variable list specifies it.
2384 (hack-local-variables t)
2385 (set-auto-mode t))
2386 (error nil)))
2388 (defun write-file (filename &optional confirm)
2389 "Write current buffer into file FILENAME.
2390 This makes the buffer visit that file, and marks it as not modified.
2392 If you specify just a directory name as FILENAME, that means to use
2393 the default file name but in that directory. You can also yank
2394 the default file name into the minibuffer to edit it, using M-n.
2396 If the buffer is not already visiting a file, the default file name
2397 for the output file is the buffer name.
2399 If optional second arg CONFIRM is non-nil, this function
2400 asks for confirmation before overwriting an existing file.
2401 Interactively, confirmation is required unless you supply a prefix argument."
2402 ;; (interactive "FWrite file: ")
2403 (interactive
2404 (list (if buffer-file-name
2405 (read-file-name "Write file: "
2406 nil nil nil nil)
2407 (read-file-name "Write file: " default-directory
2408 (expand-file-name
2409 (file-name-nondirectory (buffer-name))
2410 default-directory)
2411 nil nil))
2412 (not current-prefix-arg)))
2413 (or (null filename) (string-equal filename "")
2414 (progn
2415 ;; If arg is just a directory,
2416 ;; use the default file name, but in that directory.
2417 (if (file-directory-p filename)
2418 (setq filename (concat (file-name-as-directory filename)
2419 (file-name-nondirectory
2420 (or buffer-file-name (buffer-name))))))
2421 (and confirm
2422 (file-exists-p filename)
2423 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2424 (error "Canceled")))
2425 (set-visited-file-name filename (not confirm))))
2426 (set-buffer-modified-p t)
2427 ;; Make buffer writable if file is writable.
2428 (and buffer-file-name
2429 (file-writable-p buffer-file-name)
2430 (setq buffer-read-only nil))
2431 (save-buffer))
2433 (defun backup-buffer ()
2434 "Make a backup of the disk file visited by the current buffer, if appropriate.
2435 This is normally done before saving the buffer the first time.
2437 A backup may be done by renaming or by copying; see documentation of
2438 variable `make-backup-files'. If it's done by renaming, then the file is
2439 no longer accessible under its old name.
2441 The value is non-nil after a backup was made by renaming.
2442 It has the form (MODES . BACKUPNAME).
2443 MODES is the result of `file-modes' on the original
2444 file; this means that the caller, after saving the buffer, should change
2445 the modes of the new file to agree with the old modes.
2446 BACKUPNAME is the backup file name, which is the old file renamed."
2447 (if (and make-backup-files (not backup-inhibited)
2448 (not buffer-backed-up)
2449 (file-exists-p buffer-file-name)
2450 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2451 '(?- ?l)))
2452 (let ((real-file-name buffer-file-name)
2453 backup-info backupname targets setmodes)
2454 ;; If specified name is a symbolic link, chase it to the target.
2455 ;; Thus we make the backups in the directory where the real file is.
2456 (setq real-file-name (file-chase-links real-file-name))
2457 (setq backup-info (find-backup-file-name real-file-name)
2458 backupname (car backup-info)
2459 targets (cdr backup-info))
2460 ;; (if (file-directory-p buffer-file-name)
2461 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2462 (if backup-info
2463 (condition-case ()
2464 (let ((delete-old-versions
2465 ;; If have old versions to maybe delete,
2466 ;; ask the user to confirm now, before doing anything.
2467 ;; But don't actually delete til later.
2468 (and targets
2469 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2470 (or delete-old-versions
2471 (y-or-n-p (format "Delete excess backup versions of %s? "
2472 real-file-name)))))
2473 (modes (file-modes buffer-file-name)))
2474 ;; Actually write the back up file.
2475 (condition-case ()
2476 (if (or file-precious-flag
2477 ; (file-symlink-p buffer-file-name)
2478 backup-by-copying
2479 ;; Don't rename a suid or sgid file.
2480 (and modes (< 0 (logand modes #o6000)))
2481 (and backup-by-copying-when-linked
2482 (> (file-nlinks real-file-name) 1))
2483 (and (or backup-by-copying-when-mismatch
2484 (integerp backup-by-copying-when-privileged-mismatch))
2485 (let ((attr (file-attributes real-file-name)))
2486 (and (or backup-by-copying-when-mismatch
2487 (and (integerp (nth 2 attr))
2488 (integerp backup-by-copying-when-privileged-mismatch)
2489 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2490 (or (nth 9 attr)
2491 (not (file-ownership-preserved-p real-file-name)))))))
2492 (backup-buffer-copy real-file-name backupname modes)
2493 ;; rename-file should delete old backup.
2494 (rename-file real-file-name backupname t)
2495 (setq setmodes (cons modes backupname)))
2496 (file-error
2497 ;; If trouble writing the backup, write it in ~.
2498 (setq backupname (expand-file-name
2499 (convert-standard-filename
2500 "~/%backup%~")))
2501 (message "Cannot write backup file; backing up in %s"
2502 (file-name-nondirectory backupname))
2503 (sleep-for 1)
2504 (backup-buffer-copy real-file-name backupname modes)))
2505 (setq buffer-backed-up t)
2506 ;; Now delete the old versions, if desired.
2507 (if delete-old-versions
2508 (while targets
2509 (condition-case ()
2510 (delete-file (car targets))
2511 (file-error nil))
2512 (setq targets (cdr targets))))
2513 setmodes)
2514 (file-error nil))))))
2516 (defun backup-buffer-copy (from-name to-name modes)
2517 (condition-case ()
2518 (copy-file from-name to-name t t)
2519 (file-error
2520 ;; If copying fails because file TO-NAME
2521 ;; is not writable, delete that file and try again.
2522 (if (and (file-exists-p to-name)
2523 (not (file-writable-p to-name)))
2524 (delete-file to-name))
2525 (copy-file from-name to-name t t)))
2526 (set-file-modes to-name (logand modes #o1777)))
2528 (defun file-name-sans-versions (name &optional keep-backup-version)
2529 "Return file NAME sans backup versions or strings.
2530 This is a separate procedure so your site-init or startup file can
2531 redefine it.
2532 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2533 we do not remove backup version numbers, only true file version numbers."
2534 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2535 (if handler
2536 (funcall handler 'file-name-sans-versions name keep-backup-version)
2537 (substring name 0
2538 (if (eq system-type 'vax-vms)
2539 ;; VMS version number is (a) semicolon, optional
2540 ;; sign, zero or more digits or (b) period, option
2541 ;; sign, zero or more digits, provided this is the
2542 ;; second period encountered outside of the
2543 ;; device/directory part of the file name.
2544 (or (string-match ";[-+]?[0-9]*\\'" name)
2545 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2546 name)
2547 (match-beginning 1))
2548 (length name))
2549 (if keep-backup-version
2550 (length name)
2551 (or (string-match "\\.~[0-9.]+~\\'" name)
2552 (string-match "~\\'" name)
2553 (length name))))))))
2555 (defun file-ownership-preserved-p (file)
2556 "Return t if deleting FILE and rewriting it would preserve the owner."
2557 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2558 (if handler
2559 (funcall handler 'file-ownership-preserved-p file)
2560 (let ((attributes (file-attributes file)))
2561 ;; Return t if the file doesn't exist, since it's true that no
2562 ;; information would be lost by an (attempted) delete and create.
2563 (or (null attributes)
2564 (= (nth 2 attributes) (user-uid)))))))
2566 (defun file-name-sans-extension (filename)
2567 "Return FILENAME sans final \"extension\".
2568 The extension, in a file name, is the part that follows the last `.',
2569 except that a leading `.', if any, doesn't count."
2570 (save-match-data
2571 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2572 directory)
2573 (if (and (string-match "\\.[^.]*\\'" file)
2574 (not (eq 0 (match-beginning 0))))
2575 (if (setq directory (file-name-directory filename))
2576 ;; Don't use expand-file-name here; if DIRECTORY is relative,
2577 ;; we don't want to expand it.
2578 (concat directory (substring file 0 (match-beginning 0)))
2579 (substring file 0 (match-beginning 0)))
2580 filename))))
2582 (defun file-name-extension (filename &optional period)
2583 "Return FILENAME's final \"extension\".
2584 The extension, in a file name, is the part that follows the last `.',
2585 except that a leading `.', if any, doesn't count.
2586 Return nil for extensionless file names such as `foo'.
2587 Return the empty string for file names such as `foo.'.
2589 If PERIOD is non-nil, then the returned value includes the period
2590 that delimits the extension, and if FILENAME has no extension,
2591 the value is \"\"."
2592 (save-match-data
2593 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2594 (if (and (string-match "\\.[^.]*\\'" file)
2595 (not (eq 0 (match-beginning 0))))
2596 (substring file (+ (match-beginning 0) (if period 0 1)))
2597 (if period
2598 "")))))
2600 (defcustom make-backup-file-name-function nil
2601 "A function to use instead of the default `make-backup-file-name'.
2602 A value of nil gives the default `make-backup-file-name' behaviour.
2604 This could be buffer-local to do something special for specific
2605 files. If you define it, you may need to change `backup-file-name-p'
2606 and `file-name-sans-versions' too.
2608 See also `backup-directory-alist'."
2609 :group 'backup
2610 :type '(choice (const :tag "Default" nil)
2611 (function :tag "Your function")))
2613 (defcustom backup-directory-alist nil
2614 "Alist of filename patterns and backup directory names.
2615 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2616 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2617 relative or absolute. If it is absolute, so that all matching files
2618 are backed up into the same directory, the file names in this
2619 directory will be the full name of the file backed up with all
2620 directory separators changed to `!' to prevent clashes. This will not
2621 work correctly if your filesystem truncates the resulting name.
2623 For the common case of all backups going into one directory, the alist
2624 should contain a single element pairing \".\" with the appropriate
2625 directory name.
2627 If this variable is nil, or it fails to match a filename, the backup
2628 is made in the original file's directory.
2630 On MS-DOS filesystems without long names this variable is always
2631 ignored."
2632 :group 'backup
2633 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2634 (directory :tag "Backup directory name"))))
2636 (defun normal-backup-enable-predicate (name)
2637 "Default `backup-enable-predicate' function.
2638 Checks for files in `temporary-file-directory' or
2639 `small-temporary-file-directory'."
2640 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2641 name 0 nil)))
2642 ;; Directory is under temporary-file-directory.
2643 (and (not (eq comp t))
2644 (< comp (- (length temporary-file-directory)))))
2645 (if small-temporary-file-directory
2646 (let ((comp (compare-strings small-temporary-file-directory
2647 0 nil
2648 name 0 nil)))
2649 ;; Directory is under small-temporary-file-directory.
2650 (and (not (eq comp t))
2651 (< comp (- (length small-temporary-file-directory)))))))))
2653 (defun make-backup-file-name (file)
2654 "Create the non-numeric backup file name for FILE.
2655 Normally this will just be the file's name with `~' appended.
2656 Customization hooks are provided as follows.
2658 If the variable `make-backup-file-name-function' is non-nil, its value
2659 should be a function which will be called with FILE as its argument;
2660 the resulting name is used.
2662 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2663 the documentation of that variable. If the directory for the backup
2664 doesn't exist, it is created."
2665 (if make-backup-file-name-function
2666 (funcall make-backup-file-name-function file)
2667 (if (and (eq system-type 'ms-dos)
2668 (not (msdos-long-file-names)))
2669 (let ((fn (file-name-nondirectory file)))
2670 (concat (file-name-directory file)
2671 (or (and (string-match "\\`[^.]+\\'" fn)
2672 (concat (match-string 0 fn) ".~"))
2673 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2674 (concat (match-string 0 fn) "~")))))
2675 (concat (make-backup-file-name-1 file) "~"))))
2677 (defun make-backup-file-name-1 (file)
2678 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2679 (let ((alist backup-directory-alist)
2680 elt backup-directory failed)
2681 (while alist
2682 (setq elt (pop alist))
2683 (if (string-match (car elt) file)
2684 (setq backup-directory (cdr elt)
2685 alist nil)))
2686 (if (and backup-directory (not (file-exists-p backup-directory)))
2687 (condition-case nil
2688 (make-directory backup-directory 'parents)
2689 (file-error (setq backup-directory nil))))
2690 (if (null backup-directory)
2691 file
2692 (if (file-name-absolute-p backup-directory)
2693 (progn
2694 (when (memq system-type '(windows-nt ms-dos cygwin))
2695 ;; Normalize DOSish file names: downcase the drive
2696 ;; letter, if any, and replace the leading "x:" with
2697 ;; "/drive_x".
2698 (or (file-name-absolute-p file)
2699 (setq file (expand-file-name file))) ; make defaults explicit
2700 ;; Replace any invalid file-name characters (for the
2701 ;; case of backing up remote files).
2702 (setq file (expand-file-name (convert-standard-filename file)))
2703 (if (eq (aref file 1) ?:)
2704 (setq file (concat "/"
2705 "drive_"
2706 (char-to-string (downcase (aref file 0)))
2707 (if (eq (aref file 2) ?/)
2709 "/")
2710 (substring file 2)))))
2711 ;; Make the name unique by substituting directory
2712 ;; separators. It may not really be worth bothering about
2713 ;; doubling `!'s in the original name...
2714 (expand-file-name
2715 (subst-char-in-string
2716 ?/ ?!
2717 (replace-regexp-in-string "!" "!!" file))
2718 backup-directory))
2719 (expand-file-name (file-name-nondirectory file)
2720 (file-name-as-directory
2721 (expand-file-name backup-directory
2722 (file-name-directory file))))))))
2724 (defun backup-file-name-p (file)
2725 "Return non-nil if FILE is a backup file name (numeric or not).
2726 This is a separate function so you can redefine it for customization.
2727 You may need to redefine `file-name-sans-versions' as well."
2728 (string-match "~\\'" file))
2730 (defvar backup-extract-version-start)
2732 ;; This is used in various files.
2733 ;; The usage of backup-extract-version-start is not very clean,
2734 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2735 (defun backup-extract-version (fn)
2736 "Given the name of a numeric backup file, FN, return the backup number.
2737 Uses the free variable `backup-extract-version-start', whose value should be
2738 the index in the name where the version number begins."
2739 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2740 (= (match-beginning 0) backup-extract-version-start))
2741 (string-to-int (substring fn backup-extract-version-start -1))
2744 ;; I believe there is no need to alter this behavior for VMS;
2745 ;; since backup files are not made on VMS, it should not get called.
2746 (defun find-backup-file-name (fn)
2747 "Find a file name for a backup file FN, and suggestions for deletions.
2748 Value is a list whose car is the name for the backup file
2749 and whose cdr is a list of old versions to consider deleting now.
2750 If the value is nil, don't make a backup.
2751 Uses `backup-directory-alist' in the same way as does
2752 `make-backup-file-name'."
2753 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2754 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2755 (if handler
2756 (funcall handler 'find-backup-file-name fn)
2757 (if (or (eq version-control 'never)
2758 ;; We don't support numbered backups on plain MS-DOS
2759 ;; when long file names are unavailable.
2760 (and (eq system-type 'ms-dos)
2761 (not (msdos-long-file-names))))
2762 (list (make-backup-file-name fn))
2763 (let* ((basic-name (make-backup-file-name-1 fn))
2764 (base-versions (concat (file-name-nondirectory basic-name)
2765 ".~"))
2766 (backup-extract-version-start (length base-versions))
2767 (high-water-mark 0)
2768 (number-to-delete 0)
2769 possibilities deserve-versions-p versions)
2770 (condition-case ()
2771 (setq possibilities (file-name-all-completions
2772 base-versions
2773 (file-name-directory basic-name))
2774 versions (sort (mapcar #'backup-extract-version
2775 possibilities)
2776 #'<)
2777 high-water-mark (apply 'max 0 versions)
2778 deserve-versions-p (or version-control
2779 (> high-water-mark 0))
2780 number-to-delete (- (length versions)
2781 kept-old-versions
2782 kept-new-versions
2783 -1))
2784 (file-error (setq possibilities nil)))
2785 (if (not deserve-versions-p)
2786 (list (make-backup-file-name fn))
2787 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
2788 (if (and (> number-to-delete 0)
2789 ;; Delete nothing if there is overflow
2790 ;; in the number of versions to keep.
2791 (>= (+ kept-new-versions kept-old-versions -1) 0))
2792 (mapcar (lambda (n)
2793 (format "%s.~%d~" basic-name n))
2794 (let ((v (nthcdr kept-old-versions versions)))
2795 (rplacd (nthcdr (1- number-to-delete) v) ())
2796 v))))))))))
2798 (defun file-nlinks (filename)
2799 "Return number of names file FILENAME has."
2800 (car (cdr (file-attributes filename))))
2802 ;; (defun file-relative-name (filename &optional directory)
2803 ;; "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2804 ;; This function returns a relative file name which is equivalent to FILENAME
2805 ;; when used with that default directory as the default.
2806 ;; If this is impossible (which can happen on MSDOS and Windows
2807 ;; when the file name and directory use different drive names)
2808 ;; then it returns FILENAME."
2809 ;; (save-match-data
2810 ;; (let ((fname (expand-file-name filename)))
2811 ;; (setq directory (file-name-as-directory
2812 ;; (expand-file-name (or directory default-directory))))
2813 ;; ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2814 ;; ;; drive names, they can't be relative, so return the absolute name.
2815 ;; (if (and (or (eq system-type 'ms-dos)
2816 ;; (eq system-type 'cygwin)
2817 ;; (eq system-type 'windows-nt))
2818 ;; (not (string-equal (substring fname 0 2)
2819 ;; (substring directory 0 2))))
2820 ;; filename
2821 ;; (let ((ancestor ".")
2822 ;; (fname-dir (file-name-as-directory fname)))
2823 ;; (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2824 ;; (not (string-match (concat "^" (regexp-quote directory)) fname)))
2825 ;; (setq directory (file-name-directory (substring directory 0 -1))
2826 ;; ancestor (if (equal ancestor ".")
2827 ;; ".."
2828 ;; (concat "../" ancestor))))
2829 ;; ;; Now ancestor is empty, or .., or ../.., etc.
2830 ;; (if (string-match (concat "^" (regexp-quote directory)) fname)
2831 ;; ;; We matched within FNAME's directory part.
2832 ;; ;; Add the rest of FNAME onto ANCESTOR.
2833 ;; (let ((rest (substring fname (match-end 0))))
2834 ;; (if (and (equal ancestor ".")
2835 ;; (not (equal rest "")))
2836 ;; ;; But don't bother with ANCESTOR if it would give us `./'.
2837 ;; rest
2838 ;; (concat (file-name-as-directory ancestor) rest)))
2839 ;; ;; We matched FNAME's directory equivalent.
2840 ;; ancestor))))))
2842 (defun file-relative-name (filename &optional directory)
2843 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2844 This function returns a relative file name which is equivalent to FILENAME
2845 when used with that default directory as the default.
2846 If FILENAME and DIRECTORY lie on different machines or on different drives
2847 on a DOS/Windows machine, it returns FILENAME on expanded form."
2848 (save-match-data
2849 (setq directory
2850 (file-name-as-directory (expand-file-name (or directory
2851 default-directory))))
2852 (setq filename (expand-file-name filename))
2853 (let ((hf (find-file-name-handler filename 'file-local-copy))
2854 (hd (find-file-name-handler directory 'file-local-copy)))
2855 (when (and hf (not (get hf 'file-remote-p))) (setq hf nil))
2856 (when (and hd (not (get hd 'file-remote-p))) (setq hd nil))
2857 (if ;; Conditions for separate trees
2859 ;; Test for different drives on DOS/Windows
2860 (and
2861 (memq system-type '(ms-dos cygwin windows-nt))
2862 (not (string-equal (substring filename 0 2)
2863 (substring directory 0 2))))
2864 ;; Test for different remote file handlers
2865 (not (eq hf hd))
2866 ;; Test for different remote file system identification
2867 (and
2869 (let ((re (car (rassq hf file-name-handler-alist))))
2870 (not
2871 (equal
2872 (and
2873 (string-match re filename)
2874 (substring filename 0 (match-end 0)))
2875 (and
2876 (string-match re directory)
2877 (substring directory 0 (match-end 0))))))))
2878 filename
2879 (unless (eq (aref filename 0) ?/)
2880 (setq filename (concat "/" filename)))
2881 (unless (eq (aref directory 0) ?/)
2882 (setq directory (concat "/" directory)))
2883 (let ((ancestor ".")
2884 (filename-dir (file-name-as-directory filename)))
2885 (while
2886 (and
2887 (not (string-match (concat "^" (regexp-quote directory))
2888 filename-dir))
2889 (not (string-match (concat "^" (regexp-quote directory))
2890 filename)))
2891 (setq directory (file-name-directory (substring directory 0 -1))
2892 ancestor (if (equal ancestor ".")
2893 ".."
2894 (concat "../" ancestor))))
2895 ;; Now ancestor is empty, or .., or ../.., etc.
2896 (if (string-match (concat "^" (regexp-quote directory)) filename)
2897 ;; We matched within FILENAME's directory part.
2898 ;; Add the rest of FILENAME onto ANCESTOR.
2899 (let ((rest (substring filename (match-end 0))))
2900 (if (and (equal ancestor ".") (not (equal rest "")))
2901 ;; But don't bother with ANCESTOR if it would give us `./'.
2902 rest
2903 (concat (file-name-as-directory ancestor) rest)))
2904 ;; We matched FILENAME's directory equivalent.
2905 ancestor))))))
2907 (defun save-buffer (&optional args)
2908 "Save current buffer in visited file if modified. Versions described below.
2909 By default, makes the previous version into a backup file
2910 if previously requested or if this is the first save.
2911 With 1 \\[universal-argument], marks this version
2912 to become a backup when the next save is done.
2913 With 2 \\[universal-argument]'s,
2914 unconditionally makes the previous version into a backup file.
2915 With 3 \\[universal-argument]'s, marks this version
2916 to become a backup when the next save is done,
2917 and unconditionally makes the previous version into a backup file.
2919 With argument of 0, never make the previous version into a backup file.
2921 If a file's name is FOO, the names of its numbered backup versions are
2922 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2923 Numeric backups (rather than FOO~) will be made if value of
2924 `version-control' is not the atom `never' and either there are already
2925 numeric versions of the file being backed up, or `version-control' is
2926 non-nil.
2927 We don't want excessive versions piling up, so there are variables
2928 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2929 and `kept-new-versions', which tells how many newest versions to keep.
2930 Defaults are 2 old versions and 2 new.
2931 `dired-kept-versions' controls dired's clean-directory (.) command.
2932 If `delete-old-versions' is nil, system will query user
2933 before trimming versions. Otherwise it does it silently.
2935 If `vc-make-backup-files' is nil, which is the default,
2936 no backup files are made for files managed by version control.
2937 (This is because the version control system itself records previous versions.)
2939 See the subroutine `basic-save-buffer' for more information."
2940 (interactive "p")
2941 (let ((modp (buffer-modified-p))
2942 (large (> (buffer-size) 50000))
2943 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2944 (memq args '(16 64)))))
2945 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2946 (if (and modp large (buffer-file-name))
2947 (message "Saving file %s..." (buffer-file-name)))
2948 (basic-save-buffer)
2949 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2951 (defun delete-auto-save-file-if-necessary (&optional force)
2952 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2953 Normally delete only if the file was written by this Emacs since
2954 the last real save, but optional arg FORCE non-nil means delete anyway."
2955 (and buffer-auto-save-file-name delete-auto-save-files
2956 (not (string= buffer-file-name buffer-auto-save-file-name))
2957 (or force (recent-auto-save-p))
2958 (progn
2959 (condition-case ()
2960 (delete-file buffer-auto-save-file-name)
2961 (file-error nil))
2962 (set-buffer-auto-saved))))
2964 (defvar auto-save-hook nil
2965 "Normal hook run just before auto-saving.")
2967 (defcustom after-save-hook nil
2968 "Normal hook that is run after a buffer is saved to its file."
2969 :options '(executable-make-buffer-file-executable-if-script-p)
2970 :type 'hook
2971 :group 'files)
2973 (defvar save-buffer-coding-system nil
2974 "If non-nil, use this coding system for saving the buffer.
2975 More precisely, use this coding system in place of the
2976 value of `buffer-file-coding-system', when saving the buffer.
2977 Calling `write-region' for any purpose other than saving the buffer
2978 will still use `buffer-file-coding-system'; this variable has no effect
2979 in such cases.")
2981 (make-variable-buffer-local 'save-buffer-coding-system)
2982 (put 'save-buffer-coding-system 'permanent-local t)
2984 (defun basic-save-buffer ()
2985 "Save the current buffer in its visited file, if it has been modified.
2986 The hooks `write-contents-functions' and `write-file-functions' get a chance
2987 to do the job of saving; if they do not, then the buffer is saved in
2988 the visited file file in the usual way.
2989 After saving the buffer, this function runs `after-save-hook'."
2990 (interactive)
2991 (save-current-buffer
2992 ;; In an indirect buffer, save its base buffer instead.
2993 (if (buffer-base-buffer)
2994 (set-buffer (buffer-base-buffer)))
2995 (if (buffer-modified-p)
2996 (let ((recent-save (recent-auto-save-p))
2997 setmodes tempsetmodes)
2998 ;; On VMS, rename file and buffer to get rid of version number.
2999 (if (and (eq system-type 'vax-vms)
3000 (not (string= buffer-file-name
3001 (file-name-sans-versions buffer-file-name))))
3002 (let (buffer-new-name)
3003 ;; Strip VMS version number before save.
3004 (setq buffer-file-name
3005 (file-name-sans-versions buffer-file-name))
3006 ;; Construct a (unique) buffer name to correspond.
3007 (let ((buf (create-file-buffer (downcase buffer-file-name))))
3008 (setq buffer-new-name (buffer-name buf))
3009 (kill-buffer buf))
3010 (rename-buffer buffer-new-name)))
3011 ;; If buffer has no file name, ask user for one.
3012 (or buffer-file-name
3013 (let ((filename
3014 (expand-file-name
3015 (read-file-name "File to save in: ") nil)))
3016 (and (file-exists-p filename)
3017 (or (y-or-n-p (format "File `%s' exists; overwrite? "
3018 filename))
3019 (error "Canceled")))
3020 (set-visited-file-name filename)))
3021 (or (verify-visited-file-modtime (current-buffer))
3022 (not (file-exists-p buffer-file-name))
3023 (yes-or-no-p
3024 (format "%s has changed since visited or saved. Save anyway? "
3025 (file-name-nondirectory buffer-file-name)))
3026 (error "Save not confirmed"))
3027 (save-restriction
3028 (widen)
3029 (save-excursion
3030 (and (> (point-max) (point-min))
3031 (not find-file-literally)
3032 (/= (char-after (1- (point-max))) ?\n)
3033 (not (and (eq selective-display t)
3034 (= (char-after (1- (point-max))) ?\r)))
3035 (or (eq require-final-newline t)
3036 (and require-final-newline
3037 (y-or-n-p
3038 (format "Buffer %s does not end in newline. Add one? "
3039 (buffer-name)))))
3040 (save-excursion
3041 (goto-char (point-max))
3042 (insert ?\n))))
3043 ;; Support VC version backups.
3044 (vc-before-save)
3045 (or (run-hook-with-args-until-success 'write-contents-functions)
3046 (run-hook-with-args-until-success 'local-write-file-hooks)
3047 (run-hook-with-args-until-success 'write-file-functions)
3048 ;; If a hook returned t, file is already "written".
3049 ;; Otherwise, write it the usual way now.
3050 (setq setmodes (basic-save-buffer-1)))
3051 ;; Now we have saved the current buffer. Let's make sure
3052 ;; that buffer-file-coding-system is fixed to what
3053 ;; actually used for saving by binding it locally.
3054 (if save-buffer-coding-system
3055 (setq save-buffer-coding-system last-coding-system-used)
3056 (setq buffer-file-coding-system last-coding-system-used))
3057 (setq buffer-file-number
3058 (nthcdr 10 (file-attributes buffer-file-name)))
3059 (if setmodes
3060 (condition-case ()
3061 (set-file-modes buffer-file-name (car setmodes))
3062 (error nil))))
3063 ;; If the auto-save file was recent before this command,
3064 ;; delete it now.
3065 (delete-auto-save-file-if-necessary recent-save)
3066 ;; Support VC `implicit' locking.
3067 (vc-after-save)
3068 (run-hooks 'after-save-hook))
3069 (message "(No changes need to be saved)"))))
3071 ;; This does the "real job" of writing a buffer into its visited file
3072 ;; and making a backup file. This is what is normally done
3073 ;; but inhibited if one of write-file-functions returns non-nil.
3074 ;; It returns a value (MODES . BACKUPNAME), like backup-buffer.
3075 (defun basic-save-buffer-1 ()
3076 (if save-buffer-coding-system
3077 (let ((coding-system-for-write save-buffer-coding-system))
3078 (basic-save-buffer-2))
3079 (basic-save-buffer-2)))
3081 ;; This returns a value (MODES . BACKUPNAME), like backup-buffer.
3082 (defun basic-save-buffer-2 ()
3083 (let (tempsetmodes setmodes)
3084 (if (not (file-writable-p buffer-file-name))
3085 (let ((dir (file-name-directory buffer-file-name)))
3086 (if (not (file-directory-p dir))
3087 (if (file-exists-p dir)
3088 (error "%s is not a directory" dir)
3089 (error "%s: no such directory" buffer-file-name))
3090 (if (not (file-exists-p buffer-file-name))
3091 (error "Directory %s write-protected" dir)
3092 (if (yes-or-no-p
3093 (format "File %s is write-protected; try to save anyway? "
3094 (file-name-nondirectory
3095 buffer-file-name)))
3096 (setq tempsetmodes t)
3097 (error "Attempt to save to a file which you aren't allowed to write"))))))
3098 (or buffer-backed-up
3099 (setq setmodes (backup-buffer)))
3100 (let ((dir (file-name-directory buffer-file-name)))
3101 (if (and file-precious-flag
3102 (file-writable-p dir))
3103 ;; If file is precious, write temp name, then rename it.
3104 ;; This requires write access to the containing dir,
3105 ;; which is why we don't try it if we don't have that access.
3106 (let ((realname buffer-file-name)
3107 tempname temp nogood i succeed
3108 (old-modtime (visited-file-modtime)))
3109 (setq i 0)
3110 (setq nogood t)
3111 ;; Find the temporary name to write under.
3112 (while nogood
3113 (setq tempname (format
3114 (if (and (eq system-type 'ms-dos)
3115 (not (msdos-long-file-names)))
3116 "%s#%d.tm#" ; MSDOS limits files to 8+3
3117 (if (memq system-type '(vax-vms axp-vms))
3118 "%s$tmp$%d"
3119 "%s#tmp#%d"))
3120 dir i))
3121 (setq nogood (file-exists-p tempname))
3122 (setq i (1+ i)))
3123 (unwind-protect
3124 (progn (clear-visited-file-modtime)
3125 (write-region (point-min) (point-max)
3126 tempname nil realname
3127 buffer-file-truename)
3128 (setq succeed t))
3129 ;; If writing the temp file fails,
3130 ;; delete the temp file.
3131 (or succeed
3132 (progn
3133 (condition-case nil
3134 (delete-file tempname)
3135 (file-error nil))
3136 (set-visited-file-modtime old-modtime))))
3137 ;; Since we have created an entirely new file
3138 ;; and renamed it, make sure it gets the
3139 ;; right permission bits set.
3140 (setq setmodes (or setmodes (cons (file-modes buffer-file-name)
3141 buffer-file-name)))
3142 ;; We succeeded in writing the temp file,
3143 ;; so rename it.
3144 (rename-file tempname buffer-file-name t))
3145 ;; If file not writable, see if we can make it writable
3146 ;; temporarily while we write it.
3147 ;; But no need to do so if we have just backed it up
3148 ;; (setmodes is set) because that says we're superseding.
3149 (cond ((and tempsetmodes (not setmodes))
3150 ;; Change the mode back, after writing.
3151 (setq setmodes (cons (file-modes buffer-file-name) buffer-file-name))
3152 (set-file-modes buffer-file-name (logior (car setmodes) 128))))
3153 (let (success)
3154 (unwind-protect
3155 (progn
3156 (write-region (point-min) (point-max)
3157 buffer-file-name nil t buffer-file-truename)
3158 (setq success t))
3159 ;; If we get an error writing the new file, and we made
3160 ;; the backup by renaming, undo the backing-up.
3161 (and setmodes (not success)
3162 (rename-file (cdr setmodes) buffer-file-name))))))
3163 setmodes))
3165 (defun diff-buffer-with-file (&optional buffer)
3166 "View the differences between BUFFER and its associated file.
3167 This requires the external program `diff' to be in your `exec-path'."
3168 (interactive "bBuffer: ")
3169 (with-current-buffer (get-buffer (or buffer (current-buffer)))
3170 (if (and buffer-file-name
3171 (file-exists-p buffer-file-name))
3172 (let ((tempfile (make-temp-file "buffer-content-")))
3173 (unwind-protect
3174 (save-restriction
3175 (widen)
3176 (write-region (point-min) (point-max) tempfile nil 'nomessage)
3177 (diff buffer-file-name tempfile nil t)
3178 (sit-for 0))
3179 (when (file-exists-p tempfile)
3180 (delete-file tempfile))))
3181 (message "Buffer %s has no associated file on disc" (buffer-name))
3182 ;; Display that message for 1 second so that user can read it
3183 ;; in the minibuffer.
3184 (sit-for 1)))
3185 ;; return always nil, so that save-buffers-kill-emacs will not move
3186 ;; over to the next unsaved buffer when calling `d'.
3187 nil)
3189 (defvar save-some-buffers-action-alist
3190 '((?\C-r
3191 (lambda (buf)
3192 (view-buffer buf
3193 (lambda (ignore)
3194 (exit-recursive-edit)))
3195 (recursive-edit)
3196 ;; Return nil to ask about BUF again.
3197 nil)
3198 "display the current buffer")
3199 (?d diff-buffer-with-file
3200 "show difference to last saved version"))
3201 "ACTION-ALIST argument used in call to `map-y-or-n-p'.")
3202 (put 'save-some-buffers-action-alist 'risky-local-variable t)
3204 (defun save-some-buffers (&optional arg pred)
3205 "Save some modified file-visiting buffers. Asks user about each one.
3206 You can answer `y' to save, `n' not to save, `C-r' to look at the
3207 buffer in question with `view-buffer' before deciding or `d' to
3208 view the differences using `diff-buffer-to-file'.
3210 Optional argument (the prefix) non-nil means save all with no questions.
3211 Optional second argument PRED determines which buffers are considered:
3212 If PRED is nil, all the file-visiting buffers are considered.
3213 If PRED is t, then certain non-file buffers will also be considered.
3214 If PRED is a zero-argument function, it indicates for each buffer whether
3215 to consider it or not when called with that buffer current.
3217 See `save-some-buffers-action-alist' if you want to
3218 change the additional actions you can take on files."
3219 (interactive "P")
3220 (save-window-excursion
3221 (let* ((queried nil)
3222 (files-done
3223 (map-y-or-n-p
3224 (function
3225 (lambda (buffer)
3226 (and (buffer-modified-p buffer)
3227 (not (buffer-base-buffer buffer))
3229 (buffer-file-name buffer)
3230 (and pred
3231 (progn
3232 (set-buffer buffer)
3233 (and buffer-offer-save (> (buffer-size) 0)))))
3234 (or (not (functionp pred))
3235 (with-current-buffer buffer (funcall pred)))
3236 (if arg
3238 (setq queried t)
3239 (if (buffer-file-name buffer)
3240 (format "Save file %s? "
3241 (buffer-file-name buffer))
3242 (format "Save buffer %s? "
3243 (buffer-name buffer)))))))
3244 (function
3245 (lambda (buffer)
3246 (set-buffer buffer)
3247 (save-buffer)))
3248 (buffer-list)
3249 '("buffer" "buffers" "save")
3250 save-some-buffers-action-alist))
3251 (abbrevs-done
3252 (and save-abbrevs abbrevs-changed
3253 (progn
3254 (if (or arg
3255 (eq save-abbrevs 'silently)
3256 (y-or-n-p (format "Save abbrevs in %s? "
3257 abbrev-file-name)))
3258 (write-abbrev-file nil))
3259 ;; Don't keep bothering user if he says no.
3260 (setq abbrevs-changed nil)
3261 t))))
3262 (or queried (> files-done 0) abbrevs-done
3263 (message "(No files need saving)")))))
3265 (defun not-modified (&optional arg)
3266 "Mark current buffer as unmodified, not needing to be saved.
3267 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
3269 It is not a good idea to use this function in Lisp programs, because it
3270 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
3271 (interactive "P")
3272 (message (if arg "Modification-flag set"
3273 "Modification-flag cleared"))
3274 (set-buffer-modified-p arg))
3276 (defun toggle-read-only (&optional arg)
3277 "Change whether this buffer is visiting its file read-only.
3278 With arg, set read-only iff arg is positive.
3279 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
3280 (interactive "P")
3281 (if (and arg
3282 (if (> (prefix-numeric-value arg) 0) buffer-read-only
3283 (not buffer-read-only))) ; If buffer-read-only is set correctly,
3284 nil ; do nothing.
3285 ;; Toggle.
3286 (cond
3287 ((and buffer-read-only view-mode)
3288 (View-exit-and-edit)
3289 (make-local-variable 'view-read-only)
3290 (setq view-read-only t)) ; Must leave view mode.
3291 ((and (not buffer-read-only) view-read-only
3292 (not (eq (get major-mode 'mode-class) 'special)))
3293 (view-mode-enter))
3294 (t (setq buffer-read-only (not buffer-read-only))
3295 (force-mode-line-update)))
3296 (if (vc-backend buffer-file-name)
3297 (message (substitute-command-keys
3298 (concat "File is under version-control; "
3299 "use \\[vc-next-action] to check in/out"))))))
3301 (defun insert-file (filename)
3302 "Insert contents of file FILENAME into buffer after point.
3303 Set mark after the inserted text.
3305 This function is meant for the user to run interactively.
3306 Don't call it from programs! Use `insert-file-contents' instead.
3307 \(Its calling sequence is different; see its documentation)."
3308 (interactive "*fInsert file: ")
3309 (insert-file-1 filename #'insert-file-contents))
3311 (defun append-to-file (start end filename)
3312 "Append the contents of the region to the end of file FILENAME.
3313 When called from a function, expects three arguments,
3314 START, END and FILENAME. START and END are buffer positions
3315 saying what text to write."
3316 (interactive "r\nFAppend to file: ")
3317 (write-region start end filename t))
3319 (defun file-newest-backup (filename)
3320 "Return most recent backup file for FILENAME or nil if no backups exist."
3321 ;; `make-backup-file-name' will get us the right directory for
3322 ;; ordinary or numeric backups. It might create a directory for
3323 ;; backups as a side-effect, according to `backup-directory-alist'.
3324 (let* ((filename (file-name-sans-versions
3325 (make-backup-file-name filename)))
3326 (file (file-name-nondirectory filename))
3327 (dir (file-name-directory filename))
3328 (comp (file-name-all-completions file dir))
3329 (newest nil)
3330 tem)
3331 (while comp
3332 (setq tem (pop comp))
3333 (cond ((and (backup-file-name-p tem)
3334 (string= (file-name-sans-versions tem) file))
3335 (setq tem (concat dir tem))
3336 (if (or (null newest)
3337 (file-newer-than-file-p tem newest))
3338 (setq newest tem)))))
3339 newest))
3341 (defun rename-uniquely ()
3342 "Rename current buffer to a similar name not already taken.
3343 This function is useful for creating multiple shell process buffers
3344 or multiple mail buffers, etc."
3345 (interactive)
3346 (save-match-data
3347 (let ((base-name (buffer-name)))
3348 (and (string-match "<[0-9]+>\\'" base-name)
3349 (not (and buffer-file-name
3350 (string= base-name
3351 (file-name-nondirectory buffer-file-name))))
3352 ;; If the existing buffer name has a <NNN>,
3353 ;; which isn't part of the file name (if any),
3354 ;; then get rid of that.
3355 (setq base-name (substring base-name 0 (match-beginning 0))))
3356 (rename-buffer (generate-new-buffer-name base-name))
3357 (force-mode-line-update))))
3359 (defun make-directory (dir &optional parents)
3360 "Create the directory DIR and any nonexistent parent dirs.
3361 Interactively, the default choice of directory to create
3362 is the current default directory for file names.
3363 That is useful when you have visited a file in a nonexistent directory.
3365 Noninteractively, the second (optional) argument PARENTS says whether
3366 to create parent directories if they don't exist."
3367 (interactive
3368 (list (read-file-name "Make directory: " default-directory default-directory
3369 nil nil)
3371 ;; If default-directory is a remote directory,
3372 ;; make sure we find its make-directory handler.
3373 (setq dir (expand-file-name dir))
3374 (let ((handler (find-file-name-handler dir 'make-directory)))
3375 (if handler
3376 (funcall handler 'make-directory dir parents)
3377 (if (not parents)
3378 (make-directory-internal dir)
3379 (let ((dir (directory-file-name (expand-file-name dir)))
3380 create-list)
3381 (while (not (file-exists-p dir))
3382 (setq create-list (cons dir create-list)
3383 dir (directory-file-name (file-name-directory dir))))
3384 (while create-list
3385 (make-directory-internal (car create-list))
3386 (setq create-list (cdr create-list))))))))
3388 (put 'revert-buffer-function 'permanent-local t)
3389 (defvar revert-buffer-function nil
3390 "Function to use to revert this buffer, or nil to do the default.
3391 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
3392 which are the arguments that `revert-buffer' received.")
3394 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
3395 (defvar revert-buffer-insert-file-contents-function nil
3396 "Function to use to insert contents when reverting this buffer.
3397 Gets two args, first the nominal file name to use,
3398 and second, t if reading the auto-save file.
3400 The function you specify is responsible for updating (or preserving) point.")
3402 (defvar before-revert-hook nil
3403 "Normal hook for `revert-buffer' to run before reverting.
3404 If `revert-buffer-function' is used to override the normal revert
3405 mechanism, this hook is not used.")
3407 (defvar after-revert-hook nil
3408 "Normal hook for `revert-buffer' to run after reverting.
3409 Note that the hook value that it runs is the value that was in effect
3410 before reverting; that makes a difference if you have buffer-local
3411 hook functions.
3413 If `revert-buffer-function' is used to override the normal revert
3414 mechanism, this hook is not used.")
3416 (defvar revert-buffer-internal-hook)
3418 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
3419 "Replace current buffer text with the text of the visited file on disk.
3420 This undoes all changes since the file was visited or saved.
3421 With a prefix argument, offer to revert from latest auto-save file, if
3422 that is more recent than the visited file.
3424 This command also works for special buffers that contain text which
3425 doesn't come from a file, but reflects some other data base instead:
3426 for example, Dired buffers and `buffer-list' buffers. In these cases,
3427 it reconstructs the buffer contents from the appropriate data base.
3429 When called from Lisp, the first argument is IGNORE-AUTO; only offer
3430 to revert from the auto-save file when this is nil. Note that the
3431 sense of this argument is the reverse of the prefix argument, for the
3432 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
3433 to nil.
3435 Optional second argument NOCONFIRM means don't ask for confirmation at
3436 all. (The local variable `revert-without-query', if non-nil, prevents
3437 confirmation.)
3439 Optional third argument PRESERVE-MODES non-nil means don't alter
3440 the files modes. Normally we reinitialize them using `normal-mode'.
3442 If the value of `revert-buffer-function' is non-nil, it is called to
3443 do all the work for this command. Otherwise, the hooks
3444 `before-revert-hook' and `after-revert-hook' are run at the beginning
3445 and the end, and if `revert-buffer-insert-file-contents-function' is
3446 non-nil, it is called instead of rereading visited file contents."
3448 ;; I admit it's odd to reverse the sense of the prefix argument, but
3449 ;; there is a lot of code out there which assumes that the first
3450 ;; argument should be t to avoid consulting the auto-save file, and
3451 ;; there's no straightforward way to encourage authors to notice a
3452 ;; reversal of the argument sense. So I'm just changing the user
3453 ;; interface, but leaving the programmatic interface the same.
3454 (interactive (list (not current-prefix-arg)))
3455 (if revert-buffer-function
3456 (funcall revert-buffer-function ignore-auto noconfirm)
3457 (let* ((auto-save-p (and (not ignore-auto)
3458 (recent-auto-save-p)
3459 buffer-auto-save-file-name
3460 (file-readable-p buffer-auto-save-file-name)
3461 (y-or-n-p
3462 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3463 (file-name (if auto-save-p
3464 buffer-auto-save-file-name
3465 buffer-file-name)))
3466 (cond ((null file-name)
3467 (error "Buffer does not seem to be associated with any file"))
3468 ((or noconfirm
3469 (and (not (buffer-modified-p))
3470 (let ((tail revert-without-query)
3471 (found nil))
3472 (while tail
3473 (if (string-match (car tail) file-name)
3474 (setq found t))
3475 (setq tail (cdr tail)))
3476 found))
3477 (yes-or-no-p (format "Revert buffer from file %s? "
3478 file-name)))
3479 (run-hooks 'before-revert-hook)
3480 ;; If file was backed up but has changed since,
3481 ;; we shd make another backup.
3482 (and (not auto-save-p)
3483 (not (verify-visited-file-modtime (current-buffer)))
3484 (setq buffer-backed-up nil))
3485 ;; Get rid of all undo records for this buffer.
3486 (or (eq buffer-undo-list t)
3487 (setq buffer-undo-list nil))
3488 ;; Effectively copy the after-revert-hook status,
3489 ;; since after-find-file will clobber it.
3490 (let ((global-hook (default-value 'after-revert-hook))
3491 (local-hook-p (local-variable-p 'after-revert-hook))
3492 (local-hook (and (local-variable-p 'after-revert-hook)
3493 after-revert-hook)))
3494 (let (buffer-read-only
3495 ;; Don't make undo records for the reversion.
3496 (buffer-undo-list t))
3497 (if revert-buffer-insert-file-contents-function
3498 (funcall revert-buffer-insert-file-contents-function
3499 file-name auto-save-p)
3500 (if (not (file-exists-p file-name))
3501 (error (if buffer-file-number
3502 "File %s no longer exists!"
3503 "Cannot revert nonexistent file %s")
3504 file-name))
3505 ;; Bind buffer-file-name to nil
3506 ;; so that we don't try to lock the file.
3507 (let ((buffer-file-name nil))
3508 (or auto-save-p
3509 (unlock-buffer)))
3510 (widen)
3511 (let ((coding-system-for-read
3512 ;; Auto-saved file shoule be read without
3513 ;; any code conversion.
3514 (if auto-save-p 'emacs-mule-unix
3515 (or coding-system-for-read
3516 buffer-file-coding-system))))
3517 ;; This force
3518 ;; after-insert-file-set-buffer-file-coding-system
3519 ;; (called from insert-file-contents) to set
3520 ;; buffer-file-coding-system to a proper value.
3521 (kill-local-variable 'buffer-file-coding-system)
3523 ;; Note that this preserves point in an intelligent way.
3524 (if preserve-modes
3525 (let ((buffer-file-format buffer-file-format))
3526 (insert-file-contents file-name (not auto-save-p)
3527 nil nil t))
3528 (insert-file-contents file-name (not auto-save-p)
3529 nil nil t)))))
3530 ;; Recompute the truename in case changes in symlinks
3531 ;; have changed the truename.
3532 (setq buffer-file-truename
3533 (abbreviate-file-name (file-truename buffer-file-name)))
3534 (after-find-file nil nil t t preserve-modes)
3535 ;; Run after-revert-hook as it was before we reverted.
3536 (setq-default revert-buffer-internal-hook global-hook)
3537 (if local-hook-p
3538 (set (make-local-variable 'revert-buffer-internal-hook)
3539 local-hook)
3540 (kill-local-variable 'revert-buffer-internal-hook))
3541 (run-hooks 'revert-buffer-internal-hook))
3542 t)))))
3544 (defun recover-this-file ()
3545 "Recover the visited file--get contents from its last auto-save file."
3546 (interactive)
3547 (recover-file buffer-file-name))
3549 (defun recover-file (file)
3550 "Visit file FILE, but get contents from its last auto-save file."
3551 ;; Actually putting the file name in the minibuffer should be used
3552 ;; only rarely.
3553 ;; Not just because users often use the default.
3554 (interactive "FRecover file: ")
3555 (setq file (expand-file-name file))
3556 (if (auto-save-file-name-p (file-name-nondirectory file))
3557 (error "%s is an auto-save file" (abbreviate-file-name file)))
3558 (let ((file-name (let ((buffer-file-name file))
3559 (make-auto-save-file-name))))
3560 (cond ((if (file-exists-p file)
3561 (not (file-newer-than-file-p file-name file))
3562 (not (file-exists-p file-name)))
3563 (error "Auto-save file %s not current"
3564 (abbreviate-file-name file-name)))
3565 ((save-window-excursion
3566 (with-output-to-temp-buffer "*Directory*"
3567 (buffer-disable-undo standard-output)
3568 (save-excursion
3569 (let ((switches dired-listing-switches))
3570 (if (file-symlink-p file)
3571 (setq switches (concat switches "L")))
3572 (set-buffer standard-output)
3573 ;; Use insert-directory-safely, not insert-directory,
3574 ;; because these files might not exist. In particular,
3575 ;; FILE might not exist if the auto-save file was for
3576 ;; a buffer that didn't visit a file, such as "*mail*".
3577 ;; The code in v20.x called `ls' directly, so we need
3578 ;; to emulate what `ls' did in that case.
3579 (insert-directory-safely file switches)
3580 (insert-directory-safely file-name switches))))
3581 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3582 (switch-to-buffer (find-file-noselect file t))
3583 (let ((buffer-read-only nil)
3584 ;; Keep the current buffer-file-coding-system.
3585 (coding-system buffer-file-coding-system)
3586 ;; Auto-saved file shoule be read without any code conversion.
3587 (coding-system-for-read 'emacs-mule-unix))
3588 (erase-buffer)
3589 (insert-file-contents file-name nil)
3590 (set-buffer-file-coding-system coding-system))
3591 (after-find-file nil nil t))
3592 (t (error "Recover-file cancelled")))))
3594 (defun recover-session ()
3595 "Recover auto save files from a previous Emacs session.
3596 This command first displays a Dired buffer showing you the
3597 previous sessions that you could recover from.
3598 To choose one, move point to the proper line and then type C-c C-c.
3599 Then you'll be asked about a number of files to recover."
3600 (interactive)
3601 (if (null auto-save-list-file-prefix)
3602 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3603 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3604 (unless (file-directory-p dir)
3605 (make-directory dir t))
3606 (unless (directory-files dir nil
3607 (concat "\\`" (regexp-quote
3608 (file-name-nondirectory
3609 auto-save-list-file-prefix)))
3611 (error "No previous sessions to recover")))
3612 (let ((ls-lisp-support-shell-wildcards t))
3613 (dired (concat auto-save-list-file-prefix "*")
3614 (concat dired-listing-switches "t")))
3615 (save-excursion
3616 (goto-char (point-min))
3617 (or (looking-at " Move to the session you want to recover,")
3618 (let ((inhibit-read-only t))
3619 ;; Each line starts with a space
3620 ;; so that Font Lock mode won't highlight the first character.
3621 (insert " Move to the session you want to recover,\n"
3622 " then type C-c C-c to select it.\n\n"
3623 " You can also delete some of these files;\n"
3624 " type d on a line to mark that file for deletion.\n\n"))))
3625 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3626 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3628 (defun recover-session-finish ()
3629 "Choose one saved session to recover auto-save files from.
3630 This command is used in the special Dired buffer created by
3631 \\[recover-session]."
3632 (interactive)
3633 ;; Get the name of the session file to recover from.
3634 (let ((file (dired-get-filename))
3635 files
3636 (buffer (get-buffer-create " *recover*")))
3637 (dired-unmark 1)
3638 (dired-do-flagged-delete t)
3639 (unwind-protect
3640 (save-excursion
3641 ;; Read in the auto-save-list file.
3642 (set-buffer buffer)
3643 (erase-buffer)
3644 (insert-file-contents file)
3645 ;; Loop thru the text of that file
3646 ;; and get out the names of the files to recover.
3647 (while (not (eobp))
3648 (let (thisfile autofile)
3649 (if (eolp)
3650 ;; This is a pair of lines for a non-file-visiting buffer.
3651 ;; Get the auto-save file name and manufacture
3652 ;; a "visited file name" from that.
3653 (progn
3654 (forward-line 1)
3655 (setq autofile
3656 (buffer-substring-no-properties
3657 (point)
3658 (save-excursion
3659 (end-of-line)
3660 (point))))
3661 (setq thisfile
3662 (expand-file-name
3663 (substring
3664 (file-name-nondirectory autofile)
3665 1 -1)
3666 (file-name-directory autofile)))
3667 (forward-line 1))
3668 ;; This pair of lines is a file-visiting
3669 ;; buffer. Use the visited file name.
3670 (progn
3671 (setq thisfile
3672 (buffer-substring-no-properties
3673 (point) (progn (end-of-line) (point))))
3674 (forward-line 1)
3675 (setq autofile
3676 (buffer-substring-no-properties
3677 (point) (progn (end-of-line) (point))))
3678 (forward-line 1)))
3679 ;; Ignore a file if its auto-save file does not exist now.
3680 (if (file-exists-p autofile)
3681 (setq files (cons thisfile files)))))
3682 (setq files (nreverse files))
3683 ;; The file contains a pair of line for each auto-saved buffer.
3684 ;; The first line of the pair contains the visited file name
3685 ;; or is empty if the buffer was not visiting a file.
3686 ;; The second line is the auto-save file name.
3687 (if files
3688 (map-y-or-n-p "Recover %s? "
3689 (lambda (file)
3690 (condition-case nil
3691 (save-excursion (recover-file file))
3692 (error
3693 "Failed to recover `%s'" file)))
3694 files
3695 '("file" "files" "recover"))
3696 (message "No files can be recovered from this session now")))
3697 (kill-buffer buffer))))
3699 (defun kill-some-buffers (&optional list)
3700 "For each buffer in LIST, ask whether to kill it.
3701 LIST defaults to all existing live buffers."
3702 (interactive)
3703 (if (null list)
3704 (setq list (buffer-list)))
3705 (while list
3706 (let* ((buffer (car list))
3707 (name (buffer-name buffer)))
3708 (and (not (string-equal name ""))
3709 (/= (aref name 0) ? )
3710 (yes-or-no-p
3711 (format "Buffer %s %s. Kill? "
3712 name
3713 (if (buffer-modified-p buffer)
3714 "HAS BEEN EDITED" "is unmodified")))
3715 (kill-buffer buffer)))
3716 (setq list (cdr list))))
3718 (defun auto-save-mode (arg)
3719 "Toggle auto-saving of contents of current buffer.
3720 With prefix argument ARG, turn auto-saving on if positive, else off."
3721 (interactive "P")
3722 (setq buffer-auto-save-file-name
3723 (and (if (null arg)
3724 (or (not buffer-auto-save-file-name)
3725 ;; If auto-save is off because buffer has shrunk,
3726 ;; then toggling should turn it on.
3727 (< buffer-saved-size 0))
3728 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3729 (if (and buffer-file-name auto-save-visited-file-name
3730 (not buffer-read-only))
3731 buffer-file-name
3732 (make-auto-save-file-name))))
3733 ;; If -1 was stored here, to temporarily turn off saving,
3734 ;; turn it back on.
3735 (and (< buffer-saved-size 0)
3736 (setq buffer-saved-size 0))
3737 (if (interactive-p)
3738 (message "Auto-save %s (in this buffer)"
3739 (if buffer-auto-save-file-name "on" "off")))
3740 buffer-auto-save-file-name)
3742 (defun rename-auto-save-file ()
3743 "Adjust current buffer's auto save file name for current conditions.
3744 Also rename any existing auto save file, if it was made in this session."
3745 (let ((osave buffer-auto-save-file-name))
3746 (setq buffer-auto-save-file-name
3747 (make-auto-save-file-name))
3748 (if (and osave buffer-auto-save-file-name
3749 (not (string= buffer-auto-save-file-name buffer-file-name))
3750 (not (string= buffer-auto-save-file-name osave))
3751 (file-exists-p osave)
3752 (recent-auto-save-p))
3753 (rename-file osave buffer-auto-save-file-name t))))
3755 (defun make-auto-save-file-name ()
3756 "Return file name to use for auto-saves of current buffer.
3757 Does not consider `auto-save-visited-file-name' as that variable is checked
3758 before calling this function. You can redefine this for customization.
3759 See also `auto-save-file-name-p'."
3760 (if buffer-file-name
3761 (let ((list auto-save-file-name-transforms)
3762 (filename buffer-file-name)
3763 result uniq)
3764 ;; Apply user-specified translations
3765 ;; to the file name.
3766 (while (and list (not result))
3767 (if (string-match (car (car list)) filename)
3768 (setq result (replace-match (cadr (car list)) t nil
3769 filename)
3770 uniq (car (cddr (car list)))))
3771 (setq list (cdr list)))
3772 (if result
3773 (if uniq
3774 (setq filename (concat
3775 (file-name-directory result)
3776 (subst-char-in-string
3777 ?/ ?!
3778 (replace-regexp-in-string "!" "!!"
3779 filename))))
3780 (setq filename result)))
3781 (setq result
3782 (if (and (eq system-type 'ms-dos)
3783 (not (msdos-long-file-names)))
3784 ;; We truncate the file name to DOS 8+3 limits
3785 ;; before doing anything else, because the regexp
3786 ;; passed to string-match below cannot handle
3787 ;; extensions longer than 3 characters, multiple
3788 ;; dots, and other atrocities.
3789 (let ((fn (dos-8+3-filename
3790 (file-name-nondirectory buffer-file-name))))
3791 (string-match
3792 "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'"
3794 (concat (file-name-directory buffer-file-name)
3795 "#" (match-string 1 fn)
3796 "." (match-string 3 fn) "#"))
3797 (concat (file-name-directory filename)
3799 (file-name-nondirectory filename)
3800 "#")))
3801 ;; Make sure auto-save file names don't contain characters
3802 ;; invalid for the underlying filesystem.
3803 (if (and (memq system-type '(ms-dos windows-nt))
3804 ;; Don't modify remote (ange-ftp) filenames
3805 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" result)))
3806 (convert-standard-filename result)
3807 result))
3809 ;; Deal with buffers that don't have any associated files. (Mail
3810 ;; mode tends to create a good number of these.)
3812 (let ((buffer-name (buffer-name))
3813 (limit 0)
3814 file-name)
3815 ;; Eliminate all slashes and backslashes by
3816 ;; replacing them with sequences that start with %.
3817 ;; Quote % also, to keep distinct names distinct.
3818 (while (string-match "[/\\%]" buffer-name limit)
3819 (let* ((character (aref buffer-name (match-beginning 0)))
3820 (replacement
3821 (cond ((eq character ?%) "%%")
3822 ((eq character ?/) "%+")
3823 ((eq character ?\\) "%-"))))
3824 (setq buffer-name (replace-match replacement t t buffer-name))
3825 (setq limit (1+ (match-end 0)))))
3826 ;; Generate the file name.
3827 (setq file-name
3828 (make-temp-file
3829 (let ((fname
3830 (expand-file-name
3831 (format "#%s#" buffer-name)
3832 ;; Try a few alternative directories, to get one we can
3833 ;; write it.
3834 (cond
3835 ((file-writable-p default-directory) default-directory)
3836 ((file-writable-p "/var/tmp/") "/var/tmp/")
3837 ("~/")))))
3838 (if (and (memq system-type '(ms-dos windows-nt))
3839 ;; Don't modify remote (ange-ftp) filenames
3840 (not (string-match "^/\\w+@[-A-Za-z0-9._]+:" fname)))
3841 ;; The call to convert-standard-filename is in case
3842 ;; buffer-name includes characters not allowed by the
3843 ;; DOS/Windows filesystems. make-temp-file writes to the
3844 ;; file it creates, so we must fix the file name _before_
3845 ;; make-temp-file is called.
3846 (convert-standard-filename fname)
3847 fname))
3848 nil "#"))
3849 ;; make-temp-file creates the file,
3850 ;; but we don't want it to exist until we do an auto-save.
3851 (condition-case ()
3852 (delete-file file-name)
3853 (file-error nil))
3854 file-name)))
3856 (defun auto-save-file-name-p (filename)
3857 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3858 FILENAME should lack slashes. You can redefine this for customization."
3859 (string-match "^#.*#$" filename))
3861 (defun wildcard-to-regexp (wildcard)
3862 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3863 The generated regexp will match a filename iff the filename
3864 matches that wildcard according to shell rules. Only wildcards known
3865 by `sh' are supported."
3866 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3867 ;; Copy the initial run of non-special characters.
3868 (result (substring wildcard 0 i))
3869 (len (length wildcard)))
3870 ;; If no special characters, we're almost done.
3871 (if i
3872 (while (< i len)
3873 (let ((ch (aref wildcard i))
3875 (setq
3876 result
3877 (concat result
3878 (cond
3879 ((and (eq ch ?\[)
3880 (< (1+ i) len)
3881 (eq (aref wildcard (1+ i)) ?\]))
3882 "\\[")
3883 ((eq ch ?\[) ; [...] maps to regexp char class
3884 (progn
3885 (setq i (1+ i))
3886 (concat
3887 (cond
3888 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3889 (progn
3890 (setq i (1+ i))
3891 (if (eq (aref wildcard i) ?\])
3892 (progn
3893 (setq i (1+ i))
3894 "[^]")
3895 "[^")))
3896 ((eq (aref wildcard i) ?^)
3897 ;; Found "[^". Insert a `\0' character
3898 ;; (which cannot happen in a filename)
3899 ;; into the character class, so that `^'
3900 ;; is not the first character after `[',
3901 ;; and thus non-special in a regexp.
3902 (progn
3903 (setq i (1+ i))
3904 "[\000^"))
3905 ((eq (aref wildcard i) ?\])
3906 ;; I don't think `]' can appear in a
3907 ;; character class in a wildcard, but
3908 ;; let's be general here.
3909 (progn
3910 (setq i (1+ i))
3911 "[]"))
3912 (t "["))
3913 (prog1 ; copy everything upto next `]'.
3914 (substring wildcard
3916 (setq j (string-match
3917 "]" wildcard i)))
3918 (setq i (if j (1- j) (1- len)))))))
3919 ((eq ch ?.) "\\.")
3920 ((eq ch ?*) "[^\000]*")
3921 ((eq ch ?+) "\\+")
3922 ((eq ch ?^) "\\^")
3923 ((eq ch ?$) "\\$")
3924 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3925 ((eq ch ??) "[^\000]")
3926 (t (char-to-string ch)))))
3927 (setq i (1+ i)))))
3928 ;; Shell wildcards should match the entire filename,
3929 ;; not its part. Make the regexp say so.
3930 (concat "\\`" result "\\'")))
3932 (defcustom list-directory-brief-switches
3933 (if (eq system-type 'vax-vms) "" "-CF")
3934 "*Switches for `list-directory' to pass to `ls' for brief listing."
3935 :type 'string
3936 :group 'dired)
3938 (defcustom list-directory-verbose-switches
3939 (if (eq system-type 'vax-vms)
3940 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3941 "-l")
3942 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3943 :type 'string
3944 :group 'dired)
3946 (defun file-expand-wildcards (pattern &optional full)
3947 "Expand wildcard pattern PATTERN.
3948 This returns a list of file names which match the pattern.
3950 If PATTERN is written as an absolute relative file name,
3951 the values are absolute also.
3953 If PATTERN is written as a relative file name, it is interpreted
3954 relative to the current default directory, `default-directory'.
3955 The file names returned are normally also relative to the current
3956 default directory. However, if FULL is non-nil, they are absolute."
3957 (save-match-data
3958 (let* ((nondir (file-name-nondirectory pattern))
3959 (dirpart (file-name-directory pattern))
3960 ;; A list of all dirs that DIRPART specifies.
3961 ;; This can be more than one dir
3962 ;; if DIRPART contains wildcards.
3963 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
3964 (mapcar 'file-name-as-directory
3965 (file-expand-wildcards (directory-file-name dirpart)))
3966 (list dirpart)))
3967 contents)
3968 (while dirs
3969 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3970 (file-directory-p (directory-file-name (car dirs))))
3971 (let ((this-dir-contents
3972 ;; Filter out "." and ".."
3973 (delq nil
3974 (mapcar #'(lambda (name)
3975 (unless (string-match "\\`\\.\\.?\\'"
3976 (file-name-nondirectory name))
3977 name))
3978 (directory-files (or (car dirs) ".") full
3979 (wildcard-to-regexp nondir))))))
3980 (setq contents
3981 (nconc
3982 (if (and (car dirs) (not full))
3983 (mapcar (function (lambda (name) (concat (car dirs) name)))
3984 this-dir-contents)
3985 this-dir-contents)
3986 contents))))
3987 (setq dirs (cdr dirs)))
3988 contents)))
3990 (defun list-directory (dirname &optional verbose)
3991 "Display a list of files in or matching DIRNAME, a la `ls'.
3992 DIRNAME is globbed by the shell if necessary.
3993 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3994 Actions controlled by variables `list-directory-brief-switches'
3995 and `list-directory-verbose-switches'."
3996 (interactive (let ((pfx current-prefix-arg))
3997 (list (read-file-name (if pfx "List directory (verbose): "
3998 "List directory (brief): ")
3999 nil default-directory nil)
4000 pfx)))
4001 (let ((switches (if verbose list-directory-verbose-switches
4002 list-directory-brief-switches))
4003 buffer)
4004 (or dirname (setq dirname default-directory))
4005 (setq dirname (expand-file-name dirname))
4006 (with-output-to-temp-buffer "*Directory*"
4007 (setq buffer standard-output)
4008 (buffer-disable-undo standard-output)
4009 (princ "Directory ")
4010 (princ dirname)
4011 (terpri)
4012 (save-excursion
4013 (set-buffer "*Directory*")
4014 (let ((wildcard (not (file-directory-p dirname))))
4015 (insert-directory dirname switches wildcard (not wildcard)))))
4016 ;; Finishing with-output-to-temp-buffer seems to clobber default-directory.
4017 (with-current-buffer buffer
4018 (setq default-directory
4019 (if (file-directory-p dirname)
4020 (file-name-as-directory dirname)
4021 (file-name-directory dirname))))))
4023 (defun shell-quote-wildcard-pattern (pattern)
4024 "Quote characters special to the shell in PATTERN, leave wildcards alone.
4026 PATTERN is assumed to represent a file-name wildcard suitable for the
4027 underlying filesystem. For Unix and GNU/Linux, the characters from the
4028 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
4029 the parts of the pattern which don't include wildcard characters are
4030 quoted with double quotes.
4031 Existing quote characters in PATTERN are left alone, so you can pass
4032 PATTERN that already quotes some of the special characters."
4033 (save-match-data
4034 (cond
4035 ((memq system-type '(ms-dos windows-nt cygwin))
4036 ;; DOS/Windows don't allow `"' in file names. So if the
4037 ;; argument has quotes, we can safely assume it is already
4038 ;; quoted by the caller.
4039 (if (or (string-match "[\"]" pattern)
4040 ;; We quote [&()#$'] in case their shell is a port of a
4041 ;; Unixy shell. We quote [,=+] because stock DOS and
4042 ;; Windows shells require that in some cases, such as
4043 ;; passing arguments to batch files that use positional
4044 ;; arguments like %1.
4045 (not (string-match "[ \t;&()#$',=+]" pattern)))
4046 pattern
4047 (let ((result "\"")
4048 (beg 0)
4049 end)
4050 (while (string-match "[*?]+" pattern beg)
4051 (setq end (match-beginning 0)
4052 result (concat result (substring pattern beg end)
4053 "\""
4054 (substring pattern end (match-end 0))
4055 "\"")
4056 beg (match-end 0)))
4057 (concat result (substring pattern beg) "\""))))
4059 (let ((beg 0))
4060 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
4061 (setq pattern
4062 (concat (substring pattern 0 (match-beginning 0))
4063 "\\"
4064 (substring pattern (match-beginning 0)))
4065 beg (1+ (match-end 0)))))
4066 pattern))))
4069 (defvar insert-directory-program "ls"
4070 "Absolute or relative name of the `ls' program used by `insert-directory'.")
4072 (defcustom directory-free-space-program "df"
4073 "*Program to get the amount of free space on a file system.
4074 We assume the output has the format of `df'.
4075 The value of this variable must be just a command name or file name;
4076 if you want to specify options, use `directory-free-space-args'.
4078 A value of nil disables this feature.
4080 If the function `file-system-info' is defined, it is always used in
4081 preference to the program given by this variable."
4082 :type '(choice (string :tag "Program") (const :tag "None" nil))
4083 :group 'dired)
4085 (defcustom directory-free-space-args
4086 (if (eq system-type 'darwin) "-k" "-Pk")
4087 "*Options to use when running `directory-free-space-program'."
4088 :type 'string
4089 :group 'dired)
4091 (defun get-free-disk-space (dir)
4092 "Return the mount of free space on directory DIR's file system.
4093 The result is a string that gives the number of free 1KB blocks,
4094 or nil if the system call or the program which retrieve the infornmation
4095 fail.
4097 This function calls `file-system-info' if it is available, or invokes the
4098 program specified by `directory-free-space-program' if that is non-nil."
4099 ;; Try to find the number of free blocks. Non-Posix systems don't
4100 ;; always have df, but might have an equivalent system call.
4101 (if (fboundp 'file-system-info)
4102 (let ((fsinfo (file-system-info dir)))
4103 (if fsinfo
4104 (format "%.0f" (/ (nth 2 fsinfo) 1024))))
4105 (save-match-data
4106 (with-temp-buffer
4107 (when (and directory-free-space-program
4108 (zerop (call-process directory-free-space-program
4109 nil t nil
4110 directory-free-space-args
4111 dir)))
4112 ;; Usual format is a header line followed by a line of
4113 ;; numbers.
4114 (goto-char (point-min))
4115 (forward-line 1)
4116 (if (not (eobp))
4117 (progn
4118 ;; Move to the end of the "available blocks" number.
4119 (skip-chars-forward "^ \t")
4120 (forward-word 3)
4121 ;; Copy it into AVAILABLE.
4122 (let ((end (point)))
4123 (forward-word -1)
4124 (buffer-substring (point) end)))))))))
4127 ;; insert-directory
4128 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
4129 ;; FULL-DIRECTORY-P is nil.
4130 ;; The single line of output must display FILE's name as it was
4131 ;; given, namely, an absolute path name.
4132 ;; - must insert exactly one line for each file if WILDCARD or
4133 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
4134 ;; before the file lines, plus optional text after the file lines.
4135 ;; Lines are delimited by "\n", so filenames containing "\n" are not
4136 ;; allowed.
4137 ;; File lines should display the basename.
4138 ;; - must be consistent with
4139 ;; - functions dired-move-to-filename, (these two define what a file line is)
4140 ;; dired-move-to-end-of-filename,
4141 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
4142 ;; dired-insert-headerline
4143 ;; dired-after-subdir-garbage (defines what a "total" line is)
4144 ;; - variable dired-subdir-regexp
4145 ;; - may be passed "--dired" as the first argument in SWITCHES.
4146 ;; Filename handlers might have to remove this switch if their
4147 ;; "ls" command does not support it.
4148 (defun insert-directory (file switches &optional wildcard full-directory-p)
4149 "Insert directory listing for FILE, formatted according to SWITCHES.
4150 Leaves point after the inserted text.
4151 SWITCHES may be a string of options, or a list of strings.
4152 Optional third arg WILDCARD means treat FILE as shell wildcard.
4153 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
4154 switches do not contain `d', so that a full listing is expected.
4156 This works by running a directory listing program
4157 whose name is in the variable `insert-directory-program'.
4158 If WILDCARD, it also runs the shell specified by `shell-file-name'."
4159 ;; We need the directory in order to find the right handler.
4160 (let ((handler (find-file-name-handler (expand-file-name file)
4161 'insert-directory)))
4162 (if handler
4163 (funcall handler 'insert-directory file switches
4164 wildcard full-directory-p)
4165 (if (eq system-type 'vax-vms)
4166 (vms-read-directory file switches (current-buffer))
4167 (let (result available (beg (point)))
4169 ;; Read the actual directory using `insert-directory-program'.
4170 ;; RESULT gets the status code.
4171 (let* (;; We at first read by no-conversion, then after
4172 ;; putting text property `dired-filename, decode one
4173 ;; bunch by one to preserve that property.
4174 (coding-system-for-read 'no-conversion)
4175 ;; This is to control encoding the arguments in call-process.
4176 (coding-system-for-write
4177 (and enable-multibyte-characters
4178 (or file-name-coding-system
4179 default-file-name-coding-system))))
4180 (setq result
4181 (if wildcard
4182 ;; Run ls in the directory part of the file pattern
4183 ;; using the last component as argument.
4184 (let ((default-directory
4185 (if (file-name-absolute-p file)
4186 (file-name-directory file)
4187 (file-name-directory (expand-file-name file))))
4188 (pattern (file-name-nondirectory file)))
4189 (call-process
4190 shell-file-name nil t nil
4191 "-c"
4192 (concat (if (memq system-type '(ms-dos windows-nt))
4194 "\\") ; Disregard Unix shell aliases!
4195 insert-directory-program
4196 " -d "
4197 (if (stringp switches)
4198 switches
4199 (mapconcat 'identity switches " "))
4200 " -- "
4201 ;; Quote some characters that have
4202 ;; special meanings in shells; but
4203 ;; don't quote the wildcards--we want
4204 ;; them to be special. We also
4205 ;; currently don't quote the quoting
4206 ;; characters in case people want to
4207 ;; use them explicitly to quote
4208 ;; wildcard characters.
4209 (shell-quote-wildcard-pattern pattern))))
4210 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
4211 ;; directory if FILE is a symbolic link.
4212 (apply 'call-process
4213 insert-directory-program nil t nil
4214 (append
4215 (if (listp switches) switches
4216 (unless (equal switches "")
4217 ;; Split the switches at any spaces so we can
4218 ;; pass separate options as separate args.
4219 (split-string switches)))
4220 ;; Avoid lossage if FILE starts with `-'.
4221 '("--")
4222 (progn
4223 (if (string-match "\\`~" file)
4224 (setq file (expand-file-name file)))
4225 (list
4226 (if full-directory-p
4227 (concat (file-name-as-directory file) ".")
4228 file))))))))
4230 ;; If `insert-directory-program' failed, signal an error.
4231 (if (/= result 0)
4232 ;; On non-Posix systems, we cannot open a directory, so
4233 ;; don't even try, because that will always result in
4234 ;; the ubiquitous "Access denied". Instead, show the
4235 ;; command line so the user can try to guess what went wrong.
4236 (if (and (file-directory-p file)
4237 (memq system-type '(ms-dos windows-nt)))
4238 (error
4239 "Reading directory: \"%s %s -- %s\" exited with status %s"
4240 insert-directory-program
4241 (if (listp switches) (concat switches) switches)
4242 file result)
4243 ;; Unix. Access the file to get a suitable error.
4244 (access-file file "Reading directory")
4245 (error "Listing directory failed but `access-file' worked")))
4247 (when (string-match "--dired\\>" switches)
4248 (forward-line -2)
4249 (when (looking-at "//SUBDIRED//")
4250 (delete-region (point) (progn (forward-line 1) (point)))
4251 (forward-line -1))
4252 (let ((end (line-end-position)))
4253 (forward-word 1)
4254 (forward-char 3)
4255 (while (< (point) end)
4256 (let ((start (+ beg (read (current-buffer))))
4257 (end (+ beg (read (current-buffer)))))
4258 (if (= (char-after end) ?\n)
4259 (put-text-property start end 'dired-filename t)
4260 ;; It seems that we can't trust ls's output as to
4261 ;; byte positions of filenames.
4262 (put-text-property beg (point) 'dired-filename nil)
4263 (end-of-line))))
4264 (goto-char end)
4265 (beginning-of-line)
4266 (delete-region (point) (progn (forward-line 2) (point)))))
4268 ;; Now decode what read if necessary.
4269 (let ((coding (or coding-system-for-read
4270 file-name-coding-system
4271 default-file-name-coding-system
4272 'undecided))
4273 val pos)
4274 (when (and enable-multibyte-characters
4275 (not (memq (coding-system-base coding)
4276 '(raw-text no-conversion))))
4277 ;; If no coding system is specified or detection is
4278 ;; requested, detect the coding.
4279 (if (eq (coding-system-base coding) 'undecided)
4280 (setq coding (detect-coding-region beg (point) t)))
4281 (if (not (eq (coding-system-base coding) 'undecided))
4282 (save-restriction
4283 (narrow-to-region beg (point))
4284 (goto-char (point-min))
4285 (while (not (eobp))
4286 (setq pos (point)
4287 val (get-text-property (point) 'dired-filename))
4288 (goto-char (next-single-property-change
4289 (point) 'dired-filename nil (point-max)))
4290 (decode-coding-region pos (point) coding)
4291 (if val
4292 (put-text-property pos (point)
4293 'dired-filename t)))))))
4295 (if full-directory-p
4296 ;; Try to insert the amount of free space.
4297 (save-excursion
4298 (goto-char beg)
4299 ;; First find the line to put it on.
4300 (when (re-search-forward "^ *\\(total\\)" nil t)
4301 (let ((available (get-free-disk-space ".")))
4302 (when available
4303 ;; Replace "total" with "used", to avoid confusion.
4304 (replace-match "total used in directory" nil nil nil 1)
4305 (end-of-line)
4306 (insert " available " available)))))))))))
4308 (defun insert-directory-safely (file switches
4309 &optional wildcard full-directory-p)
4310 "Insert directory listing for FILE, formatted according to SWITCHES.
4312 Like `insert-directory', but if FILE does not exist, it inserts a
4313 message to that effect instead of signaling an error."
4314 (if (file-exists-p file)
4315 (insert-directory file switches wildcard full-directory-p)
4316 ;; Simulate the message printed by `ls'.
4317 (insert (format "%s: No such file or directory\n" file))))
4319 (defvar kill-emacs-query-functions nil
4320 "Functions to call with no arguments to query about killing Emacs.
4321 If any of these functions returns nil, killing Emacs is cancelled.
4322 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
4323 but `kill-emacs', the low level primitive, does not.
4324 See also `kill-emacs-hook'.")
4326 (defcustom confirm-kill-emacs nil
4327 "How to ask for confirmation when leaving Emacs.
4328 If nil, the default, don't ask at all. If the value is non-nil, it should
4329 be a predicate function such as `yes-or-no-p'."
4330 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
4331 (const :tag "Ask with y-or-n-p" y-or-n-p)
4332 (const :tag "Don't confirm" nil))
4333 :group 'emacs
4334 :version "21.1")
4336 (defun save-buffers-kill-emacs (&optional arg)
4337 "Offer to save each buffer, then kill this Emacs process.
4338 With prefix arg, silently save all file-visiting buffers, then kill."
4339 (interactive "P")
4340 (save-some-buffers arg t)
4341 (and (or (not (memq t (mapcar (function
4342 (lambda (buf) (and (buffer-file-name buf)
4343 (buffer-modified-p buf))))
4344 (buffer-list))))
4345 (yes-or-no-p "Modified buffers exist; exit anyway? "))
4346 (or (not (fboundp 'process-list))
4347 ;; process-list is not defined on VMS.
4348 (let ((processes (process-list))
4349 active)
4350 (while processes
4351 (and (memq (process-status (car processes)) '(run stop open listen))
4352 (process-query-on-exit-flag (car processes))
4353 (setq active t))
4354 (setq processes (cdr processes)))
4355 (or (not active)
4356 (list-processes t)
4357 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
4358 ;; Query the user for other things, perhaps.
4359 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
4360 (or (null confirm-kill-emacs)
4361 (funcall confirm-kill-emacs "Really exit Emacs? "))
4362 (kill-emacs)))
4364 ;; We use /: as a prefix to "quote" a file name
4365 ;; so that magic file name handlers will not apply to it.
4367 (setq file-name-handler-alist
4368 (cons '("\\`/:" . file-name-non-special)
4369 file-name-handler-alist))
4371 ;; We depend on being the last handler on the list,
4372 ;; so that anything else which does need handling
4373 ;; has been handled already.
4374 ;; So it is safe for us to inhibit *all* magic file name handlers.
4376 (defun file-name-non-special (operation &rest arguments)
4377 (let ((file-name-handler-alist nil)
4378 (default-directory
4379 (if (eq operation 'insert-directory)
4380 (directory-file-name
4381 (expand-file-name
4382 (unhandled-file-name-directory default-directory)))
4383 default-directory))
4384 ;; Get a list of the indices of the args which are file names.
4385 (file-arg-indices
4386 (cdr (or (assq operation
4387 ;; The first five are special because they
4388 ;; return a file name. We want to include the /:
4389 ;; in the return value.
4390 ;; So just avoid stripping it in the first place.
4391 '((expand-file-name . nil)
4392 (file-name-directory . nil)
4393 (file-name-as-directory . nil)
4394 (directory-file-name . nil)
4395 (file-name-sans-versions . nil)
4396 ;; `identity' means just return the first arg
4397 ;; as stripped of its quoting.
4398 (substitute-in-file-name . identity)
4399 (file-name-completion 1)
4400 (file-name-all-completions 1)
4401 (rename-file 0 1)
4402 (copy-file 0 1)
4403 (make-symbolic-link 0 1)
4404 (add-name-to-file 0 1)))
4405 ;; For all other operations, treat the first argument only
4406 ;; as the file name.
4407 '(nil 0))))
4408 ;; Copy ARGUMENTS so we can replace elements in it.
4409 (arguments (copy-sequence arguments)))
4410 ;; Strip off the /: from the file names that have this handler.
4411 (save-match-data
4412 (while (consp file-arg-indices)
4413 (let ((pair (nthcdr (car file-arg-indices) arguments)))
4414 (and (car pair)
4415 (string-match "\\`/:" (car pair))
4416 (setcar pair
4417 (if (= (length (car pair)) 2)
4419 (substring (car pair) 2)))))
4420 (setq file-arg-indices (cdr file-arg-indices))))
4421 (if (eq file-arg-indices 'identity)
4422 (car arguments)
4423 (apply operation arguments))))
4425 (define-key ctl-x-map "\C-f" 'find-file)
4426 (define-key ctl-x-map "\C-r" 'find-file-read-only)
4427 (define-key ctl-x-map "\C-v" 'find-alternate-file)
4428 (define-key ctl-x-map "\C-s" 'save-buffer)
4429 (define-key ctl-x-map "s" 'save-some-buffers)
4430 (define-key ctl-x-map "\C-w" 'write-file)
4431 (define-key ctl-x-map "i" 'insert-file)
4432 (define-key esc-map "~" 'not-modified)
4433 (define-key ctl-x-map "\C-d" 'list-directory)
4434 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
4435 (define-key ctl-x-map "\C-q" 'toggle-read-only)
4437 (define-key ctl-x-4-map "f" 'find-file-other-window)
4438 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
4439 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
4440 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
4441 (define-key ctl-x-4-map "\C-o" 'display-buffer)
4443 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
4444 (define-key ctl-x-5-map "f" 'find-file-other-frame)
4445 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
4446 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
4448 ;;; files.el ends here