lisp/ediff-help.el

   1 ;;; ediff-help.el --- Code related to the contents of Ediff help buffers
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
   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 3, 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
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23 ;; Boston, MA 02110-1301, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29
  30 ;; Compiler pacifier start
  31 (defvar ediff-multiframe)
  32
  33 (eval-when-compile
  34   (require 'ediff-init)
  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|    ## -ignore whitespace  |  ! -update diff regions
  62   C-l -recenter      |    #c -ignore case        |
  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|    ## -ignore whitespace  |  ! -update diff regions
  76   C-l -recenter      |    #c -ignore case        |
  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|    ## -ignore whitespace  |  ! -update diff regions
  90   C-l -recenter      |    #c -ignore case        |  % -narrow/widen buffs
  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      |    #c -ignore case        |
 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                      |  $* -skip changed regions |
 124 "
 125   "Help message for merge sessions.
 126 Normally, not a user option.  See `ediff-help-message' for details.")
 127
 128 ;; The actual long help message.
 129 (ediff-defvar-local ediff-long-help-message ""
 130   "Normally, not a user option.  See `ediff-help-message' for details.")
 131
 132 (defconst ediff-brief-message-string
 133   " Type ? for help"
 134   "Contents of the brief help message.")
 135 ;; The actual brief help message
 136 (ediff-defvar-local ediff-brief-help-message ""
 137   "Normally, not a user option.  See `ediff-help-message' for details.")
 138
 139 (ediff-defvar-local ediff-brief-help-message-function nil
 140   "The brief help message that the user can customize.
 141 If the user sets this to a parameter-less function, Ediff will use it to
 142 produce the brief help message.  This function must return a string.")
 143 (ediff-defvar-local ediff-long-help-message-function nil
 144   "The long help message that the user can customize.
 145 See `ediff-brief-help-message-function' for more.")
 146
 147 (defcustom ediff-use-long-help-message nil
 148   "*If t, Ediff displays a long help message.  Short help message otherwise."
 149   :type 'boolean
 150   :group 'ediff-window)
 151
 152 ;; The actual help message.
 153 (ediff-defvar-local ediff-help-message ""
 154   "The actual help message.
 155 Normally, the user shouldn't touch this.  However, if you want Ediff to
 156 start up with different help messages for different jobs, you can change
 157 the value of this variable and the variables `ediff-help-message-*' in
 158 `ediff-startup-hook'.")
 159
 160
 161 ;; the keymap that defines clicks over the quick help regions
 162 (defvar ediff-help-region-map (make-sparse-keymap))
 163
 164 (define-key
 165   ediff-help-region-map
 166   (if (featurep 'emacs) [mouse-2] [button2])
 167   'ediff-help-for-quick-help)
 168
 169 ;; runs in the control buffer
 170 (defun ediff-set-help-overlays ()
 171   (goto-char (point-min))
 172   (let (overl beg end cmd)
 173     (while (re-search-forward " *\\([^ \t\n|]+\\||\\) +-[^|\n]+" nil 'noerror)
 174       (setq beg (match-beginning 0)
 175             end (match-end 0)
 176             cmd (buffer-substring (match-beginning 1) (match-end 1)))
 177       (setq overl (ediff-make-overlay beg end))
 178       (if (featurep 'emacs)
 179           (ediff-overlay-put overl 'mouse-face 'highlight)
 180         (ediff-overlay-put overl 'highlight t))
 181       (ediff-overlay-put overl 'ediff-help-info cmd))))
 182
 183
 184 (defun ediff-help-for-quick-help ()
 185   "Explain Ediff commands in more detail."
 186   (interactive)
 187   (ediff-barf-if-not-control-buffer)
 188   (let ((pos (ediff-event-point last-command-event))
 189         overl cmd)
 190
 191     (if (featurep 'xemacs)
 192         (setq overl (extent-at pos (current-buffer) 'ediff-help-info)
 193               cmd   (ediff-overlay-get overl 'ediff-help-info))
 194       (setq cmd (car (mapcar (lambda (elt)
 195                                (overlay-get elt 'ediff-help-info))
 196                              (overlays-at pos)))))
 197
 198     (if (not (stringp cmd))
 199         (error "Hmm...  I don't see an Ediff command around here..."))
 200
 201     (ediff-documentation "Quick Help Commands")
 202
 203     (let (case-fold-search)
 204       (cond ((string= cmd "?") (re-search-forward "^`\\?'"))
 205             ((string= cmd "G") (re-search-forward "^`G'"))
 206             ((string= cmd "E") (re-search-forward "^`E'"))
 207             ((string= cmd "wd") (re-search-forward "^`wd'"))
 208             ((string= cmd "wx") (re-search-forward "^`wa'"))
 209             ((string= cmd "a/b") (re-search-forward "^`a'"))
 210             ((string= cmd "x") (re-search-forward "^`a'"))
 211             ((string= cmd "xy") (re-search-forward "^`ab'"))
 212             ((string= cmd "p,DEL") (re-search-forward "^`p'"))
 213             ((string= cmd "n,SPC") (re-search-forward "^`n'"))
 214             ((string= cmd "j") (re-search-forward "^`j'"))
 215             ((string= cmd "gx") (re-search-forward "^`ga'"))
 216             ((string= cmd "!") (re-search-forward "^`!'"))
 217             ((string= cmd "*") (re-search-forward "^`\\*'"))
 218             ((string= cmd "m") (re-search-forward "^`m'"))
 219             ((string= cmd "|") (re-search-forward "^`|'"))
 220             ((string= cmd "@") (re-search-forward "^`@'"))
 221             ((string= cmd "h") (re-search-forward "^`h'"))
 222             ((string= cmd "r") (re-search-forward "^`r'"))
 223             ((string= cmd "rx") (re-search-forward "^`ra'"))
 224             ((string= cmd "##") (re-search-forward "^`##'"))
 225             ((string= cmd "#c") (re-search-forward "^`#c'"))
 226             ((string= cmd "#f/#h") (re-search-forward "^`#f'"))
 227             ((string= cmd "X") (re-search-forward "^`A'"))
 228             ((string= cmd "v/V") (re-search-forward "^`v'"))
 229             ((string= cmd "</>") (re-search-forward "^`<'"))
 230             ((string= cmd "~") (re-search-forward "^`~'"))
 231             ((string= cmd "i") (re-search-forward "^`i'"))
 232             ((string= cmd "D") (re-search-forward "^`D'"))
 233             ((string= cmd "R") (re-search-forward "^`R'"))
 234             ((string= cmd "M") (re-search-forward "^`M'"))
 235             ((string= cmd "z/q") (re-search-forward "^`z'"))
 236             ((string= cmd "%") (re-search-forward "^`%'"))
 237             ((string= cmd "C-l") (re-search-forward "^`C-l'"))
 238             ((string= cmd "$$") (re-search-forward "^`\\$\\$'"))
 239             ((string= cmd "$*") (re-search-forward "^`\\$\\*'"))
 240             ((string= cmd "/") (re-search-forward "^`/'"))
 241             ((string= cmd "&") (re-search-forward "^`&'"))
 242             ((string= cmd "s") (re-search-forward "^`s'"))
 243             ((string= cmd "+") (re-search-forward "^`\\+'"))
 244             ((string= cmd "=") (re-search-forward "^`='"))
 245             (t (error "Undocumented command! Type `G' in Ediff Control Panel to drop a note to the Ediff maintainer")))
 246       ) ; let case-fold-search
 247     ))
 248
 249
 250 ;; assuming we are in control window, calculate length of the first line in
 251 ;; help message
 252 (defun ediff-help-message-line-length ()
 253   (save-excursion
 254     (goto-char (point-min))
 255     (if ediff-use-long-help-message
 256         (forward-line 1))
 257     (end-of-line)
 258     (current-column)))
 259
 260
 261 (defun ediff-indent-help-message ()
 262   (let* ((shift (/ (max 0 (- (window-width (selected-window))
 263                              (ediff-help-message-line-length)))
 264                    2))
 265          (str (make-string shift ?\ )))
 266     (save-excursion
 267       (goto-char (point-min))
 268       (while (< (point) (point-max))
 269         (insert str)
 270         (beginning-of-line)
 271         (forward-line 1)))))
 272
 273
 274 ;; compose the help message as a string
 275 (defun ediff-set-help-message ()
 276   (setq ediff-long-help-message
 277         (cond ((and ediff-long-help-message-function
 278                     (or (symbolp ediff-long-help-message-function)
 279                         (consp ediff-long-help-message-function)))
 280                (funcall ediff-long-help-message-function))
 281               (ediff-word-mode
 282                (concat ediff-long-help-message-head
 283                        ediff-long-help-message-word-mode
 284                        ediff-long-help-message-tail))
 285               (ediff-narrow-job
 286                (concat ediff-long-help-message-head
 287                        ediff-long-help-message-narrow2
 288                        ediff-long-help-message-tail))
 289               (ediff-merge-job
 290                (concat ediff-long-help-message-head
 291                        ediff-long-help-message-merge
 292                        ediff-long-help-message-tail))
 293               (ediff-diff3-job
 294                (concat ediff-long-help-message-head
 295                        ediff-long-help-message-compare3
 296                        ediff-long-help-message-tail))
 297               (t
 298                (concat ediff-long-help-message-head
 299                        ediff-long-help-message-compare2
 300                        ediff-long-help-message-tail))))
 301   (setq ediff-brief-help-message
 302         (cond ((and ediff-brief-help-message-function
 303                     (or (symbolp ediff-brief-help-message-function)
 304                         (consp ediff-brief-help-message-function)))
 305                (funcall ediff-brief-help-message-function))
 306               ((stringp ediff-brief-help-message-function)
 307                ediff-brief-help-message-function)
 308               ((ediff-multiframe-setup-p) ediff-brief-message-string)
 309               (t ; long brief msg, not multiframe --- put in the middle
 310                ediff-brief-message-string)
 311               ))
 312   (setq ediff-help-message (if ediff-use-long-help-message
 313                                ediff-long-help-message
 314                              ediff-brief-help-message))
 315   (run-hooks 'ediff-display-help-hook))
 316
 317 ;;;###autoload
 318 (defun ediff-customize ()
 319   (interactive)
 320   (customize-group "ediff"))
 321
 322
 323 (provide 'ediff-help)
 324
 325
 326 ;; arch-tag: 05659813-7fcf-4274-964f-d2f577431a9d
 327 ;;; ediff-help.el ends here