-
Notifications
You must be signed in to change notification settings - Fork 2
/
math.el
1959 lines (1833 loc) · 74.9 KB
/
math.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
; math.el, a mode package for Mathematica.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Copyright (c) 1990, 1991, 1992, 1993, 1994 Hewlett-Packard Company,
;; all rights reserved.
;;
;; LEGAL NOTICE
;;
;; This math-mode package is experimental and HP shall have no obligation to
;; maintain or support it. HP makes no express or implied warranty of any
;; kind with respect to this software, and HP shall not be liable for any
;; direct, indirect, special, incidental or consequential damages (whether
;; based on contract, tort or any other legal theory) arising in any way from
;; use of the software.
;;
;; Everyone is granted permission to copy, modify and redistribute this
;; math-mode package, provided:
;; 1. All copies contain this copyright notice.
;; 2. All modified copies shall carry a prominant notice stating who
;; made the last modification and the date of such modification.
;; 3. No charge is made for this software or works derived from it.
;; This clause shall not be construed as constraining other software
;; distributed on the same medium as this software, nor is a
;; distribution fee considered a charge.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; The procedure start-math-process was derived from the
;; procedure make-shell, part of the Gnu Emacs file shell.el, by
;; permission of the Free Software Foundation. Shell.el is
;; Copyright (C) 1985, 1986, 1987, 1988 Free Software Foundation,
;; Inc.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Author: David Jacobson, jacobson@hpl.hp.com
;; Assumes GNU Emacs version 18.54 or later
;; Version info is in math-version-string defined after history box
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; LCD Archive Entry:
;; math|David Jacobson|jacobson@hpl.hp.com|
;; Mode package for running Mathematica
;; $Date: 1994/10/18 15:14:56 $|$Revision: 1.106 $|~/modes/math.el.Z|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; 2/17/1991 Dan Dill dan@chem.bu.edu
;; Add math-send-filter-active and math-send-filter-status,
;; for use with tex-mma
;;
;; 5/1/1991 Dan Dill dan@chem.bu.edu
;; Add math-remote-host and math-remote-shell and modified
;; start-buffer-process, to run Mathematica remotely
;;
;; 5/8/1991 David Jacobson jacobson@hplabs.hp.com
;; Add math-timeout and improve documentation, add checking
;; for incomplete cells to check-math-syntax
;;
;; 11/17/1991 David Jacobson jacobson@hpl.hp.com
;; Adding indent cookie crumb rejection
;;
;; 11/27/1991 David Jacobson jacobson@hpl.hp.com
;; Fix path. Delete goto-math-line. Fix up find-math-ehrror
;;
;; 11/30/1991 Dan Dill dan@chem.bu.edu
;; Adapt indent cookie crumb rejection changes for use with tex-mma
;;
;; 12/5/91 David Jacobson jacobson@hpl.hp.com
;; Functions math and start-math no longer call math-mode if it was already
;; in math-mode. (math-mode initializes a lot of variables, including
;; all local variables.) Small changes to start-buffer-process to avoid
;; munging state if the process is already running.
;;
;; 12/10/91 David Jacobson jacobson@hpl.hp.com
;; Add kill-math-cell. Add installation instructions. Fix documentation.
;;
;; 12/12/91 Dan Dill dan@chem.bu.edu
;; Synchronize with tex-mma by setting math-send-filter-active to nil
;; in math-send-filter when the input prompt has been received.
;;
;; 12/17/91 David Jacobson jacobson@hpl.hp.com
;; Set mark when C-c C-y copies cell. Fix bug causing
;; C-c C-y and empty response in last cell of buffer that
;; was not its own math process buffer to get wrong cell.
;; Rename start-buffer-process to start-math-process.
;; Add more documentation. Add math-mode-load-hook.
;;
;; 12/31/91, 1/7/92 David Jacobson jacobson@hpl.hp.com
;; Cause the DISPLAY variable to be set when using a remote host.
;;
;; 1/20/92 David Jacobson jacobson@hpl.hp.com
;; Adjust legal wording.
;;
;; 4/2/92 David Jacobson jacobson@hpl.hp.com
;; Add math-transform-float and math-transform-floats-in-region
;;
;; 5/16/92 David Jacobson jacobson@hpl.hp.com
;; Fix math-copy-region so that if the input string ends in a "-"
;; the cell is deleted.
;;
;; 6/3/92 David Jacobson jacobson@hpl.hp.com
;; Fix to use fancy math indent cookies.
;;
;; 6/4/92 David Jacobson jacobson@hpl.hp.com
;; Fix cell sending system to that it gets responses to interrupts
;; and Input[...] right. Major changes to math-identify-cell.
;; Also fix so that no extra space is inserted after response
;; to Input.
;;
;; 6/22/92 David Jacobson jacobson@hpl.hp.com
;; Remove references to c-process-filter in math-help-filter.
;; Fix math-copy-cell to add a backslash if the first line
;; is blank. This sometimes happens when you copy an Out cell.
;; Fix math-identify-cell to search back to a blank line before the
;; beginning if it is an Out cell and also to include all the
;; text to the beginning of the next In cell.
;;
;; 6/23/92 David Jacobson jacobson@hpl.hp.com
;; Make "--" at end of math-copy-cell delete to end of buffer.
;;
;; 7/17/92 David Jacobson jacobson@hpl.hp.com
;; Twiddle on-line documentation. Make C-c C-k run old-kill-math-cell,
;; which is now an alias for kill-math-cell. Twiddle key binding
;; details.
;;
;; 7/23/92 David Jacobson jacobson@hpl.hp.com
;; Add math-remove-symbol
;;
;; 7/28/92 David Jacobson jacobson@hpl.hp.com
;; Make check-math-syntax warn on backslash whitespace eol.
;; Add math-remote-user. Make backquote be a valid statement ender.
;;
;; 8/1/92 David Jacobson jacobson@hpl.hp.com
;; Fix check-math-syntax to leave cursor at point of error.
;; Also make it detect negative paren depth.
;;
;; 8/12/92 David Jacobson jacobson@hpl.hp.com
;; Fix math-identify-cell to work around emacs bug. Now C-c C-y
;; will properly grab cells at the beginning of the buffer. (Important
;; when the buffer is a .m file rather than the *math* buffer.)
;;
;; 8/24/92 David Jacobson jacobson@hpl.hp.com
;; Add experimental math-electric-char facility. This is subject to
;; change at any moment.
;;
;; 9/28/92 David Jacobson jacobson@hpl.hp.com
;; Add /usr/bsd/rsh as possible remote shell program.
;;
;; 6/6/93 David Jacobson jacobson@hpl.hp.com
;; Add defvars for math-send-state and math-completion-symbol.
;; Comment out deep-copy-keymap and change all instances of
;; deep-copy-keymap to copy-keymap.
;; Add constant emacs-version-18 that is t if running v. 18, and nil
;; otherwise. Use this constant to select either screen-width (v18)
;; or frame-width (v19).
;;
;; 12/12/93 David Jacobson jacobson@hpl.hp.com
;; The last version breaks on Gnu Emacs 19.20 and following. The
;; following changes address that problem.
;; Change all references to shell-mode to comint-mode, shell-mode-map to
;; comint-mode-map, etc. The function unread-command-char is now
;; obsolete. Rewrite math-isearch-backwards to not depend on it.
;; Add function math-insert-in-regexp-search-ring to facilitate this.
;; Move (provide 'math) to the end of the file.
;; Fix spelling error in parse-partial-sexp-ignore-comments.
;; Fix semi-bug in math-electric-char-bounce-p: some things
;; that were passed as parameters were being accessed by the names
;; of the local vars in the calling procedure.
;;
;; 12/13/93 David Jacobson jacobson@hpl.hp.com
;; Eliminate math-insert-in-regexp-search-string and rewrite
;; math-isearch-backwards to not need it to avoid copyright hassles
;; with FSF. Add some functionality in the process. It now
;; avoids cluttering the regexp-search-ring. Eliminate some
;; lies in the comments regarding assumptions about Emacs'
;; output process. Explain the indent cookies.
;;
;; 12/15/93 David Jacobson jacobson@hpl.hp.com
;; Add LCD archive entry comment.
;; No other changes, even to math-version string.
;;
;; 03/12/94 Martin Boyer <mboyer@ireq-robot.hydro.qc.ca>
;; Added mathematica-state and the comment strings definition.
;;
;; 03/29/94 David Jacobson jacobson@hpl.hp.com
;; Removed printing of "*" is message area.
;;
;; 06/20/94 David Jacobson jacobson@hpl.hp.com
;; Make it work on Gnu Emacs 19.23 and following.
;; Split math-start-process into 2 halves, one for Gnu Emacs v18 and
;; one for Gnu Emacs v 19. The version 19 part does not call the
;; "env" program as it no longer exists. Instead it sets up evnironment
;; variables with the variable process-envoronment. Also hack mode
;; message regarding sending of interrupts.
;;
;; 06/21/94 David Jacobson jacobson@hpl.hp.com
;; Fix LCD archive entry. math-version-string left unchanged
;;
;; 10/18/94 David Jacobson jacobson@hpl.hp.com
;; Fix recommended installation comments
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defconst math-version-string
"Mathematica mode experimental version of October 18, 1994 for Mathematica version 2.2."
"String describing this version of math.el.")
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Installation and use:
;;
;; For initial tryout save this file somewhere, start emacs and type
;; M-x load-file <<the full path name of this file>>
;; Then type
;; M-x math
;; a window should be created and a Mathematica process created in it.
;; Type in a cell and "submit" it with ESC-RET.
;; You can see a lot more information and instructoins by typing
;; C-h m (DEL m for HP keyboard users).
;; You can use C-h f to find more information on each command.
;;
;; For full installation, this file should be installed as math.el
;; in whatever directory you put your local or personal emacs lisp files.
;; It should be byte-compiled. You should add the following to
;; your .emacs file:
;;
;; (autoload 'math "math" "Starts Mathematica" t)
;; (autoload 'math-mode "math"
;; "Mode for editing Mathematica. Loading will result in more info." t)
;; (setq auto-mode-alist (cons '("\\.m\\'" . math-mode) auto-mode-alist))
;;
;; and add the following to your init.m file
;;
;; If[Environment["MATHINDENTCOOKIE"] =!= $Failed,
;; $BatchInput=False;
;; If[NameQ["System`Private`$IndentSuffix"],
;; ToExpression[
;; "System`Private`$IndentSuffix = Environment[\"MATHINDENTCOOKIE\"]"];
;; Print[" ", Environment["MATHINDENTCOOKIEMSG"]]]]
;;
;; It will usually work without this, but this makes it do better at
;; identifying when the system is waiting for more input.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; LIMITATIONS
;;
;; A nasty problem arises because's in Versions 2.0 and up Mathematica will
;; under certain conditions put out a message before a cell has been
;; completed, then expect the remainder of the cell to be sent. In most
;; other conditions, unexpected output indicates an error of one sort or
;; another has occurred. Two such messages are General::spell,
;; indicating a suspected spelling error, and Syntax::newl, indicating
;; that a newline has been interpreted as a multiplication operator.
;;
;; There are several approaches to this problem:
;; 1. Avoid the constructs that lead to it.
;; 2. Turn off the messages.
;; 3. Persuade WRI to change the interface.
;; 4. Workaround it. When it occurs
;; a. Clear the input by typing ESC RET. (Moving to a blank line
;; might make you feel better, but shouldn't be necessary.
;; Math-mode keeps track of where the last output ended.)
;; This will send a newline to the Mathematica process
;; and cause it to flush its input and reissue the prompt.
;; (This step is not always necessary.)
;; b. Cut away the message and new prompt. (Or hit the key for
;; undo one or two times.)
;; c. Fix the input, if necessary (it is not necessary for
;; General::Spell), and resubmit the cell.
;;
;; The whole system for running Mathematica on a remote host is rather
;; unreliable. If the built-in facilities don't work, try setting
;; math-process-string to point to a shell script (or compiled program,for
;; that matter), that you can then work with freely.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; Note for people running older versions of Gnu Emacs.
;;
;; On sufficiently old versions of Gnu Emacs, the function copy-keymap
;; did only a "shallow" copy, i.e. it only copied the top level of the
;; key map. To overcome this, this code used to have a function
;; deep-copy-keymap. Unfortunately, deep-copy-keymap is incompatible
;; with Lucid Emacs. Since it is now also unnecessary, on June 6, 1993 I
;; commented out the code for deep-copy-keymap and changed all instances
;; of deep-copy-keymap to copy keymap. If this causes trouble on your
;; machine, uncomment deep-copy-keymap and change all instances of
;; copy-keymap to deep-copy-keymap. Here are two ways of telling if
;; you need deep-copy-keymap.
;; Look at the documentation for copy-keymap. If it looks like this:
;; "Return a copy of the keymap KEYMAP.
;; The copy starts out with the same definitions of KEYMAP,
;; but changing either the copy or KEYMAP does not affect the other.
;; Any key definitions that are subkeymaps are recursively copied."
;; you are probably ok. Also you can first start Mathematica. Then
;; run m-x shell. Then look at the shell keybindings with C-h b.
;; If you see any math-mode commands in there, you definitely need
;; deep-copy-keymap.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defconst emacs-version-18 (string= (substring emacs-version 0 3) "18.")
"t if version 18 of emacs, else nil")
(if emacs-version-18 (require 'shell) (require 'comint))
;; FIXME: FilCab - change for cross-platform
(defvar Mathematica-search-path
(list nil (getenv "HOME") "/Applications/Dev/Mathematica.app/LegacyPackages/StartUp" "/Applications/Dev/Mathematica.app/AddOns/Packages")
"*A list of directories in which to look for files.
Use nil for the current directory.")
;; FIXME: FilCab - change for cross-platform
(defvar math-process-string "/Applications/Dev/Mathematica.app/Contents/MacOS/MathKernel"
"*A string to pass to the unix exec function to start Mathematica")
(defvar math-process-buffer
"*math*"
"The buffer normally running Mathematica. Certain commands
(e.g. math-complete-symbol) will go to this buffer to find a Mathematica
process. This can be locally set with set-math-process-buffer.")
; (defconst math-header-re (concat "^" (regexp-quote "Copyright 1988-91 Wolfram Research, Inc."))
; "A regexp that will match somewhere in the Mathematica preamble")
(defvar math-header-re nil
"A regexp that matches some line in the Mathematic preamble. Nil if
Mathematica is not started.")
(defvar math-remote-host nil
"*If non-nil, use as remote host name with `math-remote-shell' to run
Mathematica remotely. See also variables math-remote-user and
math-display-var")
(defvar math-remote-user nil
"*If non-nil, use as user-ID on remote host. Effective only if
math-remote-host is non-nil. Uses the \"-l\" flag to rsh/remsh")
(defvar math-display-var nil
"*If set to a string, the DISPLAY environment variable is set to this
value. If nil, the DISPLAY environment variable is set the the local
DISPLAY environment variable. If math-display-var is neither nil nor
a string, the DISPLAY environment variable will not be set.")
(defconst math-indent-cookie "|===indent==="
"This string is put in the evironment variable MATHINDENTCOOKIE, and
in version 2.1 and greater and the init.m file is set up properly, this
is assigned to the Mathematica variable `System`Private`$IndentSuffix.
The output parser looks for this value to know to send the next line.")
(defconst math-indent-cookie-message "-- indent cookies enabled --"
"This string in the startup messages indicates that indent cookies
are being used.")
(defvar math-indent-cookies nil
"A buffer specific variable that is t if non-blank math indent cookies
are being used.")
(defvar math-timeout nil
"*If non-nil, use as a timeout between lines of input. Nil is
recommended, unless you are having trouble with the system hanging,
particularly on syntax errors. Nil causes input to be waited for
using accept-process-output. This means the next line of output will
be sent when math-mode receives the indentation prompt from
Mathematica. If non-nil math-mode will wait only math-timeout seconds
between sending lines of input. Usually this needs to be set when
using a remote host. 1 is recommended in this case. (See
math-remote-host and math-remote-shell.)")
(defvar math-remote-shell
(cond ((file-exists-p "/usr/ucb/rsh") "/usr/ucb/rsh")
((file-exists-p "/usr/bsd/rsh") "/usr/bsd/rsh")
((file-exists-p "/usr/bin/remsh") "/usr/bin/remsh"))
"*String used with `math-remote-host' to run Mathematica remotely.")
(defconst math-valid-cell-ending-re
".*\\([])}\"A-Za-z0-9!_`'$%#]\\|\\+\\+\\|--\\|=[ \t]*\\.\\|[^/];\\|\\b[0-9]+\\.\\|[^&]&\\)[ \t]*$"
"An re that matches lines that can validly end complete cells.
This is not perfect.")
;;; The "[^/];" is because "/;" means a condition follows, so it cannot
;;; be the end of a cell. The "=[ \t]*\\." and "\\b[0-9]+\\." allow periods
;;; only in "=." and at the end of mumbers, disallowing a
;;; variable followed by a period (Dot[]). "[^&]&" allows "&" but not "&&".
;;; It will mess up if "&" appears
;;; as the first character on a line by itself, but then the end of the
;;; previous line probably made a valid prefix, which is an error anyway.
(defvar math-send-state 'normal
"The state of the finite state machine that controls interaction with
Mathematica. See the description in a giant comment block in the source
code.")
(defvar math-send-filter-status 'normal
"Status of last input to Mathematica:
`normal' means no problems detected;
`input-prompt' means Mathematica input prompt received
`premature-output' means part of cell not sent due to unexpected output;
`blank-line-added' means line inserted to separate input from output;
`incomplete-cell' means an incomplete cell was detected;
`syntax-error' means a syntax error was detected.")
(defvar mathematica-state ""
"Current state of Mathematica:
`' means no process yet;
`Starting' means the Mathematica process is starting;
`Done' means Mathematica is idle;
`Computing' means Mathematica is busy;
`Printing' means Mathematica is still busy, but has printed something;
`No Process' means Mathematica has exited or has been terminated.")
(defvar math-send-filter-active nil
"Status of Mathematica process filter: t if enabled, else nil.")
(defvar math-last-output-column 8
"The column at which the last \"normal\" output ended. If
math-indent-cookies is false, indent cookies are considered complete if
they are this long.")
(defvar math-completion-symbol nil
"A global variable for communicating between math-help-filter and the
function math-complete-symbol.")
(defvar math-mode-map nil)
;;; deep-copy-keymap was written by Daniel LaLiberte.
;;; It is necessary for some older versions of Gnu Emacs. If
;;; copy-keymap on your system does not do a deep copy (ie copy
;;; all levels, remove the semicolons commenting out the following
;;; code, and replace all instances of copy-keymap in this file
;;; with deep-copy-keymap. This deep-copy-keymap code is known
;;; to be incompatible with Lucid emacs, but isn't necessary
;;; for it either.
; (defun deep-copy-keymap (keymap)
; "Return a deep copy of KEYMAP. That is, all levels are copied,
; not just the top level."
; (if (not (keymapp keymap))
; keymap
; (cond
;
; ((listp keymap)
; (let ((new-keymap (copy-alist keymap)))
; (setq keymap (cdr new-keymap))
; (while keymap
; (let ((binding (car keymap)))
; (if (keymapp (cdr binding))
; (setcdr binding (copy-keymap (cdr binding))))
; )
; (setq keymap (cdr keymap))
; )
; new-keymap
; ))
;
; ((vectorp keymap)
; (let ((i 0)
; (n (length keymap))
; (new-keymap (copy-sequence keymap)))
; (while (< i n)
; (if (keymapp (aref keymap i))
; (aset new-keymap i (copy-keymap (aref keymap i))))
; (setq i (1+ i)))
; new-keymap
; )))))
(defun math-version ()
"Display string indentifying math.el."
(interactive)
(with-output-to-temp-buffer "*Help*" (print-help-return-message))
(let ((home-buffer (current-buffer)))
(pop-to-buffer "*Help*")
(insert math-version-string)
(insert "\n")
(pop-to-buffer home-buffer))
(bury-buffer "*Help*"))
(if math-mode-map
nil
(setq math-mode-map (copy-keymap (if emacs-version-18
shell-mode-map
comint-mode-map)))
(define-key math-mode-map "\C-m" 'newline)
; The shell-mode-mode
; sets this to shell-send-input.
; We change it to 'newline. We
; ought to undefine it, so that
; Emacs will find the 'newline
; in the global keymap, but there
; is no easy way to do this.
(define-key math-mode-map "\M-\C-m" 'math-send-input)
;; \C-c\C-c is set to interrupt-shell-subjob in the shell-mode-mode
;; The name is deceptive; it sends a SIGINT signal (control C) to
;; whatever process is running in the current buffer
(define-key math-mode-map "\C-c9" 'kill-9-process)
(define-key math-mode-map "\C-cv" 'math-version)
(define-key math-mode-map "\C-he" 'math-help) ; e-xpression in help menu
(define-key math-mode-map "\C-hE" 'math-extra-help) ; E-xpression in help menu
(define-key math-mode-map "\C-c\C-f" 'math-edit-function)
(define-key math-mode-map "\M-\t" 'math-complete-symbol)
(define-key math-mode-map "\C-c\C-y" 'math-copy-cell)
(define-key math-mode-map "\C-c\C-e" 'find-math-error)
(define-key math-mode-map "\C-c\C-r" 'math-isearch-backward)
(define-key math-mode-map "\M-k" 'kill-math-cell) ; overrides kill-sentence
(define-key math-mode-map "\C-c\C-k" 'old-kill-math-cell)
;; old-kill-math-cell is effectively just an alias for kill-math-cell
;; but it is named differently so the preferred binding will show up
;; for describe mode
(define-key math-mode-map "\C-c\C-x" 'math-transform-float)
(define-key math-mode-map "\C-c\C-v" 'math-remove-symbol)
)
(defvar math-mode-syntax-table nil
"Syntax table used while in math mode.")
(if math-mode-syntax-table
()
(setq math-mode-syntax-table (make-syntax-table))
(modify-syntax-entry ?% "." math-mode-syntax-table)
(modify-syntax-entry ?& "." math-mode-syntax-table)
(modify-syntax-entry ?* ". 23" math-mode-syntax-table) ;allow for (* comment *)
(modify-syntax-entry ?+ "." math-mode-syntax-table)
(modify-syntax-entry ?- "." math-mode-syntax-table)
(modify-syntax-entry ?/ "." math-mode-syntax-table)
(modify-syntax-entry ?< "." math-mode-syntax-table)
(modify-syntax-entry ?= "." math-mode-syntax-table)
(modify-syntax-entry ?> "." math-mode-syntax-table)
(modify-syntax-entry ?_ "." math-mode-syntax-table)
(modify-syntax-entry ?\| "." math-mode-syntax-table)
(modify-syntax-entry ?\` "_" math-mode-syntax-table) ; Mathematica context symbol
(modify-syntax-entry ?\( "()1" math-mode-syntax-table) ;allow for (* comment *)
(modify-syntax-entry ?\) ")(4" math-mode-syntax-table)) ;allow for (* comment *)
;;; math-send-input sends a chunk of text to Mathematica. It
;;; interacts tightly with math-send-filter using the buffer-specific
;;; variable math-send-state and synchronizes though sending output
;;; and the accept-process-output (but see below) command.
;;; If the Mathematica process does not send a prompt at all, the
;;; accept-process-output hangs and the only solution is to kill the
;;; mathexe process or Emacs. This can happen if you use an Input[""]
;;; (a rather perverse thing to do). An alternative is to replace
;;; (accept-process-output process) with (sleep-for 10). It appears that
;;; arrival of any output causes Emacs to pop immediately out of a
;;; sleep-for. But this could mess up if you have more than one active
;;; process running at a time or if you strike a key.
;;; Of course, we could use a while loop and have the filter set
;;; math-send-state to another value when it has actually gotten
;;; something. I tried this but ran into unknown trouble and have
;;; not followed up on it.
;;; The variable math-send-state has the following interpretatons:
;;; starting-up Mathematica is just starting up.
;;; Snarf up the first line and watch
;;; for the math-indent-cookie-message.
;;;
;;; non-last-line We are in the middle of sending a
;;; multi-line input. Watch for
;;; errors and output other than indent
;;; cookies. Math-send-input exits its
;;; loop as soon as the state is not
;;; non-last-line.
;;;
;;; last-line The last line has been sent, still watch
;;; for syntax error messages. (Approprate
;;; for 1.2 only.) Also insert
;;; a blank like (and warn about it) if the
;;; output contains any non-whitespace
;;; characters before a newline.
;;;
;;; last-line-no-blank Same as last-line, except it doesn't
;;; force a blank line after the cell.
;;;
;;; throw-away-prompt A syntax error has been detected and a
;;; newline sent to Mathematica to flush its
;;; input buffer. Normally it will come
;;; back with a new prompt. If the next
;;; output looks like a prompt, throw it
;;; away and give a syntax error message.
;;; Throw away indent cookies.
;;; Otherwise display the discarded
;;; material in a warning message.
;;; This is only for compatibility with 1.2.
;;;
;;; premature-output Output that was not an indent cookie
;;; was detected in the non-last-line state.
;;; Stop sending. Watch for indent cookies.
;;; Transition to normal whan In or Out are
;;; detected.
;;;
;;; normal Just post the output.
;;;
;;; Note: the syntax error detection code and the correspoinding
;;; throw-away-prompt state were important in 1.2. They should
;;; be unnecessary in 2.0, but were left for compatibility.
;;; No attempt has been made in upgrading to 2.0 to maintain full backward
;;; compatibility, but the basic cell-submission stuff is so important
;;; that backward compatibility is attempted here.
;;; With version 2.1 indent cookie recognition has been added.
;;;
;;; The indent cookie thing watches for indent cookies (normally
;;; "|===indent===", but changable) to be output after each line of a
;;; a multi-line cell. When one is found, it is discarded, and the next line
;;; is sent. Some systems may not support indent cookies. In this case,
;;; we just watch for a blank line ending at the same column as
;;; as the end of the last input prompt. It's not completely reliable, but
;;; works most of the time. When looking for an indent cookie or spaces,
;;; we don't actually put it in the buffer, but accumulate it in the
;;; variable math-partial-output. (It actually is in the variable
;;; string during most of the execution of math-send-filter.)
(defvar math-partial-output ""
"Accumulates output until it can be determined that it is not an indent
cookie")
(defun indent-cookie-p (string &optional ignorestate)
"Checks STRING to see if it is an indent cookie. Returns
t if probably a cookie, nil if definitely not, and 'partial otherwise.
It is not really a predicate of STRING, since it also depends on
math-send-state. If optional IGNORESTATE is true it ignores the
math-send-state."
(if math-indent-cookies
(let (tail)
(cond ((not (or
ignorestate
(memq math-send-state
'(last-line last-line-no-blank non-last-line premature-output))))
nil)
((not (string-match "\\`\\([ \t]*\\)[^ \t]" string)) 'partial)
((string= (setq tail (substring string (match-end 1)))
math-indent-cookie) t)
((>= (length tail) (length math-indent-cookie)) nil)
((string= tail (substring math-indent-cookie
0
(length tail)))
'partial)
(t nil)))
;; now for the math-indent-cookies not true case
(if (or ignorestate (memq math-send-state '(last-line last-line-no-blank non-last-line)))
(if (string-match "\\` +\\'" string)
(let ((len (length string)))
(cond ((< len math-last-output-column) 'partial)
((= len math-last-output-column) t)
(t nil))) ; too long
nil) ; non-blank
nil)) ; not correct state
)
(defvar math-indent-cookie-pending nil "t if we can't decide if we have
an indent cookie.")
(defun math-send-input ()
"Send input to Mathematica.
At end of buffer, sends last \"cell\" to Mathematica. When not at end,
copies current \"cell\" to the end of the buffer and sends it. Also
sends input for interrupt and Input[]. Warning: A multi-line input
to Input[\"\"] will cause deadlock."
(interactive "*")
(let ((process (or (get-buffer-process (current-buffer))
(error "Current buffer has no process")))
bpt2
ept2
begpkt
endpkt
copy
)
;; Find beginning of "cell"
(let* ((cellinfo (math-identify-cell
(point) 'submit (process-mark process)))
(bpt (car cellinfo))
(ept (nth 1 cellinfo))
)
(check-math-syntax bpt ept)
(goto-char ept)
;; Move to line beyond cell, adding newline if necessary.
(forward-line 1)
(if (or (not (bolp))
(= (point) bpt)) ; make null cells contain a newline
(newline))
(setq copy (buffer-substring bpt (point)))
;; If we are \"near\" the end of the buffer, we don't copy the data down
;; there, but we kill excess white space. Otherwise, we go there and
;; copy the data.
(if (looking-at "\\s *\\'")
(progn
(replace-match "")
(setq bpt2 bpt)
(setq ept2 (point))
(setq math-last-input-end (point)))
(push-mark bpt) ; This sets the mark when copying down a cell
(goto-char (point-max))
(forward-line 0)
(if (or (eolp) (looking-at "^[ \t]*In\\[[0-9]+\\]:=\\s *$"))
(end-of-line)
(end-of-line)
(newline))
(setq bpt2 (point))
(insert copy)
(setq ept2 (point))
(setq math-last-input-end (point)))
(goto-char bpt2)
(setq math-partial-output "")
(setq math-indent-cookie-pending nil)
(setq math-send-filter-status 'normal) ; For single line input without filter
; ..
(set-process-filter process 'math-send-filter)
;; math-send-state is a global variable
(setq math-send-state 'non-last-line)
(setq begpkt bpt2) ; point
(setq mathematica-state "Computing")
;; (message "*")
(unwind-protect
(while (eq math-send-state 'non-last-line)
(goto-char begpkt)
(forward-line 1)
(setq endpkt (point))
;; set flag to exit loop and tell math-send-filter to
;; deal with next output as non-intermediate lines.
;; If this line likely came from an Input[...] have it
;; not force a blank line.
(if (= endpkt ept2)
(setq math-send-state (if (nth 2 cellinfo)
'last-line-no-blank
'last-line)))
(metered-process-send-string
process (buffer-substring begpkt endpkt))
(if (eq math-send-state 'non-last-line)
(if math-timeout
(sleep-for math-timeout)
(accept-process-output process)
(while math-indent-cookie-pending
(accept-process-output process))))
(setq begpkt endpkt) ; advance to next line
) ; end while
;; unwind-protect tail; here for future use
))))
(defun check-dangling-indent-cookie (proc)
;; proc can be nil
(if (eq (indent-cookie-p
(buffer-substring (save-excursion
(forward-line 0)
(point))
(point))
t) ; ignore state
t)
(progn
(setq math-send-state 'normal)
(setq math-send-filter-status 'incomplete-cell);????
(if (and proc math-indent-cookies) ; without cookies it is too
; unreliable to send the newline
(progn
(newline 2)
(ding t)
(message "Incomplete cell! Newline sent to clear input.")
(process-send-string proc "\n"))
(ding t)
(message "Incomplete cell? Clear input with ESC RET.")
)
t)
nil) ;end if
)
(defun math-send-filter (proc procstring)
(let ((cbuf (current-buffer))
(save-match-data (match-data))
(string (concat math-partial-output procstring))
incomplete-cell
cookie-status)
(unwind-protect
(progn
(setq math-partial-output "")
(setq math-indent-cookie-pending nil) ; assume for now this ouput
;completes an indent cookie
(set-buffer (process-buffer proc))
(setq cookie-status (indent-cookie-p string))
(cond
;; cond branch: can not tell if it is or is not an indent cookie
((eq cookie-status 'partial)
(setq math-partial-output string)
(setq math-indent-cookie-pending t))
;; if state is starting-up
;; check for math-send-cookie-message in startup strings
;; snarf up beginning string
;; exit to normal when In[...] is found
;; We insert and search in the buffer since we might get more
;; than one line at a time.
((eq math-send-state 'starting-up)
(let ((beg (point-max))
end)
(goto-char beg)
(insert string)
(set-marker (process-mark proc) (point))
(setq end (point))
(goto-char beg)
(forward-line 0)
(if (and (not math-header-re)
(looking-at "^.*\n"))
(setq math-header-re
(concat "^" (regexp-quote
(buffer-substring (match-beginning 0)
(match-end 0))))))
(if (and (not math-indent-cookies)
(re-search-forward math-indent-cookie-message
end t))
(setq math-indent-cookies t))
(goto-char end)
(forward-line 0)
(if (looking-at "^[ \t]*In\\[[0-9]+\\]")
(setq math-send-state 'normal))
(goto-char end)))
;; cond branch: a <retype-line error>
;; retained for version 1.2 compatibility
((and
(memq math-send-state '(non-last-line last-line last-line-no-blank))
(string-match "\\`\\([ \t]*\\)\\^ <retype line>" string))
(let ((tpt (point))
error-column
indent-column
(tail-string (substring string (match-end 0))))
(goto-char tpt)
(insert (substring string 0 (match-end 1)))
(setq error-column (current-column))
(delete-region tpt (point))
(indent-to-column (- error-column math-last-output-column))
(insert "^--error\n")
(backward-char 9)
(previous-line 1)
;; Display any unexpected output. I don't know how to
;; test this code.
(if (string-match "\\S " tail-string)
(save-excursion
(goto-char (point-max))
(insert tail-string)
(set-marker (process-mark proc) (point))))) ; end of let
(setq math-send-state 'throw-away-prompt)
(message "Syntax error") ; live dangerously here, but sometimes we
; don't get a prompt back from
; Mathematica
(process-send-string proc "\n")
(setq math-send-filter-status 'syntax-error)
)
;; cond branch: snarf up indent strings
;; Whether or not this branch is taken when math-send-state
;; is throw-away-prompt depends on the OS. On some systems
;; the indent cookie comes out with the "^ <retype-line>"
;; (in 1.2 only)
;; and the indent cookie is inserted by the tail-string
;; procesing above. On others it comes out separately and is
;; handled here.
((and
(memq math-send-state '(non-last-line throw-away-prompt))
(eq cookie-status t))) ; do nothing
;; cond branch: unexpected output
((eq math-send-state 'non-last-line)
(insert
"-------- Unexpected output appeared here; rest of cell not sent --------\n"
)
(goto-char (point-max))
(insert string)
(setq math-last-output-column (current-column))
(set-marker (process-mark proc) (point))
(setq math-send-state 'premature-output)
(setq math-send-filter-status 'premature-output)
;; the following if checks for a dangling indent cookie right
;; after unexpected output. But it probably never happens
;; since the unexpected output is probably several i/o chunks
;; long and the state is normal by the time any indent cookie
;; finally arrives. Thus the message is almost always sent.
(if (not (check-dangling-indent-cookie proc))
; check-dangling-indent-cookie
; generates its own message
(progn
(ding t)
;; (message "")
)))
;; cond branch: throw away unwanted prompt
((eq math-send-state 'throw-away-prompt)
(setq math-send-state 'normal)
(if (string-match "\\`[ \t]*In\\[[0-9]+\\]:= \\'" string)
(message "Syntax error")
(message "Syntax error, discarding prompt(?): %s"
string))
(setq math-send-filter-status 'syntax-error)
)
;; cond branch: last line has been sent, make sure a blank line
;; follows the In... stuff. See further comments.
((memq math-send-state '(last-line last-line-no-blank))
(goto-char (point-max))
;; except in the case of an indent cookie the string
;; that was received is inserted after this big cond.
(cond ((string-match "\\`\\s *\n" string); blank with newline
(setq math-send-state 'normal)
;; (message "")
) ; clear "*" in message area
((eq cookie-status t)
; give help message
(setq math-send-filter-status 'incomplete-cell)
(setq math-send-state 'normal)
(setq incomplete-cell t)
(process-send-string proc "\n")
(newline)
(ding t) ; don't do anything funny
(message "Incomplete cell! Newline sent to clear input.")
)
((string-match "\\`[ \t]*In\\[[0-9]+\\]:=" string)
;; (message "") ; clear "*" in message area.
(setq math-send-state 'normal)
(setq math-send-filter-status 'normal)
)
;; cond branch. Output was cell sent in response to
;; an Input[...] (sometimes)
((eq math-send-state 'last-line-no-blank)
(setq math-send-filter-status 'normal)
(setq math-send-state 'normal))
;; cond brach
(t
;; non-blank, but not an In[] prompt. Probably either
;; output of a Mathematica Print[...] or an error message.
;; Add a blank line to separate cells.
(newline)
(message "newline inserted by Emacs' math-mode")
(setq math-send-filter-status 'blank-line-added)
(setq math-send-state 'normal)
)
)
(if (not incomplete-cell)
(progn
(insert string)
(set-marker (process-mark proc) (point))
(setq math-last-output-column (current-column)))))
;; cond branch. premature output
((eq math-send-state 'premature-output)
(setq math-send-filter-status 'normal)
(goto-char (point-max))
(insert string)
(setq math-last-output-column (current-column))
(set-marker (process-mark proc) (point))
(if (save-excursion
(forward-line 0)
(looking-at "\\(^[ \t]*In\\[[0-9]+\\]:= ?\\)\\|\\(^[ \t]*Out\\[[0-9]+\\]\\(//[^=]*\\)?= ?\\)"))
(setq math-send-state 'normal)
(check-dangling-indent-cookie proc)))
(t
(setq math-send-filter-status 'normal)
(goto-char (point-max))
(insert string)
(setq math-last-output-column (current-column))
(set-marker (process-mark proc) (point))
;; at one time a check was made here for dangling indent cookies.
;; but only if math-indent-cookies was true, since otherwise
;; graphics resulted in spurious warnings. However
;; this code was deleted since with math-indent-cookies true
;; you can see an indent cookie anyway, and if it happens when the
;; math-send-state is 'normal, there is something seriously wrong
;; anyway.
)) ; finish off t branch and entire cond
(set-buffer-modified-p (buffer-modified-p)) ;Update modeline
(save-excursion
(forward-line 0)
(if (not (looking-at "^[ \t]*In\\[[0-9]+\\]:= "))
(setq mathematica-state "Printing")
(setq math-send-filter-active nil) ; Synchronize with tex-mma
(setq mathematica-state "Done"))
(set-buffer-modified-p (buffer-modified-p)) ;Update modeline
)
) ; end of prgn
;; safely exit the filter
;; unwind-protect tail
(set-buffer cbuf)
(store-match-data save-match-data))))
(defun math-sentinel (process msg)
(cond ((eq (process-status process) 'exit)
(setq mathematica-state "No Process")
(let ((p (process-buffer process))
(b (current-buffer)))
(set-buffer p)
(goto-char (point-max))
(insert "Process " (process-name process) " " msg)
(set-buffer b)))))
(defun math-mode ()
"Major mode for interacting with Mathematica and editing .m files.
\\[math] starts Mathematica. (See below for starting Mathematica on a
remote host.)
\\[math-send-input] tries to identify stuff following last \"In[...]:=\"
or blank line or the last output and sends it. To clear out
Mathmatica after an error occurs, move point two lines below last
printing character and type \\[math-send-input]. Warning: do not
use Input[\"\"], and type in a mult-line reply; deadlock results.
\\[math-copy-cell] will copy a previous cell to the end of the buffer.
It prompts for the number of the cell to copy. Blank is previous cell.
There are many more (and very useful) options.
Type \\[describe-key] \\[math-copy-cell] to see the full details.
\\[math-help] gives help on a Mathematica symbol. With wildcards
it lists all matching symbols.
\\[math-extra-help] or C-u \\[math-help] give more verbose help.
These functions use Mathematica's ? and ?? operations.
\\[math-complete-symbol] will complete the symbol near point.
\\[math-isearch-backward] does a backward regexp i-search,
initialized to find In[...].