1 ;;; calc-misc.el --- miscellaenous functions for Calc
3 ;; Copyright (C) 1990, 1991, 1992, 1993, 2001 Free Software Foundation, Inc.
5 ;; Author: David Gillespie <daveg@synaptics.com>
6 ;; Maintainer: Jay Belanger <belanger@truman.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is distributed in the hope that it will be useful,
11 ;; but WITHOUT ANY WARRANTY. No author or distributor
12 ;; accepts responsibility to anyone for the consequences of using it
13 ;; or for whether it serves any particular purpose or works at all,
14 ;; unless he says so in writing. Refer to the GNU Emacs General Public
15 ;; License for full details.
17 ;; Everyone is granted permission to copy, modify and redistribute
18 ;; GNU Emacs, but only under the conditions described in the
19 ;; GNU Emacs General Public License. A copy of this license is
20 ;; supposed to have been given to you along with GNU Emacs so you
21 ;; can know your rights and responsibilities. It should be in a
22 ;; file named COPYING. Among other things, the copyright notice
23 ;; and this notice must be preserved on all copies.
29 ;; This file is autoloaded from calc.el.
34 (defun calc-Need-calc-misc () nil)
37 (defun calc-dispatch-help (arg)
38 "M-# is a prefix key; follow it with one of these letters:
40 For turning Calc on and off:
41 C calc. Start the Calculator in a window at the bottom of the screen.
42 O calc-other-window. Start the Calculator but don't select its window.
43 B calc-big-or-small. Control whether to use the full Emacs screen for Calc.
44 Q quick-calc. Use the Calculator in the minibuffer.
45 K calc-keypad. Start the Calculator in keypad mode (X window system only).
46 E calc-embedded. Use the Calculator on a formula in this editing buffer.
47 J calc-embedded-select. Like E, but select appropriate half of => or :=.
48 W calc-embedded-word. Like E, but activate a single word, i.e., a number.
49 Z calc-user-invocation. Invoke Calc in the way you defined with `Z I' cmd.
50 X calc-quit. Turn Calc off.
52 For moving data into and out of Calc:
53 G calc-grab-region. Grab the region defined by mark and point into Calc.
54 R calc-grab-rectangle. Grab the rectangle defined by mark, point into Calc.
55 : calc-grab-sum-down. Grab a rectangle and sum the columns.
56 _ calc-grab-sum-across. Grab a rectangle and sum the rows.
57 Y calc-copy-to-buffer. Copy a value from the stack into the editing buffer.
59 For use with Embedded mode:
60 A calc-embedded-activate. Find and activate all :='s and =>'s in buffer.
61 D calc-embedded-duplicate. Make a copy of this formula and select it.
62 F calc-embedded-new-formula. Insert a new formula at current point.
63 N calc-embedded-next. Advance cursor to next known formula in buffer.
64 P calc-embedded-previous. Advance cursor to previous known formula.
65 U calc-embedded-update-formula. Re-evaluate formula at point.
66 ` calc-embedded-edit. Use calc-edit to edit formula at point.
69 I calc-info. Read the Calculator manual in the Emacs Info system.
70 T calc-tutorial. Run the Calculator Tutorial using the Emacs Info system.
71 S calc-summary. Read the Summary from the Calculator manual in Info.
74 L calc-load-everything. Load all parts of the Calculator into memory.
75 M read-kbd-macro. Read a region of keystroke names as a keyboard macro.
76 0 (zero) calc-reset. Reset Calc stack and modes to default state.
78 Press twice (`M-# M-#' or `M-# #') to turn Calc on or off using the same
79 Calc user interface as before (either M-# C or M-# K; initially M-# C)."
82 (if calc-dispatch-help
84 (save-window-excursion
85 (describe-function 'calc-dispatch-help)
86 (let ((win (get-buffer-window "*Help*")))
91 (message "Calc options: Calc, Keypad, ... %s"
92 "press SPC, DEL to scroll, C-g to cancel")
93 (memq (car (setq key (calc-read-key t)))
94 '(? ?\C-h ?\C-? ?\C-v ?\M-v)))
96 (if (memq (car key) '(? ?\C-v))
100 (calc-unread-command (cdr key))))))
101 (calc-do-dispatch nil))
102 (let ((calc-dispatch-help t))
103 (calc-do-dispatch arg))))
106 (defun calc-big-or-small (arg)
107 "Toggle Calc between full-screen and regular mode."
109 (let ((cwin (get-buffer-window "*Calculator*"))
110 (twin (get-buffer-window "*Calc Trail*"))
111 (kwin (get-buffer-window "*Calc Keypad*")))
115 (and twin (eq (window-width twin) (frame-width)))
116 (eq (window-height cwin) (1- (frame-height))))))
117 (setq calc-full-mode (if arg
118 (> (prefix-numeric-value arg) 0)
119 (not calc-full-mode)))
123 (calc-do-keypad calc-full-mode nil))
127 (calc nil calc-full-mode nil))))
128 (message (if calc-full-mode
129 "Now using full screen for Calc"
130 "Now using partial screen for Calc"))))
132 (defun calc-other-window (&optional interactive)
133 "Invoke the Calculator in another window."
135 (if (memq major-mode '(calc-mode calc-trail-mode))
138 (if (memq major-mode '(calc-mode calc-trail-mode))
140 (if (get-buffer-window "*Calculator*")
142 (let ((win (selected-window)))
143 (calc nil win interactive)))))
145 (defun another-calc ()
146 "Create another, independent Calculator buffer."
148 (if (eq major-mode 'calc-mode)
151 (set-default v (symbol-value v)))) calc-local-var-list))
152 (set-buffer (generate-new-buffer "*Calculator*"))
153 (pop-to-buffer (current-buffer))
157 "Run the Emacs Info system on the Calculator documentation."
159 (select-window (get-largest-window))
162 (defun calc-info-goto-node (node)
163 "Go to a node in the Calculator info documentation."
165 (select-window (get-largest-window))
166 (Info-goto-node (concat "(Calc)" node)))
168 (defun calc-tutorial ()
169 "Run the Emacs Info system on the Calculator Tutorial."
171 (if (get-buffer-window "*Calculator*")
173 (calc-info-goto-node "Interactive Tutorial")
175 (message "Welcome to the Calc Tutorial!"))
177 (defun calc-info-summary ()
178 "Run the Emacs Info system on the Calculator Summary."
180 (calc-info-goto-node "Summary"))
185 '("Press `h' for complete help; press `?' repeatedly for a summary"
186 "Letter keys: Negate; Precision; Yank; Why; Xtended cmd; Quit"
187 "Letter keys: SHIFT + Undo, reDo; Keep-args; Inverse, Hyperbolic"
188 "Letter keys: SHIFT + sQrt; Sin, Cos, Tan; Exp, Ln, logB"
189 "Letter keys: SHIFT + Floor, Round; Abs, conJ, arG; Pi"
190 "Letter keys: SHIFT + Num-eval; More-recn; eXec-kbd-macro"
191 "Other keys: +, -, *, /, ^, \\ (int div), : (frac div)"
192 "Other keys: & (1/x), | (concat), % (modulo), ! (factorial)"
193 "Other keys: ' (alg-entry), = (eval), ` (edit); M-RET (last-args)"
194 "Other keys: SPC/RET (enter/dup), LFD (over); < > (scroll horiz)"
195 "Other keys: DEL (drop), M-DEL (drop-above); { } (scroll vert)"
196 "Other keys: TAB (swap/roll-dn), M-TAB (roll-up)"
197 "Other keys: [ , ; ] (vector), ( , ) (complex), ( ; ) (polar)"
198 "Prefix keys: Algebra, Binary/business, Convert, Display"
199 "Prefix keys: Functions, Graphics, Help, J (select)"
200 "Prefix keys: Kombinatorics/statistics, Modes, Store/recall"
201 "Prefix keys: Trail/time, Units/statistics, Vector/matrix"
202 "Prefix keys: Z (user), SHIFT + Z (define)"
203 "Prefix keys: prefix + ? gives further help for that prefix")
205 " Calc %s by Dave Gillespie, daveg@synaptics.com"
207 (if calc-full-help-flag
209 (if (or calc-inverse-flag calc-hyperbolic-flag)
210 (if calc-inverse-flag
211 (if calc-hyperbolic-flag
212 (calc-inv-hyp-prefix-help)
213 (calc-inverse-prefix-help))
214 (calc-hyperbolic-prefix-help))
215 (setq calc-help-phase
216 (if (eq this-command last-command)
217 (% (1+ calc-help-phase) (1+ (length msgs)))
219 (let ((msg (nth calc-help-phase msgs)))
220 (message "%s" (if msg
222 (make-string (- (apply 'max
232 ;;;; Stack and buffer management.
234 ;; The variable calc-last-why-command is set in calc-do-handly-whys
235 ;; and used in calc-why (in calc-stuff.el).
236 (defvar calc-last-why-command)
238 (defun calc-do-handle-whys ()
239 (setq calc-why (sort calc-next-why
242 (and (eq (car x) '*) (not (eq (car y) '*))))))
244 (if (and calc-why (or (eq calc-auto-why t)
245 (and (eq (car (car calc-why)) '*)
249 (calc-explain-why (car calc-why)
250 (if (eq calc-auto-why t)
253 (eq (car (nth 1 calc-why)) '*))))
254 (setq calc-last-why-command this-command)
255 (calc-clear-command-flag 'clear-message))))
257 (defun calc-record-why (&rest stuff)
258 (if (eq (car stuff) 'quiet)
259 (setq stuff (cdr stuff))
260 (if (and (symbolp (car stuff))
262 (or (Math-objectp (nth 1 stuff))
263 (and (Math-vectorp (nth 1 stuff))
264 (math-constp (nth 1 stuff)))
265 (math-infinitep (nth 1 stuff))))
266 (setq stuff (cons '* stuff))
267 (if (and (stringp (car stuff))
268 (string-match "\\`\\*" (car stuff)))
269 (setq stuff (cons '* (cons (substring (car stuff) 1)
271 (setq calc-next-why (cons stuff calc-next-why))
274 ;;; True if A is a constant or vector of constants. [P x] [Public]
275 (defun math-constp (a)
277 (and (memq (car a) '(sdev intv mod vec))
279 (while (and (setq a (cdr a))
280 (or (Math-scalarp (car a)) ; optimization
281 (math-constp (car a)))))
285 (defun calc-roll-down-stack (n &optional m)
287 (calc-roll-up-stack (- n) m)
288 (if (or (= n 0) (> n (calc-stack-size))) (setq n (calc-stack-size)))
292 (if (and calc-any-selections
293 (not calc-use-selections))
294 (calc-roll-down-with-selections n m)
295 (calc-pop-push-list n
296 (append (calc-top-list m 1)
297 (calc-top-list (- n m) (1+ m))))))))
299 (defun calc-roll-up-stack (n &optional m)
301 (calc-roll-down-stack (- n) m)
302 (if (or (= n 0) (> n (calc-stack-size))) (setq n (calc-stack-size)))
306 (if (and calc-any-selections
307 (not calc-use-selections))
308 (calc-roll-up-with-selections n m)
309 (calc-pop-push-list n
310 (append (calc-top-list (- n m) 1)
311 (calc-top-list m (- n m -1))))))))
314 (defun calc-do-refresh ()
315 (if calc-hyperbolic-flag
317 (setq calc-display-dirty t)
323 (defun calc-record-list (vals &optional prefix)
325 (or (eq (car vals) 'top-of-stack)
327 (calc-record (car vals) prefix)
328 (setq prefix "...")))
329 (setq vals (cdr vals))))
332 (defun calc-last-args-stub (arg)
335 (calc-last-args arg))
338 (defun calc-power (arg)
341 (if (and (featurep 'calc-ext)
343 (calc-binary-op "root" 'calcFunc-nroot arg nil nil)
344 (calc-binary-op "^" 'calcFunc-pow arg nil nil '^))))
346 (defun calc-mod (arg)
349 (calc-binary-op "%" 'calcFunc-mod arg nil nil '%)))
351 (defun calc-inv (arg)
354 (calc-unary-op "inv" 'calcFunc-inv arg)))
356 (defun calc-percent ()
359 (calc-pop-push-record-list
360 1 "%" (list (list 'calcFunc-percent (calc-top-n 1))))))
366 (calc-enter (- (prefix-numeric-value n)))
370 (defun calc-pop-above (n)
373 (calc-pop (- (prefix-numeric-value n)))
376 (defun calc-roll-down (n)
379 (let ((nn (prefix-numeric-value n)))
381 (calc-roll-down-stack 2))
383 (calc-roll-down-stack nn))
385 (calc-pop-push-list (calc-stack-size)
387 (calc-top-list (calc-stack-size)))))
389 (calc-roll-down-stack (calc-stack-size) (- nn)))))))
391 (defun calc-roll-up (n)
394 (let ((nn (prefix-numeric-value n)))
396 (calc-roll-up-stack 3))
398 (calc-roll-up-stack nn))
400 (calc-pop-push-list (calc-stack-size)
402 (calc-top-list (calc-stack-size)))))
404 (calc-roll-up-stack (calc-stack-size) (- nn)))))))
411 (defun calc-num-prefix-name (n)
412 (cond ((eq n '-) "- ")
413 ((equal n '(4)) "C-u ")
414 ((consp n) (format "%d " (car n)))
415 ((integerp n) (format "%d " n))
418 (defun calc-missing-key (n)
419 "This is a placeholder for a command which needs to be loaded from calc-ext.
420 When this key is used, calc-ext (the Calculator extensions module) will be
421 loaded and the keystroke automatically re-typed."
424 (if (keymapp (key-binding (char-to-string last-command-char)))
425 (message "%s%c-" (calc-num-prefix-name n) last-command-char))
426 (calc-unread-command)
429 (defun calc-shift-Y-prefix-help ()
432 (calc-do-prefix-help calc-Y-help-msgs "other" ?Y))
437 (defun calcDigit-letter ()
439 (if (calc-minibuffer-contains "[-+]?\\(1[1-9]\\|[2-9][0-9]\\)#.*")
441 (setq last-command-char (upcase last-command-char))
443 (calcDigit-nondigit)))
446 ;; A Lisp version of temp_minibuffer_message from minibuf.c.
447 (defun calc-temp-minibuffer-message (m)
448 (let ((savemax (point-max)))
450 (goto-char (point-max))
456 (identity 1) ; this forces a call to QUIT; in bytecode.c.
459 (delete-region savemax (point-max))
460 (or okay (abort-recursive-edit)))))))
463 (put 'math-with-extra-prec 'lisp-indent-hook 1)
466 ;;; Concatenate two vectors, or a vector and an object. [V O O] [Public]
467 (defun math-concat (v1 v2)
471 (if (and (or (math-objvecp v1) (math-known-scalarp v1))
472 (or (math-objvecp v2) (math-known-scalarp v2)))
473 (append (if (and (math-vectorp v1)
474 (or (math-matrixp v1)
475 (not (math-matrixp v2))))
478 (if (and (math-vectorp v2)
479 (or (math-matrixp v2)
480 (not (math-matrixp v1))))
486 ;;; True if A is zero. Works for un-normalized values. [P n] [Public]
487 (defun math-zerop (a)
489 (cond ((memq (car a) '(bigpos bigneg))
490 (while (eq (car (setq a (cdr a))) 0))
492 ((memq (car a) '(frac float polar mod))
493 (math-zerop (nth 1 a)))
495 (and (math-zerop (nth 1 a)) (math-zerop (nth 2 a))))
497 (and (math-zerop (nth 1 a))
498 (math-zerop (nth 2 a))
499 (math-zerop (nth 3 a)))))
503 ;;; True if A is real and negative. [P n] [Public]
507 (cond ((eq (car a) 'bigpos) nil)
508 ((eq (car a) 'bigneg) (cdr a))
509 ((memq (car a) '(float frac))
510 (Math-integer-negp (nth 1 a)))
512 (if (math-zerop (nth 1 a))
513 (if (math-zerop (nth 2 a))
514 (math-negp (nth 3 a))
515 (math-negp (nth 2 a)))
516 (math-negp (nth 1 a))))
518 (math-negp (nth 1 a)))
520 (or (math-negp (nth 3 a))
521 (and (math-zerop (nth 3 a))
522 (memq (nth 1 a) '(0 2)))))
523 ((equal a '(neg (var inf var-inf))) t))
526 ;;; True if A is a negative number or an expression the starts with '-'.
527 (defun math-looks-negp (a) ; [P x] [Public]
529 (eq (car-safe a) 'neg)
530 (and (memq (car-safe a) '(* /))
531 (or (math-looks-negp (nth 1 a))
532 (math-looks-negp (nth 2 a))))
533 (and (eq (car-safe a) '-)
534 (math-looks-negp (nth 1 a)))))
537 ;;; True if A is real and positive. [P n] [Public]
540 (cond ((eq (car a) 'bigpos) (cdr a))
541 ((eq (car a) 'bigneg) nil)
542 ((memq (car a) '(float frac))
543 (Math-integer-posp (nth 1 a)))
545 (if (math-zerop (nth 1 a))
546 (if (math-zerop (nth 2 a))
547 (math-posp (nth 3 a))
548 (math-posp (nth 2 a)))
549 (math-posp (nth 1 a))))
551 (math-posp (nth 1 a)))
553 (not (math-zerop (nth 1 a))))
555 (or (math-posp (nth 2 a))
556 (and (math-zerop (nth 2 a))
557 (memq (nth 1 a) '(0 1)))))
558 ((equal a '(var inf var-inf)) t))
561 (defalias 'math-fixnump 'integerp)
562 (defalias 'math-fixnatnump 'natnump)
565 ;;; True if A is an even integer. [P R R] [Public]
566 (defun math-evenp (a)
568 (and (memq (car a) '(bigpos bigneg))
569 (= (% (nth 1 a) 2) 0))
572 ;;; Compute A / 2, for small or big integer A. [I i]
573 ;;; If A is negative, type of truncation is undefined.
577 (math-normalize (cons (car a) (math-div2-bignum (cdr a))))
581 (defun math-div2-bignum (a) ; [l l]
583 (cons (+ (/ (car a) 2) (* (% (nth 1 a) 2) 500))
584 (math-div2-bignum (cdr a)))
585 (list (/ (car a) 2))))
588 ;;; Reject an argument to a calculator function. [Public]
589 (defun math-reject-arg (&optional a p option)
591 (calc-record-why option p a)
593 (calc-record-why p a)))
594 (signal 'wrong-type-argument (and a (if p (list p a) (list a)))))
597 ;;; Coerce A to be an integer (by truncation toward zero). [I N] [Public]
599 ;; The variable math-trunc-prec is local to math-trunc, but used by
600 ;; math-trunc-fancy in calc-arith.el, which is called by math-trunc.
602 (defun math-trunc (a &optional math-trunc-prec)
603 (cond (math-trunc-prec
605 (math-trunc-special a math-trunc-prec))
606 ((Math-integerp a) a)
608 (math-neg (math-trunc (math-neg a))))
610 (math-scale-int (nth 1 a) (nth 2 a)))
611 (t (require 'calc-ext)
612 (math-trunc-fancy a))))
613 (defalias 'calcFunc-trunc 'math-trunc)
615 ;;; Coerce A to be an integer (by truncation toward minus infinity). [I N]
617 ;; The variable math-floor-prec is local to math-floor, but used by
618 ;; math-floor-fancy in calc-arith.el, which is called by math-floor.
620 (defun math-floor (a &optional math-floor-prec) ; [Public]
621 (cond (math-floor-prec
623 (math-floor-special a math-floor-prec))
624 ((Math-integerp a) a)
625 ((Math-messy-integerp a) (math-trunc a))
628 (math-add (math-trunc a) -1)
630 (t (require 'calc-ext)
631 (math-floor-fancy a))))
632 (defalias 'calcFunc-floor 'math-floor)
635 (defun math-imod (a b) ; [I I I] [Public]
636 (if (and (not (consp a)) (not (consp b)))
638 (math-reject-arg a "*Division by zero")
640 (cdr (math-idivmod a b))))
643 (defun calcFunc-inv (m)
647 (if (math-square-matrixp m)
648 (or (math-with-extra-prec 2 (math-matrix-inv-raw m))
649 (math-reject-arg m "*Singular matrix"))
650 (math-reject-arg m 'square-matrixp)))
654 (defun math-do-working (msg arg)
655 (or executing-kbd-macro
657 (calc-set-command-flag 'clear-message)
658 (if math-working-step
659 (if math-working-step-2
660 (setq msg (format "[%d/%d] %s"
661 math-working-step math-working-step-2 msg))
662 (setq msg (format "[%d] %s" math-working-step msg))))
663 (message "Working... %s = %s" msg
664 (math-showing-full-precision (math-format-number arg))))))
667 ;;; Compute A modulo B, defined in terms of truncation toward minus infinity.
668 (defun math-mod (a b) ; [R R R] [Public]
669 (cond ((and (Math-zerop a) (not (eq (car-safe a) 'mod))) a)
671 (math-reject-arg a "*Division by zero"))
672 ((and (Math-natnump a) (Math-natnump b))
674 ((and (Math-anglep a) (Math-anglep b))
675 (math-sub a (math-mul (math-floor (math-div a b)) b)))
676 (t (require 'calc-ext)
677 (math-mod-fancy a b))))
681 ;;; General exponentiation.
683 (defun math-pow (a b) ; [O O N] [Public]
684 (cond ((equal b '(var nan var-nan))
687 (if (and (Math-scalarp b) (Math-posp b))
688 (if (math-floatp b) (math-float a) a)
690 (math-pow-of-zero a b)))
691 ((or (eq a 1) (eq b 1)) a)
692 ((or (equal a '(float 1 0)) (equal b '(float 1 0))) a)
695 (if (or (math-floatp a) (math-floatp b))
698 (math-pow-zero a b)))
699 ((and (Math-integerp b) (or (Math-numberp a) (Math-vectorp a)))
700 (if (and (equal a '(float 1 1)) (integerp b))
701 (math-make-float 1 b)
702 (math-with-extra-prec 2
706 (math-pow-fancy a b))))
708 (defun math-ipow (a n) ; [O O I] [Public]
709 (cond ((Math-integer-negp n)
710 (math-ipow (math-div 1 a) (Math-integer-neg n)))
712 (if (and (Math-ratp a) (> n 20))
713 (math-iipow-show a n)
716 (math-ipow (math-mul a a) (math-div2 n)))
718 (math-mul a (math-ipow (math-mul a a)
719 (math-div2 (math-add n -1)))))))
721 (defun math-iipow (a n) ; [O O S]
724 ((= (% n 2) 0) (math-iipow (math-mul a a) (/ n 2)))
725 (t (math-mul a (math-iipow (math-mul a a) (/ n 2))))))
727 (defun math-iipow-show (a n) ; [O O S]
728 (math-working "pow" a)
732 ((= (% n 2) 0) (math-iipow-show (math-mul a a) (/ n 2)))
733 (t (math-mul a (math-iipow-show (math-mul a a) (/ n 2)))))))
734 (math-working "pow" val)
738 (defun math-read-radix-digit (dig) ; [D S; Z S]
750 (defun report-calc-bug ()
751 "Report a bug in Calc, the GNU Emacs calculator.
752 Prompts for bug subject. Leaves you in a mail buffer."
754 (let ((reporter-prompt-for-summary-p t))
755 (reporter-submit-bug-report calc-bug-address "Calc" '(calc-version)
757 "Please describe exactly what actions triggered the bug and the
758 precise symptoms of the bug. If possible, include a backtrace by
759 doing 'M-x toggle-debug-on-error', then reproducing the bug.
761 (defalias 'calc-report-bug 'report-calc-bug)
763 ;;; arch-tag: 7984d9d0-62e5-41dc-afb8-e904b975f250
764 ;;; calc-misc.el ends here