| blob | 40d8acb7e0721d84898f2c439bd2e1a8898763e9 |
1 ;;; vc-rcs.el --- support for RCS version-control
3 ;; Copyright (C) 1992-2013 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.
204 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
205 ;; should be changed to take a backend parameter. Using
206 ;; `vc-expand-dirs' is not TRTD because it returns files from
207 ;; multiple backends. It should also return 'unregistered files.
209 ;; Doing individual vc-state calls is painful but there
210 ;; is no better way in RCS-land.
222 "RCS-specific version of `vc-working-revision'."
231 "Return non-nil if workfile version of FILE is the latest on its branch.
232 When VERSION is given, perform check for that version."
238 ;; Compare VERSION to the head version number.
241 ;; If we are not on the trunk, we need to examine the
242 ;; whole current branch.
247 "RCS-specific implementation of `vc-workfile-unchanged-p'."
248 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
249 ;; do a double take and remember the fact for the future
260 ;; The workfile is unchanged if rcsdiff found no differences.
263 \f
264 ;;;
265 ;;; State-changing functions
266 ;;;
269 "Create a new RCS repository."
270 ;; RCS is totally file-oriented, so all we have to do is make the directory.
274 "Register FILES into the RCS version-control system.
275 REV is the optional revision number for the files. COMMENT can be used
276 to provide an initial description for each FILES.
277 Passes either `vc-rcs-register-switches' or `vc-register-switches'
278 to the RCS command.
280 Automatically retrieve a read-only version of the file with keywords
281 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
283 ;; When REV is specified, we need to force using "-t-".
294 ;; if available, use the secure registering option
299 ;; parse output to find master file name and workfile version
306 ;; if we couldn't find the master name,
307 ;; run vc-rcs-registered to get it
308 ;; (will be stored into the vc-name property)
312 name
314 name
319 nil t)
323 "Return non-nil if RCS thinks it would be responsible for registering FILE."
324 ;; TODO: check for all the patterns in vc-rcs-master-templates
327 file
331 "Implementation of receive-file for RCS."
339 "Unregister FILE from RCS.
340 If this leaves the RCS subdirectory empty, ask the user
341 whether to remove it."
350 ;; check whether RCS dir is empty, i.e. it does not
351 ;; contain any files except "." and ".."
358 "RCS-specific version of `vc-backend-checkin'."
360 ;; Now operate on the files
364 ;; Force branch creation if an appropriate
365 ;; default branch has been set.
367 default-branch
369 default-branch)
375 ;; if available, use the secure check-in option
379 switches)
382 ;; determine the new workfile version
392 ;; if we got to a different branch, adjust the default
393 ;; branch accordingly
401 ;; If this is an old (pre-1992!) RCS release, we might have
402 ;; to remove a remaining lock.
404 ;; exit status of 1 is also accepted.
405 ;; It means that the lock was removed before.
417 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
418 attempt the checkout for all registered files beneath it."
422 switches)
425 ;; Change buffers to get local value of vc-checkout-switches.
428 ;; Save this buffer's default-directory
429 ;; and use save-excursion to make sure it is restored
430 ;; in the same buffer it was saved in.
433 ;; Adjust the default-directory so that the check-out creates
434 ;; the file in the right place.
437 ;; if we should go to the head of the trunk,
438 ;; clear the default branch first
441 ;; now do the checkout
444 ;; If locking is not strict, force to overwrite
445 ;; the writable workfile.
449 ;; a literal revision was specified
455 ;; no revision specified:
456 ;; use current workfile version
457 workrev
458 ;; REV is t ...
460 ;; ... go to head of current branch
462 ;; ... go to head of trunk
464 nil)
466 switches)
467 ;; determine the new workfile version
472 ;; if necessary, adjust the default branch
475 file
479 new-version)))))
483 "Roll back, undoing the most recent checkins of FILES. Directories are
484 expanded to all registered subfiles in them."
493 discard file)))
497 ;; Check out the most recent remaining version. If it
498 ;; fails, because the whole branch got deleted, do a
499 ;; double-take and check out the version where the branch
500 ;; started.
512 ;; vc-do-command popped up a window with
513 ;; the error message. Get rid of it, by
514 ;; restoring the old window configuration.
516 ;; No, it was some other error: re-signal it.
520 "Revert FILE to the version it was based on. If FILE is a directory,
521 revert all registered files beneath it."
529 "Merge changes into current working copy of FILE.
530 The changes are between FIRST-VERSION and SECOND-VERSION."
537 "Steal the lock on the current workfile for FILE and revision REV.
538 If FILE is a directory, steal the lock on all registered files beneath it.
539 Needs RCS 5.6.2 or later for -M."
543 ;; Do a real checkout after stealing the lock, so that we see
544 ;; expanded headers.
548 "Modify the change comments change on FILES on a specified REV. If FILE is a
549 directory the operation is applied to all registered files beneath it."
554 \f
555 ;;;
556 ;;; History functions
557 ;;;
571 "Get change log associated with FILE. If FILE is a
572 directory the operation is applied to all registered files beneath it."
579 "Get a difference report using RCS between two sets of files."
589 "Return a string with all log entries stored in BACKEND for FILE."
591 ;; Has to be written this way, this function is used by the CVS backend too
593 ;; Remove cruft
609 ;; Return the de-crufted comment list
613 "Annotate FILE, inserting the results in BUFFER.
614 Optional arg REVISION is a revision to annotate from."
616 ;; Aside from the "head revision on the trunk", the instructions for
617 ;; each revision on the trunk are an ordered list of kill and insert
618 ;; commands necessary to go from the chronologically-following
619 ;; revision to this one. That is, associated with revision N are
620 ;; edits that applied to revision N+1 would result in revision N.
621 ;;
622 ;; On a branch, however, (some) things are inverted: the commands
623 ;; listed are those necessary to go from the chronologically-preceding
624 ;; revision to this one. That is, associated with revision N are
625 ;; edits that applied to revision N-1 would result in revision N.
626 ;;
627 ;; So, to get per-line history info, we apply reverse-chronological
628 ;; edits, starting with the head revision on the trunk, all the way
629 ;; back through the initial revision (typically "1.1" or similar),
630 ;; then apply forward-chronological edits -- keeping track of which
631 ;; revision is associated with each inserted line -- until we reach
632 ;; the desired revision for display (which may be either on the trunk
633 ;; or on a branch).
638 ;; The revision N whose instructions we currently are processing.
640 ;; Alist from the parse tree for N.
642 ;; Point and temporary string, respectively.
643 p s
644 ;; "Next-branch list". Nil means the desired revision to
645 ;; display lives on the trunk. Non-nil means it lives on a
646 ;; branch, in which case the value is a list of revision pairs
647 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
648 ;; links each series of revisions in the path from the initial
649 ;; revision to the desired revision to display.
650 nbls
651 ;; "Path-accumulate-predicate plus revision/date/author".
652 ;; Until set, forward-chronological edits are not accumulated.
653 ;; Once set, its value (updated every revision) is used for
654 ;; the text property `:vc-rcs-r/d/a' for inserts during
655 ;; processing of forward-chronological instructions for N.
656 ;; See internal func `r/d/a'.
657 prda
658 ;; List of forward-chronological instructions, each of the
659 ;; form: (POS . ACTION), where POS is a buffer position. If
660 ;; ACTION is a string, it is inserted, otherwise it is taken as
661 ;; the number of characters to be deleted.
662 path
663 ;; N+1. When `cur' is "", this is the initial revision.
664 pre)
669 ;; Find which branches (if any) must be included in the edits.
671 bpt kids)
675 ;; A branchpoint may have multiple children. Find the right one.
679 ;; Start with the full text.
682 ;; Apply reverse-chronological edits on the trunk, computing and
683 ;; accumulating forward-chronological edits after some point, for
684 ;; later.
691 ;; Start accumulating the forward-chronological edits when N+1
692 ;; on the trunk is either the desired revision to display, or
693 ;; the appropriate branchpoint for it. Do this before
694 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
698 ;; Edits in the parse tree specify a line number (in the buffer
699 ;; *BEFORE* editing occurs) to start from, but line numbers
700 ;; change as a result of edits. To DTRT, we apply edits in
701 ;; order of descending buffer position so that edits further
702 ;; down in the buffer occur first w/o corrupting specified
703 ;; buffer positions of edits occurring towards the beginning of
704 ;; the buffer. In this way we avoid using markers. A pleasant
705 ;; property of this approach is ability to push instructions
706 ;; onto `path' directly, w/o need to maintain rev boundaries.
722 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
723 ;; equivalent to pushing an insert instruction (of the entire buffer
724 ;; contents) onto `path' then erasing the buffer, but less wasteful.
726 ;; Now apply the forward-chronological edits for the trunk.
732 ;; Now apply the forward-chronological edits (directly from the
733 ;; parse-tree) for the branch(es), if necessary. We re-use vars
734 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
739 prda nil)
753 ;; Lastly, for each line, insert at bol nicely-formatted history info.
754 ;; We do two passes to collect summary information used to minimize
755 ;; the annotation's usage of screen real-estate: (1) Consider rendered
756 ;; width of revision plus author together as a unit; and (2) Omit
757 ;; author entirely if all authors are the same as the user.
762 rda w a)
772 ht)
780 " "
782 ls)
783 :vc-annotate-prefix t
791 ht)))
799 "Return the current time, based at midnight of the current day, and
800 encoded as fractional days."
805 "Return the time of the next annotation (as fraction of days)
806 systime, or nil if there is none. Also, reposition point."
815 \f
816 ;;;
817 ;;; Tag system
818 ;;;
827 dir
831 \f
832 ;;;
833 ;;; Miscellaneous
834 ;;;
837 "Return t if REV is a revision on the trunk."
841 "Return the minor revision number of a revision number REV."
846 "Return the revision number immediately preceding REV for FILE,
847 or nil if there is no previous revision. This default
848 implementation works for MAJOR.MINOR-style revision numbers as
849 used by RCS and CVS."
854 ;; revision does probably not start a branch or release
857 ;; we are at the beginning of the trunk --
858 ;; don't know anything to return here
859 nil
860 ;; we are at the beginning of a branch --
861 ;; return revision of starting point
865 "Return the revision number immediately following REV for FILE,
866 or nil if there is no next revision. This default implementation
867 works for MAJOR.MINOR-style revision numbers as used by RCS
868 and CVS."
874 ;; Note that most GNU/Linux distributions seem to supply rcs2log in a
875 ;; standard bin directory. Eg both Red Hat and Debian include it in
876 ;; their cvs packages. It's not obvious why Emacs still needs to
877 ;; provide it as well...
882 exe)
883 ;; In the unlikely event that someone is running an
884 ;; uninstalled Emacs and wants to do something RCS-related.
887 exe)
892 "Default implementation of update-changelog.
893 Uses `rcs2log' which only works for RCS and CVS."
894 ;; FIXME: We (c|sh)ould add support for cvs2cl
897 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
901 temporary-file-directory))))
909 user-mail-address)))
923 "-c" changelog
931 files)))
932 "done"
941 "Check if the current file has any headers in it."
948 "Implementation of vc-clear-headers for RCS."
954 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
1109 ;; revision is locked by some user
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
1138 ;; else: nothing found
1139 ;; -------------------
1149 ;; If the file has headers, we don't want to query the
1150 ;; master file, because that would eliminate all the
1151 ;; performance gain the headers brought us. We therefore
1152 ;; use a heuristic now to find out whether locking is used
1153 ;; for this file. If we trust the file permissions, and the
1154 ;; file is not locked, then if the file is read-only we
1155 ;; assume that locking is used for the file, otherwise
1156 ;; locking is not used.
1162 status))))
1165 "Compare release numbers, represented as strings.
1166 Release components are assumed cardinal numbers, not decimal fractions
1167 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1168 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1169 of the string is found, or a non-numeric component shows up \(5.6.7 is
1171 some cases\). This code is suitable for existing RCS release numbers.
1172 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1193 "Return t if we have RELEASE or better."
1200 "Return the RCS release installed on this system, as a string.
1201 Return symbol `unknown' if the release cannot be deducted. The user can
1202 override this using variable `vc-rcs-release'.
1204 If the user has not set variable `vc-rcs-release' and it is nil,
1205 variable `vc-rcs-release' is set to the returned value."
1223 "Parse current buffer, presumed to be in RCS-style masterfile format.
1224 Optional arg BUFFER specifies another buffer to parse. Return an alist
1225 of two elements, w/ keys `headers' and `revisions' and values in turn
1226 sub-alists. For `headers', the values unless otherwise specified are
1227 strings and the keys are:
1229 desc -- description
1230 head -- latest revision
1232 absent if the head revision lies on the trunk
1233 access -- ???
1234 symbols -- sub-alist of (SYMBOL . REVISION) elements
1238 expand -- may be absent; ???
1240 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1241 with string values (unless otherwise specified) and keys:
1243 date -- a time value (like that returned by `encode-time'); as a
1244 special case, a year value less than 100 is augmented by 1900
1245 author -- username
1247 branches -- list of revisions that begin branches from this revision
1250 log -- change log entry
1251 text -- for the head revision on the trunk, the body of the file;
1252 other revisions have `:insn' instead
1253 :insn -- for non-head revisions, a list of parsed instructions
1256 - `(START k COUNT)' -- kill COUNT lines
1257 - `(START i TEXT)' -- insert TEXT (a string)
1258 The list is in descending order by START.
1260 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1263 ;; An RCS masterfile can be viewed as containing four regular (for the
1264 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1265 ;; the "description" and (d) the "rev bodies", in that order. In the
1266 ;; returned alist (see docstring), elements from (b) and (d) are
1267 ;; combined pairwise to form the "revisions", while those from (a) and
1268 ;; (c) are simply combined to form the "headers".
1269 ;;
1270 ;; Loosely speaking, each section contains a series of alternating
1271 ;; "tags" and "printed representations". In the (b) and (d), many
1272 ;; such series can appear, and a revision number on a line by itself
1273 ;; precedes the series of tags and printed representations associated
1274 ;; with it.
1275 ;;
1276 ;; In (a) and (b), the printed representations (with the exception of
1277 ;; the `comment' tag in the headers) terminate with a semicolon, which
1278 ;; is NOT part of the "value" finally associated with the tag. All
1279 ;; other printed representations are in "@@-format"; there is an "@",
1280 ;; the middle part (to be translated into the value), another "@" and
1281 ;; a newline. Each "@@" in the middle part indicates the position of
1282 ;; a single "@" (and consequently the requirement of an additional
1283 ;; initial step when translating to the value).
1284 ;;
1285 ;; Parser state includes vars that collect parts of the return value...
1287 ;; ... as well as vars that support a single-pass, tag-assisted,
1288 ;; minimal-data-copying scan. Basically -- skirting around the
1289 ;; grouping by revision required in (b) and (d) -- we repeatedly
1290 ;; and context-sensitively read a tag (that MUST be present),
1291 ;; determine the bounds of the printed representation, translate
1292 ;; it into a value, and push the tag plus value onto one of the
1293 ;; collection vars. Finally, we return the parse tree
1294 ;; incorporating the values of the collection vars (see "rv").
1295 ;;
1296 ;; A symbol or string to keep track of context (for error messages).
1297 context
1298 ;; A symbol, the current tag.
1299 tok
1300 ;; Region (begin and end buffer positions) of the printed
1301 ;; representation for the current tag.
1302 b e
1303 ;; A list of buffer positions where "@@" can be found within the
1304 ;; printed representation region. For each location, we push two
1305 ;; elements onto the list, 1+ and 2+ the location, respectively,
1306 ;; with the 2+ appearing at the head. In this way, the expression
1307 ;; `(,e ,@@-holes ,b)
1308 ;; describes regions that can be concatenated (in reverse order)
1309 ;; to "de-@@-format" the printed representation as the first step
1310 ;; to translating it into some value. See internal func `gather'.
1340 acc)
1344 acc)
1353 ;; headers
1367 two))
1373 t))
1374 headers)
1382 ;; rev headers
1391 b e)
1393 ;; Hack the year -- verified to be the
1394 ;; same algorithm used in RCS 5.7.
1404 revs)
1407 ;; desc
1410 ;; rev bodies
1412 ;; Element of `revs' that initially holds only header info.
1413 ;; "Pairwise combination" occurs when we add body info.
1414 rev
1415 ;; Components of the editing commands (aside from the actual
1416 ;; text) that comprise the `text' printed representations
1417 ;; (not including the "head" revision).
1418 cmd start act
1419 ;; Ascending (reversed) `@-holes' which the internal func
1420 ;; `incg' pops to effect incremental gathering.
1421 asc
1422 ;; Function to extract text (for the `a' command), either
1423 ;; `incg' or `buffer-substring-no-properties'. (This is
1424 ;; for speed; strictly speaking, it is sufficient to use
1425 ;; only the former since it behaves identically to the
1426 ;; latter in the absence of "@@".)
1427 sub)
1432 ;; Self-deprecate when work is done.
1433 ;; Folding many dimensions into one.
1434 ;; Thanks B.Mandelbrot, for complex sum.
1435 ;; O beauteous math! --the Unvexed Bum
1444 context))))
1446 ;; For rev body `text' tags, delay translation slightly...
1448 ;; ... until we decide which tag and value is appropriate to
1449 ;; collect. For the "head" revision, compute the value of the
1450 ;; `text' printed representation by simple `gather'. For all
1451 ;; other revisions, replace the `text' tag+value with `:insn'
1452 ;; plus value, always scanning in-place.
1468 (?d
1469 ;; `d' means "delete lines".
1470 ;; For Emacs spirit, we use `k' for "kill".
1472 (?a
1473 ;; `a' means "append after this line" but
1474 ;; internally we normalize it so that START
1475 ;; specifies the actual line for insert, thus
1476 ;; requiring less hair in the realization algs.
1477 ;; For Emacs spirit, we use `i' for "insert".
1482 cmd context)))
1483 acc))
1486 ;; rv
1492 ;;; vc-rcs.el ends here