| blob | 38573e412d93a94c9acf0687ee707bd844ced090 |
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."
571 "Get a difference report using RCS between two sets of files."
581 "Return a string with all log entries stored in BACKEND for FILE."
583 ;; Has to be written this way, this function is used by the CVS backend too
585 ;; Remove cruft
601 ;; Return the de-crufted comment list
605 "Annotate FILE, inserting the results in BUFFER.
606 Optional arg REVISION is a revision to annotate from."
608 ;; Aside from the "head revision on the trunk", the instructions for
609 ;; each revision on the trunk are an ordered list of kill and insert
610 ;; commands necessary to go from the chronologically-following
611 ;; revision to this one. That is, associated with revision N are
612 ;; edits that applied to revision N+1 would result in revision N.
613 ;;
614 ;; On a branch, however, (some) things are inverted: the commands
615 ;; listed are those necessary to go from the chronologically-preceding
616 ;; revision to this one. That is, associated with revision N are
617 ;; edits that applied to revision N-1 would result in revision N.
618 ;;
619 ;; So, to get per-line history info, we apply reverse-chronological
620 ;; edits, starting with the head revision on the trunk, all the way
621 ;; back through the initial revision (typically "1.1" or similar),
622 ;; then apply forward-chronological edits -- keeping track of which
623 ;; revision is associated with each inserted line -- until we reach
624 ;; the desired revision for display (which may be either on the trunk
625 ;; or on a branch).
630 ;; The revision N whose instructions we currently are processing.
632 ;; Alist from the parse tree for N.
634 ;; Point and temporary string, respectively.
635 p s
636 ;; "Next-branch list". Nil means the desired revision to
637 ;; display lives on the trunk. Non-nil means it lives on a
638 ;; branch, in which case the value is a list of revision pairs
639 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
640 ;; links each series of revisions in the path from the initial
641 ;; revision to the desired revision to display.
642 nbls
643 ;; "Path-accumulate-predicate plus revision/date/author".
644 ;; Until set, forward-chronological edits are not accumulated.
645 ;; Once set, its value (updated every revision) is used for
646 ;; the text property `:vc-rcs-r/d/a' for inserts during
647 ;; processing of forward-chronological instructions for N.
648 ;; See internal func `r/d/a'.
649 prda
650 ;; List of forward-chronological instructions, each of the
651 ;; form: (POS . ACTION), where POS is a buffer position. If
652 ;; ACTION is a string, it is inserted, otherwise it is taken as
653 ;; the number of characters to be deleted.
654 path
655 ;; N+1. When `cur' is "", this is the initial revision.
656 pre)
661 ;; Find which branches (if any) must be included in the edits.
663 bpt kids)
667 ;; A branchpoint may have multiple children. Find the right one.
671 ;; Start with the full text.
674 ;; Apply reverse-chronological edits on the trunk, computing and
675 ;; accumulating forward-chronological edits after some point, for
676 ;; later.
683 ;; Start accumulating the forward-chronological edits when N+1
684 ;; on the trunk is either the desired revision to display, or
685 ;; the appropriate branchpoint for it. Do this before
686 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
690 ;; Edits in the parse tree specify a line number (in the buffer
691 ;; *BEFORE* editing occurs) to start from, but line numbers
692 ;; change as a result of edits. To DTRT, we apply edits in
693 ;; order of descending buffer position so that edits further
694 ;; down in the buffer occur first w/o corrupting specified
695 ;; buffer positions of edits occurring towards the beginning of
696 ;; the buffer. In this way we avoid using markers. A pleasant
697 ;; property of this approach is ability to push instructions
698 ;; onto `path' directly, w/o need to maintain rev boundaries.
714 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
715 ;; equivalent to pushing an insert instruction (of the entire buffer
716 ;; contents) onto `path' then erasing the buffer, but less wasteful.
718 ;; Now apply the forward-chronological edits for the trunk.
724 ;; Now apply the forward-chronological edits (directly from the
725 ;; parse-tree) for the branch(es), if necessary. We re-use vars
726 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
731 prda nil)
745 ;; Lastly, for each line, insert at bol nicely-formatted history info.
746 ;; We do two passes to collect summary information used to minimize
747 ;; the annotation's usage of screen real-estate: (1) Consider rendered
748 ;; width of revision plus author together as a unit; and (2) Omit
749 ;; author entirely if all authors are the same as the user.
754 rda w a)
764 ht)
772 " "
774 ls)
775 :vc-annotate-prefix t
783 ht)))
791 "Return the current time, based at midnight of the current day, and
792 encoded as fractional days."
797 "Return the time of the next annotation (as fraction of days)
798 systime, or nil if there is none. Also, reposition point."
807 \f
808 ;;;
809 ;;; Tag system
810 ;;;
819 dir
823 \f
824 ;;;
825 ;;; Miscellaneous
826 ;;;
829 "Return t if REV is a revision on the trunk."
833 "Return the minor revision number of a revision number REV."
838 "Return the revision number immediately preceding REV for FILE,
839 or nil if there is no previous revision. This default
840 implementation works for MAJOR.MINOR-style revision numbers as
841 used by RCS and CVS."
846 ;; revision does probably not start a branch or release
849 ;; we are at the beginning of the trunk --
850 ;; don't know anything to return here
851 nil
852 ;; we are at the beginning of a branch --
853 ;; return revision of starting point
857 "Return the revision number immediately following REV for FILE,
858 or nil if there is no next revision. This default implementation
859 works for MAJOR.MINOR-style revision numbers as used by RCS
860 and CVS."
867 "Default implementation of update-changelog.
868 Uses `rcs2log' which only works for RCS and CVS."
869 ;; FIXME: We (c|sh)ould add support for cvs2cl
872 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
876 temporary-file-directory))))
884 user-mail-address)))
898 exec-directory)
900 "-c" changelog
908 files)))
909 "done"
918 "Check if the current file has any headers in it."
925 "Implementation of vc-clear-headers for RCS."
931 nil t)
935 ;; Just move the master file (using vc-rcs-master-templates).
939 ;; If the file is locked by some other user, make
940 ;; the buffer read-only. Like this, even root
941 ;; cannot modify a file that someone else has locked.
945 \f
946 ;;;
947 ;;; Internal functions
948 ;;;
951 "Return non-nil if FILE is newer than its RCS master.
952 This likely means that FILE has been changed with respect
953 to its master version."
961 "Find most recent revision on BRANCH."
966 nil t)
975 "Compute the master file's idea of the state of FILE.
976 If a WORKING-REVISION is given, compute the state of that version,
977 otherwise determine the workfile version based on the master file.
978 This function sets the properties `vc-working-revision' and
979 `vc-checkout-model' to their correct values, based on the master
980 file."
990 ;; Workfile version not known yet. Determine that first. It
991 ;; is either the head of the trunk, the head of the default
992 ;; branch, or the "default branch" itself, if that is a full
993 ;; revision number.
995 ;; no default branch
1000 ;; default branch is actually a revision
1002 default-branch)
1004 ;; else, search for the head of the default branch
1010 ;; Check strict locking
1015 ;; Compute state of workfile version
1023 ;; not locked
1027 ;; workfile version is latest on branch
1028 'up-to-date
1029 ;; workfile version is not latest on branch
1031 ;; locked by the calling user
1034 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1036 workfile-is-latest
1038 'edited
1039 ;; Locking is not used for the file, but the owner does
1040 ;; have a lock, and there is a higher version on the current
1041 ;; branch. Not sure if this can occur, and if it is right
1042 ;; to use `needs-merge' in this case.
1044 ;; locked by somebody else
1046 locking-user)
1051 "Search for RCS headers in FILE, and set properties accordingly.
1053 Returns: nil if no headers were found
1054 'rev if a workfile revision was found
1055 'rev-and-lock if revision and lock info was found"
1063 ;; search for $Id or $Header
1064 ;; -------------------------
1065 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1072 ;; if found, store the revision number ...
1074 ;; ... and check for the locking state
1082 ;; unlocked revision
1086 ;; revision is locked by some user
1090 ;; everything else: false
1092 ;; unexpected information in
1093 ;; keyword string --> quit
1095 ;; search for $Revision
1096 ;; --------------------
1099 nil t)
1100 ;; if found, store the revision number ...
1102 ;; and see if there's any lock information
1115 ;; else: nothing found
1116 ;; -------------------
1126 ;; If the file has headers, we don't want to query the
1127 ;; master file, because that would eliminate all the
1128 ;; performance gain the headers brought us. We therefore
1129 ;; use a heuristic now to find out whether locking is used
1130 ;; for this file. If we trust the file permissions, and the
1131 ;; file is not locked, then if the file is read-only we
1132 ;; assume that locking is used for the file, otherwise
1133 ;; locking is not used.
1139 status))))
1142 "Compare release numbers, represented as strings.
1143 Release components are assumed cardinal numbers, not decimal fractions
1144 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1145 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1146 of the string is found, or a non-numeric component shows up \(5.6.7 is
1148 some cases\). This code is suitable for existing RCS release numbers.
1149 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1170 "Return t if we have RELEASE or better."
1177 "Return the RCS release installed on this system, as a string.
1178 Return symbol `unknown' if the release cannot be deducted. The user can
1179 override this using variable `vc-rcs-release'.
1181 If the user has not set variable `vc-rcs-release' and it is nil,
1182 variable `vc-rcs-release' is set to the returned value."
1200 "Parse current buffer, presumed to be in RCS-style masterfile format.
1201 Optional arg BUFFER specifies another buffer to parse. Return an alist
1202 of two elements, w/ keys `headers' and `revisions' and values in turn
1203 sub-alists. For `headers', the values unless otherwise specified are
1204 strings and the keys are:
1206 desc -- description
1207 head -- latest revision
1209 absent if the head revision lies on the trunk
1210 access -- ???
1211 symbols -- sub-alist of (SYMBOL . REVISION) elements
1215 expand -- may be absent; ???
1217 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1218 with string values (unless otherwise specified) and keys:
1220 date -- a time value (like that returned by `encode-time'); as a
1221 special case, a year value less than 100 is augmented by 1900
1222 author -- username
1224 branches -- list of revisions that begin branches from this revision
1227 log -- change log entry
1228 text -- for the head revision on the trunk, the body of the file;
1229 other revisions have `:insn' instead
1230 :insn -- for non-head revisions, a list of parsed instructions
1233 - `(START k COUNT)' -- kill COUNT lines
1234 - `(START i TEXT)' -- insert TEXT (a string)
1235 The list is in descending order by START.
1237 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1240 ;; An RCS masterfile can be viewed as containing four regular (for the
1241 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1242 ;; the "description" and (d) the "rev bodies", in that order. In the
1243 ;; returned alist (see docstring), elements from (b) and (d) are
1244 ;; combined pairwise to form the "revisions", while those from (a) and
1245 ;; (c) are simply combined to form the "headers".
1246 ;;
1247 ;; Loosely speaking, each section contains a series of alternating
1248 ;; "tags" and "printed representations". In the (b) and (d), many
1249 ;; such series can appear, and a revision number on a line by itself
1250 ;; precedes the series of tags and printed representations associated
1251 ;; with it.
1252 ;;
1253 ;; In (a) and (b), the printed representations (with the exception of
1254 ;; the `comment' tag in the headers) terminate with a semicolon, which
1255 ;; is NOT part of the "value" finally associated with the tag. All
1256 ;; other printed representations are in "@@-format"; there is an "@",
1257 ;; the middle part (to be translated into the value), another "@" and
1258 ;; a newline. Each "@@" in the middle part indicates the position of
1259 ;; a single "@" (and consequently the requirement of an additional
1260 ;; initial step when translating to the value).
1261 ;;
1262 ;; Parser state includes vars that collect parts of the return value...
1264 ;; ... as well as vars that support a single-pass, tag-assisted,
1265 ;; minimal-data-copying scan. Basically -- skirting around the
1266 ;; grouping by revision required in (b) and (d) -- we repeatedly
1267 ;; and context-sensitively read a tag (that MUST be present),
1268 ;; determine the bounds of the printed representation, translate
1269 ;; it into a value, and push the tag plus value onto one of the
1270 ;; collection vars. Finally, we return the parse tree
1271 ;; incorporating the values of the collection vars (see "rv").
1272 ;;
1273 ;; A symbol or string to keep track of context (for error messages).
1274 context
1275 ;; A symbol, the current tag.
1276 tok
1277 ;; Region (begin and end buffer positions) of the printed
1278 ;; representation for the current tag.
1279 b e
1280 ;; A list of buffer positions where "@@" can be found within the
1281 ;; printed representation region. For each location, we push two
1282 ;; elements onto the list, 1+ and 2+ the location, respectively,
1283 ;; with the 2+ appearing at the head. In this way, the expression
1284 ;; `(,e ,@@-holes ,b)
1285 ;; describes regions that can be concatenated (in reverse order)
1286 ;; to "de-@@-format" the printed representation as the first step
1287 ;; to translating it into some value. See internal func `gather'.
1316 acc)
1320 acc)
1329 ;; headers
1343 two))
1349 t))
1350 headers)
1358 ;; rev headers
1367 b e)
1369 ;; Hack the year -- verified to be the
1370 ;; same algorithm used in RCS 5.7.
1380 revs)
1383 ;; desc
1386 ;; rev bodies
1388 ;; Element of `revs' that initially holds only header info.
1389 ;; "Pairwise combination" occurs when we add body info.
1390 rev
1391 ;; Components of the editing commands (aside from the actual
1392 ;; text) that comprise the `text' printed representations
1393 ;; (not including the "head" revision).
1394 cmd start act
1395 ;; Ascending (reversed) `@-holes' which the internal func
1396 ;; `incg' pops to effect incremental gathering.
1397 asc
1398 ;; Function to extract text (for the `a' command), either
1399 ;; `incg' or `buffer-substring-no-properties'. (This is
1400 ;; for speed; strictly speaking, it is sufficient to use
1401 ;; only the former since it behaves identically to the
1402 ;; latter in the absense of "@@".)
1403 sub)
1407 ;; Self-deprecate when work is done.
1408 ;; Folding many dimensions into one.
1409 ;; Thanks B.Mandelbrot, for complex sum.
1410 ;; O beauteous math! --the Unvexed Bum
1419 context))))
1421 ;; For rev body `text' tags, delay translation slightly...
1423 ;; ... until we decide which tag and value is appropriate to
1424 ;; collect. For the "head" revision, compute the value of the
1425 ;; `text' printed representation by simple `gather'. For all
1426 ;; other revisions, replace the `text' tag+value with `:insn'
1427 ;; plus value, always scanning in-place.
1443 (?d
1444 ;; `d' means "delete lines".
1445 ;; For Emacs spirit, we use `k' for "kill".
1447 (?a
1448 ;; `a' means "append after this line" but
1449 ;; internally we normalize it so that START
1450 ;; specifies the actual line for insert, thus
1451 ;; requiring less hair in the realization algs.
1452 ;; For Emacs spirit, we use `i' for "insert".
1457 cmd context)))
1458 acc))
1461 ;; rv
1467 ;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
1468 ;;; vc-rcs.el ends here