| blob | a4be8064338b44daeeb8fef51f6f7996910906a4 |
1 ;;; vc-rcs.el --- support for RCS version-control
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: FSF (see vc.el for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
9 ;; $Id$
11 ;; This file is part of GNU Emacs.
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.
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.
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., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; See vc.el
32 ;; TODO:
33 ;; - remove call to vc-expand-dirs by implementing our own (which can just
34 ;; list the RCS subdir instead).
36 ;;; Code:
38 ;;;
39 ;;; Customization options
40 ;;;
47 "*The release number of your RCS installation, as a string.
48 If nil, VC itself computes this value when it is first needed."
55 "*Extra switches for registering a file in RCS.
56 A string or list of strings. These are passed to the checkin program
62 string))
67 "*A string or list of strings specifying extra switches for rcsdiff under VC."
72 string))
77 "*Header keywords to be inserted by `vc-insert-headers'."
83 "*Indicates whether rcsdiff understands the --brief option.
84 The value is either `yes', `no', or nil. If it is nil, VC tries
85 to use --brief and sets this variable to remember whether it worked."
89 ;;;###autoload
92 "*Where to look for RCS master files.
93 For a description of possible values, see `vc-check-master-templates'."
98 function)))
102 \f
103 ;;; Properties of the backend
108 ;;;
109 ;;; State-querying functions
110 ;;;
112 ;;; The autoload cookie below places vc-rcs-registered directly into
113 ;;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
114 ;;; every file that is visited. The definition is repeated below
115 ;;; so that Help and etags can find it.
117 ;;;###autoload (defun vc-rcs-registered (f) (vc-default-registered 'RCS f))
121 "Implementation of `vc-state' for RCS."
126 ;; vc-workfile-version might not be known; in that case the
127 ;; property is nil. vc-rcs-fetch-master-state knows how to
128 ;; handle that.
133 state
135 'up-to-date
137 'unlocked-changes
141 "State heuristic for RCS."
148 ;; If the headers say that the file is not locked, the
149 ;; permissions can tell us whether locking is used for
150 ;; the file or not.
158 'edited
162 state)
173 'edited
174 owner-name)
176 'edited
179 ;; Strange permissions. Fall through to
180 ;; expensive state computation.
185 "RCS-specific version of `vc-workfile-version'."
194 "Return non-nil if workfile version of FILE is the latest on its branch.
195 When VERSION is given, perform check for that version."
201 ;; Compare VERSION to the head version number.
204 ;; If we are not on the trunk, we need to examine the
205 ;; whole current branch.
210 "RCS-specific version of `vc-checkout-model'."
221 "RCS-specific implementation of `vc-workfile-unchanged-p'."
222 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
223 ;; do a double take and remember the fact for the future
234 ;; The workfile is unchanged if rcsdiff found no differences.
237 \f
238 ;;;
239 ;;; State-changing functions
240 ;;;
243 "Create a new RCS repository."
244 ;; RCS is totally file-oriented, so all we have to do is make the directory
248 "Register FILES into the RCS version-control system.
249 REV is the optional revision number for the files. COMMENT can be used
250 to provide an initial description for each FILES.
252 `vc-register-switches' and `vc-rcs-register-switches' are passed to
253 the RCS command (in that order).
255 Automatically retrieve a read-only version of the file with keywords
256 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
265 ;; if available, use the secure registering option
270 ;; parse output to find master file name and workfile version
277 ;; if we couldn't find the master name,
278 ;; run vc-rcs-registered to get it
279 ;; (will be stored into the vc-name property)
283 name
285 name
290 nil t)
294 "Return non-nil if RCS thinks it would be responsible for registering FILE."
295 ;; TODO: check for all the patterns in vc-rcs-master-templates
299 "Implementation of receive-file for RCS."
307 "Unregister FILE from RCS.
308 If this leaves the RCS subdirectory empty, ask the user
309 whether to remove it."
318 ;; check whether RCS dir is empty, i.e. it does not
319 ;; contain any files except "." and ".."
326 "RCS-specific version of `vc-backend-checkin'."
328 ;; Now operate on the files
332 ;; Force branch creation if an appropriate
333 ;; default branch has been set.
335 default-branch
337 default-branch)
343 ;; if available, use the secure check-in option
347 switches)
350 ;; determine the new workfile version
360 ;; if we got to a different branch, adjust the default
361 ;; branch accordingly
369 ;; If this is an old RCS release, we might have
370 ;; to remove a remaining lock.
372 ;; exit status of 1 is also accepted.
373 ;; It means that the lock was removed before.
385 "Retrieve a copy of a saved version of FILE."
387 switches)
390 ;; Change buffers to get local value of vc-checkout-switches.
393 ;; Save this buffer's default-directory
394 ;; and use save-excursion to make sure it is restored
395 ;; in the same buffer it was saved in.
398 ;; Adjust the default-directory so that the check-out creates
399 ;; the file in the right place.
402 ;; if we should go to the head of the trunk,
403 ;; clear the default branch first
406 ;; now do the checkout
409 ;; If locking is not strict, force to overwrite
410 ;; the writable workfile.
414 ;; a literal revision was specified
420 ;; no revision specified:
421 ;; use current workfile version
422 workrev
423 ;; REV is t ...
425 ;; ... go to head of current branch
427 ;; ... go to head of trunk
429 nil)
431 switches)
432 ;; determine the new workfile version
437 ;; if necessary, adjust the default branch
440 file
444 new-version)))))
448 "Roll back, undoing the most recent checkins of FILES."
457 discard file)))
461 ;; Check out the most recent remaining version. If it
462 ;; fails, because the whole branch got deleted, do a
463 ;; double-take and check out the version where the branch
464 ;; started.
476 ;; vc-do-command popped up a window with
477 ;; the error message. Get rid of it, by
478 ;; restoring the old window configuration.
480 ;; No, it was some other error: re-signal it.
484 "Revert FILE to the version it was based on."
490 "Merge changes into current working copy of FILE.
491 The changes are between FIRST-VERSION and SECOND-VERSION."
498 "Steal the lock on the current workfile for FILE and revision REV.
499 Needs RCS 5.6.2 or later for -M."
501 ;; Do a real checkout after stealing the lock, so that we see
502 ;; expanded headers.
506 \f
507 ;;;
508 ;;; History functions
509 ;;;
512 "Get change log associated with FILE."
516 "Get a difference report using RCS between two sets of files."
526 "Remove all non-comment information from log output."
544 "Annotate FILE, inserting the results in BUFFER.
545 Optional arg REVISION is a revision to annotate from."
547 ;; Aside from the "head revision on the trunk", the instructions for
548 ;; each revision on the trunk are an ordered list of kill and insert
549 ;; commands necessary to go from the chronologically-following
550 ;; revision to this one. That is, associated with revision N are
551 ;; edits that applied to revision N+1 would result in revision N.
552 ;;
553 ;; On a branch, however, (some) things are inverted: the commands
554 ;; listed are those necessary to go from the chronologically-preceding
555 ;; revision to this one. That is, associated with revision N are
556 ;; edits that applied to revision N-1 would result in revision N.
557 ;;
558 ;; So, to get per-line history info, we apply reverse-chronological
559 ;; edits, starting with the head revision on the trunk, all the way
560 ;; back through the initial revision (typically "1.1" or similar),
561 ;; then apply forward-chronological edits -- keeping track of which
562 ;; revision is associated with each inserted line -- until we reach
563 ;; the desired revision for display (which may be either on the trunk
564 ;; or on a branch).
569 ;; The revision N whose instructions we currently are processing.
571 ;; Alist from the parse tree for N.
573 ;; Point and temporary string, respectively.
574 p s
575 ;; "Next-branch list". Nil means the desired revision to
576 ;; display lives on the trunk. Non-nil means it lives on a
577 ;; branch, in which case the value is a list of revision pairs
578 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
579 ;; links each series of revisions in the path from the initial
580 ;; revision to the desired revision to display.
581 nbls
582 ;; "Path-accumulate-predicate plus revision/date/author".
583 ;; Until set, forward-chronological edits are not accumulated.
584 ;; Once set, its value (updated every revision) is used for
585 ;; the text property `:vc-rcs-r/d/a' for inserts during
586 ;; processing of forward-chronological instructions for N.
587 ;; See internal func `r/d/a'.
588 prda
589 ;; List of forward-chronological instructions, each of the
590 ;; form: (POS . ACTION), where POS is a buffer position. If
591 ;; ACTION is a string, it is inserted, otherwise it is taken as
592 ;; the number of characters to be deleted.
593 path
594 ;; N+1. When `cur' is "", this is the initial revision.
595 pre)
600 ;; Find which branches (if any) must be included in the edits.
602 bpt kids)
606 ;; A branchpoint may have multiple children. Find the right one.
610 ;; Start with the full text.
613 ;; Apply reverse-chronological edits on the trunk, computing and
614 ;; accumulating forward-chronological edits after some point, for
615 ;; later.
622 ;; Start accumulating the forward-chronological edits when N+1
623 ;; on the trunk is either the desired revision to display, or
624 ;; the appropriate branchpoint for it. Do this before
625 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
629 ;; Edits in the parse tree specify a line number (in the buffer
630 ;; *BEFORE* editing occurs) to start from, but line numbers
631 ;; change as a result of edits. To DTRT, we apply edits in
632 ;; order of descending buffer position so that edits further
633 ;; down in the buffer occur first w/o corrupting specified
634 ;; buffer positions of edits occurring towards the beginning of
635 ;; the buffer. In this way we avoid using markers. A pleasant
636 ;; property of this approach is ability to push instructions
637 ;; onto `path' directly, w/o need to maintain rev boundaries.
652 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
653 ;; equivalent to pushing an insert instruction (of the entire buffer
654 ;; contents) onto `path' then erasing the buffer, but less wasteful.
656 ;; Now apply the forward-chronological edits for the trunk.
662 ;; Now apply the forward-chronological edits (directly from the
663 ;; parse-tree) for the branch(es), if necessary. We re-use vars
664 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
669 prda nil)
682 ;; Lastly, for each line, insert at bol nicely-formatted history info.
683 ;; We do two passes to collect summary information used to minimize
684 ;; the annotation's usage of screen real-estate: (1) Consider rendered
685 ;; width of revision plus author together as a unit; and (2) Omit
686 ;; author entirely if all authors are the same as the user.
691 rda w a)
701 ht)
709 " "
711 ls)
719 ht)))
725 "Return the current time, based at midnight of the current day, and
726 encoded as fractional days."
731 "Return the time of the next annotation (as fraction of days)
732 systime, or nil if there is none. Also, reposition point."
741 \f
742 ;;;
743 ;;; Snapshot system
744 ;;;
747 "Assign to FILE's latest version a given NAME."
750 \f
751 ;;;
752 ;;; Miscellaneous
753 ;;;
756 "Check if the current file has any headers in it."
763 "Implementation of vc-clear-headers for RCS."
769 nil t)
773 ;; Just move the master file (using vc-rcs-master-templates).
776 \f
777 ;;;
778 ;;; Internal functions
779 ;;;
782 "Return non-nil if FILE is newer than its RCS master.
783 This likely means that FILE has been changed with respect
784 to its master version."
792 "Find most recent revision on BRANCH."
797 nil t)
806 "Compute the master file's idea of the state of FILE.
807 If a WORKFILE-VERSION is given, compute the state of that version,
808 otherwise determine the workfile version based on the master file.
809 This function sets the properties `vc-workfile-version' and
810 `vc-checkout-model' to their correct values, based on the master
811 file."
821 ;; Workfile version not known yet. Determine that first. It
822 ;; is either the head of the trunk, the head of the default
823 ;; branch, or the "default branch" itself, if that is a full
824 ;; revision number.
826 ;; no default branch
831 ;; default branch is actually a revision
833 default-branch)
835 ;; else, search for the head of the default branch
841 ;; Check strict locking
846 ;; Compute state of workfile version
854 ;; not locked
858 ;; workfile version is latest on branch
859 'up-to-date
860 ;; workfile version is not latest on branch
862 ;; locked by the calling user
866 workfile-is-latest
868 'edited
869 ;; Locking is not used for the file, but the owner does
870 ;; have a lock, and there is a higher version on the current
871 ;; branch. Not sure if this can occur, and if it is right
872 ;; to use `needs-merge' in this case.
874 ;; locked by somebody else
876 locking-user)
881 "Search for RCS headers in FILE, and set properties accordingly.
883 Returns: nil if no headers were found
884 'rev if a workfile revision was found
885 'rev-and-lock if revision and lock info was found"
893 ;; search for $Id or $Header
894 ;; -------------------------
895 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
902 ;; if found, store the revision number ...
904 ;; ... and check for the locking state
912 ;; unlocked revision
916 ;; revision is locked by some user
920 ;; everything else: false
922 ;; unexpected information in
923 ;; keyword string --> quit
925 ;; search for $Revision
926 ;; --------------------
929 nil t)
930 ;; if found, store the revision number ...
932 ;; and see if there's any lock information
945 ;; else: nothing found
946 ;; -------------------
956 ;; If the file has headers, we don't want to query the
957 ;; master file, because that would eliminate all the
958 ;; performance gain the headers brought us. We therefore
959 ;; use a heuristic now to find out whether locking is used
960 ;; for this file. If we trust the file permissions, and the
961 ;; file is not locked, then if the file is read-only we
962 ;; assume that locking is used for the file, otherwise
963 ;; locking is not used.
969 status))))
972 "Compare release numbers, represented as strings.
973 Release components are assumed cardinal numbers, not decimal fractions
974 \(5.10 is a higher release than 5.9\). Omitted fields are considered
975 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
976 of the string is found, or a non-numeric component shows up \(5.6.7 is
978 some cases\). This code is suitable for existing RCS release numbers.
979 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1000 "Return t if we have RELEASE or better."
1007 "Return the RCS release installed on this system, as a string.
1008 Return symbol UNKNOWN if the release cannot be deducted. The user can
1009 override this using variable `vc-rcs-release'.
1011 If the user has not set variable `vc-rcs-release' and it is nil,
1012 variable `vc-rcs-release' is set to the returned value."
1030 "Parse current buffer, presumed to be in RCS-style masterfile format.
1031 Optional arg BUFFER specifies another buffer to parse. Return an alist
1032 of two elements, w/ keys `headers' and `revisions' and values in turn
1033 sub-alists. For `headers', the values unless otherwise specified are
1034 strings and the keys are:
1036 desc -- description
1037 head -- latest revision
1039 absent if the head revision lies on the trunk
1040 access -- ???
1041 symbols -- sub-alist of (SYMBOL . REVISION) elements
1045 expand -- may be absent; ???
1047 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1048 with string values (unless otherwise specified) and keys:
1050 date -- a time value (like that returned by `encode-time'); as a
1051 special case, a year value less than 100 is augmented by 1900
1052 author -- username
1054 branches -- list of revisions that begin branches from this revision
1057 log -- change log entry
1058 text -- for the head revision on the trunk, the body of the file;
1059 other revisions have `:insn' instead
1060 :insn -- for non-head revisions, a list of parsed instructions
1063 - `(START k COUNT)' -- kill COUNT lines
1064 - `(START i TEXT)' -- insert TEXT (a string)
1065 The list is in descending order by START.
1067 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1070 ;; An RCS masterfile can be viewed as containing four regular (for the
1071 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1072 ;; the "description" and (d) the "rev bodies", in that order. In the
1073 ;; returned alist (see docstring), elements from (b) and (d) are
1074 ;; combined pairwise to form the "revisions", while those from (a) and
1075 ;; (c) are simply combined to form the "headers".
1076 ;;
1077 ;; Loosely speaking, each section contains a series of alternating
1078 ;; "tags" and "printed representations". In the (b) and (d), many
1079 ;; such series can appear, and a revision number on a line by itself
1080 ;; precedes the series of tags and printed representations associated
1081 ;; with it.
1082 ;;
1083 ;; In (a) and (b), the printed representations (with the exception of
1084 ;; the `comment' tag in the headers) terminate with a semicolon, which
1085 ;; is NOT part of the "value" finally associated with the tag. All
1086 ;; other printed representations are in "@@-format"; there is an "@",
1087 ;; the middle part (to be translated into the value), another "@" and
1088 ;; a newline. Each "@@" in the middle part indicates the position of
1089 ;; a single "@" (and consequently the requirement of an additional
1090 ;; initial step when translating to the value).
1091 ;;
1092 ;; Parser state includes vars that collect parts of the return value...
1094 ;; ... as well as vars that support a single-pass, tag-assisted,
1095 ;; minimal-data-copying scan. Basically -- skirting around the
1096 ;; grouping by revision required in (b) and (d) -- we repeatedly
1097 ;; and context-sensitively read a tag (that MUST be present),
1098 ;; determine the bounds of the printed representation, translate
1099 ;; it into a value, and push the tag plus value onto one of the
1100 ;; collection vars. Finally, we return the parse tree
1101 ;; incorporating the values of the collection vars (see "rv").
1102 ;;
1103 ;; A symbol or string to keep track of context (for error messages).
1104 context
1105 ;; A symbol, the current tag.
1106 tok
1107 ;; Region (begin and end buffer positions) of the printed
1108 ;; representation for the current tag.
1109 b e
1110 ;; A list of buffer positions where "@@" can be found within the
1111 ;; printed representation region. For each location, we push two
1112 ;; elements onto the list, 1+ and 2+ the location, respectively,
1113 ;; with the 2+ appearing at the head. In this way, the expression
1114 ;; `(,e ,@@-holes ,b)
1115 ;; describes regions that can be concatenated (in reverse order)
1116 ;; to "de-@@-format" the printed representation as the first step
1117 ;; to translating it into some value. See internal func `gather'.
1146 acc)
1150 acc)
1159 ;; headers
1173 two))
1179 t))
1180 headers)
1188 ;; rev headers
1197 b e)
1199 ;; Hack the year -- verified to be the
1200 ;; same algorithm used in RCS 5.7.
1210 revs)
1213 ;; desc
1216 ;; rev bodies
1218 ;; Element of `revs' that initially holds only header info.
1219 ;; "Pairwise combination" occurs when we add body info.
1220 rev
1221 ;; Components of the editing commands (aside from the actual
1222 ;; text) that comprise the `text' printed representations
1223 ;; (not including the "head" revision).
1224 cmd start act
1225 ;; Ascending (reversed) `@-holes' which the internal func
1226 ;; `incg' pops to effect incremental gathering.
1227 asc
1228 ;; Function to extract text (for the `a' command), either
1229 ;; `incg' or `buffer-substring-no-properties'. (This is
1230 ;; for speed; strictly speaking, it is sufficient to use
1231 ;; only the former since it behaves identically to the
1232 ;; latter in the absense of "@@".)
1233 sub)
1237 ;; Self-deprecate when work is done.
1238 ;; Folding many dimensions into one.
1239 ;; Thanks B.Mandelbrot, for complex sum.
1240 ;; O beauteous math! --the Unvexed Bum
1249 context))))
1251 ;; For rev body `text' tags, delay translation slightly...
1253 ;; ... until we decide which tag and value is appropriate to
1254 ;; collect. For the "head" revision, compute the value of the
1255 ;; `text' printed representation by simple `gather'. For all
1256 ;; other revisions, replace the `text' tag+value with `:insn'
1257 ;; plus value, always scanning in-place.
1273 (?d
1274 ;; `d' means "delete lines".
1275 ;; For Emacs spirit, we use `k' for "kill".
1277 (?a
1278 ;; `a' means "append after this line" but
1279 ;; internally we normalize it so that START
1280 ;; specifies the actual line for insert, thus
1281 ;; requiring less hair in the realization algs.
1282 ;; For Emacs spirit, we use `i' for "insert".
1287 cmd context)))
1288 acc))
1291 ;; rv
1297 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1298 ;;; vc-rcs.el ends here