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

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

;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Version: 5.3
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 32 33 34 35 36 37 38 39 40

;; 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)
    ("%sSCCS/s.%s" . SCCS) ("%ss.%s". SCCS))
  "*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
  "*If non-nil, backups of registered files are made according to
the make-backup-files variable.  Otherwise, prevents backups being made.")

41 42 43 44
(defvar vc-rcs-status t
  "*If non-nil, revision and locks on RCS working file displayed in modeline.
Otherwise, not displayed.")

Eric S. Raymond's avatar
Eric S. Raymond committed
45
;; Tell Emacs about this new kind of minor mode
Eric S. Raymond's avatar
Eric S. Raymond committed
46 47
(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
48 49
				 minor-mode-alist)))

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

;; 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.

57 58 59
(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
60 61 62 63 64 65 66 67 68 69 70 71 72 73
(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)
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 106 107
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
	(save-match-data
	  (setq handlers file-name-handler-alist)
	  (while (and (consp handlers) (null handler))
	    (if (and (consp (car handlers))
		     (stringp (car (car handlers)))
		     (string-match (car (car handlers)) file))
		(setq handler (cdr (car handlers))))
	    (setq handlers (cdr handlers)))))
    (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)
	      (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)))))))
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
108

109 110 111 112 113 114 115 116 117
(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
118
(defun vc-backend-deduce (file)
119
  "Return the version-control type of a file, nil if it is not registered."
Eric S. Raymond's avatar
Eric S. Raymond committed
120 121
  (and file
       (or (vc-file-getprop file 'vc-backend)
122 123 124 125 126
	   (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
127 128

(defun vc-toggle-read-only ()
129 130 131 132
  "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
133 134 135 136
  (interactive)
  (if (vc-backend-deduce (buffer-file-name))
      (vc-next-action nil)
    (toggle-read-only)))
137
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
138 139

(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
140
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
141 142
The value is set in the current buffer, which should be the buffer
visiting FILE."
143
  (interactive (list buffer-file-name nil))
Eric S. Raymond's avatar
Eric S. Raymond committed
144 145
  (let ((vc-type (vc-backend-deduce file)))
    (if vc-type
146
        (setq vc-mode
147 148 149
              (concat " " (or label (symbol-name vc-type))
		      (if (and vc-rcs-status (eq vc-type 'RCS))
                          (vc-rcs-status file)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
150 151 152 153
    ;; force update of mode line
    (set-buffer-modified-p (buffer-modified-p))
    vc-type))

154
(defun vc-rcs-status (file)
155
  ;; Return string " [LOCKER:REV]" if FILE under RCS control, otherwise nil,
156 157
  ;; for placement in modeline by `vc-mode-line'.

158
  ;; If FILE is not locked then return just "".  If the FILE is locked
159
  ;; then return *all* the locks currently set, in a single string of the
160
  ;; form " LOCKER1:REV1 LOCKER2:REV2 ...".
161 162 163

  ;; Algorithm: 

164
  ;; 1. Check for master file corresponding to FILE being visited.
165
  ;; 
166
  ;; 2. Insert the first few characters of the master file into a work
167 168
  ;; buffer.
  ;;  
169 170
  ;; 3. Search work buffer for "locks...;" phrase; if not found, then
  ;; keep inserting more characters until the phrase is found.
171
  ;; 
172
  ;; 4. Extract the locks, and remove control characters
173 174 175 176 177 178 179 180
  ;; separating them, like newlines; the string " user1:revision1
  ;; user2:revision2 ..." is returned.

  ;; Limitations:

  ;; The output doesn't show which version you are actually looking at.
  ;; The modeline can get quite cluttered when there are multiple locks.

181
  (let ((master (vc-name file))
182
	found)
183 184 185

    ;; If master file exists, then parse its contents, otherwise we return the 
    ;; nil value of this if form.
186
    (if master
187 188 189 190 191 192 193 194
        (save-excursion

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

195 196 197 198 199 200 201 202 203 204
          ;; 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)))
205 206

          (if found
207 208 209 210 211 212 213 214 215 216 217 218
	      ;; Clean control characters from text.
	      (let ((status
		     (save-restriction
		       (narrow-to-region (match-beginning 1) (match-end 1))
		       (goto-char (point-min))
		       (while (re-search-forward "[ \b\t\n\v\f\r]+" nil t)
			 (replace-match " " t t))
		       (buffer-string))))
		;; Clean work buffer.
		(erase-buffer)
		(set-buffer-modified-p nil)
		status))))))
219

Eric S. Raymond's avatar
Eric S. Raymond committed
220 221
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
222 223
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
224 225
  (if buffer-file-name
      (vc-file-setprop buffer-file-name 'vc-backend nil))
Eric S. Raymond's avatar
Eric S. Raymond committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
  (if (and (vc-mode-line buffer-file-name) (not vc-make-backup-files))
      (progn
	(make-local-variable 'make-backup-files)
	(setq make-backup-files nil))))

(or (memq 'vc-find-file-hook find-file-hooks)
    (setq find-file-hooks
	  (cons 'vc-find-file-hook find-file-hooks)))

;;; 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)
      (progn
	(require 'vc)
	(not (vc-error-occurred (vc-checkout buffer-file-name))))))

(or (memq 'vc-file-not-found-hook find-file-not-found-hooks)
    (setq find-file-not-found-hooks
	  (cons 'vc-file-not-found-hook find-file-not-found-hooks)))

;;; Now arrange for bindings and autoloading of the main package.
Eric S. Raymond's avatar
Eric S. Raymond committed
249 250
;;; 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
251 252 253 254 255 256 257 258

(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)
259
      (define-key vc-prefix-map "d" 'vc-directory)
Eric S. Raymond's avatar
Eric S. Raymond committed
260 261 262 263 264 265 266
      (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)
267
      (define-key vc-prefix-map "=" 'vc-diff)
Eric S. Raymond's avatar
Eric S. Raymond committed
268 269 270 271 272
      ))

(provide 'vc-hooks)

;;; vc-hooks.el ends here