1 ;;; calc-misc.el --- miscellaenous functions for Calc
3 ;; Copyright (C) 1990, 1991, 1992, 1993, 2001, 2005 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-dispatch-help (arg)
35 "M-# is a prefix key; follow it with one of these letters:
37 For turning Calc on and off:
38 C calc. Start the Calculator in a window at the bottom of the screen.
39 O calc-other-window. Start the Calculator but don't select its window.
40 B calc-big-or-small. Control whether to use the full Emacs screen for Calc.
41 Q quick-calc. Use the Calculator in the minibuffer.
42 K calc-keypad. Start the Calculator in keypad mode (X window system only).
43 E calc-embedded. Use the Calculator on a formula in this editing buffer.
44 J calc-embedded-select. Like E, but select appropriate half of => or :=.
45 W calc-embedded-word. Like E, but activate a single word, i.e., a number.
46 Z calc-user-invocation. Invoke Calc in the way you defined with `Z I' cmd.
47 X calc-quit. Turn Calc off.
49 For moving data into and out of Calc:
50 G calc-grab-region. Grab the region defined by mark and point into Calc.
51 R calc-grab-rectangle. Grab the rectangle defined by mark, point into Calc.
52 : calc-grab-sum-down. Grab a rectangle and sum the columns.
53 _ calc-grab-sum-across. Grab a rectangle and sum the rows.
54 Y calc-copy-to-buffer. Copy a value from the stack into the editing buffer.
56 For use with Embedded mode:
57 A calc-embedded-activate. Find and activate all :='s and =>'s in buffer.
58 D calc-embedded-duplicate. Make a copy of this formula and select it.
59 F calc-embedded-new-formula. Insert a new formula at current point.
60 N calc-embedded-next. Advance cursor to next known formula in buffer.
61 P calc-embedded-previous. Advance cursor to previous known formula.
62 U calc-embedded-update-formula. Re-evaluate formula at point.
63 ` calc-embedded-edit. Use calc-edit to edit formula at point.
66 I calc-info. Read the Calculator manual in the Emacs Info system.
67 T calc-tutorial. Run the Calculator Tutorial using the Emacs Info system.
68 S calc-summary. Read the Summary from the Calculator manual in Info.
71 L calc-load-everything. Load all parts of the Calculator into memory.
72 M read-kbd-macro. Read a region of keystroke names as a keyboard macro.
73 0 (zero) calc-reset. Reset Calc stack and modes to default state.
75 Press twice (`M-# M-#' or `M-# #') to turn Calc on or off using the same
76 Calc user interface as before (either M-# C or M-# K; initially M-# C)."
79 (if calc-dispatch-help
81 (save-window-excursion
82 (describe-function 'calc-dispatch-help
)
83 (let ((win (get-buffer-window "*Help*")))
88 (message "Calc options: Calc, Keypad, ... %s"
89 "press SPC, DEL to scroll, C-g to cancel")
90 (memq (car (setq key
(calc-read-key t
)))
91 '(? ?\C-h ?\C-? ?\C-v ?\M-v
)))
93 (if (memq (car key
) '(? ?\C-v
))
97 (calc-unread-command (cdr key
))))))
98 (calc-do-dispatch nil
))
99 (let ((calc-dispatch-help t
))
100 (calc-do-dispatch arg
))))
103 (defun calc-big-or-small (arg)
104 "Toggle Calc between full-screen and regular mode."
106 (let ((cwin (get-buffer-window "*Calculator*"))
107 (twin (get-buffer-window "*Calc Trail*"))
108 (kwin (get-buffer-window "*Calc Keypad*")))
112 (and twin
(eq (window-width twin
) (frame-width)))
113 (eq (window-height cwin
) (1- (frame-height))))))
114 (setq calc-full-mode
(if arg
115 (> (prefix-numeric-value arg
) 0)
116 (not calc-full-mode
)))
120 (calc-do-keypad calc-full-mode nil
))
124 (calc nil calc-full-mode nil
))))
125 (message (if calc-full-mode
126 "Now using full screen for Calc"
127 "Now using partial screen for Calc"))))
129 (defun calc-other-window (&optional interactive
)
130 "Invoke the Calculator in another window."
132 (if (memq major-mode
'(calc-mode calc-trail-mode
))
135 (if (memq major-mode
'(calc-mode calc-trail-mode
))
137 (if (get-buffer-window "*Calculator*")
139 (let ((win (selected-window)))
140 (calc nil win interactive
)))))
142 (defun another-calc ()
143 "Create another, independent Calculator buffer."
145 (if (eq major-mode
'calc-mode
)
148 (set-default v
(symbol-value v
)))) calc-local-var-list
))
149 (set-buffer (generate-new-buffer "*Calculator*"))
150 (pop-to-buffer (current-buffer))
154 "Run the Emacs Info system on the Calculator documentation."
156 (select-window (get-largest-window))
159 (defun calc-info-goto-node (node)
160 "Go to a node in the Calculator info documentation."
162 (select-window (get-largest-window))
163 (info (concat "(Calc)" node
)))
165 (defun calc-tutorial ()
166 "Run the Emacs Info system on the Calculator Tutorial."
168 (if (get-buffer-window "*Calculator*")
170 (calc-info-goto-node "Interactive Tutorial")
172 (message "Welcome to the Calc Tutorial!"))
174 (defun calc-info-summary ()
175 "Run the Emacs Info system on the Calculator Summary."
177 (calc-info-goto-node "Summary"))
182 '("Press `h' for complete help; press `?' repeatedly for a summary"
183 "Letter keys: Negate; Precision; Yank; Why; Xtended cmd; Quit"
184 "Letter keys: SHIFT + Undo, reDo; Keep-args; Inverse, Hyperbolic"
185 "Letter keys: SHIFT + sQrt; Sin, Cos, Tan; Exp, Ln, logB"
186 "Letter keys: SHIFT + Floor, Round; Abs, conJ, arG; Pi"
187 "Letter keys: SHIFT + Num-eval; More-recn; eXec-kbd-macro"
188 "Other keys: +, -, *, /, ^, \\ (int div), : (frac div)"
189 "Other keys: & (1/x), | (concat), % (modulo), ! (factorial)"
190 "Other keys: ' (alg-entry), = (eval), ` (edit); M-RET (last-args)"
191 "Other keys: SPC/RET (enter/dup), LFD (over); < > (scroll horiz)"
192 "Other keys: DEL (drop), M-DEL (drop-above); { } (scroll vert)"
193 "Other keys: TAB (swap/roll-dn), M-TAB (roll-up)"
194 "Other keys: [ , ; ] (vector), ( , ) (complex), ( ; ) (polar)"
195 "Prefix keys: Algebra, Binary/business, Convert, Display"
196 "Prefix keys: Functions, Graphics, Help, J (select)"
197 "Prefix keys: Kombinatorics/statistics, Modes, Store/recall"
198 "Prefix keys: Trail/time, Units/statistics, Vector/matrix"
199 "Prefix keys: Z (user), SHIFT + Z (define)"
200 "Prefix keys: prefix + ? gives further help for that prefix")
202 " Calc %s by Dave Gillespie, daveg@synaptics.com"
204 (if calc-full-help-flag
206 (if (or calc-inverse-flag calc-hyperbolic-flag
)
207 (if calc-inverse-flag
208 (if calc-hyperbolic-flag
209 (calc-inv-hyp-prefix-help)
210 (calc-inverse-prefix-help))
211 (calc-hyperbolic-prefix-help))
212 (setq calc-help-phase
213 (if (eq this-command last-command
)
214 (%
(1+ calc-help-phase
) (1+ (length msgs
)))
216 (let ((msg (nth calc-help-phase msgs
)))
217 (message "%s" (if msg
219 (make-string (- (apply 'max
229 ;;;; Stack and buffer management.
231 ;; The variable calc-last-why-command is set in calc-do-handly-whys
232 ;; and used in calc-why (in calc-stuff.el).
233 (defvar calc-last-why-command
)
235 (defun calc-do-handle-whys ()
236 (setq calc-why
(sort calc-next-why
239 (and (eq (car x
) '*) (not (eq (car y
) '*))))))
241 (if (and calc-why
(or (eq calc-auto-why t
)
242 (and (eq (car (car calc-why
)) '*)
246 (calc-explain-why (car calc-why
)
247 (if (eq calc-auto-why t
)
250 (eq (car (nth 1 calc-why
)) '*))))
251 (setq calc-last-why-command this-command
)
252 (calc-clear-command-flag 'clear-message
))))
254 (defun calc-record-why (&rest stuff
)
255 (if (eq (car stuff
) 'quiet
)
256 (setq stuff
(cdr stuff
))
257 (if (and (symbolp (car stuff
))
259 (or (Math-objectp (nth 1 stuff
))
260 (and (Math-vectorp (nth 1 stuff
))
261 (math-constp (nth 1 stuff
)))
262 (math-infinitep (nth 1 stuff
))))
263 (setq stuff
(cons '* stuff
))
264 (if (and (stringp (car stuff
))
265 (string-match "\\`\\*" (car stuff
)))
266 (setq stuff
(cons '* (cons (substring (car stuff
) 1)
268 (setq calc-next-why
(cons stuff calc-next-why
))
271 ;;; True if A is a constant or vector of constants. [P x] [Public]
272 (defun math-constp (a)
274 (and (memq (car a
) '(sdev intv mod vec
))
276 (while (and (setq a
(cdr a
))
277 (or (Math-scalarp (car a
)) ; optimization
278 (math-constp (car a
)))))
282 (defun calc-roll-down-stack (n &optional m
)
284 (calc-roll-up-stack (- n
) m
)
285 (if (or (= n
0) (> n
(calc-stack-size))) (setq n
(calc-stack-size)))
289 (if (and calc-any-selections
290 (not calc-use-selections
))
291 (calc-roll-down-with-selections n m
)
292 (calc-pop-push-list n
293 (append (calc-top-list m
1)
294 (calc-top-list (- n m
) (1+ m
))))))))
296 (defun calc-roll-up-stack (n &optional m
)
298 (calc-roll-down-stack (- n
) m
)
299 (if (or (= n
0) (> n
(calc-stack-size))) (setq n
(calc-stack-size)))
303 (if (and calc-any-selections
304 (not calc-use-selections
))
305 (calc-roll-up-with-selections n m
)
306 (calc-pop-push-list n
307 (append (calc-top-list (- n m
) 1)
308 (calc-top-list m
(- n m -
1))))))))
311 (defun calc-do-refresh ()
312 (if calc-hyperbolic-flag
314 (setq calc-display-dirty t
)
320 (defun calc-record-list (vals &optional prefix
)
322 (or (eq (car vals
) 'top-of-stack
)
324 (calc-record (car vals
) prefix
)
325 (setq prefix
"...")))
326 (setq vals
(cdr vals
))))
329 (defun calc-last-args-stub (arg)
332 (calc-last-args arg
))
335 (defun calc-power (arg)
338 (if (and (featurep 'calc-ext
)
340 (calc-binary-op "root" 'calcFunc-nroot arg nil nil
)
341 (calc-binary-op "^" 'calcFunc-pow arg nil nil
'^
))))
343 (defun calc-mod (arg)
346 (calc-binary-op "%" 'calcFunc-mod arg nil nil
'%
)))
348 (defun calc-inv (arg)
351 (calc-unary-op "inv" 'calcFunc-inv arg
)))
353 (defun calc-percent ()
356 (calc-pop-push-record-list
357 1 "%" (list (list 'calcFunc-percent
(calc-top-n 1))))))
363 (calc-enter (- (prefix-numeric-value n
)))
367 (defun calc-pop-above (n)
370 (calc-pop (- (prefix-numeric-value n
)))
373 (defun calc-roll-down (n)
376 (let ((nn (prefix-numeric-value n
)))
378 (calc-roll-down-stack 2))
380 (calc-roll-down-stack nn
))
382 (calc-pop-push-list (calc-stack-size)
384 (calc-top-list (calc-stack-size)))))
386 (calc-roll-down-stack (calc-stack-size) (- nn
)))))))
388 (defun calc-roll-up (n)
391 (let ((nn (prefix-numeric-value n
)))
393 (calc-roll-up-stack 3))
395 (calc-roll-up-stack nn
))
397 (calc-pop-push-list (calc-stack-size)
399 (calc-top-list (calc-stack-size)))))
401 (calc-roll-up-stack (calc-stack-size) (- nn
)))))))
408 (defun calc-num-prefix-name (n)
409 (cond ((eq n
'-
) "- ")
410 ((equal n
'(4)) "C-u ")
411 ((consp n
) (format "%d " (car n
)))
412 ((integerp n
) (format "%d " n
))
415 (defun calc-missing-key (n)
416 "This is a placeholder for a command which needs to be loaded from calc-ext.
417 When this key is used, calc-ext (the Calculator extensions module) will be
418 loaded and the keystroke automatically re-typed."
421 (if (keymapp (key-binding (char-to-string last-command-char
)))
422 (message "%s%c-" (calc-num-prefix-name n
) last-command-char
))
423 (calc-unread-command)
426 (defun calc-shift-Y-prefix-help ()
429 (calc-do-prefix-help calc-Y-help-msgs
"other" ?Y
))
434 (defun calcDigit-letter ()
436 (if (calc-minibuffer-contains "[-+]?\\(1[1-9]\\|[2-9][0-9]\\)#.*")
438 (setq last-command-char
(upcase last-command-char
))
440 (calcDigit-nondigit)))
443 ;; A Lisp version of temp_minibuffer_message from minibuf.c.
444 (defun calc-temp-minibuffer-message (m)
445 (let ((savemax (point-max)))
447 (goto-char (point-max))
453 (identity 1) ; this forces a call to QUIT; in bytecode.c.
456 (delete-region savemax
(point-max))
457 (or okay
(abort-recursive-edit)))))))
460 (put 'math-with-extra-prec
'lisp-indent-hook
1)
463 ;;; Concatenate two vectors, or a vector and an object. [V O O] [Public]
464 (defun math-concat (v1 v2
)
468 (if (and (or (math-objvecp v1
) (math-known-scalarp v1
))
469 (or (math-objvecp v2
) (math-known-scalarp v2
)))
470 (append (if (and (math-vectorp v1
)
471 (or (math-matrixp v1
)
472 (not (math-matrixp v2
))))
475 (if (and (math-vectorp v2
)
476 (or (math-matrixp v2
)
477 (not (math-matrixp v1
))))
483 ;;; True if A is zero. Works for un-normalized values. [P n] [Public]
484 (defun math-zerop (a)
486 (cond ((memq (car a
) '(bigpos bigneg
))
487 (while (eq (car (setq a
(cdr a
))) 0))
489 ((memq (car a
) '(frac float polar mod
))
490 (math-zerop (nth 1 a
)))
492 (and (math-zerop (nth 1 a
)) (math-zerop (nth 2 a
))))
494 (and (math-zerop (nth 1 a
))
495 (math-zerop (nth 2 a
))
496 (math-zerop (nth 3 a
)))))
500 ;;; True if A is real and negative. [P n] [Public]
504 (cond ((eq (car a
) 'bigpos
) nil
)
505 ((eq (car a
) 'bigneg
) (cdr a
))
506 ((memq (car a
) '(float frac
))
507 (Math-integer-negp (nth 1 a
)))
509 (if (math-zerop (nth 1 a
))
510 (if (math-zerop (nth 2 a
))
511 (math-negp (nth 3 a
))
512 (math-negp (nth 2 a
)))
513 (math-negp (nth 1 a
))))
515 (math-negp (nth 1 a
)))
517 (or (math-negp (nth 3 a
))
518 (and (math-zerop (nth 3 a
))
519 (memq (nth 1 a
) '(0 2)))))
520 ((equal a
'(neg (var inf var-inf
))) t
))
523 ;;; True if A is a negative number or an expression the starts with '-'.
524 (defun math-looks-negp (a) ; [P x] [Public]
526 (eq (car-safe a
) 'neg
)
527 (and (memq (car-safe a
) '(* /))
528 (or (math-looks-negp (nth 1 a
))
529 (math-looks-negp (nth 2 a
))))
530 (and (eq (car-safe a
) '-
)
531 (math-looks-negp (nth 1 a
)))))
534 ;;; True if A is real and positive. [P n] [Public]
537 (cond ((eq (car a
) 'bigpos
) (cdr a
))
538 ((eq (car a
) 'bigneg
) nil
)
539 ((memq (car a
) '(float frac
))
540 (Math-integer-posp (nth 1 a
)))
542 (if (math-zerop (nth 1 a
))
543 (if (math-zerop (nth 2 a
))
544 (math-posp (nth 3 a
))
545 (math-posp (nth 2 a
)))
546 (math-posp (nth 1 a
))))
548 (math-posp (nth 1 a
)))
550 (not (math-zerop (nth 1 a
))))
552 (or (math-posp (nth 2 a
))
553 (and (math-zerop (nth 2 a
))
554 (memq (nth 1 a
) '(0 1)))))
555 ((equal a
'(var inf var-inf
)) t
))
558 (defalias 'math-fixnump
'integerp
)
559 (defalias 'math-fixnatnump
'natnump
)
562 ;;; True if A is an even integer. [P R R] [Public]
563 (defun math-evenp (a)
565 (and (memq (car a
) '(bigpos bigneg
))
566 (= (%
(nth 1 a
) 2) 0))
569 ;;; Compute A / 2, for small or big integer A. [I i]
570 ;;; If A is negative, type of truncation is undefined.
574 (math-normalize (cons (car a
) (math-div2-bignum (cdr a
))))
578 (defun math-div2-bignum (a) ; [l l]
580 (cons (+ (/ (car a
) 2) (* (%
(nth 1 a
) 2) 500))
581 (math-div2-bignum (cdr a
)))
582 (list (/ (car a
) 2))))
585 ;;; Reject an argument to a calculator function. [Public]
586 (defun math-reject-arg (&optional a p option
)
588 (calc-record-why option p a
)
590 (calc-record-why p a
)))
591 (signal 'wrong-type-argument
(and a
(if p
(list p a
) (list a
)))))
594 ;;; Coerce A to be an integer (by truncation toward zero). [I N] [Public]
596 ;; The variable math-trunc-prec is local to math-trunc, but used by
597 ;; math-trunc-fancy in calc-arith.el, which is called by math-trunc.
599 (defun math-trunc (a &optional math-trunc-prec
)
600 (cond (math-trunc-prec
602 (math-trunc-special a math-trunc-prec
))
603 ((Math-integerp a
) a
)
605 (math-neg (math-trunc (math-neg a
))))
607 (math-scale-int (nth 1 a
) (nth 2 a
)))
608 (t (require 'calc-ext
)
609 (math-trunc-fancy a
))))
610 (defalias 'calcFunc-trunc
'math-trunc
)
612 ;;; Coerce A to be an integer (by truncation toward minus infinity). [I N]
614 ;; The variable math-floor-prec is local to math-floor, but used by
615 ;; math-floor-fancy in calc-arith.el, which is called by math-floor.
617 (defun math-floor (a &optional math-floor-prec
) ; [Public]
618 (cond (math-floor-prec
620 (math-floor-special a math-floor-prec
))
621 ((Math-integerp a
) a
)
622 ((Math-messy-integerp a
) (math-trunc a
))
625 (math-add (math-trunc a
) -
1)
627 (t (require 'calc-ext
)
628 (math-floor-fancy a
))))
629 (defalias 'calcFunc-floor
'math-floor
)
632 (defun math-imod (a b
) ; [I I I] [Public]
633 (if (and (not (consp a
)) (not (consp b
)))
635 (math-reject-arg a
"*Division by zero")
637 (cdr (math-idivmod a b
))))
640 (defun calcFunc-inv (m)
644 (if (math-square-matrixp m
)
645 (or (math-with-extra-prec 2 (math-matrix-inv-raw m
))
646 (math-reject-arg m
"*Singular matrix"))
647 (math-reject-arg m
'square-matrixp
)))
651 (defun math-do-working (msg arg
)
652 (or executing-kbd-macro
654 (calc-set-command-flag 'clear-message
)
655 (if math-working-step
656 (if math-working-step-2
657 (setq msg
(format "[%d/%d] %s"
658 math-working-step math-working-step-2 msg
))
659 (setq msg
(format "[%d] %s" math-working-step msg
))))
660 (message "Working... %s = %s" msg
661 (math-showing-full-precision (math-format-number arg
))))))
664 ;;; Compute A modulo B, defined in terms of truncation toward minus infinity.
665 (defun math-mod (a b
) ; [R R R] [Public]
666 (cond ((and (Math-zerop a
) (not (eq (car-safe a
) 'mod
))) a
)
668 (math-reject-arg a
"*Division by zero"))
669 ((and (Math-natnump a
) (Math-natnump b
))
671 ((and (Math-anglep a
) (Math-anglep b
))
672 (math-sub a
(math-mul (math-floor (math-div a b
)) b
)))
673 (t (require 'calc-ext
)
674 (math-mod-fancy a b
))))
678 ;;; General exponentiation.
680 (defun math-pow (a b
) ; [O O N] [Public]
681 (cond ((equal b
'(var nan var-nan
))
684 (if (and (Math-scalarp b
) (Math-posp b
))
685 (if (math-floatp b
) (math-float a
) a
)
687 (math-pow-of-zero a b
)))
688 ((or (eq a
1) (eq b
1)) a
)
689 ((or (equal a
'(float 1 0)) (equal b
'(float 1 0))) a
)
692 (if (or (math-floatp a
) (math-floatp b
))
695 (math-pow-zero a b
)))
696 ((and (Math-integerp b
) (or (Math-numberp a
) (Math-vectorp a
)))
697 (if (and (equal a
'(float 1 1)) (integerp b
))
698 (math-make-float 1 b
)
699 (math-with-extra-prec 2
703 (math-pow-fancy a b
))))
705 (defun math-ipow (a n
) ; [O O I] [Public]
706 (cond ((Math-integer-negp n
)
707 (math-ipow (math-div 1 a
) (Math-integer-neg n
)))
709 (if (and (Math-ratp a
) (> n
20))
710 (math-iipow-show a n
)
713 (math-ipow (math-mul a a
) (math-div2 n
)))
715 (math-mul a
(math-ipow (math-mul a a
)
716 (math-div2 (math-add n -
1)))))))
718 (defun math-iipow (a n
) ; [O O S]
721 ((= (% n
2) 0) (math-iipow (math-mul a a
) (/ n
2)))
722 (t (math-mul a
(math-iipow (math-mul a a
) (/ n
2))))))
724 (defun math-iipow-show (a n
) ; [O O S]
725 (math-working "pow" a
)
729 ((= (% n
2) 0) (math-iipow-show (math-mul a a
) (/ n
2)))
730 (t (math-mul a
(math-iipow-show (math-mul a a
) (/ n
2)))))))
731 (math-working "pow" val
)
735 (defun math-read-radix-digit (dig) ; [D S; Z S]
747 (defun report-calc-bug ()
748 "Report a bug in Calc, the GNU Emacs calculator.
749 Prompts for bug subject. Leaves you in a mail buffer."
751 (let ((reporter-prompt-for-summary-p t
))
752 (reporter-submit-bug-report calc-bug-address
"Calc" '(calc-version)
754 "Please describe exactly what actions triggered the bug and the
755 precise symptoms of the bug. If possible, include a backtrace by
756 doing 'M-x toggle-debug-on-error', then reproducing the bug.
758 (defalias 'calc-report-bug
'report-calc-bug
)
762 ;;; arch-tag: 7984d9d0-62e5-41dc-afb8-e904b975f250
763 ;;; calc-misc.el ends here