| blob | 9bcd178cb2874fe69b7c4cce8fe7ab55b4d8c5dd |
1 ;;; vc-rcs.el --- support for RCS version-control -*- lexical-binding:t -*-
3 ;; Copyright (C) 1992-2015 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 ;; This needs to be autoloaded because vc-rcs-registered uses it (via
93 ;; vc-default-registered), and vc-hooks needs to be able to check
94 ;; for a registered backend without loading every backend.
95 ;;;###autoload
98 "Where to look for RCS master files.
99 For a description of possible values, see `vc-check-master-templates'."
104 function)))
108 \f
109 ;;; Properties of the backend
114 "RCS-specific version of `vc-checkout-model'."
116 result)
125 ;;;
126 ;;; State-querying functions
127 ;;;
129 ;; The autoload cookie below places vc-rcs-registered directly into
130 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
131 ;; every file that is visited.
132 ;;;###autoload
137 "Implementation of `vc-state' for RCS."
139 'unregistered
144 ;; vc-working-revision might not be known; in that case the
145 ;; property is nil. vc-rcs-fetch-master-state knows how to
146 ;; handle that.
151 state
153 'up-to-date
155 'unlocked-changes
159 "State heuristic for RCS."
166 ;; If the headers say that the file is not locked, the
167 ;; permissions can tell us whether locking is used for
168 ;; the file or not.
177 'edited
181 state)
192 'edited
193 owner-name)
195 'edited
198 ;; Strange permissions. Fall through to
199 ;; expensive state computation.
206 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
207 ;; should be changed to take a backend parameter. Using
208 ;; `vc-expand-dirs' is not TRTD because it returns files from
209 ;; multiple backends. It should also return 'unregistered files.
211 ;; Doing individual vc-state calls is painful but there
212 ;; is no better way in RCS-land.
224 "RCS-specific version of `vc-working-revision'."
233 "Return non-nil if workfile version of FILE is the latest on its branch.
234 When VERSION is given, perform check for that version."
240 ;; Compare VERSION to the head version number.
243 ;; If we are not on the trunk, we need to examine the
244 ;; whole current branch.
249 "RCS-specific implementation of `vc-workfile-unchanged-p'."
250 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
251 ;; do a double take and remember the fact for the future
262 ;; The workfile is unchanged if rcsdiff found no differences.
265 \f
266 ;;;
267 ;;; State-changing functions
268 ;;;
271 "Create a new RCS repository."
272 ;; RCS is totally file-oriented, so all we have to do is make the directory.
278 "Register FILES into the RCS version-control system.
279 REV is the optional revision number for the files. COMMENT can be used
280 to provide an initial description for each FILES.
281 Passes either `vc-rcs-register-switches' or `vc-register-switches'
282 to the RCS command.
284 Automatically retrieve a read-only version of the file with keywords
285 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
287 ;; When REV is specified, we need to force using "-t-".
298 ;; if available, use the secure registering option
303 ;; parse output to find master file name and workfile version
310 ;; if we couldn't find the master name,
311 ;; run vc-rcs-registered to get it
312 ;; (will be stored into the vc-name property)
316 name
318 name
323 nil t)
327 "Return non-nil if RCS thinks it would be responsible for registering FILE."
328 ;; TODO: check for all the patterns in vc-rcs-master-templates
331 file
335 "Implementation of receive-file for RCS."
343 "Unregister FILE from RCS.
344 If this leaves the RCS subdirectory empty, ask the user
345 whether to remove it."
354 ;; check whether RCS dir is empty, i.e. it does not
355 ;; contain any files except "." and ".."
362 "RCS-specific version of `vc-backend-checkin'."
364 ;; Now operate on the files
368 ;; Force branch creation if an appropriate
369 ;; default branch has been set.
371 default-branch
373 default-branch)
379 ;; if available, use the secure check-in option
383 switches)
386 ;; determine the new workfile version
396 ;; if we got to a different branch, adjust the default
397 ;; branch accordingly
405 ;; If this is an old (pre-1992!) RCS release, we might have
406 ;; to remove a remaining lock.
408 ;; exit status of 1 is also accepted.
409 ;; It means that the lock was removed before.
421 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
422 attempt the checkout for all registered files beneath it."
426 switches)
429 ;; Change buffers to get local value of vc-checkout-switches.
432 ;; Save this buffer's default-directory
433 ;; and use save-excursion to make sure it is restored
434 ;; in the same buffer it was saved in.
437 ;; Adjust the default-directory so that the check-out creates
438 ;; the file in the right place.
441 ;; if we should go to the head of the trunk,
442 ;; clear the default branch first
445 ;; now do the checkout
448 ;; If locking is not strict, force to overwrite
449 ;; the writable workfile.
453 ;; a literal revision was specified
459 ;; no revision specified:
460 ;; use current workfile version
461 workrev
462 ;; REV is t ...
464 ;; ... go to head of current branch
466 ;; ... go to head of trunk
468 nil)
470 switches)
471 ;; determine the new workfile version
476 ;; if necessary, adjust the default branch
479 file
483 new-version)))))
487 "Roll back, undoing the most recent checkins of FILES. Directories are
488 expanded to all registered subfiles in them."
497 discard file)))
501 ;; Check out the most recent remaining version. If it
502 ;; fails, because the whole branch got deleted, do a
503 ;; double-take and check out the version where the branch
504 ;; started.
516 ;; vc-do-command popped up a window with
517 ;; the error message. Get rid of it, by
518 ;; restoring the old window configuration.
520 ;; No, it was some other error: re-signal it.
524 "Revert FILE to the version it was based on. If FILE is a directory,
525 revert all registered files beneath it."
533 "Merge changes into current working copy of FILE.
534 The changes are between FIRST-VERSION and SECOND-VERSION."
541 "Steal the lock on the current workfile for FILE and revision REV.
542 If FILE is a directory, steal the lock on all registered files beneath it.
543 Needs RCS 5.6.2 or later for -M."
547 ;; Do a real checkout after stealing the lock, so that we see
548 ;; expanded headers.
552 "Modify the change comments change on FILES on a specified REV. If FILE is a
553 directory the operation is applied to all registered files beneath it."
558 \f
559 ;;;
560 ;;; History functions
561 ;;;
575 _start-revision-ignored limit)
576 "Print commit log associated with FILES into specified BUFFER.
577 Remaining arguments are ignored.
578 If FILE is a directory the operation is applied to all registered
579 files beneath it."
587 "Get a difference report using RCS between two sets of files."
597 "Return the administrative directory of FILE."
601 "Return a string with all log entries stored in BACKEND for FILE."
603 ;; Has to be written this way, this function is used by the CVS backend too
605 ;; Remove cruft
621 ;; Return the de-crufted comment list
625 "Annotate FILE, inserting the results in BUFFER.
626 Optional arg REVISION is a revision to annotate from."
628 ;; Aside from the "head revision on the trunk", the instructions for
629 ;; each revision on the trunk are an ordered list of kill and insert
630 ;; commands necessary to go from the chronologically-following
631 ;; revision to this one. That is, associated with revision N are
632 ;; edits that applied to revision N+1 would result in revision N.
633 ;;
634 ;; On a branch, however, (some) things are inverted: the commands
635 ;; listed are those necessary to go from the chronologically-preceding
636 ;; revision to this one. That is, associated with revision N are
637 ;; edits that applied to revision N-1 would result in revision N.
638 ;;
639 ;; So, to get per-line history info, we apply reverse-chronological
640 ;; edits, starting with the head revision on the trunk, all the way
641 ;; back through the initial revision (typically "1.1" or similar),
642 ;; then apply forward-chronological edits -- keeping track of which
643 ;; revision is associated with each inserted line -- until we reach
644 ;; the desired revision for display (which may be either on the trunk
645 ;; or on a branch).
650 ;; The revision N whose instructions we currently are processing.
652 ;; Alist from the parse tree for N.
654 ;; Point and temporary string, respectively.
655 p s
656 ;; "Next-branch list". Nil means the desired revision to
657 ;; display lives on the trunk. Non-nil means it lives on a
658 ;; branch, in which case the value is a list of revision pairs
659 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
660 ;; links each series of revisions in the path from the initial
661 ;; revision to the desired revision to display.
662 nbls
663 ;; "Path-accumulate-predicate plus revision/date/author".
664 ;; Until set, forward-chronological edits are not accumulated.
665 ;; Once set, its value (updated every revision) is used for
666 ;; the text property `:vc-rcs-r/d/a' for inserts during
667 ;; processing of forward-chronological instructions for N.
668 ;; See internal func `r/d/a'.
669 prda
670 ;; List of forward-chronological instructions, each of the
671 ;; form: (POS . ACTION), where POS is a buffer position. If
672 ;; ACTION is a string, it is inserted, otherwise it is taken as
673 ;; the number of characters to be deleted.
674 path
675 ;; N+1. When `cur' is "", this is the initial revision.
676 pre)
681 ;; Find which branches (if any) must be included in the edits.
683 bpt kids)
687 ;; A branchpoint may have multiple children. Find the right one.
691 ;; Start with the full text.
694 ;; Apply reverse-chronological edits on the trunk, computing and
695 ;; accumulating forward-chronological edits after some point, for
696 ;; later.
703 ;; Start accumulating the forward-chronological edits when N+1
704 ;; on the trunk is either the desired revision to display, or
705 ;; the appropriate branchpoint for it. Do this before
706 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
710 ;; Edits in the parse tree specify a line number (in the buffer
711 ;; *BEFORE* editing occurs) to start from, but line numbers
712 ;; change as a result of edits. To DTRT, we apply edits in
713 ;; order of descending buffer position so that edits further
714 ;; down in the buffer occur first w/o corrupting specified
715 ;; buffer positions of edits occurring towards the beginning of
716 ;; the buffer. In this way we avoid using markers. A pleasant
717 ;; property of this approach is ability to push instructions
718 ;; onto `path' directly, w/o need to maintain rev boundaries.
734 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
735 ;; equivalent to pushing an insert instruction (of the entire buffer
736 ;; contents) onto `path' then erasing the buffer, but less wasteful.
738 ;; Now apply the forward-chronological edits for the trunk.
744 ;; Now apply the forward-chronological edits (directly from the
745 ;; parse-tree) for the branch(es), if necessary. We re-use vars
746 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
751 prda nil)
765 ;; Lastly, for each line, insert at bol nicely-formatted history info.
766 ;; We do two passes to collect summary information used to minimize
767 ;; the annotation's usage of screen real-estate: (1) Consider rendered
768 ;; width of revision plus author together as a unit; and (2) Omit
769 ;; author entirely if all authors are the same as the user.
774 rda w a)
784 ht)
792 " "
794 ls)
795 :vc-annotate-prefix t
803 ht)))
811 "Return the current time, based at midnight of the current day, and
812 encoded as fractional days."
817 "Return the time of the next annotation (as fraction of days)
818 systime, or nil if there is none. Also, reposition point."
827 \f
828 ;;;
829 ;;; Tag system
830 ;;;
842 dir
846 \f
847 ;;;
848 ;;; Miscellaneous
849 ;;;
852 "Return t if REV is a revision on the trunk."
856 "Return the minor revision number of a revision number REV."
861 "Return the revision number immediately preceding REV for FILE,
862 or nil if there is no previous revision. This default
863 implementation works for MAJOR.MINOR-style revision numbers as
864 used by RCS and CVS."
869 ;; revision does probably not start a branch or release
872 ;; we are at the beginning of the trunk --
873 ;; don't know anything to return here
874 nil
875 ;; we are at the beginning of a branch --
876 ;; return revision of starting point
880 "Return the revision number immediately following REV for FILE,
881 or nil if there is no next revision. This default implementation
882 works for MAJOR.MINOR-style revision numbers as used by RCS
883 and CVS."
889 ;; You might think that this should be distributed with RCS, but
890 ;; apparently not. CVS sometimes provides a version of it.
891 ;; http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00288.html
896 exe)
897 ;; In the unlikely event that someone is running an
898 ;; uninstalled Emacs and wants to do something RCS-related.
901 exe)
908 "Default implementation of update-changelog.
909 Uses `rcs2log' which only works for RCS and CVS."
910 ;; FIXME: We (c|sh)ould add support for cvs2cl
913 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
917 temporary-file-directory))))
925 user-mail-address)))
939 "-c" changelog
947 files)))
948 "done"
957 "Check if the current file has any headers in it."
964 "Implementation of vc-clear-headers for RCS."
970 nil t)
976 ;; Just move the master file (using vc-rcs-master-templates).
980 ;; If the file is locked by some other user, make
981 ;; the buffer read-only. Like this, even root
982 ;; cannot modify a file that someone else has locked.
986 \f
987 ;;;
988 ;;; Internal functions
989 ;;;
992 "Return non-nil if FILE is newer than its RCS master.
993 This likely means that FILE has been changed with respect
994 to its master version."
1002 "Find most recent revision on BRANCH."
1007 nil t)
1016 "Compute the master file's idea of the state of FILE.
1017 If a WORKING-REVISION is given, compute the state of that version,
1018 otherwise determine the workfile version based on the master file.
1019 This function sets the properties `vc-working-revision' and
1020 `vc-checkout-model' to their correct values, based on the master
1021 file."
1031 ;; Workfile version not known yet. Determine that first. It
1032 ;; is either the head of the trunk, the head of the default
1033 ;; branch, or the "default branch" itself, if that is a full
1034 ;; revision number.
1036 ;; no default branch
1041 ;; default branch is actually a revision
1043 default-branch)
1045 ;; else, search for the head of the default branch
1051 ;; Check strict locking
1056 ;; Compute state of workfile version
1064 ;; not locked
1068 ;; workfile version is latest on branch
1069 'up-to-date
1070 ;; workfile version is not latest on branch
1072 ;; locked by the calling user
1075 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1077 workfile-is-latest
1079 'edited
1080 ;; Locking is not used for the file, but the owner does
1081 ;; have a lock, and there is a higher version on the current
1082 ;; branch. Not sure if this can occur, and if it is right
1083 ;; to use `needs-merge' in this case.
1085 ;; locked by somebody else
1087 locking-user)
1092 "Search for RCS headers in FILE, and set properties accordingly.
1094 Returns: nil if no headers were found
1095 'rev if a workfile revision was found
1096 'rev-and-lock if revision and lock info was found"
1104 ;; search for $Id or $Header
1105 ;; -------------------------
1106 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1113 ;; if found, store the revision number ...
1115 ;; ... and check for the locking state
1123 ;; unlocked revision
1127 ;; revision is locked by some user
1131 ;; everything else: false
1133 ;; unexpected information in
1134 ;; keyword string --> quit
1136 ;; search for $Revision
1137 ;; --------------------
1140 nil t)
1141 ;; if found, store the revision number ...
1143 ;; and see if there's any lock information
1156 ;; else: nothing found
1157 ;; -------------------
1167 ;; If the file has headers, we don't want to query the
1168 ;; master file, because that would eliminate all the
1169 ;; performance gain the headers brought us. We therefore
1170 ;; use a heuristic now to find out whether locking is used
1171 ;; for this file. If we trust the file permissions, and the
1172 ;; file is not locked, then if the file is read-only we
1173 ;; assume that locking is used for the file, otherwise
1174 ;; locking is not used.
1180 status))))
1183 "Compare release numbers, represented as strings.
1184 Release components are assumed cardinal numbers, not decimal fractions
1185 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1186 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1187 of the string is found, or a non-numeric component shows up \(5.6.7 is
1189 some cases\). This code is suitable for existing RCS release numbers.
1190 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1211 "Return t if we have RELEASE or better."
1218 "Return the RCS release installed on this system, as a string.
1219 Return symbol `unknown' if the release cannot be deducted. The user can
1220 override this using variable `vc-rcs-release'.
1222 If the user has not set variable `vc-rcs-release' and it is nil,
1223 variable `vc-rcs-release' is set to the returned value."
1241 "Parse current buffer, presumed to be in RCS-style masterfile format.
1242 Optional arg BUFFER specifies another buffer to parse. Return an alist
1243 of two elements, w/ keys `headers' and `revisions' and values in turn
1244 sub-alists. For `headers', the values unless otherwise specified are
1245 strings and the keys are:
1247 desc -- description
1248 head -- latest revision
1250 absent if the head revision lies on the trunk
1251 access -- ???
1252 symbols -- sub-alist of (SYMBOL . REVISION) elements
1256 expand -- may be absent; ???
1258 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1259 with string values (unless otherwise specified) and keys:
1261 date -- a time value (like that returned by `encode-time'); as a
1262 special case, a year value less than 100 is augmented by 1900
1263 author -- username
1265 branches -- list of revisions that begin branches from this revision
1268 log -- change log entry
1269 text -- for the head revision on the trunk, the body of the file;
1270 other revisions have `:insn' instead
1271 :insn -- for non-head revisions, a list of parsed instructions
1274 - `(START k COUNT)' -- kill COUNT lines
1275 - `(START i TEXT)' -- insert TEXT (a string)
1276 The list is in descending order by START.
1278 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1281 ;; An RCS masterfile can be viewed as containing four regular (for the
1282 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1283 ;; the "description" and (d) the "rev bodies", in that order. In the
1284 ;; returned alist (see docstring), elements from (b) and (d) are
1285 ;; combined pairwise to form the "revisions", while those from (a) and
1286 ;; (c) are simply combined to form the "headers".
1287 ;;
1288 ;; Loosely speaking, each section contains a series of alternating
1289 ;; "tags" and "printed representations". In the (b) and (d), many
1290 ;; such series can appear, and a revision number on a line by itself
1291 ;; precedes the series of tags and printed representations associated
1292 ;; with it.
1293 ;;
1294 ;; In (a) and (b), the printed representations (with the exception of
1295 ;; the `comment' tag in the headers) terminate with a semicolon, which
1296 ;; is NOT part of the "value" finally associated with the tag. All
1297 ;; other printed representations are in "@@-format"; there is an "@",
1298 ;; the middle part (to be translated into the value), another "@" and
1299 ;; a newline. Each "@@" in the middle part indicates the position of
1300 ;; a single "@" (and consequently the requirement of an additional
1301 ;; initial step when translating to the value).
1302 ;;
1303 ;; Parser state includes vars that collect parts of the return value...
1305 ;; ... as well as vars that support a single-pass, tag-assisted,
1306 ;; minimal-data-copying scan. Basically -- skirting around the
1307 ;; grouping by revision required in (b) and (d) -- we repeatedly
1308 ;; and context-sensitively read a tag (that MUST be present),
1309 ;; determine the bounds of the printed representation, translate
1310 ;; it into a value, and push the tag plus value onto one of the
1311 ;; collection vars. Finally, we return the parse tree
1312 ;; incorporating the values of the collection vars (see "rv").
1313 ;;
1314 ;; A symbol or string to keep track of context (for error messages).
1315 context
1316 ;; A symbol, the current tag.
1317 tok
1318 ;; Region (begin and end buffer positions) of the printed
1319 ;; representation for the current tag.
1320 b e
1321 ;; A list of buffer positions where "@@" can be found within the
1322 ;; printed representation region. For each location, we push two
1323 ;; elements onto the list, 1+ and 2+ the location, respectively,
1324 ;; with the 2+ appearing at the head. In this way, the expression
1325 ;; `(,e ,@@-holes ,b)
1326 ;; describes regions that can be concatenated (in reverse order)
1327 ;; to "de-@@-format" the printed representation as the first step
1328 ;; to translating it into some value. See internal func `gather'.
1358 acc)
1362 acc)
1370 ;; headers
1384 two))
1390 t))
1391 headers)
1399 ;; rev headers
1408 b e)
1410 ;; Hack the year -- verified to be the
1411 ;; same algorithm used in RCS 5.7.
1421 revs)
1424 ;; desc
1427 ;; rev bodies
1429 ;; Element of `revs' that initially holds only header info.
1430 ;; "Pairwise combination" occurs when we add body info.
1431 rev
1432 ;; Components of the editing commands (aside from the actual
1433 ;; text) that comprise the `text' printed representations
1434 ;; (not including the "head" revision).
1435 cmd start act
1436 ;; Ascending (reversed) `@-holes' which the internal func
1437 ;; `incg' pops to effect incremental gathering.
1438 asc
1439 ;; Function to extract text (for the `a' command), either
1440 ;; `incg' or `buffer-substring-no-properties'. (This is
1441 ;; for speed; strictly speaking, it is sufficient to use
1442 ;; only the former since it behaves identically to the
1443 ;; latter in the absence of "@@".)
1444 sub)
1450 ;; Self-deprecate when work is done.
1451 ;; Folding many dimensions into one.
1452 ;; Thanks B.Mandelbrot, for complex sum.
1453 ;; O beauteous math! --the Unvexed Bum
1462 context))))
1464 ;; For rev body `text' tags, delay translation slightly...
1466 ;; ... until we decide which tag and value is appropriate to
1467 ;; collect. For the "head" revision, compute the value of the
1468 ;; `text' printed representation by simple `gather'. For all
1469 ;; other revisions, replace the `text' tag+value with `:insn'
1470 ;; plus value, always scanning in-place.
1486 (?d
1487 ;; `d' means "delete lines".
1488 ;; For Emacs spirit, we use `k' for "kill".
1490 (?a
1491 ;; `a' means "append after this line" but
1492 ;; internally we normalize it so that START
1493 ;; specifies the actual line for insert, thus
1494 ;; requiring less hair in the realization algs.
1495 ;; For Emacs spirit, we use `i' for "insert".
1500 cmd context)))
1501 acc))
1504 ;; rv
1510 ;;; vc-rcs.el ends here