| blob | 1c3b4c00e3202277075a9ddb9b583a97fff2548d |
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, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: FSF (see vc.el for full credits)
8 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
9 ;; Package: vc
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 ;; Some features will not work with old RCS versions. Where
31 ;; appropriate, VC finds out which version you have, and allows or
32 ;; disallows those features (stealing locks, for example, works only
33 ;; from 5.6.2 onwards).
34 ;; Even initial checkins will fail if your RCS version is so old that ci
35 ;; doesn't understand -t-; this has been known to happen to people running
36 ;; NExTSTEP 3.0.
37 ;;
38 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
40 ;;; Code:
42 ;;;
43 ;;; Customization options
44 ;;;
51 "The release number of your RCS installation, as a string.
52 If nil, VC itself computes this value when it is first needed."
59 "Switches for registering a file in RCS.
60 A string or list of strings passed to the checkin program by
62 If t, use no switches."
71 "String or list of strings specifying switches for RCS diff under VC.
72 If nil, use the value of `vc-diff-switches'. If t, use no switches."
81 "Header keywords to be inserted by `vc-insert-headers'."
87 "Indicates whether rcsdiff understands the --brief option.
88 The value is either `yes', `no', or nil. If it is nil, VC tries
89 to use --brief and sets this variable to remember whether it worked."
93 ;;;###autoload
96 "Where to look for RCS master files.
97 For a description of possible values, see `vc-check-master-templates'."
102 function)))
106 \f
107 ;;; Properties of the backend
112 "RCS-specific version of `vc-checkout-model'."
114 result)
123 ;;;
124 ;;; State-querying functions
125 ;;;
127 ;; The autoload cookie below places vc-rcs-registered directly into
128 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
129 ;; every file that is visited.
130 ;;;###autoload
135 "Implementation of `vc-state' for RCS."
137 'unregistered
142 ;; vc-working-revision might not be known; in that case the
143 ;; property is nil. vc-rcs-fetch-master-state knows how to
144 ;; handle that.
149 state
151 'up-to-date
153 'unlocked-changes
157 "State heuristic for RCS."
164 ;; If the headers say that the file is not locked, the
165 ;; permissions can tell us whether locking is used for
166 ;; the file or not.
175 'edited
179 state)
190 'edited
191 owner-name)
193 'edited
196 ;; Strange permissions. Fall through to
197 ;; expensive state computation.
202 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
203 ;; should be changed to take a backend parameter. Using
204 ;; `vc-expand-dirs' is not TRTD because it returns files from
205 ;; multiple backends. It should also return 'unregistered files.
207 ;; Doing individual vc-state calls is painful but there
208 ;; is no better way in RCS-land.
220 "RCS-specific version of `vc-working-revision'."
229 "Return non-nil if workfile version of FILE is the latest on its branch.
230 When VERSION is given, perform check for that version."
236 ;; Compare VERSION to the head version number.
239 ;; If we are not on the trunk, we need to examine the
240 ;; whole current branch.
245 "RCS-specific implementation of `vc-workfile-unchanged-p'."
246 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
247 ;; do a double take and remember the fact for the future
258 ;; The workfile is unchanged if rcsdiff found no differences.
261 \f
262 ;;;
263 ;;; State-changing functions
264 ;;;
267 "Create a new RCS repository."
268 ;; RCS is totally file-oriented, so all we have to do is make the directory.
272 "Register FILES into the RCS version-control system.
273 REV is the optional revision number for the files. COMMENT can be used
274 to provide an initial description for each FILES.
275 Passes either `vc-rcs-register-switches' or `vc-register-switches'
276 to the RCS command.
278 Automatically retrieve a read-only version of the file with keywords
279 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
281 ;; When REV is specified, we need to force using "-t-".
292 ;; if available, use the secure registering option
297 ;; parse output to find master file name and workfile version
304 ;; if we couldn't find the master name,
305 ;; run vc-rcs-registered to get it
306 ;; (will be stored into the vc-name property)
310 name
312 name
317 nil t)
321 "Return non-nil if RCS thinks it would be responsible for registering FILE."
322 ;; TODO: check for all the patterns in vc-rcs-master-templates
326 "Implementation of receive-file for RCS."
334 "Unregister FILE from RCS.
335 If this leaves the RCS subdirectory empty, ask the user
336 whether to remove it."
345 ;; check whether RCS dir is empty, i.e. it does not
346 ;; contain any files except "." and ".."
353 "RCS-specific version of `vc-backend-checkin'."
355 ;; Now operate on the files
359 ;; Force branch creation if an appropriate
360 ;; default branch has been set.
362 default-branch
364 default-branch)
370 ;; if available, use the secure check-in option
374 switches)
377 ;; determine the new workfile version
387 ;; if we got to a different branch, adjust the default
388 ;; branch accordingly
396 ;; If this is an old RCS release, we might have
397 ;; to remove a remaining lock.
399 ;; exit status of 1 is also accepted.
400 ;; It means that the lock was removed before.
412 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
413 attempt the checkout for all registered files beneath it."
417 switches)
420 ;; Change buffers to get local value of vc-checkout-switches.
423 ;; Save this buffer's default-directory
424 ;; and use save-excursion to make sure it is restored
425 ;; in the same buffer it was saved in.
428 ;; Adjust the default-directory so that the check-out creates
429 ;; the file in the right place.
432 ;; if we should go to the head of the trunk,
433 ;; clear the default branch first
436 ;; now do the checkout
439 ;; If locking is not strict, force to overwrite
440 ;; the writable workfile.
444 ;; a literal revision was specified
450 ;; no revision specified:
451 ;; use current workfile version
452 workrev
453 ;; REV is t ...
455 ;; ... go to head of current branch
457 ;; ... go to head of trunk
459 nil)
461 switches)
462 ;; determine the new workfile version
467 ;; if necessary, adjust the default branch
470 file
474 new-version)))))
478 "Roll back, undoing the most recent checkins of FILES. Directories are
479 expanded to all registered subfiles in them."
488 discard file)))
492 ;; Check out the most recent remaining version. If it
493 ;; fails, because the whole branch got deleted, do a
494 ;; double-take and check out the version where the branch
495 ;; started.
507 ;; vc-do-command popped up a window with
508 ;; the error message. Get rid of it, by
509 ;; restoring the old window configuration.
511 ;; No, it was some other error: re-signal it.
515 "Revert FILE to the version it was based on. If FILE is a directory,
516 revert all registered files beneath it."
524 "Merge changes into current working copy of FILE.
525 The changes are between FIRST-VERSION and SECOND-VERSION."
532 "Steal the lock on the current workfile for FILE and revision REV.
533 If FILE is a directory, steal the lock on all registered files beneath it.
534 Needs RCS 5.6.2 or later for -M."
538 ;; Do a real checkout after stealing the lock, so that we see
539 ;; expanded headers.
543 "Modify the change comments change on FILES on a specified REV. If FILE is a
544 directory the operation is applied to all registered files beneath it."
549 \f
550 ;;;
551 ;;; History functions
552 ;;;
566 "Get change log associated with FILE. If FILE is a
567 directory the operation is applied to all registered files beneath it."
574 "Get a difference report using RCS between two sets of files."
584 "Return a string with all log entries stored in BACKEND for FILE."
586 ;; Has to be written this way, this function is used by the CVS backend too
588 ;; Remove cruft
604 ;; Return the de-crufted comment list
608 "Annotate FILE, inserting the results in BUFFER.
609 Optional arg REVISION is a revision to annotate from."
611 ;; Aside from the "head revision on the trunk", the instructions for
612 ;; each revision on the trunk are an ordered list of kill and insert
613 ;; commands necessary to go from the chronologically-following
614 ;; revision to this one. That is, associated with revision N are
615 ;; edits that applied to revision N+1 would result in revision N.
616 ;;
617 ;; On a branch, however, (some) things are inverted: the commands
618 ;; listed are those necessary to go from the chronologically-preceding
619 ;; revision to this one. That is, associated with revision N are
620 ;; edits that applied to revision N-1 would result in revision N.
621 ;;
622 ;; So, to get per-line history info, we apply reverse-chronological
623 ;; edits, starting with the head revision on the trunk, all the way
624 ;; back through the initial revision (typically "1.1" or similar),
625 ;; then apply forward-chronological edits -- keeping track of which
626 ;; revision is associated with each inserted line -- until we reach
627 ;; the desired revision for display (which may be either on the trunk
628 ;; or on a branch).
633 ;; The revision N whose instructions we currently are processing.
635 ;; Alist from the parse tree for N.
637 ;; Point and temporary string, respectively.
638 p s
639 ;; "Next-branch list". Nil means the desired revision to
640 ;; display lives on the trunk. Non-nil means it lives on a
641 ;; branch, in which case the value is a list of revision pairs
642 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
643 ;; links each series of revisions in the path from the initial
644 ;; revision to the desired revision to display.
645 nbls
646 ;; "Path-accumulate-predicate plus revision/date/author".
647 ;; Until set, forward-chronological edits are not accumulated.
648 ;; Once set, its value (updated every revision) is used for
649 ;; the text property `:vc-rcs-r/d/a' for inserts during
650 ;; processing of forward-chronological instructions for N.
651 ;; See internal func `r/d/a'.
652 prda
653 ;; List of forward-chronological instructions, each of the
654 ;; form: (POS . ACTION), where POS is a buffer position. If
655 ;; ACTION is a string, it is inserted, otherwise it is taken as
656 ;; the number of characters to be deleted.
657 path
658 ;; N+1. When `cur' is "", this is the initial revision.
659 pre)
664 ;; Find which branches (if any) must be included in the edits.
666 bpt kids)
670 ;; A branchpoint may have multiple children. Find the right one.
674 ;; Start with the full text.
677 ;; Apply reverse-chronological edits on the trunk, computing and
678 ;; accumulating forward-chronological edits after some point, for
679 ;; later.
686 ;; Start accumulating the forward-chronological edits when N+1
687 ;; on the trunk is either the desired revision to display, or
688 ;; the appropriate branchpoint for it. Do this before
689 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
693 ;; Edits in the parse tree specify a line number (in the buffer
694 ;; *BEFORE* editing occurs) to start from, but line numbers
695 ;; change as a result of edits. To DTRT, we apply edits in
696 ;; order of descending buffer position so that edits further
697 ;; down in the buffer occur first w/o corrupting specified
698 ;; buffer positions of edits occurring towards the beginning of
699 ;; the buffer. In this way we avoid using markers. A pleasant
700 ;; property of this approach is ability to push instructions
701 ;; onto `path' directly, w/o need to maintain rev boundaries.
717 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
718 ;; equivalent to pushing an insert instruction (of the entire buffer
719 ;; contents) onto `path' then erasing the buffer, but less wasteful.
721 ;; Now apply the forward-chronological edits for the trunk.
727 ;; Now apply the forward-chronological edits (directly from the
728 ;; parse-tree) for the branch(es), if necessary. We re-use vars
729 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
734 prda nil)
748 ;; Lastly, for each line, insert at bol nicely-formatted history info.
749 ;; We do two passes to collect summary information used to minimize
750 ;; the annotation's usage of screen real-estate: (1) Consider rendered
751 ;; width of revision plus author together as a unit; and (2) Omit
752 ;; author entirely if all authors are the same as the user.
757 rda w a)
767 ht)
775 " "
777 ls)
778 :vc-annotate-prefix t
786 ht)))
794 "Return the current time, based at midnight of the current day, and
795 encoded as fractional days."
800 "Return the time of the next annotation (as fraction of days)
801 systime, or nil if there is none. Also, reposition point."
810 \f
811 ;;;
812 ;;; Tag system
813 ;;;
822 dir
826 \f
827 ;;;
828 ;;; Miscellaneous
829 ;;;
832 "Return t if REV is a revision on the trunk."
836 "Return the minor revision number of a revision number REV."
841 "Return the revision number immediately preceding REV for FILE,
842 or nil if there is no previous revision. This default
843 implementation works for MAJOR.MINOR-style revision numbers as
844 used by RCS and CVS."
849 ;; revision does probably not start a branch or release
852 ;; we are at the beginning of the trunk --
853 ;; don't know anything to return here
854 nil
855 ;; we are at the beginning of a branch --
856 ;; return revision of starting point
860 "Return the revision number immediately following REV for FILE,
861 or nil if there is no next revision. This default implementation
862 works for MAJOR.MINOR-style revision numbers as used by RCS
863 and CVS."
870 "Default implementation of update-changelog.
871 Uses `rcs2log' which only works for RCS and CVS."
872 ;; FIXME: We (c|sh)ould add support for cvs2cl
875 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
879 temporary-file-directory))))
887 user-mail-address)))
901 exec-directory)
903 "-c" changelog
911 files)))
912 "done"
921 "Check if the current file has any headers in it."
928 "Implementation of vc-clear-headers for RCS."
934 nil t)
938 ;; Just move the master file (using vc-rcs-master-templates).
942 ;; If the file is locked by some other user, make
943 ;; the buffer read-only. Like this, even root
944 ;; cannot modify a file that someone else has locked.
948 \f
949 ;;;
950 ;;; Internal functions
951 ;;;
954 "Return non-nil if FILE is newer than its RCS master.
955 This likely means that FILE has been changed with respect
956 to its master version."
964 "Find most recent revision on BRANCH."
969 nil t)
978 "Compute the master file's idea of the state of FILE.
979 If a WORKING-REVISION is given, compute the state of that version,
980 otherwise determine the workfile version based on the master file.
981 This function sets the properties `vc-working-revision' and
982 `vc-checkout-model' to their correct values, based on the master
983 file."
993 ;; Workfile version not known yet. Determine that first. It
994 ;; is either the head of the trunk, the head of the default
995 ;; branch, or the "default branch" itself, if that is a full
996 ;; revision number.
998 ;; no default branch
1003 ;; default branch is actually a revision
1005 default-branch)
1007 ;; else, search for the head of the default branch
1013 ;; Check strict locking
1018 ;; Compute state of workfile version
1026 ;; not locked
1030 ;; workfile version is latest on branch
1031 'up-to-date
1032 ;; workfile version is not latest on branch
1034 ;; locked by the calling user
1037 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1039 workfile-is-latest
1041 'edited
1042 ;; Locking is not used for the file, but the owner does
1043 ;; have a lock, and there is a higher version on the current
1044 ;; branch. Not sure if this can occur, and if it is right
1045 ;; to use `needs-merge' in this case.
1047 ;; locked by somebody else
1049 locking-user)
1054 "Search for RCS headers in FILE, and set properties accordingly.
1056 Returns: nil if no headers were found
1057 'rev if a workfile revision was found
1058 'rev-and-lock if revision and lock info was found"
1066 ;; search for $Id or $Header
1067 ;; -------------------------
1068 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1075 ;; if found, store the revision number ...
1077 ;; ... and check for the locking state
1085 ;; unlocked revision
1089 ;; revision is locked by some user
1093 ;; everything else: false
1095 ;; unexpected information in
1096 ;; keyword string --> quit
1098 ;; search for $Revision
1099 ;; --------------------
1102 nil t)
1103 ;; if found, store the revision number ...
1105 ;; and see if there's any lock information
1118 ;; else: nothing found
1119 ;; -------------------
1129 ;; If the file has headers, we don't want to query the
1130 ;; master file, because that would eliminate all the
1131 ;; performance gain the headers brought us. We therefore
1132 ;; use a heuristic now to find out whether locking is used
1133 ;; for this file. If we trust the file permissions, and the
1134 ;; file is not locked, then if the file is read-only we
1135 ;; assume that locking is used for the file, otherwise
1136 ;; locking is not used.
1142 status))))
1145 "Compare release numbers, represented as strings.
1146 Release components are assumed cardinal numbers, not decimal fractions
1147 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1148 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1149 of the string is found, or a non-numeric component shows up \(5.6.7 is
1151 some cases\). This code is suitable for existing RCS release numbers.
1152 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1173 "Return t if we have RELEASE or better."
1180 "Return the RCS release installed on this system, as a string.
1181 Return symbol `unknown' if the release cannot be deducted. The user can
1182 override this using variable `vc-rcs-release'.
1184 If the user has not set variable `vc-rcs-release' and it is nil,
1185 variable `vc-rcs-release' is set to the returned value."
1203 "Parse current buffer, presumed to be in RCS-style masterfile format.
1204 Optional arg BUFFER specifies another buffer to parse. Return an alist
1205 of two elements, w/ keys `headers' and `revisions' and values in turn
1206 sub-alists. For `headers', the values unless otherwise specified are
1207 strings and the keys are:
1209 desc -- description
1210 head -- latest revision
1212 absent if the head revision lies on the trunk
1213 access -- ???
1214 symbols -- sub-alist of (SYMBOL . REVISION) elements
1218 expand -- may be absent; ???
1220 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1221 with string values (unless otherwise specified) and keys:
1223 date -- a time value (like that returned by `encode-time'); as a
1224 special case, a year value less than 100 is augmented by 1900
1225 author -- username
1227 branches -- list of revisions that begin branches from this revision
1230 log -- change log entry
1231 text -- for the head revision on the trunk, the body of the file;
1232 other revisions have `:insn' instead
1233 :insn -- for non-head revisions, a list of parsed instructions
1236 - `(START k COUNT)' -- kill COUNT lines
1237 - `(START i TEXT)' -- insert TEXT (a string)
1238 The list is in descending order by START.
1240 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1243 ;; An RCS masterfile can be viewed as containing four regular (for the
1244 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1245 ;; the "description" and (d) the "rev bodies", in that order. In the
1246 ;; returned alist (see docstring), elements from (b) and (d) are
1247 ;; combined pairwise to form the "revisions", while those from (a) and
1248 ;; (c) are simply combined to form the "headers".
1249 ;;
1250 ;; Loosely speaking, each section contains a series of alternating
1251 ;; "tags" and "printed representations". In the (b) and (d), many
1252 ;; such series can appear, and a revision number on a line by itself
1253 ;; precedes the series of tags and printed representations associated
1254 ;; with it.
1255 ;;
1256 ;; In (a) and (b), the printed representations (with the exception of
1257 ;; the `comment' tag in the headers) terminate with a semicolon, which
1258 ;; is NOT part of the "value" finally associated with the tag. All
1259 ;; other printed representations are in "@@-format"; there is an "@",
1260 ;; the middle part (to be translated into the value), another "@" and
1261 ;; a newline. Each "@@" in the middle part indicates the position of
1262 ;; a single "@" (and consequently the requirement of an additional
1263 ;; initial step when translating to the value).
1264 ;;
1265 ;; Parser state includes vars that collect parts of the return value...
1267 ;; ... as well as vars that support a single-pass, tag-assisted,
1268 ;; minimal-data-copying scan. Basically -- skirting around the
1269 ;; grouping by revision required in (b) and (d) -- we repeatedly
1270 ;; and context-sensitively read a tag (that MUST be present),
1271 ;; determine the bounds of the printed representation, translate
1272 ;; it into a value, and push the tag plus value onto one of the
1273 ;; collection vars. Finally, we return the parse tree
1274 ;; incorporating the values of the collection vars (see "rv").
1275 ;;
1276 ;; A symbol or string to keep track of context (for error messages).
1277 context
1278 ;; A symbol, the current tag.
1279 tok
1280 ;; Region (begin and end buffer positions) of the printed
1281 ;; representation for the current tag.
1282 b e
1283 ;; A list of buffer positions where "@@" can be found within the
1284 ;; printed representation region. For each location, we push two
1285 ;; elements onto the list, 1+ and 2+ the location, respectively,
1286 ;; with the 2+ appearing at the head. In this way, the expression
1287 ;; `(,e ,@@-holes ,b)
1288 ;; describes regions that can be concatenated (in reverse order)
1289 ;; to "de-@@-format" the printed representation as the first step
1290 ;; to translating it into some value. See internal func `gather'.
1319 acc)
1323 acc)
1332 ;; headers
1346 two))
1352 t))
1353 headers)
1361 ;; rev headers
1370 b e)
1372 ;; Hack the year -- verified to be the
1373 ;; same algorithm used in RCS 5.7.
1383 revs)
1386 ;; desc
1389 ;; rev bodies
1391 ;; Element of `revs' that initially holds only header info.
1392 ;; "Pairwise combination" occurs when we add body info.
1393 rev
1394 ;; Components of the editing commands (aside from the actual
1395 ;; text) that comprise the `text' printed representations
1396 ;; (not including the "head" revision).
1397 cmd start act
1398 ;; Ascending (reversed) `@-holes' which the internal func
1399 ;; `incg' pops to effect incremental gathering.
1400 asc
1401 ;; Function to extract text (for the `a' command), either
1402 ;; `incg' or `buffer-substring-no-properties'. (This is
1403 ;; for speed; strictly speaking, it is sufficient to use
1404 ;; only the former since it behaves identically to the
1405 ;; latter in the absense of "@@".)
1406 sub)
1410 ;; Self-deprecate when work is done.
1411 ;; Folding many dimensions into one.
1412 ;; Thanks B.Mandelbrot, for complex sum.
1413 ;; O beauteous math! --the Unvexed Bum
1422 context))))
1424 ;; For rev body `text' tags, delay translation slightly...
1426 ;; ... until we decide which tag and value is appropriate to
1427 ;; collect. For the "head" revision, compute the value of the
1428 ;; `text' printed representation by simple `gather'. For all
1429 ;; other revisions, replace the `text' tag+value with `:insn'
1430 ;; plus value, always scanning in-place.
1446 (?d
1447 ;; `d' means "delete lines".
1448 ;; For Emacs spirit, we use `k' for "kill".
1450 (?a
1451 ;; `a' means "append after this line" but
1452 ;; internally we normalize it so that START
1453 ;; specifies the actual line for insert, thus
1454 ;; requiring less hair in the realization algs.
1455 ;; For Emacs spirit, we use `i' for "insert".
1460 cmd context)))
1461 acc))
1464 ;; rv
1470 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1471 ;;; vc-rcs.el ends here