| blob | d575530c98b2468166baa7f4ee3e8fd397033a00 |
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."
299 ;; check whether RCS dir is empty, i.e. it does not
300 ;; contain any files except "." and ".."
306 ;; It used to be possible to pass in a value for the variable rev, but
307 ;; nothing in the rest of VC used this capability. Removing it makes the
308 ;; backend interface simpler for all modes.
309 ;;
311 "RCS-specific version of `vc-backend-checkin'."
313 ;; Now operate on the files
317 ;; Force branch creation if an appropriate
318 ;; default branch has been set.
321 default-branch)
328 ;; if available, use the secure check-in option
332 switches)
335 ;; determine the new workfile version
345 ;; if we got to a different branch, adjust the default
346 ;; branch accordingly
354 ;; If this is an old (pre-1992!) RCS release, we might have
355 ;; to remove a remaining lock.
357 ;; exit status of 1 is also accepted.
358 ;; It means that the lock was removed before.
370 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
371 attempt the checkout for all registered files beneath it."
375 switches)
378 ;; Change buffers to get local value of vc-checkout-switches.
381 ;; Save this buffer's default-directory
382 ;; and use save-excursion to make sure it is restored
383 ;; in the same buffer it was saved in.
386 ;; Adjust the default-directory so that the check-out creates
387 ;; the file in the right place.
390 ;; if we should go to the head of the trunk,
391 ;; clear the default branch first
394 ;; now do the checkout
397 ;; If locking is not strict, force to overwrite
398 ;; the writable workfile.
400 "-l"
402 ;; a literal revision was specified
408 ;; no revision specified:
409 ;; use current workfile version
410 workrev
411 ;; REV is t ...
413 ;; ... go to head of current branch
415 ;; ... go to head of trunk
417 nil)
419 switches)
420 ;; determine the new workfile version
425 ;; if necessary, adjust the default branch
428 file
432 new-version)))))
436 "Revert FILE to the version it was based on. If FILE is a directory,
437 revert all registered files beneath it."
445 "Accept a file merge request, prompting for revisions."
451 second-revision)
459 "Second RCS revision: "
462 ;; We want to merge an entire branch. Set revisions
463 ;; accordingly, so that vc-rcs-merge understands us.
465 ;; first-revision must be the starting point of the branch
470 "Merge changes into current working copy of FILE.
471 The changes are between FIRST-VERSION and SECOND-VERSION."
478 "Steal the lock on the current workfile for FILE and revision REV.
479 If FILE is a directory, steal the lock on all registered files beneath it.
480 Needs RCS 5.6.2 or later for -M."
484 ;; Do a real checkout after stealing the lock, so that we see
485 ;; expanded headers.
487 ;; Must clear any headers here because they wouldn't
488 ;; show that the file is locked now.
493 ;; save-excursion may be able to relocate point and mark
494 ;; properly. If it fails, vc-restore-buffer-context
495 ;; will give it a second try.
504 "Modify the change comments change on FILES on a specified REV. If FILE is a
505 directory the operation is applied to all registered files beneath it."
510 \f
511 ;;;
512 ;;; History functions
513 ;;;
527 _start-revision-ignored limit)
528 "Print commit log associated with FILES into specified BUFFER.
529 Remaining arguments are ignored.
530 If FILE is a directory the operation is applied to all registered
531 files beneath it."
539 "Get a difference report using RCS between two sets of files."
549 "Return the administrative directory of FILE."
553 "Return a string with all log entries stored in BACKEND for FILE."
555 ;; Has to be written this way, this function is used by the CVS backend too
557 ;; Remove cruft
573 ;; Return the de-crufted comment list
577 "Annotate FILE, inserting the results in BUFFER.
578 Optional arg REVISION is a revision to annotate from."
580 ;; Aside from the "head revision on the trunk", the instructions for
581 ;; each revision on the trunk are an ordered list of kill and insert
582 ;; commands necessary to go from the chronologically-following
583 ;; revision to this one. That is, associated with revision N are
584 ;; edits that applied to revision N+1 would result in revision N.
585 ;;
586 ;; On a branch, however, (some) things are inverted: the commands
587 ;; listed are those necessary to go from the chronologically-preceding
588 ;; revision to this one. That is, associated with revision N are
589 ;; edits that applied to revision N-1 would result in revision N.
590 ;;
591 ;; So, to get per-line history info, we apply reverse-chronological
592 ;; edits, starting with the head revision on the trunk, all the way
593 ;; back through the initial revision (typically "1.1" or similar),
594 ;; then apply forward-chronological edits -- keeping track of which
595 ;; revision is associated with each inserted line -- until we reach
596 ;; the desired revision for display (which may be either on the trunk
597 ;; or on a branch).
602 ;; The revision N whose instructions we currently are processing.
604 ;; Alist from the parse tree for N.
606 ;; Point and temporary string, respectively.
607 p s
608 ;; "Next-branch list". Nil means the desired revision to
609 ;; display lives on the trunk. Non-nil means it lives on a
610 ;; branch, in which case the value is a list of revision pairs
611 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
612 ;; links each series of revisions in the path from the initial
613 ;; revision to the desired revision to display.
614 nbls
615 ;; "Path-accumulate-predicate plus revision/date/author".
616 ;; Until set, forward-chronological edits are not accumulated.
617 ;; Once set, its value (updated every revision) is used for
618 ;; the text property `:vc-rcs-r/d/a' for inserts during
619 ;; processing of forward-chronological instructions for N.
620 ;; See internal func `r/d/a'.
621 prda
622 ;; List of forward-chronological instructions, each of the
623 ;; form: (POS . ACTION), where POS is a buffer position. If
624 ;; ACTION is a string, it is inserted, otherwise it is taken as
625 ;; the number of characters to be deleted.
626 path
627 ;; N+1. When `cur' is "", this is the initial revision.
628 pre)
633 ;; Find which branches (if any) must be included in the edits.
635 bpt kids)
639 ;; A branchpoint may have multiple children. Find the right one.
643 ;; Start with the full text.
646 ;; Apply reverse-chronological edits on the trunk, computing and
647 ;; accumulating forward-chronological edits after some point, for
648 ;; later.
655 ;; Start accumulating the forward-chronological edits when N+1
656 ;; on the trunk is either the desired revision to display, or
657 ;; the appropriate branchpoint for it. Do this before
658 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
662 ;; Edits in the parse tree specify a line number (in the buffer
663 ;; *BEFORE* editing occurs) to start from, but line numbers
664 ;; change as a result of edits. To DTRT, we apply edits in
665 ;; order of descending buffer position so that edits further
666 ;; down in the buffer occur first w/o corrupting specified
667 ;; buffer positions of edits occurring towards the beginning of
668 ;; the buffer. In this way we avoid using markers. A pleasant
669 ;; property of this approach is ability to push instructions
670 ;; onto `path' directly, w/o need to maintain rev boundaries.
686 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
687 ;; equivalent to pushing an insert instruction (of the entire buffer
688 ;; contents) onto `path' then erasing the buffer, but less wasteful.
690 ;; Now apply the forward-chronological edits for the trunk.
696 ;; Now apply the forward-chronological edits (directly from the
697 ;; parse-tree) for the branch(es), if necessary. We re-use vars
698 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
703 prda nil)
717 ;; Lastly, for each line, insert at bol nicely-formatted history info.
718 ;; We do two passes to collect summary information used to minimize
719 ;; the annotation's usage of screen real-estate: (1) Consider rendered
720 ;; width of revision plus author together as a unit; and (2) Omit
721 ;; author entirely if all authors are the same as the user.
726 rda w a)
736 ht)
744 " "
746 ls)
747 :vc-annotate-prefix t
755 ht)))
763 "Return the current time, based at midnight of the current day, and
764 encoded as fractional days."
769 "Return the time of the next annotation (as fraction of days)
770 systime, or nil if there is none. Also, reposition point."
779 \f
780 ;;;
781 ;;; Tag system
782 ;;;
794 dir
798 \f
799 ;;;
800 ;;; Miscellaneous
801 ;;;
804 "Return t if REV is a revision on the trunk."
808 "Return the minor revision number of a revision number REV."
813 "Return the revision number immediately preceding REV for FILE,
814 or nil if there is no previous revision. This default
815 implementation works for MAJOR.MINOR-style revision numbers as
816 used by RCS and CVS."
821 ;; revision does probably not start a branch or release
824 ;; we are at the beginning of the trunk --
825 ;; don't know anything to return here
826 nil
827 ;; we are at the beginning of a branch --
828 ;; return revision of starting point
832 "Return the revision number immediately following REV for FILE,
833 or nil if there is no next revision. This default implementation
834 works for MAJOR.MINOR-style revision numbers as used by RCS
835 and CVS."
841 ;; You might think that this should be distributed with RCS, but
842 ;; apparently not. CVS sometimes provides a version of it.
843 ;; http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00288.html
848 exe)
849 ;; In the unlikely event that someone is running an
850 ;; uninstalled Emacs and wants to do something RCS-related.
853 exe)
860 "Default implementation of update-changelog.
861 Uses `rcs2log' which only works for RCS and CVS."
862 ;; FIXME: We (c|sh)ould add support for cvs2cl
865 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
869 temporary-file-directory))))
877 user-mail-address)))
891 "-c" changelog
899 files)))
900 "done"
909 "Check if the current file has any headers in it."
916 "Clear RCS header value parts."
922 nil t)
928 ;; Just move the master file (using vc-rcs-master-templates).
932 ;; If the file is locked by some other user, make
933 ;; the buffer read-only. Like this, even root
934 ;; cannot modify a file that someone else has locked.
938 \f
939 ;;;
940 ;;; Internal functions
941 ;;;
944 "Return non-nil if FILE is newer than its RCS master.
945 This likely means that FILE has been changed with respect
946 to its master version."
954 "Find most recent revision on BRANCH."
959 nil t)
968 "Compute the master file's idea of the state of FILE.
969 If a WORKING-REVISION is given, compute the state of that version,
970 otherwise determine the workfile version based on the master file.
971 This function sets the properties `vc-working-revision' and
972 `vc-checkout-model' to their correct values, based on the master
973 file."
983 ;; Workfile version not known yet. Determine that first. It
984 ;; is either the head of the trunk, the head of the default
985 ;; branch, or the "default branch" itself, if that is a full
986 ;; revision number.
988 ;; no default branch
993 ;; default branch is actually a revision
995 default-branch)
997 ;; else, search for the head of the default branch
1003 ;; Check strict locking
1008 ;; Compute state of workfile version
1016 ;; not locked
1020 ;; workfile version is latest on branch
1021 'up-to-date
1022 ;; workfile version is not latest on branch
1024 ;; locked by the calling user
1027 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1029 workfile-is-latest
1031 'edited
1032 ;; Locking is not used for the file, but the owner does
1033 ;; have a lock, and there is a higher version on the current
1034 ;; branch. Not sure if this can occur, and if it is right
1035 ;; to use `needs-merge' in this case.
1037 ;; locked by somebody else
1039 locking-user)
1044 "Search for RCS headers in FILE, and set properties accordingly.
1046 Returns: nil if no headers were found
1047 'rev if a workfile revision was found
1048 'rev-and-lock if revision and lock info was found"
1056 ;; search for $Id or $Header
1057 ;; -------------------------
1058 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1065 ;; if found, store the revision number ...
1067 ;; ... and check for the locking state
1075 ;; unlocked revision
1077 ;;(setq locking-user 'none)
1079 ;; revision is locked by some user
1081 ;;(setq locking-user (match-string-no-properties 1))
1083 ;; everything else: false
1085 ;; unexpected information in
1086 ;; keyword string --> quit
1088 ;; search for $Revision
1089 ;; --------------------
1092 nil t)
1093 ;; if found, store the revision number ...
1095 ;; and see if there's any lock information
1099 ;;(setq locking-user (match-string-no-properties 1))
1102 ;;(setq locking-user 'none)
1105 ;;(setq locking-user 'none)
1108 ;; else: nothing found
1109 ;; -------------------
1112 status))))
1115 "Compare release numbers, represented as strings.
1116 Release components are assumed cardinal numbers, not decimal fractions
1117 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1118 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1119 of the string is found, or a non-numeric component shows up \(5.6.7 is
1121 some cases\). This code is suitable for existing RCS release numbers.
1122 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1143 "Return t if we have RELEASE or better."
1150 "Return the RCS release installed on this system, as a string.
1151 Return symbol `unknown' if the release cannot be deducted. The user can
1152 override this using variable `vc-rcs-release'.
1154 If the user has not set variable `vc-rcs-release' and it is nil,
1155 variable `vc-rcs-release' is set to the returned value."
1173 "Parse current buffer, presumed to be in RCS-style masterfile format.
1174 Optional arg BUFFER specifies another buffer to parse. Return an alist
1175 of two elements, w/ keys `headers' and `revisions' and values in turn
1176 sub-alists. For `headers', the values unless otherwise specified are
1177 strings and the keys are:
1179 desc -- description
1180 head -- latest revision
1182 absent if the head revision lies on the trunk
1183 access -- ???
1184 symbols -- sub-alist of (SYMBOL . REVISION) elements
1188 expand -- may be absent; ???
1190 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1191 with string values (unless otherwise specified) and keys:
1193 date -- a time value (like that returned by `encode-time'); as a
1194 special case, a year value less than 100 is augmented by 1900
1195 author -- username
1197 branches -- list of revisions that begin branches from this revision
1200 log -- change log entry
1201 text -- for the head revision on the trunk, the body of the file;
1202 other revisions have `:insn' instead
1203 :insn -- for non-head revisions, a list of parsed instructions
1206 - `(START k COUNT)' -- kill COUNT lines
1207 - `(START i TEXT)' -- insert TEXT (a string)
1208 The list is in descending order by START.
1210 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1213 ;; An RCS masterfile can be viewed as containing four regular (for the
1214 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1215 ;; the "description" and (d) the "rev bodies", in that order. In the
1216 ;; returned alist (see docstring), elements from (b) and (d) are
1217 ;; combined pairwise to form the "revisions", while those from (a) and
1218 ;; (c) are simply combined to form the "headers".
1219 ;;
1220 ;; Loosely speaking, each section contains a series of alternating
1221 ;; "tags" and "printed representations". In the (b) and (d), many
1222 ;; such series can appear, and a revision number on a line by itself
1223 ;; precedes the series of tags and printed representations associated
1224 ;; with it.
1225 ;;
1226 ;; In (a) and (b), the printed representations (with the exception of
1227 ;; the `comment' tag in the headers) terminate with a semicolon, which
1228 ;; is NOT part of the "value" finally associated with the tag. All
1229 ;; other printed representations are in "@@-format"; there is an "@",
1230 ;; the middle part (to be translated into the value), another "@" and
1231 ;; a newline. Each "@@" in the middle part indicates the position of
1232 ;; a single "@" (and consequently the requirement of an additional
1233 ;; initial step when translating to the value).
1234 ;;
1235 ;; Parser state includes vars that collect parts of the return value...
1237 ;; ... as well as vars that support a single-pass, tag-assisted,
1238 ;; minimal-data-copying scan. Basically -- skirting around the
1239 ;; grouping by revision required in (b) and (d) -- we repeatedly
1240 ;; and context-sensitively read a tag (that MUST be present),
1241 ;; determine the bounds of the printed representation, translate
1242 ;; it into a value, and push the tag plus value onto one of the
1243 ;; collection vars. Finally, we return the parse tree
1244 ;; incorporating the values of the collection vars (see "rv").
1245 ;;
1246 ;; A symbol or string to keep track of context (for error messages).
1247 context
1248 ;; A symbol, the current tag.
1249 tok
1250 ;; Region (begin and end buffer positions) of the printed
1251 ;; representation for the current tag.
1252 b e
1253 ;; A list of buffer positions where "@@" can be found within the
1254 ;; printed representation region. For each location, we push two
1255 ;; elements onto the list, 1+ and 2+ the location, respectively,
1256 ;; with the 2+ appearing at the head. In this way, the expression
1257 ;; `(,e ,@@-holes ,b)
1258 ;; describes regions that can be concatenated (in reverse order)
1259 ;; to "de-@@-format" the printed representation as the first step
1260 ;; to translating it into some value. See internal func `gather'.
1290 acc)
1294 acc)
1302 ;; headers
1316 two))
1322 t))
1323 headers)
1331 ;; rev headers
1340 b e)
1342 ;; Hack the year -- verified to be the
1343 ;; same algorithm used in RCS 5.7.
1353 revs)
1356 ;; desc
1359 ;; rev bodies
1361 ;; Element of `revs' that initially holds only header info.
1362 ;; "Pairwise combination" occurs when we add body info.
1363 rev
1364 ;; Components of the editing commands (aside from the actual
1365 ;; text) that comprise the `text' printed representations
1366 ;; (not including the "head" revision).
1367 cmd start act
1368 ;; Ascending (reversed) `@-holes' which the internal func
1369 ;; `incg' pops to effect incremental gathering.
1370 asc
1371 ;; Function to extract text (for the `a' command), either
1372 ;; `incg' or `buffer-substring-no-properties'. (This is
1373 ;; for speed; strictly speaking, it is sufficient to use
1374 ;; only the former since it behaves identically to the
1375 ;; latter in the absence of "@@".)
1376 sub)
1382 ;; Self-deprecate when work is done.
1383 ;; Folding many dimensions into one.
1384 ;; Thanks B.Mandelbrot, for complex sum.
1385 ;; O beauteous math! --the Unvexed Bum
1394 context))))
1396 ;; For rev body `text' tags, delay translation slightly...
1398 ;; ... until we decide which tag and value is appropriate to
1399 ;; collect. For the "head" revision, compute the value of the
1400 ;; `text' printed representation by simple `gather'. For all
1401 ;; other revisions, replace the `text' tag+value with `:insn'
1402 ;; plus value, always scanning in-place.
1418 (?d
1419 ;; `d' means "delete lines".
1420 ;; For Emacs spirit, we use `k' for "kill".
1422 (?a
1423 ;; `a' means "append after this line" but
1424 ;; internally we normalize it so that START
1425 ;; specifies the actual line for insert, thus
1426 ;; requiring less hair in the realization algs.
1427 ;; For Emacs spirit, we use `i' for "insert".
1432 cmd context)))
1433 acc))
1436 ;; rv
1442 ;;; vc-rcs.el ends here