| blob | 7f4b2066d2696bce519cce35a343e10084f22983 |
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, 2008 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 3, 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-working-revision 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-working-revision'."
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.
245 \f
246 ;;;
247 ;;; State-changing functions
248 ;;;
251 "Create a new RCS repository."
252 ;; RCS is totally file-oriented, so all we have to do is make the directory
256 "Register FILES into the RCS version-control system.
257 REV is the optional revision number for the files. COMMENT can be used
258 to provide an initial description for each FILES.
260 `vc-register-switches' and `vc-rcs-register-switches' are passed to
261 the RCS command (in that order).
263 Automatically retrieve a read-only version of the file with keywords
264 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
273 ;; if available, use the secure registering option
278 ;; parse output to find master file name and workfile version
285 ;; if we couldn't find the master name,
286 ;; run vc-rcs-registered to get it
287 ;; (will be stored into the vc-name property)
291 name
293 name
298 nil t)
302 "Return non-nil if RCS thinks it would be responsible for registering FILE."
303 ;; TODO: check for all the patterns in vc-rcs-master-templates
307 "Implementation of receive-file for RCS."
315 "Unregister FILE from RCS.
316 If this leaves the RCS subdirectory empty, ask the user
317 whether to remove it."
326 ;; check whether RCS dir is empty, i.e. it does not
327 ;; contain any files except "." and ".."
334 "RCS-specific version of `vc-backend-checkin'."
336 ;; Now operate on the files
340 ;; Force branch creation if an appropriate
341 ;; default branch has been set.
343 default-branch
345 default-branch)
351 ;; if available, use the secure check-in option
355 switches)
358 ;; determine the new workfile version
368 ;; if we got to a different branch, adjust the default
369 ;; branch accordingly
377 ;; If this is an old RCS release, we might have
378 ;; to remove a remaining lock.
380 ;; exit status of 1 is also accepted.
381 ;; It means that the lock was removed before.
393 "Retrieve a copy of a saved version of FILE."
395 switches)
398 ;; Change buffers to get local value of vc-checkout-switches.
401 ;; Save this buffer's default-directory
402 ;; and use save-excursion to make sure it is restored
403 ;; in the same buffer it was saved in.
406 ;; Adjust the default-directory so that the check-out creates
407 ;; the file in the right place.
410 ;; if we should go to the head of the trunk,
411 ;; clear the default branch first
414 ;; now do the checkout
417 ;; If locking is not strict, force to overwrite
418 ;; the writable workfile.
422 ;; a literal revision was specified
428 ;; no revision specified:
429 ;; use current workfile version
430 workrev
431 ;; REV is t ...
433 ;; ... go to head of current branch
435 ;; ... go to head of trunk
437 nil)
439 switches)
440 ;; determine the new workfile version
445 ;; if necessary, adjust the default branch
448 file
452 new-version)))))
456 "Roll back, undoing the most recent checkins of FILES."
465 discard file)))
469 ;; Check out the most recent remaining version. If it
470 ;; fails, because the whole branch got deleted, do a
471 ;; double-take and check out the version where the branch
472 ;; started.
484 ;; vc-do-command popped up a window with
485 ;; the error message. Get rid of it, by
486 ;; restoring the old window configuration.
488 ;; No, it was some other error: re-signal it.
492 "Revert FILE to the version it was based on."
498 "Merge changes into current working copy of FILE.
499 The changes are between FIRST-VERSION and SECOND-VERSION."
506 "Steal the lock on the current workfile for FILE and revision REV.
507 Needs RCS 5.6.2 or later for -M."
509 ;; Do a real checkout after stealing the lock, so that we see
510 ;; expanded headers.
514 "Modify the change comments change on FILES on a specified REV."
519 \f
520 ;;;
521 ;;; History functions
522 ;;;
525 "Get change log associated with FILE."
529 "Get a difference report using RCS between two sets of files."
539 "Remove all non-comment information from log output."
557 "Annotate FILE, inserting the results in BUFFER.
558 Optional arg REVISION is a revision to annotate from."
560 ;; Aside from the "head revision on the trunk", the instructions for
561 ;; each revision on the trunk are an ordered list of kill and insert
562 ;; commands necessary to go from the chronologically-following
563 ;; revision to this one. That is, associated with revision N are
564 ;; edits that applied to revision N+1 would result in revision N.
565 ;;
566 ;; On a branch, however, (some) things are inverted: the commands
567 ;; listed are those necessary to go from the chronologically-preceding
568 ;; revision to this one. That is, associated with revision N are
569 ;; edits that applied to revision N-1 would result in revision N.
570 ;;
571 ;; So, to get per-line history info, we apply reverse-chronological
572 ;; edits, starting with the head revision on the trunk, all the way
573 ;; back through the initial revision (typically "1.1" or similar),
574 ;; then apply forward-chronological edits -- keeping track of which
575 ;; revision is associated with each inserted line -- until we reach
576 ;; the desired revision for display (which may be either on the trunk
577 ;; or on a branch).
582 ;; The revision N whose instructions we currently are processing.
584 ;; Alist from the parse tree for N.
586 ;; Point and temporary string, respectively.
587 p s
588 ;; "Next-branch list". Nil means the desired revision to
589 ;; display lives on the trunk. Non-nil means it lives on a
590 ;; branch, in which case the value is a list of revision pairs
591 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
592 ;; links each series of revisions in the path from the initial
593 ;; revision to the desired revision to display.
594 nbls
595 ;; "Path-accumulate-predicate plus revision/date/author".
596 ;; Until set, forward-chronological edits are not accumulated.
597 ;; Once set, its value (updated every revision) is used for
598 ;; the text property `:vc-rcs-r/d/a' for inserts during
599 ;; processing of forward-chronological instructions for N.
600 ;; See internal func `r/d/a'.
601 prda
602 ;; List of forward-chronological instructions, each of the
603 ;; form: (POS . ACTION), where POS is a buffer position. If
604 ;; ACTION is a string, it is inserted, otherwise it is taken as
605 ;; the number of characters to be deleted.
606 path
607 ;; N+1. When `cur' is "", this is the initial revision.
608 pre)
613 ;; Find which branches (if any) must be included in the edits.
615 bpt kids)
619 ;; A branchpoint may have multiple children. Find the right one.
623 ;; Start with the full text.
626 ;; Apply reverse-chronological edits on the trunk, computing and
627 ;; accumulating forward-chronological edits after some point, for
628 ;; later.
635 ;; Start accumulating the forward-chronological edits when N+1
636 ;; on the trunk is either the desired revision to display, or
637 ;; the appropriate branchpoint for it. Do this before
638 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
642 ;; Edits in the parse tree specify a line number (in the buffer
643 ;; *BEFORE* editing occurs) to start from, but line numbers
644 ;; change as a result of edits. To DTRT, we apply edits in
645 ;; order of descending buffer position so that edits further
646 ;; down in the buffer occur first w/o corrupting specified
647 ;; buffer positions of edits occurring towards the beginning of
648 ;; the buffer. In this way we avoid using markers. A pleasant
649 ;; property of this approach is ability to push instructions
650 ;; onto `path' directly, w/o need to maintain rev boundaries.
665 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
666 ;; equivalent to pushing an insert instruction (of the entire buffer
667 ;; contents) onto `path' then erasing the buffer, but less wasteful.
669 ;; Now apply the forward-chronological edits for the trunk.
675 ;; Now apply the forward-chronological edits (directly from the
676 ;; parse-tree) for the branch(es), if necessary. We re-use vars
677 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
682 prda nil)
695 ;; Lastly, for each line, insert at bol nicely-formatted history info.
696 ;; We do two passes to collect summary information used to minimize
697 ;; the annotation's usage of screen real-estate: (1) Consider rendered
698 ;; width of revision plus author together as a unit; and (2) Omit
699 ;; author entirely if all authors are the same as the user.
704 rda w a)
714 ht)
722 " "
724 ls)
725 :vc-annotate-prefix t
733 ht)))
739 "Return the current time, based at midnight of the current day, and
740 encoded as fractional days."
745 "Return the time of the next annotation (as fraction of days)
746 systime, or nil if there is none. Also, reposition point."
755 \f
756 ;;;
757 ;;; Snapshot system
758 ;;;
761 "Assign to FILE's latest version a given NAME."
764 \f
765 ;;;
766 ;;; Miscellaneous
767 ;;;
770 "Check if the current file has any headers in it."
777 "Implementation of vc-clear-headers for RCS."
783 nil t)
787 ;; Just move the master file (using vc-rcs-master-templates).
790 \f
791 ;;;
792 ;;; Internal functions
793 ;;;
796 "Return non-nil if FILE is newer than its RCS master.
797 This likely means that FILE has been changed with respect
798 to its master version."
806 "Find most recent revision on BRANCH."
811 nil t)
820 "Compute the master file's idea of the state of FILE.
821 If a WORKFILE-VERSION is given, compute the state of that version,
822 otherwise determine the workfile version based on the master file.
823 This function sets the properties `vc-working-revision' and
824 `vc-checkout-model' to their correct values, based on the master
825 file."
835 ;; Workfile version not known yet. Determine that first. It
836 ;; is either the head of the trunk, the head of the default
837 ;; branch, or the "default branch" itself, if that is a full
838 ;; revision number.
840 ;; no default branch
845 ;; default branch is actually a revision
847 default-branch)
849 ;; else, search for the head of the default branch
855 ;; Check strict locking
860 ;; Compute state of workfile version
868 ;; not locked
872 ;; workfile version is latest on branch
873 'up-to-date
874 ;; workfile version is not latest on branch
876 ;; locked by the calling user
880 workfile-is-latest
882 'edited
883 ;; Locking is not used for the file, but the owner does
884 ;; have a lock, and there is a higher version on the current
885 ;; branch. Not sure if this can occur, and if it is right
886 ;; to use `needs-merge' in this case.
888 ;; locked by somebody else
890 locking-user)
895 "Search for RCS headers in FILE, and set properties accordingly.
897 Returns: nil if no headers were found
898 'rev if a workfile revision was found
899 'rev-and-lock if revision and lock info was found"
907 ;; search for $Id or $Header
908 ;; -------------------------
909 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
916 ;; if found, store the revision number ...
918 ;; ... and check for the locking state
926 ;; unlocked revision
930 ;; revision is locked by some user
934 ;; everything else: false
936 ;; unexpected information in
937 ;; keyword string --> quit
939 ;; search for $Revision
940 ;; --------------------
943 nil t)
944 ;; if found, store the revision number ...
946 ;; and see if there's any lock information
959 ;; else: nothing found
960 ;; -------------------
970 ;; If the file has headers, we don't want to query the
971 ;; master file, because that would eliminate all the
972 ;; performance gain the headers brought us. We therefore
973 ;; use a heuristic now to find out whether locking is used
974 ;; for this file. If we trust the file permissions, and the
975 ;; file is not locked, then if the file is read-only we
976 ;; assume that locking is used for the file, otherwise
977 ;; locking is not used.
983 status))))
986 "Compare release numbers, represented as strings.
987 Release components are assumed cardinal numbers, not decimal fractions
988 \(5.10 is a higher release than 5.9\). Omitted fields are considered
989 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
990 of the string is found, or a non-numeric component shows up \(5.6.7 is
992 some cases\). This code is suitable for existing RCS release numbers.
993 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1014 "Return t if we have RELEASE or better."
1021 "Return the RCS release installed on this system, as a string.
1022 Return symbol UNKNOWN if the release cannot be deducted. The user can
1023 override this using variable `vc-rcs-release'.
1025 If the user has not set variable `vc-rcs-release' and it is nil,
1026 variable `vc-rcs-release' is set to the returned value."
1044 "Parse current buffer, presumed to be in RCS-style masterfile format.
1045 Optional arg BUFFER specifies another buffer to parse. Return an alist
1046 of two elements, w/ keys `headers' and `revisions' and values in turn
1047 sub-alists. For `headers', the values unless otherwise specified are
1048 strings and the keys are:
1050 desc -- description
1051 head -- latest revision
1053 absent if the head revision lies on the trunk
1054 access -- ???
1055 symbols -- sub-alist of (SYMBOL . REVISION) elements
1059 expand -- may be absent; ???
1061 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1062 with string values (unless otherwise specified) and keys:
1064 date -- a time value (like that returned by `encode-time'); as a
1065 special case, a year value less than 100 is augmented by 1900
1066 author -- username
1068 branches -- list of revisions that begin branches from this revision
1071 log -- change log entry
1072 text -- for the head revision on the trunk, the body of the file;
1073 other revisions have `:insn' instead
1074 :insn -- for non-head revisions, a list of parsed instructions
1077 - `(START k COUNT)' -- kill COUNT lines
1078 - `(START i TEXT)' -- insert TEXT (a string)
1079 The list is in descending order by START.
1081 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1084 ;; An RCS masterfile can be viewed as containing four regular (for the
1085 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1086 ;; the "description" and (d) the "rev bodies", in that order. In the
1087 ;; returned alist (see docstring), elements from (b) and (d) are
1088 ;; combined pairwise to form the "revisions", while those from (a) and
1089 ;; (c) are simply combined to form the "headers".
1090 ;;
1091 ;; Loosely speaking, each section contains a series of alternating
1092 ;; "tags" and "printed representations". In the (b) and (d), many
1093 ;; such series can appear, and a revision number on a line by itself
1094 ;; precedes the series of tags and printed representations associated
1095 ;; with it.
1096 ;;
1097 ;; In (a) and (b), the printed representations (with the exception of
1098 ;; the `comment' tag in the headers) terminate with a semicolon, which
1099 ;; is NOT part of the "value" finally associated with the tag. All
1100 ;; other printed representations are in "@@-format"; there is an "@",
1101 ;; the middle part (to be translated into the value), another "@" and
1102 ;; a newline. Each "@@" in the middle part indicates the position of
1103 ;; a single "@" (and consequently the requirement of an additional
1104 ;; initial step when translating to the value).
1105 ;;
1106 ;; Parser state includes vars that collect parts of the return value...
1108 ;; ... as well as vars that support a single-pass, tag-assisted,
1109 ;; minimal-data-copying scan. Basically -- skirting around the
1110 ;; grouping by revision required in (b) and (d) -- we repeatedly
1111 ;; and context-sensitively read a tag (that MUST be present),
1112 ;; determine the bounds of the printed representation, translate
1113 ;; it into a value, and push the tag plus value onto one of the
1114 ;; collection vars. Finally, we return the parse tree
1115 ;; incorporating the values of the collection vars (see "rv").
1116 ;;
1117 ;; A symbol or string to keep track of context (for error messages).
1118 context
1119 ;; A symbol, the current tag.
1120 tok
1121 ;; Region (begin and end buffer positions) of the printed
1122 ;; representation for the current tag.
1123 b e
1124 ;; A list of buffer positions where "@@" can be found within the
1125 ;; printed representation region. For each location, we push two
1126 ;; elements onto the list, 1+ and 2+ the location, respectively,
1127 ;; with the 2+ appearing at the head. In this way, the expression
1128 ;; `(,e ,@@-holes ,b)
1129 ;; describes regions that can be concatenated (in reverse order)
1130 ;; to "de-@@-format" the printed representation as the first step
1131 ;; to translating it into some value. See internal func `gather'.
1160 acc)
1164 acc)
1173 ;; headers
1187 two))
1193 t))
1194 headers)
1202 ;; rev headers
1211 b e)
1213 ;; Hack the year -- verified to be the
1214 ;; same algorithm used in RCS 5.7.
1224 revs)
1227 ;; desc
1230 ;; rev bodies
1232 ;; Element of `revs' that initially holds only header info.
1233 ;; "Pairwise combination" occurs when we add body info.
1234 rev
1235 ;; Components of the editing commands (aside from the actual
1236 ;; text) that comprise the `text' printed representations
1237 ;; (not including the "head" revision).
1238 cmd start act
1239 ;; Ascending (reversed) `@-holes' which the internal func
1240 ;; `incg' pops to effect incremental gathering.
1241 asc
1242 ;; Function to extract text (for the `a' command), either
1243 ;; `incg' or `buffer-substring-no-properties'. (This is
1244 ;; for speed; strictly speaking, it is sufficient to use
1245 ;; only the former since it behaves identically to the
1246 ;; latter in the absense of "@@".)
1247 sub)
1251 ;; Self-deprecate when work is done.
1252 ;; Folding many dimensions into one.
1253 ;; Thanks B.Mandelbrot, for complex sum.
1254 ;; O beauteous math! --the Unvexed Bum
1263 context))))
1265 ;; For rev body `text' tags, delay translation slightly...
1267 ;; ... until we decide which tag and value is appropriate to
1268 ;; collect. For the "head" revision, compute the value of the
1269 ;; `text' printed representation by simple `gather'. For all
1270 ;; other revisions, replace the `text' tag+value with `:insn'
1271 ;; plus value, always scanning in-place.
1287 (?d
1288 ;; `d' means "delete lines".
1289 ;; For Emacs spirit, we use `k' for "kill".
1291 (?a
1292 ;; `a' means "append after this line" but
1293 ;; internally we normalize it so that START
1294 ;; specifies the actual line for insert, thus
1295 ;; requiring less hair in the realization algs.
1296 ;; For Emacs spirit, we use `i' for "insert".
1301 cmd context)))
1302 acc))
1305 ;; rv
1311 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1312 ;;; vc-rcs.el ends here