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