Merge from emacs--rel--22
[bpt/emacs.git] / lisp / vc-rcs.el
CommitLineData
d8aff077
GM
1;;; vc-rcs.el --- support for RCS version-control
2
0d30b337 3;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
d7a0267c 4;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
d8aff077
GM
5
6;; Author: FSF (see vc.el for full credits)
7;; Maintainer: Andre Spiegel <spiegel@gnu.org>
8
fa63cb6d 9;; $Id$
d8aff077
GM
10
11;; This file is part of GNU Emacs.
12
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
b4aa6026 15;; the Free Software Foundation; either version 3, or (at your option)
d8aff077
GM
16;; any later version.
17
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.
22
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
086add15
LK
25;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
d8aff077 27
e8af40ee
PJ
28;;; Commentary:
29
30;; See vc.el
d8aff077 31
0792fdb4
SM
32;; TODO:
33;; - remove call to vc-expand-dirs by implementing our own (which can just
34;; list the RCS subdir instead).
35
d8aff077
GM
36;;; Code:
37
8f98485f
AS
38;;;
39;;; Customization options
40;;;
41
0bc58756 42(eval-when-compile
10489ed7
AS
43 (require 'cl)
44 (require 'vc))
0bc58756 45
d8aff077
GM
46(defcustom vc-rcs-release nil
47 "*The release number of your RCS installation, as a string.
48If nil, VC itself computes this value when it is first needed."
49 :type '(choice (const :tag "Auto" nil)
50 (string :tag "Specified")
51 (const :tag "Unknown" unknown))
52 :group 'vc)
53
54(defcustom vc-rcs-register-switches nil
33c1b7a1
DL
55 "*Extra switches for registering a file in RCS.
56A string or list of strings. These are passed to the checkin program
57by \\[vc-rcs-register]."
d8aff077
GM
58 :type '(choice (const :tag "None" nil)
59 (string :tag "Argument String")
60 (repeat :tag "Argument List"
61 :value ("")
62 string))
33c1b7a1 63 :version "21.1"
d8aff077
GM
64 :group 'vc)
65
10489ed7
AS
66(defcustom vc-rcs-diff-switches nil
67 "*A string or list of strings specifying extra switches for rcsdiff under VC."
68 :type '(choice (const :tag "None" nil)
69 (string :tag "Argument String")
70 (repeat :tag "Argument List"
71 :value ("")
72 string))
73 :version "21.1"
74 :group 'vc)
75
d8aff077
GM
76(defcustom vc-rcs-header (or (cdr (assoc 'RCS vc-header-alist)) '("\$Id\$"))
77 "*Header keywords to be inserted by `vc-insert-headers'."
f0e7c067 78 :type '(repeat string)
33c1b7a1 79 :version "21.1"
d8aff077
GM
80 :group 'vc)
81
82(defcustom vc-rcsdiff-knows-brief nil
83 "*Indicates whether rcsdiff understands the --brief option.
84The value is either `yes', `no', or nil. If it is nil, VC tries
85to use --brief and sets this variable to remember whether it worked."
86 :type '(choice (const :tag "Work out" nil) (const yes) (const no))
87 :group 'vc)
88
89;;;###autoload
90(defcustom vc-rcs-master-templates
91 '("%sRCS/%s,v" "%s%s,v" "%sRCS/%s")
92 "*Where to look for RCS master files.
93For a description of possible values, see `vc-check-master-templates'."
94 :type '(choice (const :tag "Use standard RCS file names"
95 '("%sRCS/%s,v" "%s%s,v" "%sRCS/%s"))
96 (repeat :tag "User-specified"
97 (choice string
98 function)))
33c1b7a1 99 :version "21.1"
d8aff077
GM
100 :group 'vc)
101
8f98485f 102\f
8cdd17b4
ER
103;;; Properties of the backend
104
105(defun vc-rcs-revision-granularity ()
106 'file)
107
8f98485f
AS
108;;;
109;;; State-querying functions
110;;;
111
736e0fd1
AS
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.
116
117;;;###autoload (defun vc-rcs-registered (f) (vc-default-registered 'RCS f))
0d2c82c7 118(defun vc-rcs-registered (f) (vc-default-registered 'RCS f))
d8aff077
GM
119
120(defun vc-rcs-state (file)
121 "Implementation of `vc-state' for RCS."
122 (or (boundp 'vc-rcs-headers-result)
123 (and vc-consult-headers
124 (vc-rcs-consult-headers file)))
125 (let ((state
126 ;; vc-workfile-version might not be known; in that case the
127 ;; property is nil. vc-rcs-fetch-master-state knows how to
128 ;; handle that.
33c1b7a1
DL
129 (vc-rcs-fetch-master-state file
130 (vc-file-getprop file
d8aff077 131 'vc-workfile-version))))
ceaa9974
AS
132 (if (not (eq state 'up-to-date))
133 state
ceaa9974
AS
134 (if (vc-workfile-unchanged-p file)
135 'up-to-date
136 (if (eq (vc-checkout-model file) 'locking)
137 'unlocked-changes
138 'edited)))))
d8aff077
GM
139
140(defun vc-rcs-state-heuristic (file)
141 "State heuristic for RCS."
142 (let (vc-rcs-headers-result)
143 (if (and vc-consult-headers
33c1b7a1 144 (setq vc-rcs-headers-result
d8aff077
GM
145 (vc-rcs-consult-headers file))
146 (eq vc-rcs-headers-result 'rev-and-lock))
147 (let ((state (vc-file-getprop file 'vc-state)))
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.
151 (if (and (eq state 'up-to-date)
152 (not (vc-mistrust-permissions file)))
153 (cond
154 ((string-match ".rw..-..-." (nth 8 (file-attributes file)))
0db2c43c 155 (vc-file-setprop file 'vc-checkout-model 'implicit)
f1180544
JB
156 (setq state
157 (if (vc-rcs-workfile-is-newer file)
158 'edited
0db2c43c 159 'up-to-date)))
d8aff077
GM
160 ((string-match ".r-..-..-." (nth 8 (file-attributes file)))
161 (vc-file-setprop file 'vc-checkout-model 'locking))))
162 state)
163 (if (not (vc-mistrust-permissions file))
b010f887
AS
164 (let* ((attributes (file-attributes file 'string))
165 (owner-name (nth 2 attributes))
d8aff077
GM
166 (permissions (nth 8 attributes)))
167 (cond ((string-match ".r-..-..-." permissions)
168 (vc-file-setprop file 'vc-checkout-model 'locking)
169 'up-to-date)
170 ((string-match ".rw..-..-." permissions)
0db2c43c
AS
171 (if (eq (vc-checkout-model file) 'locking)
172 (if (file-ownership-preserved-p file)
173 'edited
b010f887 174 owner-name)
f1180544 175 (if (vc-rcs-workfile-is-newer file)
0db2c43c
AS
176 'edited
177 'up-to-date)))
d8aff077
GM
178 (t
179 ;; Strange permissions. Fall through to
180 ;; expensive state computation.
181 (vc-rcs-state file))))
182 (vc-rcs-state file)))))
183
184(defun vc-rcs-workfile-version (file)
185 "RCS-specific version of `vc-workfile-version'."
186 (or (and vc-consult-headers
187 (vc-rcs-consult-headers file)
188 (vc-file-getprop file 'vc-workfile-version))
189 (progn
190 (vc-rcs-fetch-master-state file)
191 (vc-file-getprop file 'vc-workfile-version))))
192
8f98485f
AS
193(defun vc-rcs-latest-on-branch-p (file &optional version)
194 "Return non-nil if workfile version of FILE is the latest on its branch.
195When VERSION is given, perform check for that version."
196 (unless version (setq version (vc-workfile-version file)))
197 (with-temp-buffer
198 (string= version
7735770b 199 (if (vc-trunk-p version)
8f98485f
AS
200 (progn
201 ;; Compare VERSION to the head version number.
202 (vc-insert-file (vc-name file) "^[0-9]")
203 (vc-parse-buffer "^head[ \t\n]+\\([^;]+\\);" 1))
204 ;; If we are not on the trunk, we need to examine the
205 ;; whole current branch.
206 (vc-insert-file (vc-name file) "^desc")
7735770b 207 (vc-rcs-find-most-recent-rev (vc-branch-part version))))))
8f98485f 208
d8aff077
GM
209(defun vc-rcs-checkout-model (file)
210 "RCS-specific version of `vc-checkout-model'."
8915c220
AS
211 (let (result)
212 (when vc-consult-headers
213 (vc-file-setprop file 'vc-checkout-model nil)
214 (vc-rcs-consult-headers file)
215 (setq result (vc-file-getprop file 'vc-checkout-model)))
216 (or result
217 (progn (vc-rcs-fetch-master-state file)
218 (vc-file-getprop file 'vc-checkout-model)))))
d8aff077 219
d8aff077 220(defun vc-rcs-workfile-unchanged-p (file)
fa63cb6d 221 "RCS-specific implementation of `vc-workfile-unchanged-p'."
d8aff077
GM
222 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
223 ;; do a double take and remember the fact for the future
224 (let* ((version (concat "-r" (vc-workfile-version file)))
225 (status (if (eq vc-rcsdiff-knows-brief 'no)
226 (vc-do-command nil 1 "rcsdiff" file version)
227 (vc-do-command nil 2 "rcsdiff" file "--brief" version))))
228 (if (eq status 2)
229 (if (not vc-rcsdiff-knows-brief)
230 (setq vc-rcsdiff-knows-brief 'no
231 status (vc-do-command nil 1 "rcsdiff" file version))
232 (error "rcsdiff failed"))
233 (if (not vc-rcsdiff-knows-brief) (setq vc-rcsdiff-knows-brief 'yes)))
234 ;; The workfile is unchanged if rcsdiff found no differences.
235 (zerop status)))
236
9d8f43bf
SM
237(defun vc-rcs-find-file-not-found-hook ()
238 (if (yes-or-no-p
239 (format "File %s was lost; check out from version control? "
240 (file-name-nondirectory buffer-file-name)))
241 (save-excursion
242 (require 'vc)
243 (let ((default-directory (file-name-directory buffer-file-name)))
244 (not (vc-error-occurred (vc-checkout buffer-file-name)))))))
d8aff077 245\f
8f98485f
AS
246;;;
247;;; State-changing functions
248;;;
d8aff077 249
8cdd17b4
ER
250(defun vc-rcs-create-repo ()
251 "Create a new RCS repository."
252 ;; RCS is totally file-oriented, so all we have to do is make the directory
253 (make-directory "RCS"))
254
255(defun vc-rcs-register (files &optional rev comment)
256 "Register FILES into the RCS version-control system.
257REV is the optional revision number for the files. COMMENT can be used
258to provide an initial description for each FILES.
d8aff077
GM
259
260`vc-register-switches' and `vc-rcs-register-switches' are passed to
261the RCS command (in that order).
262
263Automatically retrieve a read-only version of the file with keywords
264expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
8cdd17b4
ER
265 (let ((subdir (expand-file-name "RCS" (file-name-directory file))))
266 (dolist (file files)
d8aff077
GM
267 (and (not (file-exists-p subdir))
268 (not (directory-files (file-name-directory file)
269 nil ".*,v$" t))
270 (yes-or-no-p "Create RCS subdirectory? ")
271 (make-directory subdir))
272 (apply 'vc-do-command nil 0 "ci" file
273 ;; if available, use the secure registering option
274 (and (vc-rcs-release-p "5.6.4") "-i")
275 (concat (if vc-keep-workfiles "-u" "-r") rev)
276 (and comment (concat "-t-" comment))
3e6bab65 277 (vc-switches 'RCS 'register))
d8aff077
GM
278 ;; parse output to find master file name and workfile version
279 (with-current-buffer "*vc*"
280 (goto-char (point-min))
281 (let ((name (if (looking-at (concat "^\\(.*\\) <-- "
282 (file-name-nondirectory file)))
283 (match-string 1))))
284 (if (not name)
285 ;; if we couldn't find the master name,
286 ;; run vc-rcs-registered to get it
287 ;; (will be stored into the vc-name property)
288 (vc-rcs-registered file)
289 (vc-file-setprop file 'vc-name
290 (if (file-name-absolute-p name)
291 name
33c1b7a1
DL
292 (expand-file-name
293 name
d8aff077
GM
294 (file-name-directory file))))))
295 (vc-file-setprop file 'vc-workfile-version
33c1b7a1 296 (if (re-search-forward
d8aff077
GM
297 "^initial revision: \\([0-9.]+\\).*\n"
298 nil t)
8cdd17b4 299 (match-string 1)))))))
d8aff077 300
8f98485f
AS
301(defun vc-rcs-responsible-p (file)
302 "Return non-nil if RCS thinks it would be responsible for registering FILE."
303 ;; TODO: check for all the patterns in vc-rcs-master-templates
304 (file-directory-p (expand-file-name "RCS" (file-name-directory file))))
305
306(defun vc-rcs-receive-file (file rev)
307 "Implementation of receive-file for RCS."
308 (let ((checkout-model (vc-checkout-model file)))
309 (vc-rcs-register file rev "")
310 (when (eq checkout-model 'implicit)
311 (vc-rcs-set-non-strict-locking file))
312 (vc-rcs-set-default-branch file (concat rev ".1"))))
313
0db2c43c
AS
314(defun vc-rcs-unregister (file)
315 "Unregister FILE from RCS.
316If this leaves the RCS subdirectory empty, ask the user
317whether to remove it."
318 (let* ((master (vc-name file))
7849e179
SM
319 (dir (file-name-directory master))
320 (backup-info (find-backup-file-name master)))
321 (if (not backup-info)
322 (delete-file master)
323 (rename-file master (car backup-info) 'ok-if-already-exists)
324 (dolist (f (cdr backup-info)) (ignore-errors (delete-file f))))
0db2c43c
AS
325 (and (string= (file-name-nondirectory (directory-file-name dir)) "RCS")
326 ;; check whether RCS dir is empty, i.e. it does not
327 ;; contain any files except "." and ".."
f1180544 328 (not (directory-files dir nil
0db2c43c
AS
329 "^\\([^.]\\|\\.[^.]\\|\\.\\.[^.]\\).*"))
330 (yes-or-no-p (format "Directory %s is empty; remove it? " dir))
331 (delete-directory dir))))
332
8cdd17b4 333(defun vc-rcs-checkin (files rev comment)
8f98485f 334 "RCS-specific version of `vc-backend-checkin'."
3e6bab65 335 (let ((switches (vc-switches 'RCS 'checkin)))
8cdd17b4
ER
336 ;; Now operate on the files
337 (dolist (file files)
338 (let ((old-version (vc-workfile-version file)) new-version
339 (default-branch (vc-file-getprop file 'vc-rcs-default-branch)))
340 ;; Force branch creation if an appropriate
341 ;; default branch has been set.
342 (and (not rev)
343 default-branch
344 (string-match (concat "^" (regexp-quote old-version) "\\.")
345 default-branch)
346 (setq rev default-branch)
347 (setq switches (cons "-f" switches)))
348 (if (and (not rev) old-version)
349 (setq rev (vc-branch-part old-version)))
350 (apply 'vc-do-command nil 0 "ci" (vc-name file)
351 ;; if available, use the secure check-in option
352 (and (vc-rcs-release-p "5.6.4") "-j")
353 (concat (if vc-keep-workfiles "-u" "-r") rev)
354 (concat "-m" comment)
355 switches)
356 (vc-file-setprop file 'vc-workfile-version nil)
357
358 ;; determine the new workfile version
359 (set-buffer "*vc*")
360 (goto-char (point-min))
361 (when (or (re-search-forward
362 "new revision: \\([0-9.]+\\);" nil t)
363 (re-search-forward
364 "reverting to previous revision \\([0-9.]+\\)" nil t))
365 (setq new-version (match-string 1))
366 (vc-file-setprop file 'vc-workfile-version new-version))
367
368 ;; if we got to a different branch, adjust the default
369 ;; branch accordingly
370 (cond
371 ((and old-version new-version
372 (not (string= (vc-branch-part old-version)
373 (vc-branch-part new-version))))
374 (vc-rcs-set-default-branch file
375 (if (vc-trunk-p new-version) nil
376 (vc-branch-part new-version)))
377 ;; If this is an old RCS release, we might have
378 ;; to remove a remaining lock.
379 (if (not (vc-rcs-release-p "5.6.2"))
380 ;; exit status of 1 is also accepted.
381 ;; It means that the lock was removed before.
382 (vc-do-command nil 1 "rcs" (vc-name file)
383 (concat "-u" old-version)))))))))
a7e98271 384
88388365
SM
385(defun vc-rcs-find-version (file rev buffer)
386 (apply 'vc-do-command
387 buffer 0 "co" (vc-name file)
388 "-q" ;; suppress diagnostic output
389 (concat "-p" rev)
3e6bab65 390 (vc-switches 'RCS 'checkout)))
88388365
SM
391
392(defun vc-rcs-checkout (file &optional editable rev)
393 "Retrieve a copy of a saved version of FILE."
394 (let ((file-buffer (get-file-buffer file))
d8aff077 395 switches)
88388365 396 (message "Checking out %s..." file)
d8aff077
GM
397 (save-excursion
398 ;; Change buffers to get local value of vc-checkout-switches.
399 (if file-buffer (set-buffer file-buffer))
3e6bab65 400 (setq switches (vc-switches 'RCS 'checkout))
d8aff077
GM
401 ;; Save this buffer's default-directory
402 ;; and use save-excursion to make sure it is restored
403 ;; in the same buffer it was saved in.
404 (let ((default-directory default-directory))
405 (save-excursion
406 ;; Adjust the default-directory so that the check-out creates
407 ;; the file in the right place.
88388365
SM
408 (setq default-directory (file-name-directory file))
409 (let (new-version)
410 ;; if we should go to the head of the trunk,
411 ;; clear the default branch first
412 (and rev (string= rev "")
413 (vc-rcs-set-default-branch file nil))
414 ;; now do the checkout
415 (apply 'vc-do-command
416 nil 0 "co" (vc-name file)
417 ;; If locking is not strict, force to overwrite
418 ;; the writable workfile.
419 (if (eq (vc-checkout-model file) 'implicit) "-f")
420 (if editable "-l")
a3294a80
AS
421 (if (stringp rev)
422 ;; a literal revision was specified
423 (concat "-r" rev)
424 (let ((workrev (vc-workfile-version file)))
425 (if workrev
f1180544 426 (concat "-r"
a3294a80
AS
427 (if (not rev)
428 ;; no revision specified:
429 ;; use current workfile version
430 workrev
431 ;; REV is t ...
a207e923 432 (if (not (vc-trunk-p workrev))
a3294a80
AS
433 ;; ... go to head of current branch
434 (vc-branch-part workrev)
435 ;; ... go to head of trunk
436 (vc-rcs-set-default-branch file
437 nil)
438 ""))))))
88388365
SM
439 switches)
440 ;; determine the new workfile version
441 (with-current-buffer "*vc*"
442 (setq new-version
443 (vc-parse-buffer "^revision \\([0-9.]+\\).*\n" 1)))
444 (vc-file-setprop file 'vc-workfile-version new-version)
445 ;; if necessary, adjust the default branch
446 (and rev (not (string= rev ""))
3249f234 447 (vc-rcs-set-default-branch
88388365
SM
448 file
449 (if (vc-rcs-latest-on-branch-p file new-version)
450 (if (vc-trunk-p new-version) nil
451 (vc-branch-part new-version))
452 new-version)))))
453 (message "Checking out %s...done" file)))))
d8aff077 454
8cdd17b4
ER
455(defun vc-rcs-rollback (files)
456 "Roll back, undoing the most recent checkins of FILES."
457 (if (not files)
458 (error "RCS backend doesn't support directory-level rollback."))
459 (dolist (file files)
460 (let* ((discard (vc-workfile-version file))
461 (previous (if (vc-trunk-p discard) "" (vc-branch-part discard)))
462 (config (current-window-configuration))
463 (done nil))
464 (if (null (yes-or-no-p (format "Remove version %s from %s history? "
465 discard file)))
466 (error "Aborted"))
467 (message "Removing revision %s from %s." discard file)
468 (vc-do-command nil 0 "rcs" (vc-name file) (concat "-o" discard))
469 ;; Check out the most recent remaining version. If it
470 ;; fails, because the whole branch got deleted, do a
471 ;; double-take and check out the version where the branch
472 ;; started.
473 (while (not done)
474 (condition-case err
475 (progn
476 (vc-do-command nil 0 "co" (vc-name file) "-f"
477 (concat "-u" previous))
478 (setq done t))
479 (error (set-buffer "*vc*")
480 (goto-char (point-min))
481 (if (search-forward "no side branches present for" nil t)
482 (progn (setq previous (vc-branch-part previous))
483 (vc-rcs-set-default-branch file previous)
484 ;; vc-do-command popped up a window with
485 ;; the error message. Get rid of it, by
486 ;; restoring the old window configuration.
487 (set-window-configuration config))
488 ;; No, it was some other error: re-signal it.
489 (signal (car err) (cdr err)))))))))
490
99739bbf 491(defun vc-rcs-revert (file &optional contents-done)
8f98485f
AS
492 "Revert FILE to the version it was based on."
493 (vc-do-command nil 0 "co" (vc-name file) "-f"
f1180544 494 (concat (if (eq (vc-state file) 'edited) "-u" "-r")
4837cfbd 495 (vc-workfile-version file))))
8f98485f 496
8f98485f
AS
497(defun vc-rcs-merge (file first-version &optional second-version)
498 "Merge changes into current working copy of FILE.
499The changes are between FIRST-VERSION and SECOND-VERSION."
500 (vc-do-command nil 1 "rcsmerge" (vc-name file)
501 "-kk" ; ignore keyword conflicts
502 (concat "-r" first-version)
503 (if second-version (concat "-r" second-version))))
504
505(defun vc-rcs-steal-lock (file &optional rev)
506 "Steal the lock on the current workfile for FILE and revision REV.
507Needs RCS 5.6.2 or later for -M."
7735770b 508 (vc-do-command nil 0 "rcs" (vc-name file) "-M" (concat "-u" rev))
f1180544 509 ;; Do a real checkout after stealing the lock, so that we see
7735770b
AS
510 ;; expanded headers.
511 (vc-do-command nil 0 "co" (vc-name file) "-f" (concat "-l" rev)))
8f98485f
AS
512
513
514\f
515;;;
516;;; History functions
517;;;
518
8cdd17b4 519(defun vc-rcs-print-log (files &optional buffer)
8f98485f 520 "Get change log associated with FILE."
8cdd17b4 521 (vc-do-command buffer 0 "rlog" (mapcar 'vc-name files)))
8f98485f 522
8cdd17b4
ER
523(defun vc-rcs-diff (files &optional oldvers newvers buffer)
524 "Get a difference report using RCS between two sets of files."
525 (apply 'vc-do-command (or buffer "*vc-diff*")
526 1 ;; Always go synchronous, the repo is local
527 "rcsdiff" (vc-expand-dirs files)
10489ed7 528 (append (list "-q"
8cdd17b4 529 (and oldvers (concat "-r" oldvers))
10489ed7 530 (and newvers (concat "-r" newvers)))
3e6bab65 531 (vc-switches 'RCS 'diff))))
8f98485f 532
8cdd17b4
ER
533(defun vc-rcs-wash-log ()
534 "Remove all non-comment information from log output."
535 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
536 "\\(branches: .*;\n\\)?"
537 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
538 (goto-char (point-max)) (forward-line -1)
539 (while (looking-at "=*\n")
540 (delete-char (- (match-end 0) (match-beginning 0)))
541 (forward-line -1))
542 (goto-char (point-min))
543 (if (looking-at "[\b\t\n\v\f\r ]+")
544 (delete-char (- (match-end 0) (match-beginning 0))))
545 (goto-char (point-min))
546 (re-search-forward separator nil t)
547 (delete-region (point-min) (point))
548 (while (re-search-forward separator nil t)
549 (delete-region (match-beginning 0) (match-end 0)))))
550
3249f234
TTN
551(defun vc-rcs-annotate-command (file buffer &optional revision)
552 "Annotate FILE, inserting the results in BUFFER.
553Optional arg REVISION is a revision to annotate from."
903d71fb 554 (vc-setup-buffer buffer)
3249f234
TTN
555 ;; Aside from the "head revision on the trunk", the instructions for
556 ;; each revision on the trunk are an ordered list of kill and insert
557 ;; commands necessary to go from the chronologically-following
558 ;; revision to this one. That is, associated with revision N are
559 ;; edits that applied to revision N+1 would result in revision N.
560 ;;
561 ;; On a branch, however, (some) things are inverted: the commands
562 ;; listed are those necessary to go from the chronologically-preceding
563 ;; revision to this one. That is, associated with revision N are
564 ;; edits that applied to revision N-1 would result in revision N.
565 ;;
566 ;; So, to get per-line history info, we apply reverse-chronological
567 ;; edits, starting with the head revision on the trunk, all the way
568 ;; back through the initial revision (typically "1.1" or similar),
569 ;; then apply forward-chronological edits -- keeping track of which
570 ;; revision is associated with each inserted line -- until we reach
571 ;; the desired revision for display (which may be either on the trunk
572 ;; or on a branch).
573 (let* ((tree (with-temp-buffer
574 (insert-file-contents (vc-rcs-registered file))
575 (vc-rcs-parse)))
576 (revisions (cdr (assq 'revisions tree)))
577 ;; The revision N whose instructions we currently are processing.
578 (cur (cdr (assq 'head (cdr (assq 'headers tree)))))
579 ;; Alist from the parse tree for N.
580 (meta (cdr (assoc cur revisions)))
581 ;; Point and temporary string, respectively.
582 p s
583 ;; "Next-branch list". Nil means the desired revision to
584 ;; display lives on the trunk. Non-nil means it lives on a
585 ;; branch, in which case the value is a list of revision pairs
586 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
587 ;; links each series of revisions in the path from the initial
588 ;; revision to the desired revision to display.
589 nbls
590 ;; "Path-accumulate-predicate plus revision/date/author".
591 ;; Until set, forward-chronological edits are not accumulated.
592 ;; Once set, its value (updated every revision) is used for
593 ;; the text property `:vc-rcs-r/d/a' for inserts during
594 ;; processing of forward-chronological instructions for N.
595 ;; See internal func `r/d/a'.
596 prda
597 ;; List of forward-chronological instructions, each of the
598 ;; form: (POS . ACTION), where POS is a buffer position. If
599 ;; ACTION is a string, it is inserted, otherwise it is taken as
600 ;; the number of characters to be deleted.
601 path
602 ;; N+1. When `cur' is "", this is the initial revision.
603 pre)
604 (unless revision
605 (setq revision cur))
606 (unless (assoc revision revisions)
607 (error "No such revision: %s" revision))
608 ;; Find which branches (if any) must be included in the edits.
609 (let ((par revision)
610 bpt kids)
611 (while (setq bpt (vc-branch-part par)
612 par (vc-branch-part bpt))
613 (setq kids (cdr (assq 'branches (cdr (assoc par revisions)))))
614 ;; A branchpoint may have multiple children. Find the right one.
615 (while (not (string= bpt (vc-branch-part (car kids))))
616 (setq kids (cdr kids)))
617 (push (cons par (car kids)) nbls)))
618 ;; Start with the full text.
619 (set-buffer buffer)
620 (insert (cdr (assq 'text meta)))
621 ;; Apply reverse-chronological edits on the trunk, computing and
622 ;; accumulating forward-chronological edits after some point, for
623 ;; later.
624 (flet ((r/d/a () (vector pre
625 (cdr (assq 'date meta))
626 (cdr (assq 'author meta)))))
627 (while (when (setq pre cur cur (cdr (assq 'next meta)))
628 (not (string= "" cur)))
629 (setq
630 ;; Start accumulating the forward-chronological edits when N+1
631 ;; on the trunk is either the desired revision to display, or
632 ;; the appropriate branchpoint for it. Do this before
633 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
634 prda (when (or prda (string= (if nbls (caar nbls) revision) pre))
635 (r/d/a))
636 meta (cdr (assoc cur revisions)))
637 ;; Edits in the parse tree specify a line number (in the buffer
638 ;; *BEFORE* editing occurs) to start from, but line numbers
639 ;; change as a result of edits. To DTRT, we apply edits in
640 ;; order of descending buffer position so that edits further
641 ;; down in the buffer occur first w/o corrupting specified
642 ;; buffer positions of edits occurring towards the beginning of
643 ;; the buffer. In this way we avoid using markers. A pleasant
644 ;; property of this approach is ability to push instructions
645 ;; onto `path' directly, w/o need to maintain rev boundaries.
646 (dolist (insn (cdr (assq :insn meta)))
647 (goto-line (pop insn))
648 (setq p (point))
649 (case (pop insn)
650 (k (setq s (buffer-substring-no-properties
651 p (progn (forward-line (car insn))
652 (point))))
653 (when prda
654 (push `(,p . ,(propertize s :vc-rcs-r/d/a prda)) path))
655 (delete-region p (point)))
656 (i (setq s (car insn))
657 (when prda
658 (push `(,p . ,(length s)) path))
659 (insert s)))))
660 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
661 ;; equivalent to pushing an insert instruction (of the entire buffer
662 ;; contents) onto `path' then erasing the buffer, but less wasteful.
663 (put-text-property (point-min) (point-max) :vc-rcs-r/d/a (r/d/a))
664 ;; Now apply the forward-chronological edits for the trunk.
665 (dolist (insn path)
666 (goto-char (pop insn))
667 (if (stringp insn)
668 (insert insn)
669 (delete-char insn)))
670 ;; Now apply the forward-chronological edits (directly from the
671 ;; parse-tree) for the branch(es), if necessary. We re-use vars
672 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
673 (while nbls
674 (setq pre (cdr (pop nbls)))
675 (while (progn
676 (setq meta (cdr (assoc pre revisions))
677 prda nil)
678 (dolist (insn (cdr (assq :insn meta)))
679 (goto-line (pop insn))
680 (case (pop insn)
681 (k (delete-region
682 (point) (progn (forward-line (car insn))
683 (point))))
684 (i (insert (propertize
685 (car insn)
686 :vc-rcs-r/d/a
687 (or prda (setq prda (r/d/a))))))))
688 (prog1 (not (string= (if nbls (caar nbls) revision) pre))
689 (setq pre (cdr (assq 'next meta)))))))))
690 ;; Lastly, for each line, insert at bol nicely-formatted history info.
691 ;; We do two passes to collect summary information used to minimize
692 ;; the annotation's usage of screen real-estate: (1) Consider rendered
693 ;; width of revision plus author together as a unit; and (2) Omit
694 ;; author entirely if all authors are the same as the user.
695 (let ((ht (make-hash-table :test 'eq))
696 (me (user-login-name))
697 (maxw 0)
698 (all-me t)
699 rda w a)
700 (goto-char (point-max))
701 (while (not (bobp))
702 (forward-line -1)
703 (setq rda (get-text-property (point) :vc-rcs-r/d/a))
704 (unless (gethash rda ht)
705 (setq a (aref rda 2)
706 all-me (and all-me (string= a me)))
707 (puthash rda (setq w (+ (length (aref rda 0))
708 (length a)))
709 ht)
710 (setq maxw (max w maxw))))
711 (let ((padding (make-string maxw 32)))
712 (flet ((pad (w) (substring-no-properties padding w))
713 (render (rda &rest ls)
714 (propertize
715 (apply 'concat
716 (format-time-string "%Y-%m-%d" (aref rda 1))
717 " "
718 (aref rda 0)
719 ls)
720 :vc-rcs-r/d/a rda)))
721 (maphash
722 (if all-me
723 (lambda (rda w)
724 (puthash rda (render rda (pad w) ": ") ht))
725 (lambda (rda w)
726 (puthash rda (render rda " " (pad w) " " (aref rda 2) ": ") ht)))
727 ht)))
728 (while (not (eobp))
729 (insert (gethash (get-text-property (point) :vc-rcs-r/d/a) ht))
730 (forward-line 1))))
731
732(defun vc-rcs-annotate-current-time ()
733 "Return the current time, based at midnight of the current day, and
734encoded as fractional days."
735 (vc-annotate-convert-time
736 (apply 'encode-time 0 0 0 (nthcdr 3 (decode-time (current-time))))))
737
738(defun vc-rcs-annotate-time ()
739 "Return the time of the next annotation (as fraction of days)
740systime, or nil if there is none. Also, reposition point."
741 (unless (eobp)
53cc5b9c
TTN
742 (prog1 (vc-annotate-convert-time
743 (aref (get-text-property (point) :vc-rcs-r/d/a) 1))
744 (goto-char (next-single-property-change (point) :vc-annotate-prefix)))))
3249f234
TTN
745
746(defun vc-rcs-annotate-extract-revision-at-line ()
747 (aref (get-text-property (point) :vc-rcs-r/d/a) 0))
748
8f98485f
AS
749\f
750;;;
751;;; Snapshot system
752;;;
753
754(defun vc-rcs-assign-name (file name)
755 "Assign to FILE's latest version a given NAME."
756 (vc-do-command nil 0 "rcs" (vc-name file) (concat "-n" name ":")))
757
758\f
759;;;
760;;; Miscellaneous
761;;;
762
763(defun vc-rcs-check-headers ()
764 "Check if the current file has any headers in it."
765 (save-excursion
766 (goto-char (point-min))
767 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\
768\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t)))
769
770(defun vc-rcs-clear-headers ()
771 "Implementation of vc-clear-headers for RCS."
772 (let ((case-fold-search nil))
773 (goto-char (point-min))
774 (while (re-search-forward
775 (concat "\\$\\(Author\\|Date\\|Header\\|Id\\|Locker\\|Name\\|"
776 "RCSfile\\|Revision\\|Source\\|State\\): [^$\n]+\\$")
777 nil t)
778 (replace-match "$\\1$"))))
779
780(defun vc-rcs-rename-file (old new)
781 ;; Just move the master file (using vc-rcs-master-templates).
782 (vc-rename-master (vc-name old) new vc-rcs-master-templates))
783
784\f
785;;;
786;;; Internal functions
787;;;
788
8f98485f
AS
789(defun vc-rcs-workfile-is-newer (file)
790 "Return non-nil if FILE is newer than its RCS master.
791This likely means that FILE has been changed with respect
792to its master version."
793 (let ((file-time (nth 5 (file-attributes file)))
794 (master-time (nth 5 (file-attributes (vc-name file)))))
795 (or (> (nth 0 file-time) (nth 0 master-time))
796 (and (= (nth 0 file-time) (nth 0 master-time))
797 (> (nth 1 file-time) (nth 1 master-time))))))
798
799(defun vc-rcs-find-most-recent-rev (branch)
800 "Find most recent revision on BRANCH."
801 (goto-char (point-min))
802 (let ((latest-rev -1) value)
803 (while (re-search-forward (concat "^\\(" (regexp-quote branch)
804 "\\.\\([0-9]+\\)\\)\ndate[ \t]+[0-9.]+;")
805 nil t)
806 (let ((rev (string-to-number (match-string 2))))
807 (when (< latest-rev rev)
808 (setq latest-rev rev)
809 (setq value (match-string 1)))))
810 (or value
7735770b 811 (vc-branch-part branch))))
8f98485f
AS
812
813(defun vc-rcs-fetch-master-state (file &optional workfile-version)
814 "Compute the master file's idea of the state of FILE.
815If a WORKFILE-VERSION is given, compute the state of that version,
816otherwise determine the workfile version based on the master file.
817This function sets the properties `vc-workfile-version' and
818`vc-checkout-model' to their correct values, based on the master
819file."
820 (with-temp-buffer
ea28aa35
AS
821 (if (or (not (vc-insert-file (vc-name file) "^[0-9]"))
822 (progn (goto-char (point-min))
823 (not (looking-at "^head[ \t\n]+[^;]+;$"))))
824 (error "File %s is not an RCS master file" (vc-name file)))
8f98485f
AS
825 (let ((workfile-is-latest nil)
826 (default-branch (vc-parse-buffer "^branch[ \t\n]+\\([^;]*\\);" 1)))
827 (vc-file-setprop file 'vc-rcs-default-branch default-branch)
828 (unless workfile-version
829 ;; Workfile version not known yet. Determine that first. It
830 ;; is either the head of the trunk, the head of the default
831 ;; branch, or the "default branch" itself, if that is a full
832 ;; revision number.
833 (cond
834 ;; no default branch
835 ((or (not default-branch) (string= "" default-branch))
836 (setq workfile-version
837 (vc-parse-buffer "^head[ \t\n]+\\([^;]+\\);" 1))
838 (setq workfile-is-latest t))
839 ;; default branch is actually a revision
840 ((string-match "^[0-9]+\\.[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*$"
841 default-branch)
842 (setq workfile-version default-branch))
843 ;; else, search for the head of the default branch
844 (t (vc-insert-file (vc-name file) "^desc")
845 (setq workfile-version
846 (vc-rcs-find-most-recent-rev default-branch))
847 (setq workfile-is-latest t)))
848 (vc-file-setprop file 'vc-workfile-version workfile-version))
849 ;; Check strict locking
850 (goto-char (point-min))
851 (vc-file-setprop file 'vc-checkout-model
852 (if (re-search-forward ";[ \t\n]*strict;" nil t)
853 'locking 'implicit))
854 ;; Compute state of workfile version
855 (goto-char (point-min))
856 (let ((locking-user
857 (vc-parse-buffer (concat "^locks[ \t\n]+[^;]*[ \t\n]+\\([^:]+\\):"
858 (regexp-quote workfile-version)
859 "[^0-9.]")
860 1)))
861 (cond
862 ;; not locked
863 ((not locking-user)
864 (if (or workfile-is-latest
865 (vc-rcs-latest-on-branch-p file workfile-version))
866 ;; workfile version is latest on branch
036f45fa 867 'up-to-date
8f98485f
AS
868 ;; workfile version is not latest on branch
869 'needs-patch))
870 ;; locked by the calling user
871 ((and (stringp locking-user)
4f147528 872 (string= locking-user (vc-user-login-name file)))
8f98485f
AS
873 (if (or (eq (vc-checkout-model file) 'locking)
874 workfile-is-latest
875 (vc-rcs-latest-on-branch-p file workfile-version))
876 'edited
877 ;; Locking is not used for the file, but the owner does
878 ;; have a lock, and there is a higher version on the current
879 ;; branch. Not sure if this can occur, and if it is right
880 ;; to use `needs-merge' in this case.
881 'needs-merge))
882 ;; locked by somebody else
883 ((stringp locking-user)
884 locking-user)
885 (t
886 (error "Error getting state of RCS file")))))))
887
888(defun vc-rcs-consult-headers (file)
889 "Search for RCS headers in FILE, and set properties accordingly.
890
891Returns: nil if no headers were found
892 'rev if a workfile revision was found
893 'rev-and-lock if revision and lock info was found"
894 (cond
895 ((not (get-file-buffer file)) nil)
896 ((let (status version locking-user)
897 (save-excursion
898 (set-buffer (get-file-buffer file))
899 (goto-char (point-min))
900 (cond
901 ;; search for $Id or $Header
902 ;; -------------------------
903 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
904 ((or (and (search-forward "$Id\ : " nil t)
905 (looking-at "[^ ]+ \\([0-9.]+\\) "))
906 (and (progn (goto-char (point-min))
907 (search-forward "$Header\ : " nil t))
908 (looking-at "[^ ]+ \\([0-9.]+\\) ")))
909 (goto-char (match-end 0))
910 ;; if found, store the revision number ...
911 (setq version (match-string-no-properties 1))
912 ;; ... and check for the locking state
913 (cond
914 ((looking-at
915 (concat "[0-9]+[/-][01][0-9][/-][0-3][0-9] " ; date
916 "[0-2][0-9]:[0-5][0-9]+:[0-6][0-9]+\\([+-][0-9:]+\\)? " ; time
917 "[^ ]+ [^ ]+ ")) ; author & state
918 (goto-char (match-end 0)) ; [0-6] in regexp handles leap seconds
919 (cond
920 ;; unlocked revision
921 ((looking-at "\\$")
922 (setq locking-user 'none)
923 (setq status 'rev-and-lock))
924 ;; revision is locked by some user
925 ((looking-at "\\([^ ]+\\) \\$")
926 (setq locking-user (match-string-no-properties 1))
927 (setq status 'rev-and-lock))
928 ;; everything else: false
929 (nil)))
930 ;; unexpected information in
931 ;; keyword string --> quit
932 (nil)))
933 ;; search for $Revision
934 ;; --------------------
935 ((re-search-forward (concat "\\$"
936 "Revision: \\([0-9.]+\\) \\$")
937 nil t)
938 ;; if found, store the revision number ...
939 (setq version (match-string-no-properties 1))
940 ;; and see if there's any lock information
941 (goto-char (point-min))
942 (if (re-search-forward (concat "\\$" "Locker:") nil t)
943 (cond ((looking-at " \\([^ ]+\\) \\$")
944 (setq locking-user (match-string-no-properties 1))
945 (setq status 'rev-and-lock))
946 ((looking-at " *\\$")
947 (setq locking-user 'none)
948 (setq status 'rev-and-lock))
949 (t
950 (setq locking-user 'none)
951 (setq status 'rev-and-lock)))
952 (setq status 'rev)))
953 ;; else: nothing found
954 ;; -------------------
955 (t nil)))
956 (if status (vc-file-setprop file 'vc-workfile-version version))
957 (and (eq status 'rev-and-lock)
958 (vc-file-setprop file 'vc-state
959 (cond
960 ((eq locking-user 'none) 'up-to-date)
53cc5b9c 961 ((string= locking-user (vc-user-login-name file))
4f147528 962 'edited)
8f98485f
AS
963 (t locking-user)))
964 ;; If the file has headers, we don't want to query the
965 ;; master file, because that would eliminate all the
966 ;; performance gain the headers brought us. We therefore
967 ;; use a heuristic now to find out whether locking is used
968 ;; for this file. If we trust the file permissions, and the
969 ;; file is not locked, then if the file is read-only we
970 ;; assume that locking is used for the file, otherwise
971 ;; locking is not used.
972 (not (vc-mistrust-permissions file))
973 (vc-up-to-date-p file)
974 (if (string-match ".r-..-..-." (nth 8 (file-attributes file)))
975 (vc-file-setprop file 'vc-checkout-model 'locking)
976 (vc-file-setprop file 'vc-checkout-model 'implicit)))
977 status))))
978
979(defun vc-release-greater-or-equal (r1 r2)
980 "Compare release numbers, represented as strings.
981Release components are assumed cardinal numbers, not decimal fractions
982\(5.10 is a higher release than 5.9\). Omitted fields are considered
983lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
984of the string is found, or a non-numeric component shows up \(5.6.7 is
985earlier than \"5.6.7 beta\", which is probably not what you want in
986some cases\). This code is suitable for existing RCS release numbers.
987CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
988 (let (v1 v2 i1 i2)
989 (catch 'done
990 (or (and (string-match "^\\.?\\([0-9]+\\)" r1)
991 (setq i1 (match-end 0))
992 (setq v1 (string-to-number (match-string 1 r1)))
993 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
994 (setq i2 (match-end 0))
995 (setq v2 (string-to-number (match-string 1 r2)))
996 (if (> v1 v2) (throw 'done t)
997 (if (< v1 v2) (throw 'done nil)
998 (throw 'done
999 (vc-release-greater-or-equal
1000 (substring r1 i1)
1001 (substring r2 i2)))))))
1002 (throw 'done t)))
1003 (or (and (string-match "^\\.?\\([0-9]+\\)" r2)
1004 (throw 'done nil))
1005 (throw 'done t)))))
1006
1007(defun vc-rcs-release-p (release)
1008 "Return t if we have RELEASE or better."
1009 (let ((installation (vc-rcs-system-release)))
1010 (if (and installation
1011 (not (eq installation 'unknown)))
1012 (vc-release-greater-or-equal installation release))))
1013
8f98485f
AS
1014(defun vc-rcs-system-release ()
1015 "Return the RCS release installed on this system, as a string.
1016Return symbol UNKNOWN if the release cannot be deducted. The user can
1017override this using variable `vc-rcs-release'.
1018
1019If the user has not set variable `vc-rcs-release' and it is nil,
1020variable `vc-rcs-release' is set to the returned value."
1021 (or vc-rcs-release
1022 (setq vc-rcs-release
1023 (or (and (zerop (vc-do-command nil nil "rcs" nil "-V"))
1024 (with-current-buffer (get-buffer "*vc*")
1025 (vc-parse-buffer "^RCS version \\([0-9.]+ *.*\\)" 1)))
1026 'unknown))))
1027
1028(defun vc-rcs-set-non-strict-locking (file)
1029 (vc-do-command nil 0 "rcs" file "-U")
1030 (vc-file-setprop file 'vc-checkout-model 'implicit)
1031 (set-file-modes file (logior (file-modes file) 128)))
1032
1033(defun vc-rcs-set-default-branch (file branch)
1034 (vc-do-command nil 0 "rcs" (vc-name file) (concat "-b" branch))
1035 (vc-file-setprop file 'vc-rcs-default-branch branch))
1036
3249f234
TTN
1037(defun vc-rcs-parse (&optional buffer)
1038 "Parse current buffer, presumed to be in RCS-style masterfile format.
1039Optional arg BUFFER specifies another buffer to parse. Return an alist
1040of two elements, w/ keys `headers' and `revisions' and values in turn
1041sub-alists. For `headers', the values unless otherwise specified are
1042strings and the keys are:
1043
1044 desc -- description
1045 head -- latest revision
1046 branch -- the branch the \"head revision\" lies on;
1047 absent if the head revision lies on the trunk
1048 access -- ???
1049 symbols -- sub-alist of (SYMBOL . REVISION) elements
1050 locks -- if file is checked out, something like \"ttn:1.7\"
1051 strict -- t if \"strict locking\" is in effect, otherwise nil
1052 comment -- may be absent; typically something like \"# \" or \"; \"
1053 expand -- may be absent; ???
1054
1055For `revisions', the car is REVISION (string), the cdr a sub-alist,
1056with string values (unless otherwise specified) and keys:
1057
1058 date -- a time value (like that returned by `encode-time'); as a
1059 special case, a year value less than 100 is augmented by 1900
1060 author -- username
1061 state -- typically \"Exp\" or \"Rel\"
1062 branches -- list of revisions that begin branches from this revision
1063 next -- on the trunk: the chronologically-preceding revision, or \"\";
1064 on a branch: the chronologically-following revision, or \"\"
1065 log -- change log entry
1066 text -- for the head revision on the trunk, the body of the file;
1067 other revisions have `:insn' instead
1068 :insn -- for non-head revisions, a list of parsed instructions
1069 in one of two forms, in both cases START meaning \"first
1070 go to line START\":
1071 - `(START k COUNT)' -- kill COUNT lines
1072 - `(START i TEXT)' -- insert TEXT (a string)
1073 The list is in descending order by START.
1074
1075The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1076 (setq buffer (get-buffer (or buffer (current-buffer))))
1077 (set-buffer buffer)
1078 ;; An RCS masterfile can be viewed as containing four regular (for the
1079 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1080 ;; the "description" and (d) the "rev bodies", in that order. In the
1081 ;; returned alist (see docstring), elements from (b) and (d) are
1082 ;; combined pairwise to form the "revisions", while those from (a) and
1083 ;; (c) are simply combined to form the "headers".
1084 ;;
1085 ;; Loosely speaking, each section contains a series of alternating
1086 ;; "tags" and "printed representations". In the (b) and (d), many
1087 ;; such series can appear, and a revision number on a line by itself
1088 ;; precedes the series of tags and printed representations associated
1089 ;; with it.
1090 ;;
1091 ;; In (a) and (b), the printed representations (with the exception of
1092 ;; the `comment' tag in the headers) terminate with a semicolon, which
1093 ;; is NOT part of the "value" finally associated with the tag. All
1094 ;; other printed representations are in "@@-format"; there is an "@",
1095 ;; the middle part (to be translated into the value), another "@" and
1096 ;; a newline. Each "@@" in the middle part indicates the position of
1097 ;; a single "@" (and consequently the requirement of an additional
1098 ;; initial step when translating to the value).
1099 ;;
1100 ;; Parser state includes vars that collect parts of the return value...
1101 (let ((desc nil) (headers nil) (revs nil)
1102 ;; ... as well as vars that support a single-pass, tag-assisted,
1103 ;; minimal-data-copying scan. Basically -- skirting around the
1104 ;; grouping by revision required in (b) and (d) -- we repeatedly
1105 ;; and context-sensitively read a tag (that MUST be present),
1106 ;; determine the bounds of the printed representation, translate
1107 ;; it into a value, and push the tag plus value onto one of the
1108 ;; collection vars. Finally, we return the parse tree
1109 ;; incorporating the values of the collection vars (see "rv").
1110 ;;
1111 ;; A symbol or string to keep track of context (for error messages).
1112 context
1113 ;; A symbol, the current tag.
1114 tok
1115 ;; Region (begin and end buffer positions) of the printed
1116 ;; representation for the current tag.
1117 b e
1118 ;; A list of buffer positions where "@@" can be found within the
1119 ;; printed representation region. For each location, we push two
1120 ;; elements onto the list, 1+ and 2+ the location, respectively,
1121 ;; with the 2+ appearing at the head. In this way, the expression
1122 ;; `(,e ,@@-holes ,b)
1123 ;; describes regions that can be concatenated (in reverse order)
1124 ;; to "de-@@-format" the printed representation as the first step
1125 ;; to translating it into some value. See internal func `gather'.
1126 @-holes)
1127 (flet ((sw () (skip-chars-forward " \t\n")) ; i.e., `[:space:]'
1128 (at (tag) (save-excursion (eq tag (read buffer))))
1129 (to-eol () (buffer-substring-no-properties
1130 (point) (progn (forward-line 1)
1131 (1- (point)))))
1132 (to-semi () (setq b (point)
1133 e (progn (search-forward ";")
1134 (1- (point)))))
1135 (to-one@ () (setq @-holes nil
1136 b (progn (search-forward "@") (point))
1137 e (progn (while (and (search-forward "@")
1138 (= ?@ (char-after))
1139 (progn
1140 (push (point) @-holes)
1141 (forward-char 1)
1142 (push (point) @-holes))))
1143 (1- (point)))))
1144 (tok+val (set-b+e name &optional proc)
1145 (unless (eq name (setq tok (read buffer)))
1146 (error "Missing `%s' while parsing %s" name context))
1147 (sw)
1148 (funcall set-b+e)
1149 (cons tok (if proc
1150 (funcall proc)
1151 (buffer-substring-no-properties b e))))
1152 (k-semi (name &optional proc) (tok+val 'to-semi name proc))
1153 (gather () (let ((pairs `(,e ,@@-holes ,b))
1154 acc)
1155 (while pairs
1156 (push (buffer-substring-no-properties
1157 (cadr pairs) (car pairs))
1158 acc)
1159 (setq pairs (cddr pairs)))
1160 (apply 'concat acc)))
1161 (k-one@ (name &optional later) (tok+val 'to-one@ name
1162 (if later
1163 (lambda () t)
1164 'gather))))
1165 (save-excursion
1166 (goto-char (point-min))
1167 ;; headers
1168 (setq context 'headers)
1169 (flet ((hpush (name &optional proc)
1170 (push (k-semi name proc) headers)))
1171 (hpush 'head)
1172 (when (at 'branch)
1173 (hpush 'branch))
1174 (hpush 'access)
1175 (hpush 'symbols
1176 (lambda ()
1177 (mapcar (lambda (together)
1178 (let ((two (split-string together ":")))
1179 (setcar two (intern (car two)))
1180 (setcdr two (cadr two))
1181 two))
1182 (split-string
1183 (buffer-substring-no-properties b e)))))
1184 (hpush 'locks))
1185 (push `(strict . ,(when (at 'strict)
1186 (search-forward ";")
1187 t))
1188 headers)
1189 (when (at 'comment)
1190 (push (k-one@ 'comment) headers)
1191 (search-forward ";"))
1192 (when (at 'expand)
1193 (push (k-one@ 'expand) headers)
1194 (search-forward ";"))
1195 (setq headers (nreverse headers))
1196 ;; rev headers
1197 (sw) (setq context 'rev-headers)
1198 (while (looking-at "[0-9]")
1199 (push `(,(to-eol)
1200 ,(k-semi 'date
1201 (lambda ()
1202 (let ((ls (mapcar 'string-to-number
1203 (split-string
1204 (buffer-substring-no-properties
1205 b e)
1206 "\\."))))
1207 ;; Hack the year -- verified to be the
1208 ;; same algorithm used in RCS 5.7.
1209 (when (< (car ls) 100)
1210 (setcar ls (+ 1900 (car ls))))
1211 (apply 'encode-time (nreverse ls)))))
1212 ,@(mapcar 'k-semi '(author state))
1213 ,(k-semi 'branches
1214 (lambda ()
1215 (split-string
1216 (buffer-substring-no-properties b e))))
1217 ,(k-semi 'next))
1218 revs)
1219 (sw))
1220 (setq revs (nreverse revs))
1221 ;; desc
1222 (sw) (setq context 'desc
1223 desc (k-one@ 'desc))
1224 ;; rev bodies
1225 (let (acc
1226 ;; Element of `revs' that initially holds only header info.
1227 ;; "Pairwise combination" occurs when we add body info.
1228 rev
1229 ;; Components of the editing commands (aside from the actual
1230 ;; text) that comprise the `text' printed representations
1231 ;; (not including the "head" revision).
1232 cmd start act
1233 ;; Ascending (reversed) `@-holes' which the internal func
1234 ;; `incg' pops to effect incremental gathering.
1235 asc
1236 ;; Function to extract text (for the `a' command), either
1237 ;; `incg' or `buffer-substring-no-properties'. (This is
1238 ;; for speed; strictly speaking, it is sufficient to use
1239 ;; only the former since it behaves identically to the
1240 ;; latter in the absense of "@@".)
1241 sub)
1242 (flet ((incg (beg end) (let ((b beg) (e end) @-holes)
1243 (while (and asc (< (car asc) e))
1244 (push (pop asc) @-holes))
1245 ;; Self-deprecate when work is done.
1246 ;; Folding many dimensions into one.
1247 ;; Thanks B.Mandelbrot, for complex sum.
1248 ;; O beauteous math! --the Unvexed Bum
1249 (unless asc
1250 (setq sub 'buffer-substring-no-properties))
1251 (gather))))
1252 (while (and (sw)
1253 (not (eobp))
1254 (setq context (to-eol)
1255 rev (or (assoc context revs)
1256 (error "Rev `%s' has body but no head"
1257 context))))
1258 (push (k-one@ 'log) (cdr rev))
1259 ;; For rev body `text' tags, delay translation slightly...
1260 (push (k-one@ 'text t) (cdr rev))
1261 ;; ... until we decide which tag and value is appropriate to
1262 ;; collect. For the "head" revision, compute the value of the
1263 ;; `text' printed representation by simple `gather'. For all
1264 ;; other revisions, replace the `text' tag+value with `:insn'
1265 ;; plus value, always scanning in-place.
1266 (if (string= context (cdr (assq 'head headers)))
1267 (setcdr (cadr rev) (gather))
1268 (if @-holes
1269 (setq asc (nreverse @-holes)
1270 sub 'incg)
1271 (setq sub 'buffer-substring-no-properties))
1272 (goto-char b)
1273 (setq acc nil)
1274 (while (< (point) e)
1275 (forward-char 1)
1276 (setq cmd (char-before)
1277 start (read (current-buffer))
1278 act (read (current-buffer)))
1279 (forward-char 1)
1280 (push (case cmd
1281 (?d
1282 ;; `d' means "delete lines".
1283 ;; For Emacs spirit, we use `k' for "kill".
1284 `(,start k ,act))
1285 (?a
1286 ;; `a' means "append after this line" but
1287 ;; internally we normalize it so that START
1288 ;; specifies the actual line for insert, thus
1289 ;; requiring less hair in the realization algs.
1290 ;; For Emacs spirit, we use `i' for "insert".
1291 `(,(1+ start) i
1292 ,(funcall sub (point) (progn (forward-line act)
1293 (point)))))
1294 (t (error "Bad command `%c' in `text' for rev `%s'"
1295 cmd context)))
1296 acc))
1297 (goto-char (1+ e))
1298 (setcar (cdr rev) (cons :insn acc)))))))
1299 ;; rv
1300 `((headers ,desc ,@headers)
1301 (revisions ,@revs)))))
1302
d8aff077
GM
1303(provide 'vc-rcs)
1304
fa63cb6d 1305;; arch-tag: 759b4916-5b0d-431d-b647-b185b8c652cf
d8aff077 1306;;; vc-rcs.el ends here