lisp/vc/ediff-hook.el

   1 ;;; ediff-hook.el --- setup for Ediff's menus and autoloads
   2
   3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5
   6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
   7 ;; Package: ediff
   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 3 of the License, or
  14 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  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 (defvar ediff-window-setup-function)
  48
  49 ;; This autoload is useless in Emacs because ediff-hook.el is dumped with
  50 ;; emacs, but it is needed in XEmacs
  51 ;;;###autoload
  52 (if (featurep 'xemacs)
  53     (progn
  54       (defun ediff-xemacs-init-menus ()
  55         (when (featurep 'menubar)
  56           (add-submenu
  57            '("Tools") ediff-menu "OO-Browser...")
  58           (add-submenu
  59            '("Tools") ediff-merge-menu "OO-Browser...")
  60           (add-submenu
  61            '("Tools") epatch-menu "OO-Browser...")
  62           (add-submenu
  63            '("Tools") ediff-misc-menu "OO-Browser...")
  64           (add-menu-button
  65            '("Tools") "-------" "OO-Browser...")
  66           ))
  67       (defvar ediff-menu
  68         '("Compare"
  69           ["Two Files..."  ediff-files t]
  70           ["Two Buffers..." ediff-buffers t]
  71           ["Three Files..."  ediff-files3 t]
  72           ["Three Buffers..." ediff-buffers3 t]
  73           "---"
  74           ["Two Directories..." ediff-directories t]
  75           ["Three Directories..." ediff-directories3 t]
  76           "---"
  77           ["File with Revision..."  ediff-revision t]
  78           ["Directory Revisions..."  ediff-directory-revisions t]
  79           "---"
  80           ["Windows Word-by-word..." ediff-windows-wordwise t]
  81           ["Windows Line-by-line..." ediff-windows-linewise t]
  82           "---"
  83           ["Regions Word-by-word..." ediff-regions-wordwise t]
  84           ["Regions Line-by-line..." ediff-regions-linewise t]
  85           ))
  86       (defvar ediff-merge-menu
  87         '("Merge"
  88           ["Files..."  ediff-merge-files t]
  89           ["Files with Ancestor..." ediff-merge-files-with-ancestor t]
  90           ["Buffers..."  ediff-merge-buffers t]
  91           ["Buffers with Ancestor..."
  92            ediff-merge-buffers-with-ancestor t]
  93           "---"
  94           ["Directories..."  ediff-merge-directories t]
  95           ["Directories with Ancestor..."
  96            ediff-merge-directories-with-ancestor t]
  97           "---"
  98           ["Revisions..."  ediff-merge-revisions t]
  99           ["Revisions with Ancestor..."
 100            ediff-merge-revisions-with-ancestor t]
 101           ["Directory Revisions..." ediff-merge-directory-revisions t]
 102           ["Directory Revisions with Ancestor..."
 103            ediff-merge-directory-revisions-with-ancestor t]
 104           ))
 105       (defvar epatch-menu
 106         '("Apply Patch"
 107           ["To a file..."  ediff-patch-file t]
 108           ["To a buffer..." ediff-patch-buffer t]
 109           ))
 110       (defvar ediff-misc-menu
 111         '("Ediff Miscellanea"
 112           ["Ediff Manual" ediff-documentation t]
 113           ["Customize Ediff" ediff-customize t]
 114           ["List Ediff Sessions" ediff-show-registry t]
 115           ["Use separate frame for Ediff control buffer"
 116            ediff-toggle-multiframe
 117            :style toggle
 118            :selected (if (and (featurep 'ediff-util)
 119                               (boundp 'ediff-window-setup-function))
 120                          (eq ediff-window-setup-function
 121                              'ediff-setup-windows-multiframe))]
 122           ["Use a toolbar with Ediff control buffer"
 123            ediff-toggle-use-toolbar
 124            :style toggle
 125            :selected (if (featurep 'ediff-tbar)
 126                          (ediff-use-toolbar-p))]))
 127
 128       ;; put these menus before Object-Oriented-Browser in Tools menu
 129       (if (and (featurep 'menubar) (not (featurep 'infodock))
 130                (not (featurep 'ediff-hook)))
 131           (ediff-xemacs-init-menus)))
 132   ;; Emacs
 133   ;; initialize menu bar keymaps
 134   (defvar menu-bar-ediff-misc-menu
 135     (make-sparse-keymap "Ediff Miscellanea"))
 136   (fset 'menu-bar-ediff-misc-menu
 137         (symbol-value 'menu-bar-ediff-misc-menu))
 138   (defvar menu-bar-epatch-menu (make-sparse-keymap "Apply Patch"))
 139   (fset 'menu-bar-epatch-menu (symbol-value 'menu-bar-epatch-menu))
 140   (defvar menu-bar-ediff-merge-menu (make-sparse-keymap "Merge"))
 141   (fset 'menu-bar-ediff-merge-menu
 142         (symbol-value 'menu-bar-ediff-merge-menu))
 143   (defvar menu-bar-ediff-menu (make-sparse-keymap "Compare"))
 144   (fset 'menu-bar-ediff-menu (symbol-value 'menu-bar-ediff-menu))
 145
 146   ;; define ediff compare menu
 147   (define-key menu-bar-ediff-menu [ediff-misc]
 148     `(menu-item ,(purecopy "Ediff Miscellanea") menu-bar-ediff-misc-menu))
 149   (define-key menu-bar-ediff-menu [separator-ediff-misc] menu-bar-separator)
 150   (define-key menu-bar-ediff-menu [window]
 151     `(menu-item ,(purecopy "This Window and Next Window") compare-windows
 152                 :help ,(purecopy "Compare the current window and the next window")))
 153   (define-key menu-bar-ediff-menu [ediff-windows-linewise]
 154     `(menu-item ,(purecopy "Windows Line-by-line...") ediff-windows-linewise
 155                 :help ,(purecopy "Compare windows line-wise")))
 156   (define-key menu-bar-ediff-menu [ediff-windows-wordwise]
 157     `(menu-item ,(purecopy "Windows Word-by-word...") ediff-windows-wordwise
 158                 :help ,(purecopy "Compare windows word-wise")))
 159   (define-key menu-bar-ediff-menu [separator-ediff-windows] menu-bar-separator)
 160   (define-key menu-bar-ediff-menu [ediff-regions-linewise]
 161     `(menu-item ,(purecopy "Regions Line-by-line...") ediff-regions-linewise
 162                 :help ,(purecopy "Compare regions line-wise")))
 163   (define-key menu-bar-ediff-menu [ediff-regions-wordwise]
 164     `(menu-item ,(purecopy "Regions Word-by-word...") ediff-regions-wordwise
 165                 :help ,(purecopy "Compare regions word-wise")))
 166   (define-key menu-bar-ediff-menu [separator-ediff-regions] menu-bar-separator)
 167   (define-key menu-bar-ediff-menu [ediff-dir-revision]
 168     `(menu-item ,(purecopy "Directory Revisions...") ediff-directory-revisions
 169                 :help ,(purecopy "Compare directory files with their older versions")))
 170   (define-key menu-bar-ediff-menu [ediff-revision]
 171     `(menu-item ,(purecopy "File with Revision...") ediff-revision
 172                 :help ,(purecopy "Compare file with its older versions")))
 173   (define-key menu-bar-ediff-menu [separator-ediff-directories] menu-bar-separator)
 174   (define-key menu-bar-ediff-menu [ediff-directories3]
 175     `(menu-item ,(purecopy "Three Directories...") ediff-directories3
 176                 :help ,(purecopy "Compare files common to three directories simultaneously")))
 177   (define-key menu-bar-ediff-menu [ediff-directories]
 178     `(menu-item ,(purecopy "Two Directories...") ediff-directories
 179                 :help ,(purecopy "Compare files common to two directories simultaneously")))
 180   (define-key menu-bar-ediff-menu [separator-ediff-files] menu-bar-separator)
 181   (define-key menu-bar-ediff-menu [ediff-buffers3]
 182     `(menu-item ,(purecopy "Three Buffers...") ediff-buffers3
 183                 :help ,(purecopy "Compare three buffers simultaneously")))
 184   (define-key menu-bar-ediff-menu [ediff-files3]
 185     `(menu-item ,(purecopy "Three Files...") ediff-files3
 186                 :help ,(purecopy "Compare three files simultaneously")))
 187   (define-key menu-bar-ediff-menu [ediff-buffers]
 188     `(menu-item ,(purecopy "Two Buffers...") ediff-buffers
 189                 :help ,(purecopy "Compare two buffers simultaneously")))
 190   (define-key menu-bar-ediff-menu [ediff-files]
 191     `(menu-item ,(purecopy "Two Files...") ediff-files
 192                 :help ,(purecopy "Compare two files simultaneously")))
 193
 194   ;; define ediff merge menu
 195   (define-key
 196     menu-bar-ediff-merge-menu [ediff-merge-dir-revisions-with-ancestor]
 197     `(menu-item ,(purecopy "Directory Revisions with Ancestor...")
 198       ediff-merge-directory-revisions-with-ancestor
 199       :help ,(purecopy "Merge versions of the files in the same directory by comparing the files with common ancestors")))
 200   (define-key
 201     menu-bar-ediff-merge-menu [ediff-merge-dir-revisions]
 202     `(menu-item ,(purecopy "Directory Revisions...") ediff-merge-directory-revisions
 203       :help ,(purecopy "Merge versions of the files in the same directory (without using ancestor information)")))
 204   (define-key
 205     menu-bar-ediff-merge-menu [ediff-merge-revisions-with-ancestor]
 206     `(menu-item ,(purecopy "Revisions with Ancestor...")
 207       ediff-merge-revisions-with-ancestor
 208       :help ,(purecopy "Merge versions of the same file by comparing them with a common ancestor")))
 209   (define-key menu-bar-ediff-merge-menu [ediff-merge-revisions]
 210     `(menu-item ,(purecopy "Revisions...") ediff-merge-revisions
 211       :help ,(purecopy "Merge versions of the same file (without using ancestor information)")))
 212   (define-key menu-bar-ediff-merge-menu [separator-ediff-merge] menu-bar-separator)
 213   (define-key
 214     menu-bar-ediff-merge-menu [ediff-merge-directories-with-ancestor]
 215     `(menu-item ,(purecopy "Directories with Ancestor...")
 216       ediff-merge-directories-with-ancestor
 217       :help ,(purecopy "Merge files common to a pair of directories by comparing the files with common ancestors")))
 218   (define-key menu-bar-ediff-merge-menu [ediff-merge-directories]
 219     `(menu-item ,(purecopy "Directories...") ediff-merge-directories
 220                 :help ,(purecopy "Merge files common to a pair of directories")))
 221   (define-key
 222     menu-bar-ediff-merge-menu [separator-ediff-merge-dirs] menu-bar-separator)
 223   (define-key
 224     menu-bar-ediff-merge-menu [ediff-merge-buffers-with-ancestor]
 225     `(menu-item ,(purecopy "Buffers with Ancestor...") ediff-merge-buffers-with-ancestor
 226       :help ,(purecopy "Merge buffers by comparing their contents with a common ancestor")))
 227   (define-key menu-bar-ediff-merge-menu [ediff-merge-buffers]
 228     `(menu-item ,(purecopy "Buffers...") ediff-merge-buffers
 229       :help ,(purecopy "Merge buffers (without using ancestor information)")))
 230   (define-key menu-bar-ediff-merge-menu [ediff-merge-files-with-ancestor]
 231     `(menu-item ,(purecopy "Files with Ancestor...") ediff-merge-files-with-ancestor
 232       :help ,(purecopy "Merge files by comparing them with a common ancestor")))
 233   (define-key menu-bar-ediff-merge-menu [ediff-merge-files]
 234     `(menu-item ,(purecopy "Files...") ediff-merge-files
 235       :help ,(purecopy "Merge files (without using ancestor information)")))
 236
 237   ;; define epatch menu
 238   (define-key menu-bar-epatch-menu [ediff-patch-buffer]
 239     `(menu-item ,(purecopy "To a Buffer...") ediff-patch-buffer
 240       :help ,(purecopy "Apply a patch to the contents of a buffer")))
 241   (define-key menu-bar-epatch-menu [ediff-patch-file]
 242     `(menu-item ,(purecopy "To a File...") ediff-patch-file
 243       :help ,(purecopy "Apply a patch to a file")))
 244
 245   ;; define ediff miscellanea
 246   (define-key menu-bar-ediff-misc-menu [emultiframe]
 247     `(menu-item ,(purecopy "Use separate control buffer frame")
 248       ediff-toggle-multiframe
 249       :help ,(purecopy "Switch between the single-frame presentation mode and the multi-frame mode")))
 250   (define-key menu-bar-ediff-misc-menu [eregistry]
 251     `(menu-item ,(purecopy "List Ediff Sessions") ediff-show-registry
 252                 :help ,(purecopy "List all active Ediff sessions; it is a convenient way to find and resume such a session")))
 253   (define-key menu-bar-ediff-misc-menu [ediff-cust]
 254     `(menu-item ,(purecopy "Customize Ediff") ediff-customize
 255                 :help ,(purecopy "Change some of the parameters that govern the behavior of Ediff")))
 256   (define-key menu-bar-ediff-misc-menu [ediff-doc]
 257     `(menu-item ,(purecopy "Ediff Manual") ediff-documentation
 258                 :help ,(purecopy "Bring up the Ediff manual"))))
 259
 260 (provide 'ediff-hook)
 261
 262
 263 ;; arch-tag: 512f8656-8a4b-4789-af5d-5c6144498df3
 264 ;;; ediff-hook.el ends here