| blob | f20b1e15820ff85eb3bd71b286e5fdfc3e27d3ad |
1 ;;; vc-hooks.el --- resident support for version-control
3 ;; Copyright (C) 1992, 1993, 1994, 1995 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
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;;; Commentary:
28 ;; This is the always-loaded portion of VC.
29 ;; It takes care VC-related activities that are done when you visit a file,
30 ;; so that vc.el itself is loaded only when you use a VC command.
31 ;; See the commentary of vc.el.
33 ;;; Code:
35 ;; Customization Variables (the rest is in vc.el)
38 "*Back-end actually used by this interface; may be SCCS or RCS.
42 "*If non-nil, use VC for files managed with CVS.
46 "*Indicates whether rcsdiff understands the --brief option.
47 The value is either `yes', `no', or nil. If it is nil, VC tries
53 nil)
59 vc-find-cvs-master)
60 "*Where to look for version-control master files.
61 The first pair corresponding to a given back end is used as a template
65 "*If non-nil, backups of registered files are made as with other files.
69 "*If non-nil, display revision number and lock status in modeline.
76 "*If non-nil, don't delete working files after registering changes.
77 If the back-end is CVS, workfiles are always kept, regardless of the
81 "*If non-nil, don't assume that permissions and ownership track
82 version-control status. If nil, do rely on the permissions.
86 ;; Access function to the above.
92 ;; Tell Emacs about this new kind of minor mode
95 minor-mode-alist)))
100 ;; We need a notion of per-file properties because the version
101 ;; control state of a file is expensive to derive --- we compute
102 ;; them when the file is initially found, keep them up to date
103 ;; during any subsequent VC operations, and forget them when
104 ;; the buffer is killed.
116 ;; set per-file property
120 ;; get per-file property
124 ;; clear all properties of a given file
127 ;;; Functions that determine property values, by examining the
128 ;;; working file, the master file, or log program output
134 ;; Generate lock file name corresponding to FILE
137 master
141 "p."
145 ;; Use PATTERNS to parse information out of the current buffer.
146 ;; Each element of PATTERNS is a list of 2 to 3 elements. The first element
147 ;; is the pattern to be matched, and the second (an integer) is the
148 ;; number of the subexpression that should be returned. If there's
149 ;; a third element (also the number of a subexpression), that
150 ;; subexpression is assumed to be a date field and we want the most
151 ;; recent entry matching the template.
152 ;; If FILE and PROPERTIES are given, the latter must be a list of
153 ;; properties of the same length as PATTERNS; each property is assigned
154 ;; the corresponding value.
165 value))
178 latest-val)))))
179 patterns)
180 )
183 ;; Insert the contents of FILE into the current buffer.
184 ;; Optional argument LIMIT is a regexp. If present,
185 ;; the file is inserted in chunks of size BLOCKSIZE
186 ;; (default 8 kByte), until the first occurrence of
187 ;; LIMIT is found. The function returns nil if FILE
188 ;; doesn't exist.
206 t)
210 ;; Parse RCS or SCCS locks.
211 ;; The result is a list of the form ((VERSION USER) (VERSION USER) ...),
212 ;; which is returned and stored into the property `vc-master-locks'.
218 locks index)
228 locks index)
242 ;; Simple version of vc-do-command, for use in vc-hooks only.
243 ;; Don't switch to the *vc-info* buffer before running the
244 ;; command, because that would change its default directory
248 ;; Add vc-path to PATH for the execution of this command.
251 path-separator
253 process-environment)))
262 exec-status))
265 ;; Fetch those properties of FILE that are stored in the master file.
266 ;; For an RCS file, we don't get vc-latest-version vc-your-latest-version
267 ;; here because that is slow.
268 ;; That gets done if/when the functions vc-latest-version
269 ;; and vc-your-latest-version get called.
282 file
292 file
294 vc-default-branch
295 vc-master-locks))
296 ;; determine vc-master-workfile-version: it is either the head
297 ;; of the trunk, the head of the default branch, or the
298 ;; "default branch" itself, if that is a full revision number.
301 ;; no default branch
305 ;; default branch is actually a revision
307 default-branch)
309 ;; else, search for the head of the default branch
316 ;; translate the locks
321 ;; Call "cvs status" in the right directory, passing only the
322 ;; nondirectory part of the file name -- otherwise CVS might
323 ;; silently give a wrong result.
328 ;; CVS 1.3 says "RCS Version:", other releases "RCS Revision:",
329 ;; and CVS 1.4a1 says "Repository revision:".
332 file
334 ;; Translate those status values that we understand into symbols.
335 ;; Any other value is converted to nil.
351 ))))))))
355 ;;; Functions that determine property values, by examining the
356 ;;; working file, the master file, or log program output
359 ;; Search for RCS headers in FILE, and set properties
360 ;; accordingly. This function can be disabled by setting
361 ;; vc-consult-headers to nil.
362 ;; Returns: nil if no headers were found
363 ;; (or if the feature is disabled,
364 ;; or if there is currently no buffer
365 ;; visiting FILE)
366 ;; 'rev if a workfile revision was found
367 ;; 'rev-and-lock if revision and lock info was found
376 ;; search for $Id or $Header
377 ;; -------------------------
384 ;; if found, store the revision number ...
386 ;; ... and check for the locking state
394 ;; unlocked revision
398 ;; revision is locked by some user
403 ;; everything else: false
405 ;; unexpected information in
406 ;; keyword string --> quit
408 ;; search for $Revision
409 ;; --------------------
412 nil t)
413 ;; if found, store the revision number ...
415 ;; and see if there's any lock information
429 ;; else: nothing found
430 ;; -------------------
436 ;; If the file has headers, we don't want to query the master file,
437 ;; because that would eliminate all the performance gain the headers
438 ;; brought us. We therefore use a heuristic for the checkout model
439 ;; now: If we trust the file permissions, and the file is not
440 ;; locked, then if the file is read-only the checkout model is
441 ;; `manual', otherwise `implicit'.
447 status))))
449 ;;; Access functions to file properties
450 ;;; (Properties should be _set_ using vc-file-setprop, but
451 ;;; _retrieved_ only through these functions, which decide
452 ;;; if the property is already known or not. A property should
453 ;;; only be retrieved by vc-file-getprop if there is no
454 ;;; access function.)
456 ;;; properties indicating the backend
457 ;;; being used for FILE
460 ;; Where the master and lock files for the current directory are kept
464 vc-default-back-end
468 "Return the master name of a file, nil if it is not registered.
469 For CVS, the full name of CVS/Entries is returned."
478 "Return the version-control type of a file, nil if it is not registered."
488 ;; Return `manual' if the user has to type C-x C-q to check out FILE.
489 ;; Return `implicit' if the file can be modified without locking it first.
504 ;;; properties indicating the locking state
507 ;; Return the cvs status of FILE
508 ;; (Status field in output of "cvs status")
514 ;; Return the lock entries in the master of FILE.
515 ;; Return 'none if there are no such entries, and a list
516 ;; of the form ((VERSION USER) (VERSION USER) ...) otherwise.
522 ;; Return the master file's idea of who is locking
523 ;; the current workfile version of FILE.
524 ;; Return 'none if it is not locked.
527 ;; search for a lock on the current workfile version
533 ;; If the permissions can be trusted for this file, determine the
534 ;; locking state from them. Returns (user-login-name), `none', or nil.
535 ;; This implementation assumes that any file which is under version
536 ;; control and has -rw-r--r-- is locked by its owner. This is true
537 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
538 ;; We have to be careful not to exclude files with execute bits on;
539 ;; scripts can be under version control too. Also, we must ignore the
540 ;; group-read and other-read bits, since paranoid users turn them off.
541 ;; This hack wins because calls to the somewhat expensive
542 ;; `vc-fetch-master-properties' function only have to be made if
543 ;; (a) the file is locked by someone other than the current user,
544 ;; or (b) some untoward manipulation behind vc's back has changed
545 ;; the owner or the `group' or `other' write bits.
556 ;; The expression below should return the username of the owner
557 ;; of the file. It doesn't. It returns the username if it is
558 ;; you, or otherwise the UID of the owner of the file. The
559 ;; return value from this function is only used by
560 ;; vc-dired-reformat-line, and it does the proper thing if a UID
561 ;; is returned.
562 ;; The *proper* way to fix this would be to implement a built-in
563 ;; function in Emacs, say, (username UID), that returns the
564 ;; username of a given UID.
565 ;; The result of this hack is that vc-directory will print the
566 ;; name of the owner of the file for any files that are
567 ;; modified.
572 ;; Diff the file against the master version. If differences are found,
573 ;; mark the file locked. This is only used for RCS with non-strict
574 ;; locking. (If "rcsdiff" doesn't understand --brief, we do a double-take
575 ;; and remember the fact for the future.)
591 ;; Return the name of the person currently holding a lock on FILE.
592 ;; Return nil if there is no such person. (Sometimes, not the name
593 ;; of the locking user but his uid will be returned.)
594 ;; Under CVS, a file is considered locked if it has been modified since
595 ;; it was checked out.
596 ;; The property is cached. It is only looked up if it is currently nil.
597 ;; Note that, for a file that is not locked, the actual property value
598 ;; is `none', to distinguish it from an unknown locking state. That value
599 ;; is converted to nil by this function, and returned to the caller.
602 ;; if we already know the property, return it
605 ;; otherwise, infer the property...
621 ;; Check for RCS headers first
624 ;; If there are no headers, try to learn it
625 ;; from the permissions.
629 ;; If the permissions say "not locked", we know
630 ;; that the checkout model must be `manual'.
633 ;; If the permissions say "locked", we can only trust
634 ;; this *if* the checkout model is `manual'.
637 ;; Otherwise, use lock information from the master file.
641 ;; Finally, if the file is not explicitly locked
642 ;; it might still be locked implicitly.
652 ;; convert a possible 'none value
656 ;;; properties to store current and recent version numbers
659 ;; Return version level of the latest version of FILE
665 ;; Return version level of the latest version of FILE checked in by you
671 ;; Return the master file's idea of what is the current workfile version.
672 ;; This property is defined for RCS only.
678 ;; Fetch vc-latest-version and vc-your-latest-version
679 ;; if that wasn't already done.
691 file
696 ))
699 ;; Return version level of the current workfile FILE
700 ;; This is attempted by first looking at the RCS keywords.
701 ;; If there are no keywords in the working file,
702 ;; vc-master-workfile-version is taken.
703 ;; Note that this property is cached, that is, it is only
704 ;; looked up if it is nil.
705 ;; For SCCS, this property is equivalent to vc-latest-version.
714 rev)))
723 ;;; actual version-control code starts here
731 ;; Search for a master corresponding to the given file
741 ;; Make sure the file we found with name
742 ;; TRIAL is not the source file itself.
743 ;; That can happen with RCS-style names
744 ;; if the file name is truncated
745 ;; (e.g. to 14 chars). See if either
746 ;; directory or attributes differ.
753 vc-master-templates)
754 nil)))))
757 ;; Convert a time value into universal time, and return it as a
758 ;; human-readable string. This is for comparing CVS checkout times
759 ;; with file modification times.
771 ;; Check if DIRNAME/BASENAME is handled by CVS.
772 ;; If it is, do a (throw 'found (cons MASTER 'CVS)).
773 ;; Note: This function throws the name of CVS/Entries
774 ;; NOT that of the RCS master file (because we wouldn't be able
775 ;; to access it under remote CVS).
776 ;; The function returns nil if DIRNAME/BASENAME is not handled by CVS.
787 ;; make sure the file name is searched
788 ;; case-sensitively
794 nil t)
796 ;; We found it. Store away version number now that we
797 ;; are anyhow so close to finding it.
799 'vc-workfile-version
801 ;; If the file hasn't been modified since checkout,
802 ;; store the checkout-time.
809 nil)))
813 "Return the version-control type of the visited file, or nil if none."
816 vc-buffer-backend))
819 "Change read-only status of current buffer, perhaps via version control.
820 If the buffer is visiting a file registered with version control,
821 then check the file in or out. Otherwise, just change the read-only flag
822 of the buffer. With prefix argument, ask for version number."
830 ;; Function to be called by basic-save-buffer (in files.el).
831 ;; If the file in the current buffer is under version control,
832 ;; not locked, and the checkout model for it is `implicit',
833 ;; mark it "locked" and redisplay the mode line.
836 ;; ...check the property directly, not through the function of the
837 ;; same name. Otherwise Emacs would check for a master file
838 ;; each time a non-version-controlled buffer is saved.
839 ;; The property is computed when the file is visited, so if it
840 ;; is `nil' now, it is certain that the file is NOT
841 ;; version-controlled.
844 ;; File has been saved in the same second in which
845 ;; it was checked out. Clear the checkout-time
846 ;; to avoid confusion.
848 t)
854 t)
858 "Set `vc-mode' to display type of version control for FILE.
859 The value is set in the current buffer, which should be the buffer
860 visiting FILE. Second optional arg LABEL is put in place of version
861 control system name."
871 ;; If the file is locked by some other user, make
872 ;; the buffer read-only. Like this, even root
873 ;; cannot modify a file without locking it first.
877 ;;(set-buffer-modified-p (buffer-modified-p)) ;;use this if Emacs 18
878 vc-type))
881 ;; Return string for placement in modeline by `vc-mode-line'.
882 ;; Format:
883 ;;
884 ;; "-REV" if the revision is not locked
885 ;; ":REV" if the revision is locked by the user
886 ;; ":LOCKER:REV" if the revision is locked by somebody else
887 ;; " @@" for a CVS file that is added, but not yet committed
888 ;;
889 ;; In the CVS case, a "locked" working file is a
890 ;; working file that is modified with respect to the master.
891 ;; The file is "locked" from the moment when the user saves
892 ;; the modified buffer.
893 ;;
894 ;; This function assumes that the file is registered.
909 ;;; install a call to the above as a find-file hook
911 ;; Recompute whether file is version controlled,
912 ;; if user has killed the buffer and revisited.
920 ;; Use this variable, not make-backup-files,
921 ;; because this is for things that depend on the file name.
928 "Warning: symbolic link to %s-controlled source file"
929 link-type))))))))
933 ;;; more hooks, this time for file-not-found
935 "When file is not found, try to check it out from RCS or SCCS.
936 Returns t if checkout was successful, nil otherwise."
945 ;; Discard info about a file when we kill its buffer.
952 ;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
954 ;;; Now arrange for bindings and autoloading of the main package.
955 ;;; Bindings for this have to go in the global map, as we'll often
956 ;;; want to call them from random buffers.
977 ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar
978 ;; vc-menu-map.
979 ()
980 ;;(define-key vc-menu-map [show-files]
981 ;; '("Show Files under VC" . (vc-directory t)))
984 (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
985 (define-key vc-menu-map [vc-version-other-window]
986 '("Show Other Version" . vc-version-other-window))
987 (define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
988 (define-key vc-menu-map [vc-update-change-log]
989 '("Update ChangeLog" . vc-update-change-log))
990 (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
991 (define-key vc-menu-map [separator2] '("----"))
992 (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
993 (define-key vc-menu-map [vc-revert-buffer]
994 '("Revert to Last Version" . vc-revert-buffer))
995 (define-key vc-menu-map [vc-insert-header]
996 '("Insert Header" . vc-insert-headers))
997 (define-key vc-menu-map [vc-menu-check-in] '("Check In" . vc-next-action))
998 (define-key vc-menu-map [vc-check-out] '("Check Out" . vc-toggle-read-only))
999 (define-key vc-menu-map [vc-register] '("Register" . vc-register))
1000 (put 'vc-rename-file 'menu-enable 'vc-mode)
1001 (put 'vc-version-other-window 'menu-enable 'vc-mode)
1002 (put 'vc-diff 'menu-enable 'vc-mode)
1003 (put 'vc-update-change-log 'menu-enable
1004 '(eq (vc-buffer-backend) 'RCS))
1005 (put 'vc-print-log 'menu-enable 'vc-mode)
1006 (put 'vc-cancel-version 'menu-enable 'vc-mode)
1007 (put 'vc-revert-buffer 'menu-enable 'vc-mode)
1008 (put 'vc-insert-headers 'menu-enable 'vc-mode)
1009 (put 'vc-next-action 'menu-enable '(and vc-mode (not buffer-read-only)))
1010 (put 'vc-toggle-read-only 'menu-enable '(and vc-mode buffer-read-only))
1011 (put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
1012 )
1014 (provide 'vc-hooks)
1016 ;;; vc-hooks.el ends here