(insert-directory): If the df output does not look right,
[bpt/emacs.git] / lisp / files.el
1 ;;; files.el --- file input and output commands for Emacs
2
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;;; Free Software Foundation, Inc.
5
6 ;; Maintainer: FSF
7
8 ;; This file is part of GNU Emacs.
9
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.
14
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.
19
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.
24
25 ;;; Commentary:
26
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.
30
31 ;;; Code:
32
33 (defgroup backup nil
34 "Backups of edited data files."
35 :group 'files)
36
37 (defgroup find-file nil
38 "Finding files."
39 :group 'files)
40
41
42 (defcustom delete-auto-save-files t
43 "*Non-nil means delete auto-save file when a buffer is saved or killed.
44
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)
49
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 `^'.
57
58 Do not use `~' in the TO strings.
59 They should be ordinary absolute directory names.
60
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)
70
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.
75
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.
80
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.
85
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)
92
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)
100
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)
106
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)
113
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)
123
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)
135
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.")
139
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)
147
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)
154
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)
161
162 (defcustom revert-without-query
163 nil
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)
171
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)
179
180 (defvar buffer-file-numbers-unique (not (memq system-type '(windows-nt)))
181 "Non-nil means that buffer-file-number uniquely identifies files.")
182
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)
186
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:"))
193 (t
194 (or (getenv "TMPDIR") (getenv "TMP") (getenv "TEMP") "/tmp"))))
195 "The directory for writing temporary files."
196 :group 'files
197 :type 'directory)
198
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 'directory)
207
208 ;; The system null device. (Should reference NULL_DEVICE from C.)
209 (defvar null-device "/dev/null" "The system null device.")
210
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))
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.")
223
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.
227
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.
232
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)
238
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)
249
250 (defcustom dired-kept-versions 2
251 "*When cleaning directory, number of versions to keep."
252 :type 'integer
253 :group 'backup
254 :group 'dired)
255
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)
263
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)
268
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)
274
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)
283
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)
288
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)
294
295 (defcustom auto-save-file-name-transforms
296 `(("\\`/[^/]*:\\(.+/\\)*\\(.*\\)"
297 ,(expand-file-name "\\2" temporary-file-directory)))
298 "*Transforms to apply to buffer file name before making auto-save file name.
299 Each transform is a list (REGEXP REPLACEMENT):
300 REGEXP is a regular expression to match against the file name.
301 If it matches, `replace-match' is used to replace the
302 matching part with REPLACEMENT.
303 All the transforms in the list are tried, in the order they are listed.
304 When one transform applies, its result is final;
305 no further transforms are tried.
306
307 The default value is set up to put the auto-save file into the
308 temporary directory (see the variable `temporary-file-directory') for
309 editing a remote file."
310 :group 'auto-save
311 :type '(repeat (list (string :tag "Regexp") (string :tag "Replacement")))
312 :version "21.1")
313
314 (defcustom save-abbrevs t
315 "*Non-nil means save word abbrevs too when files are saved."
316 :type 'boolean
317 :group 'abbrev)
318
319 (defcustom find-file-run-dired t
320 "*Non-nil means allow `find-file' to visit directories.
321 To visit the directory, `find-file' runs `find-directory-functions'."
322 :type 'boolean
323 :group 'find-file)
324
325 (defcustom find-directory-functions '(cvs-dired-noselect dired-noselect)
326 "*List of functions to try in sequence to visit a directory.
327 Each function is called with the directory name as the sole argument
328 and should return either a buffer or nil."
329 :type '(hook :options (cvs-dired-noselect dired-noselect))
330 :group 'find-file)
331
332 ;;;It is not useful to make this a local variable.
333 ;;;(put 'find-file-not-found-hooks 'permanent-local t)
334 (defvar find-file-not-found-hooks nil
335 "List of functions to be called for `find-file' on nonexistent file.
336 These functions are called as soon as the error is detected.
337 Variable `buffer-file-name' is already set up.
338 The functions are called in the order given until one of them returns non-nil.")
339
340 ;;;It is not useful to make this a local variable.
341 ;;;(put 'find-file-hooks 'permanent-local t)
342 (defvar find-file-hooks nil
343 "List of functions to be called after a buffer is loaded from a file.
344 The buffer's local variables (if any) will have been processed before the
345 functions are called.")
346
347 (defvar write-file-hooks nil
348 "List of functions to be called before writing out a buffer to a file.
349 If one of them returns non-nil, the file is considered already written
350 and the rest are not called.
351 These hooks are considered to pertain to the visited file.
352 So any buffer-local binding of `write-file-hooks' is
353 discarded if you change the visited file name with \\[set-visited-file-name].
354
355 Don't make this variable buffer-local; instead, use `local-write-file-hooks'.
356 See also `write-contents-hooks'.")
357 ;;; However, in case someone does make it local...
358 (put 'write-file-hooks 'permanent-local t)
359
360 (defvar local-write-file-hooks nil
361 "Just like `write-file-hooks', except intended for per-buffer use.
362 The functions in this list are called before the ones in
363 `write-file-hooks'.
364
365 This variable is meant to be used for hooks that have to do with a
366 particular visited file. Therefore, it is a permanent local, so that
367 changing the major mode does not clear it. However, calling
368 `set-visited-file-name' does clear it.")
369 (make-variable-buffer-local 'local-write-file-hooks)
370 (put 'local-write-file-hooks 'permanent-local t)
371
372 (defvar write-contents-hooks nil
373 "List of functions to be called before writing out a buffer to a file.
374 If one of them returns non-nil, the file is considered already written
375 and the rest are not called.
376
377 This variable is meant to be used for hooks that pertain to the
378 buffer's contents, not to the particular visited file; thus,
379 `set-visited-file-name' does not clear this variable; but changing the
380 major mode does clear it.
381
382 This variable automatically becomes buffer-local whenever it is set.
383 If you use `add-hook' to add elements to the list, use nil for the
384 LOCAL argument.
385
386 See also `write-file-hooks'.")
387 (make-variable-buffer-local 'write-contents-hooks)
388
389 (defcustom enable-local-variables t
390 "*Control use of local variables in files you visit.
391 The value can be t, nil or something else.
392 A value of t means file local variables specifications are obeyed;
393 nil means they are ignored; anything else means query.
394 This variable also controls use of major modes specified in
395 a -*- line.
396
397 The command \\[normal-mode], when used interactively,
398 always obeys file local variable specifications and the -*- line,
399 and ignores this variable."
400 :type '(choice (const :tag "Obey" t)
401 (const :tag "Ignore" nil)
402 (other :tag "Query" other))
403 :group 'find-file)
404
405 (defvar local-enable-local-variables t
406 "Like `enable-local-variables' but meant for buffer-local bindings.
407 The meaningful values are nil and non-nil. The default is non-nil.
408 If a major mode sets this to nil, buffer-locally, then any local
409 variables list in the file will be ignored.
410
411 This variable does not affect the use of major modes
412 specified in a -*- line.")
413
414 (defcustom enable-local-eval 'maybe
415 "*Control processing of the \"variable\" `eval' in a file's local variables.
416 The value can be t, nil or something else.
417 A value of t means obey `eval' variables;
418 nil means ignore them; anything else means query.
419
420 The command \\[normal-mode] always obeys local-variables lists
421 and ignores this variable."
422 :type '(choice (const :tag "Obey" t)
423 (const :tag "Ignore" nil)
424 (other :tag "Query" other))
425 :group 'find-file)
426
427 ;; Avoid losing in versions where CLASH_DETECTION is disabled.
428 (or (fboundp 'lock-buffer)
429 (defalias 'lock-buffer 'ignore))
430 (or (fboundp 'unlock-buffer)
431 (defalias 'unlock-buffer 'ignore))
432 (or (fboundp 'file-locked-p)
433 (defalias 'file-locked-p 'ignore))
434
435 (defvar view-read-only nil
436 "*Non-nil means buffers visiting files read-only, do it in view mode.")
437
438 (defun ange-ftp-completion-hook-function (op &rest args)
439 "Provides support for ange-ftp host name completion.
440 Runs the usual ange-ftp hook, but only for completion operations."
441 ;; Having this here avoids the need to load ange-ftp when it's not
442 ;; really in use.
443 (if (memq op '(file-name-completion file-name-all-completions))
444 (apply 'ange-ftp-hook-function op args)
445 (let ((inhibit-file-name-handlers
446 (cons 'ange-ftp-completion-hook-function
447 (and (eq inhibit-file-name-operation op)
448 inhibit-file-name-handlers)))
449 (inhibit-file-name-operation op))
450 (apply op args))))
451
452 (defun convert-standard-filename (filename)
453 "Convert a standard file's name to something suitable for the current OS.
454 This function's standard definition is trivial; it just returns the argument.
455 However, on some systems, the function is redefined with a definition
456 that really does change some file names to canonicalize certain
457 patterns and to guarantee valid names."
458 filename)
459 \f
460 (defun pwd ()
461 "Show the current default directory."
462 (interactive nil)
463 (message "Directory %s" default-directory))
464
465 (defvar cd-path nil
466 "Value of the CDPATH environment variable, as a list.
467 Not actually set up until the first time you use it.")
468
469 (defun parse-colon-path (cd-path)
470 "Explode a colon-separated search path into a list of directory names.
471 \(For values of `colon' equal to `path-separator'.)"
472 ;; We could use split-string here.
473 (and cd-path
474 (let (cd-prefix cd-list (cd-start 0) cd-colon)
475 (setq cd-path (concat cd-path path-separator))
476 (while (setq cd-colon (string-match path-separator cd-path cd-start))
477 (setq cd-list
478 (nconc cd-list
479 (list (if (= cd-start cd-colon)
480 nil
481 (substitute-in-file-name
482 (file-name-as-directory
483 (substring cd-path cd-start cd-colon)))))))
484 (setq cd-start (+ cd-colon 1)))
485 cd-list)))
486
487 (defun cd-absolute (dir)
488 "Change current directory to given absolute file name DIR."
489 ;; Put the name into directory syntax now,
490 ;; because otherwise expand-file-name may give some bad results.
491 (if (not (eq system-type 'vax-vms))
492 (setq dir (file-name-as-directory dir)))
493 (setq dir (abbreviate-file-name (expand-file-name dir)))
494 (if (not (file-directory-p dir))
495 (if (file-exists-p dir)
496 (error "%s is not a directory" dir)
497 (error "%s: no such directory" dir))
498 (if (file-executable-p dir)
499 (setq default-directory dir)
500 (error "Cannot cd to %s: Permission denied" dir))))
501
502 (defun cd (dir)
503 "Make DIR become the current buffer's default directory.
504 If your environment includes a `CDPATH' variable, try each one of that
505 colon-separated list of directories when resolving a relative directory name."
506 (interactive
507 (list (read-file-name "Change default directory: "
508 default-directory default-directory
509 (and (member cd-path '(nil ("./")))
510 (null (getenv "CDPATH"))))))
511 (if (file-name-absolute-p dir)
512 (cd-absolute (expand-file-name dir))
513 (if (null cd-path)
514 (let ((trypath (parse-colon-path (getenv "CDPATH"))))
515 (setq cd-path (or trypath (list "./")))))
516 (if (not (catch 'found
517 (mapcar
518 (function (lambda (x)
519 (let ((f (expand-file-name (concat x dir))))
520 (if (file-directory-p f)
521 (progn
522 (cd-absolute f)
523 (throw 'found t))))))
524 cd-path)
525 nil))
526 (error "No such directory found via CDPATH environment variable"))))
527
528 (defun load-file (file)
529 "Load the Lisp file named FILE."
530 ;; This is a case where .elc makes a lot of sense.
531 (interactive (list (let ((completion-ignored-extensions
532 (remove ".elc" completion-ignored-extensions)))
533 (read-file-name "Load file: "))))
534 (load (expand-file-name file) nil nil t))
535
536 (defun load-library (library)
537 "Load the library named LIBRARY.
538 This is an interface to the function `load'."
539 (interactive "sLoad library: ")
540 (load library))
541
542 (defun file-local-copy (file)
543 "Copy the file FILE into a temporary file on this machine.
544 Returns the name of the local copy, or nil, if FILE is directly
545 accessible."
546 ;; This formerly had an optional BUFFER argument that wasn't used by
547 ;; anything.
548 (let ((handler (find-file-name-handler file 'file-local-copy)))
549 (if handler
550 (funcall handler 'file-local-copy file)
551 nil)))
552
553 (defun file-truename (filename &optional counter prev-dirs)
554 "Return the truename of FILENAME, which should be absolute.
555 The truename of a file name is found by chasing symbolic links
556 both at the level of the file and at the level of the directories
557 containing it, until no links are left at any level.
558
559 The arguments COUNTER and PREV-DIRS are used only in recursive calls.
560 Do not specify them in other calls."
561 ;; COUNTER can be a cons cell whose car is the count of how many more links
562 ;; to chase before getting an error.
563 ;; PREV-DIRS can be a cons cell whose car is an alist
564 ;; of truenames we've just recently computed.
565
566 ;; The last test looks dubious, maybe `+' is meant here? --simon.
567 (if (or (string= filename "") (string= filename "~")
568 (and (string= (substring filename 0 1) "~")
569 (string-match "~[^/]*" filename)))
570 (progn
571 (setq filename (expand-file-name filename))
572 (if (string= filename "")
573 (setq filename "/"))))
574 (or counter (setq counter (list 100)))
575 (let (done
576 ;; For speed, remove the ange-ftp completion handler from the list.
577 ;; We know it's not needed here.
578 ;; For even more speed, do this only on the outermost call.
579 (file-name-handler-alist
580 (if prev-dirs file-name-handler-alist
581 (let ((tem (copy-sequence file-name-handler-alist)))
582 (delq (rassq 'ange-ftp-completion-hook-function tem) tem)))))
583 (or prev-dirs (setq prev-dirs (list nil)))
584
585 ;; andrewi@harlequin.co.uk - none of the following code (except for
586 ;; invoking the file-name handler) currently applies on Windows
587 ;; (ie. there are no native symlinks), but there is an issue with
588 ;; case differences being ignored by the OS, and short "8.3 DOS"
589 ;; name aliases existing for all files. (The short names are not
590 ;; reported by directory-files, but can be used to refer to files.)
591 ;; It seems appropriate for file-truename to resolve these issues in
592 ;; the most natural way, which on Windows is to call the function
593 ;; `w32-long-file-name' - this returns the exact name of a file as
594 ;; it is stored on disk (expanding short name aliases with the full
595 ;; name in the process).
596 (if (eq system-type 'windows-nt)
597 (let ((handler (find-file-name-handler filename 'file-truename))
598 newname)
599 ;; For file name that has a special handler, call handler.
600 ;; This is so that ange-ftp can save time by doing a no-op.
601 (if handler
602 (setq filename (funcall handler 'file-truename filename))
603 ;; If filename contains a wildcard, newname will be the old name.
604 (if (string-match "[[*?]" filename)
605 (setq newname filename)
606 ;; If filename doesn't exist, newname will be nil.
607 (setq newname (w32-long-file-name filename)))
608 (setq filename (or newname filename)))
609 (setq done t)))
610
611 ;; If this file directly leads to a link, process that iteratively
612 ;; so that we don't use lots of stack.
613 (while (not done)
614 (setcar counter (1- (car counter)))
615 (if (< (car counter) 0)
616 (error "Apparent cycle of symbolic links for %s" filename))
617 (let ((handler (find-file-name-handler filename 'file-truename)))
618 ;; For file name that has a special handler, call handler.
619 ;; This is so that ange-ftp can save time by doing a no-op.
620 (if handler
621 (setq filename (funcall handler 'file-truename filename)
622 done t)
623 (let ((dir (or (file-name-directory filename) default-directory))
624 target dirfile)
625 ;; Get the truename of the directory.
626 (setq dirfile (directory-file-name dir))
627 ;; If these are equal, we have the (or a) root directory.
628 (or (string= dir dirfile)
629 ;; If this is the same dir we last got the truename for,
630 ;; save time--don't recalculate.
631 (if (assoc dir (car prev-dirs))
632 (setq dir (cdr (assoc dir (car prev-dirs))))
633 (let ((old dir)
634 (new (file-name-as-directory (file-truename dirfile counter prev-dirs))))
635 (setcar prev-dirs (cons (cons old new) (car prev-dirs)))
636 (setq dir new))))
637 (if (equal ".." (file-name-nondirectory filename))
638 (setq filename
639 (directory-file-name (file-name-directory (directory-file-name dir)))
640 done t)
641 (if (equal "." (file-name-nondirectory filename))
642 (setq filename (directory-file-name dir)
643 done t)
644 ;; Put it back on the file name.
645 (setq filename (concat dir (file-name-nondirectory filename)))
646 ;; Is the file name the name of a link?
647 (setq target (file-symlink-p filename))
648 (if target
649 ;; Yes => chase that link, then start all over
650 ;; since the link may point to a directory name that uses links.
651 ;; We can't safely use expand-file-name here
652 ;; since target might look like foo/../bar where foo
653 ;; is itself a link. Instead, we handle . and .. above.
654 (setq filename
655 (if (file-name-absolute-p target)
656 target
657 (concat dir target))
658 done nil)
659 ;; No, we are done!
660 (setq done t))))))))
661 filename))
662
663 (defun file-chase-links (filename)
664 "Chase links in FILENAME until a name that is not a link.
665 Does not examine containing directories for links,
666 unlike `file-truename'."
667 (let (tem (count 100) (newname filename))
668 (while (setq tem (file-symlink-p newname))
669 (save-match-data
670 (if (= count 0)
671 (error "Apparent cycle of symbolic links for %s" filename))
672 ;; In the context of a link, `//' doesn't mean what Emacs thinks.
673 (while (string-match "//+" tem)
674 (setq tem (replace-match "/" nil nil tem)))
675 ;; Handle `..' by hand, since it needs to work in the
676 ;; target of any directory symlink.
677 ;; This code is not quite complete; it does not handle
678 ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
679 (while (string-match "\\`\\.\\./" tem)
680 (setq tem (substring tem 3))
681 (setq newname (expand-file-name newname))
682 ;; Chase links in the default dir of the symlink.
683 (setq newname
684 (file-chase-links
685 (directory-file-name (file-name-directory newname))))
686 ;; Now find the parent of that dir.
687 (setq newname (file-name-directory newname)))
688 (setq newname (expand-file-name tem (file-name-directory newname)))
689 (setq count (1- count))))
690 newname))
691 \f
692 (defun switch-to-buffer-other-window (buffer &optional norecord)
693 "Select buffer BUFFER in another window.
694 Optional second arg NORECORD non-nil means
695 do not put this buffer at the front of the list of recently selected ones.
696
697 This uses the function `display-buffer' as a subroutine; see its
698 documentation for additional customization information."
699 (interactive "BSwitch to buffer in other window: ")
700 (let ((pop-up-windows t))
701 (pop-to-buffer buffer t norecord)))
702
703 (defun switch-to-buffer-other-frame (buffer &optional norecord)
704 "Switch to buffer BUFFER in another frame.
705 Optional second arg NORECORD non-nil means
706 do not put this buffer at the front of the list of recently selected ones.
707
708 This uses the function `display-buffer' as a subroutine; see its
709 documentation for additional customization information."
710 (interactive "BSwitch to buffer in other frame: ")
711 (let ((pop-up-frames t))
712 (pop-to-buffer buffer t norecord)
713 (raise-frame (window-frame (selected-window)))))
714
715 (defun find-file (filename &optional wildcards)
716 "Edit file FILENAME.
717 Switch to a buffer visiting file FILENAME,
718 creating one if none already exists.
719 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
720 expand wildcards (if any) and visit multiple files. Wildcard expansion
721 can be suppressed by setting `find-file-wildcards'."
722 (interactive "FFind file: \np")
723 (let ((value (find-file-noselect filename nil nil wildcards)))
724 (if (listp value)
725 (mapcar 'switch-to-buffer (nreverse value))
726 (switch-to-buffer value))))
727
728 (defun find-file-other-window (filename &optional wildcards)
729 "Edit file FILENAME, in another window.
730 May create a new window, or reuse an existing one.
731 See the function `display-buffer'.
732 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
733 expand wildcards (if any) and visit multiple files."
734 (interactive "FFind file in other window: \np")
735 (let ((value (find-file-noselect filename nil nil wildcards)))
736 (if (listp value)
737 (progn
738 (setq value (nreverse value))
739 (switch-to-buffer-other-window (car value))
740 (mapcar 'switch-to-buffer (cdr value)))
741 (switch-to-buffer-other-window value))))
742
743 (defun find-file-other-frame (filename &optional wildcards)
744 "Edit file FILENAME, in another frame.
745 May create a new frame, or reuse an existing one.
746 See the function `display-buffer'.
747 Interactively, or if WILDCARDS is non-nil in a call from Lisp,
748 expand wildcards (if any) and visit multiple files."
749 (interactive "FFind file in other frame: \np")
750 (let ((value (find-file-noselect filename nil nil wildcards)))
751 (if (listp value)
752 (progn
753 (setq value (nreverse value))
754 (switch-to-buffer-other-frame (car value))
755 (mapcar 'switch-to-buffer (cdr value)))
756 (switch-to-buffer-other-frame value))))
757
758 (defun find-file-read-only (filename &optional wildcards)
759 "Edit file FILENAME but don't allow changes.
760 Like `find-file' but marks buffer as read-only.
761 Use \\[toggle-read-only] to permit editing."
762 (interactive "fFind file read-only: \np")
763 (find-file filename wildcards)
764 (toggle-read-only 1)
765 (current-buffer))
766
767 (defun find-file-read-only-other-window (filename &optional wildcards)
768 "Edit file FILENAME in another window but don't allow changes.
769 Like \\[find-file-other-window] but marks buffer as read-only.
770 Use \\[toggle-read-only] to permit editing."
771 (interactive "fFind file read-only other window: \np")
772 (find-file-other-window filename wildcards)
773 (toggle-read-only 1)
774 (current-buffer))
775
776 (defun find-file-read-only-other-frame (filename &optional wildcards)
777 "Edit file FILENAME in another frame but don't allow changes.
778 Like \\[find-file-other-frame] but marks buffer as read-only.
779 Use \\[toggle-read-only] to permit editing."
780 (interactive "fFind file read-only other frame: \np")
781 (find-file-other-frame filename wildcards)
782 (toggle-read-only 1)
783 (current-buffer))
784
785 (defun find-alternate-file-other-window (filename)
786 "Find file FILENAME as a replacement for the file in the next window.
787 This command does not select that window."
788 (interactive
789 (save-selected-window
790 (other-window 1)
791 (let ((file buffer-file-name)
792 (file-name nil)
793 (file-dir nil))
794 (and file
795 (setq file-name (file-name-nondirectory file)
796 file-dir (file-name-directory file)))
797 (list (read-file-name
798 "Find alternate file: " file-dir nil nil file-name)))))
799 (if (one-window-p)
800 (find-file-other-window filename)
801 (save-selected-window
802 (other-window 1)
803 (find-alternate-file filename))))
804
805 (defun find-alternate-file (filename)
806 "Find file FILENAME, select its buffer, kill previous buffer.
807 If the current buffer now contains an empty file that you just visited
808 \(presumably by mistake), use this command to visit the file you really want."
809 (interactive
810 (let ((file buffer-file-name)
811 (file-name nil)
812 (file-dir nil))
813 (and file
814 (setq file-name (file-name-nondirectory file)
815 file-dir (file-name-directory file)))
816 (list (read-file-name
817 "Find alternate file: " file-dir nil nil file-name))))
818 (and (buffer-modified-p) (buffer-file-name)
819 ;; (not buffer-read-only)
820 (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
821 (buffer-name))))
822 (error "Aborted"))
823 (let ((obuf (current-buffer))
824 (ofile buffer-file-name)
825 (onum buffer-file-number)
826 (otrue buffer-file-truename)
827 (oname (buffer-name)))
828 (if (get-buffer " **lose**")
829 (kill-buffer " **lose**"))
830 (rename-buffer " **lose**")
831 (unwind-protect
832 (progn
833 (unlock-buffer)
834 (setq buffer-file-name nil)
835 (setq buffer-file-number nil)
836 (setq buffer-file-truename nil)
837 (find-file filename))
838 (cond ((eq obuf (current-buffer))
839 (setq buffer-file-name ofile)
840 (setq buffer-file-number onum)
841 (setq buffer-file-truename otrue)
842 (lock-buffer)
843 (rename-buffer oname))))
844 (or (eq (current-buffer) obuf)
845 (kill-buffer obuf))))
846 \f
847 (defun create-file-buffer (filename)
848 "Create a suitably named buffer for visiting FILENAME, and return it.
849 FILENAME (sans directory) is used unchanged if that name is free;
850 otherwise a string <2> or <3> or ... is appended to get an unused name."
851 (let ((lastname (file-name-nondirectory filename)))
852 (if (string= lastname "")
853 (setq lastname filename))
854 (generate-new-buffer lastname)))
855
856 (defun generate-new-buffer (name)
857 "Create and return a buffer with a name based on NAME.
858 Choose the buffer's name using `generate-new-buffer-name'."
859 (get-buffer-create (generate-new-buffer-name name)))
860
861 (defcustom automount-dir-prefix "^/tmp_mnt/"
862 "Regexp to match the automounter prefix in a directory name."
863 :group 'files
864 :type 'regexp)
865
866 (defvar abbreviated-home-dir nil
867 "The user's homedir abbreviated according to `directory-abbrev-alist'.")
868
869 (defun abbreviate-file-name (filename)
870 "Return a version of FILENAME shortened using `directory-abbrev-alist'.
871 This also substitutes \"~\" for the user's home directory.
872 Type \\[describe-variable] directory-abbrev-alist RET for more information."
873 ;; Get rid of the prefixes added by the automounter.
874 (if (and automount-dir-prefix
875 (string-match automount-dir-prefix filename)
876 (file-exists-p (file-name-directory
877 (substring filename (1- (match-end 0))))))
878 (setq filename (substring filename (1- (match-end 0)))))
879 (let ((tail directory-abbrev-alist))
880 ;; If any elt of directory-abbrev-alist matches this name,
881 ;; abbreviate accordingly.
882 (while tail
883 (if (string-match (car (car tail)) filename)
884 (setq filename
885 (concat (cdr (car tail)) (substring filename (match-end 0)))))
886 (setq tail (cdr tail)))
887 ;; Compute and save the abbreviated homedir name.
888 ;; We defer computing this until the first time it's needed, to
889 ;; give time for directory-abbrev-alist to be set properly.
890 ;; We include a slash at the end, to avoid spurious matches
891 ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
892 (or abbreviated-home-dir
893 (setq abbreviated-home-dir
894 (let ((abbreviated-home-dir "$foo"))
895 (concat "^" (abbreviate-file-name (expand-file-name "~"))
896 "\\(/\\|$\\)"))))
897
898 ;; If FILENAME starts with the abbreviated homedir,
899 ;; make it start with `~' instead.
900 (if (and (string-match abbreviated-home-dir filename)
901 ;; If the home dir is just /, don't change it.
902 (not (and (= (match-end 0) 1)
903 (= (aref filename 0) ?/)))
904 ;; MS-DOS root directories can come with a drive letter;
905 ;; Novell Netware allows drive letters beyond `Z:'.
906 (not (and (or (eq system-type 'ms-dos)
907 (eq system-type 'windows-nt))
908 (save-match-data
909 (string-match "^[a-zA-`]:/$" filename)))))
910 (setq filename
911 (concat "~"
912 (substring filename (match-beginning 1) (match-end 1))
913 (substring filename (match-end 0)))))
914 filename))
915
916 (defcustom find-file-not-true-dirname-list nil
917 "*List of logical names for which visiting shouldn't save the true dirname.
918 On VMS, when you visit a file using a logical name that searches a path,
919 you may or may not want the visited file name to record the specific
920 directory where the file was found. If you *do not* want that, add the logical
921 name to this list as a string."
922 :type '(repeat (string :tag "Name"))
923 :group 'find-file)
924
925 (defun find-buffer-visiting (filename)
926 "Return the buffer visiting file FILENAME (a string).
927 This is like `get-file-buffer', except that it checks for any buffer
928 visiting the same file, possibly under a different name.
929 If there is no such live buffer, return nil."
930 (let ((buf (get-file-buffer filename))
931 (truename (abbreviate-file-name (file-truename filename))))
932 (or buf
933 (let ((list (buffer-list)) found)
934 (while (and (not found) list)
935 (save-excursion
936 (set-buffer (car list))
937 (if (and buffer-file-name
938 (string= buffer-file-truename truename))
939 (setq found (car list))))
940 (setq list (cdr list)))
941 found)
942 (let* ((attributes (file-attributes truename))
943 (number (nthcdr 10 attributes))
944 (list (buffer-list)) found)
945 (and buffer-file-numbers-unique
946 number
947 (while (and (not found) list)
948 (with-current-buffer (car list)
949 (if (and buffer-file-name
950 (equal buffer-file-number number)
951 ;; Verify this buffer's file number
952 ;; still belongs to its file.
953 (file-exists-p buffer-file-name)
954 (equal (file-attributes buffer-file-name)
955 attributes))
956 (setq found (car list))))
957 (setq list (cdr list))))
958 found))))
959 \f
960 (defcustom find-file-wildcards t
961 "*Non-nil means file-visiting commands should handle wildcards.
962 For example, if you specify `*.c', that would visit all the files
963 whose names match the pattern."
964 :group 'files
965 :version "20.4"
966 :type 'boolean)
967
968 (defcustom find-file-suppress-same-file-warnings nil
969 "*Non-nil means suppress warning messages for symlinked files.
970 When nil, Emacs prints a warning when visiting a file that is already
971 visited, but with a different name. Setting this option to t
972 suppresses this warning."
973 :group 'files
974 :version "21.1"
975 :type 'boolean)
976
977 (defun find-file-noselect (filename &optional nowarn rawfile wildcards)
978 "Read file FILENAME into a buffer and return the buffer.
979 If a buffer exists visiting FILENAME, return that one, but
980 verify that the file has not changed since visited or saved.
981 The buffer is not selected, just returned to the caller.
982 Optional first arg NOWARN non-nil means suppress any warning messages.
983 Optional second arg RAWFILE non-nil means the file is read literally.
984 Optional third arg WILDCARDS non-nil means do wildcard processing
985 and visit all the matching files. When wildcards are actually
986 used and expanded, the value is a list of buffers
987 that are visiting the various files."
988 (setq filename
989 (abbreviate-file-name
990 (expand-file-name filename)))
991 (if (file-directory-p filename)
992 (or (and find-file-run-dired
993 (run-hook-with-args-until-success
994 'find-directory-functions
995 (if find-file-visit-truename
996 (abbreviate-file-name (file-truename filename))
997 filename)))
998 (error "%s is a directory" filename))
999 (if (and wildcards
1000 find-file-wildcards
1001 (not (string-match "\\`/:" filename))
1002 (string-match "[[*?]" filename))
1003 (let ((files (condition-case nil
1004 (file-expand-wildcards filename t)
1005 (error (list filename))))
1006 (find-file-wildcards nil))
1007 (if (null files)
1008 (find-file-noselect filename)
1009 (mapcar #'find-file-noselect files)))
1010 (let* ((buf (get-file-buffer filename))
1011 (truename (abbreviate-file-name (file-truename filename)))
1012 (number (nthcdr 10 (file-attributes truename)))
1013 ;; Find any buffer for a file which has same truename.
1014 (other (and (not buf) (find-buffer-visiting filename))))
1015 ;; Let user know if there is a buffer with the same truename.
1016 (if other
1017 (progn
1018 (or nowarn
1019 find-file-suppress-same-file-warnings
1020 (string-equal filename (buffer-file-name other))
1021 (message "%s and %s are the same file"
1022 filename (buffer-file-name other)))
1023 ;; Optionally also find that buffer.
1024 (if (or find-file-existing-other-name find-file-visit-truename)
1025 (setq buf other))))
1026 (if buf
1027 ;; We are using an existing buffer.
1028 (progn
1029 (or nowarn
1030 (verify-visited-file-modtime buf)
1031 (cond ((not (file-exists-p filename))
1032 (error "File %s no longer exists!" filename))
1033 ;; Certain files should be reverted automatically
1034 ;; if they have changed on disk and not in the buffer.
1035 ((and (not (buffer-modified-p buf))
1036 (let ((tail revert-without-query)
1037 (found nil))
1038 (while tail
1039 (if (string-match (car tail) filename)
1040 (setq found t))
1041 (setq tail (cdr tail)))
1042 found))
1043 (with-current-buffer buf
1044 (message "Reverting file %s..." filename)
1045 (revert-buffer t t)
1046 (message "Reverting file %s...done" filename)))
1047 ((yes-or-no-p
1048 (if (string= (file-name-nondirectory filename)
1049 (buffer-name buf))
1050 (format
1051 (if (buffer-modified-p buf)
1052 "File %s changed on disk. Discard your edits? "
1053 "File %s changed on disk. Reread from disk? ")
1054 (file-name-nondirectory filename))
1055 (format
1056 (if (buffer-modified-p buf)
1057 "File %s changed on disk. Discard your edits in %s? "
1058 "File %s changed on disk. Reread from disk into %s? ")
1059 (file-name-nondirectory filename)
1060 (buffer-name buf))))
1061 (with-current-buffer buf
1062 (revert-buffer t t)))))
1063 (with-current-buffer buf
1064
1065 ;; Check if a formerly read-only file has become
1066 ;; writable and vice versa, but if the buffer agrees
1067 ;; with the new state of the file, that is ok too.
1068 (let ((read-only (not (file-writable-p buffer-file-name))))
1069 (unless (or (eq read-only buffer-file-read-only)
1070 (eq read-only buffer-read-only))
1071 (when (or nowarn
1072 (let ((question
1073 (format "File %s is %s on disk. Change buffer mode? "
1074 buffer-file-name
1075 (if read-only "read-only" "writable"))))
1076 (y-or-n-p question)))
1077 (setq buffer-read-only read-only)))
1078 (setq buffer-file-read-only read-only))
1079
1080 (when (not (eq (not (null rawfile))
1081 (not (null find-file-literally))))
1082 (if (buffer-modified-p)
1083 (if (y-or-n-p (if rawfile
1084 "Save file and revisit literally? "
1085 "Save file and revisit non-literally? "))
1086 (progn
1087 (save-buffer)
1088 (find-file-noselect-1 buf filename nowarn
1089 rawfile truename number))
1090 (if (y-or-n-p (if rawfile
1091 "Discard your edits and revisit file literally? "
1092 "Discard your edits and revisit file non-literally? "))
1093 (find-file-noselect-1 buf filename nowarn
1094 rawfile truename number)
1095 (error (if rawfile "File already visited non-literally"
1096 "File already visited literally"))))
1097 (if (y-or-n-p (if rawfile
1098 "Revisit file literally? "
1099 "Revisit file non-literally? "))
1100 (find-file-noselect-1 buf filename nowarn
1101 rawfile truename number)
1102 (error (if rawfile "File already visited non-literally"
1103 "File already visited literally"))))))
1104 ;; Return the buffer we are using.
1105 buf)
1106 ;; Create a new buffer.
1107 (setq buf (create-file-buffer filename))
1108 (set-buffer-major-mode buf)
1109 ;; find-file-noselect-1 may use a different buffer.
1110 (find-file-noselect-1 buf filename nowarn
1111 rawfile truename number))))))
1112
1113 (defun find-file-noselect-1 (buf filename nowarn rawfile truename number)
1114 (let ((inhibit-read-only t)
1115 error)
1116 (with-current-buffer buf
1117 (kill-local-variable 'find-file-literally)
1118 ;; Needed in case we are re-visiting the file with a different
1119 ;; text representation.
1120 (kill-local-variable 'buffer-file-coding-system)
1121 (erase-buffer)
1122 (and (default-value 'enable-multibyte-characters)
1123 (not rawfile)
1124 (set-buffer-multibyte t))
1125 (if rawfile
1126 (condition-case ()
1127 (insert-file-contents-literally filename t)
1128 (file-error
1129 (when (and (file-exists-p filename)
1130 (not (file-readable-p filename)))
1131 (kill-buffer buf)
1132 (signal 'file-error (list "File is not readable"
1133 filename)))
1134 ;; Unconditionally set error
1135 (setq error t)))
1136 (condition-case ()
1137 (insert-file-contents filename t)
1138 (file-error
1139 (when (and (file-exists-p filename)
1140 (not (file-readable-p filename)))
1141 (kill-buffer buf)
1142 (signal 'file-error (list "File is not readable"
1143 filename)))
1144 ;; Run find-file-not-found-hooks until one returns non-nil.
1145 (or (run-hook-with-args-until-success 'find-file-not-found-hooks)
1146 ;; If they fail too, set error.
1147 (setq error t)))))
1148 ;; Record the file's truename, and maybe use that as visited name.
1149 (if (equal filename buffer-file-name)
1150 (setq buffer-file-truename truename)
1151 (setq buffer-file-truename
1152 (abbreviate-file-name (file-truename buffer-file-name))))
1153 (setq buffer-file-number number)
1154 ;; On VMS, we may want to remember which directory in a search list
1155 ;; the file was found in.
1156 (and (eq system-type 'vax-vms)
1157 (let (logical)
1158 (if (string-match ":" (file-name-directory filename))
1159 (setq logical (substring (file-name-directory filename)
1160 0 (match-beginning 0))))
1161 (not (member logical find-file-not-true-dirname-list)))
1162 (setq buffer-file-name buffer-file-truename))
1163 (if find-file-visit-truename
1164 (setq buffer-file-name
1165 (setq filename
1166 (expand-file-name buffer-file-truename))))
1167 ;; Set buffer's default directory to that of the file.
1168 (setq default-directory (file-name-directory buffer-file-name))
1169 ;; Turn off backup files for certain file names. Since
1170 ;; this is a permanent local, the major mode won't eliminate it.
1171 (and (not (funcall backup-enable-predicate buffer-file-name))
1172 (progn
1173 (make-local-variable 'backup-inhibited)
1174 (setq backup-inhibited t)))
1175 (if rawfile
1176 (progn
1177 (set-buffer-multibyte nil)
1178 (setq buffer-file-coding-system 'no-conversion)
1179 (make-local-variable 'find-file-literally)
1180 (setq find-file-literally t))
1181 (after-find-file error (not nowarn)))
1182 (current-buffer))))
1183 \f
1184 (defun insert-file-contents-literally (filename &optional visit beg end replace)
1185 "Like `insert-file-contents', but only reads in the file literally.
1186 A buffer may be modified in several ways after reading into the buffer,
1187 to Emacs features such as format decoding, character code
1188 conversion, `find-file-hooks', automatic uncompression, etc.
1189
1190 This function ensures that none of these modifications will take place."
1191 (let ((format-alist nil)
1192 (after-insert-file-functions nil)
1193 (coding-system-for-read 'no-conversion)
1194 (coding-system-for-write 'no-conversion)
1195 (find-buffer-file-type-function
1196 (if (fboundp 'find-buffer-file-type)
1197 (symbol-function 'find-buffer-file-type)
1198 nil))
1199 (inhibit-file-name-handlers '(jka-compr-handler image-file-handler))
1200 (inhibit-file-name-operation 'insert-file-contents))
1201 (unwind-protect
1202 (progn
1203 (fset 'find-buffer-file-type (lambda (filename) t))
1204 (insert-file-contents filename visit beg end replace))
1205 (if find-buffer-file-type-function
1206 (fset 'find-buffer-file-type find-buffer-file-type-function)
1207 (fmakunbound 'find-buffer-file-type)))))
1208
1209 (defun insert-file-literally (filename)
1210 "Insert contents of file FILENAME into buffer after point with no conversion.
1211
1212 This function is meant for the user to run interactively.
1213 Don't call it from programs! Use `insert-file-contents-literally' instead.
1214 \(Its calling sequence is different; see its documentation)."
1215 (interactive "*fInsert file literally: ")
1216 (if (file-directory-p filename)
1217 (signal 'file-error (list "Opening input file" "file is a directory"
1218 filename)))
1219 (let ((tem (insert-file-contents-literally filename)))
1220 (push-mark (+ (point) (car (cdr tem))))))
1221
1222 (defvar find-file-literally nil
1223 "Non-nil if this buffer was made by `find-file-literally' or equivalent.
1224 This is a permanent local.")
1225 (put 'find-file-literally 'permanent-local t)
1226
1227 (defun find-file-literally (filename)
1228 "Visit file FILENAME with no conversion of any kind.
1229 Format conversion and character code conversion are both disabled,
1230 and multibyte characters are disabled in the resulting buffer.
1231 The major mode used is Fundamental mode regardless of the file name,
1232 and local variable specifications in the file are ignored.
1233 Automatic uncompression and adding a newline at the end of the
1234 file due to `require-final-newline' is also disabled.
1235
1236 You cannot absolutely rely on this function to result in
1237 visiting the file literally. If Emacs already has a buffer
1238 which is visiting the file, you get the existing buffer,
1239 regardless of whether it was created literally or not.
1240
1241 In a Lisp program, if you want to be sure of accessing a file's
1242 contents literally, you should create a temporary buffer and then read
1243 the file contents into it using `insert-file-contents-literally'."
1244 (interactive "FFind file literally: ")
1245 (switch-to-buffer (find-file-noselect filename nil t)))
1246 \f
1247 (defvar after-find-file-from-revert-buffer nil)
1248
1249 (defun after-find-file (&optional error warn noauto
1250 after-find-file-from-revert-buffer
1251 nomodes)
1252 "Called after finding a file and by the default revert function.
1253 Sets buffer mode, parses local variables.
1254 Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
1255 error in reading the file. WARN non-nil means warn if there
1256 exists an auto-save file more recent than the visited file.
1257 NOAUTO means don't mess with auto-save mode.
1258 Fourth arg AFTER-FIND-FILE-FROM-REVERT-BUFFER non-nil
1259 means this call was from `revert-buffer'.
1260 Fifth arg NOMODES non-nil means don't alter the file's modes.
1261 Finishes by calling the functions in `find-file-hooks'
1262 unless NOMODES is non-nil."
1263 (setq buffer-read-only (not (file-writable-p buffer-file-name)))
1264 (if noninteractive
1265 nil
1266 (let* (not-serious
1267 (msg
1268 (cond
1269 ((not warn) nil)
1270 ((and error (file-attributes buffer-file-name))
1271 (setq buffer-read-only t)
1272 "File exists, but cannot be read")
1273 ((not buffer-read-only)
1274 (if (and warn
1275 ;; No need to warn if buffer is auto-saved
1276 ;; under the name of the visited file.
1277 (not (and buffer-file-name
1278 auto-save-visited-file-name))
1279 (file-newer-than-file-p (or buffer-auto-save-file-name
1280 (make-auto-save-file-name))
1281 buffer-file-name))
1282 (format "%s has auto save data; consider M-x recover-file"
1283 (file-name-nondirectory buffer-file-name))
1284 (setq not-serious t)
1285 (if error "(New file)" nil)))
1286 ((not error)
1287 (setq not-serious t)
1288 "Note: file is write protected")
1289 ((file-attributes (directory-file-name default-directory))
1290 "File not found and directory write-protected")
1291 ((file-exists-p (file-name-directory buffer-file-name))
1292 (setq buffer-read-only nil))
1293 (t
1294 (setq buffer-read-only nil)
1295 (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
1296 "Use M-x make-directory RET RET to create the directory"
1297 "Use C-u M-x make-directory RET RET to create directory and its parents")))))
1298 (when msg
1299 (message msg)
1300 (or not-serious (sit-for 1 nil t))))
1301 (when (and auto-save-default (not noauto))
1302 (auto-save-mode t)))
1303 ;; Make people do a little extra work (C-x C-q)
1304 ;; before altering a backup file.
1305 (when (backup-file-name-p buffer-file-name)
1306 (setq buffer-read-only t))
1307 (unless nomodes
1308 (when (and view-read-only view-mode)
1309 (view-mode-disable))
1310 (normal-mode t)
1311 (when (and buffer-read-only
1312 view-read-only
1313 (not (eq (get major-mode 'mode-class) 'special)))
1314 (view-mode-enter))
1315 (run-hooks 'find-file-hooks)))
1316
1317 (defun normal-mode (&optional find-file)
1318 "Choose the major mode for this buffer automatically.
1319 Also sets up any specified local variables of the file.
1320 Uses the visited file name, the -*- line, and the local variables spec.
1321
1322 This function is called automatically from `find-file'. In that case,
1323 we may set up the file-specified mode and local variables,
1324 depending on the value of `enable-local-variables': if it is t, we do;
1325 if it is nil, we don't; otherwise, we query.
1326 In addition, if `local-enable-local-variables' is nil, we do
1327 not set local variables (though we do notice a mode specified with -*-.)
1328
1329 `enable-local-variables' is ignored if you run `normal-mode' interactively,
1330 or from Lisp without specifying the optional argument FIND-FILE;
1331 in that case, this function acts as if `enable-local-variables' were t."
1332 (interactive)
1333 (or find-file (funcall (or default-major-mode 'fundamental-mode)))
1334 (condition-case err
1335 (set-auto-mode)
1336 (error (message "File mode specification error: %s"
1337 (prin1-to-string err))))
1338 (condition-case err
1339 (let ((enable-local-variables (or (not find-file)
1340 enable-local-variables)))
1341 (hack-local-variables))
1342 (error (message "File local-variables error: %s"
1343 (prin1-to-string err)))))
1344
1345 (defvar auto-mode-alist
1346 (mapc
1347 (lambda (elt)
1348 (cons (purecopy (car elt)) (cdr elt)))
1349 '(("\\.te?xt\\'" . text-mode)
1350 ("\\.c\\'" . c-mode)
1351 ("\\.h\\'" . c-mode)
1352 ("\\.tex\\'" . tex-mode)
1353 ("\\.ltx\\'" . latex-mode)
1354 ("\\.el\\'" . emacs-lisp-mode)
1355 ("\\.scm\\'" . scheme-mode)
1356 ("\\.l\\'" . lisp-mode)
1357 ("\\.lisp\\'" . lisp-mode)
1358 ("\\.f\\'" . fortran-mode)
1359 ("\\.F\\'" . fortran-mode)
1360 ("\\.for\\'" . fortran-mode)
1361 ("\\.p\\'" . pascal-mode)
1362 ("\\.pas\\'" . pascal-mode)
1363 ("\\.ad[abs]\\'" . ada-mode)
1364 ("\\.\\([pP]\\([Llm]\\|erl\\)\\|al\\)\\'" . perl-mode)
1365 ("\\.s?html?\\'" . html-mode)
1366 ("\\.cc\\'" . c++-mode)
1367 ("\\.hh\\'" . c++-mode)
1368 ("\\.hpp\\'" . c++-mode)
1369 ("\\.C\\'" . c++-mode)
1370 ("\\.H\\'" . c++-mode)
1371 ("\\.cpp\\'" . c++-mode)
1372 ("\\.cxx\\'" . c++-mode)
1373 ("\\.hxx\\'" . c++-mode)
1374 ("\\.c\\+\\+\\'" . c++-mode)
1375 ("\\.h\\+\\+\\'" . c++-mode)
1376 ("\\.m\\'" . objc-mode)
1377 ("\\.java\\'" . java-mode)
1378 ("\\.mk\\'" . makefile-mode)
1379 ("\\(M\\|m\\|GNUm\\)akefile\\(\\.in\\)?\\'" . makefile-mode)
1380 ("\\.am\\'" . makefile-mode) ;For Automake.
1381 ;; Less common extensions come here
1382 ;; so more common ones above are found faster.
1383 ("\\.texinfo\\'" . texinfo-mode)
1384 ("\\.te?xi\\'" . texinfo-mode)
1385 ("\\.s\\'" . asm-mode)
1386 ("\\.S\\'" . asm-mode)
1387 ("\\.asm\\'" . asm-mode)
1388 ("ChangeLog\\'" . change-log-mode)
1389 ("change\\.log\\'" . change-log-mode)
1390 ("changelo\\'" . change-log-mode)
1391 ("ChangeLog\\.[0-9]+\\'" . change-log-mode)
1392 ;; for MSDOS and MS-Windows (which are case-insensitive)
1393 ("changelog\\'" . change-log-mode)
1394 ("changelog\\.[0-9]+\\'" . change-log-mode)
1395 ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
1396 ("\\.scm\\.[0-9]*\\'" . scheme-mode)
1397 ("\\.[ck]?sh\\'\\|\\.shar\\'\\|/\\.z?profile\\'" . sh-mode)
1398 ("\\(/\\|\\`\\)\\.\\(bash_profile\\|z?login\\|bash_login\\|z?logout\\)\\'" . sh-mode)
1399 ("\\(/\\|\\`\\)\\.\\(bash_logout\\|shrc\\|[kz]shrc\\|bashrc\\|t?cshrc\\|esrc\\)\\'" . sh-mode)
1400 ("\\(/\\|\\`\\)\\.\\([kz]shenv\\|xinitrc\\|startxrc\\|xsession\\)\\'" . sh-mode)
1401 ("\\.m?spec\\'" . sh-mode)
1402 ("\\.mm\\'" . nroff-mode)
1403 ("\\.me\\'" . nroff-mode)
1404 ("\\.ms\\'" . nroff-mode)
1405 ("\\.man\\'" . nroff-mode)
1406 ("\\.\\(u?lpc\\|pike\\|pmod\\)\\'" . pike-mode)
1407 ("\\.TeX\\'" . tex-mode)
1408 ("\\.sty\\'" . latex-mode)
1409 ("\\.cls\\'" . latex-mode) ;LaTeX 2e class
1410 ("\\.clo\\'" . latex-mode) ;LaTeX 2e class option
1411 ("\\.bbl\\'" . latex-mode)
1412 ("\\.bib\\'" . bibtex-mode)
1413 ("\\.sql\\'" . sql-mode)
1414 ("\\.m4\\'" . m4-mode)
1415 ("\\.mc\\'" . m4-mode)
1416 ("\\.mf\\'" . metafont-mode)
1417 ("\\.mp\\'" . metapost-mode)
1418 ("\\.vhdl?\\'" . vhdl-mode)
1419 ("\\.article\\'" . text-mode)
1420 ("\\.letter\\'" . text-mode)
1421 ("\\.tcl\\'" . tcl-mode)
1422 ("\\.exp\\'" . tcl-mode)
1423 ("\\.itcl\\'" . tcl-mode)
1424 ("\\.itk\\'" . tcl-mode)
1425 ("\\.icn\\'" . icon-mode)
1426 ("\\.sim\\'" . simula-mode)
1427 ("\\.mss\\'" . scribe-mode)
1428 ("\\.f90\\'" . f90-mode)
1429 ("\\.indent\\.pro\\'" . fundamental-mode) ; to avoid idlwave-mode
1430 ("\\.pro\\'" . idlwave-mode)
1431 ("\\.lsp\\'" . lisp-mode)
1432 ("\\.awk\\'" . awk-mode)
1433 ("\\.prolog\\'" . prolog-mode)
1434 ("\\.tar\\'" . tar-mode)
1435 ("\\.\\(arc\\|zip\\|lzh\\|zoo\\|jar\\)\\'" . archive-mode)
1436 ("\\.\\(ARC\\|ZIP\\|LZH\\|ZOO\\|JAR\\)\\'" . archive-mode)
1437 ;; Mailer puts message to be edited in
1438 ;; /tmp/Re.... or Message
1439 ("\\`/tmp/Re" . text-mode)
1440 ("/Message[0-9]*\\'" . text-mode)
1441 ("/drafts/[0-9]+\\'" . mh-letter-mode)
1442 ("\\.zone\\'" . zone-mode)
1443 ;; some news reader is reported to use this
1444 ("\\`/tmp/fol/" . text-mode)
1445 ("\\.y\\'" . c-mode)
1446 ("\\.lex\\'" . c-mode)
1447 ("\\.oak\\'" . scheme-mode)
1448 ("\\.sgml?\\'" . sgml-mode)
1449 ("\\.xml\\'" . sgml-mode)
1450 ("\\.dtd\\'" . sgml-mode)
1451 ("\\.ds\\(ss\\)?l\\'" . dsssl-mode)
1452 ("\\.idl\\'" . idl-mode)
1453 ;; .emacs following a directory delimiter
1454 ;; in Unix, MSDOG or VMS syntax.
1455 ("[]>:/\\]\\..*emacs\\'" . emacs-lisp-mode)
1456 ("\\`\\..*emacs\\'" . emacs-lisp-mode)
1457 ;; _emacs following a directory delimiter
1458 ;; in MsDos syntax
1459 ("[:/]_emacs\\'" . emacs-lisp-mode)
1460 ("/crontab\\.X*[0-9]+\\'" . shell-script-mode)
1461 ("\\.ml\\'" . lisp-mode)
1462 ("\\.\\(asn\\|mib\\|smi\\)\\'" . snmp-mode)
1463 ("\\.\\(as\\|mi\\|sm\\)2\\'" . snmpv2-mode)
1464 ("\\.\\(diffs?\\|patch\\|rej\\)\\'" . diff-mode)
1465 ("\\.\\(dif\\|pat\\)\\'" . diff-mode) ; for MSDOG
1466 ("\\.[eE]?[pP][sS]\\'" . ps-mode)
1467 ("configure\\.\\(ac\\|in\\)\\'" . autoconf-mode)
1468 ("BROWSE\\'" . ebrowse-tree-mode)
1469 ("\\.ebrowse\\'" . ebrowse-tree-mode)
1470 ("#\\*mail\\*" . mail-mode)
1471 ;; Get rid of any trailing .n.m and try again.
1472 ;; This is for files saved by cvs-merge that look like .#<file>.<rev>
1473 ;; or .#<file>.<rev>-<rev> or VC's <file>.~<rev>~.
1474 ;; Using mode nil rather than `ignore' would let the search continue
1475 ;; through this list (with the shortened name) rather than start over.
1476 ("\\.~?[0-9]+\\.[0-9][-.0-9]*~?\\'" ignore t)
1477 ;; The following should come after the ChangeLog pattern
1478 ;; for the sake of ChangeLog.1, etc.
1479 ;; and after the .scm.[0-9] and CVS' <file>.<rev> patterns too.
1480 ("\\.[1-9]\\'" . nroff-mode)
1481 ("\\.g\\'" . antlr-mode)))
1482 "Alist of filename patterns vs corresponding major mode functions.
1483 Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION NON-NIL).
1484 \(NON-NIL stands for anything that is not nil; the value does not matter.)
1485 Visiting a file whose name matches REGEXP specifies FUNCTION as the
1486 mode function to use. FUNCTION will be called, unless it is nil.
1487
1488 If the element has the form (REGEXP FUNCTION NON-NIL), then after
1489 calling FUNCTION (if it's not nil), we delete the suffix that matched
1490 REGEXP and search the list again for another match.")
1491
1492
1493 (defvar interpreter-mode-alist
1494 (mapc
1495 (lambda (l)
1496 (cons (purecopy (car l)) (cdr l)))
1497 '(("perl" . perl-mode)
1498 ("perl5" . perl-mode)
1499 ("miniperl" . perl-mode)
1500 ("wish" . tcl-mode)
1501 ("wishx" . tcl-mode)
1502 ("tcl" . tcl-mode)
1503 ("tclsh" . tcl-mode)
1504 ("awk" . awk-mode)
1505 ("mawk" . awk-mode)
1506 ("nawk" . awk-mode)
1507 ("gawk" . awk-mode)
1508 ("scm" . scheme-mode)
1509 ("ash" . sh-mode)
1510 ("bash" . sh-mode)
1511 ("bash2" . sh-mode)
1512 ("csh" . sh-mode)
1513 ("dtksh" . sh-mode)
1514 ("es" . sh-mode)
1515 ("itcsh" . sh-mode)
1516 ("jsh" . sh-mode)
1517 ("ksh" . sh-mode)
1518 ("oash" . sh-mode)
1519 ("pdksh" . sh-mode)
1520 ("rc" . sh-mode)
1521 ("rpm" . sh-mode)
1522 ("sh" . sh-mode)
1523 ("sh5" . sh-mode)
1524 ("tcsh" . sh-mode)
1525 ("wksh" . sh-mode)
1526 ("wsh" . sh-mode)
1527 ("zsh" . sh-mode)
1528 ("tail" . text-mode)
1529 ("more" . text-mode)
1530 ("less" . text-mode)
1531 ("pg" . text-mode)
1532 ("make" . makefile-mode) ; Debian uses this
1533 ("guile" . scheme-mode)
1534 ("clisp" . lisp-mode)))
1535 "Alist mapping interpreter names to major modes.
1536 This alist applies to files whose first line starts with `#!'.
1537 Each element looks like (INTERPRETER . MODE).
1538 The car of each element is compared with
1539 the name of the interpreter specified in the first line.
1540 If it matches, mode MODE is selected.")
1541
1542 (defvar inhibit-first-line-modes-regexps '("\\.tar\\'" "\\.tgz\\'")
1543 "List of regexps; if one matches a file name, don't look for `-*-'.")
1544
1545 (defvar inhibit-first-line-modes-suffixes nil
1546 "List of regexps for what to ignore, for `inhibit-first-line-modes-regexps'.
1547 When checking `inhibit-first-line-modes-regexps', we first discard
1548 from the end of the file name anything that matches one of these regexps.")
1549
1550 (defvar auto-mode-interpreter-regexp
1551 "#![ \t]?\\([^ \t\n]*\
1552 /bin/env[ \t]\\)?\\([^ \t\n]+\\)"
1553 "Regular expression matching interpreters, for file mode determination.
1554 This regular expression is matched against the first line of a file
1555 to determine the file's mode in `set-auto-mode' when Emacs can't deduce
1556 a mode from the file's name. If it matches, the file is assumed to
1557 be interpreted by the interpreter matched by the second group of the
1558 regular expression. The mode is then determined as the mode associated
1559 with that interpreter in `interpreter-mode-alist'.")
1560
1561 (defun set-auto-mode (&optional just-from-file-name)
1562 "Select major mode appropriate for current buffer.
1563 This checks for a -*- mode tag in the buffer's text,
1564 compares the filename against the entries in `auto-mode-alist',
1565 or checks the interpreter that runs this file against
1566 `interpreter-mode-alist'.
1567
1568 It does not check for the `mode:' local variable in the
1569 Local Variables section of the file; for that, use `hack-local-variables'.
1570
1571 If `enable-local-variables' is nil, this function does not check for a
1572 -*- mode tag.
1573
1574 If the optional argument JUST-FROM-FILE-NAME is non-nil,
1575 then we do not set anything but the major mode,
1576 and we don't even do that unless it would come from the file name."
1577 ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
1578 (let (beg end done modes)
1579 (save-excursion
1580 (goto-char (point-min))
1581 (skip-chars-forward " \t\n")
1582 (and enable-local-variables
1583 ;; Don't look for -*- if this file name matches any
1584 ;; of the regexps in inhibit-first-line-modes-regexps.
1585 (let ((temp inhibit-first-line-modes-regexps)
1586 (name (if buffer-file-name
1587 (file-name-sans-versions buffer-file-name)
1588 (buffer-name))))
1589 (while (let ((sufs inhibit-first-line-modes-suffixes))
1590 (while (and sufs (not (string-match (car sufs) name)))
1591 (setq sufs (cdr sufs)))
1592 sufs)
1593 (setq name (substring name 0 (match-beginning 0))))
1594 (while (and temp
1595 (not (string-match (car temp) name)))
1596 (setq temp (cdr temp)))
1597 (not temp))
1598 (search-forward "-*-" (save-excursion
1599 ;; If the file begins with "#!"
1600 ;; (exec interpreter magic), look
1601 ;; for mode frobs in the first two
1602 ;; lines. You cannot necessarily
1603 ;; put them in the first line of
1604 ;; such a file without screwing up
1605 ;; the interpreter invocation.
1606 (end-of-line (and (looking-at "^#!") 2))
1607 (point)) t)
1608 (progn
1609 (skip-chars-forward " \t")
1610 (setq beg (point))
1611 (search-forward "-*-"
1612 (save-excursion (end-of-line) (point))
1613 t))
1614 (progn
1615 (forward-char -3)
1616 (skip-chars-backward " \t")
1617 (setq end (point))
1618 (goto-char beg)
1619 (if (save-excursion (search-forward ":" end t))
1620 ;; Find all specifications for the `mode:' variable
1621 ;; and execute them left to right.
1622 (while (let ((case-fold-search t))
1623 (or (and (looking-at "mode:")
1624 (goto-char (match-end 0)))
1625 (re-search-forward "[ \t;]mode:" end t)))
1626 (skip-chars-forward " \t")
1627 (setq beg (point))
1628 (if (search-forward ";" end t)
1629 (forward-char -1)
1630 (goto-char end))
1631 (skip-chars-backward " \t")
1632 (push (intern (concat (downcase (buffer-substring beg (point))) "-mode"))
1633 modes))
1634 ;; Simple -*-MODE-*- case.
1635 (push (intern (concat (downcase (buffer-substring beg end))
1636 "-mode"))
1637 modes)))))
1638 ;; If we found modes to use, invoke them now,
1639 ;; outside the save-excursion.
1640 (unless just-from-file-name
1641 (dolist (mode (nreverse modes))
1642 (if (not (functionp mode))
1643 (message "Ignoring unknown mode `%s'" mode)
1644 (setq done t)
1645 (funcall mode))))
1646 ;; If we didn't find a mode from a -*- line, try using the file name.
1647 (if (and (not done) buffer-file-name)
1648 (let ((name buffer-file-name)
1649 (keep-going t))
1650 ;; Remove backup-suffixes from file name.
1651 (setq name (file-name-sans-versions name))
1652 (while keep-going
1653 (setq keep-going nil)
1654 (let ((alist auto-mode-alist)
1655 (mode nil))
1656 ;; Find first matching alist entry.
1657 (let ((case-fold-search
1658 (memq system-type '(vax-vms windows-nt))))
1659 (while (and (not mode) alist)
1660 (if (string-match (car (car alist)) name)
1661 (if (and (consp (cdr (car alist)))
1662 (nth 2 (car alist)))
1663 (setq mode (car (cdr (car alist)))
1664 name (substring name 0 (match-beginning 0))
1665 keep-going t)
1666 (setq mode (cdr (car alist))
1667 keep-going nil)))
1668 (setq alist (cdr alist))))
1669 (if mode
1670 ;; When JUST-FROM-FILE-NAME is set,
1671 ;; we are working on behalf of set-visited-file-name.
1672 ;; In that case, if the major mode specified is the
1673 ;; same one we already have, don't actually reset it.
1674 ;; We don't want to lose minor modes such as Font Lock.
1675 (unless (and just-from-file-name (eq mode major-mode))
1676 (funcall mode))
1677 ;; If we can't deduce a mode from the file name,
1678 ;; look for an interpreter specified in the first line.
1679 ;; As a special case, allow for things like "#!/bin/env perl",
1680 ;; which finds the interpreter anywhere in $PATH.
1681 (let ((interpreter
1682 (save-excursion
1683 (goto-char (point-min))
1684 (if (looking-at auto-mode-interpreter-regexp)
1685 (match-string 2)
1686 "")))
1687 elt)
1688 ;; Map interpreter name to a mode.
1689 (setq elt (assoc (file-name-nondirectory interpreter)
1690 interpreter-mode-alist))
1691 (unless just-from-file-name
1692 (if elt
1693 (funcall (cdr elt))))))))))))
1694
1695 (defun hack-local-variables-prop-line ()
1696 "Set local variables specified in the -*- line.
1697 Ignore any specification for `mode:' and `coding:';
1698 `set-auto-mode' should already have handled `mode:',
1699 `set-auto-coding' should already have handled `coding:'."
1700 (save-excursion
1701 (goto-char (point-min))
1702 (let ((result nil)
1703 (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point)))
1704 (enable-local-variables
1705 (and local-enable-local-variables enable-local-variables)))
1706 ;; Parse the -*- line into the `result' alist.
1707 (cond ((not (search-forward "-*-" end t))
1708 ;; doesn't have one.
1709 nil)
1710 ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
1711 ;; Simple form: "-*- MODENAME -*-". Already handled.
1712 nil)
1713 (t
1714 ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
1715 ;; (last ";" is optional).
1716 (save-excursion
1717 (if (search-forward "-*-" end t)
1718 (setq end (- (point) 3))
1719 (error "-*- not terminated before end of line")))
1720 (while (< (point) end)
1721 (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
1722 (error "Malformed -*- line"))
1723 (goto-char (match-end 0))
1724 ;; There used to be a downcase here,
1725 ;; but the manual didn't say so,
1726 ;; and people want to set var names that aren't all lc.
1727 (let ((key (intern (buffer-substring
1728 (match-beginning 1)
1729 (match-end 1))))
1730 (val (save-restriction
1731 (narrow-to-region (point) end)
1732 (read (current-buffer)))))
1733 ;; It is traditional to ignore
1734 ;; case when checking for `mode' in set-auto-mode,
1735 ;; so we must do that here as well.
1736 ;; That is inconsistent, but we're stuck with it.
1737 ;; The same can be said for `coding' in set-auto-coding.
1738 (or (equal (downcase (symbol-name key)) "mode")
1739 (equal (downcase (symbol-name key)) "coding")
1740 (setq result (cons (cons key val) result)))
1741 (skip-chars-forward " \t;")))
1742 (setq result (nreverse result))))
1743
1744 (if (and result
1745 (or (eq enable-local-variables t)
1746 (and enable-local-variables
1747 (save-window-excursion
1748 (condition-case nil
1749 (switch-to-buffer (current-buffer))
1750 (error
1751 ;; If we fail to switch in the selected window,
1752 ;; it is probably a minibuffer.
1753 ;; So try another window.
1754 (condition-case nil
1755 (switch-to-buffer-other-window (current-buffer))
1756 (error
1757 (switch-to-buffer-other-frame (current-buffer))))))
1758 (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
1759 (file-name-nondirectory buffer-file-name)))))))
1760 (let ((enable-local-eval enable-local-eval))
1761 (while result
1762 (hack-one-local-variable (car (car result)) (cdr (car result)))
1763 (setq result (cdr result))))))))
1764
1765 (defvar hack-local-variables-hook nil
1766 "Normal hook run after processing a file's local variables specs.
1767 Major modes can use this to examine user-specified local variables
1768 in order to initialize other data structure based on them.")
1769
1770 (defun hack-local-variables (&optional mode-only)
1771 "Parse and put into effect this buffer's local variables spec.
1772 If MODE-ONLY is non-nil, all we do is check whether the major mode
1773 is specified, returning t if it is specified."
1774 (unless mode-only
1775 (hack-local-variables-prop-line))
1776 ;; Look for "Local variables:" line in last page.
1777 (let (mode-specified
1778 (enable-local-variables
1779 (and local-enable-local-variables enable-local-variables)))
1780 (save-excursion
1781 (goto-char (point-max))
1782 (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
1783 (if (let ((case-fold-search t))
1784 (and (search-forward "Local Variables:" nil t)
1785 (or (eq enable-local-variables t)
1786 mode-only
1787 (and enable-local-variables
1788 (save-window-excursion
1789 (switch-to-buffer (current-buffer))
1790 (save-excursion
1791 (beginning-of-line)
1792 (set-window-start (selected-window) (point)))
1793 (y-or-n-p (format "Set local variables as specified at end of %s? "
1794 (if buffer-file-name
1795 (file-name-nondirectory
1796 buffer-file-name)
1797 (concat "buffer "
1798 (buffer-name))))))))))
1799 (let ((continue t)
1800 prefix prefixlen suffix beg
1801 mode-specified
1802 (enable-local-eval enable-local-eval))
1803 ;; The prefix is what comes before "local variables:" in its line.
1804 ;; The suffix is what comes after "local variables:" in its line.
1805 (skip-chars-forward " \t")
1806 (or (eolp)
1807 (setq suffix (buffer-substring (point)
1808 (progn (end-of-line) (point)))))
1809 (goto-char (match-beginning 0))
1810 (or (bolp)
1811 (setq prefix
1812 (buffer-substring (point)
1813 (progn (beginning-of-line) (point)))))
1814
1815 (if prefix (setq prefixlen (length prefix)
1816 prefix (regexp-quote prefix)))
1817 (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
1818 (while continue
1819 ;; Look at next local variable spec.
1820 (if selective-display (re-search-forward "[\n\C-m]")
1821 (forward-line 1))
1822 ;; Skip the prefix, if any.
1823 (if prefix
1824 (if (looking-at prefix)
1825 (forward-char prefixlen)
1826 (error "Local variables entry is missing the prefix")))
1827 ;; Find the variable name; strip whitespace.
1828 (skip-chars-forward " \t")
1829 (setq beg (point))
1830 (skip-chars-forward "^:\n")
1831 (if (eolp) (error "Missing colon in local variables entry"))
1832 (skip-chars-backward " \t")
1833 (let* ((str (buffer-substring beg (point)))
1834 (var (read str))
1835 val)
1836 ;; Setting variable named "end" means end of list.
1837 (if (string-equal (downcase str) "end")
1838 (setq continue nil)
1839 ;; Otherwise read the variable value.
1840 (skip-chars-forward "^:")
1841 (forward-char 1)
1842 (setq val (read (current-buffer)))
1843 (skip-chars-backward "\n")
1844 (skip-chars-forward " \t")
1845 (or (if suffix (looking-at suffix) (eolp))
1846 (error "Local variables entry is terminated incorrectly"))
1847 (if mode-only
1848 (if (eq var 'mode)
1849 (setq mode-specified t))
1850 ;; Set the variable. "Variables" mode and eval are funny.
1851 (hack-one-local-variable var val))))))))
1852 (unless mode-only
1853 (run-hooks 'hack-local-variables-hook))
1854 mode-specified))
1855
1856 (defvar ignored-local-variables
1857 '(enable-local-eval)
1858 "Variables to be ignored in a file's local variable spec.")
1859
1860 ;; Get confirmation before setting these variables as locals in a file.
1861 (put 'debugger 'risky-local-variable t)
1862 (put 'enable-local-eval 'risky-local-variable t)
1863 (put 'ignored-local-variables 'risky-local-variable t)
1864 (put 'eval 'risky-local-variable t)
1865 (put 'file-name-handler-alist 'risky-local-variable t)
1866 (put 'minor-mode-map-alist 'risky-local-variable t)
1867 (put 'after-load-alist 'risky-local-variable t)
1868 (put 'buffer-file-name 'risky-local-variable t)
1869 (put 'buffer-auto-save-file-name 'risky-local-variable t)
1870 (put 'buffer-file-truename 'risky-local-variable t)
1871 (put 'exec-path 'risky-local-variable t)
1872 (put 'load-path 'risky-local-variable t)
1873 (put 'exec-directory 'risky-local-variable t)
1874 (put 'process-environment 'risky-local-variable t)
1875 (put 'dabbrev-case-fold-search 'risky-local-variable t)
1876 (put 'dabbrev-case-replace 'risky-local-variable t)
1877 ;; Don't wait for outline.el to be loaded, for the sake of outline-minor-mode.
1878 (put 'outline-level 'risky-local-variable t)
1879 (put 'rmail-output-file-alist 'risky-local-variable t)
1880
1881 ;; This one is safe because the user gets to check it before it is used.
1882 (put 'compile-command 'safe-local-variable t)
1883
1884 (defun hack-one-local-variable-quotep (exp)
1885 (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))
1886
1887 (defun hack-one-local-variable (var val)
1888 "\"Set\" one variable in a local variables spec.
1889 A few variable names are treated specially."
1890 (cond ((eq var 'mode)
1891 (funcall (intern (concat (downcase (symbol-name val))
1892 "-mode"))))
1893 ((eq var 'coding)
1894 ;; We have already handled coding: tag in set-auto-coding.
1895 nil)
1896 ((memq var ignored-local-variables)
1897 nil)
1898 ;; "Setting" eval means either eval it or do nothing.
1899 ;; Likewise for setting hook variables.
1900 ((or (get var 'risky-local-variable)
1901 (and
1902 (string-match "-hooks?$\\|-functions?$\\|-forms?$\\|-program$\\|-command$\\|-predicate$"
1903 (symbol-name var))
1904 (not (get var 'safe-local-variable))))
1905 ;; Permit evalling a put of a harmless property.
1906 ;; if the args do nothing tricky.
1907 (if (or (and (eq var 'eval)
1908 (consp val)
1909 (eq (car val) 'put)
1910 (hack-one-local-variable-quotep (nth 1 val))
1911 (hack-one-local-variable-quotep (nth 2 val))
1912 ;; Only allow safe values of lisp-indent-hook;
1913 ;; not functions.
1914 (or (numberp (nth 3 val))
1915 (equal (nth 3 val) ''defun))
1916 (memq (nth 1 (nth 2 val))
1917 '(lisp-indent-hook)))
1918 ;; Permit eval if not root and user says ok.
1919 (and (not (zerop (user-uid)))
1920 (or (eq enable-local-eval t)
1921 (and enable-local-eval
1922 (save-window-excursion
1923 (switch-to-buffer (current-buffer))
1924 (save-excursion
1925 (beginning-of-line)
1926 (set-window-start (selected-window) (point)))
1927 (setq enable-local-eval
1928 (y-or-n-p (format "Process `eval' or hook local variables in %s? "
1929 (if buffer-file-name
1930 (concat "file " (file-name-nondirectory buffer-file-name))
1931 (concat "buffer " (buffer-name)))))))))))
1932 (if (eq var 'eval)
1933 (save-excursion (eval val))
1934 (make-local-variable var)
1935 (set var val))
1936 (message "Ignoring `eval:' in the local variables list")))
1937 ;; Ordinary variable, really set it.
1938 (t (make-local-variable var)
1939 (set var val))))
1940
1941 \f
1942 (defcustom change-major-mode-with-file-name t
1943 "*Non-nil means \\[write-file] should set the major mode from the file name.
1944 However, the mode will not be changed if
1945 \(1) a local variables list or the `-*-' line specifies a major mode, or
1946 \(2) the current major mode is a \"special\" mode,
1947 \ not suitable for ordinary files, or
1948 \(3) the new file name does not particularly specify any mode."
1949 :type 'boolean
1950 :group 'editing-basics)
1951
1952 (defun set-visited-file-name (filename &optional no-query along-with-file)
1953 "Change name of file visited in current buffer to FILENAME.
1954 The next time the buffer is saved it will go in the newly specified file.
1955 nil or empty string as argument means make buffer not be visiting any file.
1956 Remember to delete the initial contents of the minibuffer
1957 if you wish to pass an empty string as the argument.
1958
1959 The optional second argument NO-QUERY, if non-nil, inhibits asking for
1960 confirmation in the case where another buffer is already visiting FILENAME.
1961
1962 The optional third argument ALONG-WITH-FILE, if non-nil, means that
1963 the old visited file has been renamed to the new name FILENAME."
1964 (interactive "FSet visited file name: ")
1965 (if (buffer-base-buffer)
1966 (error "An indirect buffer cannot visit a file"))
1967 (let (truename)
1968 (if filename
1969 (setq filename
1970 (if (string-equal filename "")
1971 nil
1972 (expand-file-name filename))))
1973 (if filename
1974 (progn
1975 (setq truename (file-truename filename))
1976 (if find-file-visit-truename
1977 (setq filename truename))))
1978 (let ((buffer (and filename (find-buffer-visiting filename))))
1979 (and buffer (not (eq buffer (current-buffer)))
1980 (not no-query)
1981 (not (y-or-n-p (message "A buffer is visiting %s; proceed? "
1982 filename)))
1983 (error "Aborted")))
1984 (or (equal filename buffer-file-name)
1985 (progn
1986 (and filename (lock-buffer filename))
1987 (unlock-buffer)))
1988 (setq buffer-file-name filename)
1989 (if filename ; make buffer name reflect filename.
1990 (let ((new-name (file-name-nondirectory buffer-file-name)))
1991 (if (string= new-name "")
1992 (error "Empty file name"))
1993 (if (eq system-type 'vax-vms)
1994 (setq new-name (downcase new-name)))
1995 (setq default-directory (file-name-directory buffer-file-name))
1996 (or (string= new-name (buffer-name))
1997 (rename-buffer new-name t))))
1998 (setq buffer-backed-up nil)
1999 (or along-with-file
2000 (clear-visited-file-modtime))
2001 ;; Abbreviate the file names of the buffer.
2002 (if truename
2003 (progn
2004 (setq buffer-file-truename (abbreviate-file-name truename))
2005 (if find-file-visit-truename
2006 (setq buffer-file-name buffer-file-truename))))
2007 (setq buffer-file-number
2008 (if filename
2009 (nthcdr 10 (file-attributes buffer-file-name))
2010 nil)))
2011 ;; write-file-hooks is normally used for things like ftp-find-file
2012 ;; that visit things that are not local files as if they were files.
2013 ;; Changing to visit an ordinary local file instead should flush the hook.
2014 (kill-local-variable 'write-file-hooks)
2015 (kill-local-variable 'local-write-file-hooks)
2016 (kill-local-variable 'revert-buffer-function)
2017 (kill-local-variable 'backup-inhibited)
2018 ;; If buffer was read-only because of version control,
2019 ;; that reason is gone now, so make it writable.
2020 (if vc-mode
2021 (setq buffer-read-only nil))
2022 (kill-local-variable 'vc-mode)
2023 ;; Turn off backup files for certain file names.
2024 ;; Since this is a permanent local, the major mode won't eliminate it.
2025 (and buffer-file-name
2026 (not (funcall backup-enable-predicate buffer-file-name))
2027 (progn
2028 (make-local-variable 'backup-inhibited)
2029 (setq backup-inhibited t)))
2030 (let ((oauto buffer-auto-save-file-name))
2031 ;; If auto-save was not already on, turn it on if appropriate.
2032 (if (not buffer-auto-save-file-name)
2033 (and buffer-file-name auto-save-default
2034 (auto-save-mode t))
2035 ;; If auto save is on, start using a new name.
2036 ;; We deliberately don't rename or delete the old auto save
2037 ;; for the old visited file name. This is because perhaps
2038 ;; the user wants to save the new state and then compare with the
2039 ;; previous state from the auto save file.
2040 (setq buffer-auto-save-file-name
2041 (make-auto-save-file-name)))
2042 ;; Rename the old auto save file if any.
2043 (and oauto buffer-auto-save-file-name
2044 (file-exists-p oauto)
2045 (rename-file oauto buffer-auto-save-file-name t)))
2046 (and buffer-file-name
2047 (not along-with-file)
2048 (set-buffer-modified-p t))
2049 ;; Update the major mode, if the file name determines it.
2050 (condition-case nil
2051 ;; Don't change the mode if it is special.
2052 (or (not change-major-mode-with-file-name)
2053 (get major-mode 'mode-class)
2054 ;; Don't change the mode if the local variable list specifies it.
2055 (hack-local-variables t)
2056 (set-auto-mode t))
2057 (error nil)))
2058
2059 (defun write-file (filename &optional confirm)
2060 "Write current buffer into file FILENAME.
2061 This makes the buffer visit that file, and marks it as not modified.
2062
2063 If you specify just a directory name as FILENAME, that means to use
2064 the default file name but in that directory. You can also yank
2065 the default file name into the minibuffer to edit it, using M-n.
2066
2067 If the buffer is not already visiting a file, the default file name
2068 for the output file is the buffer name.
2069
2070 If optional second arg CONFIRM is non-nil, this function
2071 asks for confirmation before overwriting an existing file.
2072 Interactively, confirmation is required unless you supply a prefix argument."
2073 ;; (interactive "FWrite file: ")
2074 (interactive
2075 (list (if buffer-file-name
2076 (read-file-name "Write file: "
2077 nil nil nil nil)
2078 (read-file-name "Write file: " default-directory
2079 (expand-file-name
2080 (file-name-nondirectory (buffer-name))
2081 default-directory)
2082 nil nil))
2083 (not current-prefix-arg)))
2084 (or (null filename) (string-equal filename "")
2085 (progn
2086 ;; If arg is just a directory,
2087 ;; use the default file name, but in that directory.
2088 (if (file-directory-p filename)
2089 (setq filename (concat (file-name-as-directory filename)
2090 (file-name-nondirectory
2091 (or buffer-file-name (buffer-name))))))
2092 (and confirm
2093 (file-exists-p filename)
2094 (or (y-or-n-p (format "File `%s' exists; overwrite? " filename))
2095 (error "Canceled")))
2096 (set-visited-file-name filename (not confirm))))
2097 (set-buffer-modified-p t)
2098 ;; Make buffer writable if file is writable.
2099 (and buffer-file-name
2100 (file-writable-p buffer-file-name)
2101 (setq buffer-read-only nil))
2102 (save-buffer))
2103 \f
2104 (defun backup-buffer ()
2105 "Make a backup of the disk file visited by the current buffer, if appropriate.
2106 This is normally done before saving the buffer the first time.
2107 If the value is non-nil, it is the result of `file-modes' on the original
2108 file; this means that the caller, after saving the buffer, should change
2109 the modes of the new file to agree with the old modes.
2110
2111 A backup may be done by renaming or by copying; see documentation of
2112 variable `make-backup-files'. If it's done by renaming, then the file is
2113 no longer accessible under its old name."
2114 (if (and make-backup-files (not backup-inhibited)
2115 (not buffer-backed-up)
2116 (file-exists-p buffer-file-name)
2117 (memq (aref (elt (file-attributes buffer-file-name) 8) 0)
2118 '(?- ?l)))
2119 (let ((real-file-name buffer-file-name)
2120 backup-info backupname targets setmodes)
2121 ;; If specified name is a symbolic link, chase it to the target.
2122 ;; Thus we make the backups in the directory where the real file is.
2123 (setq real-file-name (file-chase-links real-file-name))
2124 (setq backup-info (find-backup-file-name real-file-name)
2125 backupname (car backup-info)
2126 targets (cdr backup-info))
2127 ;; (if (file-directory-p buffer-file-name)
2128 ;; (error "Cannot save buffer in directory %s" buffer-file-name))
2129 (if backup-info
2130 (condition-case ()
2131 (let ((delete-old-versions
2132 ;; If have old versions to maybe delete,
2133 ;; ask the user to confirm now, before doing anything.
2134 ;; But don't actually delete til later.
2135 (and targets
2136 (or (eq delete-old-versions t) (eq delete-old-versions nil))
2137 (or delete-old-versions
2138 (y-or-n-p (format "Delete excess backup versions of %s? "
2139 real-file-name))))))
2140 ;; Actually write the back up file.
2141 (condition-case ()
2142 (if (or file-precious-flag
2143 ; (file-symlink-p buffer-file-name)
2144 backup-by-copying
2145 (and backup-by-copying-when-linked
2146 (> (file-nlinks real-file-name) 1))
2147 (and (or backup-by-copying-when-mismatch
2148 (integerp backup-by-copying-when-privileged-mismatch))
2149 (let ((attr (file-attributes real-file-name)))
2150 (and (or backup-by-copying-when-mismatch
2151 (and (integerp (nth 2 attr))
2152 (integerp backup-by-copying-when-privileged-mismatch)
2153 (<= (nth 2 attr) backup-by-copying-when-privileged-mismatch)))
2154 (or (nth 9 attr)
2155 (not (file-ownership-preserved-p real-file-name)))))))
2156 (condition-case ()
2157 (copy-file real-file-name backupname t t)
2158 (file-error
2159 ;; If copying fails because file BACKUPNAME
2160 ;; is not writable, delete that file and try again.
2161 (if (and (file-exists-p backupname)
2162 (not (file-writable-p backupname)))
2163 (delete-file backupname))
2164 (copy-file real-file-name backupname t t)))
2165 ;; rename-file should delete old backup.
2166 (rename-file real-file-name backupname t)
2167 (setq setmodes (file-modes backupname)))
2168 (file-error
2169 ;; If trouble writing the backup, write it in ~.
2170 (setq backupname (expand-file-name
2171 (convert-standard-filename
2172 "~/%backup%~")))
2173 (message "Cannot write backup file; backing up in %s"
2174 (file-name-nondirectory backupname))
2175 (sleep-for 1)
2176 (condition-case ()
2177 (copy-file real-file-name backupname t t)
2178 (file-error
2179 ;; If copying fails because file BACKUPNAME
2180 ;; is not writable, delete that file and try again.
2181 (if (and (file-exists-p backupname)
2182 (not (file-writable-p backupname)))
2183 (delete-file backupname))
2184 (copy-file real-file-name backupname t t)))))
2185 (setq buffer-backed-up t)
2186 ;; Now delete the old versions, if desired.
2187 (if delete-old-versions
2188 (while targets
2189 (condition-case ()
2190 (delete-file (car targets))
2191 (file-error nil))
2192 (setq targets (cdr targets))))
2193 setmodes)
2194 (file-error nil))))))
2195
2196 (defun file-name-sans-versions (name &optional keep-backup-version)
2197 "Return file NAME sans backup versions or strings.
2198 This is a separate procedure so your site-init or startup file can
2199 redefine it.
2200 If the optional argument KEEP-BACKUP-VERSION is non-nil,
2201 we do not remove backup version numbers, only true file version numbers."
2202 (let ((handler (find-file-name-handler name 'file-name-sans-versions)))
2203 (if handler
2204 (funcall handler 'file-name-sans-versions name keep-backup-version)
2205 (substring name 0
2206 (if (eq system-type 'vax-vms)
2207 ;; VMS version number is (a) semicolon, optional
2208 ;; sign, zero or more digits or (b) period, option
2209 ;; sign, zero or more digits, provided this is the
2210 ;; second period encountered outside of the
2211 ;; device/directory part of the file name.
2212 (or (string-match ";[-+]?[0-9]*\\'" name)
2213 (if (string-match "\\.[^]>:]*\\(\\.[-+]?[0-9]*\\)\\'"
2214 name)
2215 (match-beginning 1))
2216 (length name))
2217 (if keep-backup-version
2218 (length name)
2219 (or (string-match "\\.~[0-9.]+~\\'" name)
2220 (string-match "~\\'" name)
2221 (length name))))))))
2222
2223 (defun file-ownership-preserved-p (file)
2224 "Return t if deleting FILE and rewriting it would preserve the owner."
2225 (let ((handler (find-file-name-handler file 'file-ownership-preserved-p)))
2226 (if handler
2227 (funcall handler 'file-ownership-preserved-p file)
2228 (let ((attributes (file-attributes file)))
2229 ;; Return t if the file doesn't exist, since it's true that no
2230 ;; information would be lost by an (attempted) delete and create.
2231 (or (null attributes)
2232 (= (nth 2 attributes) (user-uid)))))))
2233
2234 (defun file-name-sans-extension (filename)
2235 "Return FILENAME sans final \"extension\".
2236 The extension, in a file name, is the part that follows the last `.',
2237 except that a leading `.', if any, doesn't count."
2238 (save-match-data
2239 (let ((file (file-name-sans-versions (file-name-nondirectory filename)))
2240 directory)
2241 (if (and (string-match "\\.[^.]*\\'" file)
2242 (not (eq 0 (match-beginning 0))))
2243 (if (setq directory (file-name-directory filename))
2244 (expand-file-name (substring file 0 (match-beginning 0))
2245 directory)
2246 (substring file 0 (match-beginning 0)))
2247 filename))))
2248
2249 (defun file-name-extension (filename &optional period)
2250 "Return FILENAME's final \"extension\".
2251 The extension, in a file name, is the part that follows the last `.',
2252 except that a leading `.', if any, doesn't count.
2253 Return nil for extensionless file names such as `foo'.
2254 Return the empty string for file names such as `foo.'.
2255
2256 If PERIOD is non-nil, then the returned value includes the period
2257 that delimits the extension, and if FILENAME has no extension,
2258 the value is \"\"."
2259 (save-match-data
2260 (let ((file (file-name-sans-versions (file-name-nondirectory filename))))
2261 (if (and (string-match "\\.[^.]*\\'" file)
2262 (not (eq 0 (match-beginning 0))))
2263 (substring file (+ (match-beginning 0) (if period 0 1)))
2264 (if period
2265 "")))))
2266
2267 (defcustom make-backup-file-name-function nil
2268 "A function to use instead of the default `make-backup-file-name'.
2269 A value of nil gives the default `make-backup-file-name' behaviour.
2270
2271 This could be buffer-local to do something special for specific
2272 files. If you define it, you may need to change `backup-file-name-p'
2273 and `file-name-sans-versions' too.
2274
2275 See also `backup-directory-alist'."
2276 :group 'backup
2277 :type '(choice (const :tag "Default" nil)
2278 (function :tag "Your function")))
2279
2280 (defcustom backup-directory-alist nil
2281 "Alist of filename patterns and backup directory names.
2282 Each element looks like (REGEXP . DIRECTORY). Backups of files with
2283 names matching REGEXP will be made in DIRECTORY. DIRECTORY may be
2284 relative or absolute. If it is absolute, so that all matching files
2285 are backed up into the same directory, the file names in this
2286 directory will be the full name of the file backed up with all
2287 directory separators changed to `!' to prevent clashes. This will not
2288 work correctly if your filesystem truncates the resulting name.
2289
2290 For the common case of all backups going into one directory, the alist
2291 should contain a single element pairing \".\" with the appropriate
2292 directory name.
2293
2294 If this variable is nil, or it fails to match a filename, the backup
2295 is made in the original file's directory.
2296
2297 On MS-DOS filesystems without long names this variable is always
2298 ignored."
2299 :group 'backup
2300 :type '(repeat (cons (regexp :tag "Regexp matching filename")
2301 (directory :tag "Backup directory name"))))
2302
2303 (defun normal-backup-enable-predicate (name)
2304 "Default `backup-enable-predicate' function.
2305 Checks for files in `temporary-file-directory' or
2306 `small-temporary-file-directory'."
2307 (not (or (let ((comp (compare-strings temporary-file-directory 0 nil
2308 name 0 nil)))
2309 ;; Directory is under temporary-file-directory.
2310 (and (not (eq comp t))
2311 (< comp (- (length temporary-file-directory)))))
2312 (if small-temporary-file-directory
2313 (let ((comp (compare-strings small-temporary-file-directory
2314 0 nil
2315 name 0 nil)))
2316 ;; Directory is under small-temporary-file-directory.
2317 (and (not (eq comp t))
2318 (< comp (- (length small-temporary-file-directory)))))))))
2319
2320 (defun make-backup-file-name (file)
2321 "Create the non-numeric backup file name for FILE.
2322 Normally this will just be the file's name with `~' appended.
2323 Customization hooks are provided as follows.
2324
2325 If the variable `make-backup-file-name-function' is non-nil, its value
2326 should be a function which will be called with FILE as its argument;
2327 the resulting name is used.
2328
2329 Otherwise a match for FILE is sought in `backup-directory-alist'; see
2330 the documentation of that variable. If the directory for the backup
2331 doesn't exist, it is created."
2332 (if make-backup-file-name-function
2333 (funcall make-backup-file-name-function file)
2334 (if (and (eq system-type 'ms-dos)
2335 (not (msdos-long-file-names)))
2336 (let ((fn (file-name-nondirectory file)))
2337 (concat (file-name-directory file)
2338 (or (and (string-match "\\`[^.]+\\'" fn)
2339 (concat (match-string 0 fn) ".~"))
2340 (and (string-match "\\`[^.]+\\.\\(..?\\)?" fn)
2341 (concat (match-string 0 fn) "~")))))
2342 (concat (make-backup-file-name-1 file) "~"))))
2343
2344 (defun make-backup-file-name-1 (file)
2345 "Subroutine of `make-backup-file-name' and `find-backup-file-name'."
2346 (let ((alist backup-directory-alist)
2347 elt backup-directory dir-sep-string)
2348 (while alist
2349 (setq elt (pop alist))
2350 (if (string-match (car elt) file)
2351 (setq backup-directory (cdr elt)
2352 alist nil)))
2353 (if (null backup-directory)
2354 file
2355 (unless (file-exists-p backup-directory)
2356 (condition-case nil
2357 (make-directory backup-directory 'parents)
2358 (file-error file)))
2359 (if (file-name-absolute-p backup-directory)
2360 (progn
2361 (when (memq system-type '(windows-nt ms-dos))
2362 ;; Normalize DOSish file names: convert all slashes to
2363 ;; directory-sep-char, downcase the drive letter, if any,
2364 ;; and replace the leading "x:" with "/drive_x".
2365 (or (file-name-absolute-p file)
2366 (setq file (expand-file-name file))) ; make defaults explicit
2367 ;; Replace any invalid file-name characters (for the
2368 ;; case of backing up remote files).
2369 (setq file (expand-file-name (convert-standard-filename file)))
2370 (setq dir-sep-string (char-to-string directory-sep-char))
2371 (if (eq (aref file 1) ?:)
2372 (setq file (concat dir-sep-string
2373 "drive_"
2374 (char-to-string (downcase (aref file 0)))
2375 (if (eq (aref file 2) directory-sep-char)
2376 ""
2377 dir-sep-string)
2378 (substring file 2)))))
2379 ;; Make the name unique by substituting directory
2380 ;; separators. It may not really be worth bothering about
2381 ;; doubling `!'s in the original name...
2382 (expand-file-name
2383 (subst-char-in-string
2384 directory-sep-char ?!
2385 (replace-regexp-in-string "!" "!!" file))
2386 backup-directory))
2387 (expand-file-name (file-name-nondirectory file)
2388 (file-name-as-directory
2389 (expand-file-name backup-directory
2390 (file-name-directory file))))))))
2391
2392 (defun backup-file-name-p (file)
2393 "Return non-nil if FILE is a backup file name (numeric or not).
2394 This is a separate function so you can redefine it for customization.
2395 You may need to redefine `file-name-sans-versions' as well."
2396 (string-match "~\\'" file))
2397
2398 (defvar backup-extract-version-start)
2399
2400 ;; This is used in various files.
2401 ;; The usage of backup-extract-version-start is not very clean,
2402 ;; but I can't see a good alternative, so as of now I am leaving it alone.
2403 (defun backup-extract-version (fn)
2404 "Given the name of a numeric backup file, FN, return the backup number.
2405 Uses the free variable `backup-extract-version-start', whose value should be
2406 the index in the name where the version number begins."
2407 (if (and (string-match "[0-9]+~$" fn backup-extract-version-start)
2408 (= (match-beginning 0) backup-extract-version-start))
2409 (string-to-int (substring fn backup-extract-version-start -1))
2410 0))
2411
2412 ;; I believe there is no need to alter this behavior for VMS;
2413 ;; since backup files are not made on VMS, it should not get called.
2414 (defun find-backup-file-name (fn)
2415 "Find a file name for a backup file FN, and suggestions for deletions.
2416 Value is a list whose car is the name for the backup file
2417 and whose cdr is a list of old versions to consider deleting now.
2418 If the value is nil, don't make a backup.
2419 Uses `backup-directory-alist' in the same way as does
2420 `make-backup-file-name'."
2421 (let ((handler (find-file-name-handler fn 'find-backup-file-name)))
2422 ;; Run a handler for this function so that ange-ftp can refuse to do it.
2423 (if handler
2424 (funcall handler 'find-backup-file-name fn)
2425 (if (or (eq version-control 'never)
2426 ;; We don't support numbered backups on plain MS-DOS
2427 ;; when long file names are unavailable.
2428 (and (eq system-type 'ms-dos)
2429 (not (msdos-long-file-names))))
2430 (list (make-backup-file-name fn))
2431 (let* ((basic-name (make-backup-file-name-1 fn))
2432 (base-versions (concat (file-name-nondirectory basic-name)
2433 ".~"))
2434 (backup-extract-version-start (length base-versions))
2435 (high-water-mark 0)
2436 (number-to-delete 0)
2437 possibilities deserve-versions-p versions)
2438 (condition-case ()
2439 (setq possibilities (file-name-all-completions
2440 base-versions
2441 (file-name-directory basic-name))
2442 versions (sort (mapcar #'backup-extract-version
2443 possibilities)
2444 #'<)
2445 high-water-mark (apply 'max 0 versions)
2446 deserve-versions-p (or version-control
2447 (> high-water-mark 0))
2448 number-to-delete (- (length versions)
2449 kept-old-versions
2450 kept-new-versions
2451 -1))
2452 (file-error (setq possibilities nil)))
2453 (if (not deserve-versions-p)
2454 (list (make-backup-file-name fn))
2455 (cons (format "%s.~%d~" basic-name (1+ high-water-mark))
2456 (if (and (> number-to-delete 0)
2457 ;; Delete nothing if there is overflow
2458 ;; in the number of versions to keep.
2459 (>= (+ kept-new-versions kept-old-versions -1) 0))
2460 (mapcar (lambda (n)
2461 (format "%s.~%d~" basic-name n))
2462 (let ((v (nthcdr kept-old-versions versions)))
2463 (rplacd (nthcdr (1- number-to-delete) v) ())
2464 v))))))))))
2465
2466 (defun file-nlinks (filename)
2467 "Return number of names file FILENAME has."
2468 (car (cdr (file-attributes filename))))
2469
2470 (defun file-relative-name (filename &optional directory)
2471 "Convert FILENAME to be relative to DIRECTORY (default: `default-directory').
2472 This function returns a relative file name which is equivalent to FILENAME
2473 when used with that default directory as the default.
2474 If this is impossible (which can happen on MSDOS and Windows
2475 when the file name and directory use different drive names)
2476 then it returns FILENAME."
2477 (save-match-data
2478 (let ((fname (expand-file-name filename)))
2479 (setq directory (file-name-as-directory
2480 (expand-file-name (or directory default-directory))))
2481 ;; On Microsoft OSes, if FILENAME and DIRECTORY have different
2482 ;; drive names, they can't be relative, so return the absolute name.
2483 (if (and (or (eq system-type 'ms-dos)
2484 (eq system-type 'windows-nt))
2485 (not (string-equal (substring fname 0 2)
2486 (substring directory 0 2))))
2487 filename
2488 (let ((ancestor ".")
2489 (fname-dir (file-name-as-directory fname)))
2490 (while (and (not (string-match (concat "^" (regexp-quote directory)) fname-dir))
2491 (not (string-match (concat "^" (regexp-quote directory)) fname)))
2492 (setq directory (file-name-directory (substring directory 0 -1))
2493 ancestor (if (equal ancestor ".")
2494 ".."
2495 (concat "../" ancestor))))
2496 ;; Now ancestor is empty, or .., or ../.., etc.
2497 (if (string-match (concat "^" (regexp-quote directory)) fname)
2498 ;; We matched within FNAME's directory part.
2499 ;; Add the rest of FNAME onto ANCESTOR.
2500 (let ((rest (substring fname (match-end 0))))
2501 (if (and (equal ancestor ".")
2502 (not (equal rest "")))
2503 ;; But don't bother with ANCESTOR if it would give us `./'.
2504 rest
2505 (concat (file-name-as-directory ancestor) rest)))
2506 ;; We matched FNAME's directory equivalent.
2507 ancestor))))))
2508 \f
2509 (defun save-buffer (&optional args)
2510 "Save current buffer in visited file if modified. Versions described below.
2511 By default, makes the previous version into a backup file
2512 if previously requested or if this is the first save.
2513 With 1 \\[universal-argument], marks this version
2514 to become a backup when the next save is done.
2515 With 2 \\[universal-argument]'s,
2516 unconditionally makes the previous version into a backup file.
2517 With 3 \\[universal-argument]'s, marks this version
2518 to become a backup when the next save is done,
2519 and unconditionally makes the previous version into a backup file.
2520
2521 With argument of 0, never make the previous version into a backup file.
2522
2523 If a file's name is FOO, the names of its numbered backup versions are
2524 FOO.~i~ for various integers i. A non-numbered backup file is called FOO~.
2525 Numeric backups (rather than FOO~) will be made if value of
2526 `version-control' is not the atom `never' and either there are already
2527 numeric versions of the file being backed up, or `version-control' is
2528 non-nil.
2529 We don't want excessive versions piling up, so there are variables
2530 `kept-old-versions', which tells Emacs how many oldest versions to keep,
2531 and `kept-new-versions', which tells how many newest versions to keep.
2532 Defaults are 2 old versions and 2 new.
2533 `dired-kept-versions' controls dired's clean-directory (.) command.
2534 If `delete-old-versions' is nil, system will query user
2535 before trimming versions. Otherwise it does it silently.
2536
2537 If `vc-make-backup-files' is nil, which is the default,
2538 no backup files are made for files managed by version control.
2539 (This is because the version control system itself records previous versions.)
2540
2541 See the subroutine `basic-save-buffer' for more information."
2542 (interactive "p")
2543 (let ((modp (buffer-modified-p))
2544 (large (> (buffer-size) 50000))
2545 (make-backup-files (or (and make-backup-files (not (eq args 0)))
2546 (memq args '(16 64)))))
2547 (and modp (memq args '(16 64)) (setq buffer-backed-up nil))
2548 (if (and modp large (buffer-file-name))
2549 (message "Saving file %s..." (buffer-file-name)))
2550 (basic-save-buffer)
2551 (and modp (memq args '(4 64)) (setq buffer-backed-up nil))))
2552
2553 (defun delete-auto-save-file-if-necessary (&optional force)
2554 "Delete auto-save file for current buffer if `delete-auto-save-files' is t.
2555 Normally delete only if the file was written by this Emacs since
2556 the last real save, but optional arg FORCE non-nil means delete anyway."
2557 (and buffer-auto-save-file-name delete-auto-save-files
2558 (not (string= buffer-file-name buffer-auto-save-file-name))
2559 (or force (recent-auto-save-p))
2560 (progn
2561 (condition-case ()
2562 (delete-file buffer-auto-save-file-name)
2563 (file-error nil))
2564 (set-buffer-auto-saved))))
2565
2566 (defvar auto-save-hook nil
2567 "Normal hook run just before auto-saving.")
2568
2569 (defcustom after-save-hook nil
2570 "Normal hook that is run after a buffer is saved to its file."
2571 :options '(executable-make-buffer-file-executable-if-script-p)
2572 :type 'hook
2573 :group 'files)
2574
2575 (defvar save-buffer-coding-system nil
2576 "If non-nil, use this coding system for saving the buffer.
2577 More precisely, use this coding system in place of the
2578 value of `buffer-file-coding-system', when saving the buffer.
2579 Calling `write-region' for any purpose other than saving the buffer
2580 will still use `buffer-file-coding-system'; this variable has no effect
2581 in such cases.")
2582
2583 (make-variable-buffer-local 'save-buffer-coding-system)
2584 (put 'save-buffer-coding-system 'permanent-local t)
2585
2586 (defun basic-save-buffer ()
2587 "Save the current buffer in its visited file, if it has been modified.
2588 The hooks `write-contents-hooks', `local-write-file-hooks' and
2589 `write-file-hooks' get a chance to do the job of saving; if they do not,
2590 then the buffer is saved in the visited file file in the usual way.
2591 After saving the buffer, this function runs `after-save-hook'."
2592 (interactive)
2593 (save-current-buffer
2594 ;; In an indirect buffer, save its base buffer instead.
2595 (if (buffer-base-buffer)
2596 (set-buffer (buffer-base-buffer)))
2597 (if (buffer-modified-p)
2598 (let ((recent-save (recent-auto-save-p))
2599 setmodes tempsetmodes)
2600 ;; On VMS, rename file and buffer to get rid of version number.
2601 (if (and (eq system-type 'vax-vms)
2602 (not (string= buffer-file-name
2603 (file-name-sans-versions buffer-file-name))))
2604 (let (buffer-new-name)
2605 ;; Strip VMS version number before save.
2606 (setq buffer-file-name
2607 (file-name-sans-versions buffer-file-name))
2608 ;; Construct a (unique) buffer name to correspond.
2609 (let ((buf (create-file-buffer (downcase buffer-file-name))))
2610 (setq buffer-new-name (buffer-name buf))
2611 (kill-buffer buf))
2612 (rename-buffer buffer-new-name)))
2613 ;; If buffer has no file name, ask user for one.
2614 (or buffer-file-name
2615 (let ((filename
2616 (expand-file-name
2617 (read-file-name "File to save in: ") nil)))
2618 (and (file-exists-p filename)
2619 (or (y-or-n-p (format "File `%s' exists; overwrite? "
2620 filename))
2621 (error "Canceled")))
2622 (set-visited-file-name filename)))
2623 (or (verify-visited-file-modtime (current-buffer))
2624 (not (file-exists-p buffer-file-name))
2625 (yes-or-no-p
2626 (format "%s has changed since visited or saved. Save anyway? "
2627 (file-name-nondirectory buffer-file-name)))
2628 (error "Save not confirmed"))
2629 (save-restriction
2630 (widen)
2631 (save-excursion
2632 (and (> (point-max) 1)
2633 (not find-file-literally)
2634 (/= (char-after (1- (point-max))) ?\n)
2635 (not (and (eq selective-display t)
2636 (= (char-after (1- (point-max))) ?\r)))
2637 (or (eq require-final-newline t)
2638 (and require-final-newline
2639 (y-or-n-p
2640 (format "Buffer %s does not end in newline. Add one? "
2641 (buffer-name)))))
2642 (save-excursion
2643 (goto-char (point-max))
2644 (insert ?\n))))
2645 ;; Support VC version backups.
2646 (vc-before-save)
2647 (or (run-hook-with-args-until-success 'write-contents-hooks)
2648 (run-hook-with-args-until-success 'local-write-file-hooks)
2649 (run-hook-with-args-until-success 'write-file-hooks)
2650 ;; If a hook returned t, file is already "written".
2651 ;; Otherwise, write it the usual way now.
2652 (setq setmodes (basic-save-buffer-1)))
2653 ;; Now we have saved the current buffer. Let's make sure
2654 ;; that buffer-file-coding-system is fixed to what
2655 ;; actually used for saving by binding it locally.
2656 (if save-buffer-coding-system
2657 (setq save-buffer-coding-system last-coding-system-used)
2658 (setq buffer-file-coding-system last-coding-system-used))
2659 (setq buffer-file-number
2660 (nthcdr 10 (file-attributes buffer-file-name)))
2661 (if setmodes
2662 (condition-case ()
2663 (set-file-modes buffer-file-name setmodes)
2664 (error nil))))
2665 ;; If the auto-save file was recent before this command,
2666 ;; delete it now.
2667 (delete-auto-save-file-if-necessary recent-save)
2668 ;; Support VC `implicit' locking.
2669 (vc-after-save)
2670 (run-hooks 'after-save-hook))
2671 (message "(No changes need to be saved)"))))
2672
2673 ;; This does the "real job" of writing a buffer into its visited file
2674 ;; and making a backup file. This is what is normally done
2675 ;; but inhibited if one of write-file-hooks returns non-nil.
2676 ;; It returns a value to store in setmodes.
2677 (defun basic-save-buffer-1 ()
2678 (if save-buffer-coding-system
2679 (let ((coding-system-for-write save-buffer-coding-system))
2680 (basic-save-buffer-2))
2681 (basic-save-buffer-2)))
2682
2683 (defun basic-save-buffer-2 ()
2684 (let (tempsetmodes setmodes)
2685 (if (not (file-writable-p buffer-file-name))
2686 (let ((dir (file-name-directory buffer-file-name)))
2687 (if (not (file-directory-p dir))
2688 (if (file-exists-p dir)
2689 (error "%s is not a directory" dir)
2690 (error "%s: no such directory" buffer-file-name))
2691 (if (not (file-exists-p buffer-file-name))
2692 (error "Directory %s write-protected" dir)
2693 (if (yes-or-no-p
2694 (format "File %s is write-protected; try to save anyway? "
2695 (file-name-nondirectory
2696 buffer-file-name)))
2697 (setq tempsetmodes t)
2698 (error "Attempt to save to a file which you aren't allowed to write"))))))
2699 (or buffer-backed-up
2700 (setq setmodes (backup-buffer)))
2701 (let ((dir (file-name-directory buffer-file-name)))
2702 (if (and file-precious-flag
2703 (file-writable-p dir))
2704 ;; If file is precious, write temp name, then rename it.
2705 ;; This requires write access to the containing dir,
2706 ;; which is why we don't try it if we don't have that access.
2707 (let ((realname buffer-file-name)
2708 tempname temp nogood i succeed
2709 (old-modtime (visited-file-modtime)))
2710 (setq i 0)
2711 (setq nogood t)
2712 ;; Find the temporary name to write under.
2713 (while nogood
2714 (setq tempname (format
2715 (if (and (eq system-type 'ms-dos)
2716 (not (msdos-long-file-names)))
2717 "%s#%d.tm#" ; MSDOS limits files to 8+3
2718 (if (memq system-type '(vax-vms axp-vms))
2719 "%s$tmp$%d"
2720 "%s#tmp#%d"))
2721 dir i))
2722 (setq nogood (file-exists-p tempname))
2723 (setq i (1+ i)))
2724 (unwind-protect
2725 (progn (clear-visited-file-modtime)
2726 (write-region (point-min) (point-max)
2727 tempname nil realname
2728 buffer-file-truename)
2729 (setq succeed t))
2730 ;; If writing the temp file fails,
2731 ;; delete the temp file.
2732 (or succeed
2733 (progn
2734 (delete-file tempname)
2735 (set-visited-file-modtime old-modtime))))
2736 ;; Since we have created an entirely new file
2737 ;; and renamed it, make sure it gets the
2738 ;; right permission bits set.
2739 (setq setmodes (file-modes buffer-file-name))
2740 ;; We succeeded in writing the temp file,
2741 ;; so rename it.
2742 (rename-file tempname buffer-file-name t))
2743 ;; If file not writable, see if we can make it writable
2744 ;; temporarily while we write it.
2745 ;; But no need to do so if we have just backed it up
2746 ;; (setmodes is set) because that says we're superseding.
2747 (cond ((and tempsetmodes (not setmodes))
2748 ;; Change the mode back, after writing.
2749 (setq setmodes (file-modes buffer-file-name))
2750 (set-file-modes buffer-file-name (logior setmodes 128))))
2751 (write-region (point-min) (point-max)
2752 buffer-file-name nil t buffer-file-truename)))
2753 setmodes))
2754
2755 (defun save-some-buffers (&optional arg pred)
2756 "Save some modified file-visiting buffers. Asks user about each one.
2757 Optional argument (the prefix) non-nil means save all with no questions.
2758 Optional second argument PRED determines which buffers are considered:
2759 If PRED is nil, all the file-visiting buffers are considered.
2760 If PRED is t, then certain non-file buffers will also be considered.
2761 If PRED is a zero-argument function, it indicates for each buffer whether
2762 to consider it or not when called with that buffer current."
2763 (interactive "P")
2764 (save-window-excursion
2765 (let* ((queried nil)
2766 (files-done
2767 (map-y-or-n-p
2768 (function
2769 (lambda (buffer)
2770 (and (buffer-modified-p buffer)
2771 (not (buffer-base-buffer buffer))
2772 (or
2773 (buffer-file-name buffer)
2774 (and pred
2775 (progn
2776 (set-buffer buffer)
2777 (and buffer-offer-save (> (buffer-size) 0)))))
2778 (or (not (functionp pred))
2779 (with-current-buffer buffer (funcall pred)))
2780 (if arg
2781 t
2782 (setq queried t)
2783 (if (buffer-file-name buffer)
2784 (format "Save file %s? "
2785 (buffer-file-name buffer))
2786 (format "Save buffer %s? "
2787 (buffer-name buffer)))))))
2788 (function
2789 (lambda (buffer)
2790 (set-buffer buffer)
2791 (save-buffer)))
2792 (buffer-list)
2793 '("buffer" "buffers" "save")
2794 (list (list ?\C-r (lambda (buf)
2795 (view-buffer buf
2796 (function
2797 (lambda (ignore)
2798 (exit-recursive-edit))))
2799 (recursive-edit)
2800 ;; Return nil to ask about BUF again.
2801 nil)
2802 "display the current buffer"))))
2803 (abbrevs-done
2804 (and save-abbrevs abbrevs-changed
2805 (progn
2806 (if (or arg
2807 (y-or-n-p (format "Save abbrevs in %s? "
2808 abbrev-file-name)))
2809 (write-abbrev-file nil))
2810 ;; Don't keep bothering user if he says no.
2811 (setq abbrevs-changed nil)
2812 t))))
2813 (or queried (> files-done 0) abbrevs-done
2814 (message "(No files need saving)")))))
2815 \f
2816 (defun not-modified (&optional arg)
2817 "Mark current buffer as unmodified, not needing to be saved.
2818 With prefix arg, mark buffer as modified, so \\[save-buffer] will save.
2819
2820 It is not a good idea to use this function in Lisp programs, because it
2821 prints a message in the minibuffer. Instead, use `set-buffer-modified-p'."
2822 (interactive "P")
2823 (message (if arg "Modification-flag set"
2824 "Modification-flag cleared"))
2825 (set-buffer-modified-p arg))
2826
2827 (defun toggle-read-only (&optional arg)
2828 "Change whether this buffer is visiting its file read-only.
2829 With arg, set read-only iff arg is positive.
2830 If visiting file read-only and `view-read-only' is non-nil, enter view mode."
2831 (interactive "P")
2832 (cond
2833 ((and arg (if (> (prefix-numeric-value arg) 0) buffer-read-only
2834 (not buffer-read-only))) ; If buffer-read-only is set correctly,
2835 nil) ; do nothing.
2836 ;; Toggle.
2837 ((and buffer-read-only view-mode)
2838 (View-exit-and-edit)
2839 (make-local-variable 'view-read-only)
2840 (setq view-read-only t)) ; Must leave view mode.
2841 ((and (not buffer-read-only) view-read-only
2842 (not (eq (get major-mode 'mode-class) 'special)))
2843 (view-mode-enter))
2844 (t (setq buffer-read-only (not buffer-read-only))
2845 (force-mode-line-update))))
2846
2847 (defun insert-file (filename)
2848 "Insert contents of file FILENAME into buffer after point.
2849 Set mark after the inserted text.
2850
2851 This function is meant for the user to run interactively.
2852 Don't call it from programs! Use `insert-file-contents' instead.
2853 \(Its calling sequence is different; see its documentation)."
2854 (interactive "*fInsert file: ")
2855 (if (file-directory-p filename)
2856 (signal 'file-error (list "Opening input file" "file is a directory"
2857 filename)))
2858 (let ((tem (insert-file-contents filename)))
2859 (push-mark (+ (point) (car (cdr tem))))))
2860
2861 (defun append-to-file (start end filename)
2862 "Append the contents of the region to the end of file FILENAME.
2863 When called from a function, expects three arguments,
2864 START, END and FILENAME. START and END are buffer positions
2865 saying what text to write."
2866 (interactive "r\nFAppend to file: ")
2867 (write-region start end filename t))
2868
2869 (defun file-newest-backup (filename)
2870 "Return most recent backup file for FILENAME or nil if no backups exist."
2871 ;; `make-backup-file-name' will get us the right directory for
2872 ;; ordinary or numeric backups. It might create a directory for
2873 ;; backups as a side-effect, according to `backup-directory-alist'.
2874 (let* ((filename (make-backup-file-name filename))
2875 (file (file-name-nondirectory filename))
2876 (dir (file-name-directory filename))
2877 (comp (file-name-all-completions file dir))
2878 (newest nil)
2879 tem)
2880 (while comp
2881 (setq tem (pop comp))
2882 (cond ((and (backup-file-name-p tem)
2883 (string= (file-name-sans-versions tem) file))
2884 (setq tem (concat dir tem))
2885 (if (or (null newest)
2886 (file-newer-than-file-p tem newest))
2887 (setq newest tem)))))
2888 newest))
2889
2890 (defun rename-uniquely ()
2891 "Rename current buffer to a similar name not already taken.
2892 This function is useful for creating multiple shell process buffers
2893 or multiple mail buffers, etc."
2894 (interactive)
2895 (save-match-data
2896 (let ((base-name (buffer-name)))
2897 (and (string-match "<[0-9]+>\\'" base-name)
2898 (not (and buffer-file-name
2899 (string= base-name
2900 (file-name-nondirectory buffer-file-name))))
2901 ;; If the existing buffer name has a <NNN>,
2902 ;; which isn't part of the file name (if any),
2903 ;; then get rid of that.
2904 (setq base-name (substring base-name 0 (match-beginning 0))))
2905 (rename-buffer (generate-new-buffer-name base-name))
2906 (force-mode-line-update))))
2907
2908 (defun make-directory (dir &optional parents)
2909 "Create the directory DIR and any nonexistent parent dirs.
2910 Interactively, the default choice of directory to create
2911 is the current default directory for file names.
2912 That is useful when you have visited a file in a nonexistent directory.
2913
2914 Noninteractively, the second (optional) argument PARENTS says whether
2915 to create parent directories if they don't exist."
2916 (interactive
2917 (list (read-file-name "Make directory: " default-directory default-directory
2918 nil nil)
2919 t))
2920 (let ((handler (find-file-name-handler dir 'make-directory)))
2921 (if handler
2922 (funcall handler 'make-directory dir parents)
2923 (if (not parents)
2924 (make-directory-internal dir)
2925 (let ((dir (directory-file-name (expand-file-name dir)))
2926 create-list)
2927 (while (not (file-exists-p dir))
2928 (setq create-list (cons dir create-list)
2929 dir (directory-file-name (file-name-directory dir))))
2930 (while create-list
2931 (make-directory-internal (car create-list))
2932 (setq create-list (cdr create-list))))))))
2933 \f
2934 (put 'revert-buffer-function 'permanent-local t)
2935 (defvar revert-buffer-function nil
2936 "Function to use to revert this buffer, or nil to do the default.
2937 The function receives two arguments IGNORE-AUTO and NOCONFIRM,
2938 which are the arguments that `revert-buffer' received.")
2939
2940 (put 'revert-buffer-insert-file-contents-function 'permanent-local t)
2941 (defvar revert-buffer-insert-file-contents-function nil
2942 "Function to use to insert contents when reverting this buffer.
2943 Gets two args, first the nominal file name to use,
2944 and second, t if reading the auto-save file.
2945
2946 The function you specify is responsible for updating (or preserving) point.")
2947
2948 (defvar before-revert-hook nil
2949 "Normal hook for `revert-buffer' to run before reverting.
2950 If `revert-buffer-function' is used to override the normal revert
2951 mechanism, this hook is not used.")
2952
2953 (defvar after-revert-hook nil
2954 "Normal hook for `revert-buffer' to run after reverting.
2955 Note that the hook value that it runs is the value that was in effect
2956 before reverting; that makes a difference if you have buffer-local
2957 hook functions.
2958
2959 If `revert-buffer-function' is used to override the normal revert
2960 mechanism, this hook is not used.")
2961
2962 (defvar revert-buffer-internal-hook)
2963
2964 (defun revert-buffer (&optional ignore-auto noconfirm preserve-modes)
2965 "Replace current buffer text with the text of the visited file on disk.
2966 This undoes all changes since the file was visited or saved.
2967 With a prefix argument, offer to revert from latest auto-save file, if
2968 that is more recent than the visited file.
2969
2970 This command also works for special buffers that contain text which
2971 doesn't come from a file, but reflects some other data base instead:
2972 for example, Dired buffers and buffer-list buffers. In these cases,
2973 it reconstructs the buffer contents from the appropriate data base.
2974
2975 When called from Lisp, the first argument is IGNORE-AUTO; only offer
2976 to revert from the auto-save file when this is nil. Note that the
2977 sense of this argument is the reverse of the prefix argument, for the
2978 sake of backward compatibility. IGNORE-AUTO is optional, defaulting
2979 to nil.
2980
2981 Optional second argument NOCONFIRM means don't ask for confirmation at
2982 all. (The local variable `revert-without-query', if non-nil, prevents
2983 confirmation.)
2984
2985 Optional third argument PRESERVE-MODES non-nil means don't alter
2986 the files modes. Normally we reinitialize them using `normal-mode'.
2987
2988 If the value of `revert-buffer-function' is non-nil, it is called to
2989 do all the work for this command. Otherwise, the hooks
2990 `before-revert-hook' and `after-revert-hook' are run at the beginning
2991 and the end, and if `revert-buffer-insert-file-contents-function' is
2992 non-nil, it is called instead of rereading visited file contents."
2993
2994 ;; I admit it's odd to reverse the sense of the prefix argument, but
2995 ;; there is a lot of code out there which assumes that the first
2996 ;; argument should be t to avoid consulting the auto-save file, and
2997 ;; there's no straightforward way to encourage authors to notice a
2998 ;; reversal of the argument sense. So I'm just changing the user
2999 ;; interface, but leaving the programmatic interface the same.
3000 (interactive (list (not current-prefix-arg)))
3001 (if revert-buffer-function
3002 (funcall revert-buffer-function ignore-auto noconfirm)
3003 (let* ((auto-save-p (and (not ignore-auto)
3004 (recent-auto-save-p)
3005 buffer-auto-save-file-name
3006 (file-readable-p buffer-auto-save-file-name)
3007 (y-or-n-p
3008 "Buffer has been auto-saved recently. Revert from auto-save file? ")))
3009 (file-name (if auto-save-p
3010 buffer-auto-save-file-name
3011 buffer-file-name)))
3012 (cond ((null file-name)
3013 (error "Buffer does not seem to be associated with any file"))
3014 ((or noconfirm
3015 (and (not (buffer-modified-p))
3016 (let ((tail revert-without-query)
3017 (found nil))
3018 (while tail
3019 (if (string-match (car tail) file-name)
3020 (setq found t))
3021 (setq tail (cdr tail)))
3022 found))
3023 (yes-or-no-p (format "Revert buffer from file %s? "
3024 file-name)))
3025 (run-hooks 'before-revert-hook)
3026 ;; If file was backed up but has changed since,
3027 ;; we shd make another backup.
3028 (and (not auto-save-p)
3029 (not (verify-visited-file-modtime (current-buffer)))
3030 (setq buffer-backed-up nil))
3031 ;; Get rid of all undo records for this buffer.
3032 (or (eq buffer-undo-list t)
3033 (setq buffer-undo-list nil))
3034 ;; Effectively copy the after-revert-hook status,
3035 ;; since after-find-file will clobber it.
3036 (let ((global-hook (default-value 'after-revert-hook))
3037 (local-hook-p (local-variable-p 'after-revert-hook))
3038 (local-hook (and (local-variable-p 'after-revert-hook)
3039 after-revert-hook)))
3040 (let (buffer-read-only
3041 ;; Don't make undo records for the reversion.
3042 (buffer-undo-list t))
3043 (if revert-buffer-insert-file-contents-function
3044 (funcall revert-buffer-insert-file-contents-function
3045 file-name auto-save-p)
3046 (if (not (file-exists-p file-name))
3047 (error "File %s no longer exists!" file-name))
3048 ;; Bind buffer-file-name to nil
3049 ;; so that we don't try to lock the file.
3050 (let ((buffer-file-name nil))
3051 (or auto-save-p
3052 (unlock-buffer)))
3053 (widen)
3054 (let ((coding-system-for-read
3055 ;; Auto-saved file shoule be read without
3056 ;; any code conversion.
3057 (if auto-save-p 'emacs-mule-unix
3058 coding-system-for-read)))
3059 ;; Note that this preserves point in an intelligent way.
3060 (insert-file-contents file-name (not auto-save-p)
3061 nil nil t))))
3062 ;; Recompute the truename in case changes in symlinks
3063 ;; have changed the truename.
3064 (setq buffer-file-truename
3065 (abbreviate-file-name (file-truename buffer-file-name)))
3066 (after-find-file nil nil t t preserve-modes)
3067 ;; Run after-revert-hook as it was before we reverted.
3068 (setq-default revert-buffer-internal-hook global-hook)
3069 (if local-hook-p
3070 (progn
3071 (make-local-variable 'revert-buffer-internal-hook)
3072 (setq revert-buffer-internal-hook local-hook))
3073 (kill-local-variable 'revert-buffer-internal-hook))
3074 (run-hooks 'revert-buffer-internal-hook))
3075 t)))))
3076
3077 (defun recover-file (file)
3078 "Visit file FILE, but get contents from its last auto-save file."
3079 ;; Actually putting the file name in the minibuffer should be used
3080 ;; only rarely.
3081 ;; Not just because users often use the default.
3082 (interactive "FRecover file: ")
3083 (setq file (expand-file-name file))
3084 (if (auto-save-file-name-p (file-name-nondirectory file))
3085 (error "%s is an auto-save file" file))
3086 (let ((file-name (let ((buffer-file-name file))
3087 (make-auto-save-file-name))))
3088 (cond ((if (file-exists-p file)
3089 (not (file-newer-than-file-p file-name file))
3090 (not (file-exists-p file-name)))
3091 (error "Auto-save file %s not current" file-name))
3092 ((save-window-excursion
3093 (with-output-to-temp-buffer "*Directory*"
3094 (buffer-disable-undo standard-output)
3095 (save-excursion
3096 (let ((switches dired-listing-switches))
3097 (if (file-symlink-p file)
3098 (setq switches (concat switches "L")))
3099 (set-buffer standard-output)
3100 ;; Use insert-directory-safely, not insert-directory,
3101 ;; because these files might not exist. In particular,
3102 ;; FILE might not exist if the auto-save file was for
3103 ;; a buffer that didn't visit a file, such as "*mail*".
3104 ;; The code in v20.x called `ls' directly, so we need
3105 ;; to emulate what `ls' did in that case.
3106 (insert-directory-safely file switches)
3107 (insert-directory-safely file-name switches))))
3108 (yes-or-no-p (format "Recover auto save file %s? " file-name)))
3109 (switch-to-buffer (find-file-noselect file t))
3110 (let ((buffer-read-only nil)
3111 ;; Keep the current buffer-file-coding-system.
3112 (coding-system buffer-file-coding-system)
3113 ;; Auto-saved file shoule be read without any code conversion.
3114 (coding-system-for-read 'emacs-mule-unix))
3115 (erase-buffer)
3116 (insert-file-contents file-name nil)
3117 (set-buffer-file-coding-system coding-system))
3118 (after-find-file nil nil t))
3119 (t (error "Recover-file cancelled")))))
3120
3121 (defun recover-session ()
3122 "Recover auto save files from a previous Emacs session.
3123 This command first displays a Dired buffer showing you the
3124 previous sessions that you could recover from.
3125 To choose one, move point to the proper line and then type C-c C-c.
3126 Then you'll be asked about a number of files to recover."
3127 (interactive)
3128 (if (null auto-save-list-file-prefix)
3129 (error "You set `auto-save-list-file-prefix' to disable making session files"))
3130 (let ((dir (file-name-directory auto-save-list-file-prefix)))
3131 (unless (file-directory-p dir)
3132 (make-directory dir t)))
3133 (let ((ls-lisp-support-shell-wildcards t))
3134 (dired (concat auto-save-list-file-prefix "*")
3135 (concat dired-listing-switches "t")))
3136 (save-excursion
3137 (goto-char (point-min))
3138 (or (looking-at " Move to the session you want to recover,")
3139 (let ((inhibit-read-only t))
3140 ;; Each line starts with a space
3141 ;; so that Font Lock mode won't highlight the first character.
3142 (insert " Move to the session you want to recover,\n"
3143 " then type C-c C-c to select it.\n\n"
3144 " You can also delete some of these files;\n"
3145 " type d on a line to mark that file for deletion.\n\n"))))
3146 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
3147 (define-key (current-local-map) "\C-c\C-c" 'recover-session-finish))
3148
3149 (defun recover-session-finish ()
3150 "Choose one saved session to recover auto-save files from.
3151 This command is used in the special Dired buffer created by
3152 \\[recover-session]."
3153 (interactive)
3154 ;; Get the name of the session file to recover from.
3155 (let ((file (dired-get-filename))
3156 files
3157 (buffer (get-buffer-create " *recover*")))
3158 (dired-unmark 1)
3159 (dired-do-flagged-delete t)
3160 (unwind-protect
3161 (save-excursion
3162 ;; Read in the auto-save-list file.
3163 (set-buffer buffer)
3164 (erase-buffer)
3165 (insert-file-contents file)
3166 ;; Loop thru the text of that file
3167 ;; and get out the names of the files to recover.
3168 (while (not (eobp))
3169 (let (thisfile autofile)
3170 (if (eolp)
3171 ;; This is a pair of lines for a non-file-visiting buffer.
3172 ;; Get the auto-save file name and manufacture
3173 ;; a "visited file name" from that.
3174 (progn
3175 (forward-line 1)
3176 (setq autofile
3177 (buffer-substring-no-properties
3178 (point)
3179 (save-excursion
3180 (end-of-line)
3181 (point))))
3182 (setq thisfile
3183 (expand-file-name
3184 (substring
3185 (file-name-nondirectory autofile)
3186 1 -1)
3187 (file-name-directory autofile)))
3188 (forward-line 1))
3189 ;; This pair of lines is a file-visiting
3190 ;; buffer. Use the visited file name.
3191 (progn
3192 (setq thisfile
3193 (buffer-substring-no-properties
3194 (point) (progn (end-of-line) (point))))
3195 (forward-line 1)
3196 (setq autofile
3197 (buffer-substring-no-properties
3198 (point) (progn (end-of-line) (point))))
3199 (forward-line 1)))
3200 ;; Ignore a file if its auto-save file does not exist now.
3201 (if (file-exists-p autofile)
3202 (setq files (cons thisfile files)))))
3203 (setq files (nreverse files))
3204 ;; The file contains a pair of line for each auto-saved buffer.
3205 ;; The first line of the pair contains the visited file name
3206 ;; or is empty if the buffer was not visiting a file.
3207 ;; The second line is the auto-save file name.
3208 (if files
3209 (map-y-or-n-p "Recover %s? "
3210 (lambda (file)
3211 (condition-case nil
3212 (save-excursion (recover-file file))
3213 (error
3214 "Failed to recover `%s'" file)))
3215 files
3216 '("file" "files" "recover"))
3217 (message "No files can be recovered from this session now")))
3218 (kill-buffer buffer))))
3219
3220 (defun kill-some-buffers (&optional list)
3221 "For each buffer in LIST, ask whether to kill it.
3222 LIST defaults to all existing live buffers."
3223 (interactive)
3224 (if (null list)
3225 (setq list (buffer-list)))
3226 (while list
3227 (let* ((buffer (car list))
3228 (name (buffer-name buffer)))
3229 (and (not (string-equal name ""))
3230 (/= (aref name 0) ? )
3231 (yes-or-no-p
3232 (format "Buffer %s %s. Kill? "
3233 name
3234 (if (buffer-modified-p buffer)
3235 "HAS BEEN EDITED" "is unmodified")))
3236 (kill-buffer buffer)))
3237 (setq list (cdr list))))
3238 \f
3239 (defun auto-save-mode (arg)
3240 "Toggle auto-saving of contents of current buffer.
3241 With prefix argument ARG, turn auto-saving on if positive, else off."
3242 (interactive "P")
3243 (setq buffer-auto-save-file-name
3244 (and (if (null arg)
3245 (or (not buffer-auto-save-file-name)
3246 ;; If auto-save is off because buffer has shrunk,
3247 ;; then toggling should turn it on.
3248 (< buffer-saved-size 0))
3249 (or (eq arg t) (listp arg) (and (integerp arg) (> arg 0))))
3250 (if (and buffer-file-name auto-save-visited-file-name
3251 (not buffer-read-only))
3252 buffer-file-name
3253 (make-auto-save-file-name))))
3254 ;; If -1 was stored here, to temporarily turn off saving,
3255 ;; turn it back on.
3256 (and (< buffer-saved-size 0)
3257 (setq buffer-saved-size 0))
3258 (if (interactive-p)
3259 (message "Auto-save %s (in this buffer)"
3260 (if buffer-auto-save-file-name "on" "off")))
3261 buffer-auto-save-file-name)
3262
3263 (defun rename-auto-save-file ()
3264 "Adjust current buffer's auto save file name for current conditions.
3265 Also rename any existing auto save file, if it was made in this session."
3266 (let ((osave buffer-auto-save-file-name))
3267 (setq buffer-auto-save-file-name
3268 (make-auto-save-file-name))
3269 (if (and osave buffer-auto-save-file-name
3270 (not (string= buffer-auto-save-file-name buffer-file-name))
3271 (not (string= buffer-auto-save-file-name osave))
3272 (file-exists-p osave)
3273 (recent-auto-save-p))
3274 (rename-file osave buffer-auto-save-file-name t))))
3275
3276 (defun make-auto-save-file-name ()
3277 "Return file name to use for auto-saves of current buffer.
3278 Does not consider `auto-save-visited-file-name' as that variable is checked
3279 before calling this function. You can redefine this for customization.
3280 See also `auto-save-file-name-p'."
3281 (if buffer-file-name
3282 (let ((list auto-save-file-name-transforms)
3283 (filename buffer-file-name)
3284 result)
3285 ;; Apply user-specified translations
3286 ;; to the file name.
3287 (while (and list (not result))
3288 (if (string-match (car (car list)) filename)
3289 (setq result (replace-match (cadr (car list)) t nil
3290 filename)))
3291 (setq list (cdr list)))
3292 (if result (setq filename result))
3293
3294 (if (and (eq system-type 'ms-dos)
3295 (not (msdos-long-file-names)))
3296 ;; We truncate the file name to DOS 8+3 limits before
3297 ;; doing anything else, because the regexp passed to
3298 ;; string-match below cannot handle extensions longer than
3299 ;; 3 characters, multiple dots, and other atrocities.
3300 (let ((fn (dos-8+3-filename
3301 (file-name-nondirectory buffer-file-name))))
3302 (string-match "\\`\\([^.]+\\)\\(\\.\\(..?\\)?.?\\|\\)\\'" fn)
3303 (concat (file-name-directory buffer-file-name)
3304 "#" (match-string 1 fn)
3305 "." (match-string 3 fn) "#"))
3306 (concat (file-name-directory filename)
3307 "#"
3308 (file-name-nondirectory filename)
3309 "#")))
3310
3311 ;; Deal with buffers that don't have any associated files. (Mail
3312 ;; mode tends to create a good number of these.)
3313
3314 (let ((buffer-name (buffer-name))
3315 (limit 0))
3316 ;; Eliminate all slashes and backslashes by
3317 ;; replacing them with sequences that start with %.
3318 ;; Quote % also, to keep distinct names distinct.
3319 (while (string-match "[/\\%]" buffer-name limit)
3320 (let* ((character (aref buffer-name (match-beginning 0)))
3321 (replacement
3322 (cond ((eq character ?%) "%%")
3323 ((eq character ?/) "%+")
3324 ((eq character ?\\) "%-"))))
3325 (setq buffer-name (replace-match replacement t t buffer-name))
3326 (setq limit (1+ (match-end 0)))))
3327 ;; Generate the file name.
3328 (expand-file-name
3329 (format "#%s#%s#" buffer-name (make-temp-name ""))
3330 ;; Try a few alternative directories, to get one we can write it.
3331 (cond
3332 ((file-writable-p default-directory) default-directory)
3333 ((file-writable-p "/var/tmp/") "/var/tmp/")
3334 ("~/"))))))
3335
3336 (defun auto-save-file-name-p (filename)
3337 "Return non-nil if FILENAME can be yielded by `make-auto-save-file-name'.
3338 FILENAME should lack slashes. You can redefine this for customization."
3339 (string-match "^#.*#$" filename))
3340 \f
3341 (defun wildcard-to-regexp (wildcard)
3342 "Given a shell file name pattern WILDCARD, return an equivalent regexp.
3343 The generated regexp will match a filename iff the filename
3344 matches that wildcard according to shell rules. Only wildcards known
3345 by `sh' are supported."
3346 (let* ((i (string-match "[[.*+\\^$?]" wildcard))
3347 ;; Copy the initial run of non-special characters.
3348 (result (substring wildcard 0 i))
3349 (len (length wildcard)))
3350 ;; If no special characters, we're almost done.
3351 (if i
3352 (while (< i len)
3353 (let ((ch (aref wildcard i))
3354 j)
3355 (setq
3356 result
3357 (concat result
3358 (cond
3359 ((and (eq ch ?\[)
3360 (< (1+ i) len)
3361 (eq (aref wildcard (1+ i)) ?\]))
3362 "\\[")
3363 ((eq ch ?\[) ; [...] maps to regexp char class
3364 (progn
3365 (setq i (1+ i))
3366 (concat
3367 (cond
3368 ((eq (aref wildcard i) ?!) ; [!...] -> [^...]
3369 (progn
3370 (setq i (1+ i))
3371 (if (eq (aref wildcard i) ?\])
3372 (progn
3373 (setq i (1+ i))
3374 "[^]")
3375 "[^")))
3376 ((eq (aref wildcard i) ?^)
3377 ;; Found "[^". Insert a `\0' character
3378 ;; (which cannot happen in a filename)
3379 ;; into the character class, so that `^'
3380 ;; is not the first character after `[',
3381 ;; and thus non-special in a regexp.
3382 (progn
3383 (setq i (1+ i))
3384 "[\000^"))
3385 ((eq (aref wildcard i) ?\])
3386 ;; I don't think `]' can appear in a
3387 ;; character class in a wildcard, but
3388 ;; let's be general here.
3389 (progn
3390 (setq i (1+ i))
3391 "[]"))
3392 (t "["))
3393 (prog1 ; copy everything upto next `]'.
3394 (substring wildcard
3395 i
3396 (setq j (string-match
3397 "]" wildcard i)))
3398 (setq i (if j (1- j) (1- len)))))))
3399 ((eq ch ?.) "\\.")
3400 ((eq ch ?*) "[^\000]*")
3401 ((eq ch ?+) "\\+")
3402 ((eq ch ?^) "\\^")
3403 ((eq ch ?$) "\\$")
3404 ((eq ch ?\\) "\\\\") ; probably cannot happen...
3405 ((eq ch ??) "[^\000]")
3406 (t (char-to-string ch)))))
3407 (setq i (1+ i)))))
3408 ;; Shell wildcards should match the entire filename,
3409 ;; not its part. Make the regexp say so.
3410 (concat "\\`" result "\\'")))
3411 \f
3412 (defcustom list-directory-brief-switches
3413 (if (eq system-type 'vax-vms) "" "-CF")
3414 "*Switches for `list-directory' to pass to `ls' for brief listing."
3415 :type 'string
3416 :group 'dired)
3417
3418 (defcustom list-directory-verbose-switches
3419 (if (eq system-type 'vax-vms)
3420 "/PROTECTION/SIZE/DATE/OWNER/WIDTH=(OWNER:10)"
3421 "-l")
3422 "*Switches for `list-directory' to pass to `ls' for verbose listing."
3423 :type 'string
3424 :group 'dired)
3425
3426 (defun file-expand-wildcards (pattern &optional full)
3427 "Expand wildcard pattern PATTERN.
3428 This returns a list of file names which match the pattern.
3429
3430 If PATTERN is written as an absolute relative file name,
3431 the values are absolute also.
3432
3433 If PATTERN is written as a relative file name, it is interpreted
3434 relative to the current default directory, `default-directory'.
3435 The file names returned are normally also relative to the current
3436 default directory. However, if FULL is non-nil, they are absolute."
3437 (let* ((nondir (file-name-nondirectory pattern))
3438 (dirpart (file-name-directory pattern))
3439 ;; A list of all dirs that DIRPART specifies.
3440 ;; This can be more than one dir
3441 ;; if DIRPART contains wildcards.
3442 (dirs (if (and dirpart (string-match "[[*?]" dirpart))
3443 (mapcar 'file-name-as-directory
3444 (file-expand-wildcards (directory-file-name dirpart)))
3445 (list dirpart)))
3446 contents)
3447 (while dirs
3448 (when (or (null (car dirs)) ; Possible if DIRPART is not wild.
3449 (file-directory-p (directory-file-name (car dirs))))
3450 (let ((this-dir-contents
3451 ;; Filter out "." and ".."
3452 (delq nil
3453 (mapcar #'(lambda (name)
3454 (unless (string-match "\\`\\.\\.?\\'"
3455 (file-name-nondirectory name))
3456 name))
3457 (directory-files (or (car dirs) ".") full
3458 (wildcard-to-regexp nondir))))))
3459 (setq contents
3460 (nconc
3461 (if (and (car dirs) (not full))
3462 (mapcar (function (lambda (name) (concat (car dirs) name)))
3463 this-dir-contents)
3464 this-dir-contents)
3465 contents))))
3466 (setq dirs (cdr dirs)))
3467 contents))
3468
3469 (defun list-directory (dirname &optional verbose)
3470 "Display a list of files in or matching DIRNAME, a la `ls'.
3471 DIRNAME is globbed by the shell if necessary.
3472 Prefix arg (second arg if noninteractive) means supply -l switch to `ls'.
3473 Actions controlled by variables `list-directory-brief-switches'
3474 and `list-directory-verbose-switches'."
3475 (interactive (let ((pfx current-prefix-arg))
3476 (list (read-file-name (if pfx "List directory (verbose): "
3477 "List directory (brief): ")
3478 nil default-directory nil)
3479 pfx)))
3480 (let ((switches (if verbose list-directory-verbose-switches
3481 list-directory-brief-switches)))
3482 (or dirname (setq dirname default-directory))
3483 (setq dirname (expand-file-name dirname))
3484 (with-output-to-temp-buffer "*Directory*"
3485 (buffer-disable-undo standard-output)
3486 (princ "Directory ")
3487 (princ dirname)
3488 (terpri)
3489 (save-excursion
3490 (set-buffer "*Directory*")
3491 (setq default-directory
3492 (if (file-directory-p dirname)
3493 (file-name-as-directory dirname)
3494 (file-name-directory dirname)))
3495 (let ((wildcard (not (file-directory-p dirname))))
3496 (insert-directory dirname switches wildcard (not wildcard)))))))
3497
3498 (defun shell-quote-wildcard-pattern (pattern)
3499 "Quote characters special to the shell in PATTERN, leave wildcards alone.
3500
3501 PATTERN is assumed to represent a file-name wildcard suitable for the
3502 underlying filesystem. For Unix and GNU/Linux, the characters from the
3503 set [ \\t\\n;<>&|()#$] are quoted with a backslash; for DOS/Windows, all
3504 the parts of the pattern which don't include wildcard characters are
3505 quoted with double quotes.
3506 Existing quote characters in PATTERN are left alone, so you can pass
3507 PATTERN that already quotes some of the special characters."
3508 (save-match-data
3509 (cond
3510 ((memq system-type '(ms-dos windows-nt))
3511 ;; DOS/Windows don't allow `"' in file names. So if the
3512 ;; argument has quotes, we can safely assume it is already
3513 ;; quoted by the caller.
3514 (if (or (string-match "[\"]" pattern)
3515 ;; We quote [&()#$'] in case their shell is a port of a
3516 ;; Unixy shell. We quote [,=+] because stock DOS and
3517 ;; Windows shells require that in some cases, such as
3518 ;; passing arguments to batch files that use positional
3519 ;; arguments like %1.
3520 (not (string-match "[ \t;&()#$',=+]" pattern)))
3521 pattern
3522 (let ((result "\"")
3523 (beg 0)
3524 end)
3525 (while (string-match "[*?]+" pattern beg)
3526 (setq end (match-beginning 0)
3527 result (concat result (substring pattern beg end)
3528 "\""
3529 (substring pattern end (match-end 0))
3530 "\"")
3531 beg (match-end 0)))
3532 (concat result (substring pattern beg) "\""))))
3533 (t
3534 (let ((beg 0))
3535 (while (string-match "[ \t\n;<>&|()#$]" pattern beg)
3536 (setq pattern
3537 (concat (substring pattern 0 (match-beginning 0))
3538 "\\"
3539 (substring pattern (match-beginning 0)))
3540 beg (1+ (match-end 0)))))
3541 pattern))))
3542
3543
3544 (defvar insert-directory-program "ls"
3545 "Absolute or relative name of the `ls' program used by `insert-directory'.")
3546
3547 ;; insert-directory
3548 ;; - must insert _exactly_one_line_ describing FILE if WILDCARD and
3549 ;; FULL-DIRECTORY-P is nil.
3550 ;; The single line of output must display FILE's name as it was
3551 ;; given, namely, an absolute path name.
3552 ;; - must insert exactly one line for each file if WILDCARD or
3553 ;; FULL-DIRECTORY-P is t, plus one optional "total" line
3554 ;; before the file lines, plus optional text after the file lines.
3555 ;; Lines are delimited by "\n", so filenames containing "\n" are not
3556 ;; allowed.
3557 ;; File lines should display the basename.
3558 ;; - must be consistent with
3559 ;; - functions dired-move-to-filename, (these two define what a file line is)
3560 ;; dired-move-to-end-of-filename,
3561 ;; dired-between-files, (shortcut for (not (dired-move-to-filename)))
3562 ;; dired-insert-headerline
3563 ;; dired-after-subdir-garbage (defines what a "total" line is)
3564 ;; - variable dired-subdir-regexp
3565 (defun insert-directory (file switches &optional wildcard full-directory-p)
3566 "Insert directory listing for FILE, formatted according to SWITCHES.
3567 Leaves point after the inserted text.
3568 SWITCHES may be a string of options, or a list of strings.
3569 Optional third arg WILDCARD means treat FILE as shell wildcard.
3570 Optional fourth arg FULL-DIRECTORY-P means file is a directory and
3571 switches do not contain `d', so that a full listing is expected.
3572
3573 This works by running a directory listing program
3574 whose name is in the variable `insert-directory-program'.
3575 If WILDCARD, it also runs the shell specified by `shell-file-name'."
3576 ;; We need the directory in order to find the right handler.
3577 (let ((handler (find-file-name-handler (expand-file-name file)
3578 'insert-directory)))
3579 (if handler
3580 (funcall handler 'insert-directory file switches
3581 wildcard full-directory-p)
3582 (if (eq system-type 'vax-vms)
3583 (vms-read-directory file switches (current-buffer))
3584 (let (result available)
3585
3586 ;; Read the actual directory using `insert-directory-program'.
3587 ;; RESULT gets the status code.
3588 (let ((coding-system-for-read
3589 (and enable-multibyte-characters
3590 (or file-name-coding-system
3591 default-file-name-coding-system)))
3592 ;; This is to control encoding the arguments in call-process.
3593 (coding-system-for-write coding-system-for-read))
3594 (setq result
3595 (if wildcard
3596 ;; Run ls in the directory part of the file pattern
3597 ;; using the last component as argument.
3598 (let ((default-directory
3599 (if (file-name-absolute-p file)
3600 (file-name-directory file)
3601 (file-name-directory (expand-file-name file))))
3602 (pattern (file-name-nondirectory file)))
3603 (call-process
3604 shell-file-name nil t nil
3605 "-c"
3606 (concat (if (memq system-type '(ms-dos windows-nt))
3607 ""
3608 "\\") ; Disregard Unix shell aliases!
3609 insert-directory-program
3610 " -d "
3611 (if (stringp switches)
3612 switches
3613 (mapconcat 'identity switches " "))
3614 " -- "
3615 ;; Quote some characters that have
3616 ;; special meanings in shells; but
3617 ;; don't quote the wildcards--we want
3618 ;; them to be special. We also
3619 ;; currently don't quote the quoting
3620 ;; characters in case people want to
3621 ;; use them explicitly to quote
3622 ;; wildcard characters.
3623 (shell-quote-wildcard-pattern pattern))))
3624 ;; SunOS 4.1.3, SVr4 and others need the "." to list the
3625 ;; directory if FILE is a symbolic link.
3626 (apply 'call-process
3627 insert-directory-program nil t nil
3628 (append
3629 (if (listp switches) switches
3630 (unless (equal switches "")
3631 ;; Split the switches at any spaces so we can
3632 ;; pass separate options as separate args.
3633 (split-string switches)))
3634 ;; Avoid lossage if FILE starts with `-'.
3635 '("--")
3636 (progn
3637 (if (string-match "\\`~" file)
3638 (setq file (expand-file-name file)))
3639 (list
3640 (if full-directory-p
3641 (concat (file-name-as-directory file) ".")
3642 file))))))))
3643
3644 ;; If `insert-directory-program' failed, signal an error.
3645 (if (/= result 0)
3646 ;; On non-Posix systems, we cannot open a directory, so
3647 ;; don't even try, because that will always result in
3648 ;; the ubiquitous "Access denied". Instead, show the
3649 ;; command line so the user can try to guess what went wrong.
3650 (if (and (file-directory-p file)
3651 (memq system-type '(ms-dos windows-nt)))
3652 (error
3653 "Reading directory: \"%s %s -- %s\" exited with status %s"
3654 insert-directory-program
3655 (if (listp switches) (concat switches) switches)
3656 file result)
3657 ;; Unix. Access the file to get a suitable error.
3658 (access-file file "Reading directory")
3659 (error "Listing directory failed but `access-file' worked")))
3660
3661 ;; Try to insert the amount of free space.
3662 (save-excursion
3663 (goto-char (point-min))
3664 ;; First find the line to put it on.
3665 (when (re-search-forward "^total" nil t)
3666 ;; Try to find the number of free blocks.
3667 (save-match-data
3668 (with-temp-buffer
3669 (call-process "df" nil t nil ".")
3670 ;; Usual format is a header line
3671 ;; followed by a line of numbers.
3672 (goto-char (point-min))
3673 (forward-line 1)
3674 (if (not (eobp))
3675 (progn
3676 ;; Move to the end of the "available blocks" number.
3677 (skip-chars-forward "^ \t")
3678 (forward-word 3)
3679 ;; Copy it into AVAILABLE.
3680 (let ((end (point)))
3681 (forward-word -1)
3682 (setq available (buffer-substring (point) end)))))))
3683 (when available
3684 ;; Replace "total" with "used", to avoid confusion.
3685 (replace-match "used")
3686 (end-of-line)
3687 (insert " available " available)))))))))
3688
3689 (defun insert-directory-safely (file switches
3690 &optional wildcard full-directory-p)
3691 "Insert directory listing for FILE, formatted according to SWITCHES.
3692
3693 Like `insert-directory', but if FILE does not exist, it inserts a
3694 message to that effect instead of signaling an error."
3695 (if (file-exists-p file)
3696 (insert-directory file switches wildcard full-directory-p)
3697 ;; Simulate the message printed by `ls'.
3698 (insert (format "%s: No such file or directory\n" file))))
3699
3700 (defvar kill-emacs-query-functions nil
3701 "Functions to call with no arguments to query about killing Emacs.
3702 If any of these functions returns nil, killing Emacs is cancelled.
3703 `save-buffers-kill-emacs' (\\[save-buffers-kill-emacs]) calls these functions,
3704 but `kill-emacs', the low level primitive, does not.
3705 See also `kill-emacs-hook'.")
3706
3707 (defcustom confirm-kill-emacs nil
3708 "How to ask for confirmation when leaving Emacs.
3709 If nil, the default, don't ask at all. If the value is non-nil, it should
3710 be a predicate function such as `yes-or-no-p'."
3711 :type '(choice (const :tag "Ask with yes-or-no-p" yes-or-no-p)
3712 (const :tag "Ask with y-or-n-p" y-or-n-p)
3713 (const :tag "Don't confirm" nil))
3714 :group 'emacs
3715 :version "21.1")
3716
3717 (defun save-buffers-kill-emacs (&optional arg)
3718 "Offer to save each buffer, then kill this Emacs process.
3719 With prefix arg, silently save all file-visiting buffers, then kill."
3720 (interactive "P")
3721 (save-some-buffers arg t)
3722 (and (or (not (memq t (mapcar (function
3723 (lambda (buf) (and (buffer-file-name buf)
3724 (buffer-modified-p buf))))
3725 (buffer-list))))
3726 (yes-or-no-p "Modified buffers exist; exit anyway? "))
3727 (or (not (fboundp 'process-list))
3728 ;; process-list is not defined on VMS.
3729 (let ((processes (process-list))
3730 active)
3731 (while processes
3732 (and (memq (process-status (car processes)) '(run stop open))
3733 (let ((val (process-kill-without-query (car processes))))
3734 (process-kill-without-query (car processes) val)
3735 val)
3736 (setq active t))
3737 (setq processes (cdr processes)))
3738 (or (not active)
3739 (list-processes)
3740 (yes-or-no-p "Active processes exist; kill them and exit anyway? "))))
3741 ;; Query the user for other things, perhaps.
3742 (run-hook-with-args-until-failure 'kill-emacs-query-functions)
3743 (or (null confirm-kill-emacs)
3744 (funcall confirm-kill-emacs "Really exit Emacs? "))
3745 (kill-emacs)))
3746 \f
3747 ;; We use /: as a prefix to "quote" a file name
3748 ;; so that magic file name handlers will not apply to it.
3749
3750 (setq file-name-handler-alist
3751 (cons '("\\`/:" . file-name-non-special)
3752 file-name-handler-alist))
3753
3754 ;; We depend on being the last handler on the list,
3755 ;; so that anything else which does need handling
3756 ;; has been handled already.
3757 ;; So it is safe for us to inhibit *all* magic file name handlers.
3758
3759 (defun file-name-non-special (operation &rest arguments)
3760 (let ((file-name-handler-alist nil)
3761 (default-directory
3762 (if (eq operation 'insert-directory)
3763 (directory-file-name
3764 (expand-file-name
3765 (unhandled-file-name-directory default-directory)))
3766 default-directory))
3767 ;; Get a list of the indices of the args which are file names.
3768 (file-arg-indices
3769 (cdr (or (assq operation
3770 ;; The first four are special because they
3771 ;; return a file name. We want to include the /:
3772 ;; in the return value.
3773 ;; So just avoid stripping it in the first place.
3774 '((expand-file-name . nil)
3775 ;; `identity' means just return the first arg
3776 ;; as stripped of its quoting.
3777 (substitute-in-file-name . identity)
3778 (file-name-directory . nil)
3779 (file-name-as-directory . nil)
3780 (directory-file-name . nil)
3781 (file-name-completion 0 1)
3782 (file-name-all-completions 0 1)
3783 (rename-file 0 1)
3784 (copy-file 0 1)
3785 (make-symbolic-link 0 1)
3786 (add-name-to-file 0 1)))
3787 ;; For all other operations, treat the first argument only
3788 ;; as the file name.
3789 '(nil 0))))
3790 ;; Copy ARGUMENTS so we can replace elements in it.
3791 (arguments (copy-sequence arguments)))
3792 ;; Strip off the /: from the file names that have this handler.
3793 (save-match-data
3794 (while (consp file-arg-indices)
3795 (let ((pair (nthcdr (car file-arg-indices) arguments)))
3796 (and (car pair)
3797 (string-match "\\`/:" (car pair))
3798 (setcar pair
3799 (if (= (length (car pair)) 2)
3800 "/"
3801 (substring (car pair) 2)))))
3802 (setq file-arg-indices (cdr file-arg-indices))))
3803 (if (eq file-arg-indices 'identity)
3804 (car arguments)
3805 (apply operation arguments))))
3806 \f
3807 (define-key ctl-x-map "\C-f" 'find-file)
3808 (define-key ctl-x-map "\C-r" 'find-file-read-only)
3809 (define-key ctl-x-map "\C-v" 'find-alternate-file)
3810 (define-key ctl-x-map "\C-s" 'save-buffer)
3811 (define-key ctl-x-map "s" 'save-some-buffers)
3812 (define-key ctl-x-map "\C-w" 'write-file)
3813 (define-key ctl-x-map "i" 'insert-file)
3814 (define-key esc-map "~" 'not-modified)
3815 (define-key ctl-x-map "\C-d" 'list-directory)
3816 (define-key ctl-x-map "\C-c" 'save-buffers-kill-emacs)
3817
3818 (define-key ctl-x-4-map "f" 'find-file-other-window)
3819 (define-key ctl-x-4-map "r" 'find-file-read-only-other-window)
3820 (define-key ctl-x-4-map "\C-f" 'find-file-other-window)
3821 (define-key ctl-x-4-map "b" 'switch-to-buffer-other-window)
3822 (define-key ctl-x-4-map "\C-o" 'display-buffer)
3823
3824 (define-key ctl-x-5-map "b" 'switch-to-buffer-other-frame)
3825 (define-key ctl-x-5-map "f" 'find-file-other-frame)
3826 (define-key ctl-x-5-map "\C-f" 'find-file-other-frame)
3827 (define-key ctl-x-5-map "r" 'find-file-read-only-other-frame)
3828
3829 ;;; files.el ends here