code.delx.au - gnu-emacs/blob - lisp/ediff-hook.el

   1 ;;; ediff-hook.el --- setup for Ediff's menus and autoloads
   2
   3 ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
   4
   5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 ;;;   These must be placed in menu-bar.el in Emacs
  29 ;;
  30 ;;      (define-key menu-bar-tools-menu [ediff-misc]
  31 ;;      '("Ediff Miscellanea" . menu-bar-ediff-misc-menu))
  32 ;;      (define-key menu-bar-tools-menu [epatch]
  33 ;;      '("Apply Patch" . menu-bar-epatch-menu))
  34 ;;      (define-key menu-bar-tools-menu [ediff-merge]
  35 ;;      '("Merge" . menu-bar-ediff-merge-menu))
  36 ;;      (define-key menu-bar-tools-menu [ediff]
  37 ;;      '("Compare" . menu-bar-ediff-menu))
  38
  39 ;; Compiler pacifier
  40 (defvar ediff-menu)
  41 (defvar ediff-merge-menu)
  42 (defvar epatch-menu)
  43 (defvar ediff-misc-menu)
  44 ;; end pacifier
  45
  46 ;; allow menus to be set up without ediff-wind.el being loaded
  47 ;;;###autoload
  48 (defvar ediff-window-setup-function)
  49
  50 ;; This macro is used to avoid compilation warnings.
  51 ;; The macro will expand into the form that is appropriate to the
  52 ;; compiler at hand (emacs or xemacs).
  53 ;; The autoload, below, is useless in Emacs because ediff-hook.el
  54 ;; is dumped with emacs, but it is needed in XEmacs
  55 ;;;###autoload
  56 (defmacro ediff-cond-compile-for-xemacs-or-emacs (xemacs-form emacs-form)
  57   (if (string-match "XEmacs" emacs-version)
  58       xemacs-form emacs-form))
  59
  60 ;; This autoload is useless in Emacs because ediff-hook.el is dumped with
  61 ;; emacs, but it is needed in XEmacs
  62 ;;;###autoload
  63 (ediff-cond-compile-for-xemacs-or-emacs
  64  ;; xemacs form
  65  (defun ediff-xemacs-init-menus ()
  66    (if (featurep 'menubar)
  67        (progn
  68          (add-submenu
  69           '("Tools") ediff-menu "OO-Browser...")
  70          (add-submenu
  71           '("Tools") ediff-merge-menu "OO-Browser...")
  72          (add-submenu
  73           '("Tools") epatch-menu "OO-Browser...")
  74          (add-submenu
  75           '("Tools") ediff-misc-menu "OO-Browser...")
  76          (add-menu-button
  77           '("Tools") "-------" "OO-Browser...")
  78          )))
  79  nil ; emacs form
  80  )
  81
  82
  83 ;; This autoload is useless in Emacs because ediff-hook.el is dumped with
  84 ;; emacs, but it is needed in XEmacs
  85 ;;;###autoload
  86 (ediff-cond-compile-for-xemacs-or-emacs
  87  (progn
  88    (defvar ediff-menu
  89      '("Compare"
  90        ["Two Files..."  ediff-files t]
  91        ["Two Buffers..." ediff-buffers t]
  92        ["Three Files..."  ediff-files3 t]
  93        ["Three Buffers..." ediff-buffers3 t]
  94        "---"
  95        ["Two Directories..." ediff-directories t]
  96        ["Three Directories..." ediff-directories3 t]
  97        "---"
  98        ["File with Revision..."  ediff-revision t]
  99        ["Directory Revisions..."  ediff-directory-revisions t]
 100        "---"
 101        ["Windows Word-by-word..." ediff-windows-wordwise t]
 102        ["Windows Line-by-line..." ediff-windows-linewise t]
 103        "---"
 104        ["Regions Word-by-word..." ediff-regions-wordwise t]
 105        ["Regions Line-by-line..." ediff-regions-linewise t]
 106        ))
 107    (defvar ediff-merge-menu
 108      '("Merge"
 109        ["Files..."  ediff-merge-files t]
 110        ["Files with Ancestor..." ediff-merge-files-with-ancestor t]
 111        ["Buffers..."  ediff-merge-buffers t]
 112        ["Buffers with Ancestor..."
 113         ediff-merge-buffers-with-ancestor t]
 114        "---"
 115        ["Directories..."  ediff-merge-directories t]
 116        ["Directories with Ancestor..."
 117         ediff-merge-directories-with-ancestor t]
 118        "---"
 119        ["Revisions..."  ediff-merge-revisions t]
 120        ["Revisions with Ancestor..."
 121         ediff-merge-revisions-with-ancestor t]
 122        ["Directory Revisions..." ediff-merge-directory-revisions t]
 123        ["Directory Revisions with Ancestor..."
 124         ediff-merge-directory-revisions-with-ancestor t]
 125        ))
 126    (defvar epatch-menu
 127      '("Apply Patch"
 128        ["To a file..."  ediff-patch-file t]
 129        ["To a buffer..." ediff-patch-buffer t]
 130        ))
 131    (defvar ediff-misc-menu
 132      '("Ediff Miscellanea"
 133        ["Ediff Manual..." ediff-documentation t]
 134        ["Customize Ediff..." ediff-customize t]
 135        ["List Ediff Sessions..." ediff-show-registry t]
 136        ["Use separate frame for Ediff control buffer..."
 137         ediff-toggle-multiframe
 138         :style toggle
 139         :selected (if (and (featurep 'ediff-util)
 140                            (boundp 'ediff-window-setup-function))
 141                       (eq ediff-window-setup-function
 142                           'ediff-setup-windows-multiframe))]
 143        ["Use a toolbar with Ediff control buffer"
 144         ediff-toggle-use-toolbar
 145         :style toggle
 146         :selected (if (featurep 'ediff-tbar)
 147                       (ediff-use-toolbar-p))]
 148        ))
 149
 150    ;; put these menus before Object-Oriented-Browser in Tools menu
 151    (if (and (featurep 'menubar) (not (featurep 'infodock))
 152             (not (featurep 'ediff-hook)))
 153            (ediff-xemacs-init-menus)))
 154
 155  ;; Emacs--only if menu-bar is loaded
 156  (if (featurep 'menu-bar)
 157      (progn
 158        ;; initialize menu bar keymaps
 159        (defvar menu-bar-ediff-misc-menu
 160          (make-sparse-keymap "Ediff Miscellanea"))
 161        (fset 'menu-bar-ediff-misc-menu
 162              (symbol-value 'menu-bar-ediff-misc-menu))
 163        (defvar menu-bar-epatch-menu (make-sparse-keymap "Apply Patch"))
 164        (fset 'menu-bar-epatch-menu (symbol-value 'menu-bar-epatch-menu))
 165        (defvar menu-bar-ediff-merge-menu (make-sparse-keymap "Merge"))
 166        (fset 'menu-bar-ediff-merge-menu
 167              (symbol-value 'menu-bar-ediff-merge-menu))
 168        (defvar menu-bar-ediff-menu (make-sparse-keymap "Compare"))
 169        (fset 'menu-bar-ediff-menu (symbol-value 'menu-bar-ediff-menu))
 170
 171        ;; define ediff-menu
 172        (define-key menu-bar-ediff-menu [window]
 173          '("This Window and Next Window" . compare-windows))
 174        (define-key menu-bar-ediff-menu [ediff-windows-linewise]
 175          '("Windows Line-by-line..." . ediff-windows-linewise))
 176        (define-key menu-bar-ediff-menu [ediff-windows-wordwise]
 177          '("Windows Word-by-word..." . ediff-windows-wordwise))
 178        (define-key menu-bar-ediff-menu [separator-ediff-windows] '("--"))
 179        (define-key menu-bar-ediff-menu [ediff-regions-linewise]
 180          '("Regions Line-by-line..." . ediff-regions-linewise))
 181        (define-key menu-bar-ediff-menu [ediff-regions-wordwise]
 182          '("Regions Word-by-word..." . ediff-regions-wordwise))
 183        (define-key menu-bar-ediff-menu [separator-ediff-regions] '("--"))
 184        (define-key menu-bar-ediff-menu [ediff-dir-revision]
 185          '("Directory Revisions..." . ediff-directory-revisions))
 186        (define-key menu-bar-ediff-menu [ediff-revision]
 187          '("File with Revision..." . ediff-revision))
 188        (define-key menu-bar-ediff-menu [separator-ediff-directories] '("--"))
 189        (define-key menu-bar-ediff-menu [ediff-directories3]
 190          '("Three Directories..." . ediff-directories3))
 191        (define-key menu-bar-ediff-menu [ediff-directories]
 192          '("Two Directories..." . ediff-directories))
 193        (define-key menu-bar-ediff-menu [separator-ediff-files] '("--"))
 194        (define-key menu-bar-ediff-menu [ediff-buffers3]
 195          '("Three Buffers..." . ediff-buffers3))
 196        (define-key menu-bar-ediff-menu [ediff-files3]
 197          '("Three Files..." . ediff-files3))
 198        (define-key menu-bar-ediff-menu [ediff-buffers]
 199          '("Two Buffers..." . ediff-buffers))
 200        (define-key menu-bar-ediff-menu [ediff-files]
 201          '("Two Files..." . ediff-files))
 202
 203        ;; define merge menu
 204        (define-key
 205          menu-bar-ediff-merge-menu [ediff-merge-dir-revisions-with-ancestor]
 206          '("Directory Revisions with Ancestor..."
 207            . ediff-merge-directory-revisions-with-ancestor))
 208        (define-key
 209          menu-bar-ediff-merge-menu [ediff-merge-dir-revisions]
 210          '("Directory Revisions..." . ediff-merge-directory-revisions))
 211        (define-key
 212          menu-bar-ediff-merge-menu [ediff-merge-revisions-with-ancestor]
 213          '("Revisions with Ancestor..."
 214            . ediff-merge-revisions-with-ancestor))
 215        (define-key menu-bar-ediff-merge-menu [ediff-merge-revisions]
 216          '("Revisions..." . ediff-merge-revisions))
 217        (define-key menu-bar-ediff-merge-menu [separator-ediff-merge] '("--"))
 218        (define-key
 219          menu-bar-ediff-merge-menu [ediff-merge-directories-with-ancestor]
 220          '("Directories with Ancestor..."
 221            . ediff-merge-directories-with-ancestor))
 222        (define-key menu-bar-ediff-merge-menu [ediff-merge-directories]
 223          '("Directories..." . ediff-merge-directories))
 224        (define-key
 225          menu-bar-ediff-merge-menu [separator-ediff-merge-dirs] '("--"))
 226        (define-key
 227          menu-bar-ediff-merge-menu [ediff-merge-buffers-with-ancestor]
 228          '("Buffers with Ancestor..." . ediff-merge-buffers-with-ancestor))
 229        (define-key menu-bar-ediff-merge-menu [ediff-merge-buffers]
 230          '("Buffers..." . ediff-merge-buffers))
 231        (define-key menu-bar-ediff-merge-menu [ediff-merge-files-with-ancestor]
 232          '("Files with Ancestor..." . ediff-merge-files-with-ancestor))
 233        (define-key menu-bar-ediff-merge-menu [ediff-merge-files]
 234          '("Files..." . ediff-merge-files))
 235
 236        ;; define epatch menu
 237        (define-key menu-bar-epatch-menu [ediff-patch-buffer]
 238          '("To a Buffer..." . ediff-patch-buffer))
 239        (define-key menu-bar-epatch-menu [ediff-patch-file]
 240          '("To a File..." . ediff-patch-file))
 241
 242        ;; define ediff miscellanea
 243        (define-key menu-bar-ediff-misc-menu [emultiframe]
 244          '("Toggle use of separate control buffer frame..."
 245            . ediff-toggle-multiframe))
 246        (define-key menu-bar-ediff-misc-menu [eregistry]
 247          '("List Ediff Sessions..." . ediff-show-registry))
 248        (define-key menu-bar-ediff-misc-menu [ediff-cust]
 249          '("Customize Ediff..." . ediff-customize))
 250        (define-key menu-bar-ediff-misc-menu [ediff-doc]
 251          '("Ediff Manual..." . ediff-documentation))
 252        )
 253
 254       ) ; emacs case
 255  ) ; ediff-cond-compile-for-xemacs-or-emacs
 256
 257 ;; arrange for autoloads
 258 (if purify-flag
 259     () ; if dumping, autoloads are set up in loaddefs.el
 260   ;; if the user decides to load this file, set up autoloads
 261   ;; compare files and buffers
 262   (autoload 'ediff "ediff" "Compare two files" t)
 263   (autoload 'ediff-files "ediff" "Compare two files" t)
 264   (autoload 'ediff-buffers "ediff" "Compare two bufers" t)
 265   (autoload 'ebuffers "ediff" "Compare two bufers" t)
 266   (autoload 'ediff3  "ediff"  "Compare three files" t)
 267   (autoload 'ediff-files3 "ediff" "Compare three files" t)
 268   (autoload 'ediff-buffers3 "ediff" "Compare three bufers" t)
 269   (autoload 'ebuffers3 "ediff" "Compare three bufers" t)
 270
 271   (autoload 'erevision "ediff" "Compare versions of a file" t)
 272   (autoload 'ediff-revision "ediff" "Compare versions of a file" t)
 273
 274   ;; compare regions and windows
 275   (autoload 'ediff-windows-wordwise
 276     "ediff" "Compare two windows word-by-word." t)
 277   (autoload 'ediff-regions-wordwise
 278     "ediff" "Compare two regions word-by-word." t)
 279   (autoload 'ediff-windows-linewise
 280     "ediff" "Compare two windows line-by-line." t)
 281   (autoload 'ediff-regions-linewise
 282     "ediff" "Compare two regions line-by-line." t)
 283
 284   ;; patch
 285   (autoload 'ediff-patch-file "ediff" "Patch a file." t)
 286   (autoload 'epatch "ediff" "Patch a file." t)
 287   (autoload 'ediff-patch-buffer "ediff" "Patch a buffer.")
 288   (autoload 'epatch-buffer "ediff" "Patch a buffer." t)
 289
 290   ;; merge
 291   (autoload 'ediff-merge "ediff" "Merge two files." t)
 292   (autoload 'ediff-merge-files "ediff" "Merge two files." t)
 293   (autoload 'ediff-merge-files-with-ancestor
 294     "ediff" "Merge two files using a third file as an ancestor." t)
 295   (autoload 'ediff-merge-buffers "ediff" "Merge two buffers." t)
 296   (autoload 'ediff-merge-buffers-with-ancestor
 297     "ediff" "Merge two buffers using a third buffer as an ancestor." t)
 298
 299   (autoload 'ediff-merge-revisions "ediff" "Merge two versions of a file." t)
 300   (autoload 'ediff-merge-revisions-with-ancestor
 301     "ediff" "Merge two versions of a file." t)
 302
 303   ;; compare directories
 304   (autoload 'edirs "ediff" "Compare files in two directories." t)
 305   (autoload 'ediff-directories "ediff" "Compare files in two directories." t)
 306   (autoload 'edirs3 "ediff" "Compare files in three directories." t)
 307   (autoload
 308     'ediff-directories3 "ediff" "Compare files in three directories." t)
 309
 310   (autoload 'edir-revisions
 311     "ediff" "Compare two versions of a file." t)
 312   (autoload 'ediff-directory-revisions
 313     "ediff" "Compare two versions of a file." t)
 314
 315   ;; merge directories
 316   (autoload 'edirs-merge "ediff" "Merge files in two directories." t)
 317   (autoload 'ediff-merge-directories
 318     "ediff" "Merge files in two directories." t)
 319   (autoload 'edirs-merge-with-ancestor
 320     "ediff"
 321     "Merge files in two directories using files in a third dir as ancestors."
 322     t)
 323   (autoload 'ediff-merge-directories-with-ancestor
 324     "ediff"
 325     "Merge files in two directories using files in a third dir as ancestors."
 326     t)
 327
 328   (autoload 'edir-merge-revisions
 329     "ediff" "Merge versions of files in a directory." t)
 330   (autoload 'ediff-merge-directory-revisions
 331     "ediff" "Merge versions of files in a directory." t)
 332   (autoload 'ediff-merge-directory-revisions-with-ancestor
 333     "ediff"
 334     "Merge versions of files in a directory using other versions as ancestors."
 335     t)
 336   (autoload 'edir-merge-revisions-with-ancestor
 337     "ediff"
 338     "Merge versions of files in a directory using other versions as ancestors."
 339     t)
 340
 341   ;; misc
 342   (autoload 'ediff-show-registry
 343     "ediff-mult"
 344     "Display the registry of active Ediff sessions."
 345     t)
 346   (autoload 'eregistry
 347     "ediff-mult"
 348     "Display the registry of active Ediff sessions."
 349     t)
 350   (autoload 'ediff-documentation
 351     "ediff"
 352     "Display Ediff's manual."
 353     t)
 354   (autoload 'ediff-version
 355     "ediff"
 356     "Show Ediff's version and last modification date."
 357     t)
 358   (autoload 'ediff-toggle-multiframe
 359     "ediff-util"
 360     "Toggle the use of separate frame for Ediff control buffer."
 361     t)
 362   (autoload 'ediff-toggle-use-toolbar
 363     "ediff-util"
 364     "Toggle the use of Ediff toolbar."
 365     t)
 366
 367   ) ; if purify-flag
 368
 369
 370 (provide 'ediff-hook)
 371
 372 ;;; ediff-hook.el ends here