| blob | 38b91ddef85057cd1d8115a68efe10bce46e796a |
1 ;;; vc-hooks.el --- resident support for version-control
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Modified by:
7 ;; Per Cederqvist <ceder@lysator.liu.se>
8 ;; Andre Spiegel <spiegel@berlin.informatik.uni-stuttgart.de>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This is the always-loaded portion of VC.
30 ;; It takes care VC-related activities that are done when you visit a file,
31 ;; so that vc.el itself is loaded only when you use a VC command.
32 ;; See the commentary of vc.el.
34 ;;; Code:
36 ;; Customization Variables (the rest is in vc.el)
39 "*Back-end actually used by this interface; may be SCCS or RCS.
43 "*If non-nil, use VC for files managed with CVS.
47 "*Indicates whether rcsdiff understands the --brief option.
48 The value is either `yes', `no', or nil. If it is nil, VC tries
54 nil)
60 vc-find-cvs-master)
61 "*Where to look for version-control master files.
62 The first pair corresponding to a given back end is used as a template
66 "*If non-nil, backups of registered files are made as with other files.
70 "*Indicates what to do if you visit a symbolic link to a file
71 that is under version control. Editing such a file through the
72 link bypasses the version control system, which is dangerous and
73 probably not what you want.
74 If this variable is t, VC follows the link and visits the real file,
75 telling you about it in the echo area. If it is `ask', VC asks for
76 confirmation whether it should follow the link. If nil, the link is
80 "*If non-nil, display revision number and lock status in modeline.
87 "*If non-nil, don't delete working files after registering changes.
88 If the back-end is CVS, workfiles are always kept, regardless of the
92 "*If non-nil, don't assume that permissions and ownership track
93 version-control status. If nil, do rely on the permissions.
97 ;; Access function to the above.
103 ;; Tell Emacs about this new kind of minor mode
106 minor-mode-alist)))
111 ;; We need a notion of per-file properties because the version
112 ;; control state of a file is expensive to derive --- we compute
113 ;; them when the file is initially found, keep them up to date
114 ;; during any subsequent VC operations, and forget them when
115 ;; the buffer is killed.
127 ;; set per-file property
131 ;; get per-file property
135 ;; clear all properties of a given file
138 ;;; Functions that determine property values, by examining the
139 ;;; working file, the master file, or log program output
145 ;; Generate lock file name corresponding to FILE
148 master
152 "p."
156 ;; Use PATTERNS to parse information out of the current buffer.
157 ;; Each element of PATTERNS is a list of 2 to 3 elements. The first element
158 ;; is the pattern to be matched, and the second (an integer) is the
159 ;; number of the subexpression that should be returned. If there's
160 ;; a third element (also the number of a subexpression), that
161 ;; subexpression is assumed to be a date field and we want the most
162 ;; recent entry matching the template.
163 ;; If FILE and PROPERTIES are given, the latter must be a list of
164 ;; properties of the same length as PATTERNS; each property is assigned
165 ;; the corresponding value.
176 value))
189 latest-val)))))
190 patterns)
191 )
194 ;; Insert the contents of FILE into the current buffer.
195 ;; Optional argument LIMIT is a regexp. If present,
196 ;; the file is inserted in chunks of size BLOCKSIZE
197 ;; (default 8 kByte), until the first occurrence of
198 ;; LIMIT is found. The function returns nil if FILE
199 ;; doesn't exist.
217 t)
221 ;; Parse RCS or SCCS locks.
222 ;; The result is a list of the form ((VERSION USER) (VERSION USER) ...),
223 ;; which is returned and stored into the property `vc-master-locks'.
229 locks index)
239 locks index)
253 ;; Simple version of vc-do-command, for use in vc-hooks only.
254 ;; Don't switch to the *vc-info* buffer before running the
255 ;; command, because that would change its default directory
259 ;; Add vc-path to PATH for the execution of this command.
262 path-separator
264 process-environment)))
273 exec-status))
276 ;; Fetch those properties of FILE that are stored in the master file.
277 ;; For an RCS file, we don't get vc-latest-version vc-your-latest-version
278 ;; here because that is slow.
279 ;; That gets done if/when the functions vc-latest-version
280 ;; and vc-your-latest-version get called.
293 file
303 file
305 vc-default-branch
306 vc-master-locks))
307 ;; determine vc-master-workfile-version: it is either the head
308 ;; of the trunk, the head of the default branch, or the
309 ;; "default branch" itself, if that is a full revision number.
312 ;; no default branch
316 ;; default branch is actually a revision
318 default-branch)
320 ;; else, search for the head of the default branch
327 ;; translate the locks
332 ;; Call "cvs status" in the right directory, passing only the
333 ;; nondirectory part of the file name -- otherwise CVS might
334 ;; silently give a wrong result.
339 ;; CVS 1.3 says "RCS Version:", other releases "RCS Revision:",
340 ;; and CVS 1.4a1 says "Repository revision:".
343 file
345 ;; Translate those status values that we understand into symbols.
346 ;; Any other value is converted to nil.
362 ))))))))
366 ;;; Functions that determine property values, by examining the
367 ;;; working file, the master file, or log program output
370 ;; Search for RCS headers in FILE, and set properties
371 ;; accordingly. This function can be disabled by setting
372 ;; vc-consult-headers to nil.
373 ;; Returns: nil if no headers were found
374 ;; (or if the feature is disabled,
375 ;; or if there is currently no buffer
376 ;; visiting FILE)
377 ;; 'rev if a workfile revision was found
378 ;; 'rev-and-lock if revision and lock info was found
387 ;; search for $Id or $Header
388 ;; -------------------------
395 ;; if found, store the revision number ...
398 ;; ... and check for the locking state
406 ;; unlocked revision
410 ;; revision is locked by some user
416 ;; everything else: false
418 ;; unexpected information in
419 ;; keyword string --> quit
421 ;; search for $Revision
422 ;; --------------------
425 nil t)
426 ;; if found, store the revision number ...
429 ;; and see if there's any lock information
444 ;; else: nothing found
445 ;; -------------------
451 ;; If the file has headers, we don't want to query the master file,
452 ;; because that would eliminate all the performance gain the headers
453 ;; brought us. We therefore use a heuristic for the checkout model
454 ;; now: If we trust the file permissions, and the file is not
455 ;; locked, then if the file is read-only the checkout model is
456 ;; `manual', otherwise `implicit'.
462 status))))
464 ;;; Access functions to file properties
465 ;;; (Properties should be _set_ using vc-file-setprop, but
466 ;;; _retrieved_ only through these functions, which decide
467 ;;; if the property is already known or not. A property should
468 ;;; only be retrieved by vc-file-getprop if there is no
469 ;;; access function.)
471 ;;; properties indicating the backend
472 ;;; being used for FILE
475 ;; Where the master and lock files for the current directory are kept
479 vc-default-back-end
483 "Return the master name of a file, nil if it is not registered.
484 For CVS, the full name of CVS/Entries is returned."
493 "Return the version-control type of a file, nil if it is not registered."
503 ;; Return `manual' if the user has to type C-x C-q to check out FILE.
504 ;; Return `implicit' if the file can be modified without locking it first.
519 ;;; properties indicating the locking state
522 ;; Return the cvs status of FILE
523 ;; (Status field in output of "cvs status")
529 ;; Return the lock entries in the master of FILE.
530 ;; Return 'none if there are no such entries, and a list
531 ;; of the form ((VERSION USER) (VERSION USER) ...) otherwise.
537 ;; Return the master file's idea of who is locking
538 ;; the current workfile version of FILE.
539 ;; Return 'none if it is not locked.
542 ;; search for a lock on the current workfile version
548 ;; If the permissions can be trusted for this file, determine the
549 ;; locking state from them. Returns (user-login-name), `none', or nil.
550 ;; This implementation assumes that any file which is under version
551 ;; control and has -rw-r--r-- is locked by its owner. This is true
552 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
553 ;; We have to be careful not to exclude files with execute bits on;
554 ;; scripts can be under version control too. Also, we must ignore the
555 ;; group-read and other-read bits, since paranoid users turn them off.
556 ;; This hack wins because calls to the somewhat expensive
557 ;; `vc-fetch-master-properties' function only have to be made if
558 ;; (a) the file is locked by someone other than the current user,
559 ;; or (b) some untoward manipulation behind vc's back has changed
560 ;; the owner or the `group' or `other' write bits.
571 ;; The expression below should return the username of the owner
572 ;; of the file. It doesn't. It returns the username if it is
573 ;; you, or otherwise the UID of the owner of the file. The
574 ;; return value from this function is only used by
575 ;; vc-dired-reformat-line, and it does the proper thing if a UID
576 ;; is returned.
577 ;; The *proper* way to fix this would be to implement a built-in
578 ;; function in Emacs, say, (username UID), that returns the
579 ;; username of a given UID.
580 ;; The result of this hack is that vc-directory will print the
581 ;; name of the owner of the file for any files that are
582 ;; modified.
587 ;; Diff the file against the master version. If differences are found,
588 ;; mark the file locked. This is only used for RCS with non-strict
589 ;; locking. (If "rcsdiff" doesn't understand --brief, we do a double-take
590 ;; and remember the fact for the future.)
606 ;; Return the name of the person currently holding a lock on FILE.
607 ;; Return nil if there is no such person. (Sometimes, not the name
608 ;; of the locking user but his uid will be returned.)
609 ;; Under CVS, a file is considered locked if it has been modified since
610 ;; it was checked out.
611 ;; The property is cached. It is only looked up if it is currently nil.
612 ;; Note that, for a file that is not locked, the actual property value
613 ;; is `none', to distinguish it from an unknown locking state. That value
614 ;; is converted to nil by this function, and returned to the caller.
617 ;; if we already know the property, return it
620 ;; otherwise, infer the property...
636 ;; Check for RCS headers first
639 ;; If there are no headers, try to learn it
640 ;; from the permissions.
644 ;; If the permissions say "not locked", we know
645 ;; that the checkout model must be `manual'.
648 ;; If the permissions say "locked", we can only trust
649 ;; this *if* the checkout model is `manual'.
652 ;; Otherwise, use lock information from the master file.
656 ;; Finally, if the file is not explicitly locked
657 ;; it might still be locked implicitly.
667 ;; convert a possible 'none value
671 ;;; properties to store current and recent version numbers
674 ;; Return version level of the latest version of FILE
680 ;; Return version level of the latest version of FILE checked in by you
686 ;; Return the master file's idea of what is the current workfile version.
687 ;; This property is defined for RCS only.
693 ;; Fetch vc-latest-version and vc-your-latest-version
694 ;; if that wasn't already done.
706 file
711 ))
714 ;; Return version level of the current workfile FILE
715 ;; This is attempted by first looking at the RCS keywords.
716 ;; If there are no keywords in the working file,
717 ;; vc-master-workfile-version is taken.
718 ;; Note that this property is cached, that is, it is only
719 ;; looked up if it is nil.
720 ;; For SCCS, this property is equivalent to vc-latest-version.
729 rev)))
738 ;;; actual version-control code starts here
746 ;; Search for a master corresponding to the given file
756 ;; Make sure the file we found with name
757 ;; TRIAL is not the source file itself.
758 ;; That can happen with RCS-style names
759 ;; if the file name is truncated
760 ;; (e.g. to 14 chars). See if either
761 ;; directory or attributes differ.
768 vc-master-templates)
769 nil)))))
772 ;; Check if DIRNAME/BASENAME is handled by CVS.
773 ;; If it is, do a (throw 'found (cons MASTER 'CVS)).
774 ;; Note: This function throws the name of CVS/Entries
775 ;; NOT that of the RCS master file (because we wouldn't be able
776 ;; to access it under remote CVS).
777 ;; The function returns nil if DIRNAME/BASENAME is not handled by CVS.
788 ;; make sure the file name is searched
789 ;; case-sensitively
794 "/\\([^/]*\\)/[^ /]* \\([A-Z][a-z][a-z]\\) *\\([0-9]*\\) \\([0-9]*\\):\\([0-9]*\\):\\([0-9]*\\) \\([0-9]*\\)")
795 nil t)
797 ;; We found it. Store away version number now that we
798 ;; are anyhow so close to finding it.
800 'vc-workfile-version
802 ;; If the file hasn't been modified since checkout,
803 ;; store the checkout-time.
812 second minute hour day
822 nil)))
826 "Return the version-control type of the visited file, or nil if none."
829 vc-buffer-backend))
832 "Change read-only status of current buffer, perhaps via version control.
833 If the buffer is visiting a file registered with version control,
834 then check the file in or out. Otherwise, just change the read-only flag
835 of the buffer. With prefix argument, ask for version number."
843 ;; Function to be called by basic-save-buffer (in files.el).
844 ;; If the file in the current buffer is under version control,
845 ;; not locked, and the checkout model for it is `implicit',
846 ;; mark it "locked" and redisplay the mode line.
849 ;; ...check the property directly, not through the function of the
850 ;; same name. Otherwise Emacs would check for a master file
851 ;; each time a non-version-controlled buffer is saved.
852 ;; The property is computed when the file is visited, so if it
853 ;; is `nil' now, it is certain that the file is NOT
854 ;; version-controlled.
857 ;; File has been saved in the same second in which
858 ;; it was checked out. Clear the checkout-time
859 ;; to avoid confusion.
861 t)
867 t)
871 "Set `vc-mode' to display type of version control for FILE.
872 The value is set in the current buffer, which should be the buffer
873 visiting FILE. Second optional arg LABEL is put in place of version
874 control system name."
884 ;; If the file is locked by some other user, make
885 ;; the buffer read-only. Like this, even root
886 ;; cannot modify a file without locking it first.
890 ;;(set-buffer-modified-p (buffer-modified-p)) ;;use this if Emacs 18
891 vc-type))
894 ;; Return string for placement in modeline by `vc-mode-line'.
895 ;; Format:
896 ;;
897 ;; "-REV" if the revision is not locked
898 ;; ":REV" if the revision is locked by the user
899 ;; ":LOCKER:REV" if the revision is locked by somebody else
900 ;; " @@" for a CVS file that is added, but not yet committed
901 ;;
902 ;; In the CVS case, a "locked" working file is a
903 ;; working file that is modified with respect to the master.
904 ;; The file is "locked" from the moment when the user saves
905 ;; the modified buffer.
906 ;;
907 ;; This function assumes that the file is registered.
923 ;; If the current buffer visits a symbolic link, this function makes it
924 ;; visit the real file instead. If the real file is already visited in
925 ;; another buffer, make that buffer current, and kill the buffer
926 ;; that visits the link.
933 ;; In principle, we could do something like set-visited-file-name.
934 ;; However, it can't be exactly the same as set-visited-file-name.
935 ;; I'm not going to work out the details right now. -- rms.
940 ;;; install a call to the above as a find-file hook
942 ;; Recompute whether file is version controlled,
943 ;; if user has killed the buffer and revisited.
951 ;; Use this variable, not make-backup-files,
952 ;; because this is for things that depend on the file name.
962 ;; If we already visited this file by following
963 ;; the link, don't ask again if we try to visit
964 ;; it again. GUD does that, and repeated questions
965 ;; are painful.
980 ))))))))))
984 ;;; more hooks, this time for file-not-found
986 "When file is not found, try to check it out from RCS or SCCS.
987 Returns t if checkout was successful, nil otherwise."
996 ;; Discard info about a file when we kill its buffer.
1003 ;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
1005 ;;; Now arrange for bindings and autoloading of the main package.
1006 ;;; Bindings for this have to go in the global map, as we'll often
1007 ;;; want to call them from random buffers.
1028 ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar
1029 ;; vc-menu-map.
1030 ()
1031 ;;(define-key vc-menu-map [show-files]
1032 ;; '("Show Files under VC" . (vc-directory t)))
1035 (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
1036 (define-key vc-menu-map [vc-version-other-window]
1037 '("Show Other Version" . vc-version-other-window))
1038 (define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
1039 (define-key vc-menu-map [vc-update-change-log]
1040 '("Update ChangeLog" . vc-update-change-log))
1041 (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
1042 (define-key vc-menu-map [separator2] '("----"))
1043 (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
1044 (define-key vc-menu-map [vc-revert-buffer]
1045 '("Revert to Last Version" . vc-revert-buffer))
1046 (define-key vc-menu-map [vc-insert-header]
1047 '("Insert Header" . vc-insert-headers))
1048 (define-key vc-menu-map [vc-menu-check-in] '("Check In" . vc-next-action))
1049 (define-key vc-menu-map [vc-check-out] '("Check Out" . vc-toggle-read-only))
1050 (define-key vc-menu-map [vc-register] '("Register" . vc-register)))
1052 (put 'vc-rename-file 'menu-enable 'vc-mode)
1053 (put 'vc-version-other-window 'menu-enable 'vc-mode)
1054 (put 'vc-diff 'menu-enable 'vc-mode)
1055 (put 'vc-update-change-log 'menu-enable
1056 '(eq (vc-buffer-backend) 'RCS))
1057 (put 'vc-print-log 'menu-enable 'vc-mode)
1058 (put 'vc-cancel-version 'menu-enable 'vc-mode)
1059 (put 'vc-revert-buffer 'menu-enable 'vc-mode)
1060 (put 'vc-insert-headers 'menu-enable 'vc-mode)
1061 (put 'vc-next-action 'menu-enable 'vc-mode)
1062 (put 'vc-toggle-read-only 'menu-enable 'vc-mode)
1063 (put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
1065 (provide 'vc-hooks)
1067 ;;; vc-hooks.el ends here