| blob | b20240b25b740acfd668a9a2ea406d72eaf3e95f |
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 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 3, 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 ;; TODO:
33 ;; - remove call to vc-expand-dirs by implementing our own (which can just
34 ;; list the RCS subdir instead).
36 ;;; Code:
38 ;;;
39 ;;; Customization options
40 ;;;
47 "*The release number of your RCS installation, as a string.
48 If nil, VC itself computes this value when it is first needed."
55 "*Extra switches for registering a file in RCS.
56 A string or list of strings. These are passed to the checkin program
62 string))
67 "*A string or list of strings specifying extra switches for rcsdiff under VC."
72 string))
77 "*Header keywords to be inserted by `vc-insert-headers'."
83 "*Indicates whether rcsdiff understands the --brief option.
84 The value is either `yes', `no', or nil. If it is nil, VC tries
85 to use --brief and sets this variable to remember whether it worked."
89 ;;;###autoload
92 "*Where to look for RCS master files.
93 For a description of possible values, see `vc-check-master-templates'."
98 function)))
102 \f
103 ;;; Properties of the backend
108 ;;;
109 ;;; State-querying functions
110 ;;;
112 ;;; The autoload cookie below places vc-rcs-registered directly into
113 ;;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
114 ;;; every file that is visited. The definition is repeated below
115 ;;; so that Help and etags can find it.
117 ;;;###autoload (defun vc-rcs-registered (f) (vc-default-registered 'RCS f))
121 "Implementation of `vc-state' for RCS."
126 ;; vc-working-revision might not be known; in that case the
127 ;; property is nil. vc-rcs-fetch-master-state knows how to
128 ;; handle that.
133 state
135 'up-to-date
137 'unlocked-changes
141 "State heuristic for RCS."
148 ;; If the headers say that the file is not locked, the
149 ;; permissions can tell us whether locking is used for
150 ;; the file or not.
158 'edited
162 state)
173 'edited
174 owner-name)
176 'edited
179 ;; Strange permissions. Fall through to
180 ;; expensive state computation.
185 "RCS-specific version of `vc-working-revision'."
194 "Return non-nil if workfile version of FILE is the latest on its branch.
195 When VERSION is given, perform check for that version."
201 ;; Compare VERSION to the head version number.
204 ;; If we are not on the trunk, we need to examine the
205 ;; whole current branch.
210 "RCS-specific version of `vc-checkout-model'."
221 "RCS-specific implementation of `vc-workfile-unchanged-p'."
222 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
223 ;; do a double take and remember the fact for the future
234 ;; The workfile is unchanged if rcsdiff found no differences.
245 \f
246 ;;;
247 ;;; State-changing functions
248 ;;;
251 "Create a new RCS repository."
252 ;; RCS is totally file-oriented, so all we have to do is make the directory
256 "Register FILES into the RCS version-control system.
257 REV is the optional revision number for the files. COMMENT can be used
258 to provide an initial description for each FILES.
260 `vc-register-switches' and `vc-rcs-register-switches' are passed to
261 the RCS command (in that order).
263 Automatically retrieve a read-only version of the file with keywords
264 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
275 ;; if available, use the secure registering option
280 ;; parse output to find master file name and workfile version
287 ;; if we couldn't find the master name,
288 ;; run vc-rcs-registered to get it
289 ;; (will be stored into the vc-name property)
293 name
295 name
300 nil t)
304 "Return non-nil if RCS thinks it would be responsible for registering FILE."
305 ;; TODO: check for all the patterns in vc-rcs-master-templates
309 "Implementation of receive-file for RCS."
317 "Unregister FILE from RCS.
318 If this leaves the RCS subdirectory empty, ask the user
319 whether to remove it."
328 ;; check whether RCS dir is empty, i.e. it does not
329 ;; contain any files except "." and ".."
336 "RCS-specific version of `vc-backend-checkin'."
338 ;; Now operate on the files
342 ;; Force branch creation if an appropriate
343 ;; default branch has been set.
345 default-branch
347 default-branch)
353 ;; if available, use the secure check-in option
357 switches)
360 ;; determine the new workfile version
370 ;; if we got to a different branch, adjust the default
371 ;; branch accordingly
379 ;; If this is an old RCS release, we might have
380 ;; to remove a remaining lock.
382 ;; exit status of 1 is also accepted.
383 ;; It means that the lock was removed before.
395 "Retrieve a copy of a saved version of FILE."
397 switches)
400 ;; Change buffers to get local value of vc-checkout-switches.
403 ;; Save this buffer's default-directory
404 ;; and use save-excursion to make sure it is restored
405 ;; in the same buffer it was saved in.
408 ;; Adjust the default-directory so that the check-out creates
409 ;; the file in the right place.
412 ;; if we should go to the head of the trunk,
413 ;; clear the default branch first
416 ;; now do the checkout
419 ;; If locking is not strict, force to overwrite
420 ;; the writable workfile.
424 ;; a literal revision was specified
430 ;; no revision specified:
431 ;; use current workfile version
432 workrev
433 ;; REV is t ...
435 ;; ... go to head of current branch
437 ;; ... go to head of trunk
439 nil)
441 switches)
442 ;; determine the new workfile version
447 ;; if necessary, adjust the default branch
450 file
454 new-version)))))
458 "Roll back, undoing the most recent checkins of FILES."
467 discard file)))
471 ;; Check out the most recent remaining version. If it
472 ;; fails, because the whole branch got deleted, do a
473 ;; double-take and check out the version where the branch
474 ;; started.
486 ;; vc-do-command popped up a window with
487 ;; the error message. Get rid of it, by
488 ;; restoring the old window configuration.
490 ;; No, it was some other error: re-signal it.
494 "Revert FILE to the version it was based on."
500 "Merge changes into current working copy of FILE.
501 The changes are between FIRST-VERSION and SECOND-VERSION."
508 "Steal the lock on the current workfile for FILE and revision REV.
509 Needs RCS 5.6.2 or later for -M."
511 ;; Do a real checkout after stealing the lock, so that we see
512 ;; expanded headers.
516 "Modify the change comments change on FILES on a specified REV."
521 \f
522 ;;;
523 ;;; History functions
524 ;;;
527 "Get change log associated with FILE."
531 "Get a difference report using RCS between two sets of files."
541 "Remove all non-comment information from log output."
559 "Annotate FILE, inserting the results in BUFFER.
560 Optional arg REVISION is a revision to annotate from."
562 ;; Aside from the "head revision on the trunk", the instructions for
563 ;; each revision on the trunk are an ordered list of kill and insert
564 ;; commands necessary to go from the chronologically-following
565 ;; revision to this one. That is, associated with revision N are
566 ;; edits that applied to revision N+1 would result in revision N.
567 ;;
568 ;; On a branch, however, (some) things are inverted: the commands
569 ;; listed are those necessary to go from the chronologically-preceding
570 ;; revision to this one. That is, associated with revision N are
571 ;; edits that applied to revision N-1 would result in revision N.
572 ;;
573 ;; So, to get per-line history info, we apply reverse-chronological
574 ;; edits, starting with the head revision on the trunk, all the way
575 ;; back through the initial revision (typically "1.1" or similar),
576 ;; then apply forward-chronological edits -- keeping track of which
577 ;; revision is associated with each inserted line -- until we reach
578 ;; the desired revision for display (which may be either on the trunk
579 ;; or on a branch).
584 ;; The revision N whose instructions we currently are processing.
586 ;; Alist from the parse tree for N.
588 ;; Point and temporary string, respectively.
589 p s
590 ;; "Next-branch list". Nil means the desired revision to
591 ;; display lives on the trunk. Non-nil means it lives on a
592 ;; branch, in which case the value is a list of revision pairs
593 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
594 ;; links each series of revisions in the path from the initial
595 ;; revision to the desired revision to display.
596 nbls
597 ;; "Path-accumulate-predicate plus revision/date/author".
598 ;; Until set, forward-chronological edits are not accumulated.
599 ;; Once set, its value (updated every revision) is used for
600 ;; the text property `:vc-rcs-r/d/a' for inserts during
601 ;; processing of forward-chronological instructions for N.
602 ;; See internal func `r/d/a'.
603 prda
604 ;; List of forward-chronological instructions, each of the
605 ;; form: (POS . ACTION), where POS is a buffer position. If
606 ;; ACTION is a string, it is inserted, otherwise it is taken as
607 ;; the number of characters to be deleted.
608 path
609 ;; N+1. When `cur' is "", this is the initial revision.
610 pre)
615 ;; Find which branches (if any) must be included in the edits.
617 bpt kids)
621 ;; A branchpoint may have multiple children. Find the right one.
625 ;; Start with the full text.
628 ;; Apply reverse-chronological edits on the trunk, computing and
629 ;; accumulating forward-chronological edits after some point, for
630 ;; later.
637 ;; Start accumulating the forward-chronological edits when N+1
638 ;; on the trunk is either the desired revision to display, or
639 ;; the appropriate branchpoint for it. Do this before
640 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
644 ;; Edits in the parse tree specify a line number (in the buffer
645 ;; *BEFORE* editing occurs) to start from, but line numbers
646 ;; change as a result of edits. To DTRT, we apply edits in
647 ;; order of descending buffer position so that edits further
648 ;; down in the buffer occur first w/o corrupting specified
649 ;; buffer positions of edits occurring towards the beginning of
650 ;; the buffer. In this way we avoid using markers. A pleasant
651 ;; property of this approach is ability to push instructions
652 ;; onto `path' directly, w/o need to maintain rev boundaries.
667 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
668 ;; equivalent to pushing an insert instruction (of the entire buffer
669 ;; contents) onto `path' then erasing the buffer, but less wasteful.
671 ;; Now apply the forward-chronological edits for the trunk.
677 ;; Now apply the forward-chronological edits (directly from the
678 ;; parse-tree) for the branch(es), if necessary. We re-use vars
679 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
684 prda nil)
697 ;; Lastly, for each line, insert at bol nicely-formatted history info.
698 ;; We do two passes to collect summary information used to minimize
699 ;; the annotation's usage of screen real-estate: (1) Consider rendered
700 ;; width of revision plus author together as a unit; and (2) Omit
701 ;; author entirely if all authors are the same as the user.
706 rda w a)
716 ht)
724 " "
726 ls)
727 :vc-annotate-prefix t
735 ht)))
741 "Return the current time, based at midnight of the current day, and
742 encoded as fractional days."
747 "Return the time of the next annotation (as fraction of days)
748 systime, or nil if there is none. Also, reposition point."
757 \f
758 ;;;
759 ;;; Snapshot system
760 ;;;
763 "Assign to FILE's latest version a given NAME."
766 \f
767 ;;;
768 ;;; Miscellaneous
769 ;;;
772 "Check if the current file has any headers in it."
779 "Implementation of vc-clear-headers for RCS."
785 nil t)
789 ;; Just move the master file (using vc-rcs-master-templates).
792 \f
793 ;;;
794 ;;; Internal functions
795 ;;;
801 "Return non-nil if FILE is newer than its RCS master.
802 This likely means that FILE has been changed with respect
803 to its master version."
811 "Find most recent revision on BRANCH."
816 nil t)
825 "Compute the master file's idea of the state of FILE.
826 If a WORKFILE-VERSION is given, compute the state of that version,
827 otherwise determine the workfile version based on the master file.
828 This function sets the properties `vc-working-revision' and
829 `vc-checkout-model' to their correct values, based on the master
830 file."
840 ;; Workfile version not known yet. Determine that first. It
841 ;; is either the head of the trunk, the head of the default
842 ;; branch, or the "default branch" itself, if that is a full
843 ;; revision number.
845 ;; no default branch
850 ;; default branch is actually a revision
852 default-branch)
854 ;; else, search for the head of the default branch
860 ;; Check strict locking
865 ;; Compute state of workfile version
873 ;; not locked
877 ;; workfile version is latest on branch
878 'up-to-date
879 ;; workfile version is not latest on branch
881 ;; locked by the calling user
885 workfile-is-latest
887 'edited
888 ;; Locking is not used for the file, but the owner does
889 ;; have a lock, and there is a higher version on the current
890 ;; branch. Not sure if this can occur, and if it is right
891 ;; to use `needs-merge' in this case.
893 ;; locked by somebody else
895 locking-user)
900 "Search for RCS headers in FILE, and set properties accordingly.
902 Returns: nil if no headers were found
903 'rev if a workfile revision was found
904 'rev-and-lock if revision and lock info was found"
912 ;; search for $Id or $Header
913 ;; -------------------------
914 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
921 ;; if found, store the revision number ...
923 ;; ... and check for the locking state
931 ;; unlocked revision
935 ;; revision is locked by some user
939 ;; everything else: false
941 ;; unexpected information in
942 ;; keyword string --> quit
944 ;; search for $Revision
945 ;; --------------------
948 nil t)
949 ;; if found, store the revision number ...
951 ;; and see if there's any lock information
964 ;; else: nothing found
965 ;; -------------------
975 ;; If the file has headers, we don't want to query the
976 ;; master file, because that would eliminate all the
977 ;; performance gain the headers brought us. We therefore
978 ;; use a heuristic now to find out whether locking is used
979 ;; for this file. If we trust the file permissions, and the
980 ;; file is not locked, then if the file is read-only we
981 ;; assume that locking is used for the file, otherwise
982 ;; locking is not used.
988 status))))
991 "Compare release numbers, represented as strings.
992 Release components are assumed cardinal numbers, not decimal fractions
993 \(5.10 is a higher release than 5.9\). Omitted fields are considered
994 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
995 of the string is found, or a non-numeric component shows up \(5.6.7 is
997 some cases\). This code is suitable for existing RCS release numbers.
998 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1019 "Return t if we have RELEASE or better."
1026 "Return the RCS release installed on this system, as a string.
1027 Return symbol UNKNOWN if the release cannot be deducted. The user can
1028 override this using variable `vc-rcs-release'.
1030 If the user has not set variable `vc-rcs-release' and it is nil,
1031 variable `vc-rcs-release' is set to the returned value."
1049 "Parse current buffer, presumed to be in RCS-style masterfile format.
1050 Optional arg BUFFER specifies another buffer to parse. Return an alist
1051 of two elements, w/ keys `headers' and `revisions' and values in turn
1052 sub-alists. For `headers', the values unless otherwise specified are
1053 strings and the keys are:
1055 desc -- description
1056 head -- latest revision
1058 absent if the head revision lies on the trunk
1059 access -- ???
1060 symbols -- sub-alist of (SYMBOL . REVISION) elements
1064 expand -- may be absent; ???
1066 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1067 with string values (unless otherwise specified) and keys:
1069 date -- a time value (like that returned by `encode-time'); as a
1070 special case, a year value less than 100 is augmented by 1900
1071 author -- username
1073 branches -- list of revisions that begin branches from this revision
1076 log -- change log entry
1077 text -- for the head revision on the trunk, the body of the file;
1078 other revisions have `:insn' instead
1079 :insn -- for non-head revisions, a list of parsed instructions
1082 - `(START k COUNT)' -- kill COUNT lines
1083 - `(START i TEXT)' -- insert TEXT (a string)
1084 The list is in descending order by START.
1086 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1089 ;; An RCS masterfile can be viewed as containing four regular (for the
1090 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1091 ;; the "description" and (d) the "rev bodies", in that order. In the
1092 ;; returned alist (see docstring), elements from (b) and (d) are
1093 ;; combined pairwise to form the "revisions", while those from (a) and
1094 ;; (c) are simply combined to form the "headers".
1095 ;;
1096 ;; Loosely speaking, each section contains a series of alternating
1097 ;; "tags" and "printed representations". In the (b) and (d), many
1098 ;; such series can appear, and a revision number on a line by itself
1099 ;; precedes the series of tags and printed representations associated
1100 ;; with it.
1101 ;;
1102 ;; In (a) and (b), the printed representations (with the exception of
1103 ;; the `comment' tag in the headers) terminate with a semicolon, which
1104 ;; is NOT part of the "value" finally associated with the tag. All
1105 ;; other printed representations are in "@@-format"; there is an "@",
1106 ;; the middle part (to be translated into the value), another "@" and
1107 ;; a newline. Each "@@" in the middle part indicates the position of
1108 ;; a single "@" (and consequently the requirement of an additional
1109 ;; initial step when translating to the value).
1110 ;;
1111 ;; Parser state includes vars that collect parts of the return value...
1113 ;; ... as well as vars that support a single-pass, tag-assisted,
1114 ;; minimal-data-copying scan. Basically -- skirting around the
1115 ;; grouping by revision required in (b) and (d) -- we repeatedly
1116 ;; and context-sensitively read a tag (that MUST be present),
1117 ;; determine the bounds of the printed representation, translate
1118 ;; it into a value, and push the tag plus value onto one of the
1119 ;; collection vars. Finally, we return the parse tree
1120 ;; incorporating the values of the collection vars (see "rv").
1121 ;;
1122 ;; A symbol or string to keep track of context (for error messages).
1123 context
1124 ;; A symbol, the current tag.
1125 tok
1126 ;; Region (begin and end buffer positions) of the printed
1127 ;; representation for the current tag.
1128 b e
1129 ;; A list of buffer positions where "@@" can be found within the
1130 ;; printed representation region. For each location, we push two
1131 ;; elements onto the list, 1+ and 2+ the location, respectively,
1132 ;; with the 2+ appearing at the head. In this way, the expression
1133 ;; `(,e ,@@-holes ,b)
1134 ;; describes regions that can be concatenated (in reverse order)
1135 ;; to "de-@@-format" the printed representation as the first step
1136 ;; to translating it into some value. See internal func `gather'.
1165 acc)
1169 acc)
1178 ;; headers
1192 two))
1198 t))
1199 headers)
1207 ;; rev headers
1216 b e)
1218 ;; Hack the year -- verified to be the
1219 ;; same algorithm used in RCS 5.7.
1229 revs)
1232 ;; desc
1235 ;; rev bodies
1237 ;; Element of `revs' that initially holds only header info.
1238 ;; "Pairwise combination" occurs when we add body info.
1239 rev
1240 ;; Components of the editing commands (aside from the actual
1241 ;; text) that comprise the `text' printed representations
1242 ;; (not including the "head" revision).
1243 cmd start act
1244 ;; Ascending (reversed) `@-holes' which the internal func
1245 ;; `incg' pops to effect incremental gathering.
1246 asc
1247 ;; Function to extract text (for the `a' command), either
1248 ;; `incg' or `buffer-substring-no-properties'. (This is
1249 ;; for speed; strictly speaking, it is sufficient to use
1250 ;; only the former since it behaves identically to the
1251 ;; latter in the absense of "@@".)
1252 sub)
1256 ;; Self-deprecate when work is done.
1257 ;; Folding many dimensions into one.
1258 ;; Thanks B.Mandelbrot, for complex sum.
1259 ;; O beauteous math! --the Unvexed Bum
1268 context))))
1270 ;; For rev body `text' tags, delay translation slightly...
1272 ;; ... until we decide which tag and value is appropriate to
1273 ;; collect. For the "head" revision, compute the value of the
1274 ;; `text' printed representation by simple `gather'. For all
1275 ;; other revisions, replace the `text' tag+value with `:insn'
1276 ;; plus value, always scanning in-place.
1292 (?d
1293 ;; `d' means "delete lines".
1294 ;; For Emacs spirit, we use `k' for "kill".
1296 (?a
1297 ;; `a' means "append after this line" but
1298 ;; internally we normalize it so that START
1299 ;; specifies the actual line for insert, thus
1300 ;; requiring less hair in the realization algs.
1301 ;; For Emacs spirit, we use `i' for "insert".
1306 cmd context)))
1307 acc))
1310 ;; rv
1316 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1317 ;;; vc-rcs.el ends here