| blob | 9d0550880ce2c0ff97329d0080468713223b1b06 |
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 of the License, or
16 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; See vc.el
30 ;;; Code:
32 ;;;
33 ;;; Customization options
34 ;;;
41 "*The release number of your RCS installation, as a string.
42 If nil, VC itself computes this value when it is first needed."
49 "*Extra switches for registering a file in RCS.
50 A string or list of strings. These are passed to the checkin program
56 string))
61 "*A string or list of strings specifying extra switches for rcsdiff under VC."
66 string))
71 "*Header keywords to be inserted by `vc-insert-headers'."
77 "*Indicates whether rcsdiff understands the --brief option.
78 The value is either `yes', `no', or nil. If it is nil, VC tries
79 to use --brief and sets this variable to remember whether it worked."
83 ;;;###autoload
86 "*Where to look for RCS master files.
87 For a description of possible values, see `vc-check-master-templates'."
92 function)))
96 \f
97 ;;; Properties of the backend
102 "RCS-specific version of `vc-checkout-model'."
104 result)
113 ;;;
114 ;;; State-querying functions
115 ;;;
117 ;; The autoload cookie below places vc-rcs-registered directly into
118 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
119 ;; every file that is visited.
120 ;;;###autoload
125 "Implementation of `vc-state' for RCS."
127 'unregistered
132 ;; vc-working-revision might not be known; in that case the
133 ;; property is nil. vc-rcs-fetch-master-state knows how to
134 ;; handle that.
139 state
141 'up-to-date
143 'unlocked-changes
147 "State heuristic for RCS."
154 ;; If the headers say that the file is not locked, the
155 ;; permissions can tell us whether locking is used for
156 ;; the file or not.
165 'edited
169 state)
180 'edited
181 owner-name)
183 'edited
186 ;; Strange permissions. Fall through to
187 ;; expensive state computation.
192 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
193 ;; should be changed to take a backend parameter. Using
194 ;; `vc-expand-dirs' is not TRTD because it returns files from
195 ;; multiple backends. It should also return 'unregistered files.
197 ;; Doing individual vc-state calls is painful but there
198 ;; is no better way in RCS-land.
210 "RCS-specific version of `vc-working-revision'."
219 "Return non-nil if workfile version of FILE is the latest on its branch.
220 When VERSION is given, perform check for that version."
226 ;; Compare VERSION to the head version number.
229 ;; If we are not on the trunk, we need to examine the
230 ;; whole current branch.
235 "RCS-specific implementation of `vc-workfile-unchanged-p'."
236 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
237 ;; do a double take and remember the fact for the future
248 ;; The workfile is unchanged if rcsdiff found no differences.
259 \f
260 ;;;
261 ;;; State-changing functions
262 ;;;
265 "Create a new RCS repository."
266 ;; RCS is totally file-oriented, so all we have to do is make the directory
270 "Register FILES into the RCS version-control system.
271 REV is the optional revision number for the files. COMMENT can be used
272 to provide an initial description for each FILES.
274 `vc-register-switches' and `vc-rcs-register-switches' are passed to
275 the RCS command (in that order).
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."
289 ;; if available, use the secure registering option
294 ;; parse output to find master file name and workfile version
301 ;; if we couldn't find the master name,
302 ;; run vc-rcs-registered to get it
303 ;; (will be stored into the vc-name property)
307 name
309 name
314 nil t)
318 "Return non-nil if RCS thinks it would be responsible for registering FILE."
319 ;; TODO: check for all the patterns in vc-rcs-master-templates
323 "Implementation of receive-file for RCS."
331 "Unregister FILE from RCS.
332 If this leaves the RCS subdirectory empty, ask the user
333 whether to remove it."
342 ;; check whether RCS dir is empty, i.e. it does not
343 ;; contain any files except "." and ".."
350 "RCS-specific version of `vc-backend-checkin'."
352 ;; Now operate on the files
356 ;; Force branch creation if an appropriate
357 ;; default branch has been set.
359 default-branch
361 default-branch)
367 ;; if available, use the secure check-in option
371 switches)
374 ;; determine the new workfile version
384 ;; if we got to a different branch, adjust the default
385 ;; branch accordingly
393 ;; If this is an old RCS release, we might have
394 ;; to remove a remaining lock.
396 ;; exit status of 1 is also accepted.
397 ;; It means that the lock was removed before.
409 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
410 attempt the checkout for all registered files beneath it."
414 switches)
417 ;; Change buffers to get local value of vc-checkout-switches.
420 ;; Save this buffer's default-directory
421 ;; and use save-excursion to make sure it is restored
422 ;; in the same buffer it was saved in.
425 ;; Adjust the default-directory so that the check-out creates
426 ;; the file in the right place.
429 ;; if we should go to the head of the trunk,
430 ;; clear the default branch first
433 ;; now do the checkout
436 ;; If locking is not strict, force to overwrite
437 ;; the writable workfile.
441 ;; a literal revision was specified
447 ;; no revision specified:
448 ;; use current workfile version
449 workrev
450 ;; REV is t ...
452 ;; ... go to head of current branch
454 ;; ... go to head of trunk
456 nil)
458 switches)
459 ;; determine the new workfile version
464 ;; if necessary, adjust the default branch
467 file
471 new-version)))))
475 "Roll back, undoing the most recent checkins of FILES. Directories are
476 expanded to all regidtered subfuiles in them."
485 discard file)))
489 ;; Check out the most recent remaining version. If it
490 ;; fails, because the whole branch got deleted, do a
491 ;; double-take and check out the version where the branch
492 ;; started.
504 ;; vc-do-command popped up a window with
505 ;; the error message. Get rid of it, by
506 ;; restoring the old window configuration.
508 ;; No, it was some other error: re-signal it.
512 "Revert FILE to the version it was based on. If FILE is a directory,
513 revert all registered files beneath it."
521 "Merge changes into current working copy of FILE.
522 The changes are between FIRST-VERSION and SECOND-VERSION."
529 "Steal the lock on the current workfile for FILE and revision REV.
530 If FUILEis a directory, steal the lock on all registered files beneath it.
531 Needs RCS 5.6.2 or later for -M."
535 ;; Do a real checkout after stealing the lock, so that we see
536 ;; expanded headers.
540 "Modify the change comments change on FILES on a specified REV. If FILE is a
541 directory the operation is applied to all registered files beneath it."
546 \f
547 ;;;
548 ;;; History functions
549 ;;;
552 "Get change log associated with FILE. If FILE is a
553 directory the operation is applied to all registered files beneath it."
557 "Get a difference report using RCS between two sets of files."
567 "Return a string with all log entries stored in BACKEND for FILE."
569 ;; Has to be written this way, this function is used by the CVS backend too
571 ;; Remove cruft
587 ;; Return the de-crufted comment list
591 "Annotate FILE, inserting the results in BUFFER.
592 Optional arg REVISION is a revision to annotate from."
594 ;; Aside from the "head revision on the trunk", the instructions for
595 ;; each revision on the trunk are an ordered list of kill and insert
596 ;; commands necessary to go from the chronologically-following
597 ;; revision to this one. That is, associated with revision N are
598 ;; edits that applied to revision N+1 would result in revision N.
599 ;;
600 ;; On a branch, however, (some) things are inverted: the commands
601 ;; listed are those necessary to go from the chronologically-preceding
602 ;; revision to this one. That is, associated with revision N are
603 ;; edits that applied to revision N-1 would result in revision N.
604 ;;
605 ;; So, to get per-line history info, we apply reverse-chronological
606 ;; edits, starting with the head revision on the trunk, all the way
607 ;; back through the initial revision (typically "1.1" or similar),
608 ;; then apply forward-chronological edits -- keeping track of which
609 ;; revision is associated with each inserted line -- until we reach
610 ;; the desired revision for display (which may be either on the trunk
611 ;; or on a branch).
616 ;; The revision N whose instructions we currently are processing.
618 ;; Alist from the parse tree for N.
620 ;; Point and temporary string, respectively.
621 p s
622 ;; "Next-branch list". Nil means the desired revision to
623 ;; display lives on the trunk. Non-nil means it lives on a
624 ;; branch, in which case the value is a list of revision pairs
625 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
626 ;; links each series of revisions in the path from the initial
627 ;; revision to the desired revision to display.
628 nbls
629 ;; "Path-accumulate-predicate plus revision/date/author".
630 ;; Until set, forward-chronological edits are not accumulated.
631 ;; Once set, its value (updated every revision) is used for
632 ;; the text property `:vc-rcs-r/d/a' for inserts during
633 ;; processing of forward-chronological instructions for N.
634 ;; See internal func `r/d/a'.
635 prda
636 ;; List of forward-chronological instructions, each of the
637 ;; form: (POS . ACTION), where POS is a buffer position. If
638 ;; ACTION is a string, it is inserted, otherwise it is taken as
639 ;; the number of characters to be deleted.
640 path
641 ;; N+1. When `cur' is "", this is the initial revision.
642 pre)
647 ;; Find which branches (if any) must be included in the edits.
649 bpt kids)
653 ;; A branchpoint may have multiple children. Find the right one.
657 ;; Start with the full text.
660 ;; Apply reverse-chronological edits on the trunk, computing and
661 ;; accumulating forward-chronological edits after some point, for
662 ;; later.
669 ;; Start accumulating the forward-chronological edits when N+1
670 ;; on the trunk is either the desired revision to display, or
671 ;; the appropriate branchpoint for it. Do this before
672 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
676 ;; Edits in the parse tree specify a line number (in the buffer
677 ;; *BEFORE* editing occurs) to start from, but line numbers
678 ;; change as a result of edits. To DTRT, we apply edits in
679 ;; order of descending buffer position so that edits further
680 ;; down in the buffer occur first w/o corrupting specified
681 ;; buffer positions of edits occurring towards the beginning of
682 ;; the buffer. In this way we avoid using markers. A pleasant
683 ;; property of this approach is ability to push instructions
684 ;; onto `path' directly, w/o need to maintain rev boundaries.
699 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
700 ;; equivalent to pushing an insert instruction (of the entire buffer
701 ;; contents) onto `path' then erasing the buffer, but less wasteful.
703 ;; Now apply the forward-chronological edits for the trunk.
709 ;; Now apply the forward-chronological edits (directly from the
710 ;; parse-tree) for the branch(es), if necessary. We re-use vars
711 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
716 prda nil)
729 ;; Lastly, for each line, insert at bol nicely-formatted history info.
730 ;; We do two passes to collect summary information used to minimize
731 ;; the annotation's usage of screen real-estate: (1) Consider rendered
732 ;; width of revision plus author together as a unit; and (2) Omit
733 ;; author entirely if all authors are the same as the user.
738 rda w a)
748 ht)
756 " "
758 ls)
759 :vc-annotate-prefix t
767 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).
831 \f
832 ;;;
833 ;;; Internal functions
834 ;;;
840 "Return non-nil if FILE is newer than its RCS master.
841 This likely means that FILE has been changed with respect
842 to its master version."
850 "Find most recent revision on BRANCH."
855 nil t)
864 "Compute the master file's idea of the state of FILE.
865 If a WORKFILE-VERSION is given, compute the state of that version,
866 otherwise determine the workfile version based on the master file.
867 This function sets the properties `vc-working-revision' and
868 `vc-checkout-model' to their correct values, based on the master
869 file."
879 ;; Workfile version not known yet. Determine that first. It
880 ;; is either the head of the trunk, the head of the default
881 ;; branch, or the "default branch" itself, if that is a full
882 ;; revision number.
884 ;; no default branch
889 ;; default branch is actually a revision
891 default-branch)
893 ;; else, search for the head of the default branch
899 ;; Check strict locking
904 ;; Compute state of workfile version
912 ;; not locked
916 ;; workfile version is latest on branch
917 'up-to-date
918 ;; workfile version is not latest on branch
920 ;; locked by the calling user
923 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
925 workfile-is-latest
927 'edited
928 ;; Locking is not used for the file, but the owner does
929 ;; have a lock, and there is a higher version on the current
930 ;; branch. Not sure if this can occur, and if it is right
931 ;; to use `needs-merge' in this case.
933 ;; locked by somebody else
935 locking-user)
940 "Search for RCS headers in FILE, and set properties accordingly.
942 Returns: nil if no headers were found
943 'rev if a workfile revision was found
944 'rev-and-lock if revision and lock info was found"
952 ;; search for $Id or $Header
953 ;; -------------------------
954 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
961 ;; if found, store the revision number ...
963 ;; ... and check for the locking state
971 ;; unlocked revision
975 ;; revision is locked by some user
979 ;; everything else: false
981 ;; unexpected information in
982 ;; keyword string --> quit
984 ;; search for $Revision
985 ;; --------------------
988 nil t)
989 ;; if found, store the revision number ...
991 ;; and see if there's any lock information
1004 ;; else: nothing found
1005 ;; -------------------
1015 ;; If the file has headers, we don't want to query the
1016 ;; master file, because that would eliminate all the
1017 ;; performance gain the headers brought us. We therefore
1018 ;; use a heuristic now to find out whether locking is used
1019 ;; for this file. If we trust the file permissions, and the
1020 ;; file is not locked, then if the file is read-only we
1021 ;; assume that locking is used for the file, otherwise
1022 ;; locking is not used.
1028 status))))
1031 "Compare release numbers, represented as strings.
1032 Release components are assumed cardinal numbers, not decimal fractions
1033 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1034 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1035 of the string is found, or a non-numeric component shows up \(5.6.7 is
1037 some cases\). This code is suitable for existing RCS release numbers.
1038 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1059 "Return t if we have RELEASE or better."
1066 "Return the RCS release installed on this system, as a string.
1067 Return symbol UNKNOWN if the release cannot be deducted. The user can
1068 override this using variable `vc-rcs-release'.
1070 If the user has not set variable `vc-rcs-release' and it is nil,
1071 variable `vc-rcs-release' is set to the returned value."
1089 "Parse current buffer, presumed to be in RCS-style masterfile format.
1090 Optional arg BUFFER specifies another buffer to parse. Return an alist
1091 of two elements, w/ keys `headers' and `revisions' and values in turn
1092 sub-alists. For `headers', the values unless otherwise specified are
1093 strings and the keys are:
1095 desc -- description
1096 head -- latest revision
1098 absent if the head revision lies on the trunk
1099 access -- ???
1100 symbols -- sub-alist of (SYMBOL . REVISION) elements
1104 expand -- may be absent; ???
1106 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1107 with string values (unless otherwise specified) and keys:
1109 date -- a time value (like that returned by `encode-time'); as a
1110 special case, a year value less than 100 is augmented by 1900
1111 author -- username
1113 branches -- list of revisions that begin branches from this revision
1116 log -- change log entry
1117 text -- for the head revision on the trunk, the body of the file;
1118 other revisions have `:insn' instead
1119 :insn -- for non-head revisions, a list of parsed instructions
1122 - `(START k COUNT)' -- kill COUNT lines
1123 - `(START i TEXT)' -- insert TEXT (a string)
1124 The list is in descending order by START.
1126 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1129 ;; An RCS masterfile can be viewed as containing four regular (for the
1130 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1131 ;; the "description" and (d) the "rev bodies", in that order. In the
1132 ;; returned alist (see docstring), elements from (b) and (d) are
1133 ;; combined pairwise to form the "revisions", while those from (a) and
1134 ;; (c) are simply combined to form the "headers".
1135 ;;
1136 ;; Loosely speaking, each section contains a series of alternating
1137 ;; "tags" and "printed representations". In the (b) and (d), many
1138 ;; such series can appear, and a revision number on a line by itself
1139 ;; precedes the series of tags and printed representations associated
1140 ;; with it.
1141 ;;
1142 ;; In (a) and (b), the printed representations (with the exception of
1143 ;; the `comment' tag in the headers) terminate with a semicolon, which
1144 ;; is NOT part of the "value" finally associated with the tag. All
1145 ;; other printed representations are in "@@-format"; there is an "@",
1146 ;; the middle part (to be translated into the value), another "@" and
1147 ;; a newline. Each "@@" in the middle part indicates the position of
1148 ;; a single "@" (and consequently the requirement of an additional
1149 ;; initial step when translating to the value).
1150 ;;
1151 ;; Parser state includes vars that collect parts of the return value...
1153 ;; ... as well as vars that support a single-pass, tag-assisted,
1154 ;; minimal-data-copying scan. Basically -- skirting around the
1155 ;; grouping by revision required in (b) and (d) -- we repeatedly
1156 ;; and context-sensitively read a tag (that MUST be present),
1157 ;; determine the bounds of the printed representation, translate
1158 ;; it into a value, and push the tag plus value onto one of the
1159 ;; collection vars. Finally, we return the parse tree
1160 ;; incorporating the values of the collection vars (see "rv").
1161 ;;
1162 ;; A symbol or string to keep track of context (for error messages).
1163 context
1164 ;; A symbol, the current tag.
1165 tok
1166 ;; Region (begin and end buffer positions) of the printed
1167 ;; representation for the current tag.
1168 b e
1169 ;; A list of buffer positions where "@@" can be found within the
1170 ;; printed representation region. For each location, we push two
1171 ;; elements onto the list, 1+ and 2+ the location, respectively,
1172 ;; with the 2+ appearing at the head. In this way, the expression
1173 ;; `(,e ,@@-holes ,b)
1174 ;; describes regions that can be concatenated (in reverse order)
1175 ;; to "de-@@-format" the printed representation as the first step
1176 ;; to translating it into some value. See internal func `gather'.
1205 acc)
1209 acc)
1218 ;; headers
1232 two))
1238 t))
1239 headers)
1247 ;; rev headers
1256 b e)
1258 ;; Hack the year -- verified to be the
1259 ;; same algorithm used in RCS 5.7.
1269 revs)
1272 ;; desc
1275 ;; rev bodies
1277 ;; Element of `revs' that initially holds only header info.
1278 ;; "Pairwise combination" occurs when we add body info.
1279 rev
1280 ;; Components of the editing commands (aside from the actual
1281 ;; text) that comprise the `text' printed representations
1282 ;; (not including the "head" revision).
1283 cmd start act
1284 ;; Ascending (reversed) `@-holes' which the internal func
1285 ;; `incg' pops to effect incremental gathering.
1286 asc
1287 ;; Function to extract text (for the `a' command), either
1288 ;; `incg' or `buffer-substring-no-properties'. (This is
1289 ;; for speed; strictly speaking, it is sufficient to use
1290 ;; only the former since it behaves identically to the
1291 ;; latter in the absense of "@@".)
1292 sub)
1296 ;; Self-deprecate when work is done.
1297 ;; Folding many dimensions into one.
1298 ;; Thanks B.Mandelbrot, for complex sum.
1299 ;; O beauteous math! --the Unvexed Bum
1308 context))))
1310 ;; For rev body `text' tags, delay translation slightly...
1312 ;; ... until we decide which tag and value is appropriate to
1313 ;; collect. For the "head" revision, compute the value of the
1314 ;; `text' printed representation by simple `gather'. For all
1315 ;; other revisions, replace the `text' tag+value with `:insn'
1316 ;; plus value, always scanning in-place.
1332 (?d
1333 ;; `d' means "delete lines".
1334 ;; For Emacs spirit, we use `k' for "kill".
1336 (?a
1337 ;; `a' means "append after this line" but
1338 ;; internally we normalize it so that START
1339 ;; specifies the actual line for insert, thus
1340 ;; requiring less hair in the realization algs.
1341 ;; For Emacs spirit, we use `i' for "insert".
1346 cmd context)))
1347 acc))
1350 ;; rv
1356 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1357 ;;; vc-rcs.el ends here