| blob | 0a5ebe42eecd2e6cd97cfd220451f3c72d5beb8a |
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
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 ;;; Code:
31 ;;;
32 ;;; Customization options
33 ;;;
40 "The release number of your RCS installation, as a string.
41 If nil, VC itself computes this value when it is first needed."
48 "Switches for registering a file in RCS.
49 A string or list of strings passed to the checkin program by
51 If t, use no switches."
60 "String or list of strings specifying switches for RCS diff under VC.
61 If nil, use the value of `vc-diff-switches'. If t, use no switches."
70 "Header keywords to be inserted by `vc-insert-headers'."
76 "Indicates whether rcsdiff understands the --brief option.
77 The value is either `yes', `no', or nil. If it is nil, VC tries
78 to use --brief and sets this variable to remember whether it worked."
82 ;;;###autoload
85 "Where to look for RCS master files.
86 For a description of possible values, see `vc-check-master-templates'."
91 function)))
95 \f
96 ;;; Properties of the backend
101 "RCS-specific version of `vc-checkout-model'."
103 result)
112 ;;;
113 ;;; State-querying functions
114 ;;;
116 ;; The autoload cookie below places vc-rcs-registered directly into
117 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
118 ;; every file that is visited.
119 ;;;###autoload
124 "Implementation of `vc-state' for RCS."
126 'unregistered
131 ;; vc-working-revision might not be known; in that case the
132 ;; property is nil. vc-rcs-fetch-master-state knows how to
133 ;; handle that.
138 state
140 'up-to-date
142 'unlocked-changes
146 "State heuristic for RCS."
153 ;; If the headers say that the file is not locked, the
154 ;; permissions can tell us whether locking is used for
155 ;; the file or not.
164 'edited
168 state)
179 'edited
180 owner-name)
182 'edited
185 ;; Strange permissions. Fall through to
186 ;; expensive state computation.
191 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
192 ;; should be changed to take a backend parameter. Using
193 ;; `vc-expand-dirs' is not TRTD because it returns files from
194 ;; multiple backends. It should also return 'unregistered files.
196 ;; Doing individual vc-state calls is painful but there
197 ;; is no better way in RCS-land.
209 "RCS-specific version of `vc-working-revision'."
218 "Return non-nil if workfile version of FILE is the latest on its branch.
219 When VERSION is given, perform check for that version."
225 ;; Compare VERSION to the head version number.
228 ;; If we are not on the trunk, we need to examine the
229 ;; whole current branch.
234 "RCS-specific implementation of `vc-workfile-unchanged-p'."
235 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
236 ;; do a double take and remember the fact for the future
247 ;; The workfile is unchanged if rcsdiff found no differences.
258 \f
259 ;;;
260 ;;; State-changing functions
261 ;;;
264 "Create a new RCS repository."
265 ;; RCS is totally file-oriented, so all we have to do is make the directory.
269 "Register FILES into the RCS version-control system.
270 REV is the optional revision number for the files. COMMENT can be used
271 to provide an initial description for each FILES.
272 Passes either `vc-rcs-register-switches' or `vc-register-switches'
273 to the RCS command.
275 Automatically retrieve a read-only version of the file with keywords
276 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
287 ;; if available, use the secure registering option
292 ;; parse output to find master file name and workfile version
299 ;; if we couldn't find the master name,
300 ;; run vc-rcs-registered to get it
301 ;; (will be stored into the vc-name property)
305 name
307 name
312 nil t)
316 "Return non-nil if RCS thinks it would be responsible for registering FILE."
317 ;; TODO: check for all the patterns in vc-rcs-master-templates
321 "Implementation of receive-file for RCS."
329 "Unregister FILE from RCS.
330 If this leaves the RCS subdirectory empty, ask the user
331 whether to remove it."
340 ;; check whether RCS dir is empty, i.e. it does not
341 ;; contain any files except "." and ".."
348 "RCS-specific version of `vc-backend-checkin'."
350 ;; Now operate on the files
354 ;; Force branch creation if an appropriate
355 ;; default branch has been set.
357 default-branch
359 default-branch)
365 ;; if available, use the secure check-in option
369 switches)
372 ;; determine the new workfile version
382 ;; if we got to a different branch, adjust the default
383 ;; branch accordingly
391 ;; If this is an old RCS release, we might have
392 ;; to remove a remaining lock.
394 ;; exit status of 1 is also accepted.
395 ;; It means that the lock was removed before.
407 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
408 attempt the checkout for all registered files beneath it."
412 switches)
415 ;; Change buffers to get local value of vc-checkout-switches.
418 ;; Save this buffer's default-directory
419 ;; and use save-excursion to make sure it is restored
420 ;; in the same buffer it was saved in.
423 ;; Adjust the default-directory so that the check-out creates
424 ;; the file in the right place.
427 ;; if we should go to the head of the trunk,
428 ;; clear the default branch first
431 ;; now do the checkout
434 ;; If locking is not strict, force to overwrite
435 ;; the writable workfile.
439 ;; a literal revision was specified
445 ;; no revision specified:
446 ;; use current workfile version
447 workrev
448 ;; REV is t ...
450 ;; ... go to head of current branch
452 ;; ... go to head of trunk
454 nil)
456 switches)
457 ;; determine the new workfile version
462 ;; if necessary, adjust the default branch
465 file
469 new-version)))))
473 "Roll back, undoing the most recent checkins of FILES. Directories are
474 expanded to all registered subfiles in them."
483 discard file)))
487 ;; Check out the most recent remaining version. If it
488 ;; fails, because the whole branch got deleted, do a
489 ;; double-take and check out the version where the branch
490 ;; started.
502 ;; vc-do-command popped up a window with
503 ;; the error message. Get rid of it, by
504 ;; restoring the old window configuration.
506 ;; No, it was some other error: re-signal it.
510 "Revert FILE to the version it was based on. If FILE is a directory,
511 revert all registered files beneath it."
519 "Merge changes into current working copy of FILE.
520 The changes are between FIRST-VERSION and SECOND-VERSION."
527 "Steal the lock on the current workfile for FILE and revision REV.
528 If FILE is a directory, steal the lock on all registered files beneath it.
529 Needs RCS 5.6.2 or later for -M."
533 ;; Do a real checkout after stealing the lock, so that we see
534 ;; expanded headers.
538 "Modify the change comments change on FILES on a specified REV. If FILE is a
539 directory the operation is applied to all registered files beneath it."
544 \f
545 ;;;
546 ;;; History functions
547 ;;;
550 "Get change log associated with FILE. If FILE is a
551 directory the operation is applied to all registered files beneath it."
555 "Get a difference report using RCS between two sets of files."
565 "Return a string with all log entries stored in BACKEND for FILE."
567 ;; Has to be written this way, this function is used by the CVS backend too
569 ;; Remove cruft
585 ;; Return the de-crufted comment list
589 "Annotate FILE, inserting the results in BUFFER.
590 Optional arg REVISION is a revision to annotate from."
592 ;; Aside from the "head revision on the trunk", the instructions for
593 ;; each revision on the trunk are an ordered list of kill and insert
594 ;; commands necessary to go from the chronologically-following
595 ;; revision to this one. That is, associated with revision N are
596 ;; edits that applied to revision N+1 would result in revision N.
597 ;;
598 ;; On a branch, however, (some) things are inverted: the commands
599 ;; listed are those necessary to go from the chronologically-preceding
600 ;; revision to this one. That is, associated with revision N are
601 ;; edits that applied to revision N-1 would result in revision N.
602 ;;
603 ;; So, to get per-line history info, we apply reverse-chronological
604 ;; edits, starting with the head revision on the trunk, all the way
605 ;; back through the initial revision (typically "1.1" or similar),
606 ;; then apply forward-chronological edits -- keeping track of which
607 ;; revision is associated with each inserted line -- until we reach
608 ;; the desired revision for display (which may be either on the trunk
609 ;; or on a branch).
614 ;; The revision N whose instructions we currently are processing.
616 ;; Alist from the parse tree for N.
618 ;; Point and temporary string, respectively.
619 p s
620 ;; "Next-branch list". Nil means the desired revision to
621 ;; display lives on the trunk. Non-nil means it lives on a
622 ;; branch, in which case the value is a list of revision pairs
623 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
624 ;; links each series of revisions in the path from the initial
625 ;; revision to the desired revision to display.
626 nbls
627 ;; "Path-accumulate-predicate plus revision/date/author".
628 ;; Until set, forward-chronological edits are not accumulated.
629 ;; Once set, its value (updated every revision) is used for
630 ;; the text property `:vc-rcs-r/d/a' for inserts during
631 ;; processing of forward-chronological instructions for N.
632 ;; See internal func `r/d/a'.
633 prda
634 ;; List of forward-chronological instructions, each of the
635 ;; form: (POS . ACTION), where POS is a buffer position. If
636 ;; ACTION is a string, it is inserted, otherwise it is taken as
637 ;; the number of characters to be deleted.
638 path
639 ;; N+1. When `cur' is "", this is the initial revision.
640 pre)
645 ;; Find which branches (if any) must be included in the edits.
647 bpt kids)
651 ;; A branchpoint may have multiple children. Find the right one.
655 ;; Start with the full text.
658 ;; Apply reverse-chronological edits on the trunk, computing and
659 ;; accumulating forward-chronological edits after some point, for
660 ;; later.
667 ;; Start accumulating the forward-chronological edits when N+1
668 ;; on the trunk is either the desired revision to display, or
669 ;; the appropriate branchpoint for it. Do this before
670 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
674 ;; Edits in the parse tree specify a line number (in the buffer
675 ;; *BEFORE* editing occurs) to start from, but line numbers
676 ;; change as a result of edits. To DTRT, we apply edits in
677 ;; order of descending buffer position so that edits further
678 ;; down in the buffer occur first w/o corrupting specified
679 ;; buffer positions of edits occurring towards the beginning of
680 ;; the buffer. In this way we avoid using markers. A pleasant
681 ;; property of this approach is ability to push instructions
682 ;; onto `path' directly, w/o need to maintain rev boundaries.
697 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
698 ;; equivalent to pushing an insert instruction (of the entire buffer
699 ;; contents) onto `path' then erasing the buffer, but less wasteful.
701 ;; Now apply the forward-chronological edits for the trunk.
707 ;; Now apply the forward-chronological edits (directly from the
708 ;; parse-tree) for the branch(es), if necessary. We re-use vars
709 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
714 prda nil)
727 ;; Lastly, for each line, insert at bol nicely-formatted history info.
728 ;; We do two passes to collect summary information used to minimize
729 ;; the annotation's usage of screen real-estate: (1) Consider rendered
730 ;; width of revision plus author together as a unit; and (2) Omit
731 ;; author entirely if all authors are the same as the user.
736 rda w a)
746 ht)
754 " "
756 ls)
757 :vc-annotate-prefix t
765 ht)))
773 "Return the current time, based at midnight of the current day, and
774 encoded as fractional days."
779 "Return the time of the next annotation (as fraction of days)
780 systime, or nil if there is none. Also, reposition point."
789 \f
790 ;;;
791 ;;; Tag system
792 ;;;
801 dir
805 \f
806 ;;;
807 ;;; Miscellaneous
808 ;;;
811 "Check if the current file has any headers in it."
818 "Implementation of vc-clear-headers for RCS."
824 nil t)
828 ;; Just move the master file (using vc-rcs-master-templates).
832 ;; If the file is locked by some other user, make
833 ;; the buffer read-only. Like this, even root
834 ;; cannot modify a file that someone else has locked.
838 \f
839 ;;;
840 ;;; Internal functions
841 ;;;
844 "Return non-nil if FILE is newer than its RCS master.
845 This likely means that FILE has been changed with respect
846 to its master version."
854 "Find most recent revision on BRANCH."
859 nil t)
868 "Compute the master file's idea of the state of FILE.
869 If a WORKING-REVISION is given, compute the state of that version,
870 otherwise determine the workfile version based on the master file.
871 This function sets the properties `vc-working-revision' and
872 `vc-checkout-model' to their correct values, based on the master
873 file."
883 ;; Workfile version not known yet. Determine that first. It
884 ;; is either the head of the trunk, the head of the default
885 ;; branch, or the "default branch" itself, if that is a full
886 ;; revision number.
888 ;; no default branch
893 ;; default branch is actually a revision
895 default-branch)
897 ;; else, search for the head of the default branch
903 ;; Check strict locking
908 ;; Compute state of workfile version
916 ;; not locked
920 ;; workfile version is latest on branch
921 'up-to-date
922 ;; workfile version is not latest on branch
924 ;; locked by the calling user
927 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
929 workfile-is-latest
931 'edited
932 ;; Locking is not used for the file, but the owner does
933 ;; have a lock, and there is a higher version on the current
934 ;; branch. Not sure if this can occur, and if it is right
935 ;; to use `needs-merge' in this case.
937 ;; locked by somebody else
939 locking-user)
944 "Search for RCS headers in FILE, and set properties accordingly.
946 Returns: nil if no headers were found
947 'rev if a workfile revision was found
948 'rev-and-lock if revision and lock info was found"
956 ;; search for $Id or $Header
957 ;; -------------------------
958 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
965 ;; if found, store the revision number ...
967 ;; ... and check for the locking state
975 ;; unlocked revision
979 ;; revision is locked by some user
983 ;; everything else: false
985 ;; unexpected information in
986 ;; keyword string --> quit
988 ;; search for $Revision
989 ;; --------------------
992 nil t)
993 ;; if found, store the revision number ...
995 ;; and see if there's any lock information
1008 ;; else: nothing found
1009 ;; -------------------
1019 ;; If the file has headers, we don't want to query the
1020 ;; master file, because that would eliminate all the
1021 ;; performance gain the headers brought us. We therefore
1022 ;; use a heuristic now to find out whether locking is used
1023 ;; for this file. If we trust the file permissions, and the
1024 ;; file is not locked, then if the file is read-only we
1025 ;; assume that locking is used for the file, otherwise
1026 ;; locking is not used.
1032 status))))
1035 "Compare release numbers, represented as strings.
1036 Release components are assumed cardinal numbers, not decimal fractions
1037 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1038 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1039 of the string is found, or a non-numeric component shows up \(5.6.7 is
1041 some cases\). This code is suitable for existing RCS release numbers.
1042 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1063 "Return t if we have RELEASE or better."
1070 "Return the RCS release installed on this system, as a string.
1071 Return symbol `unknown' if the release cannot be deducted. The user can
1072 override this using variable `vc-rcs-release'.
1074 If the user has not set variable `vc-rcs-release' and it is nil,
1075 variable `vc-rcs-release' is set to the returned value."
1093 "Parse current buffer, presumed to be in RCS-style masterfile format.
1094 Optional arg BUFFER specifies another buffer to parse. Return an alist
1095 of two elements, w/ keys `headers' and `revisions' and values in turn
1096 sub-alists. For `headers', the values unless otherwise specified are
1097 strings and the keys are:
1099 desc -- description
1100 head -- latest revision
1102 absent if the head revision lies on the trunk
1103 access -- ???
1104 symbols -- sub-alist of (SYMBOL . REVISION) elements
1108 expand -- may be absent; ???
1110 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1111 with string values (unless otherwise specified) and keys:
1113 date -- a time value (like that returned by `encode-time'); as a
1114 special case, a year value less than 100 is augmented by 1900
1115 author -- username
1117 branches -- list of revisions that begin branches from this revision
1120 log -- change log entry
1121 text -- for the head revision on the trunk, the body of the file;
1122 other revisions have `:insn' instead
1123 :insn -- for non-head revisions, a list of parsed instructions
1126 - `(START k COUNT)' -- kill COUNT lines
1127 - `(START i TEXT)' -- insert TEXT (a string)
1128 The list is in descending order by START.
1130 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1133 ;; An RCS masterfile can be viewed as containing four regular (for the
1134 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1135 ;; the "description" and (d) the "rev bodies", in that order. In the
1136 ;; returned alist (see docstring), elements from (b) and (d) are
1137 ;; combined pairwise to form the "revisions", while those from (a) and
1138 ;; (c) are simply combined to form the "headers".
1139 ;;
1140 ;; Loosely speaking, each section contains a series of alternating
1141 ;; "tags" and "printed representations". In the (b) and (d), many
1142 ;; such series can appear, and a revision number on a line by itself
1143 ;; precedes the series of tags and printed representations associated
1144 ;; with it.
1145 ;;
1146 ;; In (a) and (b), the printed representations (with the exception of
1147 ;; the `comment' tag in the headers) terminate with a semicolon, which
1148 ;; is NOT part of the "value" finally associated with the tag. All
1149 ;; other printed representations are in "@@-format"; there is an "@",
1150 ;; the middle part (to be translated into the value), another "@" and
1151 ;; a newline. Each "@@" in the middle part indicates the position of
1152 ;; a single "@" (and consequently the requirement of an additional
1153 ;; initial step when translating to the value).
1154 ;;
1155 ;; Parser state includes vars that collect parts of the return value...
1157 ;; ... as well as vars that support a single-pass, tag-assisted,
1158 ;; minimal-data-copying scan. Basically -- skirting around the
1159 ;; grouping by revision required in (b) and (d) -- we repeatedly
1160 ;; and context-sensitively read a tag (that MUST be present),
1161 ;; determine the bounds of the printed representation, translate
1162 ;; it into a value, and push the tag plus value onto one of the
1163 ;; collection vars. Finally, we return the parse tree
1164 ;; incorporating the values of the collection vars (see "rv").
1165 ;;
1166 ;; A symbol or string to keep track of context (for error messages).
1167 context
1168 ;; A symbol, the current tag.
1169 tok
1170 ;; Region (begin and end buffer positions) of the printed
1171 ;; representation for the current tag.
1172 b e
1173 ;; A list of buffer positions where "@@" can be found within the
1174 ;; printed representation region. For each location, we push two
1175 ;; elements onto the list, 1+ and 2+ the location, respectively,
1176 ;; with the 2+ appearing at the head. In this way, the expression
1177 ;; `(,e ,@@-holes ,b)
1178 ;; describes regions that can be concatenated (in reverse order)
1179 ;; to "de-@@-format" the printed representation as the first step
1180 ;; to translating it into some value. See internal func `gather'.
1209 acc)
1213 acc)
1222 ;; headers
1236 two))
1242 t))
1243 headers)
1251 ;; rev headers
1260 b e)
1262 ;; Hack the year -- verified to be the
1263 ;; same algorithm used in RCS 5.7.
1273 revs)
1276 ;; desc
1279 ;; rev bodies
1281 ;; Element of `revs' that initially holds only header info.
1282 ;; "Pairwise combination" occurs when we add body info.
1283 rev
1284 ;; Components of the editing commands (aside from the actual
1285 ;; text) that comprise the `text' printed representations
1286 ;; (not including the "head" revision).
1287 cmd start act
1288 ;; Ascending (reversed) `@-holes' which the internal func
1289 ;; `incg' pops to effect incremental gathering.
1290 asc
1291 ;; Function to extract text (for the `a' command), either
1292 ;; `incg' or `buffer-substring-no-properties'. (This is
1293 ;; for speed; strictly speaking, it is sufficient to use
1294 ;; only the former since it behaves identically to the
1295 ;; latter in the absense of "@@".)
1296 sub)
1300 ;; Self-deprecate when work is done.
1301 ;; Folding many dimensions into one.
1302 ;; Thanks B.Mandelbrot, for complex sum.
1303 ;; O beauteous math! --the Unvexed Bum
1312 context))))
1314 ;; For rev body `text' tags, delay translation slightly...
1316 ;; ... until we decide which tag and value is appropriate to
1317 ;; collect. For the "head" revision, compute the value of the
1318 ;; `text' printed representation by simple `gather'. For all
1319 ;; other revisions, replace the `text' tag+value with `:insn'
1320 ;; plus value, always scanning in-place.
1336 (?d
1337 ;; `d' means "delete lines".
1338 ;; For Emacs spirit, we use `k' for "kill".
1340 (?a
1341 ;; `a' means "append after this line" but
1342 ;; internally we normalize it so that START
1343 ;; specifies the actual line for insert, thus
1344 ;; requiring less hair in the realization algs.
1345 ;; For Emacs spirit, we use `i' for "insert".
1350 cmd context)))
1351 acc))
1354 ;; rv
1360 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1361 ;;; vc-rcs.el ends here