1 ;;; vc-sccs.el --- support for SCCS version-control
3 ;; Copyright (C) 1992,93,94,95,96,97,98,99,2000,2001 Free Software Foundation, Inc.
5 ;; Author: FSF (see vc.el for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
8 ;; $Id: vc-sccs.el,v 1.16 2002/10/08 15:35:03 monnier Exp $
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
35 ;;; Customization options
38 (defcustom vc-sccs-register-switches nil
39 "*Extra switches for registering a file in SCCS.
40 A string or list of strings passed to the checkin program by
41 \\[vc-sccs-register]."
42 :type
'(choice (const :tag
"None" nil
)
43 (string :tag
"Argument String")
44 (repeat :tag
"Argument List"
50 (defcustom vc-sccs-diff-switches nil
51 "*A string or list of strings specifying extra switches for `vcdiff',
52 the diff utility used for SCCS under VC."
53 :type
'(choice (const :tag
"None" nil
)
54 (string :tag
"Argument String")
55 (repeat :tag
"Argument List"
61 (defcustom vc-sccs-header
(or (cdr (assoc 'SCCS vc-header-alist
)) '("%W%"))
62 "*Header keywords to be inserted by `vc-insert-headers'."
63 :type
'(repeat string
)
67 (defcustom vc-sccs-master-templates
68 '("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir
)
69 "*Where to look for SCCS master files.
70 For a description of possible values, see `vc-check-master-templates'."
71 :type
'(choice (const :tag
"Use standard SCCS file names"
72 ("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir
))
73 (repeat :tag
"User-specified"
81 ;;; Internal variables
84 (defconst vc-sccs-name-assoc-file
"VC-names")
88 ;;; State-querying functions
92 (progn (defun vc-sccs-registered (f) (vc-default-registered 'SCCS f
)))
94 (defun vc-sccs-state (file)
95 "SCCS-specific function to compute the version control state."
97 (if (vc-insert-file (vc-sccs-lock-file file
))
98 (let* ((locks (vc-sccs-parse-locks))
99 (workfile-version (vc-workfile-version file
))
100 (locking-user (cdr (assoc workfile-version locks
))))
101 (if (not locking-user
)
102 (if (vc-workfile-unchanged-p file
)
105 (if (string= locking-user
(vc-user-login-name))
110 (defun vc-sccs-state-heuristic (file)
111 "SCCS-specific state heuristic."
112 (if (not (vc-mistrust-permissions file
))
113 ;; This implementation assumes that any file which is under version
114 ;; control and has -rw-r--r-- is locked by its owner. This is true
115 ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
116 ;; We have to be careful not to exclude files with execute bits on;
117 ;; scripts can be under version control too. Also, we must ignore the
118 ;; group-read and other-read bits, since paranoid users turn them off.
119 (let* ((attributes (file-attributes file
))
120 (owner-uid (nth 2 attributes
))
121 (permissions (nth 8 attributes
)))
122 (if (string-match ".r-..-..-." permissions
)
124 (if (string-match ".rw..-..-." permissions
)
125 (if (file-ownership-preserved-p file
)
127 (vc-user-login-name owner-uid
))
128 ;; Strange permissions.
129 ;; Fall through to real state computation.
130 (vc-sccs-state file
)))
131 (vc-sccs-state file
))))
133 (defun vc-sccs-workfile-version (file)
134 "SCCS-specific version of `vc-workfile-version'."
136 (vc-insert-file (vc-name file
) "^\001e")
137 (vc-parse-buffer "^\001d D \\([^ ]+\\)" 1)))
139 (defun vc-sccs-checkout-model (file)
140 "SCCS-specific version of `vc-checkout-model'."
143 (defun vc-sccs-workfile-unchanged-p (file)
144 "SCCS-specific implementation of vc-workfile-unchanged-p."
145 (zerop (apply 'vc-do-command nil
1 "vcdiff" (vc-name file
)
147 (concat "-r" (vc-workfile-version file
))))))
151 ;;; State-changing functions
154 (defun vc-sccs-register (file &optional rev comment
)
155 "Register FILE into the SCCS version-control system.
156 REV is the optional revision number for the file. COMMENT can be used
157 to provide an initial description of FILE.
159 `vc-register-switches' and `vc-sccs-register-switches' are passed to
160 the SCCS command (in that order).
162 Automatically retrieve a read-only version of the file with keywords
163 expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
164 (let* ((switches (append
165 (if (stringp vc-register-switches
)
166 (list vc-register-switches
)
167 vc-register-switches
)
168 (if (stringp vc-sccs-register-switches
)
169 (list vc-sccs-register-switches
)
170 vc-sccs-register-switches
)))
171 (dirname (or (file-name-directory file
) ""))
172 (basename (file-name-nondirectory file
))
173 (project-file (vc-sccs-search-project-dir dirname basename
)))
176 (format (car vc-sccs-master-templates
) dirname basename
)))|
)
177 (apply 'vc-do-command nil
0 "admin" vc-name
178 (and rev
(concat "-r" rev
))
180 (concat "-i" (file-relative-name file
))
181 (and comment
(concat "-y" comment
))
184 (if vc-keep-workfiles
185 (vc-do-command nil
0 "get" (vc-name file
)))))
187 (defun vc-sccs-responsible-p (file)
188 "Return non-nil if SCCS thinks it would be responsible for registering FILE."
189 ;; TODO: check for all the patterns in vc-sccs-master-templates
190 (or (file-directory-p (expand-file-name "SCCS" (file-name-directory file
)))
191 (stringp (vc-sccs-search-project-dir (or (file-name-directory file
) "")
192 (file-name-nondirectory file
)))))
194 (defun vc-sccs-checkin (file rev comment
)
195 "SCCS-specific version of `vc-backend-checkin'."
196 (let ((switches (if (stringp vc-checkin-switches
)
197 (list vc-checkin-switches
)
198 vc-checkin-switches
)))
199 (apply 'vc-do-command nil
0 "delta" (vc-name file
)
200 (if rev
(concat "-r" rev
))
201 (concat "-y" comment
)
203 (if vc-keep-workfiles
204 (vc-do-command nil
0 "get" (vc-name file
)))))
206 (defun vc-sccs-find-version (file rev buffer
)
207 (apply 'vc-do-command
208 buffer
0 "get" (vc-name file
)
209 "-s" ;; suppress diagnostic output
213 (vc-sccs-lookup-triple file rev
)))
214 (if (stringp vc-checkout-switches
)
215 (list vc-checkout-switches
)
216 vc-checkout-switches
)))
218 (defun vc-sccs-checkout (file &optional editable rev
)
219 "Retrieve a copy of a saved version of SCCS controlled FILE.
220 EDITABLE non-nil means that the file should be writable and
221 locked. REV is the revision to check out."
222 (let ((file-buffer (get-file-buffer file
))
224 (message "Checking out %s..." file
)
226 ;; Change buffers to get local value of vc-checkout-switches.
227 (if file-buffer
(set-buffer file-buffer
))
228 (setq switches
(if (stringp vc-checkout-switches
)
229 (list vc-checkout-switches
)
230 vc-checkout-switches
))
231 ;; Save this buffer's default-directory
232 ;; and use save-excursion to make sure it is restored
233 ;; in the same buffer it was saved in.
234 (let ((default-directory default-directory
))
236 ;; Adjust the default-directory so that the check-out creates
237 ;; the file in the right place.
238 (setq default-directory
(file-name-directory file
))
240 (and rev
(string= rev
"") (setq rev nil
))
241 (apply 'vc-do-command nil
0 "get" (vc-name file
)
243 (and rev
(concat "-r" (vc-sccs-lookup-triple file rev
)))
245 (message "Checking out %s...done" file
)))
247 (defun vc-sccs-revert (file &optional contents-done
)
248 "Revert FILE to the version it was based on."
249 (vc-do-command nil
0 "unget" (vc-name file
))
250 (vc-do-command nil
0 "get" (vc-name file
))
251 ;; Checking out explicit versions is not supported under SCCS, yet.
252 ;; We always "revert" to the latest version; therefore
253 ;; vc-workfile-version is cleared here so that it gets recomputed.
254 (vc-file-setprop file
'vc-workfile-version nil
))
256 (defun vc-sccs-cancel-version (file editable
)
257 "Undo the most recent checkin of FILE.
258 EDITABLE non-nil means previous version should be locked."
259 (vc-do-command nil
0 "rmdel"
261 (concat "-r" (vc-workfile-version file
)))
262 (vc-do-command nil
0 "get"
266 (defun vc-sccs-steal-lock (file &optional rev
)
267 "Steal the lock on the current workfile for FILE and revision REV."
268 (vc-do-command nil
0 "unget" (vc-name file
) "-n" (if rev
(concat "-r" rev
)))
269 (vc-do-command nil
0 "get" (vc-name file
) "-g" (if rev
(concat "-r" rev
))))
273 ;;; History functions
276 (defun vc-sccs-print-log (file)
277 "Get change log associated with FILE."
278 (vc-do-command nil
0 "prs" (vc-name file
)))
280 (defun vc-sccs-logentry-check ()
281 "Check that the log entry in the current buffer is acceptable for SCCS."
282 (when (>= (buffer-size) 512)
284 (error "Log must be less than 512 characters; point is now at pos 512")))
286 (defun vc-sccs-diff (file &optional oldvers newvers
)
287 "Get a difference report using SCCS between two versions of FILE."
288 (setq oldvers
(vc-sccs-lookup-triple file oldvers
))
289 (setq newvers
(vc-sccs-lookup-triple file newvers
))
290 (apply 'vc-do-command
"*vc-diff*" 1 "vcdiff" (vc-name file
)
292 (and oldvers
(concat "-r" oldvers
))
293 (and newvers
(concat "-r" newvers
)))
294 (vc-diff-switches-list 'SCCS
))))
301 (defun vc-sccs-assign-name (file name
)
302 "Assign to FILE's latest version a given NAME."
303 (vc-sccs-add-triple name file
(vc-workfile-version file
)))
310 (defun vc-sccs-check-headers ()
311 "Check if the current file has any headers in it."
313 (goto-char (point-min))
314 (re-search-forward "%[A-Z]%" nil t
)))
316 (defun vc-sccs-rename-file (old new
)
317 ;; Move the master file (using vc-rcs-master-templates).
318 (vc-rename-master (vc-name old
) new vc-sccs-master-templates
)
319 ;; Update the snapshot file.
322 (expand-file-name vc-sccs-name-assoc-file
323 (file-name-directory (vc-name old
))))
324 (goto-char (point-min))
325 ;; (replace-regexp (concat ":" (regexp-quote old) "$") (concat ":" new))
326 (while (re-search-forward (concat ":" (regexp-quote old
) "$") nil t
)
327 (replace-match (concat ":" new
) nil nil
))
329 (kill-buffer (current-buffer))))
333 ;;; Internal functions
336 ;; This function is wrapped with `progn' so that the autoload cookie
337 ;; copies the whole function itself into loaddefs.el rather than just placing
338 ;; a (autoload 'vc-sccs-search-project-dir "vc-sccs") which would not
339 ;; help us avoid loading vc-sccs.
341 (progn (defun vc-sccs-search-project-dir (dirname basename
)
342 "Return the name of a master file in the SCCS project directory.
343 Does not check whether the file exists but returns nil if it does not
344 find any project directory."
345 (let ((project-dir (getenv "PROJECTDIR")) dirs dir
)
347 (if (file-name-absolute-p project-dir
)
348 (setq dirs
'("SCCS" ""))
349 (setq dirs
'("src/SCCS" "src" "source/SCCS" "source"))
350 (setq project-dir
(expand-file-name (concat "~" project-dir
))))
351 (while (and (not dir
) dirs
)
352 (setq dir
(expand-file-name (car dirs
) project-dir
))
353 (unless (file-directory-p dir
)
355 (setq dirs
(cdr dirs
))))
356 (and dir
(expand-file-name (concat "s." basename
) dir
))))))
358 (defun vc-sccs-lock-file (file)
359 "Generate lock file name corresponding to FILE."
360 (let ((master (vc-name file
)))
363 (string-match "\\(.*/\\)\\(s\\.\\)\\(.*\\)" master
)
364 (replace-match "p." t t master
2))))
366 (defun vc-sccs-parse-locks ()
367 "Parse SCCS locks in current buffer.
368 The result is a list of the form ((VERSION . USER) (VERSION . USER) ...)."
370 (goto-char (point-min))
371 (while (re-search-forward "^\\([0-9.]+\\) [0-9.]+ \\([^ ]+\\) .*\n?"
374 (cons (cons (match-string 1) (match-string 2)) master-locks
)))
375 ;; FIXME: is it really necessary to reverse ?
376 (nreverse master-locks
)))
378 (defun vc-sccs-add-triple (name file rev
)
381 (expand-file-name vc-sccs-name-assoc-file
382 (file-name-directory (vc-name file
))))
383 (goto-char (point-max))
384 (insert name
"\t:\t" file
"\t" rev
"\n")
386 (kill-buffer (current-buffer))))
388 (defun vc-sccs-lookup-triple (file name
)
389 "Return the numeric version corresponding to a named snapshot of FILE.
390 If NAME is nil or a version number string it's just passed through."
392 (let ((firstchar (aref name
0)))
393 (and (>= firstchar ?
0) (<= firstchar ?
9))))
397 (expand-file-name vc-sccs-name-assoc-file
398 (file-name-directory (vc-name file
))))
399 (vc-parse-buffer (concat name
"\t:\t" file
"\t\\(.+\\)") 1))))
403 ;;; vc-sccs.el ends here