Mercurial > emacs
view lisp/calc/calc-help.el @ 45098:06120f91eb06
(eshell-modify-global-environment): Added this customization variable,
which will cause any "export" commands within any eshell buffer to
modify the global Emacs environment. It defaults to nil, which means
that such commands will only modify that Eshell buffer's environment.
(eshell-var-initialize): Initialize `eshell-modify-global-environment'.
author | John Wiegley <johnw@newartisans.com> |
---|---|
date | Fri, 03 May 2002 20:43:53 +0000 |
parents | fcd507927105 |
children | 955efae16491 |
line wrap: on
line source
;;; calc-help.el --- help display functions for Calc, ;; Copyright (C) 1990, 1991, 1992, 1993, 2001 Free Software Foundation, Inc. ;; Author: David Gillespie <daveg@synaptics.com> ;; Maintainer: Colin Walters <walters@debian.org> ;; This file is part of GNU Emacs. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY. No author or distributor ;; accepts responsibility to anyone for the consequences of using it ;; or for whether it serves any particular purpose or works at all, ;; unless he says so in writing. Refer to the GNU Emacs General Public ;; License for full details. ;; Everyone is granted permission to copy, modify and redistribute ;; GNU Emacs, but only under the conditions described in the ;; GNU Emacs General Public License. A copy of this license is ;; supposed to have been given to you along with GNU Emacs so you ;; can know your rights and responsibilities. It should be in a ;; file named COPYING. Among other things, the copyright notice ;; and this notice must be preserved on all copies. ;;; Commentary: ;;; Code: ;; This file is autoloaded from calc-ext.el. (require 'calc-ext) (require 'calc-macs) (defun calc-Need-calc-help () nil) (defun calc-help-prefix (arg) "This key is the prefix for Calc help functions. See calc-help-for-help." (interactive "P") (or calc-dispatch-help (sit-for echo-keystrokes)) (let ((key (calc-read-key-sequence (if calc-dispatch-help "Calc Help options: Help, Info, Tutorial, Summary; Key, Function; ?=more" (format "%s (Type ? for a list of Calc Help options)" (key-description (this-command-keys)))) calc-help-map))) (setq key (lookup-key calc-help-map key)) (message "") (if key (call-interactively key) (beep)))) (defun calc-help-for-help (arg) "You have typed `h', the Calc help character. Type a Help option: B calc-describe-bindings. Display a table of all key bindings. H calc-full-help. Display all `?' key messages at once. I calc-info. Read the Calc manual using the Info system. T calc-tutorial. Read the Calc tutorial using the Info system. S calc-info-summary. Read the Calc summary using the Info system. C calc-describe-key-briefly. Look up the command name for a given key. K calc-describe-key. Look up a key's documentation in the manual. F calc-describe-function. Look up a function's documentation in the manual. V calc-describe-variable. Look up a variable's documentation in the manual. N calc-view-news. Display Calc history of changes. C-c Describe conditions for copying Calc. C-d Describe how you can get a new copy of Calc or report a bug. C-w Describe how there is no warranty for Calc." (interactive "P") (if calc-dispatch-help (let (key) (save-window-excursion (describe-function 'calc-help-for-help) (select-window (get-buffer-window "*Help*")) (while (progn (message "Calc Help options: Help, Info, ... press SPC, DEL to scroll, C-g to cancel") (memq (car (setq key (calc-read-key t))) '(? ?\C-h ?\C-? ?\C-v ?\M-v))) (condition-case err (if (memq (car key) '(? ?\C-v)) (scroll-up) (scroll-down)) (error (beep))))) (calc-unread-command (cdr key)) (calc-help-prefix nil)) (let ((calc-dispatch-help t)) (calc-help-prefix arg)))) (defun calc-describe-copying () (interactive) (calc-info) (Info-goto-node "Copying")) (defun calc-describe-distribution () (interactive) (calc-info) (Info-goto-node "Reporting Bugs")) (defun calc-describe-no-warranty () (interactive) (calc-info) (Info-goto-node "Copying") (let ((case-fold-search nil)) (search-forward " NO WARRANTY")) (beginning-of-line) (recenter 0)) (defun calc-describe-bindings () (interactive) (describe-bindings) (save-excursion (set-buffer "*Help*") (goto-char (point-min)) (if (search-forward "Global bindings:" nil t) (delete-region (match-beginning 0) (point-max))) (goto-char (point-min)) (while (re-search-forward "\n[a-z] ESC" nil t) (end-of-line) (delete-region (match-beginning 0) (point))) (goto-char (point-min)) (while (re-search-forward "\nESC m" nil t) (end-of-line) (delete-region (match-beginning 0) (point))) (goto-char (point-min)) (while (search-forward "\n\n\n" nil t) (backward-delete-char 1) (backward-char 2)) (goto-char (point-min)) (while (re-search-forward "\n[a-z] [0-9]\\(\t\t.*\n\\)\\([a-z] [0-9]\\1\\)*[a-z] \\([0-9]\\)\\1" nil t) (let ((dig1 (char-after (1- (match-beginning 1)))) (dig2 (char-after (match-beginning 3)))) (delete-region (match-end 1) (match-end 0)) (goto-char (match-beginning 1)) (delete-backward-char 1) (delete-char 1) (insert (format "%c .. %c" (min dig1 dig2) (max dig1 dig2))))) (goto-char (point-min)))) (defun calc-describe-key-briefly (key) (interactive "kDescribe key briefly: ") (calc-describe-key key t)) (defun calc-describe-key (key &optional briefly) (interactive "kDescribe key: ") (let ((defn (if (eq (key-binding key) 'calc-dispatch) (let ((key2 (calc-read-key-sequence (format "Describe key briefly: %s-" (key-description key)) calc-dispatch-map))) (setq key (concat key key2)) (lookup-key calc-dispatch-map key2)) (if (eq (key-binding key) 'calc-help-prefix) (let ((key2 (calc-read-key-sequence (format "Describe key briefly: %s-" (key-description key)) calc-help-map))) (setq key (concat key key2)) (lookup-key calc-help-map key2)) (key-binding key)))) (inv nil) (hyp nil)) (while (or (equal key "I") (equal key "H")) (if (equal key "I") (setq inv (not inv)) (setq hyp (not hyp))) (setq key (read-key-sequence (format "Describe key%s:%s%s " (if briefly " briefly" "") (if inv " I" "") (if hyp " H" ""))) defn (key-binding key))) (let ((desc (key-description key)) target) (if (string-match "^ESC " desc) (setq desc (concat "M-" (substring desc 4)))) (while (string-match "^M-# \\(ESC \\|C-\\)" desc) (setq desc (concat "M-# " (substring desc (match-end 0))))) (if briefly (let ((msg (save-excursion (set-buffer (get-buffer-create "*Calc Summary*")) (if (= (buffer-size) 0) (progn (message "Reading Calc summary from manual...") (save-window-excursion (save-excursion (calc-info) (Info-goto-node "Summary") (goto-char (point-min)) (forward-line 1) (copy-to-buffer "*Calc Summary*" (point) (point-max)) (Info-last))) (setq case-fold-search nil) (re-search-forward "^\\(.*\\)\\[\\.\\. a b") (setq calc-summary-indentation (- (match-end 1) (match-beginning 1))))) (goto-char (point-min)) (setq target (if (and (string-match "[0-9]\\'" desc) (not (string-match "[d#]" desc))) (concat (substring desc 0 -1) "0-9") desc)) (if (re-search-forward (format "\n%s%s%s%s[ a-zA-Z]" (make-string (+ calc-summary-indentation 9) ?\.) (if (string-match "M-#" desc) " " (if inv (if hyp "I H " " I ") (if hyp " H " " "))) (regexp-quote target) (make-string (max (- 6 (length target)) 0) ?\ )) nil t) (let (pt) (beginning-of-line) (forward-char calc-summary-indentation) (setq pt (point)) (end-of-line) (buffer-substring pt (point))))))) (if msg (let ((args (substring msg 0 9)) (keys (substring msg 9 19)) (prompts (substring msg 19 38)) (notes "") (cmd (substring msg 40)) msg) (if (string-match "\\` +" args) (setq args (substring args (match-end 0)))) (if (string-match " +\\'" args) (setq args (substring args 0 (match-beginning 0)))) (if (string-match "\\` +" keys) (setq keys (substring keys (match-end 0)))) (if (string-match " +\\'" keys) (setq keys (substring keys 0 (match-beginning 0)))) (if (string-match " [0-9,]+\\'" prompts) (setq notes (substring prompts (1+ (match-beginning 0))) prompts (substring prompts 0 (match-beginning 0)))) (if (string-match " +\\'" prompts) (setq prompts (substring prompts 0 (match-beginning 0)))) (if (string-match "\\` +" prompts) (setq prompts (substring prompts (match-end 0)))) (setq msg (format "%s: %s%s`%s'%s%s %s%s" (if (string-match "\\`\\(calc-[-a-zA-Z0-9]+\\) *\\(.*\\)\\'" cmd) (prog1 (math-match-substring cmd 1) (setq cmd (math-match-substring cmd 2))) defn) args (if (equal args "") "" " ") keys (if (equal prompts "") "" " ") prompts (if (equal cmd "") "" " => ") cmd)) (message "%s%s%s runs %s%s" (if inv "I " "") (if hyp "H " "") desc msg (if (equal notes "") "" (format " (?=notes %s)" notes))) (let ((key (calc-read-key t))) (if (eq (car key) ??) (if (equal notes "") (message "No notes for this command") (while (string-match "," notes) (aset notes (match-beginning 0) ? )) (setq notes (sort (car (read-from-string (format "(%s)" notes))) '<)) (with-output-to-temp-buffer "*Help*" (princ (format "%s\n\n" msg)) (set-buffer "*Calc Summary*") (re-search-forward "^ *NOTES") (while notes (re-search-forward (format "^ *%d\\. " (car notes))) (beginning-of-line) (let ((pt (point))) (forward-line 1) (or (re-search-forward "^ ? ?[0-9]+\\. " nil t) (goto-char (point-max))) (beginning-of-line) (princ (buffer-substring pt (point)))) (setq notes (cdr notes))) (print-help-return-message))) (calc-unread-command (cdr key))))) (if (or (null defn) (integerp defn)) (message "%s is undefined" desc) (message "%s runs the command %s" desc (if (symbolp defn) defn (prin1-to-string defn)))))) (if inv (setq desc (concat "I " desc))) (if hyp (setq desc (concat "H " desc))) (calc-describe-thing desc "Key Index" nil (string-match "[A-Z][A-Z][A-Z]" desc)))))) (defun calc-describe-function (&optional func) (interactive) (or func (setq func (intern (completing-read "Describe function: " obarray nil t "calcFunc-")))) (setq func (symbol-name func)) (if (string-match "\\`calc-." func) (calc-describe-thing func "Command Index") (calc-describe-thing (if (string-match "\\`calcFunc-." func) (substring func 9) func) "Function Index"))) (defun calc-describe-variable (&optional var) (interactive) (or var (setq var (intern (completing-read "Describe variable: " obarray nil t "var-")))) (setq var (symbol-name var)) (calc-describe-thing var "Variable Index" (if (string-match "\\`var-." var) (substring var 4) var))) (defun calc-describe-thing (thing where &optional target not-quoted) (message "Looking for `%s' in %s..." thing where) (let ((savewin (current-window-configuration))) (calc-info) (Info-goto-node where) (or (let ((case-fold-search nil)) (re-search-forward (format "\n\\* +%s: \\(.*\\)\\." (regexp-quote thing)) nil t)) (and (string-match "\\`\\([a-z ]*\\)[0-9]\\'" thing) (re-search-forward (format "\n\\* +%s[01]-9: \\(.*\\)\\." (substring thing 0 -1)) nil t) (setq thing (format "%s9" (substring thing 0 -1)))) (progn (Info-last) (set-window-configuration savewin) (error "Can't find `%s' in %s" thing where))) (let (Info-history) (Info-goto-node (buffer-substring (match-beginning 1) (match-end 1)))) (or (let ((case-fold-search nil)) (or (search-forward (format "\\[`%s'\\]\\|(`%s')\\|\\<The[ \n]`%s'" (or target thing) (or target thing) (or target thing)) nil t) (and not-quoted (let ((case-fold-search t)) (search-forward (or target thing) nil t))) (search-forward (format "`%s'" (or target thing)) nil t) (search-forward (or target thing) nil t))) (let ((case-fold-search t)) (or (search-forward (format "\\[`%s'\\]\\|(`%s')\\|\\<The[ \n]`%s'" (or target thing) (or target thing) (or target thing)) nil t) (search-forward (format "`%s'" (or target thing)) nil t) (search-forward (or target thing) nil t)))) (beginning-of-line) (message "Found `%s' in %s" thing where))) (defun calc-view-news () (interactive) (let ((path load-path)) (while (and path (not (file-exists-p (expand-file-name "calc.el" (car path))))) (setq path (cdr path))) (or (and path (file-exists-p (expand-file-name "README" (car path)))) (error "Can't locate Calc sources")) (calc-quit) (switch-to-buffer "*Help*") (erase-buffer) (insert-file-contents (expand-file-name "README" (car path))) (search-forward "Summary of changes") (forward-line -1) (delete-region (point-min) (point)) (goto-char (point-min)))) (defun calc-full-help () (interactive) (with-output-to-temp-buffer "*Help*" (princ (format "GNU Emacs Calculator version %s of %s.\n" calc-version calc-version-date)) (princ " By Dave Gillespie, daveg@synaptics.com.\n") (princ " Copyright (C) 1990, 1993 Free Software Foundation, Inc.\n\n") (princ "Type `h s' for a more detailed summary.\n") (princ "Or type `h i' to read the full Calc manual on-line.\n\n") (princ "Basic keys:\n") (let* ((calc-full-help-flag t)) (mapcar (function (lambda (x) (princ (format " %s\n" x)))) (nreverse (cdr (reverse (cdr (calc-help)))))) (mapcar (function (lambda (prefix) (let ((msgs (condition-case err (funcall prefix) (error nil)))) (if (car msgs) (princ (if (eq (nth 2 msgs) ?v) "\n`v' or `V' prefix (vector/matrix) keys: \n" (if (nth 2 msgs) (format "\n`%c' prefix (%s) keys:\n" (nth 2 msgs) (or (cdr (assq (nth 2 msgs) calc-help-long-names)) (nth 1 msgs))) (format "\n%s-modified keys:\n" (capitalize (nth 1 msgs))))))) (mapcar (function (lambda (x) (princ (format " %s\n" x)))) (car msgs))))) '(calc-inverse-prefix-help calc-hyperbolic-prefix-help calc-inv-hyp-prefix-help calc-a-prefix-help calc-b-prefix-help calc-c-prefix-help calc-d-prefix-help calc-f-prefix-help calc-g-prefix-help calc-h-prefix-help calc-j-prefix-help calc-k-prefix-help calc-m-prefix-help calc-r-prefix-help calc-s-prefix-help calc-t-prefix-help calc-u-prefix-help calc-v-prefix-help calc-shift-Y-prefix-help calc-shift-Z-prefix-help calc-z-prefix-help))) (print-help-return-message))) (defvar calc-help-long-names '((?b . "binary/business") (?g . "graphics") (?j . "selection") (?k . "combinatorics/statistics") (?u . "units/statistics"))) (defun calc-h-prefix-help () (interactive) (calc-do-prefix-help '("Help; Bindings; Info, Tutorial, Summary; News" "describe: Key, C (briefly), Function, Variable") "help" ?h)) (defun calc-inverse-prefix-help () (interactive) (calc-do-prefix-help '("I + S (arcsin), C (arccos), T (arctan); Q (square)" "I + E (ln), L (exp), B (alog: B^X); f E (lnp1), f L (expm1)" "I + F (ceiling), R (truncate); a S (invert func)" "I + a m (match-not); c h (from-hms); k n (prev prime)" "I + f G (gamma-Q); f e (erfc); k B (etc., lower-tail dists)" "I + V S (reverse sort); V G (reverse grade)" "I + v s (remove subvec); v h (tail)" "I + t + (alt sum), t M (mean with error)" "I + t S (pop std dev), t C (pop covar)") "inverse" nil)) (defun calc-hyperbolic-prefix-help () (interactive) (calc-do-prefix-help '("H + S (sinh), C (cosh), T (tanh); E (exp10), L (log10)" "H + F (float floor), R (float round); P (constant \"e\")" "H + a d (total derivative); k c (permutations)" "H + k b (bern-poly), k e (euler-poly); k s (stirling-2)" "H + f G (gamma-g), f B (beta-B); v h (rhead), v k (rcons)" "H + v e (expand w/filler); V H (weighted histogram)" "H + a S (general solve eqn), j I (general isolate)" "H + a R (widen/root), a N (widen/min), a X (widen/max)" "H + t M (median), t S (variance), t C (correlation coef)" "H + c f/F/c (pervasive float/frac/clean)") "hyperbolic" nil)) (defun calc-inv-hyp-prefix-help () (interactive) (calc-do-prefix-help '("I H + S (arcsinh), C (arccosh), T (arctanh)" "I H + E (log10), L (exp10); f G (gamma-G)" "I H + F (float ceiling), R (float truncate)" "I H + t S (pop variance)" "I H + a S (general invert func); v h (rtail)") "inverse-hyperbolic" nil)) (defun calc-f-prefix-help () (interactive) (calc-do-prefix-help '("miN, maX; Hypot; Im, Re; Sign; [, ] (incr/decr)" "Gamma, Beta, Erf, besselJ, besselY" "SHIFT + int-sQrt; Int-log, Exp(x)-1, Ln(x+1); arcTan2" "SHIFT + Abssqr; Mantissa, eXponent, Scale" "SHIFT + incomplete: Gamma-P, Beta-I") "functions" ?f)) (defun calc-s-prefix-help () (interactive) (calc-do-prefix-help '("Store, inTo, Xchg, Unstore; Recall, 0-9; : (:=); = (=>)" "Let; Copy; Declare; Insert, Perm; Edit" "Negate, +, -, *, /, ^, &, |, [, ]; Map" "SHIFT + Decls, GenCount, TimeZone, Holidays; IntegLimit" "SHIFT + LineStyles, PointStyles, plotRejects; Units" "SHIFT + Eval-, AlgSimp-, ExtSimp-, FitRules") "store" ?s)) (defun calc-r-prefix-help () (interactive) (calc-do-prefix-help '("digits 0-9: recall, same as `s r 0-9'") "recall" ?r)) (defun calc-j-prefix-help () (interactive) (calc-do-prefix-help '("Select, Additional, Once; eVal, Formula; Rewrite" "More, Less, 1-9, Next, Previous" "Unselect, Clear; Display; Enable; Breakable" "' (replace), ` (edit), +, -, *, /, RET (grab), DEL" "SHIFT + swap: Left, Right; maybe: Select, Once" "SHIFT + Commute, Merge, Distrib, jump-Eqn, Isolate" "SHIFT + Negate, & (invert); Unpack") "select" ?j)) (defun calc-a-prefix-help () (interactive) (calc-do-prefix-help '("Simplify, Extended-simplify, eVal; \" (exp-formula)" "eXpand, Collect, Factor, Apart, Norm-rat" "GCD, /, \\, % (polys); Polint" "Derivative, Integral, Taylor; _ (subscr)" "suBstitute; Rewrite, Match" "SHIFT + Solve; Root, miN, maX; Poly-roots; Fit" "SHIFT + Map; Tabulate, + (sum), * (prod); num-Integ" "relations: =, # (not =), <, >, [ (< or =), ] (> or =)" "logical: & (and), | (or), ! (not); : (if)" "misc: { (in-set); . (rmeq)") "algebra" ?a)) (defun calc-b-prefix-help () (interactive) (calc-do-prefix-help '("And, Or, Xor, Diff, Not; Wordsize, Clip" "Lshift, Rshift, roTate; SHIFT + signed Lshift, Rshift" "SHIFT + business: Pv, Npv, Fv, pMt, #pmts, raTe, Irr" "SHIFT + business: Sln, sYd, Ddb; %ch") "binary/bus" ?b)) (defun calc-c-prefix-help () (interactive) (calc-do-prefix-help '("Deg, Rad, HMS; Float; Polar/rect; Clean, 0-9; %" "SHIFT + Fraction") "convert" ?c)) (defun calc-d-prefix-help () (interactive) (calc-do-prefix-help '("Group, \",\"; Normal, Fix, Sci, Eng, \".\"; Over" "Radix, Zeros, 2, 8, 0, 6; Hms; Date; Complex, I, J" "Why; Line-nums, line-Breaks; <, =, > (justify); Plain" "\" (strings); Truncate, [, ]; SPC (refresh), RET" "SHIFT + language: Normal, One-line, Big, Unformatted" "SHIFT + language: C, Pascal, Fortran; TeX, Eqn" "SHIFT + language: Mathematica, W=Maple") "display" ?d)) (defun calc-g-prefix-help () (interactive) (calc-do-prefix-help '("Fast; Add, Delete, Juggle; Plot, Clear; Quit" "Header, Name, Grid, Border, Key; View-commands, X-display" "x-axis: Range, Title, Log, Zero; lineStyle" "SHIFT + y-axis: Range, Title, Log, Zero; pointStyle" "SHIFT + Print; Device, Output-file; X-geometry" "SHIFT + Num-pts; Command, Kill, View-trail" "SHIFT + 3d: Fast, Add; CTRL + z-axis: Range, Title, Log") "graph" ?g)) (defun calc-k-prefix-help () (interactive) (calc-do-prefix-help '("GCD, LCM; Choose (binomial), Double-factorial" "Random, random-Again, sHuffle" "Factors, Prime-test, Next-prime, Totient, Moebius" "Bernoulli, Euler, Stirling" "SHIFT + Extended-gcd" "SHIFT + dists: Binomial, Chi-square, F, Normal" "SHIFT + dists: Poisson, student's-T") "combinatorics" ?k)) (defun calc-m-prefix-help () (interactive) (calc-do-prefix-help '("Deg, Rad, HMS; Frac; Polar; Inf; Alg, Total; Symb; Vec/mat" "Working; Xtensions; Mode-save" "SHIFT + Shifted-prefixes, mode-Filename; Record; reCompute" "SHIFT + simplify: Off, Num, Default, Bin, Alg, Ext, Units") "mode" ?m)) (defun calc-t-prefix-help () (interactive) (calc-do-prefix-help '("Display; Fwd, Back; Next, Prev, Here, [, ]; Yank" "Search, Rev; In, Out; <, >; Kill; Marker; . (abbrev)" "SHIFT + time: Now; Part; Date, Julian, Unix, Czone" "SHIFT + time: newWeek, newMonth, newYear; Incmonth" "SHIFT + time: +, - (business days)" "digits 0-9: store-to, same as `s t 0-9'") "trail/time" ?t)) (defun calc-u-prefix-help () (interactive) (calc-do-prefix-help '("Simplify, Convert, Temperature-convert, Base-units" "Autorange; Remove, eXtract; Explain; View-table; 0-9" "Define, Undefine, Get-defn, Permanent" "SHIFT + View-table-other-window" "SHIFT + stat: Mean, G-mean, Std-dev, Covar, maX, miN" "SHIFT + stat: + (sum), - (asum), * (prod), # (count)") "units/stat" ?u)) (defun calc-v-prefix-help () (interactive) (calc-do-prefix-help '("Pack, Unpack, Identity, Diagonal, indeX, Build" "Row, Column, Subvector; Length; Find; Mask, Expand" "Tranpose, Arrange, reVerse; Head, Kons; rNorm" "SHIFT + Det, & (inverse), LUD, Trace, conJtrn, Cross" "SHIFT + Sort, Grade, Histogram; cNorm" "SHIFT + Apply, Map, Reduce, accUm, Inner-, Outer-prod" "SHIFT + sets: V (union), ^ (intersection), - (diff)" "SHIFT + sets: Xor, ~ (complement), Floor, Enum" "SHIFT + sets: : (span), # (card), + (rdup)" "<, =, > (justification); , (commas); [, {, ( (brackets)" "} (matrix brackets); . (abbreviate); / (multi-lines)") "vec/mat" ?v)) ;;; calc-help.el ends here