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