| blob | 8aedc00269dbdf6bcc0137a8d1297bd71f31d794 |
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"
248 ;; parse output to find master file name and workfile version
255 ;; if we couldn't find the master name,
256 ;; run vc-rcs-registered to get it
257 ;; (will be stored into the vc-master-name property)
261 name
263 name
268 nil t)
272 "Return non-nil if RCS thinks it would be responsible for registering FILE."
273 ;; TODO: check for all the patterns in vc-rcs-master-templates
276 file
280 "Implementation of receive-file for RCS."
288 "Unregister FILE from RCS.
289 If this leaves the RCS subdirectory empty, ask the user
290 whether to remove it."
300 ;; check whether RCS dir is empty, i.e. it does not
301 ;; contain any files except "." and ".."
307 ;; It used to be possible to pass in a value for the variable rev, but
308 ;; nothing in the rest of VC used this capability. Removing it makes the
309 ;; backend interface simpler for all modes.
310 ;;
312 "RCS-specific version of `vc-backend-checkin'."
314 ;; Now operate on the files
318 ;; Force branch creation if an appropriate
319 ;; default branch has been set.
322 default-branch)
329 ;; if available, use the secure check-in option
333 switches)
336 ;; determine the new workfile version
346 ;; if we got to a different branch, adjust the default
347 ;; branch accordingly
355 ;; If this is an old (pre-1992!) RCS release, we might have
356 ;; to remove a remaining lock.
358 ;; exit status of 1 is also accepted.
359 ;; It means that the lock was removed before.
371 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
372 attempt the checkout for all registered files beneath it."
376 switches)
379 ;; Change buffers to get local value of vc-checkout-switches.
382 ;; Save this buffer's default-directory
383 ;; and use save-excursion to make sure it is restored
384 ;; in the same buffer it was saved in.
387 ;; Adjust the default-directory so that the check-out creates
388 ;; the file in the right place.
391 ;; if we should go to the head of the trunk,
392 ;; clear the default branch first
395 ;; now do the checkout
398 ;; If locking is not strict, force to overwrite
399 ;; the writable workfile.
401 "-l"
403 ;; a literal revision was specified
409 ;; no revision specified:
410 ;; use current workfile version
411 workrev
412 ;; REV is t ...
414 ;; ... go to head of current branch
416 ;; ... go to head of trunk
418 nil)
420 switches)
421 ;; determine the new workfile version
426 ;; if necessary, adjust the default branch
429 file
433 new-version)))))
437 "Revert FILE to the version it was based on. If FILE is a directory,
438 revert all registered files beneath it."
446 "Accept a file merge request, prompting for revisions."
452 second-revision)
460 "Second RCS revision: "
463 ;; We want to merge an entire branch. Set revisions
464 ;; accordingly, so that vc-rcs-merge understands us.
466 ;; first-revision must be the starting point of the branch
471 "Merge changes into current working copy of FILE.
472 The changes are between FIRST-VERSION and SECOND-VERSION."
479 "Steal the lock on the current workfile for FILE and revision REV.
480 If FILE is a directory, steal the lock on all registered files beneath it.
481 Needs RCS 5.6.2 or later for -M."
485 ;; Do a real checkout after stealing the lock, so that we see
486 ;; expanded headers.
488 ;; Must clear any headers here because they wouldn't
489 ;; show that the file is locked now.
494 ;; save-excursion may be able to relocate point and mark
495 ;; properly. If it fails, vc-restore-buffer-context
496 ;; will give it a second try.
505 "Modify the change comments change on FILES on a specified REV. If FILE is a
506 directory the operation is applied to all registered files beneath it."
511 \f
512 ;;;
513 ;;; History functions
514 ;;;
528 _start-revision-ignored limit)
529 "Print commit log associated with FILES into specified BUFFER.
530 Remaining arguments are ignored.
531 If FILE is a directory the operation is applied to all registered
532 files beneath it."
540 "Get a difference report using RCS between two sets of files."
550 "Return the administrative directory of FILE."
554 "Return a string with all log entries stored in BACKEND for FILE."
556 ;; Has to be written this way, this function is used by the CVS backend too
558 ;; Remove cruft
574 ;; Return the de-crufted comment list
578 "Annotate FILE, inserting the results in BUFFER.
579 Optional arg REVISION is a revision to annotate from."
581 ;; Aside from the "head revision on the trunk", the instructions for
582 ;; each revision on the trunk are an ordered list of kill and insert
583 ;; commands necessary to go from the chronologically-following
584 ;; revision to this one. That is, associated with revision N are
585 ;; edits that applied to revision N+1 would result in revision N.
586 ;;
587 ;; On a branch, however, (some) things are inverted: the commands
588 ;; listed are those necessary to go from the chronologically-preceding
589 ;; revision to this one. That is, associated with revision N are
590 ;; edits that applied to revision N-1 would result in revision N.
591 ;;
592 ;; So, to get per-line history info, we apply reverse-chronological
593 ;; edits, starting with the head revision on the trunk, all the way
594 ;; back through the initial revision (typically "1.1" or similar),
595 ;; then apply forward-chronological edits -- keeping track of which
596 ;; revision is associated with each inserted line -- until we reach
597 ;; the desired revision for display (which may be either on the trunk
598 ;; or on a branch).
603 ;; The revision N whose instructions we currently are processing.
605 ;; Alist from the parse tree for N.
607 ;; Point and temporary string, respectively.
608 p s
609 ;; "Next-branch list". Nil means the desired revision to
610 ;; display lives on the trunk. Non-nil means it lives on a
611 ;; branch, in which case the value is a list of revision pairs
612 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
613 ;; links each series of revisions in the path from the initial
614 ;; revision to the desired revision to display.
615 nbls
616 ;; "Path-accumulate-predicate plus revision/date/author".
617 ;; Until set, forward-chronological edits are not accumulated.
618 ;; Once set, its value (updated every revision) is used for
619 ;; the text property `:vc-rcs-r/d/a' for inserts during
620 ;; processing of forward-chronological instructions for N.
621 ;; See internal func `r/d/a'.
622 prda
623 ;; List of forward-chronological instructions, each of the
624 ;; form: (POS . ACTION), where POS is a buffer position. If
625 ;; ACTION is a string, it is inserted, otherwise it is taken as
626 ;; the number of characters to be deleted.
627 path
628 ;; N+1. When `cur' is "", this is the initial revision.
629 pre)
634 ;; Find which branches (if any) must be included in the edits.
636 bpt kids)
640 ;; A branchpoint may have multiple children. Find the right one.
644 ;; Start with the full text.
647 ;; Apply reverse-chronological edits on the trunk, computing and
648 ;; accumulating forward-chronological edits after some point, for
649 ;; later.
656 ;; Start accumulating the forward-chronological edits when N+1
657 ;; on the trunk is either the desired revision to display, or
658 ;; the appropriate branchpoint for it. Do this before
659 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
663 ;; Edits in the parse tree specify a line number (in the buffer
664 ;; *BEFORE* editing occurs) to start from, but line numbers
665 ;; change as a result of edits. To DTRT, we apply edits in
666 ;; order of descending buffer position so that edits further
667 ;; down in the buffer occur first w/o corrupting specified
668 ;; buffer positions of edits occurring towards the beginning of
669 ;; the buffer. In this way we avoid using markers. A pleasant
670 ;; property of this approach is ability to push instructions
671 ;; onto `path' directly, w/o need to maintain rev boundaries.
687 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
688 ;; equivalent to pushing an insert instruction (of the entire buffer
689 ;; contents) onto `path' then erasing the buffer, but less wasteful.
691 ;; Now apply the forward-chronological edits for the trunk.
697 ;; Now apply the forward-chronological edits (directly from the
698 ;; parse-tree) for the branch(es), if necessary. We re-use vars
699 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
704 prda nil)
718 ;; Lastly, for each line, insert at bol nicely-formatted history info.
719 ;; We do two passes to collect summary information used to minimize
720 ;; the annotation's usage of screen real-estate: (1) Consider rendered
721 ;; width of revision plus author together as a unit; and (2) Omit
722 ;; author entirely if all authors are the same as the user.
727 rda w a)
737 ht)
745 " "
747 ls)
748 :vc-annotate-prefix t
756 ht)))
764 "Return the current time, based at midnight of the current day, and
765 encoded as fractional days."
770 "Return the time of the next annotation (as fraction of days)
771 systime, or nil if there is none. Also, reposition point."
780 \f
781 ;;;
782 ;;; Tag system
783 ;;;
795 dir
799 \f
800 ;;;
801 ;;; Miscellaneous
802 ;;;
805 "Return t if REV is a revision on the trunk."
809 "Return the minor revision number of a revision number REV."
814 "Return the revision number immediately preceding REV for FILE,
815 or nil if there is no previous revision. This default
816 implementation works for MAJOR.MINOR-style revision numbers as
817 used by RCS and CVS."
822 ;; revision does probably not start a branch or release
825 ;; we are at the beginning of the trunk --
826 ;; don't know anything to return here
827 nil
828 ;; we are at the beginning of a branch --
829 ;; return revision of starting point
833 "Return the revision number immediately following REV for FILE,
834 or nil if there is no next revision. This default implementation
835 works for MAJOR.MINOR-style revision numbers as used by RCS
836 and CVS."
842 ;; You might think that this should be distributed with RCS, but
843 ;; apparently not. CVS sometimes provides a version of it.
844 ;; http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00288.html
849 exe)
850 ;; In the unlikely event that someone is running an
851 ;; uninstalled Emacs and wants to do something RCS-related.
854 exe)
861 "Default implementation of update-changelog.
862 Uses `rcs2log' which only works for RCS and CVS."
863 ;; FIXME: We (c|sh)ould add support for cvs2cl
866 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
870 temporary-file-directory))))
878 user-mail-address)))
892 "-c" changelog
900 files)))
901 "done"
910 "Check if the current file has any headers in it."
917 "Clear RCS header value parts."
923 nil t)
929 ;; Just move the master file (using vc-rcs-master-templates).
933 ;; If the file is locked by some other user, make
934 ;; the buffer read-only. Like this, even root
935 ;; cannot modify a file that someone else has locked.
939 \f
940 ;;;
941 ;;; Internal functions
942 ;;;
945 "Return non-nil if FILE is newer than its RCS master.
946 This likely means that FILE has been changed with respect
947 to its master version."
955 "Find most recent revision on BRANCH."
960 nil t)
969 "Compute the master file's idea of the state of FILE.
970 If a WORKING-REVISION is given, compute the state of that version,
971 otherwise determine the workfile version based on the master file.
972 This function sets the properties `vc-working-revision' and
973 `vc-checkout-model' to their correct values, based on the master
974 file."
985 ;; Workfile version not known yet. Determine that first. It
986 ;; is either the head of the trunk, the head of the default
987 ;; branch, or the "default branch" itself, if that is a full
988 ;; revision number.
990 ;; no default branch
995 ;; default branch is actually a revision
997 default-branch)
999 ;; else, search for the head of the default branch
1005 ;; Check strict locking
1010 ;; Compute state of workfile version
1018 ;; not locked
1022 ;; workfile version is latest on branch
1023 'up-to-date
1024 ;; workfile version is not latest on branch
1026 ;; locked by the calling user
1029 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1031 workfile-is-latest
1033 'edited
1034 ;; Locking is not used for the file, but the owner does
1035 ;; have a lock, and there is a higher version on the current
1036 ;; branch. Not sure if this can occur, and if it is right
1037 ;; to use `needs-merge' in this case.
1039 ;; locked by somebody else
1041 locking-user)
1046 "Search for RCS headers in FILE, and set properties accordingly.
1048 Returns: nil if no headers were found
1049 'rev if a workfile revision was found
1050 'rev-and-lock if revision and lock info was found"
1058 ;; search for $Id or $Header
1059 ;; -------------------------
1060 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1067 ;; if found, store the revision number ...
1069 ;; ... and check for the locking state
1077 ;; unlocked revision
1079 ;;(setq locking-user 'none)
1081 ;; revision is locked by some user
1083 ;;(setq locking-user (match-string-no-properties 1))
1085 ;; everything else: false
1087 ;; unexpected information in
1088 ;; keyword string --> quit
1090 ;; search for $Revision
1091 ;; --------------------
1094 nil t)
1095 ;; if found, store the revision number ...
1097 ;; and see if there's any lock information
1101 ;;(setq locking-user (match-string-no-properties 1))
1104 ;;(setq locking-user 'none)
1107 ;;(setq locking-user 'none)
1110 ;; else: nothing found
1111 ;; -------------------
1114 status))))
1117 "Compare release numbers, represented as strings.
1118 Release components are assumed cardinal numbers, not decimal fractions
1119 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1120 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1121 of the string is found, or a non-numeric component shows up \(5.6.7 is
1123 some cases\). This code is suitable for existing RCS release numbers.
1124 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1145 "Return t if we have RELEASE or better."
1152 "Return the RCS release installed on this system, as a string.
1153 Return symbol `unknown' if the release cannot be deducted. The user can
1154 override this using variable `vc-rcs-release'.
1156 If the user has not set variable `vc-rcs-release' and it is nil,
1157 variable `vc-rcs-release' is set to the returned value."
1175 "Parse current buffer, presumed to be in RCS-style masterfile format.
1176 Optional arg BUFFER specifies another buffer to parse. Return an alist
1177 of two elements, w/ keys `headers' and `revisions' and values in turn
1178 sub-alists. For `headers', the values unless otherwise specified are
1179 strings and the keys are:
1181 desc -- description
1182 head -- latest revision
1184 absent if the head revision lies on the trunk
1185 access -- ???
1186 symbols -- sub-alist of (SYMBOL . REVISION) elements
1190 expand -- may be absent; ???
1192 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1193 with string values (unless otherwise specified) and keys:
1195 date -- a time value (like that returned by `encode-time'); as a
1196 special case, a year value less than 100 is augmented by 1900
1197 author -- username
1199 branches -- list of revisions that begin branches from this revision
1202 log -- change log entry
1203 text -- for the head revision on the trunk, the body of the file;
1204 other revisions have `:insn' instead
1205 :insn -- for non-head revisions, a list of parsed instructions
1208 - `(START k COUNT)' -- kill COUNT lines
1209 - `(START i TEXT)' -- insert TEXT (a string)
1210 The list is in descending order by START.
1212 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1215 ;; An RCS masterfile can be viewed as containing four regular (for the
1216 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1217 ;; the "description" and (d) the "rev bodies", in that order. In the
1218 ;; returned alist (see docstring), elements from (b) and (d) are
1219 ;; combined pairwise to form the "revisions", while those from (a) and
1220 ;; (c) are simply combined to form the "headers".
1221 ;;
1222 ;; Loosely speaking, each section contains a series of alternating
1223 ;; "tags" and "printed representations". In the (b) and (d), many
1224 ;; such series can appear, and a revision number on a line by itself
1225 ;; precedes the series of tags and printed representations associated
1226 ;; with it.
1227 ;;
1228 ;; In (a) and (b), the printed representations (with the exception of
1229 ;; the `comment' tag in the headers) terminate with a semicolon, which
1230 ;; is NOT part of the "value" finally associated with the tag. All
1231 ;; other printed representations are in "@@-format"; there is an "@",
1232 ;; the middle part (to be translated into the value), another "@" and
1233 ;; a newline. Each "@@" in the middle part indicates the position of
1234 ;; a single "@" (and consequently the requirement of an additional
1235 ;; initial step when translating to the value).
1236 ;;
1237 ;; Parser state includes vars that collect parts of the return value...
1239 ;; ... as well as vars that support a single-pass, tag-assisted,
1240 ;; minimal-data-copying scan. Basically -- skirting around the
1241 ;; grouping by revision required in (b) and (d) -- we repeatedly
1242 ;; and context-sensitively read a tag (that MUST be present),
1243 ;; determine the bounds of the printed representation, translate
1244 ;; it into a value, and push the tag plus value onto one of the
1245 ;; collection vars. Finally, we return the parse tree
1246 ;; incorporating the values of the collection vars (see "rv").
1247 ;;
1248 ;; A symbol or string to keep track of context (for error messages).
1249 context
1250 ;; A symbol, the current tag.
1251 tok
1252 ;; Region (begin and end buffer positions) of the printed
1253 ;; representation for the current tag.
1254 b e
1255 ;; A list of buffer positions where "@@" can be found within the
1256 ;; printed representation region. For each location, we push two
1257 ;; elements onto the list, 1+ and 2+ the location, respectively,
1258 ;; with the 2+ appearing at the head. In this way, the expression
1259 ;; `(,e ,@@-holes ,b)
1260 ;; describes regions that can be concatenated (in reverse order)
1261 ;; to "de-@@-format" the printed representation as the first step
1262 ;; to translating it into some value. See internal func `gather'.
1292 acc)
1296 acc)
1304 ;; headers
1318 two))
1324 t))
1325 headers)
1333 ;; rev headers
1342 b e)
1344 ;; Hack the year -- verified to be the
1345 ;; same algorithm used in RCS 5.7.
1355 revs)
1358 ;; desc
1361 ;; rev bodies
1363 ;; Element of `revs' that initially holds only header info.
1364 ;; "Pairwise combination" occurs when we add body info.
1365 rev
1366 ;; Components of the editing commands (aside from the actual
1367 ;; text) that comprise the `text' printed representations
1368 ;; (not including the "head" revision).
1369 cmd start act
1370 ;; Ascending (reversed) `@-holes' which the internal func
1371 ;; `incg' pops to effect incremental gathering.
1372 asc
1373 ;; Function to extract text (for the `a' command), either
1374 ;; `incg' or `buffer-substring-no-properties'. (This is
1375 ;; for speed; strictly speaking, it is sufficient to use
1376 ;; only the former since it behaves identically to the
1377 ;; latter in the absence of "@@".)
1378 sub)
1384 ;; Self-deprecate when work is done.
1385 ;; Folding many dimensions into one.
1386 ;; Thanks B.Mandelbrot, for complex sum.
1387 ;; O beauteous math! --the Unvexed Bum
1396 context))))
1398 ;; For rev body `text' tags, delay translation slightly...
1400 ;; ... until we decide which tag and value is appropriate to
1401 ;; collect. For the "head" revision, compute the value of the
1402 ;; `text' printed representation by simple `gather'. For all
1403 ;; other revisions, replace the `text' tag+value with `:insn'
1404 ;; plus value, always scanning in-place.
1420 (?d
1421 ;; `d' means "delete lines".
1422 ;; For Emacs spirit, we use `k' for "kill".
1424 (?a
1425 ;; `a' means "append after this line" but
1426 ;; internally we normalize it so that START
1427 ;; specifies the actual line for insert, thus
1428 ;; requiring less hair in the realization algs.
1429 ;; For Emacs spirit, we use `i' for "insert".
1434 cmd context)))
1435 acc))
1438 ;; rv
1444 ;;; vc-rcs.el ends here