1 ;;; calc-help.el --- help display functions for Calc,
3 ;; Copyright (C) 1990-1993, 2001-2015 Free Software Foundation, Inc.
5 ;; Author: David Gillespie <daveg@synaptics.com>
6 ;; Maintainer: Jay Belanger <jay.p.belanger@gmail.com>
8 ;; This file is part of GNU Emacs.
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 of the License, or
13 ;; (at your option) any later version.
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.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This file is autoloaded from calc-ext.el.
32 ;; Declare functions which are defined elsewhere.
33 (declare-function Info-goto-node
"info" (nodename &optional fork strict-case
))
34 (declare-function Info-last
"info" ())
37 (defun calc-help-prefix (arg)
38 "This key is the prefix for Calc help functions. See calc-help-for-help."
40 (or calc-dispatch-help
(sit-for echo-keystrokes
))
41 (let ((key (calc-read-key-sequence
42 (if calc-dispatch-help
43 "Calc Help options: Help, Info, Tutorial, Summary; Key, Function; ?=more"
44 (format "%s (Type ? for a list of Calc Help options)"
45 (key-description (this-command-keys))))
47 (setq key
(lookup-key calc-help-map key
))
50 (call-interactively key
)
53 (defun calc-help-for-help (arg)
54 "You have typed `h', the Calc help character. Type a Help option:
56 B calc-describe-bindings. Display a table of all key bindings.
57 H calc-full-help. Display all `?' key messages at once.
59 I calc-info. Read the Calc manual using the Info system.
60 T calc-tutorial. Read the Calc tutorial using the Info system.
61 S calc-info-summary. Read the Calc summary using the Info system.
63 C calc-describe-key-briefly. Look up the command name for a given key.
64 K calc-describe-key. Look up a key's documentation in the manual.
65 F calc-describe-function. Look up a function's documentation in the manual.
66 V calc-describe-variable. Look up a variable's documentation in the manual.
68 N calc-view-news. Display Calc history of changes.
70 C-c Describe conditions for copying Calc.
71 C-d Describe how you can get a new copy of Calc or report a bug.
72 C-w Describe how there is no warranty for Calc."
74 (if calc-dispatch-help
76 (save-window-excursion
77 (describe-function 'calc-help-for-help
)
78 (select-window (get-buffer-window "*Help*"))
80 (message "Calc Help options: Help, Info, ... press SPC, DEL to scroll, C-g to cancel")
81 (memq (car (setq key
(calc-read-key t
)))
82 '(? ?\C-h ?\C-? ?\C-v ?\M-v
)))
84 (if (memq (car key
) '(? ?\C-v
))
88 (calc-unread-command (cdr key
))
89 (calc-help-prefix nil
))
90 (let ((calc-dispatch-help t
))
91 (calc-help-prefix arg
))))
93 (defun calc-describe-copying ()
95 (calc-info-goto-node "Copying"))
97 (defun calc-describe-distribution ()
99 (calc-info-goto-node "Reporting Bugs"))
101 (defun calc-describe-no-warranty ()
103 (calc-info-goto-node "Copying")
104 (let ((case-fold-search nil
))
105 (search-forward " NO WARRANTY"))
109 (defun calc-describe-bindings ()
112 (with-current-buffer "*Help*"
113 (let ((inhibit-read-only t
))
114 (goto-char (point-min))
115 (when (search-forward "Major Mode Bindings:" nil t
)
116 (delete-region (point-min) (point))
117 (insert "Calc Mode Bindings:"))
118 (when (search-forward "Global bindings:" nil t
)
120 (delete-region (point) (point-max)))
121 (goto-char (point-min))
124 "\n[a-z] [0-9]\\( .*\n\\)\\([a-z] [0-9]\\1\\)*[a-z] \\([0-9]\\)\\1"
126 (let ((dig1 (char-after (1- (match-beginning 1))))
127 (dig2 (char-after (match-beginning 3))))
128 (delete-region (match-end 1) (match-end 0))
129 (goto-char (match-beginning 1))
132 (insert (format "%c .. %c" (min dig1 dig2
) (max dig1 dig2
)))))
133 (goto-char (point-min)))))
135 (defun calc-describe-key-briefly (key)
136 (interactive "kDescribe key briefly: ")
137 (calc-describe-key key t
))
139 (defvar Info-history
)
141 (defun calc-describe-key (key &optional briefly
)
142 (interactive "kDescribe key: ")
143 (let ((defn (if (eq (key-binding key
) 'calc-dispatch
)
144 (let ((key2 (calc-read-key-sequence
145 (format "Describe key briefly: %s-"
146 (key-description key
))
148 (setq key
(concat key key2
))
149 (lookup-key calc-dispatch-map key2
))
150 (if (eq (key-binding key
) 'calc-help-prefix
)
151 (let ((key2 (calc-read-key-sequence
152 (format "Describe key briefly: %s-"
153 (key-description key
))
155 (setq key
(concat key key2
))
156 (lookup-key calc-help-map key2
))
160 calc-summary-indentation
)
161 (while (or (equal key
"I") (equal key
"H"))
164 (setq hyp
(not hyp
)))
165 (setq key
(read-key-sequence (format "Describe key%s:%s%s "
166 (if briefly
" briefly" "")
169 defn
(key-binding key
)))
170 (let ((desc (key-description key
))
172 (if (string-match "^ESC " desc
)
173 (setq desc
(concat "M-" (substring desc
4))))
174 (while (string-match "^M-# \\(ESC \\|C-\\)" desc
)
175 (setq desc
(concat "M-# " (substring desc
(match-end 0)))))
176 (if (string-match "\\(DEL\\|\\LFD\\|RET\\|SPC\\|TAB\\)" desc
)
177 (setq desc
(replace-match "<\\&>" nil nil desc
)))
179 (let ((msg (with-current-buffer (get-buffer-create "*Calc Summary*")
180 (if (= (buffer-size) 0)
182 (message "Reading Calc summary from manual...")
183 (require 'info nil t
)
186 (Info-goto-node "(Calc)Summary")
187 (goto-char (point-min))
189 (copy-to-buffer "*Calc Summary*"
190 (point) (point-max)))
191 (setq buffer-read-only t
)))
192 (goto-char (point-min))
193 (setq case-fold-search nil
)
194 (re-search-forward "^\\(.*\\)\\[\\.\\. a b")
195 (setq calc-summary-indentation
196 (- (match-end 1) (match-beginning 1)))
197 (goto-char (point-min))
198 (setq target
(if (and (string-match "[0-9]\\'" desc
)
199 (not (string-match "[d#]" desc
)))
200 (concat (substring desc
0 -
1) "0-9")
202 (if (re-search-forward
203 (format "\n%s%s%s%s[ a-zA-Z]"
204 (make-string (+ calc-summary-indentation
9)
206 (if (string-match "M-#" desc
) " "
208 (if hyp
"I H " " I ")
210 (regexp-quote target
)
211 (make-string (max (- 6 (length target
)) 0)
216 (forward-char calc-summary-indentation
)
219 (buffer-substring pt
(point)))))))
221 (let ((args (substring msg
0 9))
222 (keys (substring msg
9 19))
223 (prompts (substring msg
19 38))
225 (cmd (substring msg
40))
227 (if (string-match "\\` +" args
)
228 (setq args
(substring args
(match-end 0))))
229 (if (string-match " +\\'" args
)
230 (setq args
(substring args
0 (match-beginning 0))))
231 (if (string-match "\\` +" keys
)
232 (setq keys
(substring keys
(match-end 0))))
233 (if (string-match " +\\'" keys
)
234 (setq keys
(substring keys
0 (match-beginning 0))))
235 (if (string-match " [0-9,]+\\'" prompts
)
236 (setq notes
(substring prompts
(1+ (match-beginning 0)))
237 prompts
(substring prompts
0 (match-beginning 0))))
238 (if (string-match " +\\'" prompts
)
239 (setq prompts
(substring prompts
0 (match-beginning 0))))
240 (if (string-match "\\` +" prompts
)
241 (setq prompts
(substring prompts
(match-end 0))))
242 (setq msg
(format-message
243 "%s: %s%s‘%s’%s%s %s%s"
245 "\\`\\(calc-[-a-zA-Z0-9]+\\) *\\(.*\\)\\'"
247 (prog1 (math-match-substring cmd
1)
248 (setq cmd
(math-match-substring cmd
2)))
250 args
(if (equal args
"") "" " ")
252 (if (equal prompts
"") "" " ") prompts
253 (if (equal cmd
"") "" " => ") cmd
))
254 (message "%s%s%s runs %s%s"
255 (if inv
"I " "") (if hyp
"H " "") desc
257 (if (equal notes
"") ""
258 (format " (?=notes %s)" notes
)))
259 (let ((key (calc-read-key t
)))
260 (if (eq (car key
) ??
)
262 (message "No notes for this command")
263 (while (string-match "," notes
)
264 (aset notes
(match-beginning 0) ?
))
265 (setq notes
(sort (car (read-from-string
266 (format "(%s)" notes
)))
268 (with-output-to-temp-buffer "*Help*"
269 (princ (format "%s\n\n" msg
))
270 (set-buffer "*Calc Summary*")
271 (re-search-forward "^ *NOTES")
274 (format "^ *%d\\. " (car notes
)))
278 (or (re-search-forward "^ ? ?[0-9]+\\. " nil t
)
279 (goto-char (point-max)))
281 (princ (buffer-substring pt
(point))))
282 (setq notes
(cdr notes
)))
283 (help-print-return-message)))
284 (calc-unread-command (cdr key
)))))
285 (if (or (null defn
) (integerp defn
))
286 (message "%s is undefined" desc
)
287 (message "%s runs the command %s"
289 (if (symbolp defn
) defn
(prin1-to-string defn
))))))
290 (if inv
(setq desc
(concat "I " desc
)))
291 (if hyp
(setq desc
(concat "H " desc
)))
292 (calc-describe-thing desc
"Key Index" nil
293 (string-match "[A-Z][A-Z][A-Z]" desc
))))))
295 (defvar calc-help-function-list nil
296 "List of functions provided by Calc.")
298 (defvar calc-help-variable-list nil
299 "List of variables provided by Calc.")
301 (defun calc-help-index-entries (&rest indices
)
302 "Create a list of entries from the INDICES in the Calc info manual."
303 (let ((entrylist '())
305 (require 'info nil t
)
310 (Info-goto-node (concat "(Calc)" (car indices
) " Index"))
311 (goto-char (point-min))
312 (while (re-search-forward "\n\\* \\(.*\\): " nil t
)
313 (setq entry
(match-string 1))
314 (if (and (not (string-match "<[1-9]+>" entry
))
315 (not (string-match "(.*)" entry
))
316 (not (string= entry
"Menu")))
317 (unless (assoc entry entrylist
)
318 (setq entrylist
(cons entry entrylist
))))))
320 (setq indices
(cdr indices
)))
323 (defun calc-describe-function (&optional func
)
325 (unless calc-help-function-list
326 (setq calc-help-function-list
327 (calc-help-index-entries "Function" "Command")))
329 (setq func
(completing-read "Describe function: "
330 calc-help-function-list
332 (if (string-match "\\`calc-." func
)
333 (calc-describe-thing func
"Command Index")
334 (calc-describe-thing func
"Function Index")))
336 (defun calc-describe-variable (&optional var
)
338 (unless calc-help-variable-list
339 (setq calc-help-variable-list
340 (calc-help-index-entries "Variable")))
342 (setq var
(completing-read "Describe variable: "
343 calc-help-variable-list
345 (calc-describe-thing var
"Variable Index"))
347 (defun calc-describe-thing (thing where
&optional target not-quoted
)
348 (message "Looking for ‘%s’ in %s..." thing where
)
349 (let ((savewin (current-window-configuration)))
350 (calc-info-goto-node where
)
351 (or (let ((case-fold-search nil
))
352 (re-search-forward (format "\n\\* +%s: \\(.*\\)\\."
353 (regexp-quote thing
))
355 (and (string-match "\\`\\([a-z ]*\\)[0-9]\\'" thing
)
356 (re-search-forward (format "\n\\* +%s[01]-9: \\(.*\\)\\."
357 (substring thing
0 -
1))
359 (setq thing
(format "%s9" (substring thing
0 -
1))))
363 (set-window-configuration savewin
)
364 (error "Can't find ‘%s’ in %s" thing where
)))
366 (Info-goto-node (buffer-substring (match-beginning 1) (match-end 1))))
367 (let* ((string-target (or target thing
))
368 (quoted (format "['`‘]%s['’]" (regexp-quote string-target
)))
369 (bracketed (format "\\[%s\\]\\|(%s)\\|\\<The[ \n]%s"
370 quoted quoted quoted
)))
371 (or (let ((case-fold-search nil
))
372 (or (re-search-forward bracketed nil t
)
374 (let ((case-fold-search t
))
375 (search-forward string-target nil t
)))
376 (re-search-forward quoted nil t
)
377 (search-forward string-target nil t
)))
378 (let ((case-fold-search t
))
379 (or (re-search-forward bracketed nil t
)
380 (re-search-forward quoted nil t
)
381 (search-forward string-target nil t
)))))
383 (message "Found ‘%s’ in %s" thing where
)))
385 (defun calc-view-news ()
389 (re-search-forward "^\*+ .*\\<Calc\\>" nil t
))
391 (defvar calc-help-long-names
'((?b .
"binary/business")
394 (?k .
"combinatorics/statistics")
395 (?u .
"units/statistics")))
397 (defun calc-full-help ()
399 (with-output-to-temp-buffer "*Help*"
400 (princ "GNU Emacs Calculator.\n")
401 (princ " By Dave Gillespie.\n")
402 (princ (format " %s\n\n" emacs-copyright
))
403 (princ (format-message "Type ‘h s’ for a more detailed summary.\n"))
404 (princ (format-message
405 "Or type ‘h i’ to read the full Calc manual on-line.\n\n"))
406 (princ "Basic keys:\n")
407 (let* ((calc-full-help-flag t
))
408 (mapc (function (lambda (x) (princ (format
410 (substitute-command-keys x
)))))
411 (nreverse (cdr (reverse (cdr (calc-help))))))
412 (mapc (function (lambda (prefix)
413 (let ((msgs (condition-case err
418 (if (eq (nth 2 msgs
) ?v
)
420 "\n‘v’ or ‘V’ prefix (vector/matrix) keys: \n")
423 "\n‘%c’ prefix (%s) keys:\n"
425 (or (cdr (assq (nth 2 msgs
)
426 calc-help-long-names
))
428 (format "\n%s-modified keys:\n"
429 (capitalize (nth 1 msgs
)))))))
434 (substitute-command-keys x
)))))
436 '(calc-inverse-prefix-help
437 calc-hyperbolic-prefix-help
438 calc-inv-hyp-prefix-help
439 calc-option-prefix-help
456 calc-shift-Y-prefix-help
457 calc-shift-Z-prefix-help
458 calc-z-prefix-help
)))
459 (help-print-return-message)))
461 (defun calc-h-prefix-help ()
464 '("Help; Bindings; Info, Tutorial, Summary; News"
465 "describe: Key, C (briefly), Function, Variable")
468 (defun calc-inverse-prefix-help ()
471 '("I + S (arcsin), C (arccos), T (arctan); Q (square)"
472 "I + E (ln), L (exp), B (alog: B^X); f E (lnp1), f L (expm1)"
473 "I + F (ceiling), R (truncate); a S (invert func)"
474 "I + a m (match-not); c h (from-hms); k n (prev prime)"
475 "I + f G (gamma-Q); f e (erfc); k B (etc., lower-tail dists)"
476 "I + V S (reverse sort); V G (reverse grade)"
477 "I + v s (remove subvec); v h (tail)"
478 "I + t + (alt sum), t M (mean with error)"
479 "I + t S (pop std dev), t C (pop covar)")
482 (defun calc-hyperbolic-prefix-help ()
485 '("H + S (sinh), C (cosh), T (tanh); E (exp10), L (log10)"
486 "H + F (float floor), R (float round); P (constant \"e\")"
487 "H + a d (total derivative); k c (permutations)"
488 "H + k b (bern-poly), k e (euler-poly); k s (stirling-2)"
489 "H + f G (gamma-g), f B (beta-B); v h (rhead), v k (rcons)"
490 "H + v e (expand w/filler); V H (weighted histogram)"
491 "H + a S (general solve eqn), j I (general isolate)"
492 "H + a R (widen/root), a N (widen/min), a X (widen/max)"
493 "H + t M (median), t S (variance), t C (correlation coef)"
494 "H + c f/F/c (pervasive float/frac/clean)")
497 (defun calc-inv-hyp-prefix-help ()
500 '("I H + S (arcsinh), C (arccosh), T (arctanh)"
501 "I H + E (log10), L (exp10); f G (gamma-G)"
502 "I H + F (float ceiling), R (float truncate)"
503 "I H + t S (pop variance)"
504 "I H + a S (general invert func); v h (rtail)")
505 "inverse-hyperbolic" nil
))
507 (defun calc-option-prefix-help ()
513 (defun calc-f-prefix-help ()
516 '("miN, maX; Hypot; Im, Re; Sign; [, ] (incr/decr)"
517 "Gamma, Beta, Erf, besselJ, besselY"
518 "SHIFT + int-sQrt; Int-log, Exp(x)-1, Ln(x+1); arcTan2"
519 "SHIFT + Abssqr; Mantissa, eXponent, Scale"
520 "SHIFT + incomplete: Gamma-P, Beta-I")
524 (defun calc-s-prefix-help ()
527 '("Store, inTo, Xchg, Unstore; Recall, 0-9; : (:=); = (=>)"
528 "Let; Copy, K=copy constant; Declare; Insert, Perm; Edit"
529 "Negate, +, -, *, /, ^, &, |, [, ]; Map"
530 "SHIFT + Decls, GenCount, TimeZone, Holidays; IntegLimit"
531 "SHIFT + LineStyles, PointStyles, plotRejects; Units"
532 "SHIFT + Eval-, AlgSimp-, ExtSimp-, FitRules")
535 (defun calc-r-prefix-help ()
538 '("digits 0-9: recall, same as `s r 0-9'"
539 "Save to register, Insert from register")
540 "recall/register" ?r
))
543 (defun calc-j-prefix-help ()
546 '("Select, Additional, Once; eVal, Formula; Rewrite"
547 "More, Less, 1-9, Next, Previous"
548 "Unselect, Clear; Display; Enable; Breakable"
549 "' (replace), \\=` (edit), +, -, *, /, RET (grab), DEL"
550 "SHIFT + swap: Left, Right; maybe: Select, Once"
551 "SHIFT + Commute, Merge, Distrib, jump-Eqn, Isolate"
552 "SHIFT + Negate, & (invert); Unpack")
556 (defun calc-a-prefix-help ()
559 '("Simplify, Extended-simplify, eVal; \" (exp-formula)"
560 "eXpand, Collect, Factor, Apart, Norm-rat"
561 "GCD, /, \\, % (polys); Polint"
562 "Derivative, Integral, Taylor; _ (subscr)"
563 "suBstitute; Rewrite, Match"
564 "SHIFT + Solve; Root, miN, maX; Poly-roots; Fit"
565 "SHIFT + Map; Tabulate, + (sum), * (prod); num-Integ"
566 "relations: =, # (not =), <, >, [ (< or =), ] (> or =)"
567 "logical: & (and), | (or), ! (not); : (if)"
568 "misc: { (in-set); . (rmeq)")
572 (defun calc-b-prefix-help ()
575 '("And, Or, Xor, Diff, Not; Wordsize, Clip"
576 "Lshift, Rshift, roTate; SHIFT + signed Lshift, Rshift"
577 "SHIFT + business: Pv, Npv, Fv, pMt, #pmts, raTe, Irr"
578 "SHIFT + business: Sln, sYd, Ddb; %ch")
582 (defun calc-c-prefix-help ()
585 '("Deg, Rad, HMS; Float; Polar/rect; Clean, 0-9; %"
590 (defun calc-d-prefix-help ()
593 '("Group, \",\"; Normal, Fix, Sci, Eng, \".\"; Over"
594 "Radix, Zeros, 2, 8, 0, 6; Hms; Date; Complex, I, J"
595 "Why; Line-nums, line-Breaks; <, =, > (justify); Plain"
596 "\" (strings); Truncate, [, ]; SPC (refresh), RET, @"
597 "SHIFT + language: Normal, One-line, Big, Unformatted"
598 "SHIFT + language: C, Pascal, Fortran; TeX, LaTeX, Eqn"
599 "SHIFT + language: Yacas, X=Maxima, A=Giac"
600 "SHIFT + language: Mathematica, W=Maple")
604 (defun calc-g-prefix-help ()
607 '("Fast; Add, Delete, Juggle; Plot, Clear; Quit"
608 "Header, Name, Grid, Border, Key; View-commands, X-display"
609 "x-axis: Range, Title, Log, Zero; lineStyle"
610 "SHIFT + y-axis: Range, Title, Log, Zero; pointStyle"
611 "SHIFT + Print; Device, Output-file; X-geometry"
612 "SHIFT + Num-pts; Command, Kill, View-trail"
613 "SHIFT + 3d: Fast, Add; CTRL + z-axis: Range, Title, Log")
617 (defun calc-k-prefix-help ()
620 '("GCD, LCM; Choose (binomial), Double-factorial"
621 "Random, random-Again, sHuffle"
622 "Factors, Prime-test, Next-prime, Totient, Moebius"
623 "Bernoulli, Euler, Stirling"
624 "SHIFT + Extended-gcd"
625 "SHIFT + dists: Binomial, Chi-square, F, Normal"
626 "SHIFT + dists: Poisson, student's-T")
630 (defun calc-m-prefix-help ()
633 '("Deg, Rad, HMS; Frac; Polar; Inf; Alg, Total; Symb; Vec/mat"
634 "Working; Xtensions; Mode-save; preserve Embedded modes"
635 "SHIFT + Shifted-prefixes, mode-Filename; Record; reCompute"
636 "SHIFT + simplify: Off, Num, basIc, Algebraic, Bin, Ext, Units")
640 (defun calc-t-prefix-help ()
643 '("Display; Fwd, Back; Next, Prev, Here, [, ]; Yank"
644 "Search, Rev; In, Out; <, >; Kill; Marker; . (abbrev)"
645 "SHIFT + time: Now; Part; Date, Julian, Unix, Czone"
646 "SHIFT + time: newWeek, newMonth, newYear; Incmonth"
647 "SHIFT + time: +, - (business days)"
648 "digits 0-9: store-to, same as `s t 0-9'")
652 (defun calc-u-prefix-help ()
655 '("Simplify, Convert, coNvert exact, Temperature-convert, Base-units"
656 "Autorange; Remove, eXtract; Explain; View-table; 0-9"
657 "Define, Undefine, Get-defn, Permanent"
658 "SHIFT + View-table-other-window"
659 "SHIFT + stat: Mean, G-mean, Std-dev, Covar, maX, miN"
660 "SHIFT + stat: + (sum), - (asum), * (prod), # (count)")
663 (defun calc-l-prefix-help ()
666 '("Quantity, DB level, Np level"
668 "Scientific pitch notation, Midi number, Frequency"
672 (defun calc-v-prefix-help ()
675 '("Pack, Unpack, Identity, Diagonal, indeX, Build"
676 "Row, Column, Subvector; Length; Find; Mask, Expand"
677 "Transpose, Arrange, reVerse; Head, Kons; rNorm"
678 "SHIFT + Det, & (inverse), LUD, Trace, conJtrn, Cross"
679 "SHIFT + Sort, Grade, Histogram; cNorm"
680 "SHIFT + Apply, Map, Reduce, accUm, Inner-, Outer-prod"
681 "SHIFT + sets: V (union), ^ (intersection), - (diff)"
682 "SHIFT + sets: Xor, ~ (complement), Floor, Enum"
683 "SHIFT + sets: : (span), # (card), + (rdup)"
684 "<, =, > (justification); , (commas); [, {, ( (brackets)"
685 "} (matrix brackets); . (abbreviate); / (multi-lines)")
690 ;;; calc-help.el ends here