lisp/pcvs-defs.el

   1 ;;; pcvs-defs.el --- variable definitions for PCL-CVS
   2
   3 ;; Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 03, 2004
   4 ;;           Free Software Foundation, Inc.
   5
   6 ;; Author: Stefan Monnier <monnier@cs.yale.edu>
   7 ;; Keywords: pcl-cvs
   8
   9 ;; This file is part of GNU Emacs.
  10
  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 2, or (at your option)
  14 ;; any later version.
  15
  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.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28
  29 ;;; Code:
  30
  31 (eval-when-compile (require 'cl))
  32 (require 'pcvs-util)
  33
  34 ;;;; -------------------------------------------------------
  35 ;;;;        START OF THINGS TO CHECK WHEN INSTALLING
  36
  37 (defvar cvs-program "cvs"
  38   "*Name or full path of the cvs executable.")
  39
  40 (defvar cvs-version
  41   (ignore-errors
  42     (with-temp-buffer
  43       (call-process cvs-program nil t nil "-v")
  44       (goto-char (point-min))
  45       (when (re-search-forward "(CVS) \\([0-9]+\\)\\.\\([0-9]+\\)" 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.")
  50
  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.")
  56
  57 ;;;;         END OF THINGS TO CHECK WHEN INSTALLING
  58 ;;;; --------------------------------------------------------
  59
  60 ;;;;
  61 ;;;;    User configuration variables:
  62 ;;;;
  63 ;;;; NOTE: these should be set in your ~/.emacs (or site-lisp/default.el) file.
  64 ;;;;
  65
  66 (defgroup pcl-cvs nil
  67   "Special support for the CVS versioning system."
  68   :version "21.1"
  69   :group 'tools
  70   :prefix "cvs-")
  71
  72 ;;
  73 ;;  cvsrc options
  74 ;;
  75
  76 (defcustom cvs-cvsrc-file "~/.cvsrc"
  77   "Path to your cvsrc file."
  78   :group 'pcl-cvs
  79   :type '(file))
  80
  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.")
  86
  87 (defvar cvs-shared-flags (make-list cvs-shared-start nil)
  88   "List of flags whose settings is shared among several commands.")
  89
  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.")
  96
  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)))
 105
 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)))
 112
 113 (defcustom cvs-auto-revert t
 114   "*Non-nil if changed files should automatically be reverted."
 115   :group 'pcl-cvs
 116   :type '(boolean))
 117
 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))
 122
 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))
 130
 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))
 139
 140 (defvar cvs-diff-ignore-marks t)
 141 (make-obsolete-variable 'cvs-diff-ignore-marks
 142                         'cvs-invert-ignore-marks)
 143
 144 (defcustom cvs-invert-ignore-marks
 145   (let ((l ()))
 146     (unless (equal cvs-diff-ignore-marks cvs-default-ignore-marks)
 147       (push "diff" l))
 148     (when (and cvs-force-dir-tag (not cvs-default-ignore-marks))
 149       (push "tag" l))
 150     l)
 151   "*List of cvs commands that invert the default ignore-mark behavior.
 152 Commands in this set will use the opposite default from the one set
 153 in `cvs-default-ignore-marks'."
 154   :group 'pcl-cvs
 155   :type '(set (const "diff")
 156               (const "tag")
 157               (const "ignore")))
 158
 159 (defcustom cvs-confirm-removals t
 160   "*Ask for confirmation before removing files.
 161 Non-nil means that PCL-CVS will ask confirmation before removing files
 162 except for files whose content can readily be recovered from the repository.
 163 A value of `list' means that the list of files to be deleted will be
 164 displayed when asking for confirmation."
 165   :group 'pcl-cvs
 166   :type '(choice (const list)
 167                  (const t)
 168                  (const nil)))
 169
 170 (defcustom cvs-add-default-message nil
 171   "*Default message to use when adding files.
 172 If set to nil, `cvs-mode-add' will always prompt for a message."
 173   :group 'pcl-cvs
 174   :type '(choice (const :tag "Prompt" nil)
 175                  (string)))
 176
 177 (defvar cvs-diff-buffer-name "*cvs-diff*")
 178 (make-obsolete-variable 'cvs-diff-buffer-name
 179                         'cvs-buffer-name-alist)
 180
 181 (defcustom cvs-find-file-and-jump nil
 182   "Jump to the modified area when finding a file.
 183 If non-nil, `cvs-mode-file-file' will place the cursor at the beginning of
 184 the modified area.  If the file is not locally modified, this will obviously
 185 have no effect."
 186   :group 'pcl-cvs
 187   :type '(boolean))
 188
 189 (defcustom cvs-buffer-name-alist
 190   '(("diff" cvs-diff-buffer-name diff-mode)
 191     ("status" "*cvs-info*" cvs-status-mode)
 192     ("tree" "*cvs-info*" cvs-status-mode)
 193     ("message" "*cvs-commit*" nil log-edit)
 194     ("log" "*cvs-info*" log-view-mode))
 195   "*Buffer name and mode to be used for each command.
 196 This is a list of elements of the form
 197
 198         (CMD BUFNAME MODE &optional POSTPROC)
 199
 200 CMD is the name of the command.
 201 BUFNAME is an expression that should evaluate to a string used as
 202   a buffer name.  It can use the variable CMD if it wants to.
 203 MODE is the command to use to setup the buffer.
 204 POSTPROC is a function that should be executed when the command terminates
 205
 206 The CMD used for `cvs-mode-commit' is \"message\".  For that special
 207   case, POSTPROC is called just after MODE with special arguments."
 208   :group 'pcl-cvs
 209   :type '(repeat
 210           (list (choice (const "diff")
 211                         (const "status")
 212                         (const "tree")
 213                         (const "message")
 214                         (const "log")
 215                         (string))
 216                 (choice (const "*vc-diff*")
 217                         (const "*cvs-info*")
 218                         (const "*cvs-commit*")
 219                         (const (expand-file-name "*cvs-commit*"))
 220                         (const (format "*cvs-%s*" cmd))
 221                         (const (expand-file-name (format "*cvs-%s*" cmd)))
 222                         (sexp :value "my-cvs-info-buffer")
 223                         (const nil))
 224                 (choice (function-item diff-mode)
 225                         (function-item cvs-edit-mode)
 226                         (function-item cvs-status-mode)
 227                         function
 228                         (const nil))
 229                 (set :inline t
 230                      (choice (function-item cvs-status-cvstrees)
 231                              (function-item cvs-status-trees)
 232                              function)))))
 233
 234 (defvar cvs-buffer-name '(expand-file-name "*cvs*" dir) ;; "*cvs*"
 235   "Name of the cvs buffer.
 236 This expression will be evaluated in an environment where DIR is set to
 237 the directory name of the cvs buffer.")
 238
 239 (defvar cvs-temp-buffer-name '(expand-file-name " *cvs-tmp*" dir)
 240   "*Name of the cvs temporary buffer.
 241 Output from cvs is placed here for asynchronous commands.")
 242
 243 (defcustom cvs-idiff-imerge-handlers
 244   (if (fboundp 'ediff)
 245       '(cvs-ediff-diff . cvs-ediff-merge)
 246     '(cvs-emerge-diff . cvs-emerge-merge))
 247   "*Pair of functions to be used for resp.  diff'ing and merg'ing interactively."
 248   :group 'pcl-cvs
 249   :type '(choice (const :tag "Ediff" (cvs-ediff-diff . cvs-ediff-merge))
 250                  (const :tag "Emerge" (cvs-emerge-diff . cvs-emerge-merge))))
 251
 252 (defvar pcl-cvs-load-hook nil
 253   "Run after loading pcl-cvs.")
 254
 255 (defvar cvs-mode-hook nil
 256   "Run after `cvs-mode' was setup.")
 257
 258 \f
 259 ;;;;
 260 ;;;; Internal variables, used in the process buffer.
 261 ;;;;
 262
 263 (defvar cvs-postprocess nil
 264   "(Buffer local) what to do once the process exits.")
 265
 266 ;;;;
 267 ;;;; Internal variables for the *cvs* buffer.
 268 ;;;;
 269
 270 (defcustom cvs-reuse-cvs-buffer 'subdir
 271   "When to reuse an existing cvs buffer.
 272 Alternatives are:
 273  CURRENT: just reuse the current buffer if it is a cvs buffer
 274  SAMEDIR: reuse any cvs buffer displaying the same directory
 275  SUBDIR:  or reuse any cvs buffer displaying any sub- or super- directory
 276  ALWAYS:  reuse any cvs buffer."
 277   :group 'pcl-cvs
 278   :type '(choice (const always) (const subdir) (const samedir) (const current)))
 279
 280 (defvar cvs-temp-buffer nil
 281   "(Buffer local) The temporary buffer associated with this *cvs* buffer.")
 282
 283 (defvar cvs-lock-file nil
 284   "Full path to a lock file that CVS is waiting for (or was waiting for).
 285 This variable is buffer local and only used in the *cvs* buffer.")
 286
 287 (defvar cvs-lock-file-regexp "^#cvs\\.\\([trw]fl\\.[-.a-z0-9]+\\|lock\\)\\'"
 288   "Regexp matching the possible names of locks in the CVS repository.")
 289
 290 (defconst cvs-cursor-column 22
 291   "Column to position cursor in in `cvs-mode'.")
 292
 293 ;;;;
 294 ;;;; Global internal variables
 295 ;;;;
 296
 297 (defconst cvs-vendor-branch "1.1.1"
 298   "The default branch used by CVS for vendor code.")
 299
 300 (easy-mmode-defmap cvs-mode-diff-map
 301   '(("E" "imerge" .     cvs-mode-imerge)
 302     ("=" .              cvs-mode-diff)
 303     ("e" "idiff" .      cvs-mode-idiff)
 304     ("2" "other" .      cvs-mode-idiff-other)
 305     ("d" "diff" .       cvs-mode-diff)
 306     ("b" "backup" .     cvs-mode-diff-backup)
 307     ("h" "head" .       cvs-mode-diff-head)
 308     ("v" "vendor" .     cvs-mode-diff-vendor))
 309   "Keymap for diff-related operations in `cvs-mode'."
 310   :name "Diff")
 311 ;; This is necessary to allow correct handling of \\[cvs-mode-diff-map]
 312 ;; in substitute-command-keys.
 313 (fset 'cvs-mode-diff-map cvs-mode-diff-map)
 314
 315 (easy-mmode-defmap cvs-mode-map
 316   ;;(define-prefix-command 'cvs-mode-map-diff-prefix)
 317   ;;(define-prefix-command 'cvs-mode-map-control-c-prefix)
 318   '(;; simulate `suppress-keymap'
 319     (self-insert-command . undefined)
 320     (("0" "1" "2" "3" "4" "5" "6" "7" "8" "9") . digit-argument)
 321     ("-" .      negative-argument)
 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     ;; M- keys are usually those that operate on modules
 346     ;;("\M-C".  cvs-mode-rcs2log) ; i.e. "Create a ChangeLog"
 347     ;;("\M-t".  cvs-rtag)
 348     ;;("\M-l".  cvs-rlog)
 349     ("\M-c".    cvs-checkout)
 350     ("\M-e".    cvs-examine)
 351     ("g" .      cvs-mode-revert-buffer)
 352     ("\M-u".    cvs-update)
 353     ("\M-s".    cvs-status)
 354     ;; diff commands
 355     ("=" .      cvs-mode-diff)
 356     ("d" .      cvs-mode-diff-map)
 357     ;; keys that operate on individual files
 358     ("\C-k" .   cvs-mode-acknowledge)
 359     ("A" .      cvs-mode-add-change-log-entry-other-window)
 360     ;;("B" .    cvs-mode-byte-compile-files)
 361     ("C" .      cvs-mode-commit-setup)
 362     ("O" .      cvs-mode-update)
 363     ("U" .      cvs-mode-undo)
 364     ("I" .      cvs-mode-insert)
 365     ("a" .      cvs-mode-add)
 366     ("b" .      cvs-set-branch-prefix)
 367     ("B" .      cvs-set-secondary-branch-prefix)
 368     ("c" .      cvs-mode-commit)
 369     ("e" .      cvs-mode-examine)
 370     ("f" .      cvs-mode-find-file)
 371     ("\C-m" .   cvs-mode-find-file)
 372     ("i" .      cvs-mode-ignore)
 373     ("l" .      cvs-mode-log)
 374     ("o" .      cvs-mode-find-file-other-window)
 375     ("r" .      cvs-mode-remove)
 376     ("s" .      cvs-mode-status)
 377     ("t" .      cvs-mode-tag)
 378     ;;("v" .    cvs-mode-diff-vendor)
 379     ("x" .      cvs-mode-remove-handled)
 380     ;; cvstree bindings
 381     ("+" .      cvs-mode-tree)
 382     ;; mouse bindings
 383     ([mouse-2] . cvs-mode-find-file)
 384     ([(down-mouse-3)] . cvs-menu)
 385     ;; dired-like bindings
 386     ("\C-o" .   cvs-mode-display-file)
 387     ;; Emacs-21 toolbar
 388     ;;([tool-bar item1] . (menu-item "Examine" cvs-examine :image (image :file "/usr/share/icons/xpaint.xpm" :type xpm)))
 389     ;;([tool-bar item2] . (menu-item "Update" cvs-update :image (image :file "/usr/share/icons/mail1.xpm" :type xpm)))
 390     )
 391   "Keymap for `cvs-mode'."
 392   :dense t)
 393
 394 (fset 'cvs-mode-map cvs-mode-map)
 395
 396 (easy-menu-define cvs-menu cvs-mode-map "Menu used in `cvs-mode'."
 397   '("CVS"
 398     ["Open file.."              cvs-mode-find-file      t]
 399     [" ..other window"          cvs-mode-find-file-other-window t]
 400     ["Display in other window"  cvs-mode-display-file   t]
 401     ["Interactive merge"        cvs-mode-imerge         t]
 402     ("View diff"
 403      ["Interactive diff"        cvs-mode-idiff          t]
 404      ["Current diff"            cvs-mode-diff           t]
 405      ["Diff with head"          cvs-mode-diff-head      t]
 406      ["Diff with vendor"        cvs-mode-diff-vendor    t]
 407      ["Diff with backup"        cvs-mode-diff-backup    t])
 408     ["View log"                 cvs-mode-log            t]
 409     ["View status"              cvs-mode-status         t]
 410     ["View tag tree"            cvs-mode-tree           t]
 411     "----"
 412     ["Insert"                   cvs-mode-insert]
 413     ["Update"                   cvs-mode-update         (cvs-enabledp 'update)]
 414     ["Re-examine"               cvs-mode-examine        t]
 415     ["Commit"                   cvs-mode-commit-setup   (cvs-enabledp 'commit)]
 416     ["Tag"                      cvs-mode-tag            (cvs-enabledp (when cvs-force-dir-tag 'tag))]
 417     ["Undo changes"             cvs-mode-undo           (cvs-enabledp 'undo)]
 418     ["Add"                      cvs-mode-add            (cvs-enabledp 'add)]
 419     ["Remove"                   cvs-mode-remove         (cvs-enabledp 'remove)]
 420     ["Ignore"                   cvs-mode-ignore         (cvs-enabledp 'ignore)]
 421     ["Add ChangeLog"            cvs-mode-add-change-log-entry-other-window t]
 422     "----"
 423     ["Mark all"                 cvs-mode-mark-all-files t]
 424     ["Mark by regexp..."        cvs-mode-mark-matching-files t]
 425     ["Mark by state..."         cvs-mode-mark-on-state t]
 426     ["Unmark all"               cvs-mode-unmark-all-files t]
 427     ["Hide handled"             cvs-mode-remove-handled t]
 428     "----"
 429     ["Quit"                     cvs-mode-quit           t]))
 430
 431 ;;;;
 432 ;;;; CVS-Minor mode
 433 ;;;;
 434
 435 (defcustom cvs-minor-mode-prefix "\C-xc"
 436   "Prefix key for the `cvs-mode' bindings in `cvs-minor-mode'."
 437   :group 'pcl-cvs)
 438
 439 (easy-mmode-defmap cvs-minor-mode-map
 440   `((,cvs-minor-mode-prefix . cvs-mode-map)
 441     ("e" . (menu-item nil cvs-mode-edit-log
 442             :filter (lambda (x) (if (derived-mode-p 'log-view-mode) x)))))
 443   "Keymap for `cvs-minor-mode', used in buffers related to PCL-CVS.")
 444
 445 (defvar cvs-buffer nil
 446   "(Buffer local) The *cvs* buffer associated with this buffer.")
 447 (put 'cvs-buffer 'permanent-local t)
 448 ;;(make-variable-buffer-local 'cvs-buffer)
 449
 450 (defvar cvs-minor-wrap-function nil
 451   "Function to call when switching to the *cvs* buffer.
 452 Takes two arguments:
 453 - a *cvs* buffer.
 454 - a zero-arg function which is guaranteed not to switch buffer.
 455 It is expected to call the function.")
 456 ;;(make-variable-buffer-local 'cvs-minor-wrap-function)
 457
 458 (defvar cvs-minor-current-files)
 459 ;;"Current files in a `cvs-minor-mode' buffer."
 460 ;; This should stay `void' because we want to be able to tell the difference
 461 ;; between an empty list and no list at all.
 462
 463 (defconst cvs-pcl-cvs-dirchange-re "^pcl-cvs: descending directory \\(.*\\)$")
 464
 465 ;;;;
 466 ;;;; autoload the global menu
 467 ;;;;
 468
 469 ;;;###autoload
 470 (defvar cvs-global-menu
 471   (let ((m (make-sparse-keymap "PCL-CVS")))
 472     (define-key m [status]
 473       '(menu-item "Directory Status" cvs-status
 474                   :help "A more verbose status of a workarea"))
 475     (define-key m [checkout]
 476       '(menu-item "Checkout Module" cvs-checkout
 477                   :help "Check out a module from the repository"))
 478     (define-key m [update]
 479       '(menu-item "Update Directory" cvs-update
 480                   :help "Fetch updates from the repository"))
 481     (define-key m [examine]
 482       '(menu-item "Examine Directory" cvs-examine
 483                   :help "Examine the current state of a workarea"))
 484     (fset 'cvs-global-menu m)))
 485
 486
 487 ;; cvs-1.10 and above can take file arguments in other directories
 488 ;; while others need to be executed once per directory
 489 (defvar cvs-execute-single-dir
 490   (if (and (consp cvs-version)
 491             (or (>= (cdr cvs-version) 10) (> (car cvs-version) 1)))
 492       '("status")
 493     t)
 494   "Whether cvs commands should be executed a directory at a time.
 495 If a list, specifies for which commands the single-dir mode should be used.
 496 If T, single-dir mode should be used for all operations.
 497
 498 CVS versions before 1.10 did not allow passing them arguments in different
 499 directories, so pcl-cvs checks what version you're using to determine
 500 whether to use the new feature or not.
 501 Sadly, even with a new cvs executable, if you connect to an older cvs server
 502 \(typically a cvs-1.9 on the server), the old restriction applies.  In such
 503 a case the sanity check made by pcl-cvs fails and you will have to manually
 504 set this variable to t (until the cvs server is upgraded).
 505 When the above problem occurs, pcl-cvs should (hopefully) catch cvs' error
 506 message and replace it with a message tell you to change this variable.")
 507
 508 ;;
 509 (provide 'pcvs-defs)
 510
 511 ;;; arch-tag: c7c701d0-d1d4-4aa9-a302-007bb03aca5e
 512 ;;; pcvs-defs.el ends here