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 is used to avoid compilation warnings. When emacs/xemacs forms can
  51 ;; generate compile time warnings, we use this macro.
  52 ;; In this case, the macro will expand into the form that is appropriate to the
  53 ;; compiler at hand.
  54 ;; Suggested by rms.
  55 (defmacro ediff-cond-compile-for-xemacs-or-emacs (xemacs-form emacs-form)
  56   (if (string-match "XEmacs" emacs-version)
  57       xemacs-form emacs-form))
  58
  59 ;; Note we wrap this in a progn so that we pick up the whole def
  60 ;; for auto-autoload. That way we do not load ediff-hook.el when defining
  61 ;; the menus.
  62 ;;;###autoload
  63 (progn
  64   (ediff-cond-compile-for-xemacs-or-emacs
  65    ;; xemacs form
  66    (defun ediff-xemacs-init-menus ()
  67      (if (featurep 'menubar)
  68          (progn
  69            (add-submenu
  70             '("Tools") ediff-menu "OO-Browser...")
  71            (add-submenu
  72             '("Tools") ediff-merge-menu "OO-Browser...")
  73            (add-submenu
  74             '("Tools") epatch-menu "OO-Browser...")
  75            (add-submenu
  76             '("Tools") ediff-misc-menu "OO-Browser...")
  77            (add-menu-button
  78             '("Tools") "-------" "OO-Browser...")
  79            )))
  80    nil ; emacs form
  81    ))
  82
  83
  84 ;;;###autoload
  85 (ediff-cond-compile-for-xemacs-or-emacs
  86  (progn
  87    (defvar ediff-menu
  88      '("Compare"
  89        ["Two Files..."  ediff-files t]
  90        ["Two Buffers..." ediff-buffers t]
  91        ["Three Files..."  ediff-files3 t]
  92        ["Three Buffers..." ediff-buffers3 t]
  93        "---"
  94        ["Two Directories..." ediff-directories t]
  95        ["Three Directories..." ediff-directories3 t]
  96        "---"
  97        ["File with Revision..."  ediff-revision t]
  98        ["Directory Revisions..."  ediff-directory-revisions t]
  99        "---"
 100        ["Windows Word-by-word..." ediff-windows-wordwise t]
 101        ["Windows Line-by-line..." ediff-windows-linewise t]
 102        "---"
 103        ["Regions Word-by-word..." ediff-regions-wordwise t]
 104        ["Regions Line-by-line..." ediff-regions-linewise t]
 105        ))
 106    (defvar ediff-merge-menu
 107      '("Merge"
 108        ["Files..."  ediff-merge-files t]
 109        ["Files with Ancestor..." ediff-merge-files-with-ancestor t]
 110        ["Buffers..."  ediff-merge-buffers t]
 111        ["Buffers with Ancestor..."
 112         ediff-merge-buffers-with-ancestor t]
 113        "---"
 114        ["Directories..."  ediff-merge-directories t]
 115        ["Directories with Ancestor..."
 116         ediff-merge-directories-with-ancestor t]
 117        "---"
 118        ["Revisions..."  ediff-merge-revisions t]
 119        ["Revisions with Ancestor..."
 120         ediff-merge-revisions-with-ancestor t]
 121        ["Directory Revisions..." ediff-merge-directory-revisions t]
 122        ["Directory Revisions with Ancestor..."
 123         ediff-merge-directory-revisions-with-ancestor t]
 124        ))
 125    (defvar epatch-menu
 126      '("Apply Patch"
 127        ["To a file..."  ediff-patch-file t]
 128        ["To a buffer..." ediff-patch-buffer t]
 129        ))
 130    (defvar ediff-misc-menu
 131      '("Ediff Miscellanea"
 132        ["Ediff Manual..." ediff-documentation t]
 133        ["Customize Ediff..." ediff-customize t]
 134        ["List Ediff Sessions..." ediff-show-registry t]
 135        ["Use separate frame for Ediff control buffer..."
 136         ediff-toggle-multiframe
 137         :style toggle
 138         :selected (if (and (featurep 'ediff-util)
 139                            (boundp 'ediff-window-setup-function))
 140                       (eq ediff-window-setup-function
 141                           'ediff-setup-windows-multiframe))]
 142        ["Use a toolbar with Ediff control buffer"
 143         ediff-toggle-use-toolbar
 144         :style toggle
 145         :selected (if (featurep 'ediff-tbar)
 146                       (ediff-use-toolbar-p))]
 147        ))
 148
 149    ;; put these menus before Object-Oriented-Browser in Tools menu
 150    (if (and (featurep 'menubar) (not (featurep 'infodock))
 151             (not (featurep 'ediff-hook)))
 152            (ediff-xemacs-init-menus)))
 153
 154  ;; Emacs--only if menu-bar is loaded
 155  (if (featurep 'menu-bar)
 156      (progn
 157        ;; initialize menu bar keymaps
 158        (defvar menu-bar-ediff-misc-menu
 159          (make-sparse-keymap "Ediff Miscellanea"))
 160        (fset 'menu-bar-ediff-misc-menu
 161              (symbol-value 'menu-bar-ediff-misc-menu))
 162        (defvar menu-bar-epatch-menu (make-sparse-keymap "Apply Patch"))
 163        (fset 'menu-bar-epatch-menu (symbol-value 'menu-bar-epatch-menu))
 164        (defvar menu-bar-ediff-merge-menu (make-sparse-keymap "Merge"))
 165        (fset 'menu-bar-ediff-merge-menu
 166              (symbol-value 'menu-bar-ediff-merge-menu))
 167        (defvar menu-bar-ediff-menu (make-sparse-keymap "Compare"))
 168        (fset 'menu-bar-ediff-menu (symbol-value 'menu-bar-ediff-menu))
 169
 170        ;; define ediff-menu
 171        (define-key menu-bar-ediff-menu [window]
 172          '("This Window and Next Window" . compare-windows))
 173        (define-key menu-bar-ediff-menu [ediff-windows-linewise]
 174          '("Windows Line-by-line..." . ediff-windows-linewise))
 175        (define-key menu-bar-ediff-menu [ediff-windows-wordwise]
 176          '("Windows Word-by-word..." . ediff-windows-wordwise))
 177        (define-key menu-bar-ediff-menu [separator-ediff-windows] '("--"))
 178        (define-key menu-bar-ediff-menu [ediff-regions-linewise]
 179          '("Regions Line-by-line..." . ediff-regions-linewise))
 180        (define-key menu-bar-ediff-menu [ediff-regions-wordwise]
 181          '("Regions Word-by-word..." . ediff-regions-wordwise))
 182        (define-key menu-bar-ediff-menu [separator-ediff-regions] '("--"))
 183        (define-key menu-bar-ediff-menu [ediff-dir-revision]
 184          '("Directory Revisions..." . ediff-directory-revisions))
 185        (define-key menu-bar-ediff-menu [ediff-revision]
 186          '("File with Revision..." . ediff-revision))
 187        (define-key menu-bar-ediff-menu [separator-ediff-directories] '("--"))
 188        (define-key menu-bar-ediff-menu [ediff-directories3]
 189          '("Three Directories..." . ediff-directories3))
 190        (define-key menu-bar-ediff-menu [ediff-directories]
 191          '("Two Directories..." . ediff-directories))
 192        (define-key menu-bar-ediff-menu [separator-ediff-files] '("--"))
 193        (define-key menu-bar-ediff-menu [ediff-buffers3]
 194          '("Three Buffers..." . ediff-buffers3))
 195        (define-key menu-bar-ediff-menu [ediff-files3]
 196          '("Three Files..." . ediff-files3))
 197        (define-key menu-bar-ediff-menu [ediff-buffers]
 198          '("Two Buffers..." . ediff-buffers))
 199        (define-key menu-bar-ediff-menu [ediff-files]
 200          '("Two Files..." . ediff-files))
 201
 202        ;; define merge menu
 203        (define-key
 204          menu-bar-ediff-merge-menu [ediff-merge-dir-revisions-with-ancestor]
 205          '("Directory Revisions with Ancestor..."
 206            . ediff-merge-directory-revisions-with-ancestor))
 207        (define-key
 208          menu-bar-ediff-merge-menu [ediff-merge-dir-revisions]
 209          '("Directory Revisions..." . ediff-merge-directory-revisions))
 210        (define-key
 211          menu-bar-ediff-merge-menu [ediff-merge-revisions-with-ancestor]
 212          '("Revisions with Ancestor..."
 213            . ediff-merge-revisions-with-ancestor))
 214        (define-key menu-bar-ediff-merge-menu [ediff-merge-revisions]
 215          '("Revisions..." . ediff-merge-revisions))
 216        (define-key menu-bar-ediff-merge-menu [separator-ediff-merge] '("--"))
 217        (define-key
 218          menu-bar-ediff-merge-menu [ediff-merge-directories-with-ancestor]
 219          '("Directories with Ancestor..."
 220            . ediff-merge-directories-with-ancestor))
 221        (define-key menu-bar-ediff-merge-menu [ediff-merge-directories]
 222          '("Directories..." . ediff-merge-directories))
 223        (define-key
 224          menu-bar-ediff-merge-menu [separator-ediff-merge-dirs] '("--"))
 225        (define-key
 226          menu-bar-ediff-merge-menu [ediff-merge-buffers-with-ancestor]
 227          '("Buffers with Ancestor..." . ediff-merge-buffers-with-ancestor))
 228        (define-key menu-bar-ediff-merge-menu [ediff-merge-buffers]
 229          '("Buffers..." . ediff-merge-buffers))
 230        (define-key menu-bar-ediff-merge-menu [ediff-merge-files-with-ancestor]
 231          '("Files with Ancestor..." . ediff-merge-files-with-ancestor))
 232        (define-key menu-bar-ediff-merge-menu [ediff-merge-files]
 233          '("Files..." . ediff-merge-files))
 234
 235        ;; define epatch menu
 236        (define-key menu-bar-epatch-menu [ediff-patch-buffer]
 237          '("To a Buffer..." . ediff-patch-buffer))
 238        (define-key menu-bar-epatch-menu [ediff-patch-file]
 239          '("To a File..." . ediff-patch-file))
 240
 241        ;; define ediff miscellanea
 242        (define-key menu-bar-ediff-misc-menu [emultiframe]
 243          '("Toggle use of separate control buffer frame..."
 244            . ediff-toggle-multiframe))
 245        (define-key menu-bar-ediff-misc-menu [eregistry]
 246          '("List Ediff Sessions..." . ediff-show-registry))
 247        (define-key menu-bar-ediff-misc-menu [ediff-cust]
 248          '("Customize Ediff..." . ediff-customize))
 249        (define-key menu-bar-ediff-misc-menu [ediff-doc]
 250          '("Ediff Manual..." . ediff-documentation))
 251        )
 252
 253       ) ; emacs case
 254  ) ; ediff-cond-compile-for-xemacs-or-emacs
 255
 256 ;; arrange for autoloads
 257 (if purify-flag
 258     () ; if dumping, autoloads are set up in loaddefs.el
 259   ;; if the user decides to load this file, set up autoloads
 260   ;; compare files and buffers
 261   (autoload 'ediff "ediff" "Compare two files" t)
 262   (autoload 'ediff-files "ediff" "Compare two files" t)
 263   (autoload 'ediff-buffers "ediff" "Compare two bufers" t)
 264   (autoload 'ebuffers "ediff" "Compare two bufers" t)
 265   (autoload 'ediff3  "ediff"  "Compare three files" t)
 266   (autoload 'ediff-files3 "ediff" "Compare three files" t)
 267   (autoload 'ediff-buffers3 "ediff" "Compare three bufers" t)
 268   (autoload 'ebuffers3 "ediff" "Compare three bufers" t)
 269
 270   (autoload 'erevision "ediff" "Compare versions of a file" t)
 271   (autoload 'ediff-revision "ediff" "Compare versions of a file" t)
 272
 273   ;; compare regions and windows
 274   (autoload 'ediff-windows-wordwise
 275     "ediff" "Compare two windows word-by-word." t)
 276   (autoload 'ediff-regions-wordwise
 277     "ediff" "Compare two regions word-by-word." t)
 278   (autoload 'ediff-windows-linewise
 279     "ediff" "Compare two windows line-by-line." t)
 280   (autoload 'ediff-regions-linewise
 281     "ediff" "Compare two regions line-by-line." t)
 282
 283   ;; patch
 284   (autoload 'ediff-patch-file "ediff" "Patch a file." t)
 285   (autoload 'epatch "ediff" "Patch a file." t)
 286   (autoload 'ediff-patch-buffer "ediff" "Patch a buffer.")
 287   (autoload 'epatch-buffer "ediff" "Patch a buffer." t)
 288
 289   ;; merge
 290   (autoload 'ediff-merge "ediff" "Merge two files." t)
 291   (autoload 'ediff-merge-files "ediff" "Merge two files." t)
 292   (autoload 'ediff-merge-files-with-ancestor
 293     "ediff" "Merge two files using a third file as an ancestor." t)
 294   (autoload 'ediff-merge-buffers "ediff" "Merge two buffers." t)
 295   (autoload 'ediff-merge-buffers-with-ancestor
 296     "ediff" "Merge two buffers using a third buffer as an ancestor." t)
 297
 298   (autoload 'ediff-merge-revisions "ediff" "Merge two versions of a file." t)
 299   (autoload 'ediff-merge-revisions-with-ancestor
 300     "ediff" "Merge two versions of a file." t)
 301
 302   ;; compare directories
 303   (autoload 'edirs "ediff" "Compare files in two directories." t)
 304   (autoload 'ediff-directories "ediff" "Compare files in two directories." t)
 305   (autoload 'edirs3 "ediff" "Compare files in three directories." t)
 306   (autoload
 307     'ediff-directories3 "ediff" "Compare files in three directories." t)
 308
 309   (autoload 'edir-revisions
 310     "ediff" "Compare two versions of a file." t)
 311   (autoload 'ediff-directory-revisions
 312     "ediff" "Compare two versions of a file." t)
 313
 314   ;; merge directories
 315   (autoload 'edirs-merge "ediff" "Merge files in two directories." t)
 316   (autoload 'ediff-merge-directories
 317     "ediff" "Merge files in two directories." t)
 318   (autoload 'edirs-merge-with-ancestor
 319     "ediff"
 320     "Merge files in two directories using files in a third dir as ancestors."
 321     t)
 322   (autoload 'ediff-merge-directories-with-ancestor
 323     "ediff"
 324     "Merge files in two directories using files in a third dir as ancestors."
 325     t)
 326
 327   (autoload 'edir-merge-revisions
 328     "ediff" "Merge versions of files in a directory." t)
 329   (autoload 'ediff-merge-directory-revisions
 330     "ediff" "Merge versions of files in a directory." t)
 331   (autoload 'ediff-merge-directory-revisions-with-ancestor
 332     "ediff"
 333     "Merge versions of files in a directory using other versions as ancestors."
 334     t)
 335   (autoload 'edir-merge-revisions-with-ancestor
 336     "ediff"
 337     "Merge versions of files in a directory using other versions as ancestors."
 338     t)
 339
 340   ;; misc
 341   (autoload 'ediff-show-registry
 342     "ediff-mult"
 343     "Display the registry of active Ediff sessions."
 344     t)
 345   (autoload 'eregistry
 346     "ediff-mult"
 347     "Display the registry of active Ediff sessions."
 348     t)
 349   (autoload 'ediff-documentation
 350     "ediff"
 351     "Display Ediff's manual."
 352     t)
 353   (autoload 'ediff-version
 354     "ediff"
 355     "Show Ediff's version and last modification date."
 356     t)
 357   (autoload 'ediff-toggle-multiframe
 358     "ediff-util"
 359     "Toggle the use of separate frame for Ediff control buffer."
 360     t)
 361   (autoload 'ediff-toggle-use-toolbar
 362     "ediff-util"
 363     "Toggle the use of Ediff toolbar."
 364     t)
 365
 366   ) ; if purify-flag
 367
 368
 369 (provide 'ediff-hook)
 370
 371 ;;; ediff-hook.el ends here