| 1 | ;;; vc-hooks.el --- resident support for version-control |
| 2 | |
| 3 | ;; Copyright (C) 1992,93,94,95,96,98,99,2000,03,2004 |
| 4 | ;; Free Software Foundation, Inc. |
| 5 | |
| 6 | ;; Author: FSF (see vc.el for full credits) |
| 7 | ;; Maintainer: Andre Spiegel <spiegel@gnu.org> |
| 8 | |
| 9 | ;; $Id: vc-hooks.el,v 1.167 2004/04/16 10:21:51 spiegel Exp $ |
| 10 | |
| 11 | ;; This file is part of GNU Emacs. |
| 12 | |
| 13 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
| 14 | ;; it under the terms of the GNU General Public License as published by |
| 15 | ;; the Free Software Foundation; either version 2, or (at your option) |
| 16 | ;; any later version. |
| 17 | |
| 18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 21 | ;; GNU General Public License for more details. |
| 22 | |
| 23 | ;; You should have received a copy of the GNU General Public License |
| 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
| 25 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 26 | ;; Boston, MA 02111-1307, USA. |
| 27 | |
| 28 | ;;; Commentary: |
| 29 | |
| 30 | ;; This is the always-loaded portion of VC. It takes care of |
| 31 | ;; VC-related activities that are done when you visit a file, so that |
| 32 | ;; vc.el itself is loaded only when you use a VC command. See the |
| 33 | ;; commentary of vc.el. |
| 34 | |
| 35 | ;;; Code: |
| 36 | |
| 37 | (eval-when-compile |
| 38 | (require 'cl)) |
| 39 | |
| 40 | ;; Customization Variables (the rest is in vc.el) |
| 41 | |
| 42 | (defvar vc-ignore-vc-files nil) |
| 43 | (make-obsolete-variable 'vc-ignore-vc-files |
| 44 | "set `vc-handled-backends' to nil to disable VC.") |
| 45 | |
| 46 | (defvar vc-master-templates ()) |
| 47 | (make-obsolete-variable 'vc-master-templates |
| 48 | "to define master templates for a given BACKEND, use |
| 49 | vc-BACKEND-master-templates. To enable or disable VC for a given |
| 50 | BACKEND, use `vc-handled-backends'.") |
| 51 | |
| 52 | (defvar vc-header-alist ()) |
| 53 | (make-obsolete-variable 'vc-header-alist 'vc-BACKEND-header) |
| 54 | |
| 55 | (defcustom vc-handled-backends '(RCS CVS SVN SCCS Arch MCVS) |
| 56 | ;; Arch and MCVS come last because they are per-tree rather than per-dir. |
| 57 | "*List of version control backends for which VC will be used. |
| 58 | Entries in this list will be tried in order to determine whether a |
| 59 | file is under that sort of version control. |
| 60 | Removing an entry from the list prevents VC from being activated |
| 61 | when visiting a file managed by that backend. |
| 62 | An empty list disables VC altogether." |
| 63 | :type '(repeat symbol) |
| 64 | :version "21.1" |
| 65 | :group 'vc) |
| 66 | |
| 67 | (defcustom vc-path |
| 68 | (if (file-directory-p "/usr/sccs") |
| 69 | '("/usr/sccs") |
| 70 | nil) |
| 71 | "*List of extra directories to search for version control commands." |
| 72 | :type '(repeat directory) |
| 73 | :group 'vc) |
| 74 | |
| 75 | (defcustom vc-make-backup-files nil |
| 76 | "*If non-nil, backups of registered files are made as with other files. |
| 77 | If nil (the default), files covered by version control don't get backups." |
| 78 | :type 'boolean |
| 79 | :group 'vc |
| 80 | :group 'backup) |
| 81 | |
| 82 | (defcustom vc-follow-symlinks 'ask |
| 83 | "*What to do if visiting a symbolic link to a file under version control. |
| 84 | Editing such a file through the link bypasses the version control system, |
| 85 | which is dangerous and probably not what you want. |
| 86 | |
| 87 | If this variable is t, VC follows the link and visits the real file, |
| 88 | telling you about it in the echo area. If it is `ask', VC asks for |
| 89 | confirmation whether it should follow the link. If nil, the link is |
| 90 | visited and a warning displayed." |
| 91 | :type '(choice (const :tag "Ask for confirmation" ask) |
| 92 | (const :tag "Visit link and warn" nil) |
| 93 | (const :tag "Follow link" t)) |
| 94 | :group 'vc) |
| 95 | |
| 96 | (defcustom vc-display-status t |
| 97 | "*If non-nil, display revision number and lock status in modeline. |
| 98 | Otherwise, not displayed." |
| 99 | :type 'boolean |
| 100 | :group 'vc) |
| 101 | |
| 102 | |
| 103 | (defcustom vc-consult-headers t |
| 104 | "*If non-nil, identify work files by searching for version headers." |
| 105 | :type 'boolean |
| 106 | :group 'vc) |
| 107 | |
| 108 | (defcustom vc-keep-workfiles t |
| 109 | "*If non-nil, don't delete working files after registering changes. |
| 110 | If the back-end is CVS, workfiles are always kept, regardless of the |
| 111 | value of this flag." |
| 112 | :type 'boolean |
| 113 | :group 'vc) |
| 114 | |
| 115 | (defcustom vc-mistrust-permissions nil |
| 116 | "*If non-nil, don't assume permissions/ownership track version-control status. |
| 117 | If nil, do rely on the permissions. |
| 118 | See also variable `vc-consult-headers'." |
| 119 | :type 'boolean |
| 120 | :group 'vc) |
| 121 | |
| 122 | (defun vc-mistrust-permissions (file) |
| 123 | "Internal access function to variable `vc-mistrust-permissions' for FILE." |
| 124 | (or (eq vc-mistrust-permissions 't) |
| 125 | (and vc-mistrust-permissions |
| 126 | (funcall vc-mistrust-permissions |
| 127 | (vc-backend-subdirectory-name file))))) |
| 128 | |
| 129 | (defcustom vc-stay-local t |
| 130 | "*Non-nil means use local operations when possible for remote repositories. |
| 131 | This avoids slow queries over the network and instead uses heuristics |
| 132 | and past information to determine the current status of a file. |
| 133 | |
| 134 | The value can also be a regular expression or list of regular |
| 135 | expressions to match against the host name of a repository; then VC |
| 136 | only stays local for hosts that match it. Alternatively, the value |
| 137 | can be a list of regular expressions where the first element is the |
| 138 | symbol `except'; then VC always stays local except for hosts matched |
| 139 | by these regular expressions." |
| 140 | :type '(choice (const :tag "Always stay local" t) |
| 141 | (const :tag "Don't stay local" nil) |
| 142 | (list :format "\nExamine hostname and %v" :tag "Examine hostname ..." |
| 143 | (set :format "%v" :inline t (const :format "%t" :tag "don't" except)) |
| 144 | (regexp :format " stay local,\n%t: %v" :tag "if it matches") |
| 145 | (repeat :format "%v%i\n" :inline t (regexp :tag "or")))) |
| 146 | :version "21.4" |
| 147 | :group 'vc) |
| 148 | |
| 149 | (defun vc-stay-local-p (file) |
| 150 | "Return non-nil if VC should stay local when handling FILE. |
| 151 | This uses the `repository-hostname' backend operation." |
| 152 | (let* ((backend (vc-backend file)) |
| 153 | (sym (vc-make-backend-sym backend 'stay-local)) |
| 154 | (stay-local (if (boundp sym) (symbol-value sym) t))) |
| 155 | (if (eq stay-local t) (setq stay-local vc-stay-local)) |
| 156 | (if (symbolp stay-local) stay-local |
| 157 | (let ((dirname (if (file-directory-p file) |
| 158 | (directory-file-name file) |
| 159 | (file-name-directory file)))) |
| 160 | (eq 'yes |
| 161 | (or (vc-file-getprop dirname 'vc-stay-local-p) |
| 162 | (vc-file-setprop |
| 163 | dirname 'vc-stay-local-p |
| 164 | (let ((hostname (vc-call-backend |
| 165 | backend 'repository-hostname dirname))) |
| 166 | (if (not hostname) |
| 167 | 'no |
| 168 | (let ((default t)) |
| 169 | (if (eq (car-safe stay-local) 'except) |
| 170 | (setq default nil stay-local (cdr stay-local))) |
| 171 | (when (consp stay-local) |
| 172 | (setq stay-local |
| 173 | (mapconcat 'identity stay-local "\\|"))) |
| 174 | (if (if (string-match stay-local hostname) |
| 175 | default (not default)) |
| 176 | 'yes 'no))))))))))) |
| 177 | |
| 178 | ;;; This is handled specially now. |
| 179 | ;; Tell Emacs about this new kind of minor mode |
| 180 | ;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode)) |
| 181 | |
| 182 | (make-variable-buffer-local 'vc-mode) |
| 183 | (put 'vc-mode 'permanent-local t) |
| 184 | |
| 185 | (defun vc-mode (&optional arg) |
| 186 | ;; Dummy function for C-h m |
| 187 | "Version Control minor mode. |
| 188 | This minor mode is automatically activated whenever you visit a file under |
| 189 | control of one of the revision control systems in `vc-handled-backends'. |
| 190 | VC commands are globally reachable under the prefix `\\[vc-prefix-map]': |
| 191 | \\{vc-prefix-map}") |
| 192 | |
| 193 | (defmacro vc-error-occurred (&rest body) |
| 194 | `(condition-case nil (progn ,@body nil) (error t))) |
| 195 | |
| 196 | ;; We need a notion of per-file properties because the version |
| 197 | ;; control state of a file is expensive to derive --- we compute |
| 198 | ;; them when the file is initially found, keep them up to date |
| 199 | ;; during any subsequent VC operations, and forget them when |
| 200 | ;; the buffer is killed. |
| 201 | |
| 202 | (defvar vc-file-prop-obarray (make-vector 17 0) |
| 203 | "Obarray for per-file properties.") |
| 204 | |
| 205 | (defvar vc-touched-properties nil) |
| 206 | |
| 207 | (defun vc-file-setprop (file property value) |
| 208 | "Set per-file VC PROPERTY for FILE to VALUE." |
| 209 | (if (and vc-touched-properties |
| 210 | (not (memq property vc-touched-properties))) |
| 211 | (setq vc-touched-properties (append (list property) |
| 212 | vc-touched-properties))) |
| 213 | (put (intern file vc-file-prop-obarray) property value)) |
| 214 | |
| 215 | (defun vc-file-getprop (file property) |
| 216 | "Get per-file VC PROPERTY for FILE." |
| 217 | (get (intern file vc-file-prop-obarray) property)) |
| 218 | |
| 219 | (defun vc-file-clearprops (file) |
| 220 | "Clear all VC properties of FILE." |
| 221 | (setplist (intern file vc-file-prop-obarray) nil)) |
| 222 | |
| 223 | \f |
| 224 | ;; We keep properties on each symbol naming a backend as follows: |
| 225 | ;; * `vc-functions': an alist mapping vc-FUNCTION to vc-BACKEND-FUNCTION. |
| 226 | |
| 227 | (defun vc-make-backend-sym (backend sym) |
| 228 | "Return BACKEND-specific version of VC symbol SYM." |
| 229 | (intern (concat "vc-" (downcase (symbol-name backend)) |
| 230 | "-" (symbol-name sym)))) |
| 231 | |
| 232 | (defun vc-find-backend-function (backend fun) |
| 233 | "Return BACKEND-specific implementation of FUN. |
| 234 | If there is no such implementation, return the default implementation; |
| 235 | if that doesn't exist either, return nil." |
| 236 | (let ((f (vc-make-backend-sym backend fun))) |
| 237 | (if (fboundp f) f |
| 238 | ;; Load vc-BACKEND.el if needed. |
| 239 | (require (intern (concat "vc-" (downcase (symbol-name backend))))) |
| 240 | (if (fboundp f) f |
| 241 | (let ((def (vc-make-backend-sym 'default fun))) |
| 242 | (if (fboundp def) (cons def backend) nil)))))) |
| 243 | |
| 244 | (defun vc-call-backend (backend function-name &rest args) |
| 245 | "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS. |
| 246 | Calls |
| 247 | |
| 248 | (apply 'vc-BACKEND-FUN ARGS) |
| 249 | |
| 250 | if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el) |
| 251 | and else calls |
| 252 | |
| 253 | (apply 'vc-default-FUN BACKEND ARGS) |
| 254 | |
| 255 | It is usually called via the `vc-call' macro." |
| 256 | (let ((f (assoc function-name (get backend 'vc-functions)))) |
| 257 | (if f (setq f (cdr f)) |
| 258 | (setq f (vc-find-backend-function backend function-name)) |
| 259 | (push (cons function-name f) (get backend 'vc-functions))) |
| 260 | (cond |
| 261 | ((null f) |
| 262 | (error "Sorry, %s is not implemented for %s" function-name backend)) |
| 263 | ((consp f) (apply (car f) (cdr f) args)) |
| 264 | (t (apply f args))))) |
| 265 | |
| 266 | (defmacro vc-call (fun file &rest args) |
| 267 | ;; BEWARE!! `file' is evaluated twice!! |
| 268 | `(vc-call-backend (vc-backend ,file) ',fun ,file ,@args)) |
| 269 | \f |
| 270 | (defsubst vc-parse-buffer (pattern i) |
| 271 | "Find PATTERN in the current buffer and return its Ith submatch." |
| 272 | (goto-char (point-min)) |
| 273 | (if (re-search-forward pattern nil t) |
| 274 | (match-string i))) |
| 275 | |
| 276 | (defun vc-insert-file (file &optional limit blocksize) |
| 277 | "Insert the contents of FILE into the current buffer. |
| 278 | |
| 279 | Optional argument LIMIT is a regexp. If present, the file is inserted |
| 280 | in chunks of size BLOCKSIZE (default 8 kByte), until the first |
| 281 | occurrence of LIMIT is found. Anything from the start of that occurrence |
| 282 | to the end of the buffer is then deleted. The function returns |
| 283 | non-nil if FILE exists and its contents were successfully inserted." |
| 284 | (erase-buffer) |
| 285 | (when (file-exists-p file) |
| 286 | (if (not limit) |
| 287 | (insert-file-contents file) |
| 288 | (if (not blocksize) (setq blocksize 8192)) |
| 289 | (let ((filepos 0)) |
| 290 | (while |
| 291 | (and (< 0 (cadr (insert-file-contents |
| 292 | file nil filepos (incf filepos blocksize)))) |
| 293 | (progn (beginning-of-line) |
| 294 | (let ((pos (re-search-forward limit nil 'move))) |
| 295 | (if pos (delete-region (match-beginning 0) |
| 296 | (point-max))) |
| 297 | (not pos))))))) |
| 298 | (set-buffer-modified-p nil) |
| 299 | t)) |
| 300 | |
| 301 | ;; Access functions to file properties |
| 302 | ;; (Properties should be _set_ using vc-file-setprop, but |
| 303 | ;; _retrieved_ only through these functions, which decide |
| 304 | ;; if the property is already known or not. A property should |
| 305 | ;; only be retrieved by vc-file-getprop if there is no |
| 306 | ;; access function.) |
| 307 | |
| 308 | ;; properties indicating the backend being used for FILE |
| 309 | |
| 310 | (defun vc-registered (file) |
| 311 | "Return non-nil if FILE is registered in a version control system. |
| 312 | |
| 313 | This function performs the check each time it is called. To rely |
| 314 | on the result of a previous call, use `vc-backend' instead. If the |
| 315 | file was previously registered under a certain backend, then that |
| 316 | backend is tried first." |
| 317 | (let (handler) |
| 318 | (if (boundp 'file-name-handler-alist) |
| 319 | (setq handler (find-file-name-handler file 'vc-registered))) |
| 320 | (if handler |
| 321 | ;; handler should set vc-backend and return t if registered |
| 322 | (funcall handler 'vc-registered file) |
| 323 | ;; There is no file name handler. |
| 324 | ;; Try vc-BACKEND-registered for each handled BACKEND. |
| 325 | (catch 'found |
| 326 | (let ((backend (vc-file-getprop file 'vc-backend))) |
| 327 | (mapcar |
| 328 | (lambda (b) |
| 329 | (and (vc-call-backend b 'registered file) |
| 330 | (vc-file-setprop file 'vc-backend b) |
| 331 | (throw 'found t))) |
| 332 | (if (or (not backend) (eq backend 'none)) |
| 333 | vc-handled-backends |
| 334 | (cons backend vc-handled-backends)))) |
| 335 | ;; File is not registered. |
| 336 | (vc-file-setprop file 'vc-backend 'none) |
| 337 | nil)))) |
| 338 | |
| 339 | (defun vc-backend (file) |
| 340 | "Return the version control type of FILE, nil if it is not registered." |
| 341 | ;; `file' can be nil in several places (typically due to the use of |
| 342 | ;; code like (vc-backend buffer-file-name)). |
| 343 | (when (stringp file) |
| 344 | (let ((property (vc-file-getprop file 'vc-backend))) |
| 345 | ;; Note that internally, Emacs remembers unregistered |
| 346 | ;; files by setting the property to `none'. |
| 347 | (cond ((eq property 'none) nil) |
| 348 | (property) |
| 349 | ;; vc-registered sets the vc-backend property |
| 350 | (t (if (vc-registered file) |
| 351 | (vc-file-getprop file 'vc-backend) |
| 352 | nil)))))) |
| 353 | |
| 354 | (defun vc-backend-subdirectory-name (file) |
| 355 | "Return where the master and lock FILEs for the current directory are kept." |
| 356 | (symbol-name (vc-backend file))) |
| 357 | |
| 358 | (defun vc-name (file) |
| 359 | "Return the master name of FILE. |
| 360 | If the file is not registered, or the master name is not known, return nil." |
| 361 | ;; TODO: This should ultimately become obsolete, at least up here |
| 362 | ;; in vc-hooks. |
| 363 | (or (vc-file-getprop file 'vc-name) |
| 364 | ;; force computation of the property by calling |
| 365 | ;; vc-BACKEND-registered explicitly |
| 366 | (if (and (vc-backend file) |
| 367 | (vc-call-backend (vc-backend file) 'registered file)) |
| 368 | (vc-file-getprop file 'vc-name)))) |
| 369 | |
| 370 | (defun vc-checkout-model (file) |
| 371 | "Indicate how FILE is checked out. |
| 372 | |
| 373 | If FILE is not registered, this function always returns nil. |
| 374 | For registered files, the possible values are: |
| 375 | |
| 376 | 'implicit FILE is always writeable, and checked out `implicitly' |
| 377 | when the user saves the first changes to the file. |
| 378 | |
| 379 | 'locking FILE is read-only if up-to-date; user must type |
| 380 | \\[vc-next-action] before editing. Strict locking |
| 381 | is assumed. |
| 382 | |
| 383 | 'announce FILE is read-only if up-to-date; user must type |
| 384 | \\[vc-next-action] before editing. But other users |
| 385 | may be editing at the same time." |
| 386 | (or (vc-file-getprop file 'vc-checkout-model) |
| 387 | (if (vc-backend file) |
| 388 | (vc-file-setprop file 'vc-checkout-model |
| 389 | (vc-call checkout-model file))))) |
| 390 | |
| 391 | (defun vc-user-login-name (&optional uid) |
| 392 | "Return the name under which the user is logged in, as a string. |
| 393 | \(With optional argument UID, return the name of that user.) |
| 394 | This function does the same as function `user-login-name', but unlike |
| 395 | that, it never returns nil. If a UID cannot be resolved, that |
| 396 | UID is returned as a string." |
| 397 | (or (user-login-name uid) |
| 398 | (number-to-string (or uid (user-uid))))) |
| 399 | |
| 400 | (defun vc-state (file) |
| 401 | "Return the version control state of FILE. |
| 402 | |
| 403 | If FILE is not registered, this function always returns nil. |
| 404 | For registered files, the value returned is one of: |
| 405 | |
| 406 | 'up-to-date The working file is unmodified with respect to the |
| 407 | latest version on the current branch, and not locked. |
| 408 | |
| 409 | 'edited The working file has been edited by the user. If |
| 410 | locking is used for the file, this state means that |
| 411 | the current version is locked by the calling user. |
| 412 | |
| 413 | USER The current version of the working file is locked by |
| 414 | some other USER (a string). |
| 415 | |
| 416 | 'needs-patch The file has not been edited by the user, but there is |
| 417 | a more recent version on the current branch stored |
| 418 | in the master file. |
| 419 | |
| 420 | 'needs-merge The file has been edited by the user, and there is also |
| 421 | a more recent version on the current branch stored in |
| 422 | the master file. This state can only occur if locking |
| 423 | is not used for the file. |
| 424 | |
| 425 | 'unlocked-changes The current version of the working file is not locked, |
| 426 | but the working file has been changed with respect |
| 427 | to that version. This state can only occur for files |
| 428 | with locking; it represents an erroneous condition that |
| 429 | should be resolved by the user (vc-next-action will |
| 430 | prompt the user to do it)." |
| 431 | ;; FIXME: New (sub)states needed (?): |
| 432 | ;; - `added' (i.e. `edited' but with no base version yet, |
| 433 | ;; typically represented by vc-workfile-version = "0") |
| 434 | ;; - `conflict' (i.e. `edited' with conflict markers) |
| 435 | ;; - `removed' |
| 436 | ;; - `copied' and `moved' (might be handled by `removed' and `added') |
| 437 | (or (vc-file-getprop file 'vc-state) |
| 438 | (if (vc-backend file) |
| 439 | (vc-file-setprop file 'vc-state |
| 440 | (vc-call state-heuristic file))))) |
| 441 | |
| 442 | (defsubst vc-up-to-date-p (file) |
| 443 | "Convenience function that checks whether `vc-state' of FILE is `up-to-date'." |
| 444 | (eq (vc-state file) 'up-to-date)) |
| 445 | |
| 446 | (defun vc-default-state-heuristic (backend file) |
| 447 | "Default implementation of vc-state-heuristic. |
| 448 | It simply calls the real state computation function `vc-BACKEND-state' |
| 449 | and does not employ any heuristic at all." |
| 450 | (vc-call-backend backend 'state file)) |
| 451 | |
| 452 | (defun vc-workfile-unchanged-p (file) |
| 453 | "Return non-nil if FILE has not changed since the last checkout." |
| 454 | (let ((checkout-time (vc-file-getprop file 'vc-checkout-time)) |
| 455 | (lastmod (nth 5 (file-attributes file)))) |
| 456 | (if checkout-time |
| 457 | (equal checkout-time lastmod) |
| 458 | (let ((unchanged (vc-call workfile-unchanged-p file))) |
| 459 | (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0)) |
| 460 | unchanged)))) |
| 461 | |
| 462 | (defun vc-default-workfile-unchanged-p (backend file) |
| 463 | "Check if FILE is unchanged by diffing against the master version. |
| 464 | Return non-nil if FILE is unchanged." |
| 465 | (zerop (condition-case err |
| 466 | ;; If the implementation supports it, let the output |
| 467 | ;; go to *vc*, not *vc-diff*, since this is an internal call. |
| 468 | (vc-call diff file nil nil "*vc*") |
| 469 | (wrong-number-of-arguments |
| 470 | ;; If this error came from the above call to vc-BACKEND-diff, |
| 471 | ;; try again without the optional buffer argument (for |
| 472 | ;; backward compatibility). Otherwise, resignal. |
| 473 | (if (or (not (eq (cadr err) |
| 474 | (indirect-function |
| 475 | (vc-find-backend-function (vc-backend file) |
| 476 | 'diff)))) |
| 477 | (not (eq (caddr err) 4))) |
| 478 | (signal (car err) (cdr err)) |
| 479 | (vc-call diff file)))))) |
| 480 | |
| 481 | (defun vc-workfile-version (file) |
| 482 | "Return the version level of the current workfile FILE. |
| 483 | If FILE is not registered, this function always returns nil." |
| 484 | (or (vc-file-getprop file 'vc-workfile-version) |
| 485 | (if (vc-backend file) |
| 486 | (vc-file-setprop file 'vc-workfile-version |
| 487 | (vc-call workfile-version file))))) |
| 488 | |
| 489 | (defun vc-default-registered (backend file) |
| 490 | "Check if FILE is registered in BACKEND using vc-BACKEND-master-templates." |
| 491 | (let ((sym (vc-make-backend-sym backend 'master-templates))) |
| 492 | (unless (get backend 'vc-templates-grabbed) |
| 493 | (put backend 'vc-templates-grabbed t) |
| 494 | (set sym (append (delq nil |
| 495 | (mapcar |
| 496 | (lambda (template) |
| 497 | (and (consp template) |
| 498 | (eq (cdr template) backend) |
| 499 | (car template))) |
| 500 | (with-no-warnings |
| 501 | vc-master-templates))) |
| 502 | (symbol-value sym)))) |
| 503 | (let ((result (vc-check-master-templates file (symbol-value sym)))) |
| 504 | (if (stringp result) |
| 505 | (vc-file-setprop file 'vc-name result) |
| 506 | nil)))) ; Not registered |
| 507 | |
| 508 | (defun vc-possible-master (s dirname basename) |
| 509 | (cond |
| 510 | ((stringp s) (format s dirname basename)) |
| 511 | ((functionp s) |
| 512 | ;; The template is a function to invoke. If the |
| 513 | ;; function returns non-nil, that means it has found a |
| 514 | ;; master. For backward compatibility, we also handle |
| 515 | ;; the case that the function throws a 'found atom |
| 516 | ;; and a pair (cons MASTER-FILE BACKEND). |
| 517 | (let ((result (catch 'found (funcall s dirname basename)))) |
| 518 | (if (consp result) (car result) result))))) |
| 519 | |
| 520 | (defun vc-check-master-templates (file templates) |
| 521 | "Return non-nil if there is a master corresponding to FILE. |
| 522 | |
| 523 | TEMPLATES is a list of strings or functions. If an element is a |
| 524 | string, it must be a control string as required by `format', with two |
| 525 | string placeholders, such as \"%sRCS/%s,v\". The directory part of |
| 526 | FILE is substituted for the first placeholder, the basename of FILE |
| 527 | for the second. If a file with the resulting name exists, it is taken |
| 528 | as the master of FILE, and returned. |
| 529 | |
| 530 | If an element of TEMPLATES is a function, it is called with the |
| 531 | directory part and the basename of FILE as arguments. It should |
| 532 | return non-nil if it finds a master; that value is then returned by |
| 533 | this function." |
| 534 | (let ((dirname (or (file-name-directory file) "")) |
| 535 | (basename (file-name-nondirectory file))) |
| 536 | (catch 'found |
| 537 | (mapcar |
| 538 | (lambda (s) |
| 539 | (let ((trial (vc-possible-master s dirname basename))) |
| 540 | (if (and trial (file-exists-p trial) |
| 541 | ;; Make sure the file we found with name |
| 542 | ;; TRIAL is not the source file itself. |
| 543 | ;; That can happen with RCS-style names if |
| 544 | ;; the file name is truncated (e.g. to 14 |
| 545 | ;; chars). See if either directory or |
| 546 | ;; attributes differ. |
| 547 | (or (not (string= dirname |
| 548 | (file-name-directory trial))) |
| 549 | (not (equal (file-attributes file) |
| 550 | (file-attributes trial))))) |
| 551 | (throw 'found trial)))) |
| 552 | templates)))) |
| 553 | |
| 554 | (defun vc-toggle-read-only (&optional verbose) |
| 555 | "Change read-only status of current buffer, perhaps via version control. |
| 556 | |
| 557 | If the buffer is visiting a file registered with version control, |
| 558 | then check the file in or out. Otherwise, just change the read-only flag |
| 559 | of the buffer. |
| 560 | With prefix argument, ask for version number to check in or check out. |
| 561 | Check-out of a specified version number does not lock the file; |
| 562 | to do that, use this command a second time with no argument. |
| 563 | |
| 564 | If you bind this function to \\[toggle-read-only], then Emacs checks files |
| 565 | in or out whenever you toggle the read-only flag." |
| 566 | (interactive "P") |
| 567 | (if (or (and (boundp 'vc-dired-mode) vc-dired-mode) |
| 568 | ;; use boundp because vc.el might not be loaded |
| 569 | (vc-backend buffer-file-name)) |
| 570 | (vc-next-action verbose) |
| 571 | (toggle-read-only))) |
| 572 | |
| 573 | (defun vc-default-make-version-backups-p (backend file) |
| 574 | "Return non-nil if unmodified versions should be backed up locally. |
| 575 | The default is to switch off this feature." |
| 576 | nil) |
| 577 | |
| 578 | (defun vc-version-backup-file-name (file &optional rev manual regexp) |
| 579 | "Return a backup file name for REV or the current version of FILE. |
| 580 | If MANUAL is non-nil it means that a name for backups created by |
| 581 | the user should be returned; if REGEXP is non-nil that means to return |
| 582 | a regexp for matching all such backup files, regardless of the version." |
| 583 | (if regexp |
| 584 | (concat (regexp-quote (file-name-nondirectory file)) |
| 585 | "\\.~[0-9.]+" (unless manual "\\.") "~") |
| 586 | (expand-file-name (concat (file-name-nondirectory file) |
| 587 | ".~" (or rev (vc-workfile-version file)) |
| 588 | (unless manual ".") "~") |
| 589 | (file-name-directory file)))) |
| 590 | |
| 591 | (defun vc-delete-automatic-version-backups (file) |
| 592 | "Delete all existing automatic version backups for FILE." |
| 593 | (condition-case nil |
| 594 | (mapcar |
| 595 | 'delete-file |
| 596 | (directory-files (or (file-name-directory file) default-directory) t |
| 597 | (vc-version-backup-file-name file nil nil t))) |
| 598 | ;; Don't fail when the directory doesn't exist. |
| 599 | (file-error nil))) |
| 600 | |
| 601 | (defun vc-make-version-backup (file) |
| 602 | "Make a backup copy of FILE, which is assumed in sync with the repository. |
| 603 | Before doing that, check if there are any old backups and get rid of them." |
| 604 | (unless (and (fboundp 'msdos-long-file-names) |
| 605 | (not (with-no-warnings (msdos-long-file-names)))) |
| 606 | (vc-delete-automatic-version-backups file) |
| 607 | (copy-file file (vc-version-backup-file-name file) |
| 608 | nil 'keep-date))) |
| 609 | |
| 610 | (defun vc-before-save () |
| 611 | "Function to be called by `basic-save-buffer' (in files.el)." |
| 612 | ;; If the file on disk is still in sync with the repository, |
| 613 | ;; and version backups should be made, copy the file to |
| 614 | ;; another name. This enables local diffs and local reverting. |
| 615 | (let ((file buffer-file-name)) |
| 616 | (and (vc-backend file) |
| 617 | (vc-up-to-date-p file) |
| 618 | (eq (vc-checkout-model file) 'implicit) |
| 619 | (vc-call make-version-backups-p file) |
| 620 | (vc-make-version-backup file)))) |
| 621 | |
| 622 | (defun vc-after-save () |
| 623 | "Function to be called by `basic-save-buffer' (in files.el)." |
| 624 | ;; If the file in the current buffer is under version control, |
| 625 | ;; up-to-date, and locking is not used for the file, set |
| 626 | ;; the state to 'edited and redisplay the mode line. |
| 627 | (let ((file buffer-file-name)) |
| 628 | (and (vc-backend file) |
| 629 | (or (and (equal (vc-file-getprop file 'vc-checkout-time) |
| 630 | (nth 5 (file-attributes file))) |
| 631 | ;; File has been saved in the same second in which |
| 632 | ;; it was checked out. Clear the checkout-time |
| 633 | ;; to avoid confusion. |
| 634 | (vc-file-setprop file 'vc-checkout-time nil)) |
| 635 | t) |
| 636 | (vc-up-to-date-p file) |
| 637 | (eq (vc-checkout-model file) 'implicit) |
| 638 | (vc-file-setprop file 'vc-state 'edited) |
| 639 | (vc-mode-line file) |
| 640 | (if (featurep 'vc) |
| 641 | ;; If VC is not loaded, then there can't be |
| 642 | ;; any VC Dired buffer to synchronize. |
| 643 | (vc-dired-resynch-file file))))) |
| 644 | |
| 645 | (defun vc-mode-line (file) |
| 646 | "Set `vc-mode' to display type of version control for FILE. |
| 647 | The value is set in the current buffer, which should be the buffer |
| 648 | visiting FILE." |
| 649 | (interactive (list buffer-file-name)) |
| 650 | (let ((backend (vc-backend file))) |
| 651 | (if (not backend) |
| 652 | (setq vc-mode nil) |
| 653 | (setq vc-mode (concat " " (if vc-display-status |
| 654 | (vc-call mode-line-string file) |
| 655 | (symbol-name backend)))) |
| 656 | ;; If the file is locked by some other user, make |
| 657 | ;; the buffer read-only. Like this, even root |
| 658 | ;; cannot modify a file that someone else has locked. |
| 659 | (and (equal file buffer-file-name) |
| 660 | (stringp (vc-state file)) |
| 661 | (setq buffer-read-only t)) |
| 662 | ;; If the user is root, and the file is not owner-writable, |
| 663 | ;; then pretend that we can't write it |
| 664 | ;; even though we can (because root can write anything). |
| 665 | ;; This way, even root cannot modify a file that isn't locked. |
| 666 | (and (equal file buffer-file-name) |
| 667 | (not buffer-read-only) |
| 668 | (zerop (user-real-uid)) |
| 669 | (zerop (logand (file-modes buffer-file-name) 128)) |
| 670 | (setq buffer-read-only t))) |
| 671 | (force-mode-line-update) |
| 672 | backend)) |
| 673 | |
| 674 | (defun vc-default-mode-line-string (backend file) |
| 675 | "Return string for placement in modeline by `vc-mode-line' for FILE. |
| 676 | Format: |
| 677 | |
| 678 | \"BACKEND-REV\" if the file is up-to-date |
| 679 | \"BACKEND:REV\" if the file is edited (or locked by the calling user) |
| 680 | \"BACKEND:LOCKER:REV\" if the file is locked by somebody else |
| 681 | |
| 682 | This function assumes that the file is registered." |
| 683 | (setq backend (symbol-name backend)) |
| 684 | (let ((state (vc-state file)) |
| 685 | (rev (vc-workfile-version file))) |
| 686 | (cond ((or (eq state 'up-to-date) |
| 687 | (eq state 'needs-patch)) |
| 688 | (concat backend "-" rev)) |
| 689 | ((stringp state) |
| 690 | (concat backend ":" state ":" rev)) |
| 691 | (t |
| 692 | ;; Not just for the 'edited state, but also a fallback |
| 693 | ;; for all other states. Think about different symbols |
| 694 | ;; for 'needs-patch and 'needs-merge. |
| 695 | (concat backend ":" rev))))) |
| 696 | |
| 697 | (defun vc-follow-link () |
| 698 | "If current buffer visits a symbolic link, visit the real file. |
| 699 | If the real file is already visited in another buffer, make that buffer |
| 700 | current, and kill the buffer that visits the link." |
| 701 | (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name))) |
| 702 | (true-buffer (find-buffer-visiting truename)) |
| 703 | (this-buffer (current-buffer))) |
| 704 | (if (eq true-buffer this-buffer) |
| 705 | (progn |
| 706 | (kill-buffer this-buffer) |
| 707 | ;; In principle, we could do something like set-visited-file-name. |
| 708 | ;; However, it can't be exactly the same as set-visited-file-name. |
| 709 | ;; I'm not going to work out the details right now. -- rms. |
| 710 | (set-buffer (find-file-noselect truename))) |
| 711 | (set-buffer true-buffer) |
| 712 | (kill-buffer this-buffer)))) |
| 713 | |
| 714 | (defun vc-default-find-file-hook (backend) |
| 715 | nil) |
| 716 | |
| 717 | (defun vc-find-file-hook () |
| 718 | "Function for `find-file-hook' activating VC mode if appropriate." |
| 719 | ;; Recompute whether file is version controlled, |
| 720 | ;; if user has killed the buffer and revisited. |
| 721 | (if vc-mode |
| 722 | (setq vc-mode nil)) |
| 723 | (when buffer-file-name |
| 724 | (vc-file-clearprops buffer-file-name) |
| 725 | (cond |
| 726 | ((vc-backend buffer-file-name) |
| 727 | ;; Compute the state and put it in the modeline. |
| 728 | (vc-mode-line buffer-file-name) |
| 729 | (unless vc-make-backup-files |
| 730 | ;; Use this variable, not make-backup-files, |
| 731 | ;; because this is for things that depend on the file name. |
| 732 | (set (make-local-variable 'backup-inhibited) t)) |
| 733 | ;; Let the backend setup any buffer-local things he needs. |
| 734 | (vc-call-backend (vc-backend buffer-file-name) 'find-file-hook)) |
| 735 | ((let* ((link (file-symlink-p buffer-file-name)) |
| 736 | (link-type (and link (vc-backend (file-chase-links link))))) |
| 737 | (cond ((not link-type) nil) ;Nothing to do. |
| 738 | ((eq vc-follow-symlinks nil) |
| 739 | (message |
| 740 | "Warning: symbolic link to %s-controlled source file" link-type)) |
| 741 | ((or (not (eq vc-follow-symlinks 'ask)) |
| 742 | ;; If we already visited this file by following |
| 743 | ;; the link, don't ask again if we try to visit |
| 744 | ;; it again. GUD does that, and repeated questions |
| 745 | ;; are painful. |
| 746 | (get-file-buffer |
| 747 | (abbreviate-file-name |
| 748 | (file-chase-links buffer-file-name)))) |
| 749 | |
| 750 | (vc-follow-link) |
| 751 | (message "Followed link to %s" buffer-file-name) |
| 752 | (vc-find-file-hook)) |
| 753 | (t |
| 754 | (if (yes-or-no-p (format |
| 755 | "Symbolic link to %s-controlled source file; follow link? " link-type)) |
| 756 | (progn (vc-follow-link) |
| 757 | (message "Followed link to %s" buffer-file-name) |
| 758 | (vc-find-file-hook)) |
| 759 | (message |
| 760 | "Warning: editing through the link bypasses version control") |
| 761 | )))))))) |
| 762 | |
| 763 | (add-hook 'find-file-hook 'vc-find-file-hook) |
| 764 | |
| 765 | ;; more hooks, this time for file-not-found |
| 766 | (defun vc-file-not-found-hook () |
| 767 | "When file is not found, try to check it out from version control. |
| 768 | Returns t if checkout was successful, nil otherwise. |
| 769 | Used in `find-file-not-found-functions'." |
| 770 | ;; When a file does not exist, ignore cached info about it |
| 771 | ;; from a previous visit. |
| 772 | (vc-file-clearprops buffer-file-name) |
| 773 | (let ((backend (vc-backend buffer-file-name))) |
| 774 | (if backend (vc-call-backend backend 'find-file-not-found-hook)))) |
| 775 | |
| 776 | (defun vc-default-find-file-not-found-hook (backend) |
| 777 | (if (yes-or-no-p |
| 778 | (format "File %s was lost; check out from version control? " |
| 779 | (file-name-nondirectory buffer-file-name))) |
| 780 | (save-excursion |
| 781 | (require 'vc) |
| 782 | (setq default-directory (file-name-directory buffer-file-name)) |
| 783 | (not (vc-error-occurred (vc-checkout buffer-file-name)))))) |
| 784 | |
| 785 | (add-hook 'find-file-not-found-functions 'vc-file-not-found-hook) |
| 786 | |
| 787 | (defun vc-kill-buffer-hook () |
| 788 | "Discard VC info about a file when we kill its buffer." |
| 789 | (if buffer-file-name |
| 790 | (vc-file-clearprops buffer-file-name))) |
| 791 | |
| 792 | (add-hook 'kill-buffer-hook 'vc-kill-buffer-hook) |
| 793 | |
| 794 | ;; Now arrange for (autoloaded) bindings of the main package. |
| 795 | ;; Bindings for this have to go in the global map, as we'll often |
| 796 | ;; want to call them from random buffers. |
| 797 | |
| 798 | ;; Autoloading works fine, but it prevents shortcuts from appearing |
| 799 | ;; in the menu because they don't exist yet when the menu is built. |
| 800 | ;; (autoload 'vc-prefix-map "vc" nil nil 'keymap) |
| 801 | (defvar vc-prefix-map |
| 802 | (let ((map (make-sparse-keymap))) |
| 803 | (define-key map "a" 'vc-update-change-log) |
| 804 | (define-key map "b" 'vc-switch-backend) |
| 805 | (define-key map "c" 'vc-cancel-version) |
| 806 | (define-key map "d" 'vc-directory) |
| 807 | (define-key map "g" 'vc-annotate) |
| 808 | (define-key map "h" 'vc-insert-headers) |
| 809 | (define-key map "i" 'vc-register) |
| 810 | (define-key map "l" 'vc-print-log) |
| 811 | (define-key map "m" 'vc-merge) |
| 812 | (define-key map "r" 'vc-retrieve-snapshot) |
| 813 | (define-key map "s" 'vc-create-snapshot) |
| 814 | (define-key map "u" 'vc-revert-buffer) |
| 815 | (define-key map "v" 'vc-next-action) |
| 816 | (define-key map "=" 'vc-diff) |
| 817 | (define-key map "~" 'vc-version-other-window) |
| 818 | map)) |
| 819 | (fset 'vc-prefix-map vc-prefix-map) |
| 820 | (define-key global-map "\C-xv" 'vc-prefix-map) |
| 821 | |
| 822 | (if (not (boundp 'vc-menu-map)) |
| 823 | ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar |
| 824 | ;; vc-menu-map. |
| 825 | () |
| 826 | ;;(define-key vc-menu-map [show-files] |
| 827 | ;; '("Show Files under VC" . (vc-directory t))) |
| 828 | (define-key vc-menu-map [vc-retrieve-snapshot] |
| 829 | '("Retrieve Snapshot" . vc-retrieve-snapshot)) |
| 830 | (define-key vc-menu-map [vc-create-snapshot] |
| 831 | '("Create Snapshot" . vc-create-snapshot)) |
| 832 | (define-key vc-menu-map [vc-directory] '("VC Directory Listing" . vc-directory)) |
| 833 | (define-key vc-menu-map [separator1] '("----")) |
| 834 | (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate)) |
| 835 | (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file)) |
| 836 | (define-key vc-menu-map [vc-version-other-window] |
| 837 | '("Show Other Version" . vc-version-other-window)) |
| 838 | (define-key vc-menu-map [vc-diff] '("Compare with Base Version" . vc-diff)) |
| 839 | (define-key vc-menu-map [vc-update-change-log] |
| 840 | '("Update ChangeLog" . vc-update-change-log)) |
| 841 | (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log)) |
| 842 | (define-key vc-menu-map [separator2] '("----")) |
| 843 | (define-key vc-menu-map [vc-insert-header] |
| 844 | '("Insert Header" . vc-insert-headers)) |
| 845 | (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version)) |
| 846 | (define-key vc-menu-map [vc-revert-buffer] |
| 847 | '("Revert to Base Version" . vc-revert-buffer)) |
| 848 | (define-key vc-menu-map [vc-update] |
| 849 | '("Update to Latest Version" . vc-update)) |
| 850 | (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action)) |
| 851 | (define-key vc-menu-map [vc-register] '("Register" . vc-register))) |
| 852 | |
| 853 | ;; These are not correct and it's not currently clear how doing it |
| 854 | ;; better (with more complicated expressions) might slow things down |
| 855 | ;; on older systems. |
| 856 | |
| 857 | ;;(put 'vc-rename-file 'menu-enable 'vc-mode) |
| 858 | ;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS)) |
| 859 | ;;(put 'vc-version-other-window 'menu-enable 'vc-mode) |
| 860 | ;;(put 'vc-diff 'menu-enable 'vc-mode) |
| 861 | ;;(put 'vc-update-change-log 'menu-enable |
| 862 | ;; '(member (vc-buffer-backend) '(RCS CVS))) |
| 863 | ;;(put 'vc-print-log 'menu-enable 'vc-mode) |
| 864 | ;;(put 'vc-cancel-version 'menu-enable 'vc-mode) |
| 865 | ;;(put 'vc-revert-buffer 'menu-enable 'vc-mode) |
| 866 | ;;(put 'vc-insert-headers 'menu-enable 'vc-mode) |
| 867 | ;;(put 'vc-next-action 'menu-enable 'vc-mode) |
| 868 | ;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode))) |
| 869 | |
| 870 | (provide 'vc-hooks) |
| 871 | |
| 872 | ;;; arch-tag: 2e5a6fa7-1d30-48e2-8bd0-e3d335f04f32 |
| 873 | ;;; vc-hooks.el ends here |