| blob | 2d486cd56d16edf8b785f2ae8940fe58b0153bdb |
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 ;; 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."
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 registered subfiles 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 FILE is 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 ;;;
563 "Get change log associated with FILE. If FILE is a
564 directory the operation is applied to all registered files beneath it."
570 "Get a difference report using RCS between two sets of files."
580 "Return a string with all log entries stored in BACKEND for FILE."
582 ;; Has to be written this way, this function is used by the CVS backend too
584 ;; Remove cruft
600 ;; Return the de-crufted comment list
604 "Annotate FILE, inserting the results in BUFFER.
605 Optional arg REVISION is a revision to annotate from."
607 ;; Aside from the "head revision on the trunk", the instructions for
608 ;; each revision on the trunk are an ordered list of kill and insert
609 ;; commands necessary to go from the chronologically-following
610 ;; revision to this one. That is, associated with revision N are
611 ;; edits that applied to revision N+1 would result in revision N.
612 ;;
613 ;; On a branch, however, (some) things are inverted: the commands
614 ;; listed are those necessary to go from the chronologically-preceding
615 ;; revision to this one. That is, associated with revision N are
616 ;; edits that applied to revision N-1 would result in revision N.
617 ;;
618 ;; So, to get per-line history info, we apply reverse-chronological
619 ;; edits, starting with the head revision on the trunk, all the way
620 ;; back through the initial revision (typically "1.1" or similar),
621 ;; then apply forward-chronological edits -- keeping track of which
622 ;; revision is associated with each inserted line -- until we reach
623 ;; the desired revision for display (which may be either on the trunk
624 ;; or on a branch).
629 ;; The revision N whose instructions we currently are processing.
631 ;; Alist from the parse tree for N.
633 ;; Point and temporary string, respectively.
634 p s
635 ;; "Next-branch list". Nil means the desired revision to
636 ;; display lives on the trunk. Non-nil means it lives on a
637 ;; branch, in which case the value is a list of revision pairs
638 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
639 ;; links each series of revisions in the path from the initial
640 ;; revision to the desired revision to display.
641 nbls
642 ;; "Path-accumulate-predicate plus revision/date/author".
643 ;; Until set, forward-chronological edits are not accumulated.
644 ;; Once set, its value (updated every revision) is used for
645 ;; the text property `:vc-rcs-r/d/a' for inserts during
646 ;; processing of forward-chronological instructions for N.
647 ;; See internal func `r/d/a'.
648 prda
649 ;; List of forward-chronological instructions, each of the
650 ;; form: (POS . ACTION), where POS is a buffer position. If
651 ;; ACTION is a string, it is inserted, otherwise it is taken as
652 ;; the number of characters to be deleted.
653 path
654 ;; N+1. When `cur' is "", this is the initial revision.
655 pre)
660 ;; Find which branches (if any) must be included in the edits.
662 bpt kids)
666 ;; A branchpoint may have multiple children. Find the right one.
670 ;; Start with the full text.
673 ;; Apply reverse-chronological edits on the trunk, computing and
674 ;; accumulating forward-chronological edits after some point, for
675 ;; later.
682 ;; Start accumulating the forward-chronological edits when N+1
683 ;; on the trunk is either the desired revision to display, or
684 ;; the appropriate branchpoint for it. Do this before
685 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
689 ;; Edits in the parse tree specify a line number (in the buffer
690 ;; *BEFORE* editing occurs) to start from, but line numbers
691 ;; change as a result of edits. To DTRT, we apply edits in
692 ;; order of descending buffer position so that edits further
693 ;; down in the buffer occur first w/o corrupting specified
694 ;; buffer positions of edits occurring towards the beginning of
695 ;; the buffer. In this way we avoid using markers. A pleasant
696 ;; property of this approach is ability to push instructions
697 ;; onto `path' directly, w/o need to maintain rev boundaries.
713 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
714 ;; equivalent to pushing an insert instruction (of the entire buffer
715 ;; contents) onto `path' then erasing the buffer, but less wasteful.
717 ;; Now apply the forward-chronological edits for the trunk.
723 ;; Now apply the forward-chronological edits (directly from the
724 ;; parse-tree) for the branch(es), if necessary. We re-use vars
725 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
730 prda nil)
744 ;; Lastly, for each line, insert at bol nicely-formatted history info.
745 ;; We do two passes to collect summary information used to minimize
746 ;; the annotation's usage of screen real-estate: (1) Consider rendered
747 ;; width of revision plus author together as a unit; and (2) Omit
748 ;; author entirely if all authors are the same as the user.
753 rda w a)
763 ht)
771 " "
773 ls)
774 :vc-annotate-prefix t
782 ht)))
790 "Return the current time, based at midnight of the current day, and
791 encoded as fractional days."
796 "Return the time of the next annotation (as fraction of days)
797 systime, or nil if there is none. Also, reposition point."
806 \f
807 ;;;
808 ;;; Tag system
809 ;;;
818 dir
822 \f
823 ;;;
824 ;;; Miscellaneous
825 ;;;
828 "Return t if REV is a revision on the trunk."
832 "Return the minor revision number of a revision number REV."
837 "Return the revision number immediately preceding REV for FILE,
838 or nil if there is no previous revision. This default
839 implementation works for MAJOR.MINOR-style revision numbers as
840 used by RCS and CVS."
845 ;; revision does probably not start a branch or release
848 ;; we are at the beginning of the trunk --
849 ;; don't know anything to return here
850 nil
851 ;; we are at the beginning of a branch --
852 ;; return revision of starting point
856 "Return the revision number immediately following REV for FILE,
857 or nil if there is no next revision. This default implementation
858 works for MAJOR.MINOR-style revision numbers as used by RCS
859 and CVS."
866 "Default implementation of update-changelog.
867 Uses `rcs2log' which only works for RCS and CVS."
868 ;; FIXME: We (c|sh)ould add support for cvs2cl
871 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
875 temporary-file-directory))))
883 user-mail-address)))
897 exec-directory)
899 "-c" changelog
907 files)))
908 "done"
917 "Check if the current file has any headers in it."
924 "Implementation of vc-clear-headers for RCS."
930 nil t)
934 ;; Just move the master file (using vc-rcs-master-templates).
938 ;; If the file is locked by some other user, make
939 ;; the buffer read-only. Like this, even root
940 ;; cannot modify a file that someone else has locked.
944 \f
945 ;;;
946 ;;; Internal functions
947 ;;;
950 "Return non-nil if FILE is newer than its RCS master.
951 This likely means that FILE has been changed with respect
952 to its master version."
960 "Find most recent revision on BRANCH."
965 nil t)
974 "Compute the master file's idea of the state of FILE.
975 If a WORKING-REVISION is given, compute the state of that version,
976 otherwise determine the workfile version based on the master file.
977 This function sets the properties `vc-working-revision' and
978 `vc-checkout-model' to their correct values, based on the master
979 file."
989 ;; Workfile version not known yet. Determine that first. It
990 ;; is either the head of the trunk, the head of the default
991 ;; branch, or the "default branch" itself, if that is a full
992 ;; revision number.
994 ;; no default branch
999 ;; default branch is actually a revision
1001 default-branch)
1003 ;; else, search for the head of the default branch
1009 ;; Check strict locking
1014 ;; Compute state of workfile version
1022 ;; not locked
1026 ;; workfile version is latest on branch
1027 'up-to-date
1028 ;; workfile version is not latest on branch
1030 ;; locked by the calling user
1033 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1035 workfile-is-latest
1037 'edited
1038 ;; Locking is not used for the file, but the owner does
1039 ;; have a lock, and there is a higher version on the current
1040 ;; branch. Not sure if this can occur, and if it is right
1041 ;; to use `needs-merge' in this case.
1043 ;; locked by somebody else
1045 locking-user)
1050 "Search for RCS headers in FILE, and set properties accordingly.
1052 Returns: nil if no headers were found
1053 'rev if a workfile revision was found
1054 'rev-and-lock if revision and lock info was found"
1062 ;; search for $Id or $Header
1063 ;; -------------------------
1064 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1071 ;; if found, store the revision number ...
1073 ;; ... and check for the locking state
1081 ;; unlocked revision
1085 ;; revision is locked by some user
1089 ;; everything else: false
1091 ;; unexpected information in
1092 ;; keyword string --> quit
1094 ;; search for $Revision
1095 ;; --------------------
1098 nil t)
1099 ;; if found, store the revision number ...
1101 ;; and see if there's any lock information
1114 ;; else: nothing found
1115 ;; -------------------
1125 ;; If the file has headers, we don't want to query the
1126 ;; master file, because that would eliminate all the
1127 ;; performance gain the headers brought us. We therefore
1128 ;; use a heuristic now to find out whether locking is used
1129 ;; for this file. If we trust the file permissions, and the
1130 ;; file is not locked, then if the file is read-only we
1131 ;; assume that locking is used for the file, otherwise
1132 ;; locking is not used.
1138 status))))
1141 "Compare release numbers, represented as strings.
1142 Release components are assumed cardinal numbers, not decimal fractions
1143 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1144 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1145 of the string is found, or a non-numeric component shows up \(5.6.7 is
1147 some cases\). This code is suitable for existing RCS release numbers.
1148 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1169 "Return t if we have RELEASE or better."
1176 "Return the RCS release installed on this system, as a string.
1177 Return symbol `unknown' if the release cannot be deducted. The user can
1178 override this using variable `vc-rcs-release'.
1180 If the user has not set variable `vc-rcs-release' and it is nil,
1181 variable `vc-rcs-release' is set to the returned value."
1199 "Parse current buffer, presumed to be in RCS-style masterfile format.
1200 Optional arg BUFFER specifies another buffer to parse. Return an alist
1201 of two elements, w/ keys `headers' and `revisions' and values in turn
1202 sub-alists. For `headers', the values unless otherwise specified are
1203 strings and the keys are:
1205 desc -- description
1206 head -- latest revision
1208 absent if the head revision lies on the trunk
1209 access -- ???
1210 symbols -- sub-alist of (SYMBOL . REVISION) elements
1214 expand -- may be absent; ???
1216 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1217 with string values (unless otherwise specified) and keys:
1219 date -- a time value (like that returned by `encode-time'); as a
1220 special case, a year value less than 100 is augmented by 1900
1221 author -- username
1223 branches -- list of revisions that begin branches from this revision
1226 log -- change log entry
1227 text -- for the head revision on the trunk, the body of the file;
1228 other revisions have `:insn' instead
1229 :insn -- for non-head revisions, a list of parsed instructions
1232 - `(START k COUNT)' -- kill COUNT lines
1233 - `(START i TEXT)' -- insert TEXT (a string)
1234 The list is in descending order by START.
1236 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1239 ;; An RCS masterfile can be viewed as containing four regular (for the
1240 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1241 ;; the "description" and (d) the "rev bodies", in that order. In the
1242 ;; returned alist (see docstring), elements from (b) and (d) are
1243 ;; combined pairwise to form the "revisions", while those from (a) and
1244 ;; (c) are simply combined to form the "headers".
1245 ;;
1246 ;; Loosely speaking, each section contains a series of alternating
1247 ;; "tags" and "printed representations". In the (b) and (d), many
1248 ;; such series can appear, and a revision number on a line by itself
1249 ;; precedes the series of tags and printed representations associated
1250 ;; with it.
1251 ;;
1252 ;; In (a) and (b), the printed representations (with the exception of
1253 ;; the `comment' tag in the headers) terminate with a semicolon, which
1254 ;; is NOT part of the "value" finally associated with the tag. All
1255 ;; other printed representations are in "@@-format"; there is an "@",
1256 ;; the middle part (to be translated into the value), another "@" and
1257 ;; a newline. Each "@@" in the middle part indicates the position of
1258 ;; a single "@" (and consequently the requirement of an additional
1259 ;; initial step when translating to the value).
1260 ;;
1261 ;; Parser state includes vars that collect parts of the return value...
1263 ;; ... as well as vars that support a single-pass, tag-assisted,
1264 ;; minimal-data-copying scan. Basically -- skirting around the
1265 ;; grouping by revision required in (b) and (d) -- we repeatedly
1266 ;; and context-sensitively read a tag (that MUST be present),
1267 ;; determine the bounds of the printed representation, translate
1268 ;; it into a value, and push the tag plus value onto one of the
1269 ;; collection vars. Finally, we return the parse tree
1270 ;; incorporating the values of the collection vars (see "rv").
1271 ;;
1272 ;; A symbol or string to keep track of context (for error messages).
1273 context
1274 ;; A symbol, the current tag.
1275 tok
1276 ;; Region (begin and end buffer positions) of the printed
1277 ;; representation for the current tag.
1278 b e
1279 ;; A list of buffer positions where "@@" can be found within the
1280 ;; printed representation region. For each location, we push two
1281 ;; elements onto the list, 1+ and 2+ the location, respectively,
1282 ;; with the 2+ appearing at the head. In this way, the expression
1283 ;; `(,e ,@@-holes ,b)
1284 ;; describes regions that can be concatenated (in reverse order)
1285 ;; to "de-@@-format" the printed representation as the first step
1286 ;; to translating it into some value. See internal func `gather'.
1315 acc)
1319 acc)
1328 ;; headers
1342 two))
1348 t))
1349 headers)
1357 ;; rev headers
1366 b e)
1368 ;; Hack the year -- verified to be the
1369 ;; same algorithm used in RCS 5.7.
1379 revs)
1382 ;; desc
1385 ;; rev bodies
1387 ;; Element of `revs' that initially holds only header info.
1388 ;; "Pairwise combination" occurs when we add body info.
1389 rev
1390 ;; Components of the editing commands (aside from the actual
1391 ;; text) that comprise the `text' printed representations
1392 ;; (not including the "head" revision).
1393 cmd start act
1394 ;; Ascending (reversed) `@-holes' which the internal func
1395 ;; `incg' pops to effect incremental gathering.
1396 asc
1397 ;; Function to extract text (for the `a' command), either
1398 ;; `incg' or `buffer-substring-no-properties'. (This is
1399 ;; for speed; strictly speaking, it is sufficient to use
1400 ;; only the former since it behaves identically to the
1401 ;; latter in the absense of "@@".)
1402 sub)
1406 ;; Self-deprecate when work is done.
1407 ;; Folding many dimensions into one.
1408 ;; Thanks B.Mandelbrot, for complex sum.
1409 ;; O beauteous math! --the Unvexed Bum
1418 context))))
1420 ;; For rev body `text' tags, delay translation slightly...
1422 ;; ... until we decide which tag and value is appropriate to
1423 ;; collect. For the "head" revision, compute the value of the
1424 ;; `text' printed representation by simple `gather'. For all
1425 ;; other revisions, replace the `text' tag+value with `:insn'
1426 ;; plus value, always scanning in-place.
1442 (?d
1443 ;; `d' means "delete lines".
1444 ;; For Emacs spirit, we use `k' for "kill".
1446 (?a
1447 ;; `a' means "append after this line" but
1448 ;; internally we normalize it so that START
1449 ;; specifies the actual line for insert, thus
1450 ;; requiring less hair in the realization algs.
1451 ;; For Emacs spirit, we use `i' for "insert".
1456 cmd context)))
1457 acc))
1460 ;; rv
1466 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1467 ;;; vc-rcs.el ends here