vc-hooks.el 14.9 KB
Newer Older
1
;;; vc-hooks.el --- resident support for version-control
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4 5

;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
Richard M. Stallman's avatar
Richard M. Stallman committed
6
;; Version: 5.3 + CVS hacks by ceder@lysator.liu.se made in Jan-Feb 1994.
Eric S. Raymond's avatar
Eric S. Raymond committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

;; 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
;; the Free Software Foundation; either version 2, or (at your option)
;; 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.

;;; Commentary:

;; See the commentary of vc.el.

;;; Code:

(defvar vc-master-templates
  '(("%sRCS/%s,v" . RCS) ("%s%s,v" . RCS) ("%sRCS/%s" . RCS)
Richard M. Stallman's avatar
Richard M. Stallman committed
32 33
    ("%sSCCS/s.%s" . SCCS) ("%ss.%s". SCCS)
    vc-find-cvs-master)
Eric S. Raymond's avatar
Eric S. Raymond committed
34 35 36 37 38
  "*Where to look for version-control master files.
The first pair corresponding to a given back end is used as a template
when creating new masters.")

(defvar vc-make-backup-files nil
39
  "*If non-nil, backups of registered files are made as with other files.
40
If nil (the default), files covered by version control don't get backups.")
Eric S. Raymond's avatar
Eric S. Raymond committed
41

42 43
(defvar vc-display-status t
  "*If non-nil, display revision number and lock status in modeline.
44 45
Otherwise, not displayed.")

Eric S. Raymond's avatar
Eric S. Raymond committed
46
;; Tell Emacs about this new kind of minor mode
Eric S. Raymond's avatar
Eric S. Raymond committed
47 48
(if (not (assoc 'vc-mode minor-mode-alist))
    (setq minor-mode-alist (cons '(vc-mode vc-mode)
Eric S. Raymond's avatar
Eric S. Raymond committed
49 50
				 minor-mode-alist)))

Eric S. Raymond's avatar
Eric S. Raymond committed
51
(make-variable-buffer-local 'vc-mode)
52
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
53 54 55 56 57

;; We need a notion of per-file properties because the version
;; control state of a file is expensive to derive --- we don't
;; want to recompute it even on every find.

58 59 60
(defmacro vc-error-occurred (&rest body)
  (list 'condition-case nil (cons 'progn (append body '(nil))) '(error t)))

Eric S. Raymond's avatar
Eric S. Raymond committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74
(defvar vc-file-prop-obarray [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
  "Obarray for per-file properties.")

(defun vc-file-setprop (file property value)
  ;; set per-file property
  (put (intern file vc-file-prop-obarray) property value))

(defun vc-file-getprop (file property)
  ;; get per-file property
  (get (intern file vc-file-prop-obarray) property))

;;; actual version-control code starts here

(defun vc-registered (file)
75 76
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
77
	(setq handler (find-file-name-handler file 'vc-registered)))
78 79 80 81 82 83 84 85
    (if handler
	(funcall handler 'vc-registered file)
      ;; Search for a master corresponding to the given file
      (let ((dirname (or (file-name-directory file) ""))
	    (basename (file-name-nondirectory file)))
	(catch 'found
	  (mapcar
	   (function (lambda (s)
Richard M. Stallman's avatar
Richard M. Stallman committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
	      (if (atom s)
		  (funcall s dirname basename)
		(let ((trial (format (car s) dirname basename)))
		  (if (and (file-exists-p trial)
			   ;; Make sure the file we found with name
			   ;; TRIAL is not the source file itself.
			   ;; That can happen with RCS-style names
			   ;; if the file name is truncated
			   ;; (e.g. to 14 chars).  See if either
			   ;; directory or attributes differ.
			   (or (not (string= dirname
					     (file-name-directory trial)))
			       (not (equal
				     (file-attributes file)
				     (file-attributes trial)))))
		      (throw 'found (cons trial (cdr s))))))))
102 103
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
104

Richard M. Stallman's avatar
Richard M. Stallman committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
(defun vc-find-cvs-master (dirname basename)
  ;; Check if DIRNAME/BASENAME is handled by CVS.
  ;; If it is, do a (throw 'found (cons MASTER 'CVS)).
  ;; Note: If the file is ``cvs add''ed but not yet ``cvs commit''ed 
  ;; the MASTER will not actually exist yet.  The other parts of VC
  ;; checks for this condition.  This function returns something random if 
  ;; DIRNAME/BASENAME is not handled by CVS.
  (if (and (file-directory-p (concat dirname "CVS/"))
	   (file-readable-p (concat dirname "CVS/Entries")))
      (let ((bufs nil))
	(unwind-protect
	    (save-excursion
	      (setq bufs (list
			  (find-file-noselect (concat dirname "CVS/Entries"))))
	      (set-buffer (car bufs))
	      (goto-char (point-min))
	      (cond
	       ((re-search-forward
		 (concat "^/" (regexp-quote basename) "/\\([^/]*\\)/")
		 nil t)
		;; We found it.  Store away version number, now
		;; that we are anyhow so close to finding it.
		(vc-file-setprop (concat dirname basename) 
				 'vc-your-latest-version
				 (buffer-substring (match-beginning 1)
						   (match-end 1)))
		(setq bufs (cons (find-file-noselect 
				  (concat dirname "CVS/Repository"))
				 bufs))
		(set-buffer (car bufs))
		(let ((master
		       (concat (file-name-as-directory 
				(buffer-substring (point-min)
						  (1- (point-max))))
			       basename
			       ",v")))
		  (throw 'found (cons master 'CVS))))))
	  (mapcar (function kill-buffer) bufs)))))

144 145 146 147 148 149 150 151 152
(defun vc-name (file)
  "Return the master name of a file, nil if it is not registered."
  (or (vc-file-getprop file 'vc-name)
      (let ((name-and-type (vc-registered file)))
	(if name-and-type
	    (progn
	      (vc-file-setprop file 'vc-backend (cdr name-and-type))
	      (vc-file-setprop file 'vc-name (car name-and-type)))))))

Eric S. Raymond's avatar
Eric S. Raymond committed
153
(defun vc-backend-deduce (file)
154
  "Return the version-control type of a file, nil if it is not registered."
Eric S. Raymond's avatar
Eric S. Raymond committed
155 156
  (and file
       (or (vc-file-getprop file 'vc-backend)
157 158 159 160 161
	   (let ((name-and-type (vc-registered file)))
	     (if name-and-type
		 (progn
		   (vc-file-setprop file 'vc-name (car name-and-type))
		   (vc-file-setprop file 'vc-backend (cdr name-and-type))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
162 163

(defun vc-toggle-read-only ()
164 165 166 167
  "Change read-only status of current buffer, perhaps via version control.
If the buffer is visiting a file registered with version control,
then check the file in or out.  Otherwise, just change the read-only flag
of the buffer."
Eric S. Raymond's avatar
Eric S. Raymond committed
168 169 170 171
  (interactive)
  (if (vc-backend-deduce (buffer-file-name))
      (vc-next-action nil)
    (toggle-read-only)))
172
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
173 174

(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
175
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
176
The value is set in the current buffer, which should be the buffer
177 178
visiting FILE.  Second optional arg LABEL is put in place of version
control system name."
179
  (interactive (list buffer-file-name nil))
180 181 182
  (if file
      (let ((vc-type (vc-backend-deduce file)))
	(setq vc-mode
183 184 185 186 187 188
	      (if vc-type
		  (concat " " (or label (symbol-name vc-type))
			  (if vc-display-status
			      (vc-status file vc-type)))))
	;; Even root shouldn't modify a registered file without
	;; locking it first.
189 190 191 192
	(and vc-type
	     (not buffer-read-only)
	     (zerop (user-uid))
	     (require 'vc)
Richard M. Stallman's avatar
Richard M. Stallman committed
193
	     (not (equal (user-login-name) (vc-locking-user file)))
194 195 196 197 198
	     (setq buffer-read-only t))
	(and (null vc-type)
	     (file-symlink-p file)
	     (let ((link-type (vc-backend-deduce (file-symlink-p file))))
	       (if link-type
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200 201
		   (message
		    "Warning: symbolic link to %s-controlled source file"
		    link-type))))
202 203 204
	(force-mode-line-update)
	;;(set-buffer-modified-p (buffer-modified-p))  ;;use this if Emacs 18
	vc-type)))
Eric S. Raymond's avatar
Eric S. Raymond committed
205

206
(defun vc-status (file vc-type)
207
  ;; Return string for placement in modeline by `vc-mode-line'.
208
  ;; If FILE is not registered, return nil.
209 210 211
  ;; If FILE is registered but not locked, return " REV" if there is a head
  ;; revision and " @@" otherwise.
  ;; If FILE is locked then return all locks in a string of the
212 213
  ;; form " LOCKER1:REV1 LOCKER2:REV2 ...", where "LOCKERi:" is empty if you
  ;; are the locker, and otherwise is the name of the locker followed by ":".
214 215 216

  ;; Algorithm: 

217
  ;; Check for master file corresponding to FILE being visited.
218
  ;; 
219 220 221 222
  ;; RCS: Insert the first few characters of the master file into a
  ;; work buffer.  Search work buffer for "locks...;" phrase; if not
  ;; found, then keep inserting more characters until the phrase is
  ;; found.  Extract the locks, and remove control characters
223 224
  ;; separating them, like newlines; the string " user1:revision1
  ;; user2:revision2 ..." is returned.
225 226 227 228
  ;;
  ;; SCCS: Check if the p-file exists.  If it does, read it and
  ;; extract the locks, giving them the right format.  Else use prs to
  ;; find the revision number.
Richard M. Stallman's avatar
Richard M. Stallman committed
229 230 231
  ;;
  ;; CVS: vc-find-cvs-master has already stored the current revision
  ;; number.  Fetch it from the file property.
232
  
233 234 235 236
  ;; Limitations:

  ;; The output doesn't show which version you are actually looking at.
  ;; The modeline can get quite cluttered when there are multiple locks.
237
  ;; The head revision is probably not what you want if you've used `rcs -b'.
238

239
  (let ((master (vc-name file))
240 241
	found
	status)
242

243 244 245
    ;; If master file exists, then parse its contents, otherwise we
    ;; return the nil value of this if form.
    (if (and master vc-type)
246 247 248
        (save-excursion

          ;; Create work buffer.
249
          (set-buffer (get-buffer-create " *vc-status*"))
250 251 252 253
          (setq buffer-read-only nil
                default-directory (file-name-directory master))
          (erase-buffer)

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	  ;; Set the `status' var to the return value.
	  (cond

	   ;; RCS code.
	   ((eq vc-type 'RCS)
	    ;; Check if we have enough of the header.
	    ;; If not, then keep including more.
	    (while
		(not (or found
			 (let ((s (buffer-size)))
			   (goto-char (1+ s))
			   (zerop (car (cdr (insert-file-contents
					     master nil s (+ s 8192))))))))
	      (beginning-of-line)
	      (setq found (re-search-forward "^locks\\([^;]*\\);" nil t)))

	    (if found
		;; Clean control characters and self-locks from text.
		(let* ((lock-pattern
			(concat "[ \b\t\n\v\f\r]+\\("
				(regexp-quote (user-login-name))
				":\\)?"))
		       (locks
			(save-restriction
			  (narrow-to-region (match-beginning 1) (match-end 1))
			  (goto-char (point-min))
			  (while (re-search-forward lock-pattern nil t)
			    (replace-match (if (eobp) "" ":") t t))
			  (buffer-string))))
		  (setq status
			(if (not (string-equal locks ""))
			    locks
			  (goto-char (point-min))
			  (if (looking-at "head[ \b\t\n\v\f\r]+\\([.0-9]+\\)")
			      (concat "-"
				      (buffer-substring (match-beginning 1)
							(match-end 1)))
			    " @@"))))))

	   ;; SCCS code.
	   ((eq vc-type 'SCCS)
	    ;; Build the name of the p-file and put it in the work buffer.
	    (insert master)
	    (search-backward "/s.")
	    (delete-char 2)
	    (insert "/p")
	    (if (not (file-exists-p (buffer-string)))
		;; No lock.
		(let ((exec-path (if vc-path (append exec-path vc-path)
				   exec-path)))
		  (erase-buffer)
		  (insert "-")
		  (if (zerop (call-process "prs" nil t nil "-d:I:" master))
		      (setq status (buffer-substring 1 (1- (point-max))))))
	      ;; Locks exist.
	      (insert-file-contents (buffer-string) nil nil nil t)
	      (while (looking-at "[^ ]+ \\([^ ]+\\) \\([^ ]+\\).*\n")
		(replace-match " \\2:\\1"))
	      (setq status (buffer-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
313 314 315 316 317 318 319 320
	      (aset status 0 ?:)))
	   ;; CVS code.
	   ((eq vc-type 'CVS)
	    (let ((version (vc-file-getprop
			    file 'vc-your-latest-version)))
	      (setq status (concat ":" (if (string= "0" version)
					   " @@" ;added, not yet committed.
					 version))))))
321 322 323 324 325

	  ;; Clean work buffer.
	  (erase-buffer)
	  (set-buffer-modified-p nil)
	  status))))
326

Eric S. Raymond's avatar
Eric S. Raymond committed
327 328
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
329 330
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
331 332
  (if buffer-file-name
      (vc-file-setprop buffer-file-name 'vc-backend nil))
Eric S. Raymond's avatar
Eric S. Raymond committed
333 334
  (if (and (vc-mode-line buffer-file-name) (not vc-make-backup-files))
      (progn
335 336 337 338
	;; Use this variable, not make-backup-files,
	;; because this is for things that depend on the file name.
	(make-local-variable 'backup-inhibited)
	(setq backup-inhibited t))))
Eric S. Raymond's avatar
Eric S. Raymond committed
339

340
(add-hook 'find-file-hooks 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
341 342 343 344 345 346

;;; more hooks, this time for file-not-found
(defun vc-file-not-found-hook ()
  "When file is not found, try to check it out from RCS or SCCS.
Returns t if checkout was successful, nil otherwise."
  (if (vc-backend-deduce buffer-file-name)
347
      (save-excursion
Eric S. Raymond's avatar
Eric S. Raymond committed
348 349 350
	(require 'vc)
	(not (vc-error-occurred (vc-checkout buffer-file-name))))))

351
(add-hook 'find-file-not-found-hooks 'vc-file-not-found-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
352 353

;;; Now arrange for bindings and autoloading of the main package.
Eric S. Raymond's avatar
Eric S. Raymond committed
354 355
;;; Bindings for this have to go in the global map, as we'll often
;;; want to call them from random buffers.
Eric S. Raymond's avatar
Eric S. Raymond committed
356 357 358 359 360 361 362 363

(setq vc-prefix-map (lookup-key global-map "\C-xv"))
(if (not (keymapp vc-prefix-map))
    (progn
      (setq vc-prefix-map (make-sparse-keymap))
      (define-key global-map "\C-xv" vc-prefix-map)
      (define-key vc-prefix-map "a" 'vc-update-change-log)
      (define-key vc-prefix-map "c" 'vc-cancel-version)
364
      (define-key vc-prefix-map "d" 'vc-directory)
Eric S. Raymond's avatar
Eric S. Raymond committed
365 366 367 368 369 370 371
      (define-key vc-prefix-map "h" 'vc-insert-headers)
      (define-key vc-prefix-map "i" 'vc-register)
      (define-key vc-prefix-map "l" 'vc-print-log)
      (define-key vc-prefix-map "r" 'vc-retrieve-snapshot)
      (define-key vc-prefix-map "s" 'vc-create-snapshot)
      (define-key vc-prefix-map "u" 'vc-revert-buffer)
      (define-key vc-prefix-map "v" 'vc-next-action)
372
      (define-key vc-prefix-map "=" 'vc-diff)
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
      (define-key vc-prefix-map "~" 'vc-version-other-window)))

;;;(define-key vc-menu-map [show-files]
;;;  '("Show Files under VC" . (vc-directory t)))
(define-key vc-menu-map [vc-directory] '("Show Locked Files" . vc-directory))
(define-key vc-menu-map [separator1] '("----"))
(define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
(define-key vc-menu-map [vc-version-other-window]
  '("Show Other Version" . vc-version-other-window))
(define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
(define-key vc-menu-map [vc-update-change-log]
  '("Update ChangeLog" . vc-update-change-log))
(define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
(define-key vc-menu-map [separator2] '("----"))
(define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
(define-key vc-menu-map [vc-revert-buffer]
  '("Revert to Last Version" . vc-revert-buffer))
(define-key vc-menu-map [vc-insert-header]
  '("Insert Header" . vc-insert-headers))
(define-key vc-menu-map [vc-menu-check-in] '("Check In" . vc-next-action))
(define-key vc-menu-map [vc-check-out] '("Check Out" . vc-toggle-read-only))
(define-key vc-menu-map [vc-register] '("Register" . vc-register))

(put 'vc-rename-file 'menu-enable 'vc-mode)
(put 'vc-version-other-window 'menu-enable 'vc-mode)
(put 'vc-diff 'menu-enable 'vc-mode)
(put 'vc-update-change-log 'menu-enable '(eq (vc-backend-deduce (buffer-file-name)) 'RCS))
(put 'vc-print-log 'menu-enable 'vc-mode)
(put 'vc-cancel-version 'menu-enable 'vc-mode)
(put 'vc-revert-buffer 'menu-enable 'vc-mode)
(put 'vc-insert-headers 'menu-enable 'vc-mode)
(put 'vc-next-action 'menu-enable '(and vc-mode (not buffer-read-only)))
(put 'vc-toggle-read-only 'menu-enable '(and vc-mode buffer-read-only))
(put 'vc-register 'menu-enable '(not vc-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
407 408 409 410

(provide 'vc-hooks)

;;; vc-hooks.el ends here