1 ;;; vc-rcs.el --- support for RCS version-control
3 ;; Copyright (C) 1992-2012 Free Software Foundation, Inc.
5 ;; Author: FSF (see vc.el for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Some features will not work with ancient RCS versions. Where
29 ;; appropriate, VC finds out which version you have, and allows or
30 ;; disallows those features.
32 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
37 ;;; Customization options
49 (defcustom vc-rcs-release nil
50 "The release number of your RCS installation, as a string.
51 If nil, VC itself computes this value when it is first needed."
52 :type
'(choice (const :tag
"Auto" nil
)
53 (string :tag
"Specified")
54 (const :tag
"Unknown" unknown
))
57 (defcustom vc-rcs-register-switches nil
58 "Switches for registering a file in RCS.
59 A string or list of strings passed to the checkin program by
60 \\[vc-register]. If nil, use the value of `vc-register-switches'.
61 If t, use no switches."
62 :type
'(choice (const :tag
"Unspecified" nil
)
64 (string :tag
"Argument String")
65 (repeat :tag
"Argument List" :value
("") string
))
69 (defcustom vc-rcs-diff-switches nil
70 "String or list of strings specifying switches for RCS diff under VC.
71 If nil, use the value of `vc-diff-switches'. If t, use no switches."
72 :type
'(choice (const :tag
"Unspecified" nil
)
74 (string :tag
"Argument String")
75 (repeat :tag
"Argument List" :value
("") string
))
79 (defcustom vc-rcs-header
'("\$Id\$")
80 "Header keywords to be inserted by `vc-insert-headers'."
81 :type
'(repeat string
)
82 :version
"24.1" ; no longer consult the obsolete vc-header-alist
85 (defcustom vc-rcsdiff-knows-brief nil
86 "Indicates whether rcsdiff understands the --brief option.
87 The value is either `yes', `no', or nil. If it is nil, VC tries
88 to use --brief and sets this variable to remember whether it worked."
89 :type
'(choice (const :tag
"Work out" nil
) (const yes
) (const no
))
93 (defcustom vc-rcs-master-templates
94 (purecopy '("%sRCS/%s,v" "%s%s,v" "%sRCS/%s"))
95 "Where to look for RCS master files.
96 For a description of possible values, see `vc-check-master-templates'."
97 :type
'(choice (const :tag
"Use standard RCS file names"
98 '("%sRCS/%s,v" "%s%s,v" "%sRCS/%s"))
99 (repeat :tag
"User-specified"
106 ;;; Properties of the backend
108 (defun vc-rcs-revision-granularity () 'file
)
110 (defun vc-rcs-checkout-model (files)
111 "RCS-specific version of `vc-checkout-model'."
112 (let ((file (if (consp files
) (car files
) files
))
114 (when vc-consult-headers
115 (vc-file-setprop file
'vc-checkout-model nil
)
116 (vc-rcs-consult-headers file
)
117 (setq result
(vc-file-getprop file
'vc-checkout-model
)))
119 (progn (vc-rcs-fetch-master-state file
)
120 (vc-file-getprop file
'vc-checkout-model
)))))
123 ;;; State-querying functions
126 ;; The autoload cookie below places vc-rcs-registered directly into
127 ;; loaddefs.el, so that vc-rcs.el does not need to be loaded for
128 ;; every file that is visited.
131 (defun vc-rcs-registered (f) (vc-default-registered 'RCS f
)))
133 (defun vc-rcs-state (file)
134 "Implementation of `vc-state' for RCS."
135 (if (not (vc-rcs-registered file
))
137 (or (boundp 'vc-rcs-headers-result
)
138 (and vc-consult-headers
139 (vc-rcs-consult-headers file
)))
141 ;; vc-working-revision might not be known; in that case the
142 ;; property is nil. vc-rcs-fetch-master-state knows how to
144 (vc-rcs-fetch-master-state file
145 (vc-file-getprop file
146 'vc-working-revision
))))
147 (if (not (eq state
'up-to-date
))
149 (if (vc-workfile-unchanged-p file
)
151 (if (eq (vc-rcs-checkout-model (list file
)) 'locking
)
155 (defun vc-rcs-state-heuristic (file)
156 "State heuristic for RCS."
157 (let (vc-rcs-headers-result)
158 (if (and vc-consult-headers
159 (setq vc-rcs-headers-result
160 (vc-rcs-consult-headers file
))
161 (eq vc-rcs-headers-result
'rev-and-lock
))
162 (let ((state (vc-file-getprop file
'vc-state
)))
163 ;; If the headers say that the file is not locked, the
164 ;; permissions can tell us whether locking is used for
166 (if (and (eq state
'up-to-date
)
167 (not (vc-mistrust-permissions file
))
168 (file-exists-p file
))
170 ((string-match ".rw..-..-." (nth 8 (file-attributes file
)))
171 (vc-file-setprop file
'vc-checkout-model
'implicit
)
173 (if (vc-rcs-workfile-is-newer file
)
176 ((string-match ".r-..-..-." (nth 8 (file-attributes file
)))
177 (vc-file-setprop file
'vc-checkout-model
'locking
))))
179 (if (not (vc-mistrust-permissions file
))
180 (let* ((attributes (file-attributes file
'string
))
181 (owner-name (nth 2 attributes
))
182 (permissions (nth 8 attributes
)))
183 (cond ((and permissions
(string-match ".r-..-..-." permissions
))
184 (vc-file-setprop file
'vc-checkout-model
'locking
)
186 ((and permissions
(string-match ".rw..-..-." permissions
))
187 (if (eq (vc-rcs-checkout-model file
) 'locking
)
188 (if (file-ownership-preserved-p file
)
191 (if (vc-rcs-workfile-is-newer file
)
195 ;; Strange permissions. Fall through to
196 ;; expensive state computation.
197 (vc-rcs-state file
))))
198 (vc-rcs-state file
)))))
200 (defun vc-rcs-dir-status (dir update-function
)
201 ;; FIXME: this function should be rewritten or `vc-expand-dirs'
202 ;; should be changed to take a backend parameter. Using
203 ;; `vc-expand-dirs' is not TRTD because it returns files from
204 ;; multiple backends. It should also return 'unregistered files.
206 ;; Doing individual vc-state calls is painful but there
207 ;; is no better way in RCS-land.
208 (let ((flist (vc-expand-dirs (list dir
)))
211 (let ((state (vc-state file
))
212 (frel (file-relative-name file
)))
213 (when (and (eq (vc-backend file
) 'RCS
)
214 (not (eq state
'up-to-date
)))
215 (push (list frel state
) result
))))
216 (funcall update-function result
)))
218 (defun vc-rcs-working-revision (file)
219 "RCS-specific version of `vc-working-revision'."
220 (or (and vc-consult-headers
221 (vc-rcs-consult-headers file
)
222 (vc-file-getprop file
'vc-working-revision
))
224 (vc-rcs-fetch-master-state file
)
225 (vc-file-getprop file
'vc-working-revision
))))
227 (defun vc-rcs-latest-on-branch-p (file &optional version
)
228 "Return non-nil if workfile version of FILE is the latest on its branch.
229 When VERSION is given, perform check for that version."
230 (unless version
(setq version
(vc-working-revision file
)))
233 (if (vc-rcs-trunk-p version
)
235 ;; Compare VERSION to the head version number.
236 (vc-insert-file (vc-name file
) "^[0-9]")
237 (vc-parse-buffer "^head[ \t\n]+\\([^;]+\\);" 1))
238 ;; If we are not on the trunk, we need to examine the
239 ;; whole current branch.
240 (vc-insert-file (vc-name file
) "^desc")
241 (vc-rcs-find-most-recent-rev (vc-branch-part version
))))))
243 (defun vc-rcs-workfile-unchanged-p (file)
244 "RCS-specific implementation of `vc-workfile-unchanged-p'."
245 ;; Try to use rcsdiff --brief. If rcsdiff does not understand that,
246 ;; do a double take and remember the fact for the future
247 (let* ((version (concat "-r" (vc-working-revision file
)))
248 (status (if (eq vc-rcsdiff-knows-brief
'no
)
249 (vc-do-command "*vc*" 1 "rcsdiff" file version
)
250 (vc-do-command "*vc*" 2 "rcsdiff" file
"--brief" version
))))
252 (if (not vc-rcsdiff-knows-brief
)
253 (setq vc-rcsdiff-knows-brief
'no
254 status
(vc-do-command "*vc*" 1 "rcsdiff" file version
))
255 (error "rcsdiff failed"))
256 (if (not vc-rcsdiff-knows-brief
) (setq vc-rcsdiff-knows-brief
'yes
)))
257 ;; The workfile is unchanged if rcsdiff found no differences.
262 ;;; State-changing functions
265 (defun vc-rcs-create-repo ()
266 "Create a new RCS repository."
267 ;; RCS is totally file-oriented, so all we have to do is make the directory.
268 (make-directory "RCS"))
270 (defun vc-rcs-register (files &optional rev comment
)
271 "Register FILES into the RCS version-control system.
272 REV is the optional revision number for the files. COMMENT can be used
273 to provide an initial description for each FILES.
274 Passes either `vc-rcs-register-switches' or `vc-register-switches'
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."
280 ;; When REV is specified, we need to force using "-t-".
281 (when rev
(unless comment
(setq comment
"")))
283 (and (not (file-exists-p
284 (setq subdir
(expand-file-name "RCS"
285 (file-name-directory file
)))))
286 (not (directory-files (file-name-directory file
)
288 (yes-or-no-p "Create RCS subdirectory? ")
289 (make-directory subdir
))
290 (apply 'vc-do-command
"*vc*" 0 "ci" file
291 ;; if available, use the secure registering option
292 (and (vc-rcs-release-p "5.6.4") "-i")
293 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
294 (and comment
(concat "-t-" comment
))
295 (vc-switches 'RCS
'register
))
296 ;; parse output to find master file name and workfile version
297 (with-current-buffer "*vc*"
298 (goto-char (point-min))
300 (if (looking-at (concat "^\\(.*\\) <-- "
301 (file-name-nondirectory file
)))
303 ;; if we couldn't find the master name,
304 ;; run vc-rcs-registered to get it
305 ;; (will be stored into the vc-name property)
306 (vc-rcs-registered file
)
307 (vc-file-setprop file
'vc-name
308 (if (file-name-absolute-p name
)
312 (file-name-directory file
))))))
313 (vc-file-setprop file
'vc-working-revision
314 (if (re-search-forward
315 "^initial revision: \\([0-9.]+\\).*\n"
317 (match-string 1))))))
319 (defun vc-rcs-responsible-p (file)
320 "Return non-nil if RCS thinks it would be responsible for registering FILE."
321 ;; TODO: check for all the patterns in vc-rcs-master-templates
322 (file-directory-p (expand-file-name "RCS"
323 (if (file-directory-p file
)
325 (file-name-directory file
)))))
327 (defun vc-rcs-receive-file (file rev
)
328 "Implementation of receive-file for RCS."
329 (let ((checkout-model (vc-rcs-checkout-model (list file
))))
330 (vc-rcs-register file rev
"")
331 (when (eq checkout-model
'implicit
)
332 (vc-rcs-set-non-strict-locking file
))
333 (vc-rcs-set-default-branch file
(concat rev
".1"))))
335 (defun vc-rcs-unregister (file)
336 "Unregister FILE from RCS.
337 If this leaves the RCS subdirectory empty, ask the user
338 whether to remove it."
339 (let* ((master (vc-name file
))
340 (dir (file-name-directory master
))
341 (backup-info (find-backup-file-name master
)))
342 (if (not backup-info
)
344 (rename-file master
(car backup-info
) 'ok-if-already-exists
)
345 (dolist (f (cdr backup-info
)) (ignore-errors (delete-file f
))))
346 (and (string= (file-name-nondirectory (directory-file-name dir
)) "RCS")
347 ;; check whether RCS dir is empty, i.e. it does not
348 ;; contain any files except "." and ".."
349 (not (directory-files dir nil
350 "^\\([^.]\\|\\.[^.]\\|\\.\\.[^.]\\).*"))
351 (yes-or-no-p (format "Directory %s is empty; remove it? " dir
))
352 (delete-directory dir
))))
354 (defun vc-rcs-checkin (files rev comment
)
355 "RCS-specific version of `vc-backend-checkin'."
356 (let ((switches (vc-switches 'RCS
'checkin
)))
357 ;; Now operate on the files
358 (dolist (file (vc-expand-dirs files
))
359 (let ((old-version (vc-working-revision file
)) new-version
360 (default-branch (vc-file-getprop file
'vc-rcs-default-branch
)))
361 ;; Force branch creation if an appropriate
362 ;; default branch has been set.
365 (string-match (concat "^" (regexp-quote old-version
) "\\.")
367 (setq rev default-branch
)
368 (setq switches
(cons "-f" switches
)))
369 (if (and (not rev
) old-version
)
370 (setq rev
(vc-branch-part old-version
)))
371 (apply 'vc-do-command
"*vc*" 0 "ci" (vc-name file
)
372 ;; if available, use the secure check-in option
373 (and (vc-rcs-release-p "5.6.4") "-j")
374 (concat (if vc-keep-workfiles
"-u" "-r") rev
)
375 (concat "-m" comment
)
377 (vc-file-setprop file
'vc-working-revision nil
)
379 ;; determine the new workfile version
381 (goto-char (point-min))
382 (when (or (re-search-forward
383 "new revision: \\([0-9.]+\\);" nil t
)
385 "reverting to previous revision \\([0-9.]+\\)" nil t
))
386 (setq new-version
(match-string 1))
387 (vc-file-setprop file
'vc-working-revision new-version
))
389 ;; if we got to a different branch, adjust the default
390 ;; branch accordingly
392 ((and old-version new-version
393 (not (string= (vc-branch-part old-version
)
394 (vc-branch-part new-version
))))
395 (vc-rcs-set-default-branch file
396 (if (vc-rcs-trunk-p new-version
) nil
397 (vc-branch-part new-version
)))
398 ;; If this is an old (pre-1992!) RCS release, we might have
399 ;; to remove a remaining lock.
400 (if (not (vc-rcs-release-p "5.6.2"))
401 ;; exit status of 1 is also accepted.
402 ;; It means that the lock was removed before.
403 (vc-do-command "*vc*" 1 "rcs" (vc-name file
)
404 (concat "-u" old-version
)))))))))
406 (defun vc-rcs-find-revision (file rev buffer
)
407 (apply 'vc-do-command
408 (or buffer
"*vc*") 0 "co" (vc-name file
)
409 "-q" ;; suppress diagnostic output
411 (vc-switches 'RCS
'checkout
)))
413 (defun vc-rcs-checkout (file &optional editable rev
)
414 "Retrieve a copy of a saved version of FILE. If FILE is a directory,
415 attempt the checkout for all registered files beneath it."
416 (if (file-directory-p file
)
417 (mapc 'vc-rcs-checkout
(vc-expand-dirs (list file
)))
418 (let ((file-buffer (get-file-buffer file
))
420 (message "Checking out %s..." file
)
422 ;; Change buffers to get local value of vc-checkout-switches.
423 (if file-buffer
(set-buffer file-buffer
))
424 (setq switches
(vc-switches 'RCS
'checkout
))
425 ;; Save this buffer's default-directory
426 ;; and use save-excursion to make sure it is restored
427 ;; in the same buffer it was saved in.
428 (let ((default-directory default-directory
))
430 ;; Adjust the default-directory so that the check-out creates
431 ;; the file in the right place.
432 (setq default-directory
(file-name-directory file
))
434 ;; if we should go to the head of the trunk,
435 ;; clear the default branch first
436 (and rev
(string= rev
"")
437 (vc-rcs-set-default-branch file nil
))
438 ;; now do the checkout
439 (apply 'vc-do-command
440 "*vc*" 0 "co" (vc-name file
)
441 ;; If locking is not strict, force to overwrite
442 ;; the writable workfile.
443 (if (eq (vc-rcs-checkout-model (list file
)) 'implicit
) "-f")
446 ;; a literal revision was specified
448 (let ((workrev (vc-working-revision file
)))
452 ;; no revision specified:
453 ;; use current workfile version
456 (if (not (vc-rcs-trunk-p workrev
))
457 ;; ... go to head of current branch
458 (vc-branch-part workrev
)
459 ;; ... go to head of trunk
460 (vc-rcs-set-default-branch file
464 ;; determine the new workfile version
465 (with-current-buffer "*vc*"
467 (vc-parse-buffer "^revision \\([0-9.]+\\).*\n" 1)))
468 (vc-file-setprop file
'vc-working-revision new-version
)
469 ;; if necessary, adjust the default branch
470 (and rev
(not (string= rev
""))
471 (vc-rcs-set-default-branch
473 (if (vc-rcs-latest-on-branch-p file new-version
)
474 (if (vc-rcs-trunk-p new-version
) nil
475 (vc-branch-part new-version
))
477 (message "Checking out %s...done" file
))))))
479 (defun vc-rcs-rollback (files)
480 "Roll back, undoing the most recent checkins of FILES. Directories are
481 expanded to all registered subfiles in them."
483 (error "RCS backend doesn't support directory-level rollback"))
484 (dolist (file (vc-expand-dirs files
))
485 (let* ((discard (vc-working-revision file
))
486 (previous (if (vc-rcs-trunk-p discard
) "" (vc-branch-part discard
)))
487 (config (current-window-configuration))
489 (if (null (yes-or-no-p (format "Remove version %s from %s history? "
492 (message "Removing revision %s from %s." discard file
)
493 (vc-do-command "*vc*" 0 "rcs" (vc-name file
) (concat "-o" discard
))
494 ;; Check out the most recent remaining version. If it
495 ;; fails, because the whole branch got deleted, do a
496 ;; double-take and check out the version where the branch
501 (vc-do-command "*vc*" 0 "co" (vc-name file
) "-f"
502 (concat "-u" previous
))
504 (error (set-buffer "*vc*")
505 (goto-char (point-min))
506 (if (search-forward "no side branches present for" nil t
)
507 (progn (setq previous
(vc-branch-part previous
))
508 (vc-rcs-set-default-branch file previous
)
509 ;; vc-do-command popped up a window with
510 ;; the error message. Get rid of it, by
511 ;; restoring the old window configuration.
512 (set-window-configuration config
))
513 ;; No, it was some other error: re-signal it.
514 (signal (car err
) (cdr err
)))))))))
516 (defun vc-rcs-revert (file &optional contents-done
)
517 "Revert FILE to the version it was based on. If FILE is a directory,
518 revert all registered files beneath it."
519 (if (file-directory-p file
)
520 (mapc 'vc-rcs-revert
(vc-expand-dirs (list file
)))
521 (vc-do-command "*vc*" 0 "co" (vc-name file
) "-f"
522 (concat (if (eq (vc-state file
) 'edited
) "-u" "-r")
523 (vc-working-revision file
)))))
525 (defun vc-rcs-merge (file first-version
&optional second-version
)
526 "Merge changes into current working copy of FILE.
527 The changes are between FIRST-VERSION and SECOND-VERSION."
528 (vc-do-command "*vc*" 1 "rcsmerge" (vc-name file
)
529 "-kk" ; ignore keyword conflicts
530 (concat "-r" first-version
)
531 (if second-version
(concat "-r" second-version
))))
533 (defun vc-rcs-steal-lock (file &optional rev
)
534 "Steal the lock on the current workfile for FILE and revision REV.
535 If FILE is a directory, steal the lock on all registered files beneath it.
536 Needs RCS 5.6.2 or later for -M."
537 (if (file-directory-p file
)
538 (mapc 'vc-rcs-steal-lock
(vc-expand-dirs (list file
)))
539 (vc-do-command "*vc*" 0 "rcs" (vc-name file
) "-M" (concat "-u" rev
))
540 ;; Do a real checkout after stealing the lock, so that we see
542 (vc-do-command "*vc*" 0 "co" (vc-name file
) "-f" (concat "-l" rev
))))
544 (defun vc-rcs-modify-change-comment (files rev comment
)
545 "Modify the change comments change on FILES on a specified REV. If FILE is a
546 directory the operation is applied to all registered files beneath it."
547 (dolist (file (vc-expand-dirs files
))
548 (vc-do-command "*vc*" 0 "rcs" (vc-name file
)
549 (concat "-m" rev
":" comment
))))
553 ;;; History functions
556 (defun vc-rcs-print-log-cleanup ()
557 (let ((inhibit-read-only t
))
558 (goto-char (point-max))
560 (while (looking-at "=*\n")
561 (delete-char (- (match-end 0) (match-beginning 0)))
563 (goto-char (point-min))
564 (when (looking-at "[\b\t\n\v\f\r ]+")
565 (delete-char (- (match-end 0) (match-beginning 0))))))
567 (defun vc-rcs-print-log (files buffer
&optional shortlog start-revision-ignored limit
)
568 "Get change log associated with FILE. If FILE is a
569 directory the operation is applied to all registered files beneath it."
570 (vc-do-command (or buffer
"*vc*") 0 "rlog" (mapcar 'vc-name
(vc-expand-dirs files
)))
571 (with-current-buffer (or buffer
"*vc*")
572 (vc-rcs-print-log-cleanup))
573 (when limit
'limit-unsupported
))
575 (defun vc-rcs-diff (files &optional oldvers newvers buffer
)
576 "Get a difference report using RCS between two sets of files."
577 (apply 'vc-do-command
(or buffer
"*vc-diff*")
578 1 ;; Always go synchronous, the repo is local
579 "rcsdiff" (vc-expand-dirs files
)
581 (and oldvers
(concat "-r" oldvers
))
582 (and newvers
(concat "-r" newvers
)))
583 (vc-switches 'RCS
'diff
))))
585 (defun vc-rcs-comment-history (file)
586 "Return a string with all log entries stored in BACKEND for FILE."
587 (with-current-buffer "*vc*"
588 ;; Has to be written this way, this function is used by the CVS backend too
589 (vc-call-backend (vc-backend file
) 'print-log
(list file
))
591 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
592 "\\(branches: .*;\n\\)?"
593 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
594 (goto-char (point-max)) (forward-line -
1)
595 (while (looking-at "=*\n")
596 (delete-char (- (match-end 0) (match-beginning 0)))
598 (goto-char (point-min))
599 (if (looking-at "[\b\t\n\v\f\r ]+")
600 (delete-char (- (match-end 0) (match-beginning 0))))
601 (goto-char (point-min))
602 (re-search-forward separator nil t
)
603 (delete-region (point-min) (point))
604 (while (re-search-forward separator nil t
)
605 (delete-region (match-beginning 0) (match-end 0))))
606 ;; Return the de-crufted comment list
609 (defun vc-rcs-annotate-command (file buffer
&optional revision
)
610 "Annotate FILE, inserting the results in BUFFER.
611 Optional arg REVISION is a revision to annotate from."
612 (vc-setup-buffer buffer
)
613 ;; Aside from the "head revision on the trunk", the instructions for
614 ;; each revision on the trunk are an ordered list of kill and insert
615 ;; commands necessary to go from the chronologically-following
616 ;; revision to this one. That is, associated with revision N are
617 ;; edits that applied to revision N+1 would result in revision N.
619 ;; On a branch, however, (some) things are inverted: the commands
620 ;; listed are those necessary to go from the chronologically-preceding
621 ;; revision to this one. That is, associated with revision N are
622 ;; edits that applied to revision N-1 would result in revision N.
624 ;; So, to get per-line history info, we apply reverse-chronological
625 ;; edits, starting with the head revision on the trunk, all the way
626 ;; back through the initial revision (typically "1.1" or similar),
627 ;; then apply forward-chronological edits -- keeping track of which
628 ;; revision is associated with each inserted line -- until we reach
629 ;; the desired revision for display (which may be either on the trunk
631 (let* ((tree (with-temp-buffer
632 (insert-file-contents (vc-rcs-registered file
))
634 (revisions (cdr (assq 'revisions tree
)))
635 ;; The revision N whose instructions we currently are processing.
636 (cur (cdr (assq 'head
(cdr (assq 'headers tree
)))))
637 ;; Alist from the parse tree for N.
638 (meta (cdr (assoc cur revisions
)))
639 ;; Point and temporary string, respectively.
641 ;; "Next-branch list". Nil means the desired revision to
642 ;; display lives on the trunk. Non-nil means it lives on a
643 ;; branch, in which case the value is a list of revision pairs
644 ;; (PARENT . CHILD), the first PARENT being on the trunk, that
645 ;; links each series of revisions in the path from the initial
646 ;; revision to the desired revision to display.
648 ;; "Path-accumulate-predicate plus revision/date/author".
649 ;; Until set, forward-chronological edits are not accumulated.
650 ;; Once set, its value (updated every revision) is used for
651 ;; the text property `:vc-rcs-r/d/a' for inserts during
652 ;; processing of forward-chronological instructions for N.
653 ;; See internal func `r/d/a'.
655 ;; List of forward-chronological instructions, each of the
656 ;; form: (POS . ACTION), where POS is a buffer position. If
657 ;; ACTION is a string, it is inserted, otherwise it is taken as
658 ;; the number of characters to be deleted.
660 ;; N+1. When `cur' is "", this is the initial revision.
664 (unless (assoc revision revisions
)
665 (error "No such revision: %s" revision
))
666 ;; Find which branches (if any) must be included in the edits.
669 (while (setq bpt
(vc-branch-part par
)
670 par
(vc-branch-part bpt
))
671 (setq kids
(cdr (assq 'branches
(cdr (assoc par revisions
)))))
672 ;; A branchpoint may have multiple children. Find the right one.
673 (while (not (string= bpt
(vc-branch-part (car kids
))))
674 (setq kids
(cdr kids
)))
675 (push (cons par
(car kids
)) nbls
)))
676 ;; Start with the full text.
678 (insert (cdr (assq 'text meta
)))
679 ;; Apply reverse-chronological edits on the trunk, computing and
680 ;; accumulating forward-chronological edits after some point, for
682 (cl-flet ((r/d
/a
() (vector pre
683 (cdr (assq 'date meta
))
684 (cdr (assq 'author meta
)))))
685 (while (when (setq pre cur cur
(cdr (assq 'next meta
)))
686 (not (string= "" cur
)))
688 ;; Start accumulating the forward-chronological edits when N+1
689 ;; on the trunk is either the desired revision to display, or
690 ;; the appropriate branchpoint for it. Do this before
691 ;; updating `meta' since `r/d/a' uses N+1's `meta' value.
692 prda
(when (or prda
(string= (if nbls
(caar nbls
) revision
) pre
))
694 meta
(cdr (assoc cur revisions
)))
695 ;; Edits in the parse tree specify a line number (in the buffer
696 ;; *BEFORE* editing occurs) to start from, but line numbers
697 ;; change as a result of edits. To DTRT, we apply edits in
698 ;; order of descending buffer position so that edits further
699 ;; down in the buffer occur first w/o corrupting specified
700 ;; buffer positions of edits occurring towards the beginning of
701 ;; the buffer. In this way we avoid using markers. A pleasant
702 ;; property of this approach is ability to push instructions
703 ;; onto `path' directly, w/o need to maintain rev boundaries.
704 (dolist (insn (cdr (assq :insn meta
)))
705 (goto-char (point-min))
706 (forward-line (1- (pop insn
)))
709 (`k
(setq s
(buffer-substring-no-properties
710 p
(progn (forward-line (car insn
))
713 (push `(,p .
,(propertize s
:vc-rcs-r
/d
/a prda
)) path
))
714 (delete-region p
(point)))
715 (`i
(setq s
(car insn
))
717 (push `(,p .
,(length s
)) path
))
719 ;; For the initial revision, setting `:vc-rcs-r/d/a' directly is
720 ;; equivalent to pushing an insert instruction (of the entire buffer
721 ;; contents) onto `path' then erasing the buffer, but less wasteful.
722 (put-text-property (point-min) (point-max) :vc-rcs-r
/d
/a
(r/d
/a
))
723 ;; Now apply the forward-chronological edits for the trunk.
725 (goto-char (pop insn
))
729 ;; Now apply the forward-chronological edits (directly from the
730 ;; parse-tree) for the branch(es), if necessary. We re-use vars
731 ;; `pre' and `meta' for the sake of internal func `r/d/a'.
733 (setq pre
(cdr (pop nbls
)))
735 (setq meta
(cdr (assoc pre revisions
))
737 (dolist (insn (cdr (assq :insn meta
)))
738 (goto-char (point-min))
739 (forward-line (1- (pop insn
)))
742 (point) (progn (forward-line (car insn
))
744 (`i
(insert (propertize
747 (or prda
(setq prda
(r/d
/a
))))))))
748 (prog1 (not (string= (if nbls
(caar nbls
) revision
) pre
))
749 (setq pre
(cdr (assq 'next meta
)))))))))
750 ;; Lastly, for each line, insert at bol nicely-formatted history info.
751 ;; We do two passes to collect summary information used to minimize
752 ;; the annotation's usage of screen real-estate: (1) Consider rendered
753 ;; width of revision plus author together as a unit; and (2) Omit
754 ;; author entirely if all authors are the same as the user.
755 (let ((ht (make-hash-table :test
'eq
))
756 (me (user-login-name))
760 (goto-char (point-max))
763 (setq rda
(get-text-property (point) :vc-rcs-r
/d
/a
))
764 (unless (gethash rda ht
)
766 all-me
(and all-me
(string= a me
)))
767 (puthash rda
(setq w
(+ (length (aref rda
0))
770 (setq maxw
(max w maxw
))))
771 (let ((padding (make-string maxw
32)))
772 (cl-flet ((pad (w) (substring-no-properties padding w
))
773 (render (rda &rest ls
)
776 (format-time-string "%Y-%m-%d" (aref rda
1))
780 :vc-annotate-prefix t
785 (puthash rda
(render rda
(pad w
) ": ") ht
))
787 (puthash rda
(render rda
" " (pad w
) " " (aref rda
2) ": ") ht
)))
790 (insert (gethash (get-text-property (point) :vc-rcs-r
/d
/a
) ht
))
793 (declare-function vc-annotate-convert-time
"vc-annotate" (time))
795 (defun vc-rcs-annotate-current-time ()
796 "Return the current time, based at midnight of the current day, and
797 encoded as fractional days."
798 (vc-annotate-convert-time
799 (apply 'encode-time
0 0 0 (nthcdr 3 (decode-time (current-time))))))
801 (defun vc-rcs-annotate-time ()
802 "Return the time of the next annotation (as fraction of days)
803 systime, or nil if there is none. Also, reposition point."
805 (prog1 (vc-annotate-convert-time
806 (aref (get-text-property (point) :vc-rcs-r
/d
/a
) 1))
807 (goto-char (next-single-property-change (point) :vc-annotate-prefix
)))))
809 (defun vc-rcs-annotate-extract-revision-at-line ()
810 (aref (get-text-property (point) :vc-rcs-r
/d
/a
) 0))
817 (defun vc-rcs-create-tag (dir name branchp
)
819 (error "RCS backend does not support module branches"))
820 (let ((result (vc-tag-precondition dir
)))
822 (error "File %s is not up-to-date" result
)
826 (vc-do-command "*vc*" 0 "rcs" (vc-name f
) (concat "-n" name
":")))))))
833 (defun vc-rcs-trunk-p (rev)
834 "Return t if REV is a revision on the trunk."
835 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
837 (defun vc-rcs-minor-part (rev)
838 "Return the minor revision number of a revision number REV."
839 (string-match "[0-9]+\\'" rev
)
840 (substring rev
(match-beginning 0) (match-end 0)))
842 (defun vc-rcs-previous-revision (file rev
)
843 "Return the revision number immediately preceding REV for FILE,
844 or nil if there is no previous revision. This default
845 implementation works for MAJOR.MINOR-style revision numbers as
846 used by RCS and CVS."
847 (let ((branch (vc-branch-part rev
))
848 (minor-num (string-to-number (vc-rcs-minor-part rev
))))
851 ;; revision does probably not start a branch or release
852 (concat branch
"." (number-to-string (1- minor-num
)))
853 (if (vc-rcs-trunk-p rev
)
854 ;; we are at the beginning of the trunk --
855 ;; don't know anything to return here
857 ;; we are at the beginning of a branch --
858 ;; return revision of starting point
859 (vc-branch-part branch
))))))
861 (defun vc-rcs-next-revision (file rev
)
862 "Return the revision number immediately following REV for FILE,
863 or nil if there is no next revision. This default implementation
864 works for MAJOR.MINOR-style revision numbers as used by RCS
866 (when (not (string= rev
(vc-working-revision file
)))
867 (let ((branch (vc-branch-part rev
))
868 (minor-num (string-to-number (vc-rcs-minor-part rev
))))
869 (concat branch
"." (number-to-string (1+ minor-num
))))))
871 ;; Note that most GNU/Linux distributions seem to supply rcs2log in a
872 ;; standard bin directory. Eg both Red Hat and Debian include it in
873 ;; their cvs packages. It's not obvious why Emacs still needs to
874 ;; provide it as well...
875 (defvar vc-rcs-rcs2log-program
877 (cond ((file-executable-p
878 (setq exe
(expand-file-name "rcs2log" exec-directory
)))
880 ;; In the unlikely event that someone is running an
881 ;; uninstalled Emacs and wants to do something RCS-related.
883 (setq exe
(expand-file-name "lib-src/rcs2log" source-directory
)))
886 "Path to the `rcs2log' program (normally in `exec-directory').")
888 (defun vc-rcs-update-changelog (files)
889 "Default implementation of update-changelog.
890 Uses `rcs2log' which only works for RCS and CVS."
891 ;; FIXME: We (c|sh)ould add support for cvs2cl
892 (let ((odefault default-directory
)
893 (changelog (find-change-log))
894 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
895 (tempfile (make-temp-file
896 (expand-file-name "vc"
897 (or small-temporary-file-directory
898 temporary-file-directory
))))
899 (login-name (or user-login-name
900 (format "uid%d" (number-to-string (user-uid)))))
901 (full-name (or add-log-full-name
904 (format "uid%d" (number-to-string (user-uid)))))
905 (mailing-address (or add-log-mailing-address
907 (find-file-other-window changelog
)
908 (barf-if-buffer-read-only)
911 (goto-char (point-min))
913 (message "Computing change log entries...")
914 (message "Computing change log entries... %s"
917 (setq default-directory odefault
)
918 (if (eq 0 (apply 'call-process vc-rcs-rcs2log-program
919 nil
(list t tempfile
) nil
921 "-u" (concat login-name
923 "\t" mailing-address
)
927 (expand-file-name f odefault
)))
930 (pop-to-buffer (get-buffer-create "*vc*"))
932 (insert-file-contents tempfile
)
934 (setq default-directory
(file-name-directory changelog
))
935 (delete-file tempfile
)))))
937 (defun vc-rcs-check-headers ()
938 "Check if the current file has any headers in it."
940 (goto-char (point-min))
941 (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\
942 \\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t
)))
944 (defun vc-rcs-clear-headers ()
945 "Implementation of vc-clear-headers for RCS."
946 (let ((case-fold-search nil
))
947 (goto-char (point-min))
948 (while (re-search-forward
949 (concat "\\$\\(Author\\|Date\\|Header\\|Id\\|Locker\\|Name\\|"
950 "RCSfile\\|Revision\\|Source\\|State\\): [^$\n]+\\$")
952 (replace-match "$\\1$"))))
954 (defun vc-rcs-rename-file (old new
)
955 ;; Just move the master file (using vc-rcs-master-templates).
956 (vc-rename-master (vc-name old
) new vc-rcs-master-templates
))
958 (defun vc-rcs-find-file-hook ()
959 ;; If the file is locked by some other user, make
960 ;; the buffer read-only. Like this, even root
961 ;; cannot modify a file that someone else has locked.
962 (and (stringp (vc-state buffer-file-name
'RCS
))
963 (setq buffer-read-only t
)))
967 ;;; Internal functions
970 (defun vc-rcs-workfile-is-newer (file)
971 "Return non-nil if FILE is newer than its RCS master.
972 This likely means that FILE has been changed with respect
973 to its master version."
974 (let ((file-time (nth 5 (file-attributes file
)))
975 (master-time (nth 5 (file-attributes (vc-name file
)))))
976 (or (> (nth 0 file-time
) (nth 0 master-time
))
977 (and (= (nth 0 file-time
) (nth 0 master-time
))
978 (> (nth 1 file-time
) (nth 1 master-time
))))))
980 (defun vc-rcs-find-most-recent-rev (branch)
981 "Find most recent revision on BRANCH."
982 (goto-char (point-min))
983 (let ((latest-rev -
1) value
)
984 (while (re-search-forward (concat "^\\(" (regexp-quote branch
)
985 "\\.\\([0-9]+\\)\\)\ndate[ \t]+[0-9.]+;")
987 (let ((rev (string-to-number (match-string 2))))
988 (when (< latest-rev rev
)
989 (setq latest-rev rev
)
990 (setq value
(match-string 1)))))
992 (vc-branch-part branch
))))
994 (defun vc-rcs-fetch-master-state (file &optional working-revision
)
995 "Compute the master file's idea of the state of FILE.
996 If a WORKING-REVISION is given, compute the state of that version,
997 otherwise determine the workfile version based on the master file.
998 This function sets the properties `vc-working-revision' and
999 `vc-checkout-model' to their correct values, based on the master
1002 (if (or (not (vc-insert-file (vc-name file
) "^[0-9]"))
1003 (progn (goto-char (point-min))
1004 (not (looking-at "^head[ \t\n]+[^;]+;$"))))
1005 (error "File %s is not an RCS master file" (vc-name file
)))
1006 (let ((workfile-is-latest nil
)
1007 (default-branch (vc-parse-buffer "^branch[ \t\n]+\\([^;]*\\);" 1)))
1008 (vc-file-setprop file
'vc-rcs-default-branch default-branch
)
1009 (unless working-revision
1010 ;; Workfile version not known yet. Determine that first. It
1011 ;; is either the head of the trunk, the head of the default
1012 ;; branch, or the "default branch" itself, if that is a full
1015 ;; no default branch
1016 ((or (not default-branch
) (string= "" default-branch
))
1017 (setq working-revision
1018 (vc-parse-buffer "^head[ \t\n]+\\([^;]+\\);" 1))
1019 (setq workfile-is-latest t
))
1020 ;; default branch is actually a revision
1021 ((string-match "^[0-9]+\\.[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*$"
1023 (setq working-revision default-branch
))
1024 ;; else, search for the head of the default branch
1025 (t (vc-insert-file (vc-name file
) "^desc")
1026 (setq working-revision
1027 (vc-rcs-find-most-recent-rev default-branch
))
1028 (setq workfile-is-latest t
)))
1029 (vc-file-setprop file
'vc-working-revision working-revision
))
1030 ;; Check strict locking
1031 (goto-char (point-min))
1032 (vc-file-setprop file
'vc-checkout-model
1033 (if (re-search-forward ";[ \t\n]*strict;" nil t
)
1034 'locking
'implicit
))
1035 ;; Compute state of workfile version
1036 (goto-char (point-min))
1038 (vc-parse-buffer (concat "^locks[ \t\n]+[^;]*[ \t\n]+\\([^:]+\\):"
1039 (regexp-quote working-revision
)
1045 (if (or workfile-is-latest
1046 (vc-rcs-latest-on-branch-p file working-revision
))
1047 ;; workfile version is latest on branch
1049 ;; workfile version is not latest on branch
1051 ;; locked by the calling user
1052 ((and (stringp locking-user
)
1053 (string= locking-user
(vc-user-login-name file
)))
1054 ;; Don't call `vc-rcs-checkout-model' to avoid inf-looping.
1055 (if (or (eq (vc-file-getprop file
'vc-checkout-model
) 'locking
)
1057 (vc-rcs-latest-on-branch-p file working-revision
))
1059 ;; Locking is not used for the file, but the owner does
1060 ;; have a lock, and there is a higher version on the current
1061 ;; branch. Not sure if this can occur, and if it is right
1062 ;; to use `needs-merge' in this case.
1064 ;; locked by somebody else
1065 ((stringp locking-user
)
1068 (error "Error getting state of RCS file")))))))
1070 (defun vc-rcs-consult-headers (file)
1071 "Search for RCS headers in FILE, and set properties accordingly.
1073 Returns: nil if no headers were found
1074 'rev if a workfile revision was found
1075 'rev-and-lock if revision and lock info was found"
1077 ((not (get-file-buffer file
)) nil
)
1078 ((let (status version locking-user
)
1079 (with-current-buffer (get-file-buffer file
)
1081 (goto-char (point-min))
1083 ;; search for $Id or $Header
1084 ;; -------------------------
1085 ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
1086 ((or (and (search-forward "$Id\ : " nil t
)
1087 (looking-at "[^ ]+ \\([0-9.]+\\) "))
1088 (and (progn (goto-char (point-min))
1089 (search-forward "$Header\ : " nil t
))
1090 (looking-at "[^ ]+ \\([0-9.]+\\) ")))
1091 (goto-char (match-end 0))
1092 ;; if found, store the revision number ...
1093 (setq version
(match-string-no-properties 1))
1094 ;; ... and check for the locking state
1097 (concat "[0-9]+[/-][01][0-9][/-][0-3][0-9] " ; date
1098 "[0-2][0-9]:[0-5][0-9]+:[0-6][0-9]+\\([+-][0-9:]+\\)? " ; time
1099 "[^ ]+ [^ ]+ ")) ; author & state
1100 (goto-char (match-end 0)) ; [0-6] in regexp handles leap seconds
1102 ;; unlocked revision
1104 (setq locking-user
'none
)
1105 (setq status
'rev-and-lock
))
1106 ;; revision is locked by some user
1107 ((looking-at "\\([^ ]+\\) \\$")
1108 (setq locking-user
(match-string-no-properties 1))
1109 (setq status
'rev-and-lock
))
1110 ;; everything else: false
1112 ;; unexpected information in
1113 ;; keyword string --> quit
1115 ;; search for $Revision
1116 ;; --------------------
1117 ((re-search-forward (concat "\\$"
1118 "Revision: \\([0-9.]+\\) \\$")
1120 ;; if found, store the revision number ...
1121 (setq version
(match-string-no-properties 1))
1122 ;; and see if there's any lock information
1123 (goto-char (point-min))
1124 (if (re-search-forward (concat "\\$" "Locker:") nil t
)
1125 (cond ((looking-at " \\([^ ]+\\) \\$")
1126 (setq locking-user
(match-string-no-properties 1))
1127 (setq status
'rev-and-lock
))
1128 ((looking-at " *\\$")
1129 (setq locking-user
'none
)
1130 (setq status
'rev-and-lock
))
1132 (setq locking-user
'none
)
1133 (setq status
'rev-and-lock
)))
1134 (setq status
'rev
)))
1135 ;; else: nothing found
1136 ;; -------------------
1138 (if status
(vc-file-setprop file
'vc-working-revision version
))
1139 (and (eq status
'rev-and-lock
)
1140 (vc-file-setprop file
'vc-state
1142 ((eq locking-user
'none
) 'up-to-date
)
1143 ((string= locking-user
(vc-user-login-name file
))
1146 ;; If the file has headers, we don't want to query the
1147 ;; master file, because that would eliminate all the
1148 ;; performance gain the headers brought us. We therefore
1149 ;; use a heuristic now to find out whether locking is used
1150 ;; for this file. If we trust the file permissions, and the
1151 ;; file is not locked, then if the file is read-only we
1152 ;; assume that locking is used for the file, otherwise
1153 ;; locking is not used.
1154 (not (vc-mistrust-permissions file
))
1155 (vc-up-to-date-p file
)
1156 (if (string-match ".r-..-..-." (nth 8 (file-attributes file
)))
1157 (vc-file-setprop file
'vc-checkout-model
'locking
)
1158 (vc-file-setprop file
'vc-checkout-model
'implicit
)))
1161 (defun vc-release-greater-or-equal (r1 r2
)
1162 "Compare release numbers, represented as strings.
1163 Release components are assumed cardinal numbers, not decimal fractions
1164 \(5.10 is a higher release than 5.9\). Omitted fields are considered
1165 lower \(5.6.7 is earlier than 5.6.7.1\). Comparison runs till the end
1166 of the string is found, or a non-numeric component shows up \(5.6.7 is
1167 earlier than \"5.6.7 beta\", which is probably not what you want in
1168 some cases\). This code is suitable for existing RCS release numbers.
1169 CVS releases are handled reasonably, too \(1.3 < 1.4* < 1.5\)."
1172 (or (and (string-match "^\\.?\\([0-9]+\\)" r1
)
1173 (setq i1
(match-end 0))
1174 (setq v1
(string-to-number (match-string 1 r1
)))
1175 (or (and (string-match "^\\.?\\([0-9]+\\)" r2
)
1176 (setq i2
(match-end 0))
1177 (setq v2
(string-to-number (match-string 1 r2
)))
1178 (if (> v1 v2
) (throw 'done t
)
1179 (if (< v1 v2
) (throw 'done nil
)
1181 (vc-release-greater-or-equal
1183 (substring r2 i2
)))))))
1185 (or (and (string-match "^\\.?\\([0-9]+\\)" r2
)
1189 (defun vc-rcs-release-p (release)
1190 "Return t if we have RELEASE or better."
1191 (let ((installation (vc-rcs-system-release)))
1192 (if (and installation
1193 (not (eq installation
'unknown
)))
1194 (vc-release-greater-or-equal installation release
))))
1196 (defun vc-rcs-system-release ()
1197 "Return the RCS release installed on this system, as a string.
1198 Return symbol `unknown' if the release cannot be deducted. The user can
1199 override this using variable `vc-rcs-release'.
1201 If the user has not set variable `vc-rcs-release' and it is nil,
1202 variable `vc-rcs-release' is set to the returned value."
1204 (setq vc-rcs-release
1205 (or (and (zerop (vc-do-command "*vc*" nil
"rcs" nil
"-V"))
1206 (with-current-buffer (get-buffer "*vc*")
1207 (vc-parse-buffer "^RCS version \\([0-9.]+ *.*\\)" 1)))
1210 (defun vc-rcs-set-non-strict-locking (file)
1211 (vc-do-command "*vc*" 0 "rcs" file
"-U")
1212 (vc-file-setprop file
'vc-checkout-model
'implicit
)
1213 (set-file-modes file
(logior (file-modes file
) 128)))
1215 (defun vc-rcs-set-default-branch (file branch
)
1216 (vc-do-command "*vc*" 0 "rcs" (vc-name file
) (concat "-b" branch
))
1217 (vc-file-setprop file
'vc-rcs-default-branch branch
))
1219 (defun vc-rcs-parse (&optional buffer
)
1220 "Parse current buffer, presumed to be in RCS-style masterfile format.
1221 Optional arg BUFFER specifies another buffer to parse. Return an alist
1222 of two elements, w/ keys `headers' and `revisions' and values in turn
1223 sub-alists. For `headers', the values unless otherwise specified are
1224 strings and the keys are:
1227 head -- latest revision
1228 branch -- the branch the \"head revision\" lies on;
1229 absent if the head revision lies on the trunk
1231 symbols -- sub-alist of (SYMBOL . REVISION) elements
1232 locks -- if file is checked out, something like \"ttn:1.7\"
1233 strict -- t if \"strict locking\" is in effect, otherwise nil
1234 comment -- may be absent; typically something like \"# \" or \"; \"
1235 expand -- may be absent; ???
1237 For `revisions', the car is REVISION (string), the cdr a sub-alist,
1238 with string values (unless otherwise specified) and keys:
1240 date -- a time value (like that returned by `encode-time'); as a
1241 special case, a year value less than 100 is augmented by 1900
1243 state -- typically \"Exp\" or \"Rel\"
1244 branches -- list of revisions that begin branches from this revision
1245 next -- on the trunk: the chronologically-preceding revision, or \"\";
1246 on a branch: the chronologically-following revision, or \"\"
1247 log -- change log entry
1248 text -- for the head revision on the trunk, the body of the file;
1249 other revisions have `:insn' instead
1250 :insn -- for non-head revisions, a list of parsed instructions
1251 in one of two forms, in both cases START meaning \"first
1253 - `(START k COUNT)' -- kill COUNT lines
1254 - `(START i TEXT)' -- insert TEXT (a string)
1255 The list is in descending order by START.
1257 The `:insn' key is a keyword to distinguish it as a vc-rcs.el extension."
1258 (setq buffer
(get-buffer (or buffer
(current-buffer))))
1260 ;; An RCS masterfile can be viewed as containing four regular (for the
1261 ;; most part) sections: (a) the "headers", (b) the "rev headers", (c)
1262 ;; the "description" and (d) the "rev bodies", in that order. In the
1263 ;; returned alist (see docstring), elements from (b) and (d) are
1264 ;; combined pairwise to form the "revisions", while those from (a) and
1265 ;; (c) are simply combined to form the "headers".
1267 ;; Loosely speaking, each section contains a series of alternating
1268 ;; "tags" and "printed representations". In the (b) and (d), many
1269 ;; such series can appear, and a revision number on a line by itself
1270 ;; precedes the series of tags and printed representations associated
1273 ;; In (a) and (b), the printed representations (with the exception of
1274 ;; the `comment' tag in the headers) terminate with a semicolon, which
1275 ;; is NOT part of the "value" finally associated with the tag. All
1276 ;; other printed representations are in "@@-format"; there is an "@",
1277 ;; the middle part (to be translated into the value), another "@" and
1278 ;; a newline. Each "@@" in the middle part indicates the position of
1279 ;; a single "@" (and consequently the requirement of an additional
1280 ;; initial step when translating to the value).
1282 ;; Parser state includes vars that collect parts of the return value...
1283 (let ((desc nil
) (headers nil
) (revs nil
)
1284 ;; ... as well as vars that support a single-pass, tag-assisted,
1285 ;; minimal-data-copying scan. Basically -- skirting around the
1286 ;; grouping by revision required in (b) and (d) -- we repeatedly
1287 ;; and context-sensitively read a tag (that MUST be present),
1288 ;; determine the bounds of the printed representation, translate
1289 ;; it into a value, and push the tag plus value onto one of the
1290 ;; collection vars. Finally, we return the parse tree
1291 ;; incorporating the values of the collection vars (see "rv").
1293 ;; A symbol or string to keep track of context (for error messages).
1295 ;; A symbol, the current tag.
1297 ;; Region (begin and end buffer positions) of the printed
1298 ;; representation for the current tag.
1300 ;; A list of buffer positions where "@@" can be found within the
1301 ;; printed representation region. For each location, we push two
1302 ;; elements onto the list, 1+ and 2+ the location, respectively,
1303 ;; with the 2+ appearing at the head. In this way, the expression
1304 ;; `(,e ,@@-holes ,b)
1305 ;; describes regions that can be concatenated (in reverse order)
1306 ;; to "de-@@-format" the printed representation as the first step
1307 ;; to translating it into some value. See internal func `gather'.
1310 ((sw () (skip-chars-forward " \t\n")) ; i.e., `[:space:]'
1311 (at (tag) (save-excursion (eq tag
(read buffer
))))
1312 (to-eol () (buffer-substring-no-properties
1313 (point) (progn (forward-line 1)
1315 (to-semi () (setq b
(point)
1316 e
(progn (search-forward ";")
1318 (to-one@ () (setq @-holes nil
1319 b
(progn (search-forward "@") (point))
1320 e
(progn (while (and (search-forward "@")
1323 (push (point) @-holes
)
1325 (push (point) @-holes
))))
1327 (tok+val
(set-b+e name
&optional proc
)
1328 (unless (eq name
(setq tok
(read buffer
)))
1329 (error "Missing `%s' while parsing %s" name context
))
1334 (buffer-substring-no-properties b e
))))
1335 (k-semi (name &optional proc
) (tok+val
#'to-semi name proc
))
1336 (gather () (let ((pairs `(,e
,@@-holes
,b
))
1339 (push (buffer-substring-no-properties
1340 (cadr pairs
) (car pairs
))
1342 (setq pairs
(cddr pairs
)))
1343 (apply 'concat acc
)))
1344 (k-one@ (name &optional later
) (tok+val
#'to-one
@ name
1349 (goto-char (point-min))
1351 (setq context
'headers
)
1352 (cl-flet ((hpush (name &optional proc
)
1353 (push (k-semi name proc
) headers
)))
1360 (mapcar (lambda (together)
1361 (let ((two (split-string together
":")))
1362 (setcar two
(intern (car two
)))
1363 (setcdr two
(cadr two
))
1366 (buffer-substring-no-properties b e
)))))
1368 (push `(strict .
,(when (at 'strict
)
1369 (search-forward ";")
1373 (push (k-one@ 'comment
) headers
)
1374 (search-forward ";"))
1376 (push (k-one@ 'expand
) headers
)
1377 (search-forward ";"))
1378 (setq headers
(nreverse headers
))
1380 (sw) (setq context
'rev-headers
)
1381 (while (looking-at "[0-9]")
1385 (let ((ls (mapcar 'string-to-number
1387 (buffer-substring-no-properties
1390 ;; Hack the year -- verified to be the
1391 ;; same algorithm used in RCS 5.7.
1392 (when (< (car ls
) 100)
1393 (setcar ls
(+ 1900 (car ls
))))
1394 (apply 'encode-time
(nreverse ls
)))))
1395 ,@(mapcar #'k-semi
'(author state
))
1399 (buffer-substring-no-properties b e
))))
1403 (setq revs
(nreverse revs
))
1405 (sw) (setq context
'desc
1406 desc
(k-one@ 'desc
))
1409 ;; Element of `revs' that initially holds only header info.
1410 ;; "Pairwise combination" occurs when we add body info.
1412 ;; Components of the editing commands (aside from the actual
1413 ;; text) that comprise the `text' printed representations
1414 ;; (not including the "head" revision).
1416 ;; Ascending (reversed) `@-holes' which the internal func
1417 ;; `incg' pops to effect incremental gathering.
1419 ;; Function to extract text (for the `a' command), either
1420 ;; `incg' or `buffer-substring-no-properties'. (This is
1421 ;; for speed; strictly speaking, it is sufficient to use
1422 ;; only the former since it behaves identically to the
1423 ;; latter in the absence of "@@".)
1425 (cl-flet ((incg (beg end
)
1426 (let ((b beg
) (e end
) @-holes
)
1427 (while (and asc
(< (car asc
) e
))
1428 (push (pop asc
) @-holes
))
1429 ;; Self-deprecate when work is done.
1430 ;; Folding many dimensions into one.
1431 ;; Thanks B.Mandelbrot, for complex sum.
1432 ;; O beauteous math! --the Unvexed Bum
1434 (setq sub
#'buffer-substring-no-properties
))
1438 (setq context
(to-eol)
1439 rev
(or (assoc context revs
)
1440 (error "Rev `%s' has body but no head"
1442 (push (k-one@ 'log
) (cdr rev
))
1443 ;; For rev body `text' tags, delay translation slightly...
1444 (push (k-one@ 'text t
) (cdr rev
))
1445 ;; ... until we decide which tag and value is appropriate to
1446 ;; collect. For the "head" revision, compute the value of the
1447 ;; `text' printed representation by simple `gather'. For all
1448 ;; other revisions, replace the `text' tag+value with `:insn'
1449 ;; plus value, always scanning in-place.
1450 (if (string= context
(cdr (assq 'head headers
)))
1451 (setcdr (cadr rev
) (gather))
1453 (setq asc
(nreverse @-holes
)
1455 (setq sub
#'buffer-substring-no-properties
))
1458 (while (< (point) e
)
1460 (setq cmd
(char-before)
1461 start
(read (current-buffer))
1462 act
(read (current-buffer)))
1466 ;; `d' means "delete lines".
1467 ;; For Emacs spirit, we use `k' for "kill".
1470 ;; `a' means "append after this line" but
1471 ;; internally we normalize it so that START
1472 ;; specifies the actual line for insert, thus
1473 ;; requiring less hair in the realization algs.
1474 ;; For Emacs spirit, we use `i' for "insert".
1476 ,(funcall sub
(point) (progn (forward-line act
)
1478 (_ (error "Bad command `%c' in `text' for rev `%s'"
1482 (setcar (cdr rev
) (cons :insn acc
)))))))
1484 `((headers ,desc
,@headers
)
1485 (revisions ,@revs
)))))
1489 ;;; vc-rcs.el ends here