| blob | 2df84eb3189fb70898f493c31e5cc191cb1797b7 |
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 of the License, or
16 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; See vc.el
30 ;; TODO:
31 ;; - remove call to vc-expand-dirs by implementing our own (which can just
32 ;; list the RCS subdir instead).
34 ;;; Code:
36 ;;;
37 ;;; Customization options
38 ;;;
45 "*The release number of your RCS installation, as a string.
46 If nil, VC itself computes this value when it is first needed."
53 "*Extra switches for registering a file in RCS.
54 A string or list of strings. These are passed to the checkin program
60 string))
65 "*A string or list of strings specifying extra switches for rcsdiff under VC."
70 string))
75 "*Header keywords to be inserted by `vc-insert-headers'."
81 "*Indicates whether rcsdiff understands the --brief option.
82 The value is either `yes', `no', or nil. If it is nil, VC tries
83 to use --brief and sets this variable to remember whether it worked."
87 ;;;###autoload
90 "*Where to look for RCS master files.
91 For a description of possible values, see `vc-check-master-templates'."
96 function)))
100 \f
101 ;;; Properties of the backend
106 "RCS-specific version of `vc-checkout-model'."
108 result)
117 ;;;
118 ;;; State-querying functions
119 ;;;
121 ;; The autoload cookie below places vc-rcs-registered directly into
122 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
123 ;; every file that is visited.
124 ;;;###autoload
129 "Implementation of `vc-state' for RCS."
131 'unregistered
136 ;; vc-working-revision might not be known; in that case the
137 ;; property is nil. vc-rcs-fetch-master-state knows how to
138 ;; handle that.
143 state
145 'up-to-date
147 'unlocked-changes
151 "State heuristic for RCS."
158 ;; If the headers say that the file is not locked, the
159 ;; permissions can tell us whether locking is used for
160 ;; the file or not.
168 'edited
172 state)
183 'edited
184 owner-name)
186 'edited
189 ;; Strange permissions. Fall through to
190 ;; expensive state computation.
195 ;; Doing individual vc-state calls is painful but tgere
196 ;; is no better way in RCS-land.
206 "RCS-specific version of `vc-working-revision'."
215 "Return non-nil if workfile version of FILE is the latest on its branch.
216 When VERSION is given, perform check for that version."
222 ;; Compare VERSION to the head version number.
225 ;; If we are not on the trunk, we need to examine the
226 ;; whole current branch.
231 "RCS-specific implementation of `vc-workfile-unchanged-p'."
232 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
233 ;; do a double take and remember the fact for the future
244 ;; The workfile is unchanged if rcsdiff found no differences.
255 \f
256 ;;;
257 ;;; State-changing functions
258 ;;;
261 "Create a new RCS repository."
262 ;; RCS is totally file-oriented, so all we have to do is make the directory
266 "Register FILES into the RCS version-control system.
267 REV is the optional revision number for the files. COMMENT can be used
268 to provide an initial description for each FILES.
270 `vc-register-switches' and `vc-rcs-register-switches' are passed to
271 the RCS command (in that order).
273 Automatically retrieve a read-only version of the file with keywords
274 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
285 ;; if available, use the secure registering option
290 ;; parse output to find master file name and workfile version
297 ;; if we couldn't find the master name,
298 ;; run vc-rcs-registered to get it
299 ;; (will be stored into the vc-name property)
303 name
305 name
310 nil t)
314 "Return non-nil if RCS thinks it would be responsible for registering FILE."
315 ;; TODO: check for all the patterns in vc-rcs-master-templates
319 "Implementation of receive-file for RCS."
327 "Unregister FILE from RCS.
328 If this leaves the RCS subdirectory empty, ask the user
329 whether to remove it."
338 ;; check whether RCS dir is empty, i.e. it does not
339 ;; contain any files except "." and ".."
346 "RCS-specific version of `vc-backend-checkin'."
348 ;; Now operate on the files
352 ;; Force branch creation if an appropriate
353 ;; default branch has been set.
355 default-branch
357 default-branch)
363 ;; if available, use the secure check-in option
367 switches)
370 ;; determine the new workfile version
380 ;; if we got to a different branch, adjust the default
381 ;; branch accordingly
389 ;; If this is an old RCS release, we might have
390 ;; to remove a remaining lock.
392 ;; exit status of 1 is also accepted.
393 ;; It means that the lock was removed before.
405 "Retrieve a copy of a saved version of FILE."
407 switches)
410 ;; Change buffers to get local value of vc-checkout-switches.
413 ;; Save this buffer's default-directory
414 ;; and use save-excursion to make sure it is restored
415 ;; in the same buffer it was saved in.
418 ;; Adjust the default-directory so that the check-out creates
419 ;; the file in the right place.
422 ;; if we should go to the head of the trunk,
423 ;; clear the default branch first
426 ;; now do the checkout
429 ;; If locking is not strict, force to overwrite
430 ;; the writable workfile.
434 ;; a literal revision was specified
440 ;; no revision specified:
441 ;; use current workfile version
442 workrev
443 ;; REV is t ...
445 ;; ... go to head of current branch
447 ;; ... go to head of trunk
449 nil)
451 switches)
452 ;; determine the new workfile version
457 ;; if necessary, adjust the default branch
460 file
464 new-version)))))
468 "Roll back, undoing the most recent checkins of FILES."
477 discard file)))
481 ;; Check out the most recent remaining version. If it
482 ;; fails, because the whole branch got deleted, do a
483 ;; double-take and check out the version where the branch
484 ;; started.
496 ;; vc-do-command popped up a window with
497 ;; the error message. Get rid of it, by
498 ;; restoring the old window configuration.
500 ;; No, it was some other error: re-signal it.
504 "Revert FILE to the version it was based on."
510 "Merge changes into current working copy of FILE.
511 The changes are between FIRST-VERSION and SECOND-VERSION."
518 "Steal the lock on the current workfile for FILE and revision REV.
519 Needs RCS 5.6.2 or later for -M."
521 ;; Do a real checkout after stealing the lock, so that we see
522 ;; expanded headers.
526 "Modify the change comments change on FILES on a specified REV."
531 \f
532 ;;;
533 ;;; History functions
534 ;;;
537 "Get change log associated with FILE."
541 "Get a difference report using RCS between two sets of files."
551 "Remove all non-comment information from log output."
569 "Annotate FILE, inserting the results in BUFFER.
570 Optional arg REVISION is a revision to annotate from."
572 ;; Aside from the "head revision on the trunk", the instructions for
573 ;; each revision on the trunk are an ordered list of kill and insert
574 ;; commands necessary to go from the chronologically-following
575 ;; revision to this one. That is, associated with revision N are
576 ;; edits that applied to revision N+1 would result in revision N.
577 ;;
578 ;; On a branch, however, (some) things are inverted: the commands
579 ;; listed are those necessary to go from the chronologically-preceding
580 ;; revision to this one. That is, associated with revision N are
581 ;; edits that applied to revision N-1 would result in revision N.
582 ;;
583 ;; So, to get per-line history info, we apply reverse-chronological
584 ;; edits, starting with the head revision on the trunk, all the way
585 ;; back through the initial revision (typically "1.1" or similar),
586 ;; then apply forward-chronological edits -- keeping track of which
587 ;; revision is associated with each inserted line -- until we reach
588 ;; the desired revision for display (which may be either on the trunk
589 ;; or on a branch).
594 ;; The revision N whose instructions we currently are processing.
596 ;; Alist from the parse tree for N.
598 ;; Point and temporary string, respectively.
599 p s
600 ;; "Next-branch list". Nil means the desired revision to
601 ;; display lives on the trunk. Non-nil means it lives on a
602 ;; branch, in which case the value is a list of revision pairs
603 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
604 ;; links each series of revisions in the path from the initial
605 ;; revision to the desired revision to display.
606 nbls
607 ;; "Path-accumulate-predicate plus revision/date/author".
608 ;; Until set, forward-chronological edits are not accumulated.
609 ;; Once set, its value (updated every revision) is used for
610 ;; the text property `:vc-rcs-r/d/a' for inserts during
611 ;; processing of forward-chronological instructions for N.
612 ;; See internal func `r/d/a'.
613 prda
614 ;; List of forward-chronological instructions, each of the
615 ;; form: (POS . ACTION), where POS is a buffer position. If
616 ;; ACTION is a string, it is inserted, otherwise it is taken as
617 ;; the number of characters to be deleted.
618 path
619 ;; N+1. When `cur' is "", this is the initial revision.
620 pre)
625 ;; Find which branches (if any) must be included in the edits.
627 bpt kids)
631 ;; A branchpoint may have multiple children. Find the right one.
635 ;; Start with the full text.
638 ;; Apply reverse-chronological edits on the trunk, computing and
639 ;; accumulating forward-chronological edits after some point, for
640 ;; later.
647 ;; Start accumulating the forward-chronological edits when N+1
648 ;; on the trunk is either the desired revision to display, or
649 ;; the appropriate branchpoint for it. Do this before
650 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
654 ;; Edits in the parse tree specify a line number (in the buffer
655 ;; *BEFORE* editing occurs) to start from, but line numbers
656 ;; change as a result of edits. To DTRT, we apply edits in
657 ;; order of descending buffer position so that edits further
658 ;; down in the buffer occur first w/o corrupting specified
659 ;; buffer positions of edits occurring towards the beginning of
660 ;; the buffer. In this way we avoid using markers. A pleasant
661 ;; property of this approach is ability to push instructions
662 ;; onto `path' directly, w/o need to maintain rev boundaries.
677 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
678 ;; equivalent to pushing an insert instruction (of the entire buffer
679 ;; contents) onto `path' then erasing the buffer, but less wasteful.
681 ;; Now apply the forward-chronological edits for the trunk.
687 ;; Now apply the forward-chronological edits (directly from the
688 ;; parse-tree) for the branch(es), if necessary. We re-use vars
689 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
694 prda nil)
707 ;; Lastly, for each line, insert at bol nicely-formatted history info.
708 ;; We do two passes to collect summary information used to minimize
709 ;; the annotation's usage of screen real-estate: (1) Consider rendered
710 ;; width of revision plus author together as a unit; and (2) Omit
711 ;; author entirely if all authors are the same as the user.
716 rda w a)
726 ht)
734 " "
736 ls)
737 :vc-annotate-prefix t
745 ht)))
751 "Return the current time, based at midnight of the current day, and
752 encoded as fractional days."
757 "Return the time of the next annotation (as fraction of days)
758 systime, or nil if there is none. Also, reposition point."
767 \f
768 ;;;
769 ;;; Snapshot system
770 ;;;
773 "Assign to FILE's latest version a given NAME."
776 \f
777 ;;;
778 ;;; Miscellaneous
779 ;;;
782 "Check if the current file has any headers in it."
789 "Implementation of vc-clear-headers for RCS."
795 nil t)
799 ;; Just move the master file (using vc-rcs-master-templates).
802 \f
803 ;;;
804 ;;; Internal functions
805 ;;;
811 "Return non-nil if FILE is newer than its RCS master.
812 This likely means that FILE has been changed with respect
813 to its master version."
821 "Find most recent revision on BRANCH."
826 nil t)
835 "Compute the master file's idea of the state of FILE.
836 If a WORKFILE-VERSION is given, compute the state of that version,
837 otherwise determine the workfile version based on the master file.
838 This function sets the properties `vc-working-revision' and
839 `vc-checkout-model' to their correct values, based on the master
840 file."
850 ;; Workfile version not known yet. Determine that first. It
851 ;; is either the head of the trunk, the head of the default
852 ;; branch, or the "default branch" itself, if that is a full
853 ;; revision number.
855 ;; no default branch
860 ;; default branch is actually a revision
862 default-branch)
864 ;; else, search for the head of the default branch
870 ;; Check strict locking
875 ;; Compute state of workfile version
883 ;; not locked
887 ;; workfile version is latest on branch
888 'up-to-date
889 ;; workfile version is not latest on branch
891 ;; locked by the calling user
894 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
896 workfile-is-latest
898 'edited
899 ;; Locking is not used for the file, but the owner does
900 ;; have a lock, and there is a higher version on the current
901 ;; branch. Not sure if this can occur, and if it is right
902 ;; to use `needs-merge' in this case.
904 ;; locked by somebody else
906 locking-user)
911 "Search for RCS headers in FILE, and set properties accordingly.
913 Returns: nil if no headers were found
914 'rev if a workfile revision was found
915 'rev-and-lock if revision and lock info was found"
923 ;; search for $Id or $Header
924 ;; -------------------------
925 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
932 ;; if found, store the revision number ...
934 ;; ... and check for the locking state
942 ;; unlocked revision
946 ;; revision is locked by some user
950 ;; everything else: false
952 ;; unexpected information in
953 ;; keyword string --> quit
955 ;; search for $Revision
956 ;; --------------------
959 nil t)
960 ;; if found, store the revision number ...
962 ;; and see if there's any lock information
975 ;; else: nothing found
976 ;; -------------------
986 ;; If the file has headers, we don't want to query the
987 ;; master file, because that would eliminate all the
988 ;; performance gain the headers brought us. We therefore
989 ;; use a heuristic now to find out whether locking is used
990 ;; for this file. If we trust the file permissions, and the
991 ;; file is not locked, then if the file is read-only we
992 ;; assume that locking is used for the file, otherwise
993 ;; locking is not used.
999 status))))
1002 "Compare release numbers, represented as strings.
1003 Release components are assumed cardinal numbers, not decimal fractions
1004 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1005 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1006 of the string is found, or a non-numeric component shows up \(5.6.7 is
1008 some cases\). This code is suitable for existing RCS release numbers.
1009 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1030 "Return t if we have RELEASE or better."
1037 "Return the RCS release installed on this system, as a string.
1038 Return symbol UNKNOWN if the release cannot be deducted. The user can
1039 override this using variable `vc-rcs-release'.
1041 If the user has not set variable `vc-rcs-release' and it is nil,
1042 variable `vc-rcs-release' is set to the returned value."
1060 "Parse current buffer, presumed to be in RCS-style masterfile format.
1061 Optional arg BUFFER specifies another buffer to parse. Return an alist
1062 of two elements, w/ keys `headers' and `revisions' and values in turn
1063 sub-alists. For `headers', the values unless otherwise specified are
1064 strings and the keys are:
1066 desc -- description
1067 head -- latest revision
1069 absent if the head revision lies on the trunk
1070 access -- ???
1071 symbols -- sub-alist of (SYMBOL . REVISION) elements
1075 expand -- may be absent; ???
1077 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1078 with string values (unless otherwise specified) and keys:
1080 date -- a time value (like that returned by `encode-time'); as a
1081 special case, a year value less than 100 is augmented by 1900
1082 author -- username
1084 branches -- list of revisions that begin branches from this revision
1087 log -- change log entry
1088 text -- for the head revision on the trunk, the body of the file;
1089 other revisions have `:insn' instead
1090 :insn -- for non-head revisions, a list of parsed instructions
1093 - `(START k COUNT)' -- kill COUNT lines
1094 - `(START i TEXT)' -- insert TEXT (a string)
1095 The list is in descending order by START.
1097 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1100 ;; An RCS masterfile can be viewed as containing four regular (for the
1101 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1102 ;; the "description" and (d) the "rev bodies", in that order. In the
1103 ;; returned alist (see docstring), elements from (b) and (d) are
1104 ;; combined pairwise to form the "revisions", while those from (a) and
1105 ;; (c) are simply combined to form the "headers".
1106 ;;
1107 ;; Loosely speaking, each section contains a series of alternating
1108 ;; "tags" and "printed representations". In the (b) and (d), many
1109 ;; such series can appear, and a revision number on a line by itself
1110 ;; precedes the series of tags and printed representations associated
1111 ;; with it.
1112 ;;
1113 ;; In (a) and (b), the printed representations (with the exception of
1114 ;; the `comment' tag in the headers) terminate with a semicolon, which
1115 ;; is NOT part of the "value" finally associated with the tag. All
1116 ;; other printed representations are in "@@-format"; there is an "@",
1117 ;; the middle part (to be translated into the value), another "@" and
1118 ;; a newline. Each "@@" in the middle part indicates the position of
1119 ;; a single "@" (and consequently the requirement of an additional
1120 ;; initial step when translating to the value).
1121 ;;
1122 ;; Parser state includes vars that collect parts of the return value...
1124 ;; ... as well as vars that support a single-pass, tag-assisted,
1125 ;; minimal-data-copying scan. Basically -- skirting around the
1126 ;; grouping by revision required in (b) and (d) -- we repeatedly
1127 ;; and context-sensitively read a tag (that MUST be present),
1128 ;; determine the bounds of the printed representation, translate
1129 ;; it into a value, and push the tag plus value onto one of the
1130 ;; collection vars. Finally, we return the parse tree
1131 ;; incorporating the values of the collection vars (see "rv").
1132 ;;
1133 ;; A symbol or string to keep track of context (for error messages).
1134 context
1135 ;; A symbol, the current tag.
1136 tok
1137 ;; Region (begin and end buffer positions) of the printed
1138 ;; representation for the current tag.
1139 b e
1140 ;; A list of buffer positions where "@@" can be found within the
1141 ;; printed representation region. For each location, we push two
1142 ;; elements onto the list, 1+ and 2+ the location, respectively,
1143 ;; with the 2+ appearing at the head. In this way, the expression
1144 ;; `(,e ,@@-holes ,b)
1145 ;; describes regions that can be concatenated (in reverse order)
1146 ;; to "de-@@-format" the printed representation as the first step
1147 ;; to translating it into some value. See internal func `gather'.
1176 acc)
1180 acc)
1189 ;; headers
1203 two))
1209 t))
1210 headers)
1218 ;; rev headers
1227 b e)
1229 ;; Hack the year -- verified to be the
1230 ;; same algorithm used in RCS 5.7.
1240 revs)
1243 ;; desc
1246 ;; rev bodies
1248 ;; Element of `revs' that initially holds only header info.
1249 ;; "Pairwise combination" occurs when we add body info.
1250 rev
1251 ;; Components of the editing commands (aside from the actual
1252 ;; text) that comprise the `text' printed representations
1253 ;; (not including the "head" revision).
1254 cmd start act
1255 ;; Ascending (reversed) `@-holes' which the internal func
1256 ;; `incg' pops to effect incremental gathering.
1257 asc
1258 ;; Function to extract text (for the `a' command), either
1259 ;; `incg' or `buffer-substring-no-properties'. (This is
1260 ;; for speed; strictly speaking, it is sufficient to use
1261 ;; only the former since it behaves identically to the
1262 ;; latter in the absense of "@@".)
1263 sub)
1267 ;; Self-deprecate when work is done.
1268 ;; Folding many dimensions into one.
1269 ;; Thanks B.Mandelbrot, for complex sum.
1270 ;; O beauteous math! --the Unvexed Bum
1279 context))))
1281 ;; For rev body `text' tags, delay translation slightly...
1283 ;; ... until we decide which tag and value is appropriate to
1284 ;; collect. For the "head" revision, compute the value of the
1285 ;; `text' printed representation by simple `gather'. For all
1286 ;; other revisions, replace the `text' tag+value with `:insn'
1287 ;; plus value, always scanning in-place.
1303 (?d
1304 ;; `d' means "delete lines".
1305 ;; For Emacs spirit, we use `k' for "kill".
1307 (?a
1308 ;; `a' means "append after this line" but
1309 ;; internally we normalize it so that START
1310 ;; specifies the actual line for insert, thus
1311 ;; requiring less hair in the realization algs.
1312 ;; For Emacs spirit, we use `i' for "insert".
1317 cmd context)))
1318 acc))
1321 ;; rv
1327 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1328 ;;; vc-rcs.el ends here