lisp/ediff-help.el

   1 ;;; ediff-help.el --- Code related to the contents of Ediff help buffers
   2
   3 ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
   4
   5 ;; Author: Michael Kifer <kifer@cs.sunysb.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 ;;; Code:
  25
  26 (provide 'ediff-help)
  27
  28 ;; Compiler pacifier start
  29 (defvar ediff-multiframe)
  30
  31 (eval-when-compile
  32   (let ((load-path (cons (expand-file-name ".") load-path)))
  33     (or (featurep 'ediff-init)
  34         (load "ediff-init.el" nil nil 'nosuffix))
  35     ))
  36 ;; end pacifier
  37
  38 (require 'ediff-init)
  39
  40 ;; Help messages
  41
  42 (defconst ediff-long-help-message-head
  43   "    Move around      |      Toggle features      |        Manipulate
  44 =====================|===========================|============================="
  45   "The head of the full help message.")
  46 (defconst ediff-long-help-message-tail
  47   "=====================|===========================|=============================
  48     R -show registry |     = -compare regions    |  M   -show session group
  49     D -diff output   |     E -browse Ediff manual|  G   -send bug report
  50     i -status info   |     ? -help off           |  z/q -suspend/quit
  51 -------------------------------------------------------------------------------
  52 For help on a specific command:  Click Button 2 over it; or
  53                                  Put the cursor over it and type RET."
  54   "The tail of the full-help message.")
  55
  56 (defconst ediff-long-help-message-compare3
  57   "
  58 p,DEL -previous diff |     | -vert/horiz split   | xy -copy buf X's region to Y
  59 n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
  60     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
  61    gx -goto X's point|                           |  ! -update diff regions
  62   C-l -recenter      |    ## -ignore whitespace  |
  63   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  64   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
  65     ~ -rotate buffers|     m -wide display       |
  66 "
  67   "Help message usually used for 3-way comparison.
  68 Normally, not a user option. See `ediff-help-message' for details.")
  69
  70 (defconst ediff-long-help-message-compare2
  71   "
  72 p,DEL -previous diff |     | -vert/horiz split   |a/b -copy A/B's region to B/A
  73 n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
  74     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
  75    gx -goto X's point|                           |  ! -update diff regions
  76   C-l -recenter      |    ## -ignore whitespace  |
  77   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  78   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
  79     ~ -swap variants |     m -wide display       |
  80 "
  81   "Help message usually used for 2-way comparison.
  82 Normally, not a user option. See `ediff-help-message' for details.")
  83
  84 (defconst ediff-long-help-message-narrow2
  85   "
  86 p,DEL -previous diff |     | -vert/horiz split   |a/b -copy A/B's region to B/A
  87 n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
  88     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
  89    gx -goto X's point|     % -narrow/widen buffs |  ! -update diff regions
  90   C-l -recenter      |    ## -ignore whitespace  |
  91   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  92   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
  93     ~ -swap variants |     m -wide display       |
  94 "
  95   "Help message when comparing windows or regions line-by-line.
  96 Normally, not a user option. See `ediff-help-message' for details.")
  97
  98 (defconst ediff-long-help-message-word-mode
  99   "
 100 p,DEL -previous diff |     | -vert/horiz split   | xy -copy buf X's region to Y
 101 n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
 102     j -jump to diff  |                           |
 103    gx -goto X's point|     % -narrow/widen buffs |  ! -recompute diffs
 104   C-l -recenter      |                           |
 105   v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
 106   </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
 107     ~ -swap variants |     m -wide display       |
 108 "
 109   "Help message when comparing windows or regions word-by-word.
 110 Normally, not a user option. See `ediff-help-message' for details.")
 111
 112 (defconst ediff-long-help-message-merge
 113   "
 114 p,DEL -previous diff |     | -vert/horiz split   |  x -copy buf X's region to C
 115 n,SPC -next diff     |     h -hilighting         |  r -restore buf C's old diff
 116     j -jump to diff  |     @ -auto-refinement    |  * -refine current region
 117    gx -goto X's point|    ## -ignore whitespace  |  ! -update diff regions
 118   C-l -recenter      | #f/#h -focus/hide regions |  + -combine diff regions
 119   v/V -scroll up/dn  |     X -read-only in buf X | wx -save buf X
 120   </> -scroll lt/rt  |     m -wide display       | wd -save diff output
 121     ~ -swap variants |     s -shrink window C    |  / -show ancestor buff
 122                      |     $ -show clashes only  |  & -merge w/new default
 123 "
 124   "Help message during merging.
 125 Normally, not a user option. See `ediff-help-message' for details.")
 126
 127 ;; The actual long help message.
 128 (ediff-defvar-local ediff-long-help-message ""
 129   "Normally, not a user option. See `ediff-help-message' for details.")
 130
 131 (defconst ediff-brief-message-string
 132   "? -quick help "
 133   "Contents of the brief help message.")
 134 ;; The actual brief help message
 135 (ediff-defvar-local ediff-brief-help-message ""
 136   "Normally, not a user option. See `ediff-help-message' for details.")
 137
 138 (ediff-defvar-local ediff-brief-help-message-function nil
 139   "The brief help message that the user can customize.
 140 If the user sets this to a parameter-less function, Ediff will use it to
 141 produce the brief help message. This function must return a string.")
 142 (ediff-defvar-local ediff-long-help-message-function nil
 143   "The long help message that the user can customize.
 144 See `ediff-brief-help-message-function' for more.")
 145
 146 (defvar ediff-use-long-help-message nil
 147   "*If t, Ediff displays a long help message. Short help message otherwise.")
 148
 149 ;; The actual help message.
 150 (ediff-defvar-local ediff-help-message ""
 151   "The actual help message.
 152 Normally, the user shouldn't touch this. However, if you want Ediff to
 153 start up with different help messages for different jobs, you can change
 154 the value of this variable and the variables `ediff-help-message-*' in
 155 `ediff-startup-hook'.")
 156
 157
 158 ;; the keymap that defines clicks over the quick help regions
 159 (defvar ediff-help-region-map (make-sparse-keymap))
 160
 161 (define-key
 162   ediff-help-region-map
 163   (if ediff-emacs-p [mouse-2] [button2])
 164   'ediff-help-for-quick-help)
 165
 166 ;; runs in the control buffer
 167 (defun ediff-set-help-overlays ()
 168   (goto-char (point-min))
 169   (let (overl beg end cmd)
 170     (while (re-search-forward " *\\([^ \t\n|]+\\||\\) +-[^|\n]+" nil 'noerror)
 171       (setq beg (match-beginning 0)
 172             end (match-end 0)
 173             cmd (buffer-substring (match-beginning 1) (match-end 1)))
 174       (setq overl (ediff-make-overlay beg end))
 175       (if ediff-emacs-p
 176           (ediff-overlay-put overl 'mouse-face 'highlight)
 177         (ediff-overlay-put overl 'highlight t))
 178       (ediff-overlay-put overl 'ediff-help-info cmd))))
 179
 180
 181 (defun ediff-help-for-quick-help ()
 182   "Explain Ediff commands in more detail."
 183   (interactive)
 184   (ediff-barf-if-not-control-buffer)
 185   (let ((pos (ediff-event-point last-command-event))
 186         overl cmd)
 187
 188     (if ediff-xemacs-p
 189         (setq overl (extent-at pos (current-buffer) 'ediff-help-info)
 190               cmd   (ediff-overlay-get overl 'ediff-help-info))
 191       (setq cmd (car (mapcar (function (lambda (elt)
 192                                          (overlay-get elt 'ediff-help-info)))
 193                              (overlays-at pos)))))
 194
 195     (if (not (stringp cmd))
 196         (error "Hmm... I don't see an Ediff command around here..."))
 197
 198     (ediff-documentation "Quick Help Commands")
 199
 200     (let (case-fold-search)
 201       (cond ((string= cmd "?") (re-search-forward "^`\\?'"))
 202             ((string= cmd "G") (re-search-forward "^`G'"))
 203             ((string= cmd "E") (re-search-forward "^`E'"))
 204             ((string= cmd "wd") (re-search-forward "^`wd'"))
 205             ((string= cmd "wx") (re-search-forward "^`wa'"))
 206             ((string= cmd "a/b") (re-search-forward "^`a'"))
 207             ((string= cmd "x") (re-search-forward "^`a'"))
 208             ((string= cmd "xy") (re-search-forward "^`ab'"))
 209             ((string= cmd "p,DEL") (re-search-forward "^`p'"))
 210             ((string= cmd "n,SPC") (re-search-forward "^`n'"))
 211             ((string= cmd "j") (re-search-forward "^`j'"))
 212             ((string= cmd "gx") (re-search-forward "^`ga'"))
 213             ((string= cmd "!") (re-search-forward "^`!'"))
 214             ((string= cmd "*") (re-search-forward "^`\\*'"))
 215             ((string= cmd "m") (re-search-forward "^`m'"))
 216             ((string= cmd "|") (re-search-forward "^`|'"))
 217             ((string= cmd "@") (re-search-forward "^`@'"))
 218             ((string= cmd "h") (re-search-forward "^`h'"))
 219             ((string= cmd "r") (re-search-forward "^`r'"))
 220             ((string= cmd "rx") (re-search-forward "^`ra'"))
 221             ((string= cmd "##") (re-search-forward "^`##'"))
 222             ((string= cmd "#f/#h") (re-search-forward "^`#f'"))
 223             ((string= cmd "X") (re-search-forward "^`A'"))
 224             ((string= cmd "v/V") (re-search-forward "^`v'"))
 225             ((string= cmd "</>") (re-search-forward "^`<'"))
 226             ((string= cmd "~") (re-search-forward "^`~'"))
 227             ((string= cmd "i") (re-search-forward "^`i'"))
 228             ((string= cmd "D") (re-search-forward "^`D'"))
 229             ((string= cmd "R") (re-search-forward "^`R'"))
 230             ((string= cmd "M") (re-search-forward "^`M'"))
 231             ((string= cmd "z/q") (re-search-forward "^`z'"))
 232             ((string= cmd "%") (re-search-forward "^`%'"))
 233             ((string= cmd "C-l") (re-search-forward "^`C-l'"))
 234             ((string= cmd "$") (re-search-forward "^`\\$'"))
 235             ((string= cmd "/") (re-search-forward "^`/'"))
 236             ((string= cmd "&") (re-search-forward "^`&'"))
 237             ((string= cmd "s") (re-search-forward "^`s'"))
 238             ((string= cmd "+") (re-search-forward "^`\\+'"))
 239             ((string= cmd "=") (re-search-forward "^`='"))
 240             (t (error "Undocumented command! Type `G' in Ediff Control Panel to drop a note to the Ediff maintainer")))
 241       ) ; let case-fold-search
 242     ))
 243
 244
 245 ;; assuming we are in control window, calculate length of the first line in
 246 ;; help message
 247 (defun ediff-help-message-line-length ()
 248   (save-excursion
 249     (goto-char (point-min))
 250     (if ediff-use-long-help-message
 251         (next-line 1))
 252     (end-of-line)
 253     (current-column)))
 254
 255
 256 (defun ediff-indent-help-message ()
 257   (let* ((shift (/ (max 0 (- (window-width (selected-window))
 258                              (ediff-help-message-line-length)))
 259                    2))
 260          (str (make-string shift ?\ )))
 261     (save-excursion
 262       (goto-char (point-min))
 263       (while (< (point) (point-max))
 264         (insert str)
 265         (beginning-of-line)
 266         (forward-line 1)))))
 267
 268
 269 ;; compose the help message as a string
 270 (defun ediff-set-help-message ()
 271   (setq ediff-long-help-message
 272         (cond ((and ediff-long-help-message-function
 273                     (or (symbolp ediff-long-help-message-function)
 274                         (consp ediff-long-help-message-function)))
 275                (funcall ediff-long-help-message-function))
 276               (ediff-word-mode
 277                (concat ediff-long-help-message-head
 278                        ediff-long-help-message-word-mode
 279                        ediff-long-help-message-tail))
 280               (ediff-narrow-job
 281                (concat ediff-long-help-message-head
 282                        ediff-long-help-message-narrow2
 283                        ediff-long-help-message-tail))
 284               (ediff-merge-job
 285                (concat ediff-long-help-message-head
 286                        ediff-long-help-message-merge
 287                        ediff-long-help-message-tail))
 288               (ediff-diff3-job
 289                (concat ediff-long-help-message-head
 290                        ediff-long-help-message-compare3
 291                        ediff-long-help-message-tail))
 292               (t
 293                (concat ediff-long-help-message-head
 294                        ediff-long-help-message-compare2
 295                        ediff-long-help-message-tail))))
 296   (setq ediff-brief-help-message
 297         (cond ((and ediff-brief-help-message-function
 298                     (or (symbolp ediff-brief-help-message-function)
 299                         (consp ediff-brief-help-message-function)))
 300                (funcall ediff-brief-help-message-function))
 301               ((stringp ediff-brief-help-message-function)
 302                ediff-brief-help-message-function)
 303               ((ediff-multiframe-setup-p) ediff-brief-message-string)
 304               (t ; long brief msg, not multiframe --- put in the middle
 305                ediff-brief-message-string)
 306               ))
 307   (setq ediff-help-message (if ediff-use-long-help-message
 308                                ediff-long-help-message
 309                              ediff-brief-help-message))
 310   (run-hooks 'ediff-display-help-hook))
 311
 312
 313 ;;; ediff-help.el ends here