| blob | ecd7b826437fbd5a34170bf9abdd55d63b0fc1e5 |
1 ;;; vc-rcs.el --- support for RCS version-control
3 ;; Copyright (C) 1992-2012 Free Software Foundation, Inc.
5 ;; Author: FSF (see vc.el for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
7 ;; Package: vc
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; See vc.el
28 ;; Some features will not work with ancient RCS versions. Where
29 ;; appropriate, VC finds out which version you have, and allows or
30 ;; disallows those features.
32 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
34 ;;; Code:
36 ;;;
37 ;;; Customization options
38 ;;;
45 "VC RCS backend."
50 "The release number of your RCS installation, as a string.
51 If nil, VC itself computes this value when it is first needed."
58 "Switches for registering a file in RCS.
59 A string or list of strings passed to the checkin program by
61 If t, use no switches."
70 "String or list of strings specifying switches for RCS diff under VC.
71 If nil, use the value of `vc-diff-switches'. If t, use no switches."
80 "Header keywords to be inserted by `vc-insert-headers'."
86 "Indicates whether rcsdiff understands the --brief option.
87 The value is either `yes', `no', or nil. If it is nil, VC tries
88 to use --brief and sets this variable to remember whether it worked."
92 ;;;###autoload
95 "Where to look for RCS master files.
96 For a description of possible values, see `vc-check-master-templates'."
101 function)))
105 \f
106 ;;; Properties of the backend
111 "RCS-specific version of `vc-checkout-model'."
113 result)
122 ;;;
123 ;;; State-querying functions
124 ;;;
126 ;; The autoload cookie below places vc-rcs-registered directly into
127 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
128 ;; every file that is visited.
129 ;;;###autoload
134 "Implementation of `vc-state' for RCS."
136 'unregistered
141 ;; vc-working-revision might not be known; in that case the
142 ;; property is nil. vc-rcs-fetch-master-state knows how to
143 ;; handle that.
148 state
150 'up-to-date
152 'unlocked-changes
156 "State heuristic for RCS."
163 ;; If the headers say that the file is not locked, the
164 ;; permissions can tell us whether locking is used for
165 ;; the file or not.
174 'edited
178 state)
189 'edited
190 owner-name)
192 'edited
195 ;; Strange permissions. Fall through to
196 ;; expensive state computation.
201 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
202 ;; should be changed to take a backend parameter. Using
203 ;; `vc-expand-dirs' is not TRTD because it returns files from
204 ;; multiple backends. It should also return 'unregistered files.
206 ;; Doing individual vc-state calls is painful but there
207 ;; is no better way in RCS-land.
219 "RCS-specific version of `vc-working-revision'."
228 "Return non-nil if workfile version of FILE is the latest on its branch.
229 When VERSION is given, perform check for that version."
235 ;; Compare VERSION to the head version number.
238 ;; If we are not on the trunk, we need to examine the
239 ;; whole current branch.
244 "RCS-specific implementation of `vc-workfile-unchanged-p'."
245 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
246 ;; do a double take and remember the fact for the future
257 ;; The workfile is unchanged if rcsdiff found no differences.
260 \f
261 ;;;
262 ;;; State-changing functions
263 ;;;
266 "Create a new RCS repository."
267 ;; RCS is totally file-oriented, so all we have to do is make the directory.
271 "Register FILES into the RCS version-control system.
272 REV is the optional revision number for the files. COMMENT can be used
273 to provide an initial description for each FILES.
274 Passes either `vc-rcs-register-switches' or `vc-register-switches'
275 to the RCS command.
277 Automatically retrieve a read-only version of the file with keywords
278 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
280 ;; When REV is specified, we need to force using "-t-".
291 ;; if available, use the secure registering option
296 ;; parse output to find master file name and workfile version
303 ;; if we couldn't find the master name,
304 ;; run vc-rcs-registered to get it
305 ;; (will be stored into the vc-name property)
309 name
311 name
316 nil t)
320 "Return non-nil if RCS thinks it would be responsible for registering FILE."
321 ;; TODO: check for all the patterns in vc-rcs-master-templates
324 file
328 "Implementation of receive-file for RCS."
336 "Unregister FILE from RCS.
337 If this leaves the RCS subdirectory empty, ask the user
338 whether to remove it."
347 ;; check whether RCS dir is empty, i.e. it does not
348 ;; contain any files except "." and ".."
355 "RCS-specific version of `vc-backend-checkin'."
357 ;; Now operate on the files
361 ;; Force branch creation if an appropriate
362 ;; default branch has been set.
364 default-branch
366 default-branch)
372 ;; if available, use the secure check-in option
376 switches)
379 ;; determine the new workfile version
389 ;; if we got to a different branch, adjust the default
390 ;; branch accordingly
398 ;; If this is an old (pre-1992!) RCS release, we might have
399 ;; to remove a remaining lock.
401 ;; exit status of 1 is also accepted.
402 ;; It means that the lock was removed before.
414 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
415 attempt the checkout for all registered files beneath it."
419 switches)
422 ;; Change buffers to get local value of vc-checkout-switches.
425 ;; Save this buffer's default-directory
426 ;; and use save-excursion to make sure it is restored
427 ;; in the same buffer it was saved in.
430 ;; Adjust the default-directory so that the check-out creates
431 ;; the file in the right place.
434 ;; if we should go to the head of the trunk,
435 ;; clear the default branch first
438 ;; now do the checkout
441 ;; If locking is not strict, force to overwrite
442 ;; the writable workfile.
446 ;; a literal revision was specified
452 ;; no revision specified:
453 ;; use current workfile version
454 workrev
455 ;; REV is t ...
457 ;; ... go to head of current branch
459 ;; ... go to head of trunk
461 nil)
463 switches)
464 ;; determine the new workfile version
469 ;; if necessary, adjust the default branch
472 file
476 new-version)))))
480 "Roll back, undoing the most recent checkins of FILES. Directories are
481 expanded to all registered subfiles in them."
490 discard file)))
494 ;; Check out the most recent remaining version. If it
495 ;; fails, because the whole branch got deleted, do a
496 ;; double-take and check out the version where the branch
497 ;; started.
509 ;; vc-do-command popped up a window with
510 ;; the error message. Get rid of it, by
511 ;; restoring the old window configuration.
513 ;; No, it was some other error: re-signal it.
517 "Revert FILE to the version it was based on. If FILE is a directory,
518 revert all registered files beneath it."
526 "Merge changes into current working copy of FILE.
527 The changes are between FIRST-VERSION and SECOND-VERSION."
534 "Steal the lock on the current workfile for FILE and revision REV.
535 If FILE is a directory, steal the lock on all registered files beneath it.
536 Needs RCS 5.6.2 or later for -M."
540 ;; Do a real checkout after stealing the lock, so that we see
541 ;; expanded headers.
545 "Modify the change comments change on FILES on a specified REV. If FILE is a
546 directory the operation is applied to all registered files beneath it."
551 \f
552 ;;;
553 ;;; History functions
554 ;;;
568 "Get change log associated with FILE. If FILE is a
569 directory the operation is applied to all registered files beneath it."
576 "Get a difference report using RCS between two sets of files."
586 "Return a string with all log entries stored in BACKEND for FILE."
588 ;; Has to be written this way, this function is used by the CVS backend too
590 ;; Remove cruft
606 ;; Return the de-crufted comment list
610 "Annotate FILE, inserting the results in BUFFER.
611 Optional arg REVISION is a revision to annotate from."
613 ;; Aside from the "head revision on the trunk", the instructions for
614 ;; each revision on the trunk are an ordered list of kill and insert
615 ;; commands necessary to go from the chronologically-following
616 ;; revision to this one. That is, associated with revision N are
617 ;; edits that applied to revision N+1 would result in revision N.
618 ;;
619 ;; On a branch, however, (some) things are inverted: the commands
620 ;; listed are those necessary to go from the chronologically-preceding
621 ;; revision to this one. That is, associated with revision N are
622 ;; edits that applied to revision N-1 would result in revision N.
623 ;;
624 ;; So, to get per-line history info, we apply reverse-chronological
625 ;; edits, starting with the head revision on the trunk, all the way
626 ;; back through the initial revision (typically "1.1" or similar),
627 ;; then apply forward-chronological edits -- keeping track of which
628 ;; revision is associated with each inserted line -- until we reach
629 ;; the desired revision for display (which may be either on the trunk
630 ;; or on a branch).
635 ;; The revision N whose instructions we currently are processing.
637 ;; Alist from the parse tree for N.
639 ;; Point and temporary string, respectively.
640 p s
641 ;; "Next-branch list". Nil means the desired revision to
642 ;; display lives on the trunk. Non-nil means it lives on a
643 ;; branch, in which case the value is a list of revision pairs
644 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
645 ;; links each series of revisions in the path from the initial
646 ;; revision to the desired revision to display.
647 nbls
648 ;; "Path-accumulate-predicate plus revision/date/author".
649 ;; Until set, forward-chronological edits are not accumulated.
650 ;; Once set, its value (updated every revision) is used for
651 ;; the text property `:vc-rcs-r/d/a' for inserts during
652 ;; processing of forward-chronological instructions for N.
653 ;; See internal func `r/d/a'.
654 prda
655 ;; List of forward-chronological instructions, each of the
656 ;; form: (POS . ACTION), where POS is a buffer position. If
657 ;; ACTION is a string, it is inserted, otherwise it is taken as
658 ;; the number of characters to be deleted.
659 path
660 ;; N+1. When `cur' is "", this is the initial revision.
661 pre)
666 ;; Find which branches (if any) must be included in the edits.
668 bpt kids)
672 ;; A branchpoint may have multiple children. Find the right one.
676 ;; Start with the full text.
679 ;; Apply reverse-chronological edits on the trunk, computing and
680 ;; accumulating forward-chronological edits after some point, for
681 ;; later.
688 ;; Start accumulating the forward-chronological edits when N+1
689 ;; on the trunk is either the desired revision to display, or
690 ;; the appropriate branchpoint for it. Do this before
691 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
695 ;; Edits in the parse tree specify a line number (in the buffer
696 ;; *BEFORE* editing occurs) to start from, but line numbers
697 ;; change as a result of edits. To DTRT, we apply edits in
698 ;; order of descending buffer position so that edits further
699 ;; down in the buffer occur first w/o corrupting specified
700 ;; buffer positions of edits occurring towards the beginning of
701 ;; the buffer. In this way we avoid using markers. A pleasant
702 ;; property of this approach is ability to push instructions
703 ;; onto `path' directly, w/o need to maintain rev boundaries.
719 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
720 ;; equivalent to pushing an insert instruction (of the entire buffer
721 ;; contents) onto `path' then erasing the buffer, but less wasteful.
723 ;; Now apply the forward-chronological edits for the trunk.
729 ;; Now apply the forward-chronological edits (directly from the
730 ;; parse-tree) for the branch(es), if necessary. We re-use vars
731 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
736 prda nil)
750 ;; Lastly, for each line, insert at bol nicely-formatted history info.
751 ;; We do two passes to collect summary information used to minimize
752 ;; the annotation's usage of screen real-estate: (1) Consider rendered
753 ;; width of revision plus author together as a unit; and (2) Omit
754 ;; author entirely if all authors are the same as the user.
759 rda w a)
769 ht)
777 " "
779 ls)
780 :vc-annotate-prefix t
788 ht)))
796 "Return the current time, based at midnight of the current day, and
797 encoded as fractional days."
802 "Return the time of the next annotation (as fraction of days)
803 systime, or nil if there is none. Also, reposition point."
812 \f
813 ;;;
814 ;;; Tag system
815 ;;;
824 dir
828 \f
829 ;;;
830 ;;; Miscellaneous
831 ;;;
834 "Return t if REV is a revision on the trunk."
838 "Return the minor revision number of a revision number REV."
843 "Return the revision number immediately preceding REV for FILE,
844 or nil if there is no previous revision. This default
845 implementation works for MAJOR.MINOR-style revision numbers as
846 used by RCS and CVS."
851 ;; revision does probably not start a branch or release
854 ;; we are at the beginning of the trunk --
855 ;; don't know anything to return here
856 nil
857 ;; we are at the beginning of a branch --
858 ;; return revision of starting point
862 "Return the revision number immediately following REV for FILE,
863 or nil if there is no next revision. This default implementation
864 works for MAJOR.MINOR-style revision numbers as used by RCS
865 and CVS."
871 ;; Note that most GNU/Linux distributions seem to supply rcs2log in a
872 ;; standard bin directory. Eg both Red Hat and Debian include it in
873 ;; their cvs packages. It's not obvious why Emacs still needs to
874 ;; provide it as well...
879 exe)
880 ;; In the unlikely event that someone is running an
881 ;; uninstalled Emacs and wants to do something RCS-related.
884 exe)
889 "Default implementation of update-changelog.
890 Uses `rcs2log' which only works for RCS and CVS."
891 ;; FIXME: We (c|sh)ould add support for cvs2cl
894 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
898 temporary-file-directory))))
906 user-mail-address)))
920 "-c" changelog
928 files)))
929 "done"
938 "Check if the current file has any headers in it."
945 "Implementation of vc-clear-headers for RCS."
951 nil t)
955 ;; Just move the master file (using vc-rcs-master-templates).
959 ;; If the file is locked by some other user, make
960 ;; the buffer read-only. Like this, even root
961 ;; cannot modify a file that someone else has locked.
965 \f
966 ;;;
967 ;;; Internal functions
968 ;;;
971 "Return non-nil if FILE is newer than its RCS master.
972 This likely means that FILE has been changed with respect
973 to its master version."
981 "Find most recent revision on BRANCH."
986 nil t)
995 "Compute the master file's idea of the state of FILE.
996 If a WORKING-REVISION is given, compute the state of that version,
997 otherwise determine the workfile version based on the master file.
998 This function sets the properties `vc-working-revision' and
999 `vc-checkout-model' to their correct values, based on the master
1000 file."
1010 ;; Workfile version not known yet. Determine that first. It
1011 ;; is either the head of the trunk, the head of the default
1012 ;; branch, or the "default branch" itself, if that is a full
1013 ;; revision number.
1015 ;; no default branch
1020 ;; default branch is actually a revision
1022 default-branch)
1024 ;; else, search for the head of the default branch
1030 ;; Check strict locking
1035 ;; Compute state of workfile version
1043 ;; not locked
1047 ;; workfile version is latest on branch
1048 'up-to-date
1049 ;; workfile version is not latest on branch
1051 ;; locked by the calling user
1054 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1056 workfile-is-latest
1058 'edited
1059 ;; Locking is not used for the file, but the owner does
1060 ;; have a lock, and there is a higher version on the current
1061 ;; branch. Not sure if this can occur, and if it is right
1062 ;; to use `needs-merge' in this case.
1064 ;; locked by somebody else
1066 locking-user)
1071 "Search for RCS headers in FILE, and set properties accordingly.
1073 Returns: nil if no headers were found
1074 'rev if a workfile revision was found
1075 'rev-and-lock if revision and lock info was found"
1083 ;; search for $Id or $Header
1084 ;; -------------------------
1085 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1092 ;; if found, store the revision number ...
1094 ;; ... and check for the locking state
1102 ;; unlocked revision
1106 ;; revision is locked by some user
1110 ;; everything else: false
1112 ;; unexpected information in
1113 ;; keyword string --> quit
1115 ;; search for $Revision
1116 ;; --------------------
1119 nil t)
1120 ;; if found, store the revision number ...
1122 ;; and see if there's any lock information
1135 ;; else: nothing found
1136 ;; -------------------
1146 ;; If the file has headers, we don't want to query the
1147 ;; master file, because that would eliminate all the
1148 ;; performance gain the headers brought us. We therefore
1149 ;; use a heuristic now to find out whether locking is used
1150 ;; for this file. If we trust the file permissions, and the
1151 ;; file is not locked, then if the file is read-only we
1152 ;; assume that locking is used for the file, otherwise
1153 ;; locking is not used.
1159 status))))
1162 "Compare release numbers, represented as strings.
1163 Release components are assumed cardinal numbers, not decimal fractions
1164 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1165 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1166 of the string is found, or a non-numeric component shows up \(5.6.7 is
1168 some cases\). This code is suitable for existing RCS release numbers.
1169 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1190 "Return t if we have RELEASE or better."
1197 "Return the RCS release installed on this system, as a string.
1198 Return symbol `unknown' if the release cannot be deducted. The user can
1199 override this using variable `vc-rcs-release'.
1201 If the user has not set variable `vc-rcs-release' and it is nil,
1202 variable `vc-rcs-release' is set to the returned value."
1220 "Parse current buffer, presumed to be in RCS-style masterfile format.
1221 Optional arg BUFFER specifies another buffer to parse. Return an alist
1222 of two elements, w/ keys `headers' and `revisions' and values in turn
1223 sub-alists. For `headers', the values unless otherwise specified are
1224 strings and the keys are:
1226 desc -- description
1227 head -- latest revision
1229 absent if the head revision lies on the trunk
1230 access -- ???
1231 symbols -- sub-alist of (SYMBOL . REVISION) elements
1235 expand -- may be absent; ???
1237 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1238 with string values (unless otherwise specified) and keys:
1240 date -- a time value (like that returned by `encode-time'); as a
1241 special case, a year value less than 100 is augmented by 1900
1242 author -- username
1244 branches -- list of revisions that begin branches from this revision
1247 log -- change log entry
1248 text -- for the head revision on the trunk, the body of the file;
1249 other revisions have `:insn' instead
1250 :insn -- for non-head revisions, a list of parsed instructions
1253 - `(START k COUNT)' -- kill COUNT lines
1254 - `(START i TEXT)' -- insert TEXT (a string)
1255 The list is in descending order by START.
1257 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1260 ;; An RCS masterfile can be viewed as containing four regular (for the
1261 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1262 ;; the "description" and (d) the "rev bodies", in that order. In the
1263 ;; returned alist (see docstring), elements from (b) and (d) are
1264 ;; combined pairwise to form the "revisions", while those from (a) and
1265 ;; (c) are simply combined to form the "headers".
1266 ;;
1267 ;; Loosely speaking, each section contains a series of alternating
1268 ;; "tags" and "printed representations". In the (b) and (d), many
1269 ;; such series can appear, and a revision number on a line by itself
1270 ;; precedes the series of tags and printed representations associated
1271 ;; with it.
1272 ;;
1273 ;; In (a) and (b), the printed representations (with the exception of
1274 ;; the `comment' tag in the headers) terminate with a semicolon, which
1275 ;; is NOT part of the "value" finally associated with the tag. All
1276 ;; other printed representations are in "@@-format"; there is an "@",
1277 ;; the middle part (to be translated into the value), another "@" and
1278 ;; a newline. Each "@@" in the middle part indicates the position of
1279 ;; a single "@" (and consequently the requirement of an additional
1280 ;; initial step when translating to the value).
1281 ;;
1282 ;; Parser state includes vars that collect parts of the return value...
1284 ;; ... as well as vars that support a single-pass, tag-assisted,
1285 ;; minimal-data-copying scan. Basically -- skirting around the
1286 ;; grouping by revision required in (b) and (d) -- we repeatedly
1287 ;; and context-sensitively read a tag (that MUST be present),
1288 ;; determine the bounds of the printed representation, translate
1289 ;; it into a value, and push the tag plus value onto one of the
1290 ;; collection vars. Finally, we return the parse tree
1291 ;; incorporating the values of the collection vars (see "rv").
1292 ;;
1293 ;; A symbol or string to keep track of context (for error messages).
1294 context
1295 ;; A symbol, the current tag.
1296 tok
1297 ;; Region (begin and end buffer positions) of the printed
1298 ;; representation for the current tag.
1299 b e
1300 ;; A list of buffer positions where "@@" can be found within the
1301 ;; printed representation region. For each location, we push two
1302 ;; elements onto the list, 1+ and 2+ the location, respectively,
1303 ;; with the 2+ appearing at the head. In this way, the expression
1304 ;; `(,e ,@@-holes ,b)
1305 ;; describes regions that can be concatenated (in reverse order)
1306 ;; to "de-@@-format" the printed representation as the first step
1307 ;; to translating it into some value. See internal func `gather'.
1337 acc)
1341 acc)
1350 ;; headers
1364 two))
1370 t))
1371 headers)
1379 ;; rev headers
1388 b e)
1390 ;; Hack the year -- verified to be the
1391 ;; same algorithm used in RCS 5.7.
1401 revs)
1404 ;; desc
1407 ;; rev bodies
1409 ;; Element of `revs' that initially holds only header info.
1410 ;; "Pairwise combination" occurs when we add body info.
1411 rev
1412 ;; Components of the editing commands (aside from the actual
1413 ;; text) that comprise the `text' printed representations
1414 ;; (not including the "head" revision).
1415 cmd start act
1416 ;; Ascending (reversed) `@-holes' which the internal func
1417 ;; `incg' pops to effect incremental gathering.
1418 asc
1419 ;; Function to extract text (for the `a' command), either
1420 ;; `incg' or `buffer-substring-no-properties'. (This is
1421 ;; for speed; strictly speaking, it is sufficient to use
1422 ;; only the former since it behaves identically to the
1423 ;; latter in the absence of "@@".)
1424 sub)
1429 ;; Self-deprecate when work is done.
1430 ;; Folding many dimensions into one.
1431 ;; Thanks B.Mandelbrot, for complex sum.
1432 ;; O beauteous math! --the Unvexed Bum
1441 context))))
1443 ;; For rev body `text' tags, delay translation slightly...
1445 ;; ... until we decide which tag and value is appropriate to
1446 ;; collect. For the "head" revision, compute the value of the
1447 ;; `text' printed representation by simple `gather'. For all
1448 ;; other revisions, replace the `text' tag+value with `:insn'
1449 ;; plus value, always scanning in-place.
1465 (?d
1466 ;; `d' means "delete lines".
1467 ;; For Emacs spirit, we use `k' for "kill".
1469 (?a
1470 ;; `a' means "append after this line" but
1471 ;; internally we normalize it so that START
1472 ;; specifies the actual line for insert, thus
1473 ;; requiring less hair in the realization algs.
1474 ;; For Emacs spirit, we use `i' for "insert".
1479 cmd context)))
1480 acc))
1483 ;; rv
1489 ;;; vc-rcs.el ends here