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