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