| blob | ae4758169f456d8d204515d48402c89a3ce3ce3f |
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 Free Software Foundation, Inc.
6 ;; Author: FSF (see vc.el for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
9 ;; $Id$
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; See vc.el
32 ;;; Code:
34 ;;;
35 ;;; Customization options
36 ;;;
43 "*The release number of your RCS installation, as a string.
44 If nil, VC itself computes this value when it is first needed."
51 "*Extra switches for registering a file in RCS.
52 A string or list of strings. These are passed to the checkin program
58 string))
63 "*A string or list of strings specifying extra switches for rcsdiff under VC."
68 string))
73 "*Header keywords to be inserted by `vc-insert-headers'."
79 "*Indicates whether rcsdiff understands the --brief option.
80 The value is either `yes', `no', or nil. If it is nil, VC tries
81 to use --brief and sets this variable to remember whether it worked."
85 ;;;###autoload
88 "*Where to look for RCS master files.
89 For a description of possible values, see `vc-check-master-templates'."
94 function)))
98 \f
99 ;;;
100 ;;; State-querying functions
101 ;;;
103 ;;; The autoload cookie below places vc-rcs-registered directly into
104 ;;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
105 ;;; every file that is visited. The definition is repeated below
106 ;;; so that Help and etags can find it.
108 ;;;###autoload (defun vc-rcs-registered (f) (vc-default-registered 'RCS f))
112 "Implementation of `vc-state' for RCS."
117 ;; vc-workfile-version might not be known; in that case the
118 ;; property is nil. vc-rcs-fetch-master-state knows how to
119 ;; handle that.
124 state
126 'up-to-date
128 'unlocked-changes
132 "State heuristic for RCS."
139 ;; If the headers say that the file is not locked, the
140 ;; permissions can tell us whether locking is used for
141 ;; the file or not.
149 'edited
153 state)
164 'edited
165 owner-name)
167 'edited
170 ;; Strange permissions. Fall through to
171 ;; expensive state computation.
176 "RCS-specific version of `vc-workfile-version'."
185 "Return non-nil if workfile version of FILE is the latest on its branch.
186 When VERSION is given, perform check for that version."
192 ;; Compare VERSION to the head version number.
195 ;; If we are not on the trunk, we need to examine the
196 ;; whole current branch.
201 "RCS-specific version of `vc-checkout-model'."
212 "RCS-specific implementation of `vc-workfile-unchanged-p'."
213 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
214 ;; do a double take and remember the fact for the future
225 ;; The workfile is unchanged if rcsdiff found no differences.
228 \f
229 ;;;
230 ;;; State-changing functions
231 ;;;
234 "Register FILE into the RCS version-control system.
235 REV is the optional revision number for the file. COMMENT can be used
236 to provide an initial description of FILE.
238 `vc-register-switches' and `vc-rcs-register-switches' are passed to
239 the RCS command (in that order).
241 Automatically retrieve a read-only version of the file with keywords
242 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
250 ;; if available, use the secure registering option
255 ;; parse output to find master file name and workfile version
262 ;; if we couldn't find the master name,
263 ;; run vc-rcs-registered to get it
264 ;; (will be stored into the vc-name property)
268 name
270 name
275 nil t)
279 "Return non-nil if RCS thinks it would be responsible for registering FILE."
280 ;; TODO: check for all the patterns in vc-rcs-master-templates
284 "Implementation of receive-file for RCS."
292 "Unregister FILE from RCS.
293 If this leaves the RCS subdirectory empty, ask the user
294 whether to remove it."
303 ;; check whether RCS dir is empty, i.e. it does not
304 ;; contain any files except "." and ".."
311 "RCS-specific version of `vc-backend-checkin'."
315 ;; Force branch creation if an appropriate
316 ;; default branch has been set.
318 default-branch
320 default-branch)
326 ;; if available, use the secure check-in option
330 switches)
333 ;; determine the new workfile version
343 ;; if we got to a different branch, adjust the default
344 ;; branch accordingly
352 ;; If this is an old RCS release, we might have
353 ;; to remove a remaining lock.
355 ;; exit status of 1 is also accepted.
356 ;; It means that the lock was removed before.
368 "Retrieve a copy of a saved version of FILE."
370 switches)
373 ;; Change buffers to get local value of vc-checkout-switches.
376 ;; Save this buffer's default-directory
377 ;; and use save-excursion to make sure it is restored
378 ;; in the same buffer it was saved in.
381 ;; Adjust the default-directory so that the check-out creates
382 ;; the file in the right place.
385 ;; if we should go to the head of the trunk,
386 ;; clear the default branch first
389 ;; now do the checkout
392 ;; If locking is not strict, force to overwrite
393 ;; the writable workfile.
397 ;; a literal revision was specified
403 ;; no revision specified:
404 ;; use current workfile version
405 workrev
406 ;; REV is t ...
408 ;; ... go to head of current branch
410 ;; ... go to head of trunk
412 nil)
414 switches)
415 ;; determine the new workfile version
420 ;; if necessary, adjust the default branch
423 file
427 new-version)))))
431 "Revert FILE to the version it was based on."
437 "Undo the most recent checkin of FILE.
438 EDITABLE non-nil means previous version should be locked."
444 ;; Check out the most recent remaining version. If it fails, because
445 ;; the whole branch got deleted, do a double-take and check out the
446 ;; version where the branch started.
458 ;; vc-do-command popped up a window with
459 ;; the error message. Get rid of it, by
460 ;; restoring the old window configuration.
462 ;; No, it was some other error: re-signal it.
466 "Merge changes into current working copy of FILE.
467 The changes are between FIRST-VERSION and SECOND-VERSION."
474 "Steal the lock on the current workfile for FILE and revision REV.
475 Needs RCS 5.6.2 or later for -M."
477 ;; Do a real checkout after stealing the lock, so that we see
478 ;; expanded headers.
482 \f
483 ;;;
484 ;;; History functions
485 ;;;
488 "Get change log associated with FILE."
492 "Get a difference report using RCS between two versions of FILE."
501 "Annotate FILE, inserting the results in BUFFER.
502 Optional arg REVISION is a revision to annotate from."
504 ;; Aside from the "head revision on the trunk", the instructions for
505 ;; each revision on the trunk are an ordered list of kill and insert
506 ;; commands necessary to go from the chronologically-following
507 ;; revision to this one. That is, associated with revision N are
508 ;; edits that applied to revision N+1 would result in revision N.
509 ;;
510 ;; On a branch, however, (some) things are inverted: the commands
511 ;; listed are those necessary to go from the chronologically-preceding
512 ;; revision to this one. That is, associated with revision N are
513 ;; edits that applied to revision N-1 would result in revision N.
514 ;;
515 ;; So, to get per-line history info, we apply reverse-chronological
516 ;; edits, starting with the head revision on the trunk, all the way
517 ;; back through the initial revision (typically "1.1" or similar),
518 ;; then apply forward-chronological edits -- keeping track of which
519 ;; revision is associated with each inserted line -- until we reach
520 ;; the desired revision for display (which may be either on the trunk
521 ;; or on a branch).
526 ;; The revision N whose instructions we currently are processing.
528 ;; Alist from the parse tree for N.
530 ;; Point and temporary string, respectively.
531 p s
532 ;; "Next-branch list". Nil means the desired revision to
533 ;; display lives on the trunk. Non-nil means it lives on a
534 ;; branch, in which case the value is a list of revision pairs
535 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
536 ;; links each series of revisions in the path from the initial
537 ;; revision to the desired revision to display.
538 nbls
539 ;; "Path-accumulate-predicate plus revision/date/author".
540 ;; Until set, forward-chronological edits are not accumulated.
541 ;; Once set, its value (updated every revision) is used for
542 ;; the text property `:vc-rcs-r/d/a' for inserts during
543 ;; processing of forward-chronological instructions for N.
544 ;; See internal func `r/d/a'.
545 prda
546 ;; List of forward-chronological instructions, each of the
547 ;; form: (POS . ACTION), where POS is a buffer position. If
548 ;; ACTION is a string, it is inserted, otherwise it is taken as
549 ;; the number of characters to be deleted.
550 path
551 ;; N+1. When `cur' is "", this is the initial revision.
552 pre)
557 ;; Find which branches (if any) must be included in the edits.
559 bpt kids)
563 ;; A branchpoint may have multiple children. Find the right one.
567 ;; Start with the full text.
570 ;; Apply reverse-chronological edits on the trunk, computing and
571 ;; accumulating forward-chronological edits after some point, for
572 ;; later.
579 ;; Start accumulating the forward-chronological edits when N+1
580 ;; on the trunk is either the desired revision to display, or
581 ;; the appropriate branchpoint for it. Do this before
582 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
586 ;; Edits in the parse tree specify a line number (in the buffer
587 ;; *BEFORE* editing occurs) to start from, but line numbers
588 ;; change as a result of edits. To DTRT, we apply edits in
589 ;; order of descending buffer position so that edits further
590 ;; down in the buffer occur first w/o corrupting specified
591 ;; buffer positions of edits occurring towards the beginning of
592 ;; the buffer. In this way we avoid using markers. A pleasant
593 ;; property of this approach is ability to push instructions
594 ;; onto `path' directly, w/o need to maintain rev boundaries.
609 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
610 ;; equivalent to pushing an insert instruction (of the entire buffer
611 ;; contents) onto `path' then erasing the buffer, but less wasteful.
613 ;; Now apply the forward-chronological edits for the trunk.
619 ;; Now apply the forward-chronological edits (directly from the
620 ;; parse-tree) for the branch(es), if necessary. We re-use vars
621 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
626 prda nil)
639 ;; Lastly, for each line, insert at bol nicely-formatted history info.
640 ;; We do two passes to collect summary information used to minimize
641 ;; the annotation's usage of screen real-estate: (1) Consider rendered
642 ;; width of revision plus author together as a unit; and (2) Omit
643 ;; author entirely if all authors are the same as the user.
648 rda w a)
658 ht)
666 " "
668 ls)
676 ht)))
682 "Return the current time, based at midnight of the current day, and
683 encoded as fractional days."
688 "Return the time of the next annotation (as fraction of days)
689 systime, or nil if there is none. Also, reposition point."
698 \f
699 ;;;
700 ;;; Snapshot system
701 ;;;
704 "Assign to FILE's latest version a given NAME."
707 \f
708 ;;;
709 ;;; Miscellaneous
710 ;;;
713 "Check if the current file has any headers in it."
720 "Implementation of vc-clear-headers for RCS."
726 nil t)
730 ;; Just move the master file (using vc-rcs-master-templates).
733 \f
734 ;;;
735 ;;; Internal functions
736 ;;;
739 "Return non-nil if FILE is newer than its RCS master.
740 This likely means that FILE has been changed with respect
741 to its master version."
749 "Find most recent revision on BRANCH."
754 nil t)
763 "Compute the master file's idea of the state of FILE.
764 If a WORKFILE-VERSION is given, compute the state of that version,
765 otherwise determine the workfile version based on the master file.
766 This function sets the properties `vc-workfile-version' and
767 `vc-checkout-model' to their correct values, based on the master
768 file."
778 ;; Workfile version not known yet. Determine that first. It
779 ;; is either the head of the trunk, the head of the default
780 ;; branch, or the "default branch" itself, if that is a full
781 ;; revision number.
783 ;; no default branch
788 ;; default branch is actually a revision
790 default-branch)
792 ;; else, search for the head of the default branch
798 ;; Check strict locking
803 ;; Compute state of workfile version
811 ;; not locked
815 ;; workfile version is latest on branch
816 'up-to-date
817 ;; workfile version is not latest on branch
819 ;; locked by the calling user
823 workfile-is-latest
825 'edited
826 ;; Locking is not used for the file, but the owner does
827 ;; have a lock, and there is a higher version on the current
828 ;; branch. Not sure if this can occur, and if it is right
829 ;; to use `needs-merge' in this case.
831 ;; locked by somebody else
833 locking-user)
838 "Search for RCS headers in FILE, and set properties accordingly.
840 Returns: nil if no headers were found
841 'rev if a workfile revision was found
842 'rev-and-lock if revision and lock info was found"
850 ;; search for $Id or $Header
851 ;; -------------------------
852 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
859 ;; if found, store the revision number ...
861 ;; ... and check for the locking state
869 ;; unlocked revision
873 ;; revision is locked by some user
877 ;; everything else: false
879 ;; unexpected information in
880 ;; keyword string --> quit
882 ;; search for $Revision
883 ;; --------------------
886 nil t)
887 ;; if found, store the revision number ...
889 ;; and see if there's any lock information
902 ;; else: nothing found
903 ;; -------------------
913 ;; If the file has headers, we don't want to query the
914 ;; master file, because that would eliminate all the
915 ;; performance gain the headers brought us. We therefore
916 ;; use a heuristic now to find out whether locking is used
917 ;; for this file. If we trust the file permissions, and the
918 ;; file is not locked, then if the file is read-only we
919 ;; assume that locking is used for the file, otherwise
920 ;; locking is not used.
926 status))))
929 "Compare release numbers, represented as strings.
930 Release components are assumed cardinal numbers, not decimal fractions
931 \(5.10 is a higher release than 5.9\). Omitted fields are considered
932 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
933 of the string is found, or a non-numeric component shows up \(5.6.7 is
935 some cases\). This code is suitable for existing RCS release numbers.
936 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
957 "Return t if we have RELEASE or better."
964 "Return the RCS release installed on this system, as a string.
965 Return symbol UNKNOWN if the release cannot be deducted. The user can
966 override this using variable `vc-rcs-release'.
968 If the user has not set variable `vc-rcs-release' and it is nil,
969 variable `vc-rcs-release' is set to the returned value."
987 "Parse current buffer, presumed to be in RCS-style masterfile format.
988 Optional arg BUFFER specifies another buffer to parse. Return an alist
989 of two elements, w/ keys `headers' and `revisions' and values in turn
990 sub-alists. For `headers', the values unless otherwise specified are
991 strings and the keys are:
993 desc -- description
994 head -- latest revision
996 absent if the head revision lies on the trunk
997 access -- ???
998 symbols -- sub-alist of (SYMBOL . REVISION) elements
1002 expand -- may be absent; ???
1004 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1005 with string values (unless otherwise specified) and keys:
1007 date -- a time value (like that returned by `encode-time'); as a
1008 special case, a year value less than 100 is augmented by 1900
1009 author -- username
1011 branches -- list of revisions that begin branches from this revision
1014 log -- change log entry
1015 text -- for the head revision on the trunk, the body of the file;
1016 other revisions have `:insn' instead
1017 :insn -- for non-head revisions, a list of parsed instructions
1020 - `(START k COUNT)' -- kill COUNT lines
1021 - `(START i TEXT)' -- insert TEXT (a string)
1022 The list is in descending order by START.
1024 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1027 ;; An RCS masterfile can be viewed as containing four regular (for the
1028 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1029 ;; the "description" and (d) the "rev bodies", in that order. In the
1030 ;; returned alist (see docstring), elements from (b) and (d) are
1031 ;; combined pairwise to form the "revisions", while those from (a) and
1032 ;; (c) are simply combined to form the "headers".
1033 ;;
1034 ;; Loosely speaking, each section contains a series of alternating
1035 ;; "tags" and "printed representations". In the (b) and (d), many
1036 ;; such series can appear, and a revision number on a line by itself
1037 ;; precedes the series of tags and printed representations associated
1038 ;; with it.
1039 ;;
1040 ;; In (a) and (b), the printed representations (with the exception of
1041 ;; the `comment' tag in the headers) terminate with a semicolon, which
1042 ;; is NOT part of the "value" finally associated with the tag. All
1043 ;; other printed representations are in "@@-format"; there is an "@",
1044 ;; the middle part (to be translated into the value), another "@" and
1045 ;; a newline. Each "@@" in the middle part indicates the position of
1046 ;; a single "@" (and consequently the requirement of an additional
1047 ;; initial step when translating to the value).
1048 ;;
1049 ;; Parser state includes vars that collect parts of the return value...
1051 ;; ... as well as vars that support a single-pass, tag-assisted,
1052 ;; minimal-data-copying scan. Basically -- skirting around the
1053 ;; grouping by revision required in (b) and (d) -- we repeatedly
1054 ;; and context-sensitively read a tag (that MUST be present),
1055 ;; determine the bounds of the printed representation, translate
1056 ;; it into a value, and push the tag plus value onto one of the
1057 ;; collection vars. Finally, we return the parse tree
1058 ;; incorporating the values of the collection vars (see "rv").
1059 ;;
1060 ;; A symbol or string to keep track of context (for error messages).
1061 context
1062 ;; A symbol, the current tag.
1063 tok
1064 ;; Region (begin and end buffer positions) of the printed
1065 ;; representation for the current tag.
1066 b e
1067 ;; A list of buffer positions where "@@" can be found within the
1068 ;; printed representation region. For each location, we push two
1069 ;; elements onto the list, 1+ and 2+ the location, respectively,
1070 ;; with the 2+ appearing at the head. In this way, the expression
1071 ;; `(,e ,@@-holes ,b)
1072 ;; describes regions that can be concatenated (in reverse order)
1073 ;; to "de-@@-format" the printed representation as the first step
1074 ;; to translating it into some value. See internal func `gather'.
1103 acc)
1107 acc)
1116 ;; headers
1130 two))
1136 t))
1137 headers)
1145 ;; rev headers
1154 b e)
1156 ;; Hack the year -- verified to be the
1157 ;; same algorithm used in RCS 5.7.
1167 revs)
1170 ;; desc
1173 ;; rev bodies
1175 ;; Element of `revs' that initially holds only header info.
1176 ;; "Pairwise combination" occurs when we add body info.
1177 rev
1178 ;; Components of the editing commands (aside from the actual
1179 ;; text) that comprise the `text' printed representations
1180 ;; (not including the "head" revision).
1181 cmd start act
1182 ;; Ascending (reversed) `@-holes' which the internal func
1183 ;; `incg' pops to effect incremental gathering.
1184 asc
1185 ;; Function to extract text (for the `a' command), either
1186 ;; `incg' or `buffer-substring-no-properties'. (This is
1187 ;; for speed; strictly speaking, it is sufficient to use
1188 ;; only the former since it behaves identically to the
1189 ;; latter in the absense of "@@".)
1190 sub)
1194 ;; Self-deprecate when work is done.
1195 ;; Folding many dimensions into one.
1196 ;; Thanks B.Mandelbrot, for complex sum.
1197 ;; O beauteous math! --the Unvexed Bum
1206 context))))
1208 ;; For rev body `text' tags, delay translation slightly...
1210 ;; ... until we decide which tag and value is appropriate to
1211 ;; collect. For the "head" revision, compute the value of the
1212 ;; `text' printed representation by simple `gather'. For all
1213 ;; other revisions, replace the `text' tag+value with `:insn'
1214 ;; plus value, always scanning in-place.
1230 (?d
1231 ;; `d' means "delete lines".
1232 ;; For Emacs spirit, we use `k' for "kill".
1234 (?a
1235 ;; `a' means "append after this line" but
1236 ;; internally we normalize it so that START
1237 ;; specifies the actual line for insert, thus
1238 ;; requiring less hair in the realization algs.
1239 ;; For Emacs spirit, we use `i' for "insert".
1244 cmd context)))
1245 acc))
1248 ;; rv
1254 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1255 ;;; vc-rcs.el ends here