24 |
;;; Commentary: |
;;; Commentary: |
25 |
|
|
26 |
;;; Code: |
;;; Code: |
27 |
|
|
28 |
(provide 'ediff-help) |
(provide 'ediff-help) |
29 |
|
|
30 |
;; Compiler pacifier start |
;; Compiler pacifier start |
47 |
"The head of the full help message.") |
"The head of the full help message.") |
48 |
(defconst ediff-long-help-message-tail |
(defconst ediff-long-help-message-tail |
49 |
"=====================|===========================|============================= |
"=====================|===========================|============================= |
50 |
R -show registry | = -compare regions | M -show session group |
R -show registry | = -compare regions | M -show session group |
51 |
D -diff output | E -browse Ediff manual| G -send bug report |
D -diff output | E -browse Ediff manual| G -send bug report |
52 |
i -status info | ? -help off | z/q -suspend/quit |
i -status info | ? -help off | z/q -suspend/quit |
53 |
------------------------------------------------------------------------------- |
------------------------------------------------------------------------------- |
54 |
For help on a specific command: Click Button 2 over it; or |
For help on a specific command: Click Button 2 over it; or |
55 |
Put the cursor over it and type RET." |
Put the cursor over it and type RET." |
59 |
" |
" |
60 |
p,DEL -previous diff | | -vert/horiz split | xy -copy buf X's region to Y |
p,DEL -previous diff | | -vert/horiz split | xy -copy buf X's region to Y |
61 |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
62 |
j -jump to diff | @ -auto-refinement | * -refine current region |
j -jump to diff | @ -auto-refinement | * -refine current region |
63 |
gx -goto X's point| | ! -update diff regions |
gx -goto X's point| | ! -update diff regions |
64 |
C-l -recenter | ## -ignore whitespace | |
C-l -recenter | ## -ignore whitespace | |
65 |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
66 |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
67 |
~ -rotate buffers| m -wide display | |
~ -rotate buffers| m -wide display | |
68 |
" |
" |
69 |
"Help message usually used for 3-way comparison. |
"Help message usually used for 3-way comparison. |
70 |
Normally, not a user option. See `ediff-help-message' for details.") |
Normally, not a user option. See `ediff-help-message' for details.") |
71 |
|
|
72 |
(defconst ediff-long-help-message-compare2 |
(defconst ediff-long-help-message-compare2 |
73 |
" |
" |
74 |
p,DEL -previous diff | | -vert/horiz split |a/b -copy A/B's region to B/A |
p,DEL -previous diff | | -vert/horiz split |a/b -copy A/B's region to B/A |
75 |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
76 |
j -jump to diff | @ -auto-refinement | * -refine current region |
j -jump to diff | @ -auto-refinement | * -refine current region |
77 |
gx -goto X's point| | ! -update diff regions |
gx -goto X's point| | ! -update diff regions |
78 |
C-l -recenter | ## -ignore whitespace | |
C-l -recenter | ## -ignore whitespace | |
79 |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
80 |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
81 |
~ -swap variants | m -wide display | |
~ -swap variants | m -wide display | |
82 |
" |
" |
83 |
"Help message usually used for 2-way comparison. |
"Help message usually used for 2-way comparison. |
84 |
Normally, not a user option. See `ediff-help-message' for details.") |
Normally, not a user option. See `ediff-help-message' for details.") |
85 |
|
|
86 |
(defconst ediff-long-help-message-narrow2 |
(defconst ediff-long-help-message-narrow2 |
87 |
" |
" |
88 |
p,DEL -previous diff | | -vert/horiz split |a/b -copy A/B's region to B/A |
p,DEL -previous diff | | -vert/horiz split |a/b -copy A/B's region to B/A |
89 |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
90 |
j -jump to diff | @ -auto-refinement | * -refine current region |
j -jump to diff | @ -auto-refinement | * -refine current region |
91 |
gx -goto X's point| % -narrow/widen buffs | ! -update diff regions |
gx -goto X's point| % -narrow/widen buffs | ! -update diff regions |
92 |
C-l -recenter | ## -ignore whitespace | |
C-l -recenter | ## -ignore whitespace | |
93 |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
94 |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
95 |
~ -swap variants | m -wide display | |
~ -swap variants | m -wide display | |
96 |
" |
" |
97 |
"Help message when comparing windows or regions line-by-line. |
"Help message when comparing windows or regions line-by-line. |
98 |
Normally, not a user option. See `ediff-help-message' for details.") |
Normally, not a user option. See `ediff-help-message' for details.") |
99 |
|
|
100 |
(defconst ediff-long-help-message-word-mode |
(defconst ediff-long-help-message-word-mode |
101 |
" |
" |
102 |
p,DEL -previous diff | | -vert/horiz split | xy -copy buf X's region to Y |
p,DEL -previous diff | | -vert/horiz split | xy -copy buf X's region to Y |
103 |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
n,SPC -next diff | h -hilighting | rx -restore buf X's old diff |
104 |
j -jump to diff | | |
j -jump to diff | | |
105 |
gx -goto X's point| % -narrow/widen buffs | ! -recompute diffs |
gx -goto X's point| % -narrow/widen buffs | ! -recompute diffs |
106 |
C-l -recenter | | |
C-l -recenter | | |
107 |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
v/V -scroll up/dn | #f/#h -focus/hide regions | wx -save buf X |
108 |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
</> -scroll lt/rt | X -read-only in buf X | wd -save diff output |
109 |
~ -swap variants | m -wide display | |
~ -swap variants | m -wide display | |
110 |
" |
" |
111 |
"Help message when comparing windows or regions word-by-word. |
"Help message when comparing windows or regions word-by-word. |
112 |
Normally, not a user option. See `ediff-help-message' for details.") |
Normally, not a user option. See `ediff-help-message' for details.") |
113 |
|
|
114 |
(defconst ediff-long-help-message-merge |
(defconst ediff-long-help-message-merge |
115 |
" |
" |
116 |
p,DEL -previous diff | | -vert/horiz split | x -copy buf X's region to C |
p,DEL -previous diff | | -vert/horiz split | x -copy buf X's region to C |
117 |
n,SPC -next diff | h -hilighting | r -restore buf C's old diff |
n,SPC -next diff | h -hilighting | r -restore buf C's old diff |
118 |
j -jump to diff | @ -auto-refinement | * -refine current region |
j -jump to diff | @ -auto-refinement | * -refine current region |
119 |
gx -goto X's point| ## -ignore whitespace | ! -update diff regions |
gx -goto X's point| ## -ignore whitespace | ! -update diff regions |
120 |
C-l -recenter | #f/#h -focus/hide regions | + -combine diff regions |
C-l -recenter | #f/#h -focus/hide regions | + -combine diff regions |
121 |
v/V -scroll up/dn | X -read-only in buf X | wx -save buf X |
v/V -scroll up/dn | X -read-only in buf X | wx -save buf X |
122 |
</> -scroll lt/rt | m -wide display | wd -save diff output |
</> -scroll lt/rt | m -wide display | wd -save diff output |
123 |
~ -swap variants | s -shrink window C | / -show ancestor buff |
~ -swap variants | s -shrink window C | / -show ancestor buff |
124 |
| $$ -show clashes only | & -merge w/new default |
| $$ -show clashes only | & -merge w/new default |
125 |
| $* -skip changed regions | |
| $* -skip changed regions | |
126 |
" |
" |
127 |
"Help message for merge sessions. |
"Help message for merge sessions. |
130 |
;; The actual long help message. |
;; The actual long help message. |
131 |
(ediff-defvar-local ediff-long-help-message "" |
(ediff-defvar-local ediff-long-help-message "" |
132 |
"Normally, not a user option. See `ediff-help-message' for details.") |
"Normally, not a user option. See `ediff-help-message' for details.") |
133 |
|
|
134 |
(defconst ediff-brief-message-string |
(defconst ediff-brief-message-string |
135 |
" ? -quick help " |
" ? -quick help " |
136 |
"Contents of the brief help message.") |
"Contents of the brief help message.") |
137 |
;; The actual brief help message |
;; The actual brief help message |
138 |
(ediff-defvar-local ediff-brief-help-message "" |
(ediff-defvar-local ediff-brief-help-message "" |
139 |
"Normally, not a user option. See `ediff-help-message' for details.") |
"Normally, not a user option. See `ediff-help-message' for details.") |
140 |
|
|
141 |
(ediff-defvar-local ediff-brief-help-message-function nil |
(ediff-defvar-local ediff-brief-help-message-function nil |
142 |
"The brief help message that the user can customize. |
"The brief help message that the user can customize. |
143 |
If the user sets this to a parameter-less function, Ediff will use it to |
If the user sets this to a parameter-less function, Ediff will use it to |
157 |
Normally, the user shouldn't touch this. However, if you want Ediff to |
Normally, the user shouldn't touch this. However, if you want Ediff to |
158 |
start up with different help messages for different jobs, you can change |
start up with different help messages for different jobs, you can change |
159 |
the value of this variable and the variables `ediff-help-message-*' in |
the value of this variable and the variables `ediff-help-message-*' in |
160 |
`ediff-startup-hook'.") |
`ediff-startup-hook'.") |
161 |
|
|
162 |
|
|
163 |
;; the keymap that defines clicks over the quick help regions |
;; the keymap that defines clicks over the quick help regions |
199 |
(overlay-get elt 'ediff-help-info)) |
(overlay-get elt 'ediff-help-info)) |
200 |
(overlays-at pos)))) |
(overlays-at pos)))) |
201 |
) |
) |
202 |
|
|
203 |
(if (not (stringp cmd)) |
(if (not (stringp cmd)) |
204 |
(error "Hmm... I don't see an Ediff command around here...")) |
(error "Hmm... I don't see an Ediff command around here...")) |
205 |
|
|
206 |
(ediff-documentation "Quick Help Commands") |
(ediff-documentation "Quick Help Commands") |
207 |
|
|
208 |
(let (case-fold-search) |
(let (case-fold-search) |
209 |
(cond ((string= cmd "?") (re-search-forward "^`\\?'")) |
(cond ((string= cmd "?") (re-search-forward "^`\\?'")) |
210 |
((string= cmd "G") (re-search-forward "^`G'")) |
((string= cmd "G") (re-search-forward "^`G'")) |
260 |
(next-line 1)) |
(next-line 1)) |
261 |
(end-of-line) |
(end-of-line) |
262 |
(current-column))) |
(current-column))) |
263 |
|
|
264 |
|
|
265 |
(defun ediff-indent-help-message () |
(defun ediff-indent-help-message () |
266 |
(let* ((shift (/ (max 0 (- (window-width (selected-window)) |
(let* ((shift (/ (max 0 (- (window-width (selected-window)) |
273 |
(insert str) |
(insert str) |
274 |
(beginning-of-line) |
(beginning-of-line) |
275 |
(forward-line 1))))) |
(forward-line 1))))) |
276 |
|
|
277 |
|
|
278 |
;; compose the help message as a string |
;; compose the help message as a string |
279 |
(defun ediff-set-help-message () |
(defun ediff-set-help-message () |
282 |
(or (symbolp ediff-long-help-message-function) |
(or (symbolp ediff-long-help-message-function) |
283 |
(consp ediff-long-help-message-function))) |
(consp ediff-long-help-message-function))) |
284 |
(funcall ediff-long-help-message-function)) |
(funcall ediff-long-help-message-function)) |
285 |
(ediff-word-mode |
(ediff-word-mode |
286 |
(concat ediff-long-help-message-head |
(concat ediff-long-help-message-head |
287 |
ediff-long-help-message-word-mode |
ediff-long-help-message-word-mode |
288 |
ediff-long-help-message-tail)) |
ediff-long-help-message-tail)) |
290 |
(concat ediff-long-help-message-head |
(concat ediff-long-help-message-head |
291 |
ediff-long-help-message-narrow2 |
ediff-long-help-message-narrow2 |
292 |
ediff-long-help-message-tail)) |
ediff-long-help-message-tail)) |
293 |
(ediff-merge-job |
(ediff-merge-job |
294 |
(concat ediff-long-help-message-head |
(concat ediff-long-help-message-head |
295 |
ediff-long-help-message-merge |
ediff-long-help-message-merge |
296 |
ediff-long-help-message-tail)) |
ediff-long-help-message-tail)) |
298 |
(concat ediff-long-help-message-head |
(concat ediff-long-help-message-head |
299 |
ediff-long-help-message-compare3 |
ediff-long-help-message-compare3 |
300 |
ediff-long-help-message-tail)) |
ediff-long-help-message-tail)) |
301 |
(t |
(t |
302 |
(concat ediff-long-help-message-head |
(concat ediff-long-help-message-head |
303 |
ediff-long-help-message-compare2 |
ediff-long-help-message-compare2 |
304 |
ediff-long-help-message-tail)))) |
ediff-long-help-message-tail)))) |
305 |
(setq ediff-brief-help-message |
(setq ediff-brief-help-message |
306 |
(cond ((and ediff-brief-help-message-function |
(cond ((and ediff-brief-help-message-function |
307 |
(or (symbolp ediff-brief-help-message-function) |
(or (symbolp ediff-brief-help-message-function) |
308 |
(consp ediff-brief-help-message-function))) |
(consp ediff-brief-help-message-function))) |