[bpt/emacs.git] / lisp / vc / ediff-help.el

;;; ediff-help.el --- Code related to the contents of Ediff help buffers

;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
;;   2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.

;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
;; Package: ediff

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;; Code:


;; Compiler pacifier start
(defvar ediff-multiframe)
;; end pacifier

(require 'ediff-init)

;; Help messages

(defconst ediff-long-help-message-head
  "    Move around      |      Toggle features      |        Manipulate
=====================|===========================|============================="
  "The head of the full help message.")
(defconst ediff-long-help-message-tail
  "=====================|===========================|=============================
    R -show registry |     = -compare regions    |  M   -show session group
    D -diff output   |     E -browse Ediff manual|  G   -send bug report
    i -status info   |     ? -help off           |  z/q -suspend/quit
-------------------------------------------------------------------------------
For help on a specific command:  Click Button 2 over it; or
              			 Put the cursor over it and type RET."
  "The tail of the full-help message.")

(defconst ediff-long-help-message-compare3
  "
p,DEL -previous diff |     | -vert/horiz split   | xy -copy buf X's region to Y
n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
    j -jump to diff  |     @ -auto-refinement    |  * -refine current region
   gx -goto X's point|    ## -ignore whitespace  |  ! -update diff regions
  C-l -recenter      |    #c -ignore case        |
  v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
    ~ -rotate buffers|     m -wide display       |
"
  "Help message usually used for 3-way comparison.
Normally, not a user option.  See `ediff-help-message' for details.")

(defconst ediff-long-help-message-compare2
  "
p,DEL -previous diff |     | -vert/horiz split   |a/b -copy A/B's region to B/A
n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
    j -jump to diff  |     @ -auto-refinement    |  * -refine current region
   gx -goto X's point|    ## -ignore whitespace  |  ! -update diff regions
  C-l -recenter      |    #c -ignore case        |
  v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
    ~ -swap variants |     m -wide display       |
"
  "Help message usually used for 2-way comparison.
Normally, not a user option.  See `ediff-help-message' for details.")

(defconst ediff-long-help-message-narrow2
  "
p,DEL -previous diff |     | -vert/horiz split   |a/b -copy A/B's region to B/A
n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
    j -jump to diff  |     @ -auto-refinement    |  * -refine current region
   gx -goto X's point|    ## -ignore whitespace  |  ! -update diff regions
  C-l -recenter      |    #c -ignore case        |  % -narrow/widen buffs
  v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
    ~ -swap variants |     m -wide display       |
"
  "Help message when comparing windows or regions line-by-line.
Normally, not a user option.  See `ediff-help-message' for details.")

(defconst ediff-long-help-message-word-mode
  "
p,DEL -previous diff |     | -vert/horiz split   | xy -copy buf X's region to Y
n,SPC -next diff     |     h -hilighting         | rx -restore buf X's old diff
    j -jump to diff  |                           |
   gx -goto X's point|    % -narrow/widen buffs  |  ! -recompute diffs
  C-l -recenter      |    #c -ignore case        |
  v/V -scroll up/dn  | #f/#h -focus/hide regions | wx -save buf X
  </> -scroll lt/rt  |     X -read-only in buf X | wd -save diff output
    ~ -swap variants |     m -wide display       |
"
  "Help message when comparing windows or regions word-by-word.
Normally, not a user option.  See `ediff-help-message' for details.")

(defconst ediff-long-help-message-merge
  "
p,DEL -previous diff |     | -vert/horiz split   |  x -copy buf X's region to C
n,SPC -next diff     |     h -hilighting         |  r -restore buf C's old diff
    j -jump to diff  |     @ -auto-refinement    |  * -refine current region
   gx -goto X's point|    ## -ignore whitespace  |  ! -update diff regions
  C-l -recenter      | #f/#h -focus/hide regions |  + -combine diff regions
  v/V -scroll up/dn  |     X -read-only in buf X | wx -save buf X
  </> -scroll lt/rt  |     m -wide display       | wd -save diff output
    ~ -swap variants |     s -shrink window C    |  / -show ancestor buff
                     |  $$ -show clashes only    |  & -merge w/new default
                     |  $* -skip changed regions |
"
  "Help message for merge sessions.
Normally, not a user option.  See `ediff-help-message' for details.")

;; The actual long help message.
(ediff-defvar-local ediff-long-help-message ""
  "Normally, not a user option.  See `ediff-help-message' for details.")

(defconst ediff-brief-message-string
  " Type ? for help"
  "Contents of the brief help message.")
;; The actual brief help message
(ediff-defvar-local ediff-brief-help-message ""
  "Normally, not a user option.  See `ediff-help-message' for details.")

(ediff-defvar-local ediff-brief-help-message-function nil
  "The brief help message that the user can customize.
If the user sets this to a parameter-less function, Ediff will use it to
produce the brief help message.  This function must return a string.")
(ediff-defvar-local ediff-long-help-message-function nil
  "The long help message that the user can customize.
See `ediff-brief-help-message-function' for more.")

(defcustom ediff-use-long-help-message nil
  "If t, Ediff displays a long help message.  Short help message otherwise."
  :type 'boolean
  :group 'ediff-window)

;; The actual help message.
(ediff-defvar-local ediff-help-message ""
  "The actual help message.
Normally, the user shouldn't touch this.  However, if you want Ediff to
start up with different help messages for different jobs, you can change
the value of this variable and the variables `ediff-help-message-*' in
`ediff-startup-hook'.")


;; the keymap that defines clicks over the quick help regions
(defvar ediff-help-region-map (make-sparse-keymap))

(define-key
  ediff-help-region-map
  (if (featurep 'emacs) [mouse-2] [button2])
  'ediff-help-for-quick-help)

;; runs in the control buffer
(defun ediff-set-help-overlays ()
  (goto-char (point-min))
  (let (overl beg end cmd)
    (while (re-search-forward " *\\([^ \t\n|]+\\||\\) +-[^|\n]+" nil 'noerror)
      (setq beg (match-beginning 0)
	    end (match-end 0)
	    cmd (buffer-substring (match-beginning 1) (match-end 1)))
      (setq overl (ediff-make-overlay beg end))
      (if (featurep 'emacs)
	  (ediff-overlay-put overl 'mouse-face 'highlight)
	(ediff-overlay-put overl 'highlight t))
      (ediff-overlay-put overl 'ediff-help-info cmd))))


(defun ediff-help-for-quick-help ()
  "Explain Ediff commands in more detail."
  (interactive)
  (ediff-barf-if-not-control-buffer)
  (let ((pos (ediff-event-point last-command-event))
	overl cmd)

    (if (featurep 'xemacs)
	(setq overl (extent-at pos (current-buffer) 'ediff-help-info)
	      cmd   (ediff-overlay-get overl 'ediff-help-info))
      (setq cmd (car (mapcar (lambda (elt)
			       (overlay-get elt 'ediff-help-info))
			     (overlays-at pos)))))

    (if (not (stringp cmd))
	(error "Hmm...  I don't see an Ediff command around here..."))

    (ediff-documentation "Quick Help Commands")

    (let (case-fold-search)
      (cond ((string= cmd "?") (re-search-forward "^`\\?'"))
	    ((string= cmd "G") (re-search-forward "^`G'"))
	    ((string= cmd "E") (re-search-forward "^`E'"))
	    ((string= cmd "wd") (re-search-forward "^`wd'"))
	    ((string= cmd "wx") (re-search-forward "^`wa'"))
	    ((string= cmd "a/b") (re-search-forward "^`a'"))
	    ((string= cmd "x") (re-search-forward "^`a'"))
	    ((string= cmd "xy") (re-search-forward "^`ab'"))
	    ((string= cmd "p,DEL") (re-search-forward "^`p'"))
	    ((string= cmd "n,SPC") (re-search-forward "^`n'"))
	    ((string= cmd "j") (re-search-forward "^`j'"))
	    ((string= cmd "gx") (re-search-forward "^`ga'"))
	    ((string= cmd "!") (re-search-forward "^`!'"))
	    ((string= cmd "*") (re-search-forward "^`\\*'"))
	    ((string= cmd "m") (re-search-forward "^`m'"))
	    ((string= cmd "|") (re-search-forward "^`|'"))
	    ((string= cmd "@") (re-search-forward "^`@'"))
	    ((string= cmd "h") (re-search-forward "^`h'"))
	    ((string= cmd "r") (re-search-forward "^`r'"))
	    ((string= cmd "rx") (re-search-forward "^`ra'"))
	    ((string= cmd "##") (re-search-forward "^`##'"))
	    ((string= cmd "#c") (re-search-forward "^`#c'"))
	    ((string= cmd "#f/#h") (re-search-forward "^`#f'"))
	    ((string= cmd "X") (re-search-forward "^`A'"))
	    ((string= cmd "v/V") (re-search-forward "^`v'"))
	    ((string= cmd "</>") (re-search-forward "^`<'"))
	    ((string= cmd "~") (re-search-forward "^`~'"))
	    ((string= cmd "i") (re-search-forward "^`i'"))
	    ((string= cmd "D") (re-search-forward "^`D'"))
	    ((string= cmd "R") (re-search-forward "^`R'"))
	    ((string= cmd "M") (re-search-forward "^`M'"))
	    ((string= cmd "z/q") (re-search-forward "^`z'"))
	    ((string= cmd "%") (re-search-forward "^`%'"))
	    ((string= cmd "C-l") (re-search-forward "^`C-l'"))
	    ((string= cmd "$$") (re-search-forward "^`\\$\\$'"))
	    ((string= cmd "$*") (re-search-forward "^`\\$\\*'"))
	    ((string= cmd "/") (re-search-forward "^`/'"))
	    ((string= cmd "&") (re-search-forward "^`&'"))
	    ((string= cmd "s") (re-search-forward "^`s'"))
	    ((string= cmd "+") (re-search-forward "^`\\+'"))
	    ((string= cmd "=") (re-search-forward "^`='"))
	    (t (error "Undocumented command! Type `G' in Ediff Control Panel to drop a note to the Ediff maintainer")))
      ) ; let case-fold-search
    ))


;; assuming we are in control window, calculate length of the first line in
;; help message
(defun ediff-help-message-line-length ()
  (save-excursion
    (goto-char (point-min))
    (if ediff-use-long-help-message
	(forward-line 1))
    (end-of-line)
    (current-column)))


(defun ediff-indent-help-message ()
  (let* ((shift (/ (max 0 (- (window-width (selected-window))
			     (ediff-help-message-line-length)))
		   2))
	 (str (make-string shift ?\ )))
    (save-excursion
      (goto-char (point-min))
      (while (< (point) (point-max))
	(insert str)
	(beginning-of-line)
	(forward-line 1)))))


;; compose the help message as a string
(defun ediff-set-help-message ()
  (setq ediff-long-help-message
	(cond ((and ediff-long-help-message-function
		    (or (symbolp ediff-long-help-message-function)
			(consp ediff-long-help-message-function)))
	       (funcall ediff-long-help-message-function))
	      (ediff-word-mode
	       (concat ediff-long-help-message-head
		       ediff-long-help-message-word-mode
		       ediff-long-help-message-tail))
	      (ediff-narrow-job
	       (concat ediff-long-help-message-head
		       ediff-long-help-message-narrow2
		       ediff-long-help-message-tail))
	      (ediff-merge-job
	       (concat ediff-long-help-message-head
		       ediff-long-help-message-merge
		       ediff-long-help-message-tail))
	      (ediff-diff3-job
	       (concat ediff-long-help-message-head
		       ediff-long-help-message-compare3
		       ediff-long-help-message-tail))
	      (t
	       (concat ediff-long-help-message-head
		       ediff-long-help-message-compare2
		       ediff-long-help-message-tail))))
  (setq ediff-brief-help-message
	(cond ((and ediff-brief-help-message-function
		    (or (symbolp ediff-brief-help-message-function)
			(consp ediff-brief-help-message-function)))
	       (funcall ediff-brief-help-message-function))
	      ((stringp ediff-brief-help-message-function)
	       ediff-brief-help-message-function)
	      ((ediff-multiframe-setup-p) ediff-brief-message-string)
	      (t ; long brief msg, not multiframe --- put in the middle
	       ediff-brief-message-string)
	      ))
  (setq ediff-help-message (if ediff-use-long-help-message
			       ediff-long-help-message
			     ediff-brief-help-message))
  (run-hooks 'ediff-display-help-hook))

;;;###autoload
(defun ediff-customize ()
  (interactive)
  (customize-group "ediff"))


(provide 'ediff-help)


;; arch-tag: 05659813-7fcf-4274-964f-d2f577431a9d
;;; ediff-help.el ends here
Commit	Line	Data
f49e1445 MK	1	;;; ediff-help.el --- Code related to the contents of Ediff help buffers
f49e1445 MK	2
0d30b337	3	;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
5df4f04c	4	;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
f49e1445	5
50a07e18	6	;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
bd78fa1d	7	;; Package: ediff
f49e1445 MK	8
	9	;; This file is part of GNU Emacs.
	10
eb3fa2cf	11	;; GNU Emacs is free software: you can redistribute it and/or modify
f49e1445	12	;; it under the terms of the GNU General Public License as published by
eb3fa2cf GM	13	;; the Free Software Foundation, either version 3 of the License, or
eb3fa2cf GM	14	;; (at your option) any later version.
f49e1445 MK	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
eb3fa2cf	22	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
f49e1445	23
3afbc435 PJ	24	;;; Commentary:
3afbc435 PJ	25
f49e1445	26	;;; Code:
71296446	27
f49e1445 MK	28
	29	;; Compiler pacifier start
	30	(defvar ediff-multiframe)
f49e1445 MK	31	;; end pacifier
f49e1445 MK	32
ddc90f39 MK	33	(require 'ediff-init)
ddc90f39 MK	34
f49e1445 MK	35	;; Help messages
	36
	37	(defconst ediff-long-help-message-head
	38	" Move around \| Toggle features \| Manipulate
	39	=====================\|===========================\|============================="
	40	"The head of the full help message.")
	41	(defconst ediff-long-help-message-tail
	42	"=====================\|===========================\|=============================
71296446 JB	43	R -show registry \| = -compare regions \| M -show session group
	44	D -diff output \| E -browse Ediff manual\| G -send bug report
	45	i -status info \| ? -help off \| z/q -suspend/quit
f49e1445 MK	46	-------------------------------------------------------------------------------
	47	For help on a specific command: Click Button 2 over it; or
	48	Put the cursor over it and type RET."
	49	"The tail of the full-help message.")
	50
	51	(defconst ediff-long-help-message-compare3
	52	"
	53	p,DEL -previous diff \| \| -vert/horiz split \| xy -copy buf X's region to Y
	54	n,SPC -next diff \| h -hilighting \| rx -restore buf X's old diff
71296446	55	j -jump to diff \| @ -auto-refinement \| * -refine current region
b6178721 MK	56	gx -goto X's point\| ## -ignore whitespace \| ! -update diff regions
b6178721 MK	57	C-l -recenter \| #c -ignore case \|
71296446 JB	58	v/V -scroll up/dn \| #f/#h -focus/hide regions \| wx -save buf X
71296446 JB	59	</> -scroll lt/rt \| X -read-only in buf X \| wd -save diff output
f49e1445 MK	60	~ -rotate buffers\| m -wide display \|
	61	"
	62	"Help message usually used for 3-way comparison.
3af0304a	63	Normally, not a user option. See `ediff-help-message' for details.")
71296446	64
f49e1445 MK	65	(defconst ediff-long-help-message-compare2
	66	"
	67	p,DEL -previous diff \| \| -vert/horiz split \|a/b -copy A/B's region to B/A
	68	n,SPC -next diff \| h -hilighting \| rx -restore buf X's old diff
71296446	69	j -jump to diff \| @ -auto-refinement \| * -refine current region
b6178721 MK	70	gx -goto X's point\| ## -ignore whitespace \| ! -update diff regions
b6178721 MK	71	C-l -recenter \| #c -ignore case \|
71296446 JB	72	v/V -scroll up/dn \| #f/#h -focus/hide regions \| wx -save buf X
	73	</> -scroll lt/rt \| X -read-only in buf X \| wd -save diff output
	74	~ -swap variants \| m -wide display \|
f49e1445 MK	75	"
f49e1445 MK	76	"Help message usually used for 2-way comparison.
3af0304a	77	Normally, not a user option. See `ediff-help-message' for details.")
71296446	78
f49e1445 MK	79	(defconst ediff-long-help-message-narrow2
	80	"
	81	p,DEL -previous diff \| \| -vert/horiz split \|a/b -copy A/B's region to B/A
	82	n,SPC -next diff \| h -hilighting \| rx -restore buf X's old diff
71296446	83	j -jump to diff \| @ -auto-refinement \| * -refine current region
b6178721	84	gx -goto X's point\| ## -ignore whitespace \| ! -update diff regions
9201cc28	85	C-l -recenter \| #c -ignore case \| % -narrow/widen buffs
71296446 JB	86	v/V -scroll up/dn \| #f/#h -focus/hide regions \| wx -save buf X
	87	</> -scroll lt/rt \| X -read-only in buf X \| wd -save diff output
	88	~ -swap variants \| m -wide display \|
f49e1445 MK	89	"
f49e1445 MK	90	"Help message when comparing windows or regions line-by-line.
3af0304a	91	Normally, not a user option. See `ediff-help-message' for details.")
71296446	92
f49e1445 MK	93	(defconst ediff-long-help-message-word-mode
	94	"
	95	p,DEL -previous diff \| \| -vert/horiz split \| xy -copy buf X's region to Y
	96	n,SPC -next diff \| h -hilighting \| rx -restore buf X's old diff
71296446	97	j -jump to diff \| \|
b6178721 MK	98	gx -goto X's point\| % -narrow/widen buffs \| ! -recompute diffs
b6178721 MK	99	C-l -recenter \| #c -ignore case \|
71296446 JB	100	v/V -scroll up/dn \| #f/#h -focus/hide regions \| wx -save buf X
	101	</> -scroll lt/rt \| X -read-only in buf X \| wd -save diff output
	102	~ -swap variants \| m -wide display \|
f49e1445 MK	103	"
f49e1445 MK	104	"Help message when comparing windows or regions word-by-word.
3af0304a	105	Normally, not a user option. See `ediff-help-message' for details.")
71296446	106
f49e1445 MK	107	(defconst ediff-long-help-message-merge
	108	"
	109	p,DEL -previous diff \| \| -vert/horiz split \| x -copy buf X's region to C
	110	n,SPC -next diff \| h -hilighting \| r -restore buf C's old diff
71296446 JB	111	j -jump to diff \| @ -auto-refinement \| * -refine current region
	112	gx -goto X's point\| ## -ignore whitespace \| ! -update diff regions
	113	C-l -recenter \| #f/#h -focus/hide regions \| + -combine diff regions
	114	v/V -scroll up/dn \| X -read-only in buf X \| wx -save buf X
	115	</> -scroll lt/rt \| m -wide display \| wd -save diff output
	116	~ -swap variants \| s -shrink window C \| / -show ancestor buff
	117	\| $$ -show clashes only \| & -merge w/new default
3af0304a	118	\| $* -skip changed regions \|
f49e1445	119	"
3af0304a MK	120	"Help message for merge sessions.
3af0304a MK	121	Normally, not a user option. See `ediff-help-message' for details.")
f49e1445 MK	122
	123	;; The actual long help message.
	124	(ediff-defvar-local ediff-long-help-message ""
3af0304a	125	"Normally, not a user option. See `ediff-help-message' for details.")
71296446	126
f49e1445	127	(defconst ediff-brief-message-string
899a431b	128	" Type ? for help"
f49e1445 MK	129	"Contents of the brief help message.")
	130	;; The actual brief help message
	131	(ediff-defvar-local ediff-brief-help-message ""
3af0304a	132	"Normally, not a user option. See `ediff-help-message' for details.")
71296446	133
f49e1445 MK	134	(ediff-defvar-local ediff-brief-help-message-function nil
	135	"The brief help message that the user can customize.
	136	If the user sets this to a parameter-less function, Ediff will use it to
3af0304a	137	produce the brief help message. This function must return a string.")
f49e1445 MK	138	(ediff-defvar-local ediff-long-help-message-function nil
	139	"The long help message that the user can customize.
	140	See `ediff-brief-help-message-function' for more.")
	141
7d027816	142	(defcustom ediff-use-long-help-message nil
9201cc28	143	"If t, Ediff displays a long help message. Short help message otherwise."
7d027816 MK	144	:type 'boolean
7d027816 MK	145	:group 'ediff-window)
f49e1445 MK	146
	147	;; The actual help message.
	148	(ediff-defvar-local ediff-help-message ""
	149	"The actual help message.
3af0304a	150	Normally, the user shouldn't touch this. However, if you want Ediff to
f49e1445 MK	151	start up with different help messages for different jobs, you can change
f49e1445 MK	152	the value of this variable and the variables `ediff-help-message-*' in
71296446	153	`ediff-startup-hook'.")
f49e1445 MK	154
	155
	156	;; the keymap that defines clicks over the quick help regions
	157	(defvar ediff-help-region-map (make-sparse-keymap))
	158
	159	(define-key
	160	ediff-help-region-map
e83d1fe8	161	(if (featurep 'emacs) [mouse-2] [button2])
f49e1445 MK	162	'ediff-help-for-quick-help)
	163
	164	;; runs in the control buffer
	165	(defun ediff-set-help-overlays ()
	166	(goto-char (point-min))
	167	(let (overl beg end cmd)
	168	(while (re-search-forward " *\\([^ \t\n\|]+\\\|\|\\) +-[^\|\n]+" nil 'noerror)
	169	(setq beg (match-beginning 0)
	170	end (match-end 0)
	171	cmd (buffer-substring (match-beginning 1) (match-end 1)))
	172	(setq overl (ediff-make-overlay beg end))
e83d1fe8	173	(if (featurep 'emacs)
f49e1445 MK	174	(ediff-overlay-put overl 'mouse-face 'highlight)
	175	(ediff-overlay-put overl 'highlight t))
	176	(ediff-overlay-put overl 'ediff-help-info cmd))))
	177
	178
	179	(defun ediff-help-for-quick-help ()
	180	"Explain Ediff commands in more detail."
	181	(interactive)
	182	(ediff-barf-if-not-control-buffer)
ddc90f39	183	(let ((pos (ediff-event-point last-command-event))
f49e1445 MK	184	overl cmd)
f49e1445 MK	185
dc3fbc6a GM	186	(if (featurep 'xemacs)
	187	(setq overl (extent-at pos (current-buffer) 'ediff-help-info)
	188	cmd (ediff-overlay-get overl 'ediff-help-info))
	189	(setq cmd (car (mapcar (lambda (elt)
	190	(overlay-get elt 'ediff-help-info))
	191	(overlays-at pos)))))
71296446	192
f49e1445	193	(if (not (stringp cmd))
3af0304a	194	(error "Hmm... I don't see an Ediff command around here..."))
71296446	195
f49e1445	196	(ediff-documentation "Quick Help Commands")
71296446	197
f49e1445 MK	198	(let (case-fold-search)
	199	(cond ((string= cmd "?") (re-search-forward "^`\\?'"))
	200	((string= cmd "G") (re-search-forward "^`G'"))
	201	((string= cmd "E") (re-search-forward "^`E'"))
	202	((string= cmd "wd") (re-search-forward "^`wd'"))
	203	((string= cmd "wx") (re-search-forward "^`wa'"))
	204	((string= cmd "a/b") (re-search-forward "^`a'"))
	205	((string= cmd "x") (re-search-forward "^`a'"))
	206	((string= cmd "xy") (re-search-forward "^`ab'"))
	207	((string= cmd "p,DEL") (re-search-forward "^`p'"))
	208	((string= cmd "n,SPC") (re-search-forward "^`n'"))
	209	((string= cmd "j") (re-search-forward "^`j'"))
	210	((string= cmd "gx") (re-search-forward "^`ga'"))
	211	((string= cmd "!") (re-search-forward "^`!'"))
	212	((string= cmd "") (re-search-forward "^`\\'"))
	213	((string= cmd "m") (re-search-forward "^`m'"))
	214	((string= cmd "\|") (re-search-forward "^`\|'"))
	215	((string= cmd "@") (re-search-forward "^`@'"))
	216	((string= cmd "h") (re-search-forward "^`h'"))
	217	((string= cmd "r") (re-search-forward "^`r'"))
	218	((string= cmd "rx") (re-search-forward "^`ra'"))
	219	((string= cmd "##") (re-search-forward "^`##'"))
b6178721	220	((string= cmd "#c") (re-search-forward "^`#c'"))
f49e1445 MK	221	((string= cmd "#f/#h") (re-search-forward "^`#f'"))
	222	((string= cmd "X") (re-search-forward "^`A'"))
	223	((string= cmd "v/V") (re-search-forward "^`v'"))
	224	((string= cmd "</>") (re-search-forward "^`<'"))
	225	((string= cmd "~") (re-search-forward "^`~'"))
	226	((string= cmd "i") (re-search-forward "^`i'"))
	227	((string= cmd "D") (re-search-forward "^`D'"))
	228	((string= cmd "R") (re-search-forward "^`R'"))
	229	((string= cmd "M") (re-search-forward "^`M'"))
	230	((string= cmd "z/q") (re-search-forward "^`z'"))
	231	((string= cmd "%") (re-search-forward "^`%'"))
	232	((string= cmd "C-l") (re-search-forward "^`C-l'"))
3af0304a MK	233	((string= cmd "$$") (re-search-forward "^`\\$\\$'"))
3af0304a MK	234	((string= cmd "$") (re-search-forward "^`\\$\\'"))
f49e1445 MK	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
97546017	251	(forward-line 1))
f49e1445 MK	252	(end-of-line)
f49e1445 MK	253	(current-column)))
71296446	254
f49e1445 MK	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)))))
71296446	267
f49e1445 MK	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))
71296446	276	(ediff-word-mode
f49e1445 MK	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))
71296446	284	(ediff-merge-job
f49e1445 MK	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))
71296446	292	(t
f49e1445 MK	293	(concat ediff-long-help-message-head
	294	ediff-long-help-message-compare2
	295	ediff-long-help-message-tail))))
71296446	296	(setq ediff-brief-help-message
f49e1445 MK	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
55d7ff38	312	;;;###autoload
3af0304a MK	313	(defun ediff-customize ()
	314	(interactive)
	315	(customize-group "ediff"))
	316
f49e1445	317
b6178721 MK	318	(provide 'ediff-help)
	319
	320
cbee283d	321	;; arch-tag: 05659813-7fcf-4274-964f-d2f577431a9d
f49e1445	322	;;; ediff-help.el ends here