Reduce use of (require 'cl).
[emacs.git] / lisp / vc / pcvs-defs.el
blob0f71b7b82e725fa296a2d5fdda90bd949ebce148
1 ;;; pcvs-defs.el --- variable definitions for PCL-CVS
3 ;; Copyright (C) 1991-2012 Free Software Foundation, Inc.
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
6 ;; Keywords: pcl-cvs
7 ;; Package: pcvs
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/>.
24 ;;; Commentary:
27 ;;; Code:
29 (require 'pcvs-util)
31 ;;;; -------------------------------------------------------
32 ;;;; START OF THINGS TO CHECK WHEN INSTALLING
34 (defvar cvs-program "cvs"
35 "Name or full path of the cvs executable.")
37 (defvar cvs-version
38 ;; With the divergence of the CVSNT codebase and version numbers, this is
39 ;; not really good any more.
40 (ignore-errors
41 (with-temp-buffer
42 (call-process cvs-program nil t nil "-v")
43 (goto-char (point-min))
44 (when (re-search-forward "(CVS\\(NT\\)?) \\([0-9]+\\)\\.\\([0-9]+\\)"
45 nil t)
46 (cons (string-to-number (match-string 1))
47 (string-to-number (match-string 2))))))
48 "Version of `cvs' installed on your system.
49 It must be in the (MAJOR . MINOR) format.")
51 ;; FIXME: this is only used by cvs-mode-diff-backup
52 (defvar cvs-diff-program (or (and (boundp 'diff-command) diff-command) "diff")
53 "Name or full path of the best diff program you've got.
54 NOTE: there are some nasty bugs in the context diff variants of some vendor
55 versions, such as the one in SunOS-4.")
57 ;;;; END OF THINGS TO CHECK WHEN INSTALLING
58 ;;;; --------------------------------------------------------
60 ;;;;
61 ;;;; User configuration variables:
62 ;;;;
63 ;;;; NOTE: these should be set in your ~/.emacs (or site-lisp/default.el) file.
64 ;;;;
66 (defgroup pcl-cvs nil
67 "Special support for the CVS versioning system."
68 :version "21.1"
69 :group 'tools
70 :prefix "cvs-")
73 ;; cvsrc options
76 (defcustom cvs-cvsrc-file (convert-standard-filename "~/.cvsrc")
77 "Path to your cvsrc file."
78 :group 'pcl-cvs
79 :type '(file))
81 (defvar cvs-shared-start 4
82 "Index of the first shared flag.
83 If set to 4, for instance, a numeric argument smaller than 4 will
84 select a non-shared flag, while a numeric argument greater than 3
85 will select a shared-flag.")
87 (defvar cvs-shared-flags (make-list cvs-shared-start nil)
88 "List of flags whose settings is shared among several commands.")
90 (defvar cvs-cvsroot nil
91 "Specifies where the (current) cvs master repository is.
92 Overrides the environment variable $CVSROOT by sending \" -d dir\" to
93 all CVS commands. This switch is useful if you have multiple CVS
94 repositories. It can be set interactively with \\[cvs-change-cvsroot.]
95 There is no need to set this if $CVSROOT is set to a correct value.")
97 (defcustom cvs-auto-remove-handled nil
98 "If up-to-date files should be acknowledged automatically.
99 If T, they will be removed from the *cvs* buffer after every command.
100 If DELAYED, they will be removed from the *cvs* buffer before every command.
101 If STATUS, they will only be removed after a `cvs-mode-status' command.
102 Else, they will never be automatically removed from the *cvs* buffer."
103 :group 'pcl-cvs
104 :type '(choice (const nil) (const status) (const delayed) (const t)))
106 (defcustom cvs-auto-remove-directories 'handled
107 "If ALL, directory entries will never be shown.
108 If HANDLED, only non-handled directories will be shown.
109 If EMPTY, only non-empty directories will be shown."
110 :group 'pcl-cvs
111 :type '(choice (const :tag "No" nil) (const all) (const handled) (const empty)))
113 (defcustom cvs-auto-revert t
114 "Non-nil if changed files should automatically be reverted."
115 :group 'pcl-cvs
116 :type '(boolean))
118 (defcustom cvs-sort-ignore-file t
119 "Non-nil if `cvs-mode-ignore' should sort the .cvsignore automatically."
120 :group 'pcl-cvs
121 :type '(boolean))
123 (defcustom cvs-force-dir-tag t
124 "If non-nil, tagging can only be applied to directories.
125 Tagging should generally be applied a directory at a time, but sometimes it is
126 useful to be able to tag a single file. The normal way to do that is to use
127 `cvs-mode-force-command' so as to temporarily override the restrictions,"
128 :group 'pcl-cvs
129 :type '(boolean))
131 (defcustom cvs-default-ignore-marks nil
132 "Non-nil if cvs mode commands should ignore any marked files.
133 Normally they run on the files that are marked (with `cvs-mode-mark'),
134 or the file under the cursor if no files are marked. If this variable
135 is set to a non-nil value they will by default run on the file on the
136 current line. See also `cvs-invert-ignore-marks'"
137 :group 'pcl-cvs
138 :type '(boolean))
140 (defvar cvs-diff-ignore-marks t)
141 (make-obsolete-variable 'cvs-diff-ignore-marks
142 'cvs-invert-ignore-marks
143 "21.1")
145 (defcustom cvs-invert-ignore-marks
146 (let ((l ()))
147 (unless (equal cvs-diff-ignore-marks cvs-default-ignore-marks)
148 (push "diff" l))
149 (when (and cvs-force-dir-tag (not cvs-default-ignore-marks))
150 (push "tag" l))
152 "List of cvs commands that invert the default ignore-mark behavior.
153 Commands in this set will use the opposite default from the one set
154 in `cvs-default-ignore-marks'."
155 :group 'pcl-cvs
156 :type '(set (const "diff")
157 (const "tag")
158 (const "ignore")))
160 (defcustom cvs-confirm-removals t
161 "Ask for confirmation before removing files.
162 Non-nil means that PCL-CVS will ask confirmation before removing files
163 except for files whose content can readily be recovered from the repository.
164 A value of `list' means that the list of files to be deleted will be
165 displayed when asking for confirmation."
166 :group 'pcl-cvs
167 :type '(choice (const list)
168 (const t)
169 (const nil)))
171 (defcustom cvs-add-default-message nil
172 "Default message to use when adding files.
173 If set to nil, `cvs-mode-add' will always prompt for a message."
174 :group 'pcl-cvs
175 :type '(choice (const :tag "Prompt" nil)
176 (string)))
178 (defvar cvs-diff-buffer-name "*cvs-diff*")
179 (make-obsolete-variable 'cvs-diff-buffer-name
180 'cvs-buffer-name-alist
181 "21.1")
183 (defcustom cvs-find-file-and-jump nil
184 "Jump to the modified area when finding a file.
185 If non-nil, `cvs-mode-find-file' will place the cursor at the beginning of
186 the modified area. If the file is not locally modified, this will obviously
187 have no effect."
188 :group 'pcl-cvs
189 :type '(boolean))
191 (defcustom cvs-buffer-name-alist
192 '(("diff" cvs-diff-buffer-name diff-mode)
193 ("status" "*cvs-info*" cvs-status-mode)
194 ("tree" "*cvs-info*" cvs-status-mode)
195 ("message" "*cvs-commit*" nil log-edit)
196 ("log" "*cvs-info*" log-view-mode))
197 "Buffer name and mode to be used for each command.
198 This is a list of elements of the form
200 (CMD BUFNAME MODE &optional POSTPROC)
202 CMD is the name of the command.
203 BUFNAME is an expression that should evaluate to a string used as
204 a buffer name. It can use the variable CMD if it wants to.
205 MODE is the command to use to setup the buffer.
206 POSTPROC is a function that should be executed when the command terminates
208 The CMD used for `cvs-mode-commit' is \"message\". For that special
209 case, POSTPROC is called just after MODE with special arguments."
210 :group 'pcl-cvs
211 :type '(repeat
212 (list (choice (const "diff")
213 (const "status")
214 (const "tree")
215 (const "message")
216 (const "log")
217 (string))
218 (choice (const "*vc-diff*")
219 (const "*cvs-info*")
220 (const "*cvs-commit*")
221 (const (expand-file-name "*cvs-commit*"))
222 (const (format "*cvs-%s*" cmd))
223 (const (expand-file-name (format "*cvs-%s*" cmd)))
224 (sexp :value "my-cvs-info-buffer")
225 (const nil))
226 (choice (function-item diff-mode)
227 (function-item cvs-edit-mode)
228 (function-item cvs-status-mode)
229 function
230 (const nil))
231 (set :inline t
232 (choice (function-item cvs-status-cvstrees)
233 (function-item cvs-status-trees)
234 function)))))
236 (defvar cvs-buffer-name '(expand-file-name "*cvs*" dir) ;; "*cvs*"
237 "Name of the cvs buffer.
238 This expression will be evaluated in an environment where DIR is set to
239 the directory name of the cvs buffer.")
241 (defvar cvs-temp-buffer-name
242 ;; Was '(expand-file-name " *cvs-tmp*" dir), but that causes them to
243 ;; become non-hidden if uniquification is done `forward'.
244 " *cvs-tmp*"
245 "Name of the cvs temporary buffer.
246 Output from cvs is placed here for asynchronous commands.")
248 (defcustom cvs-idiff-imerge-handlers
249 (if (fboundp 'ediff)
250 '(cvs-ediff-diff . cvs-ediff-merge)
251 '(cvs-emerge-diff . cvs-emerge-merge))
252 "Pair of functions to be used for resp. diff'ing and merg'ing interactively."
253 :group 'pcl-cvs
254 :type '(choice (const :tag "Ediff" (cvs-ediff-diff . cvs-ediff-merge))
255 (const :tag "Emerge" (cvs-emerge-diff . cvs-emerge-merge))))
257 (defvar cvs-mode-hook nil
258 "Run after `cvs-mode' was setup.")
261 ;;;;
262 ;;;; Internal variables, used in the process buffer.
263 ;;;;
265 (defvar cvs-postprocess nil
266 "(Buffer local) what to do once the process exits.")
268 ;;;;
269 ;;;; Internal variables for the *cvs* buffer.
270 ;;;;
272 (defcustom cvs-reuse-cvs-buffer 'subdir
273 "When to reuse an existing cvs buffer.
274 Alternatives are:
275 CURRENT: just reuse the current buffer if it is a cvs buffer
276 SAMEDIR: reuse any cvs buffer displaying the same directory
277 SUBDIR: or reuse any cvs buffer displaying any sub- or super- directory
278 ALWAYS: reuse any cvs buffer."
279 :group 'pcl-cvs
280 :type '(choice (const always) (const subdir) (const samedir) (const current)))
282 (defvar cvs-temp-buffer nil
283 "(Buffer local) The temporary buffer associated with this *cvs* buffer.")
285 (defvar cvs-lock-file nil
286 "Full path to a lock file that CVS is waiting for (or was waiting for).
287 This variable is buffer local and only used in the *cvs* buffer.")
289 (defvar cvs-lock-file-regexp "^#cvs\\.\\([trw]fl\\.[-.a-z0-9]+\\|lock\\)\\'"
290 "Regexp matching the possible names of locks in the CVS repository.")
292 (defconst cvs-cursor-column 22
293 "Column to position cursor in in `cvs-mode'.")
295 ;;;;
296 ;;;; Global internal variables
297 ;;;;
299 (defconst cvs-vendor-branch "1.1.1"
300 "The default branch used by CVS for vendor code.")
302 (easy-mmode-defmap cvs-mode-diff-map
303 '(("E" "imerge" . cvs-mode-imerge)
304 ("=" . cvs-mode-diff)
305 ("e" "idiff" . cvs-mode-idiff)
306 ("2" "other" . cvs-mode-idiff-other)
307 ("d" "diff" . cvs-mode-diff)
308 ("b" "backup" . cvs-mode-diff-backup)
309 ("h" "head" . cvs-mode-diff-head)
310 ("r" "repository" . cvs-mode-diff-repository)
311 ("y" "yesterday" . cvs-mode-diff-yesterday)
312 ("v" "vendor" . cvs-mode-diff-vendor))
313 "Keymap for diff-related operations in `cvs-mode'."
314 :name "Diff")
315 ;; This is necessary to allow correct handling of \\[cvs-mode-diff-map]
316 ;; in substitute-command-keys.
317 (fset 'cvs-mode-diff-map cvs-mode-diff-map)
319 (easy-mmode-defmap cvs-mode-map
320 ;;(define-prefix-command 'cvs-mode-map-diff-prefix)
321 ;;(define-prefix-command 'cvs-mode-map-control-c-prefix)
322 '(;; various
323 ;; (undo . cvs-mode-undo)
324 ("?" . cvs-help)
325 ("h" . cvs-help)
326 ("q" . cvs-bury-buffer)
327 ("z" . kill-this-buffer)
328 ("F" . cvs-mode-set-flags)
329 ;; ("\M-f" . cvs-mode-force-command)
330 ("!" . cvs-mode-force-command)
331 ("\C-c\C-c" . cvs-mode-kill-process)
332 ;; marking
333 ("m" . cvs-mode-mark)
334 ("M" . cvs-mode-mark-all-files)
335 ("S" . cvs-mode-mark-on-state)
336 ("u" . cvs-mode-unmark)
337 ("\C-?". cvs-mode-unmark-up)
338 ("%" . cvs-mode-mark-matching-files)
339 ("T" . cvs-mode-toggle-marks)
340 ("\M-\C-?" . cvs-mode-unmark-all-files)
341 ;; navigation keys
342 (" " . cvs-mode-next-line)
343 ("n" . cvs-mode-next-line)
344 ("p" . cvs-mode-previous-line)
345 ("\t" . cvs-mode-next-line)
346 ([backtab] . cvs-mode-previous-line)
347 ;; M- keys are usually those that operate on modules
348 ;;("\M-C". cvs-mode-rcs2log) ; i.e. "Create a ChangeLog"
349 ;;("\M-t". cvs-rtag)
350 ;;("\M-l". cvs-rlog)
351 ("\M-c". cvs-checkout)
352 ("\M-e". cvs-examine)
353 ("g" . cvs-mode-revert-buffer)
354 ("\M-u". cvs-update)
355 ("\M-s". cvs-status)
356 ;; diff commands
357 ("=" . cvs-mode-diff)
358 ("d" . cvs-mode-diff-map)
359 ;; keys that operate on individual files
360 ("\C-k" . cvs-mode-acknowledge)
361 ("A" . cvs-mode-add-change-log-entry-other-window)
362 ;;("B" . cvs-mode-byte-compile-files)
363 ("C" . cvs-mode-commit-setup)
364 ("O" . cvs-mode-update)
365 ("U" . cvs-mode-undo)
366 ("I" . cvs-mode-insert)
367 ("a" . cvs-mode-add)
368 ("b" . cvs-set-branch-prefix)
369 ("B" . cvs-set-secondary-branch-prefix)
370 ("c" . cvs-mode-commit)
371 ("e" . cvs-mode-examine)
372 ("f" . cvs-mode-find-file)
373 ("\C-m" . cvs-mode-find-file)
374 ("i" . cvs-mode-ignore)
375 ("l" . cvs-mode-log)
376 ("o" . cvs-mode-find-file-other-window)
377 ("r" . cvs-mode-remove)
378 ("s" . cvs-mode-status)
379 ("t" . cvs-mode-tag)
380 ("v" . cvs-mode-view-file)
381 ("x" . cvs-mode-remove-handled)
382 ;; cvstree bindings
383 ("+" . cvs-mode-tree)
384 ;; mouse bindings
385 ([mouse-2] . cvs-mode-find-file)
386 ([follow-link] . (lambda (pos)
387 (if (eq (get-char-property pos 'face) 'cvs-filename) t)))
388 ([(down-mouse-3)] . cvs-menu)
389 ;; dired-like bindings
390 ("\C-o" . cvs-mode-display-file)
391 ;; Emacs-21 toolbar
392 ;;([tool-bar item1] . (menu-item "Examine" cvs-examine :image (image :file "/usr/share/icons/xpaint.xpm" :type xpm)))
393 ;;([tool-bar item2] . (menu-item "Update" cvs-update :image (image :file "/usr/share/icons/mail1.xpm" :type xpm)))
395 "Keymap for `cvs-mode'."
396 :dense t
397 :suppress t)
399 (fset 'cvs-mode-map cvs-mode-map)
401 (easy-menu-define cvs-menu cvs-mode-map "Menu used in `cvs-mode'."
402 '("CVS"
403 ["Open file" cvs-mode-find-file t]
404 ["Open in other window" cvs-mode-find-file-other-window t]
405 ["Display in other window" cvs-mode-display-file t]
406 ["Interactive merge" cvs-mode-imerge t]
407 ("View diff"
408 ["Interactive diff" cvs-mode-idiff t]
409 ["Current diff" cvs-mode-diff t]
410 ["Diff with head" cvs-mode-diff-head t]
411 ["Diff with vendor" cvs-mode-diff-vendor t]
412 ["Diff against yesterday" cvs-mode-diff-yesterday t]
413 ["Diff with backup" cvs-mode-diff-backup t])
414 ["View log" cvs-mode-log t]
415 ["View status" cvs-mode-status t]
416 ["View tag tree" cvs-mode-tree t]
417 "----"
418 ["Insert" cvs-mode-insert]
419 ["Update" cvs-mode-update (cvs-enabledp 'update)]
420 ["Re-examine" cvs-mode-examine t]
421 ["Commit" cvs-mode-commit-setup (cvs-enabledp 'commit)]
422 ["Tag" cvs-mode-tag (cvs-enabledp (when cvs-force-dir-tag 'tag))]
423 ["Undo changes" cvs-mode-undo (cvs-enabledp 'undo)]
424 ["Add" cvs-mode-add (cvs-enabledp 'add)]
425 ["Remove" cvs-mode-remove (cvs-enabledp 'remove)]
426 ["Ignore" cvs-mode-ignore (cvs-enabledp 'ignore)]
427 ["Add ChangeLog" cvs-mode-add-change-log-entry-other-window t]
428 "----"
429 ["Mark" cvs-mode-mark t]
430 ["Mark all" cvs-mode-mark-all-files t]
431 ["Mark by regexp..." cvs-mode-mark-matching-files t]
432 ["Mark by state..." cvs-mode-mark-on-state t]
433 ["Unmark" cvs-mode-unmark t]
434 ["Unmark all" cvs-mode-unmark-all-files t]
435 ["Hide handled" cvs-mode-remove-handled t]
436 "----"
437 ["PCL-CVS Manual" (lambda () (interactive)
438 (info "(pcl-cvs)Top")) t]
439 "----"
440 ["Quit" cvs-mode-quit t]))
442 ;;;;
443 ;;;; CVS-Minor mode
444 ;;;;
446 (defcustom cvs-minor-mode-prefix "\C-xc"
447 "Prefix key for the `cvs-mode' bindings in `cvs-minor-mode'."
448 :group 'pcl-cvs)
450 (easy-mmode-defmap cvs-minor-mode-map
451 `((,cvs-minor-mode-prefix . cvs-mode-map)
452 ("e" . (menu-item nil cvs-mode-edit-log
453 :filter (lambda (x) (if (derived-mode-p 'log-view-mode) x)))))
454 "Keymap for `cvs-minor-mode', used in buffers related to PCL-CVS.")
456 (defvar cvs-buffer nil
457 "(Buffer local) The *cvs* buffer associated with this buffer.")
458 (put 'cvs-buffer 'permanent-local t)
459 ;;(make-variable-buffer-local 'cvs-buffer)
461 (defvar cvs-minor-wrap-function nil
462 "Function to call when switching to the *cvs* buffer.
463 Takes two arguments:
464 - a *cvs* buffer.
465 - a zero-arg function which is guaranteed not to switch buffer.
466 It is expected to call the function.")
467 ;;(make-variable-buffer-local 'cvs-minor-wrap-function)
469 (defvar cvs-minor-current-files)
470 ;;"Current files in a `cvs-minor-mode' buffer."
471 ;; This should stay `void' because we want to be able to tell the difference
472 ;; between an empty list and no list at all.
474 (defconst cvs-pcl-cvs-dirchange-re "^pcl-cvs: descending directory \\(.*\\)$")
476 ;;;;
477 ;;;; autoload the global menu
478 ;;;;
480 ;;;###autoload
481 (defvar cvs-global-menu
482 (let ((m (make-sparse-keymap "PCL-CVS")))
483 (define-key m [status]
484 `(menu-item ,(purecopy "Directory Status") cvs-status
485 :help ,(purecopy "A more verbose status of a workarea")))
486 (define-key m [checkout]
487 `(menu-item ,(purecopy "Checkout Module") cvs-checkout
488 :help ,(purecopy "Check out a module from the repository")))
489 (define-key m [update]
490 `(menu-item ,(purecopy "Update Directory") cvs-update
491 :help ,(purecopy "Fetch updates from the repository")))
492 (define-key m [examine]
493 `(menu-item ,(purecopy "Examine Directory") cvs-examine
494 :help ,(purecopy "Examine the current state of a workarea")))
495 (fset 'cvs-global-menu m))
496 "Global menu used by PCL-CVS.")
499 ;; cvs-1.10 and above can take file arguments in other directories
500 ;; while others need to be executed once per directory
501 (defvar cvs-execute-single-dir
502 (if (or (null cvs-version)
503 (or (>= (cdr cvs-version) 10) (> (car cvs-version) 1)))
504 ;; Supposedly some recent versions of CVS output some directory info
505 ;; as they recurse down the tree, but it's not good enough in the case
506 ;; where we run "cvs status foo bar/foo".
507 '("status")
509 "Whether cvs commands should be executed a directory at a time.
510 If a list, specifies for which commands the single-dir mode should be used.
511 If T, single-dir mode should be used for all operations.
513 CVS versions before 1.10 did not allow passing them arguments in different
514 directories, so pcl-cvs checks what version you're using to determine
515 whether to use the new feature or not.
516 Sadly, even with a new cvs executable, if you connect to an older cvs server
517 \(typically a cvs-1.9 on the server), the old restriction applies. In such
518 a case the sanity check made by pcl-cvs fails and you will have to manually
519 set this variable to t (until the cvs server is upgraded).
520 When the above problem occurs, pcl-cvs should (hopefully) catch cvs' error
521 message and replace it with a message telling you to change this variable.")
524 (provide 'pcvs-defs)
526 ;;; pcvs-defs.el ends here