Commit | Line | Data |
---|---|---|
7a004b71 GM |
1 | ;;; vc-sccs.el --- support for SCCS version-control |
2 | ||
891b8b69 | 3 | ;; Copyright (C) 1992,93,94,95,96,97,98,99,2000,2001 Free Software Foundation, Inc. |
7a004b71 GM |
4 | |
5 | ;; Author: FSF (see vc.el for full credits) | |
6 | ;; Maintainer: Andre Spiegel <spiegel@gnu.org> | |
7 | ||
bbd59337 | 8 | ;; $Id: vc-sccs.el,v 1.19 2002/11/13 12:37:58 spiegel Exp $ |
7a004b71 GM |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
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) | |
15 | ;; any later version. | |
16 | ||
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. | |
21 | ||
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. | |
26 | ||
27 | ;;; Commentary: | |
28 | ||
29 | ;;; Code: | |
30 | ||
a1e9f194 AS |
31 | (eval-when-compile |
32 | (require 'vc)) | |
33 | ||
8f98485f AS |
34 | ;;; |
35 | ;;; Customization options | |
36 | ;;; | |
37 | ||
7a004b71 | 38 | (defcustom vc-sccs-register-switches nil |
a7cafade DL |
39 | "*Extra switches for registering a file in SCCS. |
40 | A string or list of strings passed to the checkin program by | |
7a004b71 GM |
41 | \\[vc-sccs-register]." |
42 | :type '(choice (const :tag "None" nil) | |
43 | (string :tag "Argument String") | |
44 | (repeat :tag "Argument List" | |
45 | :value ("") | |
46 | string)) | |
a7cafade | 47 | :version "21.1" |
7a004b71 GM |
48 | :group 'vc) |
49 | ||
a1e9f194 AS |
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" | |
56 | :value ("") | |
57 | string)) | |
58 | :version "21.1" | |
59 | :group 'vc) | |
60 | ||
7a004b71 GM |
61 | (defcustom vc-sccs-header (or (cdr (assoc 'SCCS vc-header-alist)) '("%W%")) |
62 | "*Header keywords to be inserted by `vc-insert-headers'." | |
8b7c8991 | 63 | :type '(repeat string) |
7a004b71 GM |
64 | :group 'vc) |
65 | ||
66 | ;;;###autoload | |
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" | |
74 | (choice string | |
75 | function))) | |
a7cafade | 76 | :version "21.1" |
7a004b71 GM |
77 | :group 'vc) |
78 | ||
8f98485f AS |
79 | \f |
80 | ;;; | |
81 | ;;; Internal variables | |
82 | ;;; | |
83 | ||
099bd78a SM |
84 | (defconst vc-sccs-name-assoc-file "VC-names") |
85 | ||
8f98485f AS |
86 | \f |
87 | ;;; | |
88 | ;;; State-querying functions | |
89 | ;;; | |
90 | ||
9ef33737 AS |
91 | ;;; The autoload cookie below places vc-sccs-registered directly into |
92 | ;;; loaddefs.el, so that vc-sccs.el does not need to be loaded for | |
93 | ;;; every file that is visited. The definition is repeated below | |
94 | ;;; so that Help and etags can find it. | |
95 | ||
96 | ;;;###autoload (defun vc-sccs-registered(f) (vc-default-registered 'SCCS f)) | |
af65391b | 97 | (defun vc-sccs-registered (f) (vc-default-registered 'SCCS f)) |
7a004b71 GM |
98 | |
99 | (defun vc-sccs-state (file) | |
100 | "SCCS-specific function to compute the version control state." | |
101 | (with-temp-buffer | |
102 | (if (vc-insert-file (vc-sccs-lock-file file)) | |
103 | (let* ((locks (vc-sccs-parse-locks)) | |
104 | (workfile-version (vc-workfile-version file)) | |
105 | (locking-user (cdr (assoc workfile-version locks)))) | |
106 | (if (not locking-user) | |
107 | (if (vc-workfile-unchanged-p file) | |
108 | 'up-to-date | |
109 | 'unlocked-changes) | |
110 | (if (string= locking-user (vc-user-login-name)) | |
111 | 'edited | |
112 | locking-user))) | |
113 | 'up-to-date))) | |
114 | ||
115 | (defun vc-sccs-state-heuristic (file) | |
116 | "SCCS-specific state heuristic." | |
117 | (if (not (vc-mistrust-permissions file)) | |
118 | ;; This implementation assumes that any file which is under version | |
119 | ;; control and has -rw-r--r-- is locked by its owner. This is true | |
120 | ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--. | |
121 | ;; We have to be careful not to exclude files with execute bits on; | |
122 | ;; scripts can be under version control too. Also, we must ignore the | |
123 | ;; group-read and other-read bits, since paranoid users turn them off. | |
124 | (let* ((attributes (file-attributes file)) | |
125 | (owner-uid (nth 2 attributes)) | |
126 | (permissions (nth 8 attributes))) | |
127 | (if (string-match ".r-..-..-." permissions) | |
128 | 'up-to-date | |
129 | (if (string-match ".rw..-..-." permissions) | |
130 | (if (file-ownership-preserved-p file) | |
131 | 'edited | |
132 | (vc-user-login-name owner-uid)) | |
a7cafade | 133 | ;; Strange permissions. |
7a004b71 GM |
134 | ;; Fall through to real state computation. |
135 | (vc-sccs-state file))) | |
136 | (vc-sccs-state file)))) | |
137 | ||
138 | (defun vc-sccs-workfile-version (file) | |
139 | "SCCS-specific version of `vc-workfile-version'." | |
140 | (with-temp-buffer | |
141 | (vc-insert-file (vc-name file) "^\001e") | |
142 | (vc-parse-buffer "^\001d D \\([^ ]+\\)" 1))) | |
143 | ||
a7cafade | 144 | (defun vc-sccs-checkout-model (file) |
7a004b71 GM |
145 | "SCCS-specific version of `vc-checkout-model'." |
146 | 'locking) | |
147 | ||
148 | (defun vc-sccs-workfile-unchanged-p (file) | |
149 | "SCCS-specific implementation of vc-workfile-unchanged-p." | |
a1e9f194 AS |
150 | (zerop (apply 'vc-do-command nil 1 "vcdiff" (vc-name file) |
151 | (list "--brief" "-q" | |
152 | (concat "-r" (vc-workfile-version file)))))) | |
7a004b71 | 153 | |
7a004b71 | 154 | \f |
8f98485f AS |
155 | ;;; |
156 | ;;; State-changing functions | |
157 | ;;; | |
7a004b71 GM |
158 | |
159 | (defun vc-sccs-register (file &optional rev comment) | |
160 | "Register FILE into the SCCS version-control system. | |
161 | REV is the optional revision number for the file. COMMENT can be used | |
162 | to provide an initial description of FILE. | |
163 | ||
164 | `vc-register-switches' and `vc-sccs-register-switches' are passed to | |
165 | the SCCS command (in that order). | |
166 | ||
167 | Automatically retrieve a read-only version of the file with keywords | |
168 | expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile." | |
00ec645c | 169 | (let* ((switches (append |
7a004b71 GM |
170 | (if (stringp vc-register-switches) |
171 | (list vc-register-switches) | |
172 | vc-register-switches) | |
173 | (if (stringp vc-sccs-register-switches) | |
174 | (list vc-sccs-register-switches) | |
175 | vc-sccs-register-switches))) | |
176 | (dirname (or (file-name-directory file) "")) | |
177 | (basename (file-name-nondirectory file)) | |
178 | (project-file (vc-sccs-search-project-dir dirname basename))) | |
179 | (let ((vc-name | |
180 | (or project-file | |
181 | (format (car vc-sccs-master-templates) dirname basename)))|) | |
0cccd8ff | 182 | (apply 'vc-do-command nil 0 "admin" vc-name |
7a004b71 GM |
183 | (and rev (concat "-r" rev)) |
184 | "-fb" | |
0cccd8ff | 185 | (concat "-i" (file-relative-name file)) |
7a004b71 | 186 | (and comment (concat "-y" comment)) |
7a004b71 GM |
187 | switches)) |
188 | (delete-file file) | |
189 | (if vc-keep-workfiles | |
190 | (vc-do-command nil 0 "get" (vc-name file))))) | |
191 | ||
8f98485f AS |
192 | (defun vc-sccs-responsible-p (file) |
193 | "Return non-nil if SCCS thinks it would be responsible for registering FILE." | |
194 | ;; TODO: check for all the patterns in vc-sccs-master-templates | |
195 | (or (file-directory-p (expand-file-name "SCCS" (file-name-directory file))) | |
196 | (stringp (vc-sccs-search-project-dir (or (file-name-directory file) "") | |
197 | (file-name-nondirectory file))))) | |
198 | ||
199 | (defun vc-sccs-checkin (file rev comment) | |
200 | "SCCS-specific version of `vc-backend-checkin'." | |
201 | (let ((switches (if (stringp vc-checkin-switches) | |
202 | (list vc-checkin-switches) | |
203 | vc-checkin-switches))) | |
204 | (apply 'vc-do-command nil 0 "delta" (vc-name file) | |
205 | (if rev (concat "-r" rev)) | |
206 | (concat "-y" comment) | |
207 | switches) | |
208 | (if vc-keep-workfiles | |
209 | (vc-do-command nil 0 "get" (vc-name file))))) | |
210 | ||
52876673 SM |
211 | (defun vc-sccs-find-version (file rev buffer) |
212 | (apply 'vc-do-command | |
213 | buffer 0 "get" (vc-name file) | |
214 | "-s" ;; suppress diagnostic output | |
215 | "-p" | |
216 | (and rev | |
217 | (concat "-r" | |
218 | (vc-sccs-lookup-triple file rev))) | |
8e859566 SM |
219 | (if (stringp vc-checkout-switches) |
220 | (list vc-checkout-switches) | |
221 | vc-checkout-switches))) | |
52876673 SM |
222 | |
223 | (defun vc-sccs-checkout (file &optional editable rev) | |
224 | "Retrieve a copy of a saved version of SCCS controlled FILE. | |
1862f9ef | 225 | EDITABLE non-nil means that the file should be writable and |
52876673 SM |
226 | locked. REV is the revision to check out." |
227 | (let ((file-buffer (get-file-buffer file)) | |
7a004b71 | 228 | switches) |
52876673 | 229 | (message "Checking out %s..." file) |
7a004b71 GM |
230 | (save-excursion |
231 | ;; Change buffers to get local value of vc-checkout-switches. | |
232 | (if file-buffer (set-buffer file-buffer)) | |
233 | (setq switches (if (stringp vc-checkout-switches) | |
234 | (list vc-checkout-switches) | |
235 | vc-checkout-switches)) | |
236 | ;; Save this buffer's default-directory | |
237 | ;; and use save-excursion to make sure it is restored | |
238 | ;; in the same buffer it was saved in. | |
239 | (let ((default-directory default-directory)) | |
240 | (save-excursion | |
241 | ;; Adjust the default-directory so that the check-out creates | |
242 | ;; the file in the right place. | |
52876673 | 243 | (setq default-directory (file-name-directory file)) |
7a004b71 | 244 | |
bbd59337 AS |
245 | (and rev (or (string= rev "") |
246 | (not (stringp rev))) | |
247 | (setq rev nil)) | |
52876673 SM |
248 | (apply 'vc-do-command nil 0 "get" (vc-name file) |
249 | (if editable "-e") | |
250 | (and rev (concat "-r" (vc-sccs-lookup-triple file rev))) | |
251 | switches)))) | |
252 | (message "Checking out %s...done" file))) | |
7a004b71 | 253 | |
99739bbf | 254 | (defun vc-sccs-revert (file &optional contents-done) |
8f98485f AS |
255 | "Revert FILE to the version it was based on." |
256 | (vc-do-command nil 0 "unget" (vc-name file)) | |
257 | (vc-do-command nil 0 "get" (vc-name file)) | |
258 | ;; Checking out explicit versions is not supported under SCCS, yet. | |
259 | ;; We always "revert" to the latest version; therefore | |
260 | ;; vc-workfile-version is cleared here so that it gets recomputed. | |
261 | (vc-file-setprop file 'vc-workfile-version nil)) | |
262 | ||
1862f9ef | 263 | (defun vc-sccs-cancel-version (file editable) |
8f98485f | 264 | "Undo the most recent checkin of FILE. |
1862f9ef | 265 | EDITABLE non-nil means previous version should be locked." |
8f98485f AS |
266 | (vc-do-command nil 0 "rmdel" |
267 | (vc-name file) | |
268 | (concat "-r" (vc-workfile-version file))) | |
269 | (vc-do-command nil 0 "get" | |
270 | (vc-name file) | |
1862f9ef | 271 | (if editable "-e"))) |
8f98485f AS |
272 | |
273 | (defun vc-sccs-steal-lock (file &optional rev) | |
274 | "Steal the lock on the current workfile for FILE and revision REV." | |
275 | (vc-do-command nil 0 "unget" (vc-name file) "-n" (if rev (concat "-r" rev))) | |
276 | (vc-do-command nil 0 "get" (vc-name file) "-g" (if rev (concat "-r" rev)))) | |
277 | ||
278 | \f | |
279 | ;;; | |
280 | ;;; History functions | |
281 | ;;; | |
282 | ||
283 | (defun vc-sccs-print-log (file) | |
284 | "Get change log associated with FILE." | |
23e94aed | 285 | (vc-do-command nil 0 "prs" (vc-name file))) |
8f98485f AS |
286 | |
287 | (defun vc-sccs-logentry-check () | |
288 | "Check that the log entry in the current buffer is acceptable for SCCS." | |
289 | (when (>= (buffer-size) 512) | |
290 | (goto-char 512) | |
291 | (error "Log must be less than 512 characters; point is now at pos 512"))) | |
292 | ||
293 | (defun vc-sccs-diff (file &optional oldvers newvers) | |
294 | "Get a difference report using SCCS between two versions of FILE." | |
295 | (setq oldvers (vc-sccs-lookup-triple file oldvers)) | |
296 | (setq newvers (vc-sccs-lookup-triple file newvers)) | |
23e94aed | 297 | (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" (vc-name file) |
a1e9f194 AS |
298 | (append (list "-q" |
299 | (and oldvers (concat "-r" oldvers)) | |
300 | (and newvers (concat "-r" newvers))) | |
01f70dba | 301 | (vc-diff-switches-list 'SCCS)))) |
8f98485f AS |
302 | |
303 | \f | |
304 | ;;; | |
305 | ;;; Snapshot system | |
306 | ;;; | |
307 | ||
308 | (defun vc-sccs-assign-name (file name) | |
309 | "Assign to FILE's latest version a given NAME." | |
310 | (vc-sccs-add-triple name file (vc-workfile-version file))) | |
311 | ||
312 | \f | |
313 | ;;; | |
314 | ;;; Miscellaneous | |
315 | ;;; | |
316 | ||
317 | (defun vc-sccs-check-headers () | |
318 | "Check if the current file has any headers in it." | |
319 | (save-excursion | |
320 | (goto-char (point-min)) | |
321 | (re-search-forward "%[A-Z]%" nil t))) | |
322 | ||
323 | (defun vc-sccs-rename-file (old new) | |
324 | ;; Move the master file (using vc-rcs-master-templates). | |
325 | (vc-rename-master (vc-name old) new vc-sccs-master-templates) | |
326 | ;; Update the snapshot file. | |
327 | (with-current-buffer | |
328 | (find-file-noselect | |
329 | (expand-file-name vc-sccs-name-assoc-file | |
330 | (file-name-directory (vc-name old)))) | |
331 | (goto-char (point-min)) | |
332 | ;; (replace-regexp (concat ":" (regexp-quote old) "$") (concat ":" new)) | |
333 | (while (re-search-forward (concat ":" (regexp-quote old) "$") nil t) | |
334 | (replace-match (concat ":" new) nil nil)) | |
335 | (basic-save-buffer) | |
336 | (kill-buffer (current-buffer)))) | |
337 | ||
338 | \f | |
339 | ;;; | |
340 | ;;; Internal functions | |
341 | ;;; | |
342 | ||
343 | ;; This function is wrapped with `progn' so that the autoload cookie | |
344 | ;; copies the whole function itself into loaddefs.el rather than just placing | |
345 | ;; a (autoload 'vc-sccs-search-project-dir "vc-sccs") which would not | |
346 | ;; help us avoid loading vc-sccs. | |
347 | ;;;###autoload | |
348 | (progn (defun vc-sccs-search-project-dir (dirname basename) | |
349 | "Return the name of a master file in the SCCS project directory. | |
350 | Does not check whether the file exists but returns nil if it does not | |
351 | find any project directory." | |
352 | (let ((project-dir (getenv "PROJECTDIR")) dirs dir) | |
353 | (when project-dir | |
354 | (if (file-name-absolute-p project-dir) | |
355 | (setq dirs '("SCCS" "")) | |
356 | (setq dirs '("src/SCCS" "src" "source/SCCS" "source")) | |
357 | (setq project-dir (expand-file-name (concat "~" project-dir)))) | |
358 | (while (and (not dir) dirs) | |
359 | (setq dir (expand-file-name (car dirs) project-dir)) | |
360 | (unless (file-directory-p dir) | |
361 | (setq dir nil) | |
362 | (setq dirs (cdr dirs)))) | |
363 | (and dir (expand-file-name (concat "s." basename) dir)))))) | |
364 | ||
365 | (defun vc-sccs-lock-file (file) | |
366 | "Generate lock file name corresponding to FILE." | |
367 | (let ((master (vc-name file))) | |
368 | (and | |
369 | master | |
370 | (string-match "\\(.*/\\)\\(s\\.\\)\\(.*\\)" master) | |
371 | (replace-match "p." t t master 2)))) | |
372 | ||
373 | (defun vc-sccs-parse-locks () | |
374 | "Parse SCCS locks in current buffer. | |
375 | The result is a list of the form ((VERSION . USER) (VERSION . USER) ...)." | |
376 | (let (master-locks) | |
377 | (goto-char (point-min)) | |
378 | (while (re-search-forward "^\\([0-9.]+\\) [0-9.]+ \\([^ ]+\\) .*\n?" | |
379 | nil t) | |
380 | (setq master-locks | |
381 | (cons (cons (match-string 1) (match-string 2)) master-locks))) | |
382 | ;; FIXME: is it really necessary to reverse ? | |
383 | (nreverse master-locks))) | |
384 | ||
385 | (defun vc-sccs-add-triple (name file rev) | |
386 | (with-current-buffer | |
387 | (find-file-noselect | |
388 | (expand-file-name vc-sccs-name-assoc-file | |
389 | (file-name-directory (vc-name file)))) | |
390 | (goto-char (point-max)) | |
391 | (insert name "\t:\t" file "\t" rev "\n") | |
392 | (basic-save-buffer) | |
393 | (kill-buffer (current-buffer)))) | |
394 | ||
395 | (defun vc-sccs-lookup-triple (file name) | |
396 | "Return the numeric version corresponding to a named snapshot of FILE. | |
397 | If NAME is nil or a version number string it's just passed through." | |
398 | (if (or (null name) | |
399 | (let ((firstchar (aref name 0))) | |
400 | (and (>= firstchar ?0) (<= firstchar ?9)))) | |
401 | name | |
402 | (with-temp-buffer | |
403 | (vc-insert-file | |
404 | (expand-file-name vc-sccs-name-assoc-file | |
405 | (file-name-directory (vc-name file)))) | |
406 | (vc-parse-buffer (concat name "\t:\t" file "\t\\(.+\\)") 1)))) | |
7a004b71 GM |
407 | |
408 | (provide 'vc-sccs) | |
409 | ||
410 | ;;; vc-sccs.el ends here |