| blob | 995bd059f2df40bd221f0a090496f3aa5d2540bc |
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
172 "RCS-specific version of `vc-working-revision'."
183 "Return non-nil if workfile version of FILE is the latest on its branch.
184 When VERSION is given, perform check for that version."
190 ;; Compare VERSION to the head version number.
193 ;; If we are not on the trunk, we need to examine the
194 ;; whole current branch.
199 "Has FILE remained unchanged since last checkout?"
200 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
201 ;; do a double take and remember the fact for the future
212 ;; The workfile is unchanged if rcsdiff found no differences.
215 \f
216 ;;;
217 ;;; State-changing functions
218 ;;;
221 "Create a new RCS repository."
222 ;; RCS is totally file-oriented, so all we have to do is make the directory.
228 "Register FILES into the RCS version-control system.
229 Automatically retrieve a read-only version of the file with keywords expanded.
230 COMMENT can be used to provide an initial description for each FILES.
231 Passes either `vc-rcs-register-switches' or `vc-register-switches'
232 to the RCS command."
243 ;; if available, use the secure registering option
245 "-u"
246 ;; Some old MS-Windows ports of RCS crash when "ci -i" is
247 ;; invoked without -t; indulge them.
250 ;; parse output to find master file name and workfile version
257 ;; if we couldn't find the master name,
258 ;; run vc-rcs-registered to get it
259 ;; (will be stored into the vc-master-name property)
263 name
265 name
270 nil t)
274 "Return non-nil if RCS thinks it would be responsible for registering FILE."
275 ;; TODO: check for all the patterns in vc-rcs-master-templates
278 file
282 "Implementation of receive-file for RCS."
290 "Unregister FILE from RCS.
291 If this leaves the RCS subdirectory empty, ask the user
292 whether to remove it."
302 ;; check whether RCS dir is empty, i.e. it does not
303 ;; contain any files except "." and ".."
309 ;; It used to be possible to pass in a value for the variable rev, but
310 ;; nothing in the rest of VC used this capability. Removing it makes the
311 ;; backend interface simpler for all modes.
312 ;;
314 "RCS-specific version of `vc-backend-checkin'."
316 ;; Now operate on the files
320 ;; Force branch creation if an appropriate
321 ;; default branch has been set.
324 default-branch)
331 ;; if available, use the secure check-in option
335 switches)
338 ;; determine the new workfile version
348 ;; if we got to a different branch, adjust the default
349 ;; branch accordingly
357 ;; If this is an old (pre-1992!) RCS release, we might have
358 ;; to remove a remaining lock.
360 ;; exit status of 1 is also accepted.
361 ;; It means that the lock was removed before.
373 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
374 attempt the checkout for all registered files beneath it."
378 switches)
381 ;; Change buffers to get local value of vc-checkout-switches.
384 ;; Save this buffer's default-directory
385 ;; and use save-excursion to make sure it is restored
386 ;; in the same buffer it was saved in.
389 ;; Adjust the default-directory so that the check-out creates
390 ;; the file in the right place.
393 ;; if we should go to the head of the trunk,
394 ;; clear the default branch first
397 ;; now do the checkout
400 ;; If locking is not strict, force to overwrite
401 ;; the writable workfile.
403 "-l"
405 ;; a literal revision was specified
411 ;; no revision specified:
412 ;; use current workfile version
413 workrev
414 ;; REV is t ...
416 ;; ... go to head of current branch
418 ;; ... go to head of trunk
420 nil)
422 switches)
423 ;; determine the new workfile version
428 ;; if necessary, adjust the default branch
431 file
435 new-version)))))
439 "Revert FILE to the version it was based on. If FILE is a directory,
440 revert all registered files beneath it."
448 "Accept a file merge request, prompting for revisions."
454 second-revision)
462 "Second RCS revision: "
465 ;; We want to merge an entire branch. Set revisions
466 ;; accordingly, so that vc-rcs-merge understands us.
468 ;; first-revision must be the starting point of the branch
473 "Merge changes into current working copy of FILE.
474 The changes are between FIRST-VERSION and SECOND-VERSION."
481 "Steal the lock on the current workfile for FILE and revision REV.
482 If FILE is a directory, steal the lock on all registered files beneath it.
483 Needs RCS 5.6.2 or later for -M."
487 ;; Do a real checkout after stealing the lock, so that we see
488 ;; expanded headers.
490 ;; Must clear any headers here because they wouldn't
491 ;; show that the file is locked now.
496 ;; save-excursion may be able to relocate point and mark
497 ;; properly. If it fails, vc-restore-buffer-context
498 ;; will give it a second try.
507 "Modify the change comments change on FILES on a specified REV. If FILE is a
508 directory the operation is applied to all registered files beneath it."
513 \f
514 ;;;
515 ;;; History functions
516 ;;;
530 _start-revision-ignored limit)
531 "Print commit log associated with FILES into specified BUFFER.
532 Remaining arguments are ignored.
533 If FILE is a directory the operation is applied to all registered
534 files beneath it."
542 "Get a difference report using RCS between two sets of files."
552 "Return the administrative directory of FILE."
556 "Return a string with all log entries stored in BACKEND for FILE."
558 ;; Has to be written this way, this function is used by the CVS backend too
560 ;; Remove cruft
576 ;; Return the de-crufted comment list
580 "Annotate FILE, inserting the results in BUFFER.
581 Optional arg REVISION is a revision to annotate from."
583 ;; Aside from the "head revision on the trunk", the instructions for
584 ;; each revision on the trunk are an ordered list of kill and insert
585 ;; commands necessary to go from the chronologically-following
586 ;; revision to this one. That is, associated with revision N are
587 ;; edits that applied to revision N+1 would result in revision N.
588 ;;
589 ;; On a branch, however, (some) things are inverted: the commands
590 ;; listed are those necessary to go from the chronologically-preceding
591 ;; revision to this one. That is, associated with revision N are
592 ;; edits that applied to revision N-1 would result in revision N.
593 ;;
594 ;; So, to get per-line history info, we apply reverse-chronological
595 ;; edits, starting with the head revision on the trunk, all the way
596 ;; back through the initial revision (typically "1.1" or similar),
597 ;; then apply forward-chronological edits -- keeping track of which
598 ;; revision is associated with each inserted line -- until we reach
599 ;; the desired revision for display (which may be either on the trunk
600 ;; or on a branch).
605 ;; The revision N whose instructions we currently are processing.
607 ;; Alist from the parse tree for N.
609 ;; Point and temporary string, respectively.
610 p s
611 ;; "Next-branch list". Nil means the desired revision to
612 ;; display lives on the trunk. Non-nil means it lives on a
613 ;; branch, in which case the value is a list of revision pairs
614 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
615 ;; links each series of revisions in the path from the initial
616 ;; revision to the desired revision to display.
617 nbls
618 ;; "Path-accumulate-predicate plus revision/date/author".
619 ;; Until set, forward-chronological edits are not accumulated.
620 ;; Once set, its value (updated every revision) is used for
621 ;; the text property `:vc-rcs-r/d/a' for inserts during
622 ;; processing of forward-chronological instructions for N.
623 ;; See internal func `r/d/a'.
624 prda
625 ;; List of forward-chronological instructions, each of the
626 ;; form: (POS . ACTION), where POS is a buffer position. If
627 ;; ACTION is a string, it is inserted, otherwise it is taken as
628 ;; the number of characters to be deleted.
629 path
630 ;; N+1. When `cur' is "", this is the initial revision.
631 pre)
636 ;; Find which branches (if any) must be included in the edits.
638 bpt kids)
642 ;; A branchpoint may have multiple children. Find the right one.
646 ;; Start with the full text.
649 ;; Apply reverse-chronological edits on the trunk, computing and
650 ;; accumulating forward-chronological edits after some point, for
651 ;; later.
658 ;; Start accumulating the forward-chronological edits when N+1
659 ;; on the trunk is either the desired revision to display, or
660 ;; the appropriate branchpoint for it. Do this before
661 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
665 ;; Edits in the parse tree specify a line number (in the buffer
666 ;; *BEFORE* editing occurs) to start from, but line numbers
667 ;; change as a result of edits. To DTRT, we apply edits in
668 ;; order of descending buffer position so that edits further
669 ;; down in the buffer occur first w/o corrupting specified
670 ;; buffer positions of edits occurring towards the beginning of
671 ;; the buffer. In this way we avoid using markers. A pleasant
672 ;; property of this approach is ability to push instructions
673 ;; onto `path' directly, w/o need to maintain rev boundaries.
689 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
690 ;; equivalent to pushing an insert instruction (of the entire buffer
691 ;; contents) onto `path' then erasing the buffer, but less wasteful.
693 ;; Now apply the forward-chronological edits for the trunk.
699 ;; Now apply the forward-chronological edits (directly from the
700 ;; parse-tree) for the branch(es), if necessary. We re-use vars
701 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
706 prda nil)
720 ;; Lastly, for each line, insert at bol nicely-formatted history info.
721 ;; We do two passes to collect summary information used to minimize
722 ;; the annotation's usage of screen real-estate: (1) Consider rendered
723 ;; width of revision plus author together as a unit; and (2) Omit
724 ;; author entirely if all authors are the same as the user.
729 rda w a)
739 ht)
747 " "
749 ls)
750 :vc-annotate-prefix t
758 ht)))
766 "Return the current time, based at midnight of the current day, and
767 encoded as fractional days."
772 "Return the time of the next annotation (as fraction of days)
773 systime, or nil if there is none. Also, reposition point."
782 \f
783 ;;;
784 ;;; Tag system
785 ;;;
797 dir
801 \f
802 ;;;
803 ;;; Miscellaneous
804 ;;;
807 "Return t if REV is a revision on the trunk."
811 "Return the minor revision number of a revision number REV."
816 "Return the revision number immediately preceding REV for FILE,
817 or nil if there is no previous revision. This default
818 implementation works for MAJOR.MINOR-style revision numbers as
819 used by RCS and CVS."
824 ;; revision does probably not start a branch or release
827 ;; we are at the beginning of the trunk --
828 ;; don't know anything to return here
829 nil
830 ;; we are at the beginning of a branch --
831 ;; return revision of starting point
835 "Return the revision number immediately following REV for FILE,
836 or nil if there is no next revision. This default implementation
837 works for MAJOR.MINOR-style revision numbers as used by RCS
838 and CVS."
844 ;; You might think that this should be distributed with RCS, but
845 ;; apparently not. CVS sometimes provides a version of it.
846 ;; http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00288.html
851 exe)
852 ;; In the unlikely event that someone is running an
853 ;; uninstalled Emacs and wants to do something RCS-related.
856 exe)
863 "Default implementation of update-changelog.
864 Uses `rcs2log' which only works for RCS and CVS."
865 ;; FIXME: We (c|sh)ould add support for cvs2cl
868 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
872 temporary-file-directory))))
880 user-mail-address)))
894 "-c" changelog
902 files)))
903 "done"
912 "Check if the current file has any headers in it."
919 "Clear RCS header value parts."
925 nil t)
931 ;; Just move the master file (using vc-rcs-master-templates).
935 ;; If the file is locked by some other user, make
936 ;; the buffer read-only. Like this, even root
937 ;; cannot modify a file that someone else has locked.
941 \f
942 ;;;
943 ;;; Internal functions
944 ;;;
947 "Return non-nil if FILE is newer than its RCS master.
948 This likely means that FILE has been changed with respect
949 to its master version."
957 "Find most recent revision on BRANCH."
962 nil t)
971 "Compute the master file's idea of the state of FILE.
972 If a WORKING-REVISION is given, compute the state of that version,
973 otherwise determine the workfile version based on the master file.
974 This function sets the properties `vc-working-revision' and
975 `vc-checkout-model' to their correct values, based on the master
976 file."
987 ;; Workfile version not known yet. Determine that first. It
988 ;; is either the head of the trunk, the head of the default
989 ;; branch, or the "default branch" itself, if that is a full
990 ;; revision number.
992 ;; no default branch
997 ;; default branch is actually a revision
999 default-branch)
1001 ;; else, search for the head of the default branch
1007 ;; Check strict locking
1012 ;; Compute state of workfile version
1020 ;; not locked
1024 ;; workfile version is latest on branch
1025 'up-to-date
1026 ;; workfile version is not latest on branch
1028 ;; locked by the calling user
1031 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1033 workfile-is-latest
1035 'edited
1036 ;; Locking is not used for the file, but the owner does
1037 ;; have a lock, and there is a higher version on the current
1038 ;; branch. Not sure if this can occur, and if it is right
1039 ;; to use `needs-merge' in this case.
1041 ;; locked by somebody else
1043 locking-user)
1048 "Search for RCS headers in FILE, and set properties accordingly.
1050 Returns: nil if no headers were found
1051 'rev if a workfile revision was found
1052 'rev-and-lock if revision and lock info was found"
1060 ;; search for $Id or $Header
1061 ;; -------------------------
1062 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1069 ;; if found, store the revision number ...
1071 ;; ... and check for the locking state
1079 ;; unlocked revision
1081 ;;(setq locking-user 'none)
1083 ;; revision is locked by some user
1085 ;;(setq locking-user (match-string-no-properties 1))
1087 ;; everything else: false
1089 ;; unexpected information in
1090 ;; keyword string --> quit
1092 ;; search for $Revision
1093 ;; --------------------
1096 nil t)
1097 ;; if found, store the revision number ...
1099 ;; and see if there's any lock information
1103 ;;(setq locking-user (match-string-no-properties 1))
1106 ;;(setq locking-user 'none)
1109 ;;(setq locking-user 'none)
1112 ;; else: nothing found
1113 ;; -------------------
1116 status))))
1119 "Compare release numbers, represented as strings.
1120 Release components are assumed cardinal numbers, not decimal fractions
1121 \(5.10 is a higher release than 5.9). Omitted fields are considered
1122 lower \(5.6.7 is earlier than 5.6.7.1). Comparison runs till the end
1123 of the string is found, or a non-numeric component shows up \(5.6.7 is
1125 some cases). This code is suitable for existing RCS release numbers.
1126 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5)."
1147 "Return t if we have RELEASE or better."
1154 "Return the RCS release installed on this system, as a string.
1155 Return symbol `unknown' if the release cannot be deducted. The user can
1156 override this using variable `vc-rcs-release'.
1158 If the user has not set variable `vc-rcs-release' and it is nil,
1159 variable `vc-rcs-release' is set to the returned value."
1177 "Parse current buffer, presumed to be in RCS-style masterfile format.
1178 Optional arg BUFFER specifies another buffer to parse. Return an alist
1179 of two elements, w/ keys `headers' and `revisions' and values in turn
1180 sub-alists. For `headers', the values unless otherwise specified are
1181 strings and the keys are:
1183 desc -- description
1184 head -- latest revision
1186 absent if the head revision lies on the trunk
1187 access -- ???
1188 symbols -- sub-alist of (SYMBOL . REVISION) elements
1192 expand -- may be absent; ???
1194 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1195 with string values (unless otherwise specified) and keys:
1197 date -- a time value (like that returned by `encode-time'); as a
1198 special case, a year value less than 100 is augmented by 1900
1199 author -- username
1201 branches -- list of revisions that begin branches from this revision
1204 log -- change log entry
1205 text -- for the head revision on the trunk, the body of the file;
1206 other revisions have `:insn' instead
1207 :insn -- for non-head revisions, a list of parsed instructions
1210 - `(START k COUNT)' -- kill COUNT lines
1211 - `(START i TEXT)' -- insert TEXT (a string)
1212 The list is in descending order by START.
1214 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1217 ;; An RCS masterfile can be viewed as containing four regular (for the
1218 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1219 ;; the "description" and (d) the "rev bodies", in that order. In the
1220 ;; returned alist (see docstring), elements from (b) and (d) are
1221 ;; combined pairwise to form the "revisions", while those from (a) and
1222 ;; (c) are simply combined to form the "headers".
1223 ;;
1224 ;; Loosely speaking, each section contains a series of alternating
1225 ;; "tags" and "printed representations". In the (b) and (d), many
1226 ;; such series can appear, and a revision number on a line by itself
1227 ;; precedes the series of tags and printed representations associated
1228 ;; with it.
1229 ;;
1230 ;; In (a) and (b), the printed representations (with the exception of
1231 ;; the `comment' tag in the headers) terminate with a semicolon, which
1232 ;; is NOT part of the "value" finally associated with the tag. All
1233 ;; other printed representations are in "@@-format"; there is an "@",
1234 ;; the middle part (to be translated into the value), another "@" and
1235 ;; a newline. Each "@@" in the middle part indicates the position of
1236 ;; a single "@" (and consequently the requirement of an additional
1237 ;; initial step when translating to the value).
1238 ;;
1239 ;; Parser state includes vars that collect parts of the return value...
1241 ;; ... as well as vars that support a single-pass, tag-assisted,
1242 ;; minimal-data-copying scan. Basically -- skirting around the
1243 ;; grouping by revision required in (b) and (d) -- we repeatedly
1244 ;; and context-sensitively read a tag (that MUST be present),
1245 ;; determine the bounds of the printed representation, translate
1246 ;; it into a value, and push the tag plus value onto one of the
1247 ;; collection vars. Finally, we return the parse tree
1248 ;; incorporating the values of the collection vars (see "rv").
1249 ;;
1250 ;; A symbol or string to keep track of context (for error messages).
1251 context
1252 ;; A symbol, the current tag.
1253 tok
1254 ;; Region (begin and end buffer positions) of the printed
1255 ;; representation for the current tag.
1256 b e
1257 ;; A list of buffer positions where "@@" can be found within the
1258 ;; printed representation region. For each location, we push two
1259 ;; elements onto the list, 1+ and 2+ the location, respectively,
1260 ;; with the 2+ appearing at the head. In this way, the expression
1261 ;; `(,e ,@@-holes ,b)
1262 ;; describes regions that can be concatenated (in reverse order)
1263 ;; to "de-@@-format" the printed representation as the first step
1264 ;; to translating it into some value. See internal func `gather'.
1294 acc)
1298 acc)
1306 ;; headers
1320 two))
1326 t))
1327 headers)
1335 ;; rev headers
1344 b e)
1346 ;; Hack the year -- verified to be the
1347 ;; same algorithm used in RCS 5.7.
1357 revs)
1360 ;; desc
1363 ;; rev bodies
1365 ;; Element of `revs' that initially holds only header info.
1366 ;; "Pairwise combination" occurs when we add body info.
1367 rev
1368 ;; Components of the editing commands (aside from the actual
1369 ;; text) that comprise the `text' printed representations
1370 ;; (not including the "head" revision).
1371 cmd start act
1372 ;; Ascending (reversed) `@-holes' which the internal func
1373 ;; `incg' pops to effect incremental gathering.
1374 asc
1375 ;; Function to extract text (for the `a' command), either
1376 ;; `incg' or `buffer-substring-no-properties'. (This is
1377 ;; for speed; strictly speaking, it is sufficient to use
1378 ;; only the former since it behaves identically to the
1379 ;; latter in the absence of "@@".)
1380 sub)
1386 ;; Self-deprecate when work is done.
1387 ;; Folding many dimensions into one.
1388 ;; Thanks B.Mandelbrot, for complex sum.
1389 ;; O beauteous math! --the Unvexed Bum
1398 context))))
1400 ;; For rev body `text' tags, delay translation slightly...
1402 ;; ... until we decide which tag and value is appropriate to
1403 ;; collect. For the "head" revision, compute the value of the
1404 ;; `text' printed representation by simple `gather'. For all
1405 ;; other revisions, replace the `text' tag+value with `:insn'
1406 ;; plus value, always scanning in-place.
1422 (?d
1423 ;; `d' means "delete lines".
1424 ;; For Emacs spirit, we use `k' for "kill".
1426 (?a
1427 ;; `a' means "append after this line" but
1428 ;; internally we normalize it so that START
1429 ;; specifies the actual line for insert, thus
1430 ;; requiring less hair in the realization algs.
1431 ;; For Emacs spirit, we use `i' for "insert".
1436 cmd context)))
1437 acc))
1440 ;; rv
1446 ;;; vc-rcs.el ends here