| blob | e1cb4e21c2633e494a71d0f17728c68991fa5432 |
1 ;;; vc-rcs.el --- support for RCS version-control
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
7 ;; Author: FSF (see vc.el for full credits)
8 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; See vc.el
29 ;; Some features will not work with old RCS versions. Where
30 ;; appropriate, VC finds out which version you have, and allows or
31 ;; disallows those features (stealing locks, for example, works only
32 ;; from 5.6.2 onwards).
33 ;; Even initial checkins will fail if your RCS version is so old that ci
34 ;; doesn't understand -t-; this has been known to happen to people running
35 ;; NExTSTEP 3.0.
36 ;;
37 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
39 ;;; Code:
41 ;;;
42 ;;; Customization options
43 ;;;
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 ;;;###autoload
95 "Where to look for RCS master files.
96 For a description of possible values, see `vc-check-master-templates'."
101 function)))
105 \f
106 ;;; Properties of the backend
111 "RCS-specific version of `vc-checkout-model'."
113 result)
122 ;;;
123 ;;; State-querying functions
124 ;;;
126 ;; The autoload cookie below places vc-rcs-registered directly into
127 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
128 ;; every file that is visited.
129 ;;;###autoload
134 "Implementation of `vc-state' for RCS."
136 'unregistered
141 ;; vc-working-revision might not be known; in that case the
142 ;; property is nil. vc-rcs-fetch-master-state knows how to
143 ;; handle that.
148 state
150 'up-to-date
152 'unlocked-changes
156 "State heuristic for RCS."
163 ;; If the headers say that the file is not locked, the
164 ;; permissions can tell us whether locking is used for
165 ;; the file or not.
174 'edited
178 state)
189 'edited
190 owner-name)
192 'edited
195 ;; Strange permissions. Fall through to
196 ;; expensive state computation.
201 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
202 ;; should be changed to take a backend parameter. Using
203 ;; `vc-expand-dirs' is not TRTD because it returns files from
204 ;; multiple backends. It should also return 'unregistered files.
206 ;; Doing individual vc-state calls is painful but there
207 ;; is no better way in RCS-land.
219 "RCS-specific version of `vc-working-revision'."
228 "Return non-nil if workfile version of FILE is the latest on its branch.
229 When VERSION is given, perform check for that version."
235 ;; Compare VERSION to the head version number.
238 ;; If we are not on the trunk, we need to examine the
239 ;; whole current branch.
244 "RCS-specific implementation of `vc-workfile-unchanged-p'."
245 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
246 ;; do a double take and remember the fact for the future
257 ;; The workfile is unchanged if rcsdiff found no differences.
260 \f
261 ;;;
262 ;;; State-changing functions
263 ;;;
266 "Create a new RCS repository."
267 ;; RCS is totally file-oriented, so all we have to do is make the directory.
271 "Register FILES into the RCS version-control system.
272 REV is the optional revision number for the files. COMMENT can be used
273 to provide an initial description for each FILES.
274 Passes either `vc-rcs-register-switches' or `vc-register-switches'
275 to the RCS command.
277 Automatically retrieve a read-only version of the file with keywords
278 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
280 ;; When REV is specified, we need to force using "-t-".
291 ;; if available, use the secure registering option
296 ;; parse output to find master file name and workfile version
303 ;; if we couldn't find the master name,
304 ;; run vc-rcs-registered to get it
305 ;; (will be stored into the vc-name property)
309 name
311 name
316 nil t)
320 "Return non-nil if RCS thinks it would be responsible for registering FILE."
321 ;; TODO: check for all the patterns in vc-rcs-master-templates
325 "Implementation of receive-file for RCS."
333 "Unregister FILE from RCS.
334 If this leaves the RCS subdirectory empty, ask the user
335 whether to remove it."
344 ;; check whether RCS dir is empty, i.e. it does not
345 ;; contain any files except "." and ".."
352 "RCS-specific version of `vc-backend-checkin'."
354 ;; Now operate on the files
358 ;; Force branch creation if an appropriate
359 ;; default branch has been set.
361 default-branch
363 default-branch)
369 ;; if available, use the secure check-in option
373 switches)
376 ;; determine the new workfile version
386 ;; if we got to a different branch, adjust the default
387 ;; branch accordingly
395 ;; If this is an old RCS release, we might have
396 ;; to remove a remaining lock.
398 ;; exit status of 1 is also accepted.
399 ;; It means that the lock was removed before.
411 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
412 attempt the checkout for all registered files beneath it."
416 switches)
419 ;; Change buffers to get local value of vc-checkout-switches.
422 ;; Save this buffer's default-directory
423 ;; and use save-excursion to make sure it is restored
424 ;; in the same buffer it was saved in.
427 ;; Adjust the default-directory so that the check-out creates
428 ;; the file in the right place.
431 ;; if we should go to the head of the trunk,
432 ;; clear the default branch first
435 ;; now do the checkout
438 ;; If locking is not strict, force to overwrite
439 ;; the writable workfile.
443 ;; a literal revision was specified
449 ;; no revision specified:
450 ;; use current workfile version
451 workrev
452 ;; REV is t ...
454 ;; ... go to head of current branch
456 ;; ... go to head of trunk
458 nil)
460 switches)
461 ;; determine the new workfile version
466 ;; if necessary, adjust the default branch
469 file
473 new-version)))))
477 "Roll back, undoing the most recent checkins of FILES. Directories are
478 expanded to all registered subfiles in them."
487 discard file)))
491 ;; Check out the most recent remaining version. If it
492 ;; fails, because the whole branch got deleted, do a
493 ;; double-take and check out the version where the branch
494 ;; started.
506 ;; vc-do-command popped up a window with
507 ;; the error message. Get rid of it, by
508 ;; restoring the old window configuration.
510 ;; No, it was some other error: re-signal it.
514 "Revert FILE to the version it was based on. If FILE is a directory,
515 revert all registered files beneath it."
523 "Merge changes into current working copy of FILE.
524 The changes are between FIRST-VERSION and SECOND-VERSION."
531 "Steal the lock on the current workfile for FILE and revision REV.
532 If FILE is a directory, steal the lock on all registered files beneath it.
533 Needs RCS 5.6.2 or later for -M."
537 ;; Do a real checkout after stealing the lock, so that we see
538 ;; expanded headers.
542 "Modify the change comments change on FILES on a specified REV. If FILE is a
543 directory the operation is applied to all registered files beneath it."
548 \f
549 ;;;
550 ;;; History functions
551 ;;;
565 "Get change log associated with FILE. If FILE is a
566 directory the operation is applied to all registered files beneath it."
573 "Get a difference report using RCS between two sets of files."
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 ;;;
821 dir
825 \f
826 ;;;
827 ;;; Miscellaneous
828 ;;;
831 "Return t if REV is a revision on the trunk."
835 "Return the minor revision number of a revision number REV."
840 "Return the revision number immediately preceding REV for FILE,
841 or nil if there is no previous revision. This default
842 implementation works for MAJOR.MINOR-style revision numbers as
843 used by RCS and CVS."
848 ;; revision does probably not start a branch or release
851 ;; we are at the beginning of the trunk --
852 ;; don't know anything to return here
853 nil
854 ;; we are at the beginning of a branch --
855 ;; return revision of starting point
859 "Return the revision number immediately following REV for FILE,
860 or nil if there is no next revision. This default implementation
861 works for MAJOR.MINOR-style revision numbers as used by RCS
862 and CVS."
869 "Default implementation of update-changelog.
870 Uses `rcs2log' which only works for RCS and CVS."
871 ;; FIXME: We (c|sh)ould add support for cvs2cl
874 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
878 temporary-file-directory))))
886 user-mail-address)))
900 exec-directory)
902 "-c" changelog
910 files)))
911 "done"
920 "Check if the current file has any headers in it."
927 "Implementation of vc-clear-headers for RCS."
933 nil t)
937 ;; Just move the master file (using vc-rcs-master-templates).
941 ;; If the file is locked by some other user, make
942 ;; the buffer read-only. Like this, even root
943 ;; cannot modify a file that someone else has locked.
947 \f
948 ;;;
949 ;;; Internal functions
950 ;;;
953 "Return non-nil if FILE is newer than its RCS master.
954 This likely means that FILE has been changed with respect
955 to its master version."
963 "Find most recent revision on BRANCH."
968 nil t)
977 "Compute the master file's idea of the state of FILE.
978 If a WORKING-REVISION is given, compute the state of that version,
979 otherwise determine the workfile version based on the master file.
980 This function sets the properties `vc-working-revision' and
981 `vc-checkout-model' to their correct values, based on the master
982 file."
992 ;; Workfile version not known yet. Determine that first. It
993 ;; is either the head of the trunk, the head of the default
994 ;; branch, or the "default branch" itself, if that is a full
995 ;; revision number.
997 ;; no default branch
1002 ;; default branch is actually a revision
1004 default-branch)
1006 ;; else, search for the head of the default branch
1012 ;; Check strict locking
1017 ;; Compute state of workfile version
1025 ;; not locked
1029 ;; workfile version is latest on branch
1030 'up-to-date
1031 ;; workfile version is not latest on branch
1033 ;; locked by the calling user
1036 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1038 workfile-is-latest
1040 'edited
1041 ;; Locking is not used for the file, but the owner does
1042 ;; have a lock, and there is a higher version on the current
1043 ;; branch. Not sure if this can occur, and if it is right
1044 ;; to use `needs-merge' in this case.
1046 ;; locked by somebody else
1048 locking-user)
1053 "Search for RCS headers in FILE, and set properties accordingly.
1055 Returns: nil if no headers were found
1056 'rev if a workfile revision was found
1057 'rev-and-lock if revision and lock info was found"
1065 ;; search for $Id or $Header
1066 ;; -------------------------
1067 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1074 ;; if found, store the revision number ...
1076 ;; ... and check for the locking state
1084 ;; unlocked revision
1088 ;; revision is locked by some user
1092 ;; everything else: false
1094 ;; unexpected information in
1095 ;; keyword string --> quit
1097 ;; search for $Revision
1098 ;; --------------------
1101 nil t)
1102 ;; if found, store the revision number ...
1104 ;; and see if there's any lock information
1117 ;; else: nothing found
1118 ;; -------------------
1128 ;; If the file has headers, we don't want to query the
1129 ;; master file, because that would eliminate all the
1130 ;; performance gain the headers brought us. We therefore
1131 ;; use a heuristic now to find out whether locking is used
1132 ;; for this file. If we trust the file permissions, and the
1133 ;; file is not locked, then if the file is read-only we
1134 ;; assume that locking is used for the file, otherwise
1135 ;; locking is not used.
1141 status))))
1144 "Compare release numbers, represented as strings.
1145 Release components are assumed cardinal numbers, not decimal fractions
1146 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1147 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1148 of the string is found, or a non-numeric component shows up \(5.6.7 is
1150 some cases\). This code is suitable for existing RCS release numbers.
1151 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1172 "Return t if we have RELEASE or better."
1179 "Return the RCS release installed on this system, as a string.
1180 Return symbol `unknown' if the release cannot be deducted. The user can
1181 override this using variable `vc-rcs-release'.
1183 If the user has not set variable `vc-rcs-release' and it is nil,
1184 variable `vc-rcs-release' is set to the returned value."
1202 "Parse current buffer, presumed to be in RCS-style masterfile format.
1203 Optional arg BUFFER specifies another buffer to parse. Return an alist
1204 of two elements, w/ keys `headers' and `revisions' and values in turn
1205 sub-alists. For `headers', the values unless otherwise specified are
1206 strings and the keys are:
1208 desc -- description
1209 head -- latest revision
1211 absent if the head revision lies on the trunk
1212 access -- ???
1213 symbols -- sub-alist of (SYMBOL . REVISION) elements
1217 expand -- may be absent; ???
1219 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1220 with string values (unless otherwise specified) and keys:
1222 date -- a time value (like that returned by `encode-time'); as a
1223 special case, a year value less than 100 is augmented by 1900
1224 author -- username
1226 branches -- list of revisions that begin branches from this revision
1229 log -- change log entry
1230 text -- for the head revision on the trunk, the body of the file;
1231 other revisions have `:insn' instead
1232 :insn -- for non-head revisions, a list of parsed instructions
1235 - `(START k COUNT)' -- kill COUNT lines
1236 - `(START i TEXT)' -- insert TEXT (a string)
1237 The list is in descending order by START.
1239 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1242 ;; An RCS masterfile can be viewed as containing four regular (for the
1243 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1244 ;; the "description" and (d) the "rev bodies", in that order. In the
1245 ;; returned alist (see docstring), elements from (b) and (d) are
1246 ;; combined pairwise to form the "revisions", while those from (a) and
1247 ;; (c) are simply combined to form the "headers".
1248 ;;
1249 ;; Loosely speaking, each section contains a series of alternating
1250 ;; "tags" and "printed representations". In the (b) and (d), many
1251 ;; such series can appear, and a revision number on a line by itself
1252 ;; precedes the series of tags and printed representations associated
1253 ;; with it.
1254 ;;
1255 ;; In (a) and (b), the printed representations (with the exception of
1256 ;; the `comment' tag in the headers) terminate with a semicolon, which
1257 ;; is NOT part of the "value" finally associated with the tag. All
1258 ;; other printed representations are in "@@-format"; there is an "@",
1259 ;; the middle part (to be translated into the value), another "@" and
1260 ;; a newline. Each "@@" in the middle part indicates the position of
1261 ;; a single "@" (and consequently the requirement of an additional
1262 ;; initial step when translating to the value).
1263 ;;
1264 ;; Parser state includes vars that collect parts of the return value...
1266 ;; ... as well as vars that support a single-pass, tag-assisted,
1267 ;; minimal-data-copying scan. Basically -- skirting around the
1268 ;; grouping by revision required in (b) and (d) -- we repeatedly
1269 ;; and context-sensitively read a tag (that MUST be present),
1270 ;; determine the bounds of the printed representation, translate
1271 ;; it into a value, and push the tag plus value onto one of the
1272 ;; collection vars. Finally, we return the parse tree
1273 ;; incorporating the values of the collection vars (see "rv").
1274 ;;
1275 ;; A symbol or string to keep track of context (for error messages).
1276 context
1277 ;; A symbol, the current tag.
1278 tok
1279 ;; Region (begin and end buffer positions) of the printed
1280 ;; representation for the current tag.
1281 b e
1282 ;; A list of buffer positions where "@@" can be found within the
1283 ;; printed representation region. For each location, we push two
1284 ;; elements onto the list, 1+ and 2+ the location, respectively,
1285 ;; with the 2+ appearing at the head. In this way, the expression
1286 ;; `(,e ,@@-holes ,b)
1287 ;; describes regions that can be concatenated (in reverse order)
1288 ;; to "de-@@-format" the printed representation as the first step
1289 ;; to translating it into some value. See internal func `gather'.
1318 acc)
1322 acc)
1331 ;; headers
1345 two))
1351 t))
1352 headers)
1360 ;; rev headers
1369 b e)
1371 ;; Hack the year -- verified to be the
1372 ;; same algorithm used in RCS 5.7.
1382 revs)
1385 ;; desc
1388 ;; rev bodies
1390 ;; Element of `revs' that initially holds only header info.
1391 ;; "Pairwise combination" occurs when we add body info.
1392 rev
1393 ;; Components of the editing commands (aside from the actual
1394 ;; text) that comprise the `text' printed representations
1395 ;; (not including the "head" revision).
1396 cmd start act
1397 ;; Ascending (reversed) `@-holes' which the internal func
1398 ;; `incg' pops to effect incremental gathering.
1399 asc
1400 ;; Function to extract text (for the `a' command), either
1401 ;; `incg' or `buffer-substring-no-properties'. (This is
1402 ;; for speed; strictly speaking, it is sufficient to use
1403 ;; only the former since it behaves identically to the
1404 ;; latter in the absense of "@@".)
1405 sub)
1409 ;; Self-deprecate when work is done.
1410 ;; Folding many dimensions into one.
1411 ;; Thanks B.Mandelbrot, for complex sum.
1412 ;; O beauteous math! --the Unvexed Bum
1421 context))))
1423 ;; For rev body `text' tags, delay translation slightly...
1425 ;; ... until we decide which tag and value is appropriate to
1426 ;; collect. For the "head" revision, compute the value of the
1427 ;; `text' printed representation by simple `gather'. For all
1428 ;; other revisions, replace the `text' tag+value with `:insn'
1429 ;; plus value, always scanning in-place.
1445 (?d
1446 ;; `d' means "delete lines".
1447 ;; For Emacs spirit, we use `k' for "kill".
1449 (?a
1450 ;; `a' means "append after this line" but
1451 ;; internally we normalize it so that START
1452 ;; specifies the actual line for insert, thus
1453 ;; requiring less hair in the realization algs.
1454 ;; For Emacs spirit, we use `i' for "insert".
1459 cmd context)))
1460 acc))
1463 ;; rv
1469 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1470 ;;; vc-rcs.el ends here