| blob | 0b839a622e1282db3d1681912138544273306be4 |
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
159 "State heuristic for RCS."
166 ;; If the headers say that the file is not locked, the
167 ;; permissions can tell us whether locking is used for
168 ;; the file or not.
177 'edited
181 state)
192 'edited
193 owner-name)
195 'edited
198 ;; Strange permissions. Fall through to
199 ;; expensive state computation.
206 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
207 ;; should be changed to take a backend parameter. Using
208 ;; `vc-expand-dirs' is not TRTD because it returns files from
209 ;; multiple backends. It should also return 'unregistered files.
211 ;; Doing individual vc-state calls is painful but there
212 ;; is no better way in RCS-land.
224 "RCS-specific version of `vc-working-revision'."
233 "Return non-nil if workfile version of FILE is the latest on its branch.
234 When VERSION is given, perform check for that version."
240 ;; Compare VERSION to the head version number.
243 ;; If we are not on the trunk, we need to examine the
244 ;; whole current branch.
249 "RCS-specific implementation of `vc-workfile-unchanged-p'."
250 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
251 ;; do a double take and remember the fact for the future
262 ;; The workfile is unchanged if rcsdiff found no differences.
265 \f
266 ;;;
267 ;;; State-changing functions
268 ;;;
271 "Create a new RCS repository."
272 ;; RCS is totally file-oriented, so all we have to do is make the directory.
278 "Register FILES into the RCS version-control system.
279 REV is the optional revision number for the files. COMMENT can be used
280 to provide an initial description for each FILES.
281 Passes either `vc-rcs-register-switches' or `vc-register-switches'
282 to the RCS command.
284 Automatically retrieve a read-only version of the file with keywords
285 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
287 ;; When REV is specified, we need to force using "-t-".
298 ;; if available, use the secure registering option
303 ;; parse output to find master file name and workfile version
310 ;; if we couldn't find the master name,
311 ;; run vc-rcs-registered to get it
312 ;; (will be stored into the vc-master-name property)
316 name
318 name
323 nil t)
327 "Return non-nil if RCS thinks it would be responsible for registering FILE."
328 ;; TODO: check for all the patterns in vc-rcs-master-templates
331 file
335 "Implementation of receive-file for RCS."
343 "Unregister FILE from RCS.
344 If this leaves the RCS subdirectory empty, ask the user
345 whether to remove it."
354 ;; check whether RCS dir is empty, i.e. it does not
355 ;; contain any files except "." and ".."
361 ;; It used to be possible to pass in a value for the variable rev, but
362 ;; nothing in the rest of VC used this capability. Removing it makes the
363 ;; backend interface simpler for all modes.
364 ;;
366 "RCS-specific version of `vc-backend-checkin'."
368 ;; Now operate on the files
372 ;; Force branch creation if an appropriate
373 ;; default branch has been set.
376 default-branch)
383 ;; if available, use the secure check-in option
387 switches)
390 ;; determine the new workfile version
400 ;; if we got to a different branch, adjust the default
401 ;; branch accordingly
409 ;; If this is an old (pre-1992!) RCS release, we might have
410 ;; to remove a remaining lock.
412 ;; exit status of 1 is also accepted.
413 ;; It means that the lock was removed before.
425 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
426 attempt the checkout for all registered files beneath it."
430 switches)
433 ;; Change buffers to get local value of vc-checkout-switches.
436 ;; Save this buffer's default-directory
437 ;; and use save-excursion to make sure it is restored
438 ;; in the same buffer it was saved in.
441 ;; Adjust the default-directory so that the check-out creates
442 ;; the file in the right place.
445 ;; if we should go to the head of the trunk,
446 ;; clear the default branch first
449 ;; now do the checkout
452 ;; If locking is not strict, force to overwrite
453 ;; the writable workfile.
455 "-l"
457 ;; a literal revision was specified
463 ;; no revision specified:
464 ;; use current workfile version
465 workrev
466 ;; REV is t ...
468 ;; ... go to head of current branch
470 ;; ... go to head of trunk
472 nil)
474 switches)
475 ;; determine the new workfile version
480 ;; if necessary, adjust the default branch
483 file
487 new-version)))))
491 "Roll back, undoing the most recent checkins of FILES. Directories are
492 expanded to all registered subfiles in them."
501 discard file)))
505 ;; Check out the most recent remaining version. If it
506 ;; fails, because the whole branch got deleted, do a
507 ;; double-take and check out the version where the branch
508 ;; started.
520 ;; vc-do-command popped up a window with
521 ;; the error message. Get rid of it, by
522 ;; restoring the old window configuration.
524 ;; No, it was some other error: re-signal it.
528 "Revert FILE to the version it was based on. If FILE is a directory,
529 revert all registered files beneath it."
537 "Merge changes into current working copy of FILE.
538 The changes are between FIRST-VERSION and SECOND-VERSION."
545 "Steal the lock on the current workfile for FILE and revision REV.
546 If FILE is a directory, steal the lock on all registered files beneath it.
547 Needs RCS 5.6.2 or later for -M."
551 ;; Do a real checkout after stealing the lock, so that we see
552 ;; expanded headers.
556 "Modify the change comments change on FILES on a specified REV. If FILE is a
557 directory the operation is applied to all registered files beneath it."
562 \f
563 ;;;
564 ;;; History functions
565 ;;;
579 _start-revision-ignored limit)
580 "Print commit log associated with FILES into specified BUFFER.
581 Remaining arguments are ignored.
582 If FILE is a directory the operation is applied to all registered
583 files beneath it."
591 "Get a difference report using RCS between two sets of files."
601 "Return the administrative directory of FILE."
605 "Return a string with all log entries stored in BACKEND for FILE."
607 ;; Has to be written this way, this function is used by the CVS backend too
609 ;; Remove cruft
625 ;; Return the de-crufted comment list
629 "Annotate FILE, inserting the results in BUFFER.
630 Optional arg REVISION is a revision to annotate from."
632 ;; Aside from the "head revision on the trunk", the instructions for
633 ;; each revision on the trunk are an ordered list of kill and insert
634 ;; commands necessary to go from the chronologically-following
635 ;; revision to this one. That is, associated with revision N are
636 ;; edits that applied to revision N+1 would result in revision N.
637 ;;
638 ;; On a branch, however, (some) things are inverted: the commands
639 ;; listed are those necessary to go from the chronologically-preceding
640 ;; revision to this one. That is, associated with revision N are
641 ;; edits that applied to revision N-1 would result in revision N.
642 ;;
643 ;; So, to get per-line history info, we apply reverse-chronological
644 ;; edits, starting with the head revision on the trunk, all the way
645 ;; back through the initial revision (typically "1.1" or similar),
646 ;; then apply forward-chronological edits -- keeping track of which
647 ;; revision is associated with each inserted line -- until we reach
648 ;; the desired revision for display (which may be either on the trunk
649 ;; or on a branch).
654 ;; The revision N whose instructions we currently are processing.
656 ;; Alist from the parse tree for N.
658 ;; Point and temporary string, respectively.
659 p s
660 ;; "Next-branch list". Nil means the desired revision to
661 ;; display lives on the trunk. Non-nil means it lives on a
662 ;; branch, in which case the value is a list of revision pairs
663 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
664 ;; links each series of revisions in the path from the initial
665 ;; revision to the desired revision to display.
666 nbls
667 ;; "Path-accumulate-predicate plus revision/date/author".
668 ;; Until set, forward-chronological edits are not accumulated.
669 ;; Once set, its value (updated every revision) is used for
670 ;; the text property `:vc-rcs-r/d/a' for inserts during
671 ;; processing of forward-chronological instructions for N.
672 ;; See internal func `r/d/a'.
673 prda
674 ;; List of forward-chronological instructions, each of the
675 ;; form: (POS . ACTION), where POS is a buffer position. If
676 ;; ACTION is a string, it is inserted, otherwise it is taken as
677 ;; the number of characters to be deleted.
678 path
679 ;; N+1. When `cur' is "", this is the initial revision.
680 pre)
685 ;; Find which branches (if any) must be included in the edits.
687 bpt kids)
691 ;; A branchpoint may have multiple children. Find the right one.
695 ;; Start with the full text.
698 ;; Apply reverse-chronological edits on the trunk, computing and
699 ;; accumulating forward-chronological edits after some point, for
700 ;; later.
707 ;; Start accumulating the forward-chronological edits when N+1
708 ;; on the trunk is either the desired revision to display, or
709 ;; the appropriate branchpoint for it. Do this before
710 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
714 ;; Edits in the parse tree specify a line number (in the buffer
715 ;; *BEFORE* editing occurs) to start from, but line numbers
716 ;; change as a result of edits. To DTRT, we apply edits in
717 ;; order of descending buffer position so that edits further
718 ;; down in the buffer occur first w/o corrupting specified
719 ;; buffer positions of edits occurring towards the beginning of
720 ;; the buffer. In this way we avoid using markers. A pleasant
721 ;; property of this approach is ability to push instructions
722 ;; onto `path' directly, w/o need to maintain rev boundaries.
738 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
739 ;; equivalent to pushing an insert instruction (of the entire buffer
740 ;; contents) onto `path' then erasing the buffer, but less wasteful.
742 ;; Now apply the forward-chronological edits for the trunk.
748 ;; Now apply the forward-chronological edits (directly from the
749 ;; parse-tree) for the branch(es), if necessary. We re-use vars
750 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
755 prda nil)
769 ;; Lastly, for each line, insert at bol nicely-formatted history info.
770 ;; We do two passes to collect summary information used to minimize
771 ;; the annotation's usage of screen real-estate: (1) Consider rendered
772 ;; width of revision plus author together as a unit; and (2) Omit
773 ;; author entirely if all authors are the same as the user.
778 rda w a)
788 ht)
796 " "
798 ls)
799 :vc-annotate-prefix t
807 ht)))
815 "Return the current time, based at midnight of the current day, and
816 encoded as fractional days."
821 "Return the time of the next annotation (as fraction of days)
822 systime, or nil if there is none. Also, reposition point."
831 \f
832 ;;;
833 ;;; Tag system
834 ;;;
846 dir
850 \f
851 ;;;
852 ;;; Miscellaneous
853 ;;;
856 "Return t if REV is a revision on the trunk."
860 "Return the minor revision number of a revision number REV."
865 "Return the revision number immediately preceding REV for FILE,
866 or nil if there is no previous revision. This default
867 implementation works for MAJOR.MINOR-style revision numbers as
868 used by RCS and CVS."
873 ;; revision does probably not start a branch or release
876 ;; we are at the beginning of the trunk --
877 ;; don't know anything to return here
878 nil
879 ;; we are at the beginning of a branch --
880 ;; return revision of starting point
884 "Return the revision number immediately following REV for FILE,
885 or nil if there is no next revision. This default implementation
886 works for MAJOR.MINOR-style revision numbers as used by RCS
887 and CVS."
893 ;; You might think that this should be distributed with RCS, but
894 ;; apparently not. CVS sometimes provides a version of it.
895 ;; http://lists.gnu.org/archive/html/emacs-devel/2014-05/msg00288.html
900 exe)
901 ;; In the unlikely event that someone is running an
902 ;; uninstalled Emacs and wants to do something RCS-related.
905 exe)
912 "Default implementation of update-changelog.
913 Uses `rcs2log' which only works for RCS and CVS."
914 ;; FIXME: We (c|sh)ould add support for cvs2cl
917 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
921 temporary-file-directory))))
929 user-mail-address)))
943 "-c" changelog
951 files)))
952 "done"
961 "Check if the current file has any headers in it."
968 "Implementation of vc-clear-headers for RCS."
974 nil t)
980 ;; Just move the master file (using vc-rcs-master-templates).
984 ;; If the file is locked by some other user, make
985 ;; the buffer read-only. Like this, even root
986 ;; cannot modify a file that someone else has locked.
990 \f
991 ;;;
992 ;;; Internal functions
993 ;;;
996 "Return non-nil if FILE is newer than its RCS master.
997 This likely means that FILE has been changed with respect
998 to its master version."
1006 "Find most recent revision on BRANCH."
1011 nil t)
1020 "Compute the master file's idea of the state of FILE.
1021 If a WORKING-REVISION is given, compute the state of that version,
1022 otherwise determine the workfile version based on the master file.
1023 This function sets the properties `vc-working-revision' and
1024 `vc-checkout-model' to their correct values, based on the master
1025 file."
1035 ;; Workfile version not known yet. Determine that first. It
1036 ;; is either the head of the trunk, the head of the default
1037 ;; branch, or the "default branch" itself, if that is a full
1038 ;; revision number.
1040 ;; no default branch
1045 ;; default branch is actually a revision
1047 default-branch)
1049 ;; else, search for the head of the default branch
1055 ;; Check strict locking
1060 ;; Compute state of workfile version
1068 ;; not locked
1072 ;; workfile version is latest on branch
1073 'up-to-date
1074 ;; workfile version is not latest on branch
1076 ;; locked by the calling user
1079 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1081 workfile-is-latest
1083 'edited
1084 ;; Locking is not used for the file, but the owner does
1085 ;; have a lock, and there is a higher version on the current
1086 ;; branch. Not sure if this can occur, and if it is right
1087 ;; to use `needs-merge' in this case.
1089 ;; locked by somebody else
1091 locking-user)
1096 "Search for RCS headers in FILE, and set properties accordingly.
1098 Returns: nil if no headers were found
1099 'rev if a workfile revision was found
1100 'rev-and-lock if revision and lock info was found"
1108 ;; search for $Id or $Header
1109 ;; -------------------------
1110 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1117 ;; if found, store the revision number ...
1119 ;; ... and check for the locking state
1127 ;; unlocked revision
1131 ;; revision is locked by some user
1135 ;; everything else: false
1137 ;; unexpected information in
1138 ;; keyword string --> quit
1140 ;; search for $Revision
1141 ;; --------------------
1144 nil t)
1145 ;; if found, store the revision number ...
1147 ;; and see if there's any lock information
1160 ;; else: nothing found
1161 ;; -------------------
1171 ;; If the file has headers, we don't want to query the
1172 ;; master file, because that would eliminate all the
1173 ;; performance gain the headers brought us. We therefore
1174 ;; use a heuristic now to find out whether locking is used
1175 ;; for this file. If we trust the file permissions, and the
1176 ;; file is not locked, then if the file is read-only we
1177 ;; assume that locking is used for the file, otherwise
1178 ;; locking is not used.
1184 status))))
1187 "Compare release numbers, represented as strings.
1188 Release components are assumed cardinal numbers, not decimal fractions
1189 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1190 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1191 of the string is found, or a non-numeric component shows up \(5.6.7 is
1193 some cases\). This code is suitable for existing RCS release numbers.
1194 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1215 "Return t if we have RELEASE or better."
1222 "Return the RCS release installed on this system, as a string.
1223 Return symbol `unknown' if the release cannot be deducted. The user can
1224 override this using variable `vc-rcs-release'.
1226 If the user has not set variable `vc-rcs-release' and it is nil,
1227 variable `vc-rcs-release' is set to the returned value."
1245 "Parse current buffer, presumed to be in RCS-style masterfile format.
1246 Optional arg BUFFER specifies another buffer to parse. Return an alist
1247 of two elements, w/ keys `headers' and `revisions' and values in turn
1248 sub-alists. For `headers', the values unless otherwise specified are
1249 strings and the keys are:
1251 desc -- description
1252 head -- latest revision
1254 absent if the head revision lies on the trunk
1255 access -- ???
1256 symbols -- sub-alist of (SYMBOL . REVISION) elements
1260 expand -- may be absent; ???
1262 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1263 with string values (unless otherwise specified) and keys:
1265 date -- a time value (like that returned by `encode-time'); as a
1266 special case, a year value less than 100 is augmented by 1900
1267 author -- username
1269 branches -- list of revisions that begin branches from this revision
1272 log -- change log entry
1273 text -- for the head revision on the trunk, the body of the file;
1274 other revisions have `:insn' instead
1275 :insn -- for non-head revisions, a list of parsed instructions
1278 - `(START k COUNT)' -- kill COUNT lines
1279 - `(START i TEXT)' -- insert TEXT (a string)
1280 The list is in descending order by START.
1282 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1285 ;; An RCS masterfile can be viewed as containing four regular (for the
1286 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1287 ;; the "description" and (d) the "rev bodies", in that order. In the
1288 ;; returned alist (see docstring), elements from (b) and (d) are
1289 ;; combined pairwise to form the "revisions", while those from (a) and
1290 ;; (c) are simply combined to form the "headers".
1291 ;;
1292 ;; Loosely speaking, each section contains a series of alternating
1293 ;; "tags" and "printed representations". In the (b) and (d), many
1294 ;; such series can appear, and a revision number on a line by itself
1295 ;; precedes the series of tags and printed representations associated
1296 ;; with it.
1297 ;;
1298 ;; In (a) and (b), the printed representations (with the exception of
1299 ;; the `comment' tag in the headers) terminate with a semicolon, which
1300 ;; is NOT part of the "value" finally associated with the tag. All
1301 ;; other printed representations are in "@@-format"; there is an "@",
1302 ;; the middle part (to be translated into the value), another "@" and
1303 ;; a newline. Each "@@" in the middle part indicates the position of
1304 ;; a single "@" (and consequently the requirement of an additional
1305 ;; initial step when translating to the value).
1306 ;;
1307 ;; Parser state includes vars that collect parts of the return value...
1309 ;; ... as well as vars that support a single-pass, tag-assisted,
1310 ;; minimal-data-copying scan. Basically -- skirting around the
1311 ;; grouping by revision required in (b) and (d) -- we repeatedly
1312 ;; and context-sensitively read a tag (that MUST be present),
1313 ;; determine the bounds of the printed representation, translate
1314 ;; it into a value, and push the tag plus value onto one of the
1315 ;; collection vars. Finally, we return the parse tree
1316 ;; incorporating the values of the collection vars (see "rv").
1317 ;;
1318 ;; A symbol or string to keep track of context (for error messages).
1319 context
1320 ;; A symbol, the current tag.
1321 tok
1322 ;; Region (begin and end buffer positions) of the printed
1323 ;; representation for the current tag.
1324 b e
1325 ;; A list of buffer positions where "@@" can be found within the
1326 ;; printed representation region. For each location, we push two
1327 ;; elements onto the list, 1+ and 2+ the location, respectively,
1328 ;; with the 2+ appearing at the head. In this way, the expression
1329 ;; `(,e ,@@-holes ,b)
1330 ;; describes regions that can be concatenated (in reverse order)
1331 ;; to "de-@@-format" the printed representation as the first step
1332 ;; to translating it into some value. See internal func `gather'.
1362 acc)
1366 acc)
1374 ;; headers
1388 two))
1394 t))
1395 headers)
1403 ;; rev headers
1412 b e)
1414 ;; Hack the year -- verified to be the
1415 ;; same algorithm used in RCS 5.7.
1425 revs)
1428 ;; desc
1431 ;; rev bodies
1433 ;; Element of `revs' that initially holds only header info.
1434 ;; "Pairwise combination" occurs when we add body info.
1435 rev
1436 ;; Components of the editing commands (aside from the actual
1437 ;; text) that comprise the `text' printed representations
1438 ;; (not including the "head" revision).
1439 cmd start act
1440 ;; Ascending (reversed) `@-holes' which the internal func
1441 ;; `incg' pops to effect incremental gathering.
1442 asc
1443 ;; Function to extract text (for the `a' command), either
1444 ;; `incg' or `buffer-substring-no-properties'. (This is
1445 ;; for speed; strictly speaking, it is sufficient to use
1446 ;; only the former since it behaves identically to the
1447 ;; latter in the absence of "@@".)
1448 sub)
1454 ;; Self-deprecate when work is done.
1455 ;; Folding many dimensions into one.
1456 ;; Thanks B.Mandelbrot, for complex sum.
1457 ;; O beauteous math! --the Unvexed Bum
1466 context))))
1468 ;; For rev body `text' tags, delay translation slightly...
1470 ;; ... until we decide which tag and value is appropriate to
1471 ;; collect. For the "head" revision, compute the value of the
1472 ;; `text' printed representation by simple `gather'. For all
1473 ;; other revisions, replace the `text' tag+value with `:insn'
1474 ;; plus value, always scanning in-place.
1490 (?d
1491 ;; `d' means "delete lines".
1492 ;; For Emacs spirit, we use `k' for "kill".
1494 (?a
1495 ;; `a' means "append after this line" but
1496 ;; internally we normalize it so that START
1497 ;; specifies the actual line for insert, thus
1498 ;; requiring less hair in the realization algs.
1499 ;; For Emacs spirit, we use `i' for "insert".
1504 cmd context)))
1505 acc))
1508 ;; rv
1514 ;;; vc-rcs.el ends here