| blob | 940d967d68bea1d065abd863bea8cd6a16b476c2 |
1 ;;; vc-rcs.el --- support for RCS version-control -*- lexical-binding:t -*-
3 ;; Copyright (C) 1992-2014 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
161 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
162 ;; should be changed to take a backend parameter. Using
163 ;; `vc-expand-dirs' is not TRTD because it returns files from
164 ;; multiple backends. It should also return 'unregistered files.
166 ;; Doing individual vc-state calls is painful but there
167 ;; is no better way in RCS-land.
179 "RCS-specific version of `vc-working-revision'."
190 "Return non-nil if workfile version of FILE is the latest on its branch.
191 When VERSION is given, perform check for that version."
197 ;; Compare VERSION to the head version number.
200 ;; If we are not on the trunk, we need to examine the
201 ;; whole current branch.
206 "Has FILE remained unchanged since last checkout?"
207 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
208 ;; do a double take and remember the fact for the future
219 ;; The workfile is unchanged if rcsdiff found no differences.
222 \f
223 ;;;
224 ;;; State-changing functions
225 ;;;
228 "Create a new RCS repository."
229 ;; RCS is totally file-oriented, so all we have to do is make the directory.
235 "Register FILES into the RCS version-control system.
236 COMMENT can be used to provide an initial description for each FILES.
237 Passes either `vc-rcs-register-switches' or `vc-register-switches'
238 to the RCS command.
240 Automatically retrieve a read-only version of the file with keywords
241 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
252 ;; if available, use the secure registering option
256 ;; parse output to find master file name and workfile version
263 ;; if we couldn't find the master name,
264 ;; run vc-rcs-registered to get it
265 ;; (will be stored into the vc-master-name property)
269 name
271 name
276 nil t)
280 "Return non-nil if RCS thinks it would be responsible for registering FILE."
281 ;; TODO: check for all the patterns in vc-rcs-master-templates
284 file
288 "Implementation of receive-file for RCS."
296 "Unregister FILE from RCS.
297 If this leaves the RCS subdirectory empty, ask the user
298 whether to remove it."
307 ;; check whether RCS dir is empty, i.e. it does not
308 ;; contain any files except "." and ".."
314 ;; It used to be possible to pass in a value for the variable rev, but
315 ;; nothing in the rest of VC used this capability. Removing it makes the
316 ;; backend interface simpler for all modes.
317 ;;
319 "RCS-specific version of `vc-backend-checkin'."
321 ;; Now operate on the files
325 ;; Force branch creation if an appropriate
326 ;; default branch has been set.
329 default-branch)
336 ;; if available, use the secure check-in option
340 switches)
343 ;; determine the new workfile version
353 ;; if we got to a different branch, adjust the default
354 ;; branch accordingly
362 ;; If this is an old (pre-1992!) RCS release, we might have
363 ;; to remove a remaining lock.
365 ;; exit status of 1 is also accepted.
366 ;; It means that the lock was removed before.
378 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
379 attempt the checkout for all registered files beneath it."
383 switches)
386 ;; Change buffers to get local value of vc-checkout-switches.
389 ;; Save this buffer's default-directory
390 ;; and use save-excursion to make sure it is restored
391 ;; in the same buffer it was saved in.
394 ;; Adjust the default-directory so that the check-out creates
395 ;; the file in the right place.
398 ;; if we should go to the head of the trunk,
399 ;; clear the default branch first
402 ;; now do the checkout
405 ;; If locking is not strict, force to overwrite
406 ;; the writable workfile.
408 "-l"
410 ;; a literal revision was specified
416 ;; no revision specified:
417 ;; use current workfile version
418 workrev
419 ;; REV is t ...
421 ;; ... go to head of current branch
423 ;; ... go to head of trunk
425 nil)
427 switches)
428 ;; determine the new workfile version
433 ;; if necessary, adjust the default branch
436 file
440 new-version)))))
444 "Roll back, undoing the most recent checkins of FILES. Directories are
445 expanded to all registered subfiles in them."
454 discard file)))
458 ;; Check out the most recent remaining version. If it
459 ;; fails, because the whole branch got deleted, do a
460 ;; double-take and check out the version where the branch
461 ;; started.
473 ;; vc-do-command popped up a window with
474 ;; the error message. Get rid of it, by
475 ;; restoring the old window configuration.
477 ;; No, it was some other error: re-signal it.
481 "Revert FILE to the version it was based on. If FILE is a directory,
482 revert all registered files beneath it."
490 "Accept a file merge request, prompting for revisions."
496 second-revision)
504 "Second RCS revision: "
507 ;; We want to merge an entire branch. Set revisions
508 ;; accordingly, so that vc-rcs-merge understands us.
510 ;; first-revision must be the starting point of the branch
515 "Merge changes into current working copy of FILE.
516 The changes are between FIRST-VERSION and SECOND-VERSION."
523 "Steal the lock on the current workfile for FILE and revision REV.
524 If FILE is a directory, steal the lock on all registered files beneath it.
525 Needs RCS 5.6.2 or later for -M."
529 ;; Do a real checkout after stealing the lock, so that we see
530 ;; expanded headers.
534 "Modify the change comments change on FILES on a specified REV. If FILE is a
535 directory the operation is applied to all registered files beneath it."
540 \f
541 ;;;
542 ;;; History functions
543 ;;;
557 _start-revision-ignored limit)
558 "Print commit log associated with FILES into specified BUFFER.
559 Remaining arguments are ignored.
560 If FILE is a directory the operation is applied to all registered
561 files beneath it."
569 "Get a difference report using RCS between two sets of files."
579 "Return the administrative directory of FILE."
583 "Return a string with all log entries stored in BACKEND for FILE."
585 ;; Has to be written this way, this function is used by the CVS backend too
587 ;; Remove cruft
603 ;; Return the de-crufted comment list
607 "Annotate FILE, inserting the results in BUFFER.
608 Optional arg REVISION is a revision to annotate from."
610 ;; Aside from the "head revision on the trunk", the instructions for
611 ;; each revision on the trunk are an ordered list of kill and insert
612 ;; commands necessary to go from the chronologically-following
613 ;; revision to this one. That is, associated with revision N are
614 ;; edits that applied to revision N+1 would result in revision N.
615 ;;
616 ;; On a branch, however, (some) things are inverted: the commands
617 ;; listed are those necessary to go from the chronologically-preceding
618 ;; revision to this one. That is, associated with revision N are
619 ;; edits that applied to revision N-1 would result in revision N.
620 ;;
621 ;; So, to get per-line history info, we apply reverse-chronological
622 ;; edits, starting with the head revision on the trunk, all the way
623 ;; back through the initial revision (typically "1.1" or similar),
624 ;; then apply forward-chronological edits -- keeping track of which
625 ;; revision is associated with each inserted line -- until we reach
626 ;; the desired revision for display (which may be either on the trunk
627 ;; or on a branch).
632 ;; The revision N whose instructions we currently are processing.
634 ;; Alist from the parse tree for N.
636 ;; Point and temporary string, respectively.
637 p s
638 ;; "Next-branch list". Nil means the desired revision to
639 ;; display lives on the trunk. Non-nil means it lives on a
640 ;; branch, in which case the value is a list of revision pairs
641 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
642 ;; links each series of revisions in the path from the initial
643 ;; revision to the desired revision to display.
644 nbls
645 ;; "Path-accumulate-predicate plus revision/date/author".
646 ;; Until set, forward-chronological edits are not accumulated.
647 ;; Once set, its value (updated every revision) is used for
648 ;; the text property `:vc-rcs-r/d/a' for inserts during
649 ;; processing of forward-chronological instructions for N.
650 ;; See internal func `r/d/a'.
651 prda
652 ;; List of forward-chronological instructions, each of the
653 ;; form: (POS . ACTION), where POS is a buffer position. If
654 ;; ACTION is a string, it is inserted, otherwise it is taken as
655 ;; the number of characters to be deleted.
656 path
657 ;; N+1. When `cur' is "", this is the initial revision.
658 pre)
663 ;; Find which branches (if any) must be included in the edits.
665 bpt kids)
669 ;; A branchpoint may have multiple children. Find the right one.
673 ;; Start with the full text.
676 ;; Apply reverse-chronological edits on the trunk, computing and
677 ;; accumulating forward-chronological edits after some point, for
678 ;; later.
685 ;; Start accumulating the forward-chronological edits when N+1
686 ;; on the trunk is either the desired revision to display, or
687 ;; the appropriate branchpoint for it. Do this before
688 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
692 ;; Edits in the parse tree specify a line number (in the buffer
693 ;; *BEFORE* editing occurs) to start from, but line numbers
694 ;; change as a result of edits. To DTRT, we apply edits in
695 ;; order of descending buffer position so that edits further
696 ;; down in the buffer occur first w/o corrupting specified
697 ;; buffer positions of edits occurring towards the beginning of
698 ;; the buffer. In this way we avoid using markers. A pleasant
699 ;; property of this approach is ability to push instructions
700 ;; onto `path' directly, w/o need to maintain rev boundaries.
716 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
717 ;; equivalent to pushing an insert instruction (of the entire buffer
718 ;; contents) onto `path' then erasing the buffer, but less wasteful.
720 ;; Now apply the forward-chronological edits for the trunk.
726 ;; Now apply the forward-chronological edits (directly from the
727 ;; parse-tree) for the branch(es), if necessary. We re-use vars
728 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
733 prda nil)
747 ;; Lastly, for each line, insert at bol nicely-formatted history info.
748 ;; We do two passes to collect summary information used to minimize
749 ;; the annotation's usage of screen real-estate: (1) Consider rendered
750 ;; width of revision plus author together as a unit; and (2) Omit
751 ;; author entirely if all authors are the same as the user.
756 rda w a)
766 ht)
774 " "
776 ls)
777 :vc-annotate-prefix t
785 ht)))
793 "Return the current time, based at midnight of the current day, and
794 encoded as fractional days."
799 "Return the time of the next annotation (as fraction of days)
800 systime, or nil if there is none. Also, reposition point."
809 \f
810 ;;;
811 ;;; Tag system
812 ;;;
824 dir
828 \f
829 ;;;
830 ;;; Miscellaneous
831 ;;;
834 "Return t if REV is a revision on the trunk."
838 "Return the minor revision number of a revision number REV."
843 "Return the revision number immediately preceding REV for FILE,
844 or nil if there is no previous revision. This default
845 implementation works for MAJOR.MINOR-style revision numbers as
846 used by RCS and CVS."
851 ;; revision does probably not start a branch or release
854 ;; we are at the beginning of the trunk --
855 ;; don't know anything to return here
856 nil
857 ;; we are at the beginning of a branch --
858 ;; return revision of starting point
862 "Return the revision number immediately following REV for FILE,
863 or nil if there is no next revision. This default implementation
864 works for MAJOR.MINOR-style revision numbers as used by RCS
865 and CVS."
871 ;; You might think that this should be distributed with RCS, but
872 ;; apparently not. CVS sometimes provides a version of it.
873 ;; http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00288.html
878 exe)
879 ;; In the unlikely event that someone is running an
880 ;; uninstalled Emacs and wants to do something RCS-related.
883 exe)
890 "Default implementation of update-changelog.
891 Uses `rcs2log' which only works for RCS and CVS."
892 ;; FIXME: We (c|sh)ould add support for cvs2cl
895 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
899 temporary-file-directory))))
907 user-mail-address)))
921 "-c" changelog
929 files)))
930 "done"
939 "Check if the current file has any headers in it."
946 "Implementation of vc-clear-headers for RCS."
952 nil t)
958 ;; Just move the master file (using vc-rcs-master-templates).
962 ;; If the file is locked by some other user, make
963 ;; the buffer read-only. Like this, even root
964 ;; cannot modify a file that someone else has locked.
968 \f
969 ;;;
970 ;;; Internal functions
971 ;;;
974 "Return non-nil if FILE is newer than its RCS master.
975 This likely means that FILE has been changed with respect
976 to its master version."
984 "Find most recent revision on BRANCH."
989 nil t)
998 "Compute the master file's idea of the state of FILE.
999 If a WORKING-REVISION is given, compute the state of that version,
1000 otherwise determine the workfile version based on the master file.
1001 This function sets the properties `vc-working-revision' and
1002 `vc-checkout-model' to their correct values, based on the master
1003 file."
1013 ;; Workfile version not known yet. Determine that first. It
1014 ;; is either the head of the trunk, the head of the default
1015 ;; branch, or the "default branch" itself, if that is a full
1016 ;; revision number.
1018 ;; no default branch
1023 ;; default branch is actually a revision
1025 default-branch)
1027 ;; else, search for the head of the default branch
1033 ;; Check strict locking
1038 ;; Compute state of workfile version
1046 ;; not locked
1050 ;; workfile version is latest on branch
1051 'up-to-date
1052 ;; workfile version is not latest on branch
1054 ;; locked by the calling user
1057 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1059 workfile-is-latest
1061 'edited
1062 ;; Locking is not used for the file, but the owner does
1063 ;; have a lock, and there is a higher version on the current
1064 ;; branch. Not sure if this can occur, and if it is right
1065 ;; to use `needs-merge' in this case.
1067 ;; locked by somebody else
1069 locking-user)
1074 "Search for RCS headers in FILE, and set properties accordingly.
1076 Returns: nil if no headers were found
1077 'rev if a workfile revision was found
1078 'rev-and-lock if revision and lock info was found"
1086 ;; search for $Id or $Header
1087 ;; -------------------------
1088 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1095 ;; if found, store the revision number ...
1097 ;; ... and check for the locking state
1105 ;; unlocked revision
1107 ;;(setq locking-user 'none)
1109 ;; revision is locked by some user
1111 ;;(setq locking-user (match-string-no-properties 1))
1113 ;; everything else: false
1115 ;; unexpected information in
1116 ;; keyword string --> quit
1118 ;; search for $Revision
1119 ;; --------------------
1122 nil t)
1123 ;; if found, store the revision number ...
1125 ;; and see if there's any lock information
1129 ;;(setq locking-user (match-string-no-properties 1))
1132 ;;(setq locking-user 'none)
1135 ;;(setq locking-user 'none)
1138 ;; else: nothing found
1139 ;; -------------------
1142 status))))
1145 "Compare release numbers, represented as strings.
1146 Release components are assumed cardinal numbers, not decimal fractions
1147 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1148 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1149 of the string is found, or a non-numeric component shows up \(5.6.7 is
1151 some cases\). This code is suitable for existing RCS release numbers.
1152 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1173 "Return t if we have RELEASE or better."
1180 "Return the RCS release installed on this system, as a string.
1181 Return symbol `unknown' if the release cannot be deducted. The user can
1182 override this using variable `vc-rcs-release'.
1184 If the user has not set variable `vc-rcs-release' and it is nil,
1185 variable `vc-rcs-release' is set to the returned value."
1203 "Parse current buffer, presumed to be in RCS-style masterfile format.
1204 Optional arg BUFFER specifies another buffer to parse. Return an alist
1205 of two elements, w/ keys `headers' and `revisions' and values in turn
1206 sub-alists. For `headers', the values unless otherwise specified are
1207 strings and the keys are:
1209 desc -- description
1210 head -- latest revision
1212 absent if the head revision lies on the trunk
1213 access -- ???
1214 symbols -- sub-alist of (SYMBOL . REVISION) elements
1218 expand -- may be absent; ???
1220 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1221 with string values (unless otherwise specified) and keys:
1223 date -- a time value (like that returned by `encode-time'); as a
1224 special case, a year value less than 100 is augmented by 1900
1225 author -- username
1227 branches -- list of revisions that begin branches from this revision
1230 log -- change log entry
1231 text -- for the head revision on the trunk, the body of the file;
1232 other revisions have `:insn' instead
1233 :insn -- for non-head revisions, a list of parsed instructions
1236 - `(START k COUNT)' -- kill COUNT lines
1237 - `(START i TEXT)' -- insert TEXT (a string)
1238 The list is in descending order by START.
1240 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1243 ;; An RCS masterfile can be viewed as containing four regular (for the
1244 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1245 ;; the "description" and (d) the "rev bodies", in that order. In the
1246 ;; returned alist (see docstring), elements from (b) and (d) are
1247 ;; combined pairwise to form the "revisions", while those from (a) and
1248 ;; (c) are simply combined to form the "headers".
1249 ;;
1250 ;; Loosely speaking, each section contains a series of alternating
1251 ;; "tags" and "printed representations". In the (b) and (d), many
1252 ;; such series can appear, and a revision number on a line by itself
1253 ;; precedes the series of tags and printed representations associated
1254 ;; with it.
1255 ;;
1256 ;; In (a) and (b), the printed representations (with the exception of
1257 ;; the `comment' tag in the headers) terminate with a semicolon, which
1258 ;; is NOT part of the "value" finally associated with the tag. All
1259 ;; other printed representations are in "@@-format"; there is an "@",
1260 ;; the middle part (to be translated into the value), another "@" and
1261 ;; a newline. Each "@@" in the middle part indicates the position of
1262 ;; a single "@" (and consequently the requirement of an additional
1263 ;; initial step when translating to the value).
1264 ;;
1265 ;; Parser state includes vars that collect parts of the return value...
1267 ;; ... as well as vars that support a single-pass, tag-assisted,
1268 ;; minimal-data-copying scan. Basically -- skirting around the
1269 ;; grouping by revision required in (b) and (d) -- we repeatedly
1270 ;; and context-sensitively read a tag (that MUST be present),
1271 ;; determine the bounds of the printed representation, translate
1272 ;; it into a value, and push the tag plus value onto one of the
1273 ;; collection vars. Finally, we return the parse tree
1274 ;; incorporating the values of the collection vars (see "rv").
1275 ;;
1276 ;; A symbol or string to keep track of context (for error messages).
1277 context
1278 ;; A symbol, the current tag.
1279 tok
1280 ;; Region (begin and end buffer positions) of the printed
1281 ;; representation for the current tag.
1282 b e
1283 ;; A list of buffer positions where "@@" can be found within the
1284 ;; printed representation region. For each location, we push two
1285 ;; elements onto the list, 1+ and 2+ the location, respectively,
1286 ;; with the 2+ appearing at the head. In this way, the expression
1287 ;; `(,e ,@@-holes ,b)
1288 ;; describes regions that can be concatenated (in reverse order)
1289 ;; to "de-@@-format" the printed representation as the first step
1290 ;; to translating it into some value. See internal func `gather'.
1320 acc)
1324 acc)
1332 ;; headers
1346 two))
1352 t))
1353 headers)
1361 ;; rev headers
1370 b e)
1372 ;; Hack the year -- verified to be the
1373 ;; same algorithm used in RCS 5.7.
1383 revs)
1386 ;; desc
1389 ;; rev bodies
1391 ;; Element of `revs' that initially holds only header info.
1392 ;; "Pairwise combination" occurs when we add body info.
1393 rev
1394 ;; Components of the editing commands (aside from the actual
1395 ;; text) that comprise the `text' printed representations
1396 ;; (not including the "head" revision).
1397 cmd start act
1398 ;; Ascending (reversed) `@-holes' which the internal func
1399 ;; `incg' pops to effect incremental gathering.
1400 asc
1401 ;; Function to extract text (for the `a' command), either
1402 ;; `incg' or `buffer-substring-no-properties'. (This is
1403 ;; for speed; strictly speaking, it is sufficient to use
1404 ;; only the former since it behaves identically to the
1405 ;; latter in the absence of "@@".)
1406 sub)
1412 ;; Self-deprecate when work is done.
1413 ;; Folding many dimensions into one.
1414 ;; Thanks B.Mandelbrot, for complex sum.
1415 ;; O beauteous math! --the Unvexed Bum
1424 context))))
1426 ;; For rev body `text' tags, delay translation slightly...
1428 ;; ... until we decide which tag and value is appropriate to
1429 ;; collect. For the "head" revision, compute the value of the
1430 ;; `text' printed representation by simple `gather'. For all
1431 ;; other revisions, replace the `text' tag+value with `:insn'
1432 ;; plus value, always scanning in-place.
1448 (?d
1449 ;; `d' means "delete lines".
1450 ;; For Emacs spirit, we use `k' for "kill".
1452 (?a
1453 ;; `a' means "append after this line" but
1454 ;; internally we normalize it so that START
1455 ;; specifies the actual line for insert, thus
1456 ;; requiring less hair in the realization algs.
1457 ;; For Emacs spirit, we use `i' for "insert".
1462 cmd context)))
1463 acc))
1466 ;; rv
1472 ;;; vc-rcs.el ends here