files.el 81.7 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; files.el --- file input and output commands for Emacs

Roland McGrath's avatar
Roland McGrath committed
3
;; Copyright (C) 1985, 86, 87, 92, 93, 94 Free Software Foundation, Inc.
Roland McGrath's avatar
Roland McGrath committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5 6
;; Maintainer: FSF

Roland McGrath's avatar
Roland McGrath committed
7 8 9 10
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
11
;; the Free Software Foundation; either version 2, or (at your option)
Roland McGrath's avatar
Roland McGrath committed
12 13 14 15 16 17 18 19 20 21 22
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

23 24 25 26 27 28
;;; Commentary:

;; Defines most of Emacs's file- and directory-handling functions,
;; including basic file visiting, backup generation, link handling,
;; ITS-id version control, load- and write-hook handling, and the like.

Eric S. Raymond's avatar
Eric S. Raymond committed
29 30
;;; Code:

Roland McGrath's avatar
Roland McGrath committed
31 32 33 34 35 36 37 38 39 40 41
(defconst delete-auto-save-files t
  "*Non-nil means delete a buffer's auto-save file when the buffer is saved.")

(defconst directory-abbrev-alist
  nil
  "*Alist of abbreviations for file directories.
A list of elements of the form (FROM . TO), each meaning to replace
FROM with TO when it appears in a directory name.  This replacement is
done when setting up the default directory of a newly visited file.
*Every* FROM string should start with `^'.

42 43 44
Do not use `~' in the TO strings.
They should be ordinary absolute directory names.

Roland McGrath's avatar
Roland McGrath committed
45 46 47 48 49 50
Use this feature when you have directories which you normally refer to
via absolute symbolic links.  Make TO the name of the link, and FROM
the name it is linked to.")

;;; Turn off backup files on VMS since it has version numbers.
(defconst make-backup-files (not (eq system-type 'vax-vms))
51
  "*Non-nil means make a backup of a file the first time it is saved.
Roland McGrath's avatar
Roland McGrath committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65
This can be done by renaming the file or by copying.

Renaming means that Emacs renames the existing file so that it is a
backup file, then writes the buffer into a new file.  Any other names
that the old file had will now refer to the backup file.  The new file
is owned by you and its group is defaulted.

Copying means that Emacs copies the existing file into the backup
file, then writes the buffer on top of the existing file.  Any other
names that the old file had will now refer to the new (edited) file.
The file's owner and group are unchanged.

The choice of renaming or copying is controlled by the variables
`backup-by-copying', `backup-by-copying-when-linked' and
66
`backup-by-copying-when-mismatch'.  See also `backup-inhibited'.")
Roland McGrath's avatar
Roland McGrath committed
67 68 69 70

;; Do this so that local variables based on the file name
;; are not overridden by the major mode.
(defvar backup-inhibited nil
71 72 73
  "Non-nil means don't make a backup, regardless of the other parameters.
This variable is intended for use by making it local to a buffer.
But it is local only if you make it local.")
Roland McGrath's avatar
Roland McGrath committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
(put 'backup-inhibited 'permanent-local t)

(defconst backup-by-copying nil
 "*Non-nil means always use copying to create backup files.
See documentation of variable `make-backup-files'.")

(defconst backup-by-copying-when-linked nil
 "*Non-nil means use copying to create backups for files with multiple names.
This causes the alternate names to refer to the latest version as edited.
This variable is relevant only if `backup-by-copying' is nil.")

(defconst backup-by-copying-when-mismatch nil
  "*Non-nil means create backups by copying if this preserves owner or group.
Renaming may still be used (subject to control of other variables)
when it would not result in changing the owner or group of the file;
that is, for files which are owned by you and whose group matches
the default for a new file created there by you.
This variable is relevant only if `backup-by-copying' is nil.")

(defvar backup-enable-predicate
  '(lambda (name)
     (or (< (length name) 5)
	 (not (string-equal "/tmp/" (substring name 0 5)))))
  "Predicate that looks at a file name and decides whether to make backups.
Called with an absolute file name as argument, it returns t to enable backup.")

(defconst buffer-offer-save nil
  "*Non-nil in a buffer means offer to save the buffer on exit
even if the buffer is not visiting a file.
Automatically local in all buffers.")
(make-variable-buffer-local 'buffer-offer-save)

106 107 108 109 110 111 112 113 114 115 116
(defconst find-file-existing-other-name nil
  "*Non-nil means find a file under alternative names, in existing buffers.
This means if any existing buffer is visiting the file you want
under another name, you get the existing buffer instead of a new buffer.")

(defconst find-file-visit-truename nil
  "*Non-nil means visit a file under its truename.
The truename of a file is found by chasing all links
both at the file level and at the levels of the containing directories.")

(defvar buffer-file-truename nil
Karl Heuer's avatar
Karl Heuer committed
117 118
  "The abbreviated truename of the file visited in the current buffer.
That is, (abbreviated-file-name (file-truename buffer-file-name)).
119 120 121 122 123 124 125 126 127 128 129 130
This variable is automatically local in all buffers, when non-nil.")
(make-variable-buffer-local 'buffer-file-truename)
(put 'buffer-file-truename 'permanent-local t)

(defvar buffer-file-number nil
  "The device number and file number of the file visited in the current buffer.
The value is a list of the form (FILENUM DEVNUM).
This pair of numbers uniquely identifies the file.
If the buffer is visiting a new file, the value is nil.")
(make-variable-buffer-local 'buffer-file-number)
(put 'buffer-file-number 'permanent-local t)

Roland McGrath's avatar
Roland McGrath committed
131 132 133 134 135 136 137 138
(defconst file-precious-flag nil
  "*Non-nil means protect against I/O errors while saving files.
Some modes set this non-nil in particular buffers.")

(defvar version-control nil
  "*Control use of version numbers for backup files.
t means make numeric backup versions unconditionally.
nil means make them for files that have some already.
139
`never' means do not make them.")
Roland McGrath's avatar
Roland McGrath committed
140 141 142 143 144

(defvar dired-kept-versions 2
  "*When cleaning directory, number of versions to keep.")

(defvar trim-versions-without-asking nil
Eric S. Raymond's avatar
Eric S. Raymond committed
145 146
  "*If t, deletes excess backup versions silently.
If nil, asks confirmation.  Any other value prevents any trimming.")
Roland McGrath's avatar
Roland McGrath committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171

(defvar kept-old-versions 2
  "*Number of oldest versions to keep when a new numbered backup is made.")

(defvar kept-new-versions 2
  "*Number of newest versions to keep when a new numbered backup is made.
Includes the new backup.  Must be > 0")

(defconst require-final-newline nil
  "*Value of t says silently ensure a file ends in a newline when it is saved.
Non-nil but not t says ask user whether to add a newline when there isn't one.
nil means don't add newlines.")

(defconst auto-save-default t
  "*Non-nil says by default do auto-saving of every file-visiting buffer.")

(defconst auto-save-visited-file-name nil
  "*Non-nil says auto-save a buffer in the file it is visiting, when practical.
Normally auto-save files are written under other names.")

(defconst save-abbrevs nil
  "*Non-nil means save word abbrevs too when files are saved.
Loading an abbrev file sets this to t.")

(defconst find-file-run-dired t
172
  "*Non-nil says run dired if `find-file' is given the name of a directory.")
Roland McGrath's avatar
Roland McGrath committed
173

174 175
;;;It is not useful to make this a local variable.
;;;(put 'find-file-not-found-hooks 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
176 177 178 179 180 181
(defvar find-file-not-found-hooks nil
  "List of functions to be called for `find-file' on nonexistent file.
These functions are called as soon as the error is detected.
`buffer-file-name' is already set up.
The functions are called in the order given until one of them returns non-nil.")

182 183
;;;It is not useful to make this a local variable.
;;;(put 'find-file-hooks 'permanent-local t)
Roland McGrath's avatar
Roland McGrath committed
184 185 186 187 188 189 190 191
(defvar find-file-hooks nil
  "List of functions to be called after a buffer is loaded from a file.
The buffer's local variables (if any) will have been processed before the
functions are called.")

(defvar write-file-hooks nil
  "List of functions to be called before writing out a buffer to a file.
If one of them returns non-nil, the file is considered already written
Jim Blandy's avatar
Jim Blandy committed
192 193 194
and the rest are not called.
These hooks are considered to pertain to the visited file.
So this list is cleared if you change the visited file name.
195 196
See also `write-contents-hooks'.
Don't make this variable buffer-local; instead, use `local-write-file-hooks'.")
197 198
;;; However, in case someone does make it local...
(put 'write-file-hooks 'permanent-local t)
199 200 201 202 203

(defvar local-write-file-hooks nil
  "Just like `write-file-hooks', except intended for per-buffer use.
The functions in this list are called before the ones in
`write-file-hooks'.")
204 205
(make-variable-buffer-local 'local-write-file-hooks)
(put 'local-write-file-hooks 'permanent-local t)
Jim Blandy's avatar
Jim Blandy committed
206 207 208 209 210 211 212 213 214

(defvar write-contents-hooks nil
  "List of functions to be called before writing out a buffer to a file.
If one of them returns non-nil, the file is considered already written
and the rest are not called.
These hooks are considered to pertain to the buffer's contents,
not to the particular visited file; thus, `set-visited-file-name' does
not clear this variable, but changing the major mode does clear it.
See also `write-file-hooks'.")
Roland McGrath's avatar
Roland McGrath committed
215 216 217 218 219 220 221 222 223 224

(defconst enable-local-variables t
  "*Control use of local-variables lists in files you visit.
The value can be t, nil or something else.
A value of t means local-variables lists are obeyed;
nil means they are ignored; anything else means query.

The command \\[normal-mode] always obeys local-variables lists
and ignores this variable.")

225
(defconst enable-local-eval 'maybe
226 227 228 229 230 231 232
  "*Control processing of the \"variable\" `eval' in a file's local variables.
The value can be t, nil or something else.
A value of t means obey `eval' variables;
nil means ignore them; anything else means query.

The command \\[normal-mode] always obeys local-variables lists
and ignores this variable.")
Roland McGrath's avatar
Roland McGrath committed
233 234 235

;; Avoid losing in versions where CLASH_DETECTION is disabled.
(or (fboundp 'lock-buffer)
236
    (defalias 'lock-buffer 'ignore))
Roland McGrath's avatar
Roland McGrath committed
237
(or (fboundp 'unlock-buffer)
238
    (defalias 'unlock-buffer 'ignore))
239 240 241 242 243 244 245 246

;; This hook function provides support for ange-ftp host name
;; completion.  It runs the usual ange-ftp hook, but only for
;; completion operations.  Having this here avoids the need
;; to load ange-ftp when it's not really in use.
(defun ange-ftp-completion-hook-function (op &rest args)
  (if (memq op '(file-name-completion file-name-all-completions))
      (apply 'ange-ftp-hook-function op args)
247 248 249 250 251
    (let ((inhibit-file-name-handlers
	   (cons 'ange-ftp-completion-hook-function
		 (and (eq inhibit-file-name-operation op)
		      inhibit-file-name-handlers)))
	  (inhibit-file-name-operation op))
252
      (apply op args))))
Roland McGrath's avatar
Roland McGrath committed
253 254 255 256 257 258

(defun pwd ()
  "Show the current default directory."
  (interactive nil)
  (message "Directory %s" default-directory))

259 260 261 262 263 264 265 266 267 268 269
(defvar cd-path nil
  "Value of the CDPATH environment variable, as a list.
Not actually set up until the first time you you use it.")

(defun parse-colon-path (cd-path)
  "Explode a colon-separated list of paths into a string list."
  (and cd-path
       (let (cd-prefix cd-list (cd-start 0) cd-colon)
	 (setq cd-path (concat cd-path ":"))
	 (while (setq cd-colon (string-match ":" cd-path cd-start))
	   (setq cd-list
270
		 (nconc cd-list
271 272 273
			(list (if (= cd-start cd-colon)
				   nil
				(substitute-in-file-name
274 275
				 (file-name-as-directory
				  (substring cd-path cd-start cd-colon)))))))
276 277 278 279
	   (setq cd-start (+ cd-colon 1)))
	 cd-list)))

(defun cd-absolute (dir)
280
  "Change current directory to given absolute file name DIR."
281
  (setq dir (abbreviate-file-name (expand-file-name dir)))
Roland McGrath's avatar
Roland McGrath committed
282 283 284 285 286 287
  (if (not (eq system-type 'vax-vms))
      (setq dir (file-name-as-directory dir)))
  (if (not (file-directory-p dir))
      (error "%s is not a directory" dir)
    (if (file-executable-p dir)
	(setq default-directory dir)
288
      (error "Cannot cd to %s:  Permission denied" dir))))
Roland McGrath's avatar
Roland McGrath committed
289

290 291
(defun cd (dir)
  "Make DIR become the current buffer's default directory.
292 293
If your environment includes a `CDPATH' variable, try each one of that
colon-separated list of directories when resolving a relative directory name."
294
  (interactive "FChange default directory: ")
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
  (if (file-name-absolute-p dir)
      (cd-absolute (expand-file-name dir))
    (if (null cd-path)
	(let ((trypath (parse-colon-path (getenv "CDPATH"))))
	  (setq cd-path (or trypath (list "./")))))
    (if (not (catch 'found
	       (mapcar
		(function (lambda (x)
			    (let ((f (expand-file-name (concat x dir))))
			      (if (file-directory-p f)
				  (progn
				    (cd-absolute f)
				    (throw 'found t))))))
		cd-path)
	       nil))
	(error "No such directory found via CDPATH environment variable"))))
311

Roland McGrath's avatar
Roland McGrath committed
312 313 314 315 316 317 318 319 320 321
(defun load-file (file)
  "Load the Lisp file named FILE."
  (interactive "fLoad file: ")
  (load (expand-file-name file) nil nil t))

(defun load-library (library)
  "Load the library named LIBRARY.
This is an interface to the function `load'."
  (interactive "sLoad library: ")
  (load library))
322

Karl Heuer's avatar
Karl Heuer committed
323
(defun file-local-copy (file &optional buffer)
324 325 326
  "Copy the file FILE into a temporary file on this machine.
Returns the name of the local copy, or nil, if FILE is directly
accessible."
327
  (let ((handler (find-file-name-handler file 'file-local-copy)))
328 329 330
    (if handler
	(funcall handler 'file-local-copy file)
      nil)))
331 332 333 334 335 336

(defun file-truename (filename)
  "Return the truename of FILENAME, which should be absolute.
The truename of a file name is found by chasing symbolic links
both at the level of the file and at the level of the directories
containing it, until no links are left at any level."
337 338 339
  (if (or (string= filename "~")
	  (and (string= (substring filename 0 1) "~")
	       (string-match "~[^/]*" filename)))
340 341 342 343
      (progn
	(setq filename (expand-file-name filename))
	(if (string= filename "")
	    (setq filename "/"))))
344
  (let ((handler (find-file-name-handler filename 'file-truename)))
345 346 347 348 349 350 351 352 353 354 355
    ;; For file name that has a special handler, call handler.
    ;; This is so that ange-ftp can save time by doing a no-op.
    (if handler
	(funcall handler 'file-truename filename)
      (let ((dir (file-name-directory filename))
	    target dirfile)
	;; Get the truename of the directory.
	(setq dirfile (directory-file-name dir))
	;; If these are equal, we have the (or a) root directory.
	(or (string= dir dirfile)
	    (setq dir (file-name-as-directory (file-truename dirfile))))
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
	(if (equal ".." (file-name-nondirectory filename))
	    (directory-file-name (file-name-directory (directory-file-name dir)))
	  (if (equal "." (file-name-nondirectory filename))
	      (directory-file-name dir)
	    ;; Put it back on the file name.
	    (setq filename (concat dir (file-name-nondirectory filename)))
	    ;; Is the file name the name of a link?
	    (setq target (file-symlink-p filename))
	    (if target
		;; Yes => chase that link, then start all over
		;; since the link may point to a directory name that uses links.
		;; We can't safely use expand-file-name here
		;; since target might look like foo/../bar where foo
		;; is itself a link.  Instead, we handle . and .. above.
		(if (file-name-absolute-p target)
		    (file-truename target)
		  (file-truename (concat dir target)))
	      ;; No, we are done!
	      filename)))))))
375

376 377 378 379 380 381 382 383
(defun file-chase-links (filename)
  "Chase links in FILENAME until a name that is not a link.
Does not examine containing directories for links,
unlike `file-truename'."
  (let (tem (count 100) (newname filename))
    (while (setq tem (file-symlink-p newname))
      (if (= count 0)
	  (error "Apparent cycle of symbolic links for %s" filename))
384 385 386 387 388 389 390 391 392 393 394 395 396 397
      ;; Handle `..' by hand, since it needs to work in the
      ;; target of any directory symlink.
      ;; This code is not quite complete; it does not handle
      ;; embedded .. in some cases such as ./../foo and foo/bar/../../../lose.
      (while (string-match "\\.\\./" tem)
	(setq tem (substring tem 3))
	(setq newname (file-name-as-directory
		       ;; Do the .. by hand.
		       (directory-file-name
			(file-name-directory
			 ;; Chase links in the default dir of the symlink.
			 (file-chase-links
			  (directory-file-name
			   (file-name-directory newname))))))))
398 399 400
      (setq newname (expand-file-name tem (file-name-directory newname)))
      (setq count (1- count)))
    newname))
Roland McGrath's avatar
Roland McGrath committed
401 402 403 404 405 406 407

(defun switch-to-buffer-other-window (buffer)
  "Select buffer BUFFER in another window."
  (interactive "BSwitch to buffer in other window: ")
  (let ((pop-up-windows t))
    (pop-to-buffer buffer t)))

Jim Blandy's avatar
Jim Blandy committed
408 409 410 411
(defun switch-to-buffer-other-frame (buffer)
  "Switch to buffer BUFFER in another frame."
  (interactive "BSwitch to buffer in other frame: ")
  (let ((pop-up-frames t))
412
    (pop-to-buffer buffer t)))
Jim Blandy's avatar
Jim Blandy committed
413

Roland McGrath's avatar
Roland McGrath committed
414 415 416 417 418 419 420 421 422 423 424 425 426 427
(defun find-file (filename)
  "Edit file FILENAME.
Switch to a buffer visiting file FILENAME,
creating one if none already exists."
  (interactive "FFind file: ")
  (switch-to-buffer (find-file-noselect filename)))

(defun find-file-other-window (filename)
  "Edit file FILENAME, in another window.
May create a new window, or reuse an existing one.
See the function `display-buffer'."
  (interactive "FFind file in other window: ")
  (switch-to-buffer-other-window (find-file-noselect filename)))

Jim Blandy's avatar
Jim Blandy committed
428 429 430
(defun find-file-other-frame (filename)
  "Edit file FILENAME, in another frame.
May create a new frame, or reuse an existing one.
Jim Blandy's avatar
Jim Blandy committed
431
See the function `display-buffer'."
Jim Blandy's avatar
Jim Blandy committed
432 433
  (interactive "FFind file in other frame: ")
  (switch-to-buffer-other-frame (find-file-noselect filename)))
Jim Blandy's avatar
Jim Blandy committed
434

Roland McGrath's avatar
Roland McGrath committed
435 436 437 438 439 440
(defun find-file-read-only (filename)
  "Edit file FILENAME but don't allow changes.
Like \\[find-file] but marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
  (interactive "fFind file read-only: ")
  (find-file filename)
441 442
  (setq buffer-read-only t)
  (current-buffer))
Roland McGrath's avatar
Roland McGrath committed
443 444 445 446 447 448

(defun find-file-read-only-other-window (filename)
  "Edit file FILENAME in another window but don't allow changes.
Like \\[find-file-other-window] but marks buffer as read-only.
Use \\[toggle-read-only] to permit editing."
  (interactive "fFind file read-only other window: ")
449
  (find-file-other-window filename)
450 451
  (setq buffer-read-only t)
  (current-buffer))
Roland McGrath's avatar
Roland McGrath committed
452

Jim Blandy's avatar
Jim Blandy committed
453 454 455
(defun find-file-read-only-other-frame (filename)
  "Edit file FILENAME in another frame but don't allow changes.
Like \\[find-file-other-frame] but marks buffer as read-only.
Jim Blandy's avatar
Jim Blandy committed
456
Use \\[toggle-read-only] to permit editing."
Jim Blandy's avatar
Jim Blandy committed
457 458
  (interactive "fFind file read-only other frame: ")
  (find-file-other-frame filename)
459 460
  (setq buffer-read-only t)
  (current-buffer))
Jim Blandy's avatar
Jim Blandy committed
461

Roland McGrath's avatar
Roland McGrath committed
462 463 464 465 466 467 468 469 470 471 472
(defun find-alternate-file (filename)
  "Find file FILENAME, select its buffer, kill previous buffer.
If the current buffer now contains an empty file that you just visited
\(presumably by mistake), use this command to visit the file you really want."
  (interactive
   (let ((file buffer-file-name)
	 (file-name nil)
	 (file-dir nil))
     (and file
	  (setq file-name (file-name-nondirectory file)
		file-dir (file-name-directory file)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
473 474
     (list (read-file-name
	    "Find alternate file: " file-dir nil nil file-name))))
Roland McGrath's avatar
Roland McGrath committed
475 476 477 478 479 480 481
  (and (buffer-modified-p)
       ;; (not buffer-read-only)
       (not (yes-or-no-p (format "Buffer %s is modified; kill anyway? "
				 (buffer-name))))
       (error "Aborted"))
  (let ((obuf (current-buffer))
	(ofile buffer-file-name)
482 483
	(onum buffer-file-number)
	(otrue buffer-file-truename)
Roland McGrath's avatar
Roland McGrath committed
484 485 486
	(oname (buffer-name)))
    (rename-buffer " **lose**")
    (setq buffer-file-name nil)
487 488
    (setq buffer-file-number nil)
    (setq buffer-file-truename nil)
Roland McGrath's avatar
Roland McGrath committed
489 490 491 492 493 494
    (unwind-protect
	(progn
	  (unlock-buffer)
	  (find-file filename))
      (cond ((eq obuf (current-buffer))
	     (setq buffer-file-name ofile)
495 496
	     (setq buffer-file-number onum)
	     (setq buffer-file-truename otrue)
Roland McGrath's avatar
Roland McGrath committed
497 498 499 500 501 502 503 504 505 506 507 508 509 510
	     (lock-buffer)
	     (rename-buffer oname))))
    (or (eq (current-buffer) obuf)
	(kill-buffer obuf))))

(defun create-file-buffer (filename)
  "Create a suitably named buffer for visiting FILENAME, and return it.
FILENAME (sans directory) is used unchanged if that name is free;
otherwise a string <2> or <3> or ... is appended to get an unused name."
  (let ((lastname (file-name-nondirectory filename)))
    (if (string= lastname "")
	(setq lastname filename))
    (generate-new-buffer lastname)))

Jim Blandy's avatar
Jim Blandy committed
511 512
(defun generate-new-buffer (name)
  "Create and return a buffer with a name based on NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
513
Choose the buffer's name using `generate-new-buffer-name'."
Jim Blandy's avatar
Jim Blandy committed
514 515
  (get-buffer-create (generate-new-buffer-name name)))

Jim Blandy's avatar
Jim Blandy committed
516 517 518
(defconst automount-dir-prefix "^/tmp_mnt/"
  "Regexp to match the automounter prefix in a directory name.")

519
(defvar abbreviated-home-dir nil
520
  "The user's homedir abbreviated according to `directory-abbrev-list'.")
521

Jim Blandy's avatar
Jim Blandy committed
522
(defun abbreviate-file-name (filename)
Richard M. Stallman's avatar
Richard M. Stallman committed
523
  "Return a version of FILENAME shortened using `directory-abbrev-alist'.
Jim Blandy's avatar
Jim Blandy committed
524
This also substitutes \"~\" for the user's home directory.
Richard M. Stallman's avatar
Richard M. Stallman committed
525
Type \\[describe-variable] directory-abbrev-alist RET for more information."
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530
  ;; Get rid of the prefixes added by the automounter.
  (if (and (string-match automount-dir-prefix filename)
	   (file-exists-p (file-name-directory
			   (substring filename (1- (match-end 0))))))
      (setq filename (substring filename (1- (match-end 0)))))
Jim Blandy's avatar
Jim Blandy committed
531
  (let ((tail directory-abbrev-alist))
532 533
    ;; If any elt of directory-abbrev-alist matches this name,
    ;; abbreviate accordingly.
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538
    (while tail
      (if (string-match (car (car tail)) filename)
	  (setq filename
		(concat (cdr (car tail)) (substring filename (match-end 0)))))
      (setq tail (cdr tail)))
539 540 541
    ;; Compute and save the abbreviated homedir name.
    ;; We defer computing this until the first time it's needed, to
    ;; give time for directory-abbrev-alist to be set properly.
542 543
    ;; We include a slash at the end, to avoid spurious matches
    ;; such as `/usr/foobar' when the home dir is `/usr/foo'.
544 545 546
    (or abbreviated-home-dir
	(setq abbreviated-home-dir
	      (let ((abbreviated-home-dir "$foo"))
547 548 549
		(concat "^" (abbreviate-file-name (expand-file-name "~"))
			"\\(/\\|$\\)"))))
						  
550 551
    ;; If FILENAME starts with the abbreviated homedir,
    ;; make it start with `~' instead.
552 553 554 555
    (if (and (string-match abbreviated-home-dir filename)
	     ;; If the home dir is just /, don't change it.
	     (not (and (= (match-end 0) 1)
		       (= (aref filename 0) ?/))))
Jim Blandy's avatar
Jim Blandy committed
556
	(setq filename
557 558 559 560 561 562 563 564 565 566 567
	      (concat "~"
		      ;; If abbreviated-home-dir ends with a slash,
		      ;; don't remove the corresponding slash from
		      ;; filename.  On MS-DOS and OS/2, you can have
		      ;; home directories like "g:/", in which it is
		      ;; important not to remove the slash.  And what
		      ;; about poor root on Unix systems?
		      (if (eq ?/ (aref abbreviated-home-dir
				       (1- (length abbreviated-home-dir))))
			  "/"
			"")
568
		      (substring filename (match-beginning 1) (match-end 1))
569
		      (substring filename (match-end 0)))))
Jim Blandy's avatar
Jim Blandy committed
570 571
    filename))

572 573 574 575 576 577 578
(defvar find-file-not-true-dirname-list nil
  "*List of logical names for which visiting shouldn't save the true dirname.
On VMS, when you visit a file using a logical name that searches a path,
you may or may not want the visited file name to record the specific
directory where the file was found.  If you *do not* want that, add the logical
name to this list as a string.")

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
(defun find-buffer-visiting (filename)
  "Return the buffer visiting file FILENAME (a string).
This is like `get-file-buffer', except that it checks for any buffer
visiting the same file, possibly under a different name.
If there is no such live buffer, return nil."
  (let ((buf (get-file-buffer filename))
	(truename (abbreviate-file-name (file-truename filename))))
    (or buf
	(let ((list (buffer-list)) found)
	  (while (and (not found) list)
	    (save-excursion
	      (set-buffer (car list))
	      (if (and buffer-file-name
		       (string= buffer-file-truename truename))
		  (setq found (car list))))
	    (setq list (cdr list)))
	  found)
596
	(let ((number (nthcdr 10 (file-attributes truename)))
597
	      (list (buffer-list)) found)
598 599 600 601
	  (and number
	       (while (and (not found) list)
		 (save-excursion
		   (set-buffer (car list))
602 603
		   (if (and buffer-file-name
			    (equal buffer-file-number number)
604 605 606 607 608 609 610
			    ;; Verify this buffer's file number
			    ;; still belongs to its file.
			    (file-exists-p buffer-file-name)
			    (equal (nthcdr 10 (file-attributes buffer-file-name))
				   number))
		       (setq found (car list))))
		 (setq list (cdr list))))
611 612
	  found))))

Roland McGrath's avatar
Roland McGrath committed
613 614 615 616 617
(defun find-file-noselect (filename &optional nowarn)
  "Read file FILENAME into a buffer and return the buffer.
If a buffer exists visiting FILENAME, return that one, but
verify that the file has not changed since visited or saved.
The buffer is not selected, just returned to the caller."
Jim Blandy's avatar
Jim Blandy committed
618 619 620
  (setq filename
	(abbreviate-file-name
	 (expand-file-name filename)))
Roland McGrath's avatar
Roland McGrath committed
621 622 623 624
  (if (file-directory-p filename)
      (if find-file-run-dired
	  (dired-noselect filename)
	(error "%s is a directory." filename))
625 626 627 628
    (let* ((buf (get-file-buffer filename))
	   (truename (abbreviate-file-name (file-truename filename)))
	   (number (nthcdr 10 (file-attributes truename)))
	   ;; Find any buffer for a file which has same truename.
629
	   (other (and (not buf) (find-buffer-visiting filename)))
630 631
	   error)
      ;; Let user know if there is a buffer with the same truename.
632 633 634 635 636 637 638
      (if other
	  (progn
	    (or nowarn (message "%s and %s are the same file"
				filename (buffer-file-name other)))
	    ;; Optionally also find that buffer.
	    (if (or find-file-existing-other-name find-file-visit-truename)
		(setq buf other))))
Roland McGrath's avatar
Roland McGrath committed
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
      (if buf
	  (or nowarn
	      (verify-visited-file-modtime buf)
	      (cond ((not (file-exists-p filename))
		     (error "File %s no longer exists!" filename))
		    ((yes-or-no-p
		      (format
		       (if (buffer-modified-p buf)
    "File %s changed on disk.  Discard your edits? "
    "File %s changed on disk.  Read the new version? ")
		       (file-name-nondirectory filename)))
		     (save-excursion
		       (set-buffer buf)
		       (revert-buffer t t)))))
	(save-excursion
654 655 656 657 658 659 660
;;; The truename stuff makes this obsolete.
;;;	  (let* ((link-name (car (file-attributes filename)))
;;;		 (linked-buf (and (stringp link-name)
;;;				  (get-file-buffer link-name))))
;;;	    (if (bufferp linked-buf)
;;;		(message "Symbolic link to file in buffer %s"
;;;			 (buffer-name linked-buf))))
Roland McGrath's avatar
Roland McGrath committed
661 662 663 664 665 666 667 668 669 670
	  (setq buf (create-file-buffer filename))
	  (set-buffer buf)
	  (erase-buffer)
	  (condition-case ()
	      (insert-file-contents filename t)
	    (file-error
	     (setq error t)
	     ;; Run find-file-not-found-hooks until one returns non-nil.
	     (let ((hooks find-file-not-found-hooks))
	       (while (and hooks
671 672 673 674 675
			   (not (and (funcall (car hooks))
				     ;; If a hook succeeded, clear error.
				     (progn (setq error nil)
					    ;; Also exit the loop.
					    t))))
Roland McGrath's avatar
Roland McGrath committed
676
		 (setq hooks (cdr hooks))))))
677
	  ;; Find the file's truename, and maybe use that as visited name.
678
	  (setq buffer-file-truename truename)
679 680 681 682 683 684 685 686 687 688
	  (setq buffer-file-number number)
	  ;; On VMS, we may want to remember which directory in a search list
	  ;; the file was found in.
	  (and (eq system-type 'vax-vms)
	       (let (logical)
		 (if (string-match ":" (file-name-directory filename))
		     (setq logical (substring (file-name-directory filename)
					      0 (match-beginning 0))))
		 (not (member logical find-file-not-true-dirname-list)))
	       (setq buffer-file-name buffer-file-truename))
689
	  (if find-file-visit-truename
690 691 692
	      (setq buffer-file-name
		    (setq filename
			  (expand-file-name buffer-file-truename))))
Roland McGrath's avatar
Roland McGrath committed
693 694 695 696 697 698 699 700 701 702 703
	  ;; Set buffer's default directory to that of the file.
	  (setq default-directory (file-name-directory filename))
	  ;; Turn off backup files for certain file names.  Since
	  ;; this is a permanent local, the major mode won't eliminate it.
	  (and (not (funcall backup-enable-predicate buffer-file-name))
	       (progn
		 (make-local-variable 'backup-inhibited)
		 (setq backup-inhibited t)))
	  (after-find-file error (not nowarn))))
      buf)))

704
(defun after-find-file (&optional error warn noauto)
Roland McGrath's avatar
Roland McGrath committed
705 706
  "Called after finding a file and by the default revert function.
Sets buffer mode, parses local variables.
707
Optional args ERROR, WARN, and NOAUTO: ERROR non-nil means there was an
Roland McGrath's avatar
Roland McGrath committed
708 709
error in reading the file.  WARN non-nil means warn if there
exists an auto-save file more recent than the visited file.
710
NOAUTO means don't mess with auto-save mode.
Roland McGrath's avatar
Roland McGrath committed
711 712 713 714 715 716 717 718
Finishes by calling the functions in `find-file-hooks'."
  (setq buffer-read-only (not (file-writable-p buffer-file-name)))
  (if noninteractive
      nil
    (let* (not-serious
	   (msg
	    (cond ((and error (file-attributes buffer-file-name))
		   (setq buffer-read-only t)
719
		   "File exists, but cannot be read.")
Roland McGrath's avatar
Roland McGrath committed
720 721 722 723 724 725 726 727 728 729 730 731
		  ((not buffer-read-only)
		   (if (and warn
			    (file-newer-than-file-p (make-auto-save-file-name)
						    buffer-file-name))
		       "Auto save file is newer; consider M-x recover-file"
		     (setq not-serious t)
		     (if error "(New file)" nil)))
		  ((not error)
		   (setq not-serious t)
		   "Note: file is write protected")
		  ((file-attributes (directory-file-name default-directory))
		   "File not found and directory write-protected")
732 733
		  ((file-exists-p (file-name-directory buffer-file-name))
		   (setq buffer-read-only nil))
Roland McGrath's avatar
Roland McGrath committed
734
		  (t
Jim Blandy's avatar
Jim Blandy committed
735
		   (setq buffer-read-only nil)
736 737 738
		   (if (file-exists-p (file-name-directory (directory-file-name (file-name-directory buffer-file-name))))
		       "Use M-x make-dir RET RET to create the directory"
		     "Use C-u M-x make-dir RET RET to create directory and its parents")))))
Roland McGrath's avatar
Roland McGrath committed
739 740 741 742
      (if msg
	  (progn
	    (message msg)
	    (or not-serious (sit-for 1 nil t)))))
743
    (if (and auto-save-default (not noauto))
Roland McGrath's avatar
Roland McGrath committed
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
	(auto-save-mode t)))
  (normal-mode t)
  (mapcar 'funcall find-file-hooks))

(defun normal-mode (&optional find-file)
  "Choose the major mode for this buffer automatically.
Also sets up any specified local variables of the file.
Uses the visited file name, the -*- line, and the local variables spec.

This function is called automatically from `find-file'.  In that case,
we may set up specified local variables depending on the value of
`enable-local-variables': if it is t, we do; if it is nil, we don't;
otherwise, we query.  `enable-local-variables' is ignored if you
run `normal-mode' explicitly."
  (interactive)
  (or find-file (funcall (or default-major-mode 'fundamental-mode)))
  (condition-case err
      (set-auto-mode)
    (error (message "File mode specification error: %s"
		    (prin1-to-string err))))
  (condition-case err
Jim Blandy's avatar
Jim Blandy committed
765 766 767
      (let ((enable-local-variables (or (not find-file)
					enable-local-variables)))
	(hack-local-variables))
Roland McGrath's avatar
Roland McGrath committed
768 769 770
    (error (message "File local-variables error: %s"
		    (prin1-to-string err)))))

Jim Blandy's avatar
Jim Blandy committed
771 772 773 774 775 776 777 778 779
(defvar auto-mode-alist (mapcar 'purecopy
				'(("\\.text\\'" . text-mode)
				  ("\\.c\\'" . c-mode)
				  ("\\.h\\'" . c-mode)
				  ("\\.tex\\'" . TeX-mode)
				  ("\\.ltx\\'" . LaTeX-mode)
				  ("\\.el\\'" . emacs-lisp-mode)
				  ("\\.mm\\'" . nroff-mode)
				  ("\\.me\\'" . nroff-mode)
780 781
				  ("\\.ms\\'" . nroff-mode)
				  ("\\.man\\'" . nroff-mode)
Jim Blandy's avatar
Jim Blandy committed
782 783 784 785 786
				  ("\\.scm\\'" . scheme-mode)
				  ("\\.l\\'" . lisp-mode)
				  ("\\.lisp\\'" . lisp-mode)
				  ("\\.f\\'" . fortran-mode)
				  ("\\.for\\'" . fortran-mode)
787 788
				  ("\\.p\\'" . pascal-mode)
				  ("\\.pas\\'" . pascal-mode)
Jim Blandy's avatar
Jim Blandy committed
789 790 791
				  ("\\.mss\\'" . scribe-mode)
				  ("\\.pl\\'" . prolog-mode)
				  ("\\.cc\\'" . c++-mode)
792
				  ("\\.hh\\'" . c++-mode)
Jim Blandy's avatar
Jim Blandy committed
793
				  ("\\.C\\'" . c++-mode)
794
				  ("\\.H\\'" . c++-mode)
795 796
;;;				  ("\\.mk\\'" . makefile-mode)
;;;				  ("[Mm]akefile" . makefile-mode)
Jim Blandy's avatar
Jim Blandy committed
797 798
;;; Less common extensions come here
;;; so more common ones above are found faster.
799 800
				  ("\\.texinfo\\'" . texinfo-mode)
				  ("\\.texi\\'" . texinfo-mode)
Jim Blandy's avatar
Jim Blandy committed
801 802
				  ("\\.s\\'" . asm-mode)
				  ("ChangeLog\\'" . change-log-mode)
803
				  ("change.log\\'" . change-log-mode)
804
				  ("changelo\\'" . change-log-mode)
805
				  ("ChangeLog.[0-9]+\\'" . change-log-mode)
Jim Blandy's avatar
Jim Blandy committed
806
				  ("\\$CHANGE_LOG\\$\\.TXT" . change-log-mode)
807 808 809
;; The following should come after the ChangeLog pattern
;; for the sake of ChangeLog.1, etc.
				  ("\\.[12345678]\\'" . nroff-mode)
Jim Blandy's avatar
Jim Blandy committed
810 811 812 813 814 815
				  ("\\.TeX\\'" . TeX-mode)
				  ("\\.sty\\'" . LaTeX-mode)
				  ("\\.bbl\\'" . LaTeX-mode)
				  ("\\.bib\\'" . bibtex-mode)
				  ("\\.article\\'" . text-mode)
				  ("\\.letter\\'" . text-mode)
816
				  ("\\.tcl\\'" . tcl-mode)
Jim Blandy's avatar
Jim Blandy committed
817 818 819
				  ("\\.lsp\\'" . lisp-mode)
				  ("\\.awk\\'" . awk-mode)
				  ("\\.prolog\\'" . prolog-mode)
820
				  ("\\.tar\\'" . tar-mode)
Jim Blandy's avatar
Jim Blandy committed
821 822 823 824 825 826 827
				  ;; Mailer puts message to be edited in
				  ;; /tmp/Re.... or Message
				  ("^/tmp/Re" . text-mode)
				  ("/Message[0-9]*\\'" . text-mode)
				  ;; some news reader is reported to use this
				  ("^/tmp/fol/" . text-mode)
				  ("\\.y\\'" . c-mode)
828
				  ("\\.lex\\'" . c-mode)
Jim Blandy's avatar
Jim Blandy committed
829 830
				  ("\\.oak\\'" . scheme-mode)
				  ("\\.scm.[0-9]*\\'" . scheme-mode)
831 832 833
				  ("\\.sgm\\'" . sgml-mode)
				  ("\\.sgml\\'" . sgml-mode)
				  ("\\.dtd\\'" . sgml-mode)
Jim Blandy's avatar
Jim Blandy committed
834 835 836
				  ;; .emacs following a directory delimiter
				  ;; in either Unix or VMS syntax.
				  ("[]>:/]\\..*emacs\\'" . emacs-lisp-mode)
837 838 839
				  ;; _emacs following a directory delimiter
				  ;; in MsDos syntax
				  ("[:/]_emacs\\'" . emacs-lisp-mode)
Jim Blandy's avatar
Jim Blandy committed
840 841 842
				  ("\\.ml\\'" . lisp-mode)))
  "\
Alist of filename patterns vs corresponding major mode functions.
843 844 845 846 847
Each element looks like (REGEXP . FUNCTION) or (REGEXP FUNCTION).
Visiting a file whose name matches REGEXP causes FUNCTION to be called.
If the element has the form (REGEXP FUNCTION), then after calling
FUNCTION, we delete the suffix that matched REGEXP and search the list
again for another match.")
Jim Blandy's avatar
Jim Blandy committed
848

849 850 851 852 853 854
(defconst interpreter-mode-alist
  '(("perl" . perl-mode)
    ("scope" . tcl-mode)
    ("wish" . tcl-mode)
    ("shell" . tcl-mode)
    ("form" . tcl-mode)
855 856 857 858
    ("tcl" . tcl-mode)
    ("awk" . awk-mode)
    ("gawk" . awk-mode)
    ("scm" . scheme-mode))
859 860 861 862 863 864 865
  "Alist mapping interpreter names to major modes.
This alist applies to files whose first line starts with `#!'.
Each element looks like (INTERPRETER . MODE).
The car of each element is compared with
the name of the interpreter specified in the first line.
If it matches, mode MODE is selected.")

866 867
(defconst inhibit-first-line-modes-regexps '("\\.tar$")
  "List of regexps; if one matches a file name, don't look for `-*-'.")
868

869 870 871 872
(defvar user-init-file
  "" ; set by command-line
  "File name including directory of user's initialization file.")

Roland McGrath's avatar
Roland McGrath committed
873 874
(defun set-auto-mode ()
  "Select major mode appropriate for current buffer.
Jim Blandy's avatar
Jim Blandy committed
875
This checks for a -*- mode tag in the buffer's text, or
876
compares the filename against the entries in `auto-mode-alist'.  It does
Jim Blandy's avatar
Jim Blandy committed
877 878 879
not check for the \"mode:\" local variable in the Local Variables
section of the file; for that, use `hack-local-variables'.

880
If `enable-local-variables' is nil, this function does not check for a
Jim Blandy's avatar
Jim Blandy committed
881
-*- mode tag."
Roland McGrath's avatar
Roland McGrath committed
882
  ;; Look for -*-MODENAME-*- or -*- ... mode: MODENAME; ... -*-
883
  (let (beg end done)
Roland McGrath's avatar
Roland McGrath committed
884 885 886
    (save-excursion
      (goto-char (point-min))
      (skip-chars-forward " \t\n")
887 888
      (and enable-local-variables
	   ;; Don't look for -*- if this file name matches any
889 890
	   ;; of the regexps in inhibit-first-line-modes-regexps.
	   (let ((temp inhibit-first-line-modes-regexps))
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
	     (while (and temp
			 (not (string-match (car temp)
					    buffer-file-name)))
	       (setq temp (cdr temp)))
	     (not temp))
	   (search-forward "-*-" (save-excursion
				   ;; If the file begins with "#!"
				   ;; (exec interpreter magic), look
				   ;; for mode frobs in the first two
				   ;; lines.  You cannot necessarily
				   ;; put them in the first line of
				   ;; such a file without screwing up
				   ;; the interpreter invocation.
				   (end-of-line (and (looking-at "^#!") 2))
				   (point)) t)
	   (progn
	     (skip-chars-forward " \t")
	     (setq beg (point))
	     (search-forward "-*-"
			     (save-excursion (end-of-line) (point))
			     t))
	   (progn
	     (forward-char -3)
	     (skip-chars-backward " \t")
	     (setq end (point))
	     (goto-char beg)
	     (if (save-excursion (search-forward ":" end t))
		 ;; Find all specifications for the `mode:' variable
Karl Heuer's avatar
Karl Heuer committed
919
		 ;; and execute them left to right.
920 921 922 923 924 925 926 927 928 929 930 931 932 933
		 (while (let ((case-fold-search t))
			  (search-forward "mode:" end t))
		   (skip-chars-forward " \t")
		   (setq beg (point))
		   (if (search-forward ";" end t)
		       (forward-char -1)
		     (goto-char end))
		   (skip-chars-backward " \t")
		   (funcall (intern (concat (downcase (buffer-substring beg (point))) "-mode"))))
	       ;; Simple -*-MODE-*- case.
	       (funcall (intern (concat (downcase (buffer-substring beg end)) "-mode"))))
	     (setq done t)))
      ;; If we didn't find a mode from a -*- line, try using the file name.
      (if (and (not done) buffer-file-name)
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
	  (let ((name buffer-file-name)
		(case-fold-search (eq system-type 'vax-vms))
		(keep-going t))
	    ;; Remove backup-suffixes from file name.
	    (setq name (file-name-sans-versions name))
	    (while keep-going
	      (setq keep-going nil)
	      (let ((alist auto-mode-alist)
		    (mode nil))
		;; Find first matching alist entry.
		(while (and (not mode) alist)
		  (if (string-match (car (car alist)) name)
		      (if (and (consp (cdr (car alist)))
			       (nth 2 (car alist)))
			  (progn
			    (setq mode (car (cdr (car alist)))
				  name (substring name 0 (match-beginning 0))
				  keep-going t))
			(setq mode (cdr (car alist))
			      keep-going nil)))
		  (setq alist (cdr alist)))
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
		(if mode
		    (funcall mode)
		  ;; If we can't deduce a mode from the file name,
		  ;; look for an interpreter specified in the first line.
		  (let ((interpreter
			 (save-excursion
			   (goto-char (point-min))
			   (if (looking-at "#! *")
			       (progn
				 (goto-char (match-end 0))
				 (buffer-substring (point)
						   (progn (end-of-line) (point))))
			     "")))
			elt)
		    ;; Map interpreter name to a mode.
		    (setq elt (assoc (file-name-nondirectory interpreter)
				     interpreter-mode-alist))
		    (if elt
			(funcall (cdr elt))))))))))))
Roland McGrath's avatar
Roland McGrath committed
974

975 976
(defun hack-local-variables-prop-line ()
  ;; Set local variables specified in the -*- line.
977 978
  ;; Ignore any specification for `mode:';
  ;; set-auto-mode should already have handled that.
979 980
  (save-excursion
    (goto-char (point-min))
981 982
    (let ((result nil)
	  (end (save-excursion (end-of-line (and (looking-at "^#!") 2)) (point))))
983 984 985 986 987
      ;; Parse the -*- line into the `result' alist.
      (cond ((not (search-forward "-*-" end t))
	     ;; doesn't have one.
	     nil)
	    ((looking-at "[ \t]*\\([^ \t\n\r:;]+\\)\\([ \t]*-\\*-\\)")
988 989
	     ;; Simple form: "-*- MODENAME -*-".  Already handled.
	     nil)
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
	    (t
	     ;; Hairy form: '-*-' [ <variable> ':' <value> ';' ]* '-*-'
	     ;; (last ";" is optional).
	     (save-excursion
	       (if (search-forward "-*-" end t)
		   (setq end (- (point) 3))
		 (error "-*- not terminated before end of line")))
	     (while (< (point) end)
	       (or (looking-at "[ \t]*\\([^ \t\n:]+\\)[ \t]*:[ \t]*")
		   (error "malformed -*- line"))
	       (goto-char (match-end 0))
	       (let ((key (intern (downcase (buffer-substring
					     (match-beginning 1)
					     (match-end 1)))))
		     (val (save-restriction
			    (narrow-to-region (point) end)
			    (read (current-buffer)))))
1007 1008
		 (or (eq key 'mode)
		     (setq result (cons (cons key val) result)))
1009 1010 1011 1012 1013 1014 1015
		 (skip-chars-forward " \t;")))
	     (setq result (nreverse result))))
      
      (if (and result
	       (or (eq enable-local-variables t)
		   (and enable-local-variables
			(save-window-excursion
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
			  (condition-case nil
			      (switch-to-buffer (current-buffer))
			    (error
			     ;; If we fail to switch in the selected window,
			     ;; it is probably a minibuffer.
			     ;; So try another window.
			     (condition-case nil
				 (switch-to-buffer-other-window (current-buffer))
			       (error
				(switch-to-buffer-other-frame (current-buffer))))))
1026 1027 1028
			  (y-or-n-p (format "Set local variables as specified in -*- line of %s? "
					    (file-name-nondirectory buffer-file-name)))))))
	  (while result
1029
	    (hack-one-local-variable (car (car result)) (cdr (car result)))
1030
	    (setq result (cdr result)))))))
1031

Jim Blandy's avatar
Jim Blandy committed
1032
(defun hack-local-variables ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1033
  "Parse and put into effect this buffer's local variables spec."
1034
  (hack-local-variables-prop-line)
Roland McGrath's avatar
Roland McGrath committed
1035 1036 1037 1038 1039 1040
  ;; Look for "Local variables:" line in last page.
  (save-excursion
    (goto-char (point-max))
    (search-backward "\n\^L" (max (- (point-max) 3000) (point-min)) 'move)
    (if (let ((case-fold-search t))
	  (and (search-forward "Local Variables:" nil t)
Jim Blandy's avatar
Jim Blandy committed
1041
	       (or (eq enable-local-variables t)
Roland McGrath's avatar
Roland McGrath committed
1042 1043 1044 1045 1046 1047 1048
		   (and enable-local-variables
			(save-window-excursion
			  (switch-to-buffer (current-buffer))
			  (save-excursion
			    (beginning-of-line)
			    (set-window-start (selected-window) (point)))
			  (y-or-n-p (format "Set local variables as specified at end of %s? "
1049 1050 1051 1052 1053
 					    (if buffer-file-name
 						(file-name-nondirectory 
 						 buffer-file-name)
 					      (concat "buffer "
 						      (buffer-name))))))))))
Roland McGrath's avatar
Roland McGrath committed
1054
	(let ((continue t)
1055 1056
	      prefix prefixlen suffix beg
	      (enable-local-eval enable-local-eval))
Roland McGrath's avatar
Roland McGrath committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	  ;; The prefix is what comes before "local variables:" in its line.
	  ;; The suffix is what comes after "local variables:" in its line.
	  (skip-chars-forward " \t")
	  (or (eolp)
	      (setq suffix (buffer-substring (point)
					     (progn (end-of-line) (point)))))
	  (goto-char (match-beginning 0))
	  (or (bolp)
	      (setq prefix
		    (buffer-substring (point)
				      (progn (beginning-of-line) (point)))))
Jim Blandy's avatar
Jim Blandy committed
1068

Roland McGrath's avatar
Roland McGrath committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
	  (if prefix (setq prefixlen (length prefix)
			   prefix (regexp-quote prefix)))
	  (if suffix (setq suffix (concat (regexp-quote suffix) "$")))
	  (while continue
	    ;; Look at next local variable spec.
	    (if selective-display (re-search-forward "[\n\C-m]")
	      (forward-line 1))
	    ;; Skip the prefix, if any.
	    (if prefix
		(if (looking-at prefix)
		    (forward-char prefixlen)
		  (error "Local variables entry is missing the prefix")))
	    ;; Find the variable name; strip whitespace.
	    (skip-chars-forward " \t")
	    (setq beg (point))
	    (skip-chars-forward "^:\n")
	    (if (eolp) (error "Missing colon in local variables entry"))
	    (skip-chars-backward " \t")
	    (let* ((str (buffer-substring beg (point)))
		   (var (read str))
		  val)
	      ;; Setting variable named "end" means end of list.
	      (if (string-equal (downcase str) "end")
		  (setq continue nil)
		;; Otherwise read the variable value.
		(skip-chars-forward "^:")
		(forward-char 1)
		(setq val (read (current-buffer)))
		(skip-chars-backward "\n")
		(skip-chars-forward " \t")
		(or (if suffix (looking-at suffix) (eolp))
		    (error "Local variables entry is terminated incorrectly"))
		;; Set the variable.  "Variables" mode and eval are funny.
1102 1103 1104 1105 1106 1107
		(hack-one-local-variable var val))))))))

(defconst ignored-local-variables
  '(enable-local-eval)
  "Variables to be ignored in a file's local variable spec.")

1108 1109 1110 1111 1112 1113
;; Get confirmation before setting these variables as locals in a file.
(put 'eval 'risky-local-variable t)
(put 'file-name-handler-alist 'risky-local-variable t)
(put 'minor-mode-map-alist 'risky-local-variable t)
(put 'after-load-alist 'risky-local-variable t)
	    
1114 1115 1116
(defun hack-one-local-variable-quotep (exp)
  (and (consp exp) (eq (car exp) 'quote) (consp (cdr exp))))

1117 1118 1119 1120 1121 1122 1123 1124 1125
;; "Set" one variable in a local variables spec.
;; A few variable names are treated specially.
(defun hack-one-local-variable (var val)
  (cond ((eq var 'mode)
	 (funcall (intern (concat (downcase (symbol-name val))
				  "-mode"))))
	((memq var ignored-local-variables)
	 nil)
	;; "Setting" eval means either eval it or do nothing.
1126
	;; Likewise for setting hook variables.
1127
	((or (get var 'risky-local-variable)
1128 1129
	     (string-match "-hooks?$\\|-functions?$\\|-forms?$"
			   (symbol-name var)))
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
	 ;; Permit evaling a put of a harmless property
	 ;; if the args do nothing tricky.
	 (if (or (and (eq var 'eval)
		      (consp val)
		      (eq (car val) 'put)
		      (hack-one-local-variable-quotep (nth 1 val))
		      (hack-one-local-variable-quotep (nth 2 val))
		      ;; Only allow safe values of lisp-indent-hook;
		      ;; not functions.
		      (or (numberp (nth 3 val))
			  (eq (nth 3 val) 'defun))
		      (memq (nth 1 (nth 2 val))
			    '(lisp-indent-hook)))
		 ;; Permit eval if not root and user says ok.
		 (and (not (string= (user-login-name) "root"))
		      (or (eq enable-local-eval t)
			  (and enable-local-eval
			       (save-window-excursion
				 (switch-to-buffer (current-buffer))
				 (save-excursion
				   (beginning-of-line)
				   (set-window-start (selected-window) (point)))
				 (setq enable-local-eval
				       (y-or-n-p (format "Process `eval' or hook local variables in file %s? "
							 (file-name-nondirectory buffer-file-name)))))))))
1155 1156 1157 1158
	     (if (eq var 'eval)
		 (save-excursion (eval val))
	       (make-local-variable var)
	       (set var val))
1159 1160 1161 1162 1163
	   (message "Ignoring `eval:' in file's local variables")))
	;; Ordinary variable, really set it.
	(t (make-local-variable var)
	   (set var val))))

Roland McGrath's avatar
Roland McGrath committed
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

(defun set-visited-file-name (filename)
  "Change name of file visited in current buffer to FILENAME.
The next time the buffer is saved it will go in the newly specified file.
nil or empty string as argument means make buffer not be visiting any file.
Remember to delete the initial contents of the minibuffer
if you wish to pass an empty string as the argument."
  (interactive "FSet visited file name: ")
  (if filename
      (setq filename
	    (if (string-equal filename "")
		nil
	      (expand-file-name filename))))
  (or (equal filename buffer-file-name)
      (progn
1179
	(and filename (lock-buffer filename))
Roland McGrath's avatar
Roland McGrath committed
1180 1181 1182
	(unlock-buffer)))
  (setq buffer-file-name filename)
  (if filename				; make buffer name reflect filename.
Jim Blandy's avatar
Jim Blandy committed
1183
      (let ((new-name (file-name-nondirectory buffer-file-name)))
Roland McGrath's avatar
Roland McGrath committed
1184 1185 1186 1187 1188
	(if (string= new-name "")
	    (error "Empty file name"))
	(if (eq system-type 'vax-vms)
	    (setq new-name (downcase new-name)))
	(setq default-directory (file-name-directory buffer-file-name))
1189 1190
	(or (string= new-name (buffer-name))
	    (rename-buffer new-name t))))
Roland McGrath's avatar
Roland McGrath committed
1191 1192
  (setq buffer-backed-up nil)
  (clear-visited-file-modtime)
1193 1194 1195 1196 1197 1198 1199 1200
  (if filename
      (progn
	(setq buffer-file-truename
	      (abbreviate-file-name (file-truename buffer-file-name)))
	(if find-file-visit-truename
	    (setq buffer-file-name buffer-file-truename))
	(setq buffer-file-number (nth 10 (file-attributes buffer-file-name))))
    (setq buffer-file-truename nil buffer-file-number nil))
Roland McGrath's avatar
Roland McGrath committed
1201 1202 1203 1204
  ;; write-file-hooks is normally used for things like ftp-find-file
  ;; that visit things that are not local files as if they were files.
  ;; Changing to visit an ordinary local file instead should flush the hook.
  (kill-local-variable 'write-file-hooks)
1205
  (kill-local-variable 'local-write-file-hooks)
Roland McGrath's avatar
Roland McGrath committed
1206 1207
  (kill-local-variable 'revert-buffer-function)
  (kill-local-variable 'backup-inhibited)
1208 1209 1210 1211 1212
  ;; If buffer was read-only because of version control,
  ;; that reason is gone now, so make it writable.
  (if vc-mode
      (setq buffer-read-only nil))
  (kill-local-variable 'vc-mode)
Roland McGrath's avatar
Roland McGrath committed
1213 1214 1215 1216 1217 1218
  ;; Turn off backup files for certain file names.
  ;; Since this is a permanent local, the major mode won't eliminate it.
  (and (not (funcall backup-enable-predicate buffer-file-name))
       (progn
	 (make-local-variable 'backup-inhibited)
	 (setq backup-inhibited t)))
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
  (let ((oauto buffer-auto-save-file-name))
    ;; If auto-save was not already on, turn it on if appropriate.
    (if (not buffer-auto-save-file-name)
	(and buffer-file-name auto-save-default
	     (auto-save-mode t))
      ;; If auto save is on, start using a