| blob | 5591d4908109fc1a9c8bbd91dacf05c2227ef035 |
1 ;;; vc-hooks.el --- resident support for version-control
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
8 ;; $Id: vc-hooks.el,v 1.1 2000/01/10 13:25:12 gerd Exp gerd $
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.
40 The value is only computed when needed to avoid an expensive search."
45 "*If non-nil, use VC for files managed with CVS.
46 If it is nil, don't use VC for those files."
51 "*Indicates whether rcsdiff understands the --brief option.
52 The value is either `yes', `no', or nil. If it is nil, VC tries
53 to use --brief and sets this variable to remember whether it worked."
60 nil)
61 "*List of extra directories to search for version control commands."
68 vc-find-cvs-master
69 vc-search-sccs-project-dir)
70 "*Where to look for version-control master files.
71 The first pair corresponding to a given back end is used as a template
72 when creating new masters.
73 Setting this variable to nil turns off use of VC entirely."
78 "*If non-nil, backups of registered files are made as with other files.
79 If nil (the default), files covered by version control don't get backups."
84 "*Indicates what to do if you visit a symbolic link to a file
85 that is under version control. Editing such a file through the
86 link bypasses the version control system, which is dangerous and
87 probably not what you want.
88 If this variable is t, VC follows the link and visits the real file,
89 telling you about it in the echo area. If it is `ask', VC asks for
90 confirmation whether it should follow the link. If nil, the link is
91 visited and a warning displayed."
96 "*If non-nil, display revision number and lock status in modeline.
97 Otherwise, not displayed."
103 "*If non-nil, identify work files by searching for version headers."
108 "*If non-nil, don't delete working files after registering changes.
109 If the back-end is CVS, workfiles are always kept, regardless of the
110 value of this flag."
115 "*If non-nil, don't assume that permissions and ownership track
116 version-control status. If nil, do rely on the permissions.
117 See also variable `vc-consult-headers'."
122 "*If non-nil don't look for version control information when finding files.
124 It may be useful to set this if (say) you edit files in a directory
125 containing corresponding RCS files but don't have RCS available;
126 similarly for other version control systems."
132 ;; Access function to the above.
138 ;; Tell Emacs about this new kind of minor mode
141 minor-mode-alist)))
146 ;; We need a notion of per-file properties because the version
147 ;; control state of a file is expensive to derive --- we compute
148 ;; them when the file is initially found, keep them up to date
149 ;; during any subsequent VC operations, and forget them when
150 ;; the buffer is killed.
162 ;; set per-file property
166 ;; get per-file property
170 ;; clear all properties of a given file
173 ;;; Functions that determine property values, by examining the
174 ;;; working file, the master file, or log program output
180 ;; Generate lock file name corresponding to FILE
183 master
187 "p."
191 ;; Use PATTERNS to parse information out of the current buffer.
192 ;; Each element of PATTERNS is a list of 2 to 3 elements. The first element
193 ;; is the pattern to be matched, and the second (an integer) is the
194 ;; number of the subexpression that should be returned. If there's
195 ;; a third element (also the number of a subexpression), that
196 ;; subexpression is assumed to be a date field and we want the most
197 ;; recent entry matching the template; this works for RCS format dates only.
198 ;; If FILE and PROPERTIES are given, the latter must be a list of
199 ;; properties of the same length as PATTERNS; each property is assigned
200 ;; the corresponding value.
211 value))
216 ;; Most (but not all) versions of RCS use two-digit years
217 ;; to represent dates in the range 1900 through 1999.
218 ;; The two-digit and four-digit notations can both appear
219 ;; in the same file. Normalize the two-digit versions.
231 latest-val)))))
232 patterns)
233 )
236 ;; Insert the contents of FILE into the current buffer.
237 ;; Optional argument LIMIT is a regexp. If present,
238 ;; the file is inserted in chunks of size BLOCKSIZE
239 ;; (default 8 kByte), until the first occurrence of
240 ;; LIMIT is found. The function returns nil if FILE
241 ;; doesn't exist.
259 t)
263 ;; Parse RCS or SCCS locks.
264 ;; The result is a list of the form ((VERSION USER) (VERSION USER) ...),
265 ;; which is returned and stored into the property `vc-master-locks'.
271 locks index)
281 locks index)
295 ;; Simple version of vc-do-command, for use in vc-hooks only.
296 ;; Don't switch to the *vc-info* buffer before running the
297 ;; command, because that would change its default directory
301 ;; Add vc-path to PATH for the execution of this command.
304 path-separator
306 process-environment)))
315 exec-status))
318 ;; Parse output of "cvs status" command in the current buffer and
319 ;; set file properties accordingly. Unless FULL is t, parse only
320 ;; essential information.
335 nil t))
357 ;; Fetch those properties of FILE that are stored in the master file.
358 ;; For an RCS file, we don't get vc-latest-version vc-your-latest-version
359 ;; here because that is slow.
360 ;; That gets done if/when the functions vc-latest-version
361 ;; and vc-your-latest-version get called.
374 file
384 file
386 vc-default-branch
387 vc-master-locks))
388 ;; determine vc-master-workfile-version: it is either the head
389 ;; of the trunk, the head of the default branch, or the
390 ;; "default branch" itself, if that is a full revision number.
393 ;; no default branch
397 ;; default branch is actually a revision
399 default-branch)
401 ;; else, search for the head of the default branch
408 ;; translate the locks
413 ;; Call "cvs status" in the right directory, passing only the
414 ;; nondirectory part of the file name -- otherwise CVS might
415 ;; silently give a wrong result.
423 ;;; Functions that determine property values, by examining the
424 ;;; working file, the master file, or log program output
427 ;; Search for RCS headers in FILE, and set properties
428 ;; accordingly. This function can be disabled by setting
429 ;; vc-consult-headers to nil.
430 ;; Returns: nil if no headers were found
431 ;; (or if the feature is disabled,
432 ;; or if there is currently no buffer
433 ;; visiting FILE)
434 ;; 'rev if a workfile revision was found
435 ;; 'rev-and-lock if revision and lock info was found
444 ;; search for $Id or $Header
445 ;; -------------------------
446 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
453 ;; if found, store the revision number ...
456 ;; ... and check for the locking state
464 ;; unlocked revision
468 ;; revision is locked by some user
474 ;; everything else: false
476 ;; unexpected information in
477 ;; keyword string --> quit
479 ;; search for $Revision
480 ;; --------------------
483 nil t)
484 ;; if found, store the revision number ...
487 ;; and see if there's any lock information
502 ;; else: nothing found
503 ;; -------------------
509 ;; If the file has headers, we don't want to query the master file,
510 ;; because that would eliminate all the performance gain the headers
511 ;; brought us. We therefore use a heuristic for the checkout model
512 ;; now: If we trust the file permissions, and the file is not
513 ;; locked, then if the file is read-only the checkout model is
514 ;; `manual', otherwise `implicit'.
520 status))))
522 ;;; Access functions to file properties
523 ;;; (Properties should be _set_ using vc-file-setprop, but
524 ;;; _retrieved_ only through these functions, which decide
525 ;;; if the property is already known or not. A property should
526 ;;; only be retrieved by vc-file-getprop if there is no
527 ;;; access function.)
529 ;;; properties indicating the backend
530 ;;; being used for FILE
533 ;; Where the master and lock files for the current directory are kept
537 vc-default-back-end
541 "Return the master name of a file, nil if it is not registered.
542 For CVS, the full name of CVS/Entries is returned."
544 ;; Use the caching mechanism of vc-backend, below.
549 "Return the version-control type of a file, nil if it is not registered."
550 ;; Note that internally, Emacs remembers unregistered
551 ;; files by setting the property to `none'.
563 nil))))))
566 ;; Return `manual' if the user has to type C-x C-q to check out FILE.
567 ;; Return `implicit' if the file can be modified without locking it first.
582 ;; If the file is not writeable, this is probably because the
583 ;; file is being "watched" by other developers. Use "manual"
584 ;; checkout in this case. (If vc-mistrust-permissions was t,
585 ;; we actually shouldn't trust this, but there is no other way
586 ;; to learn this from CVS at the moment (version 1.9).)
591 ;;; properties indicating the locking state
594 ;; Return the cvs status of FILE
595 ;; (Status field in output of "cvs status")
601 ;; Return the lock entries in the master of FILE.
602 ;; Return 'none if there are no such entries, and a list
603 ;; of the form ((VERSION USER) (VERSION USER) ...) otherwise.
609 ;; Return the master file's idea of who is locking
610 ;; the current workfile version of FILE.
611 ;; Return 'none if it is not locked.
614 ;; search for a lock on the current workfile version
620 ;; If the permissions can be trusted for this file, determine the
621 ;; locking state from them. Returns (user-login-name), `none', or nil.
622 ;; This implementation assumes that any file which is under version
623 ;; control and has -rw-r--r-- is locked by its owner. This is true
624 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
625 ;; We have to be careful not to exclude files with execute bits on;
626 ;; scripts can be under version control too. Also, we must ignore the
627 ;; group-read and other-read bits, since paranoid users turn them off.
628 ;; This hack wins because calls to the somewhat expensive
629 ;; `vc-fetch-master-properties' function only have to be made if
630 ;; (a) the file is locked by someone other than the current user,
631 ;; or (b) some untoward manipulation behind vc's back has changed
632 ;; the owner or the `group' or `other' write bits.
643 ;; Return the name under which the user is logged in, as a string.
644 ;; (With optional argument UID, return the name of that user.)
645 ;; This function does the same as `user-login-name', but unlike
646 ;; that, it never returns nil. If a UID cannot be resolved, that
647 ;; UID is returned as a string.
653 ;; Return who owns FILE (user name, as a string).
657 ;; Diff the file against the master version. If differences are found,
658 ;; mark the file locked. This is only used for RCS with non-strict
659 ;; locking. (If "rcsdiff" doesn't understand --brief, we do a double-take
660 ;; and remember the fact for the future.)
676 ;; Return the name of the person currently holding a lock on FILE.
677 ;; Return nil if there is no such person.
678 ;; Under CVS, a file is considered locked if it has been modified since
679 ;; it was checked out.
680 ;; The property is cached. It is only looked up if it is currently nil.
681 ;; Note that, for a file that is not locked, the actual property value
682 ;; is `none', to distinguish it from an unknown locking state. That value
683 ;; is converted to nil by this function, and returned to the caller.
686 ;; if we already know the property, return it
689 ;; otherwise, infer the property...
702 ;; Check for RCS headers first
705 ;; If there are no headers, try to learn it
706 ;; from the permissions.
710 ;; If the permissions say "not locked", we know
711 ;; that the checkout model must be `manual'.
714 ;; If the permissions say "locked", we can only trust
715 ;; this *if* the checkout model is `manual'.
718 ;; Otherwise, use lock information from the master file.
722 ;; Finally, if the file is not explicitly locked
723 ;; it might still be locked implicitly.
733 ;; convert a possible 'none value
737 ;;; properties to store current and recent version numbers
740 ;; Return version level of the latest version of FILE
746 ;; Return version level of the latest version of FILE checked in by you
752 ;; Return the master file's idea of what is the current workfile version.
753 ;; This property is defined for RCS only.
759 ;; Fetch vc-latest-version and vc-your-latest-version
760 ;; if that wasn't already done.
772 file
777 ))
780 ;; Return version level of the current workfile FILE
781 ;; This is attempted by first looking at the RCS keywords.
782 ;; If there are no keywords in the working file,
783 ;; vc-master-workfile-version is taken.
784 ;; Note that this property is cached, that is, it is only
785 ;; looked up if it is nil.
786 ;; For SCCS, this property is equivalent to vc-latest-version.
795 rev)))
804 ;;; actual version-control code starts here
812 ;; Search for a master corresponding to the given file
822 ;; Make sure the file we found with name
823 ;; TRIAL is not the source file itself.
824 ;; That can happen with RCS-style names
825 ;; if the file name is truncated
826 ;; (e.g. to 14 chars). See if either
827 ;; directory or attributes differ.
834 vc-master-templates)
835 nil)))))
838 ;; Return the full pathname of the SCCS PROJECTDIR, if it exists,
839 ;; otherwise nil. The PROJECTDIR is indicated by the environment
840 ;; variable of the same name. If its value starts with a slash,
841 ;; it must be an absolute path name that points to the
842 ;; directory where SCCS history files reside. If it does not
843 ;; begin with a slash, it is taken as the name of a user,
844 ;; and history files reside in an "src" or "source" subdirectory
845 ;; of that user's home directory.
852 project-dir))
869 ;; Check if there is a master file for BASENAME in the
870 ;; SCCS project directory. If yes, throw `found' as
871 ;; expected by vc-registered. If not, return nil.
879 ;; Check if DIRNAME/BASENAME is handled by CVS.
880 ;; If it is, do a (throw 'found (cons MASTER-FILE 'CVS)).
881 ;; Note: This function throws the name of CVS/Entries
882 ;; NOT that of the RCS master file (because we wouldn't be able
883 ;; to access it under remote CVS).
884 ;; The function returns nil if DIRNAME/BASENAME is not handled by CVS.
889 buffer)
895 ;; make sure that the file name is searched
896 ;; case-sensitively - case-fold-search is a buffer-local
897 ;; variable, so setting it here won't affect any other buffers
900 ;; entry for a "locally added" file (not yet committed)
906 ;; normal entry
909 ;; revision
911 ;; timestamp
917 ;; optional conflict field
919 nil t)
920 ;; We found it. Store away version number now that we
921 ;; are anyhow so close to finding it.
923 'vc-workfile-version
925 ;; If the file hasn't been modified since checkout,
926 ;; store the checkout-time.
935 second minute hour day
944 ;; entry with arbitrary text as timestamp
945 ;; (this means we should consider it modified)
948 ;; revision
950 ;; timestamp (arbitrary text)
951 "/[^/]*"
952 ;; optional conflict field
954 nil t)
955 ;; We found it. Store away version number now that we
956 ;; are anyhow so close to finding it.
964 "Return the version-control type of the visited file, or nil if none."
967 vc-buffer-backend))
970 "Change read-only status of current buffer, perhaps via version control.
971 If the buffer is visiting a file registered with version control,
972 then check the file in or out. Otherwise, just change the read-only flag
973 of the buffer.
974 With prefix argument, ask for version number to check in or check out.
975 Check-out of a specified version number does not lock the file;
976 to do that, use this command a second time with no argument."
979 ;; use boundp because vc.el might not be loaded
986 ;; Function to be called by basic-save-buffer (in files.el).
987 ;; If the file in the current buffer is under version control,
988 ;; not locked, and the checkout model for it is `implicit',
989 ;; mark it "locked" and redisplay the mode line.
994 ;; File has been saved in the same second in which
995 ;; it was checked out. Clear the checkout-time
996 ;; to avoid confusion.
998 t)
1004 t)
1008 "Set `vc-mode' to display type of version control for FILE.
1009 The value is set in the current buffer, which should be the buffer
1010 visiting FILE. Second optional arg LABEL is put in place of version
1011 control system name."
1018 ;; If the file is locked by some other user, make
1019 ;; the buffer read-only. Like this, even root
1020 ;; cannot modify a file that someone else has locked.
1026 ;; If the user is root, and the file is not owner-writable,
1027 ;; then pretend that we can't write it
1028 ;; even though we can (because root can write anything).
1029 ;; This way, even root cannot modify a file that isn't locked.
1037 ;;(set-buffer-modified-p (buffer-modified-p)) ;;use this if Emacs 18
1038 vc-type))
1041 ;; Return string for placement in modeline by `vc-mode-line'.
1042 ;; Format:
1043 ;;
1044 ;; "-REV" if the revision is not locked
1045 ;; ":REV" if the revision is locked by the user
1046 ;; ":LOCKER:REV" if the revision is locked by somebody else
1047 ;; " @@" for a CVS file that is added, but not yet committed
1048 ;;
1049 ;; In the CVS case, a "locked" working file is a
1050 ;; working file that is modified with respect to the master.
1051 ;; The file is "locked" from the moment when the user saves
1052 ;; the modified buffer.
1053 ;;
1054 ;; This function assumes that the file is registered.
1068 ;; If the current buffer visits a symbolic link, this function makes it
1069 ;; visit the real file instead. If the real file is already visited in
1070 ;; another buffer, make that buffer current, and kill the buffer
1071 ;; that visits the link.
1078 ;; In principle, we could do something like set-visited-file-name.
1079 ;; However, it can't be exactly the same as set-visited-file-name.
1080 ;; I'm not going to work out the details right now. -- rms.
1085 ;;; install a call to the above as a find-file hook
1087 ;; Recompute whether file is version controlled,
1088 ;; if user has killed the buffer and revisited.
1096 ;; Use this variable, not make-backup-files,
1097 ;; because this is for things that depend on the file name.
1107 ;; If we already visited this file by following
1108 ;; the link, don't ask again if we try to visit
1109 ;; it again. GUD does that, and repeated questions
1110 ;; are painful.
1125 ))))))))))
1129 ;;; more hooks, this time for file-not-found
1131 "When file is not found, try to check it out from RCS or SCCS.
1132 Returns t if checkout was successful, nil otherwise."
1133 ;; When a file does not exist, ignore cached info about it
1134 ;; from a previous visit.
1145 ;; Discard info about a file when we kill its buffer.
1152 ;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
1154 ;;; Now arrange for bindings and autoloading of the main package.
1155 ;;; Bindings for this have to go in the global map, as we'll often
1156 ;;; want to call them from random buffers.
1179 ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar
1180 ;; vc-menu-map.
1181 ()
1182 ;;(define-key vc-menu-map [show-files]
1183 ;; '("Show Files under VC" . (vc-directory t)))
1190 (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate))
1191 (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
1192 (define-key vc-menu-map [vc-version-other-window]
1193 '("Show Other Version" . vc-version-other-window))
1194 (define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
1195 (define-key vc-menu-map [vc-update-change-log]
1196 '("Update ChangeLog" . vc-update-change-log))
1197 (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
1198 (define-key vc-menu-map [separator2] '("----"))
1199 (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
1200 (define-key vc-menu-map [vc-revert-buffer]
1201 '("Revert to Last Version" . vc-revert-buffer))
1202 (define-key vc-menu-map [vc-insert-header]
1203 '("Insert Header" . vc-insert-headers))
1204 (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action))
1205 (define-key vc-menu-map [vc-register] '("Register" . vc-register)))
1207 ;;; These are not correct and it's not currently clear how doing it
1208 ;;; better (with more complicated expressions) might slow things down
1209 ;;; on older systems.
1211 ;;;(put 'vc-rename-file 'menu-enable 'vc-mode)
1212 ;;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS))
1213 ;;;(put 'vc-version-other-window 'menu-enable 'vc-mode)
1214 ;;;(put 'vc-diff 'menu-enable 'vc-mode)
1215 ;;;(put 'vc-update-change-log 'menu-enable
1216 ;;; '(eq (vc-buffer-backend) 'RCS))
1217 ;;;(put 'vc-print-log 'menu-enable 'vc-mode)
1218 ;;;(put 'vc-cancel-version 'menu-enable 'vc-mode)
1219 ;;;(put 'vc-revert-buffer 'menu-enable 'vc-mode)
1220 ;;;(put 'vc-insert-headers 'menu-enable 'vc-mode)
1221 ;;;(put 'vc-next-action 'menu-enable 'vc-mode)
1222 ;;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
1224 (provide 'vc-hooks)
1226 ;;; vc-hooks.el ends here