1 ;;; vc-sccs.el --- support for SCCS 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/>.
32 ;;; Customization options
35 ;; ;; Maybe a better solution is to not use "get" but "sccs get".
36 ;; ;; Note for GNU CSSC, you can parse sccs -V to get the libexec path.
37 ;; (defcustom vc-sccs-path
38 ;; (prune-directory-list '("/usr/ccs/bin" "/usr/sccs" "/usr/lib/sccs"
39 ;; "/usr/libexec/sccs"))
40 ;; "List of extra directories to search for SCCS commands."
41 ;; :type '(repeat directory)
49 (defcustom vc-sccs-register-switches nil
50 "Switches for registering a file in SCCS.
51 A string or list of strings passed to the checkin program by
52 \\[vc-register]. If nil, use the value of `vc-register-switches'.
53 If t, use no switches."
54 :type
'(choice (const :tag
"Unspecified" nil
)
56 (string :tag
"Argument String")
57 (repeat :tag
"Argument List" :value
("") string
))
61 (defcustom vc-sccs-diff-switches nil
62 "String or list of strings specifying switches for SCCS diff under VC.
63 If nil, use the value of `vc-diff-switches'. If t, use no switches."
64 :type
'(choice (const :tag
"Unspecified" nil
)
66 (string :tag
"Argument String")
67 (repeat :tag
"Argument List" :value
("") string
))
71 (defcustom vc-sccs-header
'("%W%")
72 "Header keywords to be inserted by `vc-insert-headers'."
73 :type
'(repeat string
)
74 :version
"24.1" ; no longer consult the obsolete vc-header-alist
77 ;; This needs to be autoloaded because vc-sccs-registered uses it (via
78 ;; vc-default-registered), and vc-hooks needs to be able to check
79 ;; for a registered backend without loading every backend.
81 (defcustom vc-sccs-master-templates
82 (purecopy '("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir
))
83 "Where to look for SCCS master files.
84 For a description of possible values, see `vc-check-master-templates'."
85 :type
'(choice (const :tag
"Use standard SCCS file names"
86 ("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir
))
87 (repeat :tag
"User-specified"
95 ;;; Internal variables
98 (defconst vc-sccs-name-assoc-file
"VC-names")
101 ;;; Properties of the backend
103 (defun vc-sccs-revision-granularity () 'file
)
104 (defun vc-sccs-checkout-model (files) 'locking
)
107 ;;; State-querying functions
110 ;; The autoload cookie below places vc-sccs-registered directly into
111 ;; loaddefs.el, so that vc-sccs.el does not need to be loaded for
112 ;; every file that is visited.
115 (defun vc-sccs-registered (f) (vc-default-registered 'SCCS f
)))
117 (defun vc-sccs-state (file)
118 "SCCS-specific function to compute the version control state."
119 (if (not (vc-sccs-registered file
))
122 (if (vc-insert-file (vc-sccs-lock-file file
))
123 (let* ((locks (vc-sccs-parse-locks))
124 (working-revision (vc-working-revision file
))
125 (locking-user (cdr (assoc working-revision locks
))))
126 (if (not locking-user
)
127 (if (vc-workfile-unchanged-p file
)
130 (if (string= locking-user
(vc-user-login-name file
))
135 (defun vc-sccs-state-heuristic (file)
136 "SCCS-specific state heuristic."
137 (if (not (vc-mistrust-permissions file
))
138 ;; This implementation assumes that any file which is under version
139 ;; control and has -rw-r--r-- is locked by its owner. This is true
140 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
141 ;; We have to be careful not to exclude files with execute bits on;
142 ;; scripts can be under version control too. Also, we must ignore the
143 ;; group-read and other-read bits, since paranoid users turn them off.
144 (let* ((attributes (file-attributes file
'string
))
145 (owner-name (nth 2 attributes
))
146 (permissions (nth 8 attributes
)))
147 (if (string-match ".r-..-..-." permissions
)
149 (if (string-match ".rw..-..-." permissions
)
150 (if (file-ownership-preserved-p file
)
153 ;; Strange permissions.
154 ;; Fall through to real state computation.
155 (vc-sccs-state file
))))
156 (vc-sccs-state file
)))
158 (defun vc-sccs-dir-status (dir update-function
)
159 ;; FIXME: this function should be rewritten, using `vc-expand-dirs'
160 ;; is not TRTD because it returns files from multiple backends.
161 ;; It should also return 'unregistered files.
163 ;; Doing lots of individual VC-state calls is painful, but
164 ;; there is no better option in SCCS-land.
165 (let ((flist (vc-expand-dirs (list dir
)))
168 (let ((state (vc-state file
))
169 (frel (file-relative-name file
)))
170 (when (and (eq (vc-backend file
) 'SCCS
)
171 (not (eq state
'up-to-date
)))
172 (push (list frel state
) result
))))
173 (funcall update-function result
)))
175 (defun vc-sccs-working-revision (file)
176 "SCCS-specific version of `vc-working-revision'."
178 ;; The working revision is always the latest revision number.
179 ;; To find this number, search the entire delta table,
180 ;; rather than just the first entry, because the
181 ;; first entry might be a deleted ("R") revision.
182 (vc-insert-file (vc-name file
) "^\001e\n\001[^s]")
183 (vc-parse-buffer "^\001d D \\([^ ]+\\)" 1)))
185 ;; Cf vc-sccs-find-revision.
186 (defun vc-sccs-write-revision (file outfile
&optional rev
)
187 "Write the SCCS version of input file FILE to output file OUTFILE.
188 Optional string REV is a revision."
190 (apply 'vc-sccs-do-command t
0 "get" (vc-name file
)
191 (append '("-s" "-p" "-k") ; -k: no keyword expansion
192 (if rev
(list (concat "-r" rev
)))))
193 (write-region nil nil outfile nil
'silent
)))
195 (defun vc-sccs-workfile-unchanged-p (file)
196 "SCCS-specific implementation of `vc-workfile-unchanged-p'."
197 (let ((tempfile (make-temp-file "vc-sccs")))
200 (vc-sccs-write-revision file tempfile
(vc-working-revision file
))
201 (zerop (vc-do-command "*vc*" 1 "cmp" file tempfile
)))
202 (delete-file tempfile
))))
206 ;;; State-changing functions
209 (defun vc-sccs-do-command (buffer okstatus command file-or-list
&rest flags
)
210 ;; (let ((load-path (append vc-sccs-path load-path)))
211 ;; (apply 'vc-do-command buffer okstatus command file-or-list flags))
212 (apply 'vc-do-command
(or buffer
"*vc*") okstatus
"sccs" file-or-list command flags
))
214 (defun vc-sccs-create-repo ()
215 "Create a new SCCS repository."
216 ;; SCCS is totally file-oriented, so all we have to do is make the directory
217 (make-directory "SCCS"))
219 (defun vc-sccs-register (files &optional rev comment
)
220 "Register FILES into the SCCS version-control system.
221 REV is the optional revision number for the file. COMMENT can be used
222 to provide an initial description of FILES.
223 Passes either `vc-sccs-register-switches' or `vc-register-switches'
226 Automatically retrieve a read-only version of the files with keywords
227 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
229 (let* ((dirname (or (file-name-directory file
) ""))
230 (basename (file-name-nondirectory file
))
231 (project-file (vc-sccs-search-project-dir dirname basename
)))
234 (format (car vc-sccs-master-templates
) dirname basename
))))
235 (apply 'vc-sccs-do-command nil
0 "admin" vc-name
236 (and rev
(not (string= rev
"")) (concat "-r" rev
))
238 (concat "-i" (file-relative-name file
))
239 (and comment
(concat "-y" comment
))
240 (vc-switches 'SCCS
'register
)))
242 (if vc-keep-workfiles
243 (vc-sccs-do-command nil
0 "get" (vc-name file
))))))
245 (defun vc-sccs-responsible-p (file)
246 "Return non-nil if SCCS thinks it would be responsible for registering FILE."
247 ;; TODO: check for all the patterns in vc-sccs-master-templates
248 (or (file-directory-p (expand-file-name "SCCS" (file-name-directory file
)))
249 (stringp (vc-sccs-search-project-dir (or (file-name-directory file
) "")
250 (file-name-nondirectory file
)))))
252 (defun vc-sccs-checkin (files rev comment
)
253 "SCCS-specific version of `vc-backend-checkin'."
254 (dolist (file (vc-expand-dirs files
))
255 (apply 'vc-sccs-do-command nil
0 "delta" (vc-name file
)
256 (if rev
(concat "-r" rev
))
257 (concat "-y" comment
)
258 (vc-switches 'SCCS
'checkin
))
259 (if vc-keep-workfiles
260 (vc-sccs-do-command nil
0 "get" (vc-name file
)))))
262 (defun vc-sccs-find-revision (file rev buffer
)
263 (apply 'vc-sccs-do-command
264 buffer
0 "get" (vc-name file
)
265 "-s" ;; suppress diagnostic output
269 (vc-sccs-lookup-triple file rev
)))
270 (vc-switches 'SCCS
'checkout
)))
272 (defun vc-sccs-checkout (file &optional editable rev
)
273 "Retrieve a copy of a saved revision of SCCS controlled FILE.
274 If FILE is a directory, all version-controlled files beneath are checked out.
275 EDITABLE non-nil means that the file should be writable and
276 locked. REV is the revision to check out."
277 (if (file-directory-p file
)
278 (mapc 'vc-sccs-checkout
(vc-expand-dirs (list file
)))
279 (let ((file-buffer (get-file-buffer file
))
281 (message "Checking out %s..." file
)
283 ;; Change buffers to get local value of vc-checkout-switches.
284 (if file-buffer
(set-buffer file-buffer
))
285 (setq switches
(vc-switches 'SCCS
'checkout
))
286 ;; Save this buffer's default-directory
287 ;; and use save-excursion to make sure it is restored
288 ;; in the same buffer it was saved in.
289 (let ((default-directory default-directory
))
291 ;; Adjust the default-directory so that the check-out creates
292 ;; the file in the right place.
293 (setq default-directory
(file-name-directory file
))
295 (and rev
(or (string= rev
"")
298 (apply 'vc-sccs-do-command nil
0 "get" (vc-name file
)
300 (and rev
(concat "-r" (vc-sccs-lookup-triple file rev
)))
302 (message "Checking out %s...done" file
))))
304 (defun vc-sccs-rollback (files)
305 "Roll back, undoing the most recent checkins of FILES. Directories
306 are expanded to all version-controlled subfiles."
307 (setq files
(vc-expand-dirs files
))
309 (error "SCCS backend doesn't support directory-level rollback"))
311 (let ((discard (vc-working-revision file
)))
312 (if (null (yes-or-no-p (format "Remove version %s from %s history? "
315 (message "Removing revision %s from %s..." discard file
)
316 (vc-sccs-do-command nil
0 "rmdel"
317 (vc-name file
) (concat "-r" discard
))
318 (vc-sccs-do-command nil
0 "get" (vc-name file
) nil
))))
320 (defun vc-sccs-revert (file &optional contents-done
)
321 "Revert FILE to the version it was based on. If FILE is a directory,
322 revert all subfiles."
323 (if (file-directory-p file
)
324 (mapc 'vc-sccs-revert
(vc-expand-dirs (list file
)))
325 (vc-sccs-do-command nil
0 "unget" (vc-name file
))
326 (vc-sccs-do-command nil
0 "get" (vc-name file
))
327 ;; Checking out explicit revisions is not supported under SCCS, yet.
328 ;; We always "revert" to the latest revision; therefore
329 ;; vc-working-revision is cleared here so that it gets recomputed.
330 (vc-file-setprop file
'vc-working-revision nil
)))
332 (defun vc-sccs-steal-lock (file &optional rev
)
333 "Steal the lock on the current workfile for FILE and revision REV."
334 (if (file-directory-p file
)
335 (mapc 'vc-sccs-steal-lock
(vc-expand-dirs (list file
)))
336 (vc-sccs-do-command nil
0 "unget"
337 (vc-name file
) "-n" (if rev
(concat "-r" rev
)))
338 (vc-sccs-do-command nil
0 "get"
339 (vc-name file
) "-g" (if rev
(concat "-r" rev
)))))
341 (defun vc-sccs-modify-change-comment (files rev comment
)
342 "Modify (actually, append to) the change comments for FILES on a specified REV."
343 (dolist (file (vc-expand-dirs files
))
344 (vc-sccs-do-command nil
0 "cdc" (vc-name file
)
345 (concat "-y" comment
) (concat "-r" rev
))))
349 ;;; History functions
352 (defun vc-sccs-print-log (files buffer
&optional shortlog start-revision-ignored limit
)
353 "Get change log associated with FILES."
354 (setq files
(vc-expand-dirs files
))
355 (vc-sccs-do-command buffer
0 "prs" (mapcar 'vc-name files
))
356 (when limit
'limit-unsupported
))
358 ;; FIXME use sccsdiff if present?
359 (defun vc-sccs-diff (files &optional oldvers newvers buffer
)
360 "Get a difference report using SCCS between two filesets."
361 (setq files
(vc-expand-dirs files
))
362 (setq oldvers
(vc-sccs-lookup-triple (car files
) oldvers
))
363 (setq newvers
(vc-sccs-lookup-triple (car files
) newvers
))
364 (or buffer
(setq buffer
"*vc-diff*"))
365 ;; We have to reimplement pieces of vc-do-command, because
366 ;; we want to run multiple external commands, and only do the setup
367 ;; and exit pieces once.
369 (unless (or (eq buffer t
)
370 (and (stringp buffer
) (string= (buffer-name) buffer
))
371 (eq buffer
(current-buffer)))
372 (vc-setup-buffer buffer
))
373 (let* ((fake-flags (append (vc-switches 'SCCS
'diff
)
374 (if oldvers
(list (concat " -r" oldvers
)))
375 (if newvers
(list (concat " -r" newvers
)))))
379 (concat " " (mapconcat 'identity fake-flags
" "))
381 (vc-delistify files
)))
383 (oldproc (get-buffer-process (current-buffer))))
384 (when vc-command-messages
385 (message "Running %s in foreground..." fake-command
))
386 (if oldproc
(delete-process oldproc
))
388 (let ((oldfile (make-temp-file "vc-sccs"))
392 (vc-sccs-write-revision file oldfile oldvers
)
394 (vc-sccs-write-revision file
(setq newfile
395 (make-temp-file "vc-sccs"))
397 (let* ((inhibit-read-only t
)
400 (cons "LC_MESSAGES=C" process-environment
))
401 (w32-quote-process-args t
)
403 (apply 'process-file
"diff" nil t nil
404 (append (vc-switches 'SCCS
'diff
)
407 (file-relative-name file
)))))))
408 (or (integerp this-status
) (setq status
'error
))
409 (and (integerp status
)
410 (> this-status status
)
411 (setq status this-status
))))
412 (delete-file oldfile
)
413 (if newfile
(delete-file newfile
)))))
414 (when (or (not (integerp status
)) (> status
1))
415 (unless (eq ?\s
(aref (buffer-name (current-buffer)) 0))
416 (pop-to-buffer (current-buffer))
417 (goto-char (point-min))
418 (shrink-window-if-larger-than-buffer))
419 (error "Running %s...FAILED (%s)" fake-command
420 (if (integerp status
) (format "status %d" status
) status
)))
421 (when vc-command-messages
422 (message "Running %s...OK = %d" fake-command status
))
423 ;; Should we pretend we ran sccsdiff instead?
424 ;; This might not actually be a valid diff command.
425 (run-hook-with-args 'vc-post-command-functions
"diff" files fake-flags
)
430 ;;; Tag system. SCCS doesn't have tags, so we simulate them by maintaining
431 ;;; our own set of name-to-revision mappings.
434 (defun vc-sccs-create-tag (dir name branchp
)
436 (error "SCCS backend does not support module branches"))
437 (let ((result (vc-tag-precondition dir
)))
439 (error "File %s is not up-to-date" result
)
443 (vc-sccs-add-triple name f
(vc-working-revision f
)))))))
450 (defun vc-sccs-previous-revision (file rev
)
451 (vc-call-backend 'RCS
'previous-revision file rev
))
453 (defun vc-sccs-next-revision (file rev
)
454 (vc-call-backend 'RCS
'next-revision file rev
))
456 (defun vc-sccs-check-headers ()
457 "Check if the current file has any headers in it."
459 (goto-char (point-min))
460 (re-search-forward "%[A-Z]%" nil t
)))
462 (defun vc-sccs-rename-file (old new
)
463 ;; Move the master file (using vc-rcs-master-templates).
464 (vc-rename-master (vc-name old
) new vc-sccs-master-templates
)
465 ;; Update the tag file.
468 (expand-file-name vc-sccs-name-assoc-file
469 (file-name-directory (vc-name old
))))
470 (goto-char (point-min))
471 ;; (replace-regexp (concat ":" (regexp-quote old) "$") (concat ":" new))
472 (while (re-search-forward (concat ":" (regexp-quote old
) "$") nil t
)
473 (replace-match (concat ":" new
) nil nil
))
475 (kill-buffer (current-buffer))))
477 (defun vc-sccs-find-file-hook ()
478 ;; If the file is locked by some other user, make
479 ;; the buffer read-only. Like this, even root
480 ;; cannot modify a file that someone else has locked.
481 (and (stringp (vc-state buffer-file-name
'SCCS
))
482 (setq buffer-read-only t
)))
486 ;;; Internal functions
489 ;; This function is wrapped with `progn' so that the autoload cookie
490 ;; copies the whole function itself into loaddefs.el rather than just placing
491 ;; a (autoload 'vc-sccs-search-project-dir "vc-sccs") which would not
492 ;; help us avoid loading vc-sccs.
494 (progn (defun vc-sccs-search-project-dir (dirname basename
)
495 "Return the name of a master file in the SCCS project directory.
496 Does not check whether the file exists but returns nil if it does not
497 find any project directory."
498 (let ((project-dir (getenv "PROJECTDIR")) dirs dir
)
500 (if (file-name-absolute-p project-dir
)
501 (setq dirs
'("SCCS" ""))
502 (setq dirs
'("src/SCCS" "src" "source/SCCS" "source"))
503 (setq project-dir
(expand-file-name (concat "~" project-dir
))))
504 (while (and (not dir
) dirs
)
505 (setq dir
(expand-file-name (car dirs
) project-dir
))
506 (unless (file-directory-p dir
)
508 (setq dirs
(cdr dirs
))))
509 (and dir
(expand-file-name (concat "s." basename
) dir
))))))
511 (defun vc-sccs-lock-file (file)
512 "Generate lock file name corresponding to FILE."
513 (let ((master (vc-name file
)))
516 (string-match "\\(.*/\\)\\(s\\.\\)\\(.*\\)" master
)
517 (replace-match "p." t t master
2))))
519 (defun vc-sccs-parse-locks ()
520 "Parse SCCS locks in current buffer.
521 The result is a list of the form ((REVISION . USER) (REVISION . USER) ...)."
523 (goto-char (point-min))
524 (while (re-search-forward "^\\([0-9.]+\\) [0-9.]+ \\([^ ]+\\) .*\n?"
527 (cons (cons (match-string 1) (match-string 2)) master-locks
)))
528 ;; FIXME: is it really necessary to reverse ?
529 (nreverse master-locks
)))
531 (defun vc-sccs-add-triple (name file rev
)
534 (expand-file-name vc-sccs-name-assoc-file
535 (file-name-directory (vc-name file
))))
536 (goto-char (point-max))
537 (insert name
"\t:\t" file
"\t" rev
"\n")
539 (kill-buffer (current-buffer))))
541 (defun vc-sccs-lookup-triple (file name
)
542 "Return the numeric revision corresponding to a named tag of FILE.
543 If NAME is nil or a revision number string it's just passed through."
545 (let ((firstchar (aref name
0)))
546 (and (>= firstchar ?
0) (<= firstchar ?
9))))
550 (expand-file-name vc-sccs-name-assoc-file
551 (file-name-directory (vc-name file
))))
552 (vc-parse-buffer (concat name
"\t:\t" file
"\t\\(.+\\)") 1))))
556 ;;; vc-sccs.el ends here