vc-sccs.el 17.1 KB
Newer Older
1 2
;;; vc-sccs.el --- support for SCCS version-control

3
;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Glenn Morris's avatar
Glenn Morris committed
5
;;   Free Software Foundation, Inc.
6 7 8 9 10 11

;; Author:     FSF (see vc.el for full credits)
;; Maintainer: Andre Spiegel <spiegel@gnu.org>

;; 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 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
24 25 26 27 28

;;; Commentary:

;;; Code:

29
(eval-when-compile
30 31
  (require 'vc))

32
;;;
André Spiegel's avatar
André Spiegel committed
33 34 35
;;; Customization options
;;;

36 37 38 39 40 41 42 43 44 45 46
;; ;; Maybe a better solution is to not use "get" but "sccs get".
;; (defcustom vc-sccs-path
;;   (let ((path ()))
;;     (dolist (dir '("/usr/sccs" "/usr/lib/sccs" "/usr/libexec/sccs"))
;;       (if (file-directory-p dir)
;;           (push dir path)))
;;     path)
;;   "List of extra directories to search for SCCS commands."
;;   :type '(repeat directory)
;;   :group 'vc)

47
(defcustom vc-sccs-register-switches nil
48
  "Switches for registering a file in SCCS.
Dave Love's avatar
Dave Love committed
49
A string or list of strings passed to the checkin program by
50 51 52 53
\\[vc-register].  If nil, use the value of `vc-register-switches'.
If t, use no switches."
  :type '(choice (const :tag "Unspecified" nil)
		 (const :tag "None" t)
54
		 (string :tag "Argument String")
55
		 (repeat :tag "Argument List" :value ("") string))
Dave Love's avatar
Dave Love committed
56
  :version "21.1"
57 58
  :group 'vc)

59
(defcustom vc-sccs-diff-switches nil
60 61 62 63
  "String or list of strings specifying switches for SCCS diff under VC.
If nil, use the value of `vc-diff-switches'.  If t, use no switches."
  :type '(choice (const :tag "Unspecified" nil)
		 (const :tag "None" t)
64
		 (string :tag "Argument String")
65
		 (repeat :tag "Argument List" :value ("") string))
66 67 68
  :version "21.1"
  :group 'vc)

69
(defcustom vc-sccs-header (or (cdr (assoc 'SCCS vc-header-alist)) '("%W%"))
Lute Kamstra's avatar
Lute Kamstra committed
70
  "Header keywords to be inserted by `vc-insert-headers'."
Dave Love's avatar
Dave Love committed
71
  :type '(repeat string)
72 73 74 75 76
  :group 'vc)

;;;###autoload
(defcustom vc-sccs-master-templates
  '("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir)
Lute Kamstra's avatar
Lute Kamstra committed
77
  "Where to look for SCCS master files.
78 79 80 81 82 83
For a description of possible values, see `vc-check-master-templates'."
  :type '(choice (const :tag "Use standard SCCS file names"
			("%sSCCS/s.%s" "%ss.%s" vc-sccs-search-project-dir))
		 (repeat :tag "User-specified"
			 (choice string
				 function)))
Dave Love's avatar
Dave Love committed
84
  :version "21.1"
85 86
  :group 'vc)

André Spiegel's avatar
André Spiegel committed
87 88 89 90 91

;;;
;;; Internal variables
;;;

92 93
(defconst vc-sccs-name-assoc-file "VC-names")

André Spiegel's avatar
André Spiegel committed
94

95 96
;;; Properties of the backend

97
(defun vc-sccs-revision-granularity () 'file)
98
(defun vc-sccs-checkout-model (files) 'locking)
99

André Spiegel's avatar
André Spiegel committed
100 101 102 103
;;;
;;; State-querying functions
;;;

104 105 106 107
;; The autoload cookie below places vc-sccs-registered directly into
;; loaddefs.el, so that vc-sccs.el does not need to be loaded for
;; every file that is visited.  The definition is repeated below
;; so that Help and etags can find it.
108 109

;;;###autoload (defun vc-sccs-registered(f) (vc-default-registered 'SCCS f))
110
(defun vc-sccs-registered (f) (vc-default-registered 'SCCS f))
111 112 113

(defun vc-sccs-state (file)
  "SCCS-specific function to compute the version control state."
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
  (if (not (vc-sccs-registered file))
      'unregistered
    (with-temp-buffer
      (if (vc-insert-file (vc-sccs-lock-file file))
	  (let* ((locks (vc-sccs-parse-locks))
		 (working-revision (vc-working-revision file))
		 (locking-user (cdr (assoc working-revision locks))))
	    (if (not locking-user)
		(if (vc-workfile-unchanged-p file)
		    'up-to-date
		  'unlocked-changes)
	      (if (string= locking-user (vc-user-login-name file))
		  'edited
		locking-user)))
	'up-to-date))))
129 130 131 132 133 134 135 136 137 138

(defun vc-sccs-state-heuristic (file)
  "SCCS-specific state heuristic."
  (if (not (vc-mistrust-permissions file))
      ;;   This implementation assumes that any file which is under version
      ;; control and has -rw-r--r-- is locked by its owner.  This is true
      ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
      ;; We have to be careful not to exclude files with execute bits on;
      ;; scripts can be under version control too.  Also, we must ignore the
      ;; group-read and other-read bits, since paranoid users turn them off.
139 140
      (let* ((attributes  (file-attributes file 'string))
             (owner-name  (nth 2 attributes))
141 142 143 144 145 146
             (permissions (nth 8 attributes)))
	(if (string-match ".r-..-..-." permissions)
            'up-to-date
          (if (string-match ".rw..-..-." permissions)
              (if (file-ownership-preserved-p file)
                  'edited
147
                owner-name)
148 149 150 151
            ;; Strange permissions.
            ;; Fall through to real state computation.
            (vc-sccs-state file))))
    (vc-sccs-state file)))
152

153
(defun vc-sccs-dir-status (dir update-function)
154 155 156 157 158
  ;; FIXME: this function should be rewritten, using `vc-expand-dirs'
  ;; is not TRTD because it returns files from multiple backends.
  ;; It should also return 'unregistered files.

  ;; Doing lots of individual VC-state calls is painful, but
159
  ;; there is no better option in SCCS-land.
160 161 162 163 164
  (let ((flist (vc-expand-dirs (list dir)))
	(result nil))
    (dolist (file flist)
      (let ((state (vc-state file))
	    (frel (file-relative-name file)))
165 166 167
	(when (and (eq (vc-backend file) 'SCCS)
		   (not (eq state 'up-to-date)))
	  (push (list frel state) result))))
168
    (funcall update-function result)))
169

Eric S. Raymond's avatar
Eric S. Raymond committed
170 171
(defun vc-sccs-working-revision (file)
  "SCCS-specific version of `vc-working-revision'."
172
  (with-temp-buffer
173
    ;; The working revision is always the latest revision number.
174 175
    ;; To find this number, search the entire delta table,
    ;; rather than just the first entry, because the
176
    ;; first entry might be a deleted ("R") revision.
177
    (vc-insert-file (vc-name file) "^\001e\n\001[^s]")
178 179 180
    (vc-parse-buffer "^\001d D \\([^ ]+\\)" 1)))

(defun vc-sccs-workfile-unchanged-p (file)
Stefan Monnier's avatar
Stefan Monnier committed
181
  "SCCS-specific implementation of `vc-workfile-unchanged-p'."
182
  (zerop (apply 'vc-do-command "*vc*" 1 "vcdiff" (vc-name file)
183
                (list "--brief" "-q"
Eric S. Raymond's avatar
Eric S. Raymond committed
184
                      (concat "-r" (vc-working-revision file))))))
185 186


André Spiegel's avatar
André Spiegel committed
187 188 189
;;;
;;; State-changing functions
;;;
190

191 192 193
(defun vc-sccs-do-command (buffer okstatus command file-or-list &rest flags)
  ;; (let ((load-path (append vc-sccs-path load-path)))
  ;;   (apply 'vc-do-command buffer okstatus command file-or-list flags))
194
  (apply 'vc-do-command (or buffer "*vc*") okstatus "sccs" file-or-list command flags))
195

196 197 198 199 200 201 202
(defun vc-sccs-create-repo ()
  "Create a new SCCS repository."
  ;; SCCS is totally file-oriented, so all we have to do is make the directory
  (make-directory "SCCS"))

(defun vc-sccs-register (files &optional rev comment)
  "Register FILES into the SCCS version-control system.
203
REV is the optional revision number for the file.  COMMENT can be used
204
to provide an initial description of FILES.
205 206
Passes either `vc-sccs-register-switches' or `vc-register-switches'
to the SCCS command.
207

208
Automatically retrieve a read-only version of the files with keywords
209
expanded if `vc-keep-workfiles' is non-nil, otherwise, delete the workfile."
210
  (dolist (file files)
211
    (let* ((dirname (or (file-name-directory file) ""))
212 213 214 215
	   (basename (file-name-nondirectory file))
	   (project-file (vc-sccs-search-project-dir dirname basename)))
      (let ((vc-name
	     (or project-file
216
		 (format (car vc-sccs-master-templates) dirname basename))))
217
	(apply 'vc-sccs-do-command nil 0 "admin" vc-name
218
	       (and rev (not (string= rev "")) (concat "-r" rev))
219
	       "-fb"
220
	       (concat "-i" (file-relative-name file))
221
	       (and comment (concat "-y" comment))
222
	       (vc-switches 'SCCS 'register)))
223 224
      (delete-file file)
      (if vc-keep-workfiles
225
	  (vc-sccs-do-command nil 0 "get" (vc-name file))))))
226

André Spiegel's avatar
André Spiegel committed
227 228 229 230 231 232 233
(defun vc-sccs-responsible-p (file)
  "Return non-nil if SCCS thinks it would be responsible for registering FILE."
  ;; TODO: check for all the patterns in vc-sccs-master-templates
  (or (file-directory-p (expand-file-name "SCCS" (file-name-directory file)))
      (stringp (vc-sccs-search-project-dir (or (file-name-directory file) "")
					   (file-name-nondirectory file)))))

234
(defun vc-sccs-checkin (files rev comment)
André Spiegel's avatar
André Spiegel committed
235
  "SCCS-specific version of `vc-backend-checkin'."
236
  (dolist (file (vc-expand-dirs files))
237
    (apply 'vc-sccs-do-command nil 0 "delta" (vc-name file)
238 239 240 241
	   (if rev (concat "-r" rev))
	   (concat "-y" comment)
	   (vc-switches 'SCCS 'checkin))
    (if vc-keep-workfiles
242
	(vc-sccs-do-command nil 0 "get" (vc-name file)))))
André Spiegel's avatar
André Spiegel committed
243

Eric S. Raymond's avatar
Eric S. Raymond committed
244
(defun vc-sccs-find-revision (file rev buffer)
245
  (apply 'vc-sccs-do-command
246 247 248 249 250 251
	 buffer 0 "get" (vc-name file)
	 "-s" ;; suppress diagnostic output
	 "-p"
	 (and rev
	      (concat "-r"
		      (vc-sccs-lookup-triple file rev)))
252
	 (vc-switches 'SCCS 'checkout)))
253 254

(defun vc-sccs-checkout (file &optional editable rev)
255
  "Retrieve a copy of a saved revision of SCCS controlled FILE.
256
If FILE is a directory, all version-controlled files beneath are checked out.
257
EDITABLE non-nil means that the file should be writable and
258
locked.  REV is the revision to check out."
259
  (if (file-directory-p file)
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      (mapc 'vc-sccs-checkout (vc-expand-dirs (list file)))
    (let ((file-buffer (get-file-buffer file))
	  switches)
      (message "Checking out %s..." file)
      (save-excursion
	;; Change buffers to get local value of vc-checkout-switches.
	(if file-buffer (set-buffer file-buffer))
	(setq switches (vc-switches 'SCCS 'checkout))
	;; Save this buffer's default-directory
	;; and use save-excursion to make sure it is restored
	;; in the same buffer it was saved in.
	(let ((default-directory default-directory))
	  (save-excursion
	    ;; Adjust the default-directory so that the check-out creates
	    ;; the file in the right place.
	    (setq default-directory (file-name-directory file))

	    (and rev (or (string= rev "")
			 (not (stringp rev)))
		 (setq rev nil))
	    (apply 'vc-sccs-do-command nil 0 "get" (vc-name file)
		   (if editable "-e")
		   (and rev (concat "-r" (vc-sccs-lookup-triple file rev)))
		   switches))))
      (message "Checking out %s...done" file))))
285

286
(defun vc-sccs-rollback (files)
287 288 289
  "Roll back, undoing the most recent checkins of FILES.  Directories
are expanded to all version-controlled subfiles."
  (setq files (vc-expand-dirs files))
290 291 292
  (if (not files)
      (error "SCCS backend doesn't support directory-level rollback."))
  (dolist (file files)
Eric S. Raymond's avatar
Eric S. Raymond committed
293
	  (let ((discard (vc-working-revision file)))
294
	    (if (null (yes-or-no-p (format "Remove version %s from %s history? "
295 296 297
					   discard file)))
		(error "Aborted"))
	    (message "Removing revision %s from %s..." discard file)
298 299 300
	    (vc-sccs-do-command nil 0 "rmdel"
                                (vc-name file) (concat "-r" discard))
	    (vc-sccs-do-command nil 0 "get" (vc-name file) nil))))
301

302
(defun vc-sccs-revert (file &optional contents-done)
303 304
  "Revert FILE to the version it was based on. If FILE is a directory,
revert all subfiles."
305
  (if (file-directory-p file)
306 307 308 309 310 311 312
      (mapc 'vc-sccs-revert (vc-expand-dirs (list file)))
    (vc-sccs-do-command nil 0 "unget" (vc-name file))
    (vc-sccs-do-command nil 0 "get" (vc-name file))
    ;; Checking out explicit revisions is not supported under SCCS, yet.
    ;; We always "revert" to the latest revision; therefore
    ;; vc-working-revision is cleared here so that it gets recomputed.
    (vc-file-setprop file 'vc-working-revision nil)))
André Spiegel's avatar
André Spiegel committed
313 314 315

(defun vc-sccs-steal-lock (file &optional rev)
  "Steal the lock on the current workfile for FILE and revision REV."
316
  (if (file-directory-p file)
317 318 319 320 321
      (mapc 'vc-sccs-steal-lock (vc-expand-dirs (list file)))
    (vc-sccs-do-command nil 0 "unget"
			(vc-name file) "-n" (if rev (concat "-r" rev)))
    (vc-sccs-do-command nil 0 "get"
			(vc-name file) "-g" (if rev (concat "-r" rev)))))
André Spiegel's avatar
André Spiegel committed
322

323 324
(defun vc-sccs-modify-change-comment (files rev comment)
  "Modify (actually, append to) the change comments for FILES on a specified REV."
325
  (dolist (file (vc-expand-dirs files))
326
    (vc-sccs-do-command nil 0 "cdc" (vc-name file)
327
                        (concat "-y" comment) (concat "-r" rev))))
328

André Spiegel's avatar
André Spiegel committed
329 330 331 332 333

;;;
;;; History functions
;;;

334 335
(defun vc-sccs-print-log (files &optional buffer)
  "Get change log associated with FILES."
336
  (setq files (vc-expand-dirs files))
337
  (vc-sccs-do-command buffer 0 "prs" (mapcar 'vc-name files)))
338 339 340

(defun vc-sccs-diff (files &optional oldvers newvers buffer)
  "Get a difference report using SCCS between two filesets."
341
  (setq files (vc-expand-dirs files))
342 343
  (setq oldvers (vc-sccs-lookup-triple (car files) oldvers))
  (setq newvers (vc-sccs-lookup-triple (car files) newvers))
Glenn Morris's avatar
Glenn Morris committed
344
  (apply 'vc-do-command (or buffer "*vc-diff*")
345
	 1 "vcdiff" (mapcar 'vc-name (vc-expand-dirs files))
346 347 348
         (append (list "-q"
                       (and oldvers (concat "-r" oldvers))
                       (and newvers (concat "-r" newvers)))
349
                 (vc-switches 'SCCS 'diff))))
André Spiegel's avatar
André Spiegel committed
350 351 352


;;;
353 354
;;; Tag system.  SCCS doesn't have tags, so we simulate them by maintaining
;;; our own set of name-to-revision mappings.
André Spiegel's avatar
André Spiegel committed
355 356
;;;

357 358
(defun vc-sccs-create-tag (backend dir name branchp)
  (when branchp
359
    (error "SCCS backend %s does not support module branches" backend))
360 361 362 363 364 365 366
  (let ((result (vc-tag-precondition dir)))
    (if (stringp result)
	(error "File %s is not up-to-date" result)
      (vc-file-tree-walk
       dir
       (lambda (f)
	 (vc-sccs-add-triple name f (vc-working-revision f)))))))
André Spiegel's avatar
André Spiegel committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381


;;;
;;; Miscellaneous
;;;

(defun vc-sccs-check-headers ()
  "Check if the current file has any headers in it."
  (save-excursion
    (goto-char (point-min))
    (re-search-forward  "%[A-Z]%" nil t)))

(defun vc-sccs-rename-file (old new)
  ;; Move the master file (using vc-rcs-master-templates).
  (vc-rename-master (vc-name old) new vc-sccs-master-templates)
382
  ;; Update the tag file.
André Spiegel's avatar
André Spiegel committed
383 384 385 386 387 388 389 390 391 392 393
  (with-current-buffer
      (find-file-noselect
       (expand-file-name vc-sccs-name-assoc-file
			 (file-name-directory (vc-name old))))
    (goto-char (point-min))
    ;; (replace-regexp (concat ":" (regexp-quote old) "$") (concat ":" new))
    (while (re-search-forward (concat ":" (regexp-quote old) "$") nil t)
      (replace-match (concat ":" new) nil nil))
    (basic-save-buffer)
    (kill-buffer (current-buffer))))

394 395 396 397
(defun vc-sccs-find-file-hook ()
  ;; If the file is locked by some other user, make
  ;; the buffer read-only.  Like this, even root
  ;; cannot modify a file that someone else has locked.
398 399
  (and (stringp (vc-state buffer-file-name 'SCCS))
       (setq buffer-read-only t)))
400

André Spiegel's avatar
André Spiegel committed
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437

;;;
;;; Internal functions
;;;

;; This function is wrapped with `progn' so that the autoload cookie
;; copies the whole function itself into loaddefs.el rather than just placing
;; a (autoload 'vc-sccs-search-project-dir "vc-sccs") which would not
;; help us avoid loading vc-sccs.
;;;###autoload
(progn (defun vc-sccs-search-project-dir (dirname basename)
  "Return the name of a master file in the SCCS project directory.
Does not check whether the file exists but returns nil if it does not
find any project directory."
  (let ((project-dir (getenv "PROJECTDIR")) dirs dir)
    (when project-dir
      (if (file-name-absolute-p project-dir)
	  (setq dirs '("SCCS" ""))
	(setq dirs '("src/SCCS" "src" "source/SCCS" "source"))
	(setq project-dir (expand-file-name (concat "~" project-dir))))
      (while (and (not dir) dirs)
	(setq dir (expand-file-name (car dirs) project-dir))
	(unless (file-directory-p dir)
	  (setq dir nil)
	  (setq dirs (cdr dirs))))
      (and dir (expand-file-name (concat "s." basename) dir))))))

(defun vc-sccs-lock-file (file)
  "Generate lock file name corresponding to FILE."
  (let ((master (vc-name file)))
    (and
     master
     (string-match "\\(.*/\\)\\(s\\.\\)\\(.*\\)" master)
     (replace-match "p." t t master 2))))

(defun vc-sccs-parse-locks ()
  "Parse SCCS locks in current buffer.
438
The result is a list of the form ((REVISION . USER) (REVISION . USER) ...)."
André Spiegel's avatar
André Spiegel committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
  (let (master-locks)
    (goto-char (point-min))
    (while (re-search-forward "^\\([0-9.]+\\) [0-9.]+ \\([^ ]+\\) .*\n?"
			      nil t)
      (setq master-locks
	    (cons (cons (match-string 1) (match-string 2)) master-locks)))
    ;; FIXME: is it really necessary to reverse ?
    (nreverse master-locks)))

(defun vc-sccs-add-triple (name file rev)
  (with-current-buffer
      (find-file-noselect
       (expand-file-name vc-sccs-name-assoc-file
			 (file-name-directory (vc-name file))))
    (goto-char (point-max))
    (insert name "\t:\t" file "\t" rev "\n")
    (basic-save-buffer)
    (kill-buffer (current-buffer))))

(defun vc-sccs-lookup-triple (file name)
459
  "Return the numeric revision corresponding to a named tag of FILE.
460
If NAME is nil or a revision number string it's just passed through."
André Spiegel's avatar
André Spiegel committed
461 462 463 464 465 466 467 468 469
  (if (or (null name)
	  (let ((firstchar (aref name 0)))
	    (and (>= firstchar ?0) (<= firstchar ?9))))
      name
    (with-temp-buffer
      (vc-insert-file
       (expand-file-name vc-sccs-name-assoc-file
			 (file-name-directory (vc-name file))))
      (vc-parse-buffer (concat name "\t:\t" file "\t\\(.+\\)") 1))))
470 471 472

(provide 'vc-sccs)

Stefan Monnier's avatar
Stefan Monnier committed
473
;; arch-tag: d751dee3-d7b3-47e1-95e3-7ae98c052041
474
;;; vc-sccs.el ends here