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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
| | ;;; octave.el --- editing octave source files under emacs -*- lexical-binding: t; -*-
;; Copyright (C) 1997, 2001-2013 Free Software Foundation, Inc.
;; Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
;; John Eaton <jwe@octave.org>
;; Maintainer: FSF
;; Keywords: languages
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This package provides Emacs support for Octave. It defines a major
;; mode for editing Octave code and contains code for interacting with
;; an inferior Octave process using comint.
;; See the documentation of `octave-mode' and `run-octave' for further
;; information on usage and customization.
;;; Code:
(require 'comint)
;;; For emacs < 24.3.
(require 'newcomment)
(eval-and-compile
(unless (fboundp 'user-error)
(defalias 'user-error 'error))
(unless (fboundp 'delete-consecutive-dups)
(defalias 'delete-consecutive-dups 'delete-dups)))
(eval-when-compile
(unless (fboundp 'setq-local)
(defmacro setq-local (var val)
"Set variable VAR to value VAL in current buffer."
(list 'set (list 'make-local-variable (list 'quote var)) val))))
(defgroup octave nil
"Editing Octave code."
:link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
:group 'languages)
(define-obsolete-function-alias 'octave-submit-bug-report
'report-emacs-bug "24.4")
(define-abbrev-table 'octave-abbrev-table nil
"Abbrev table for Octave's reserved words.
Used in `octave-mode' and `inferior-octave-mode' buffers.")
(defvar octave-comment-char ?#
"Character to start an Octave comment.")
(defvar octave-comment-start (char-to-string octave-comment-char)
"Octave-specific `comment-start' (which see).")
(defvar octave-comment-start-skip "\\(^\\|\\S<\\)\\(?:%!\\|\\s<+\\)\\s-*"
"Octave-specific `comment-start-skip' (which see).")
(defvar octave-begin-keywords
'("classdef" "do" "enumeration" "events" "for" "function" "if" "methods"
"parfor" "properties" "switch" "try" "unwind_protect" "while"))
(defvar octave-else-keywords
'("case" "catch" "else" "elseif" "otherwise" "unwind_protect_cleanup"))
(defvar octave-end-keywords
'("endclassdef" "endenumeration" "endevents" "endfor" "endfunction" "endif"
"endmethods" "endparfor" "endproperties" "endswitch" "end_try_catch"
"end_unwind_protect" "endwhile" "until" "end"))
(defvar octave-reserved-words
(append octave-begin-keywords
octave-else-keywords
octave-end-keywords
'("break" "continue" "global" "persistent" "return"))
"Reserved words in Octave.")
(defvar octave-function-header-regexp
(concat "^\\s-*\\_<\\(function\\)\\_>"
"\\([^=;(\n]*=[ \t]*\\|[ \t]*\\)\\(\\(?:\\w\\|\\s_\\)+\\)\\_>")
"Regexp to match an Octave function header.
The string `function' and its name are given by the first and third
parenthetical grouping.")
\f
(defvar octave-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\M-." 'octave-find-definition)
(define-key map "\M-\C-j" 'octave-indent-new-comment-line)
(define-key map "\C-c\C-p" 'octave-previous-code-line)
(define-key map "\C-c\C-n" 'octave-next-code-line)
(define-key map "\C-c\C-a" 'octave-beginning-of-line)
(define-key map "\C-c\C-e" 'octave-end-of-line)
(define-key map [remap down-list] 'smie-down-list)
(define-key map "\C-c\M-\C-h" 'octave-mark-block)
(define-key map "\C-c]" 'smie-close-block)
(define-key map "\C-c/" 'smie-close-block)
(define-key map "\C-c;" 'octave-update-function-file-comment)
(define-key map "\C-hd" 'octave-help)
(define-key map "\C-ha" 'octave-lookfor)
(define-key map "\C-c\C-f" 'octave-insert-defun)
(define-key map "\C-c\C-il" 'octave-send-line)
(define-key map "\C-c\C-ib" 'octave-send-block)
(define-key map "\C-c\C-if" 'octave-send-defun)
(define-key map "\C-c\C-ir" 'octave-send-region)
(define-key map "\C-c\C-ia" 'octave-send-buffer)
(define-key map "\C-c\C-is" 'octave-show-process-buffer)
(define-key map "\C-c\C-iq" 'octave-hide-process-buffer)
(define-key map "\C-c\C-ik" 'octave-kill-process)
(define-key map "\C-c\C-i\C-l" 'octave-send-line)
(define-key map "\C-c\C-i\C-b" 'octave-send-block)
(define-key map "\C-c\C-i\C-f" 'octave-send-defun)
(define-key map "\C-c\C-i\C-r" 'octave-send-region)
(define-key map "\C-c\C-i\C-a" 'octave-send-buffer)
(define-key map "\C-c\C-i\C-s" 'octave-show-process-buffer)
(define-key map "\C-c\C-i\C-q" 'octave-hide-process-buffer)
(define-key map "\C-c\C-i\C-k" 'octave-kill-process)
map)
"Keymap used in Octave mode.")
(easy-menu-define octave-mode-menu octave-mode-map
"Menu for Octave mode."
'("Octave"
["Split Line at Point" octave-indent-new-comment-line t]
["Previous Code Line" octave-previous-code-line t]
["Next Code Line" octave-next-code-line t]
["Begin of Line" octave-beginning-of-line t]
["End of Line" octave-end-of-line t]
["Mark Block" octave-mark-block t]
["Close Block" smie-close-block t]
"---"
["Start Octave Process" run-octave t]
["Documentation Lookup" info-lookup-symbol t]
["Help on Function" octave-help t]
["Search help" octave-lookfor t]
["Find Function Definition" octave-find-definition t]
["Insert Function" octave-insert-defun t]
["Update Function File Comment" octave-update-function-file-comment t]
"---"
["Function Syntax Hints" (call-interactively
(if (fboundp 'eldoc-post-insert-mode)
'eldoc-post-insert-mode
'eldoc-mode))
:style toggle :selected (or eldoc-post-insert-mode eldoc-mode)
:help "Display function signatures after typing `SPC' or `('"]
["Delimiter Matching" show-paren-mode
:style toggle :selected show-paren-mode
:help "Highlight matched pairs such as `if ... end'"
:visible (fboundp 'smie--matching-block-data)]
["Auto Fill" auto-fill-mode
:style toggle :selected auto-fill-function
:help "Automatic line breaking"]
["Electric Layout" electric-layout-mode
:style toggle :selected electric-layout-mode
:help "Automatically insert newlines around some chars"]
"---"
("Debug"
["Send Current Line" octave-send-line t]
["Send Current Block" octave-send-block t]
["Send Current Function" octave-send-defun t]
["Send Region" octave-send-region t]
["Send Buffer" octave-send-buffer t]
["Show Process Buffer" octave-show-process-buffer t]
["Hide Process Buffer" octave-hide-process-buffer t]
["Kill Process" octave-kill-process t])
"---"
["Customize Octave" (customize-group 'octave) t]
["Submit Bug Report" report-emacs-bug t]))
(defvar octave-mode-syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?\r " " table)
(modify-syntax-entry ?+ "." table)
(modify-syntax-entry ?- "." table)
(modify-syntax-entry ?= "." table)
(modify-syntax-entry ?* "." table)
(modify-syntax-entry ?/ "." table)
(modify-syntax-entry ?> "." table)
(modify-syntax-entry ?< "." table)
(modify-syntax-entry ?& "." table)
(modify-syntax-entry ?| "." table)
(modify-syntax-entry ?! "." table)
(modify-syntax-entry ?\\ "." table)
(modify-syntax-entry ?\' "." table)
(modify-syntax-entry ?\` "." table)
(modify-syntax-entry ?. "." table)
(modify-syntax-entry ?\" "\"" table)
(modify-syntax-entry ?_ "_" table)
;; The "b" flag only applies to the second letter of the comstart
;; and the first letter of the comend, i.e. the "4b" below is ineffective.
;; If we try to put `b' on the single-line comments, we get a similar
;; problem where the % and # chars appear as first chars of the 2-char
;; comend, so the multi-line ender is also turned into style-b.
;; So we need the new "c" comment style.
(modify-syntax-entry ?\% "< 13" table)
(modify-syntax-entry ?\# "< 13" table)
(modify-syntax-entry ?\{ "(} 2c" table)
(modify-syntax-entry ?\} "){ 4c" table)
(modify-syntax-entry ?\n ">" table)
table)
"Syntax table in use in `octave-mode' buffers.")
(defcustom octave-font-lock-texinfo-comment t
"Control whether to highlight the texinfo comment block."
:type 'boolean
:group 'octave
:version "24.4")
(defcustom octave-blink-matching-block t
"Control the blinking of matching Octave block keywords.
Non-nil means show matching begin of block when inserting a space,
newline or semicolon after an else or end keyword."
:type 'boolean
:group 'octave)
(defcustom octave-block-offset 2
"Extra indentation applied to statements in Octave block structures."
:type 'integer
:group 'octave)
(defvar octave-block-comment-start
(concat (make-string 2 octave-comment-char) " ")
"String to insert to start a new Octave comment on an empty line.")
(defcustom octave-continuation-offset 4
"Extra indentation applied to Octave continuation lines."
:type 'integer
:group 'octave)
(eval-and-compile
(defconst octave-continuation-marker-regexp "\\\\\\|\\.\\.\\."))
(defvar octave-continuation-regexp
(concat "[^#%\n]*\\(" octave-continuation-marker-regexp
"\\)\\s-*\\(\\s<.*\\)?$"))
;; Char \ is considered a bad decision for continuing a line.
(defconst octave-continuation-string "..."
"Character string used for Octave continuation lines.")
(defvar octave-mode-imenu-generic-expression
(list
;; Functions
(list nil octave-function-header-regexp 3))
"Imenu expression for Octave mode. See `imenu-generic-expression'.")
(defcustom octave-mode-hook nil
"Hook to be run when Octave mode is started."
:type 'hook
:group 'octave)
(defcustom octave-send-show-buffer t
"Non-nil means display `inferior-octave-buffer' after sending to it."
:type 'boolean
:group 'octave)
(defcustom octave-send-line-auto-forward t
"Control auto-forward after sending to the inferior Octave process.
Non-nil means always go to the next Octave code line after sending."
:type 'boolean
:group 'octave)
(defcustom octave-send-echo-input t
"Non-nil means echo input sent to the inferior Octave process."
:type 'boolean
:group 'octave)
\f
;;; SMIE indentation
(require 'smie)
;; Use '__operators__' in Octave REPL to get a full list.
(defconst octave-operator-table
'((assoc ";" "\n") (assoc ",") ; The doc claims they have equal precedence!?
(right "=" "+=" "-=" "*=" "/=")
(assoc "&&") (assoc "||") ; The doc claims they have equal precedence!?
(assoc "&") (assoc "|") ; The doc claims they have equal precedence!?
(nonassoc "<" "<=" "==" ">=" ">" "!=" "~=")
(nonassoc ":") ;No idea what this is.
(assoc "+" "-")
(assoc "*" "/" "\\" ".\\" ".*" "./")
(nonassoc "'" ".'")
(nonassoc "++" "--" "!" "~") ;And unary "+" and "-".
(right "^" "**" ".^" ".**")
;; It's not really an operator, but for indentation purposes it
;; could be convenient to treat it as one.
(assoc "...")))
(defconst octave-smie-bnf-table
'((atom)
;; We can't distinguish the first element in a sequence with
;; precedence grammars, so we can't distinguish the condition
;; if the `if' from the subsequent body, for example.
;; This has to be done later in the indentation rules.
(exp (exp "\n" exp)
;; We need to mention at least one of the operators in this part
;; of the grammar: if the BNF and the operator table have
;; no overlap, SMIE can't know how they relate.
(exp ";" exp)
("try" exp "catch" exp "end_try_catch")
("try" exp "catch" exp "end")
("unwind_protect" exp
"unwind_protect_cleanup" exp "end_unwind_protect")
("unwind_protect" exp "unwind_protect_cleanup" exp "end")
("for" exp "endfor")
("for" exp "end")
("parfor" exp "endparfor")
("parfor" exp "end")
("do" exp "until" atom)
("while" exp "endwhile")
("while" exp "end")
("if" exp "endif")
("if" exp "else" exp "endif")
("if" exp "elseif" exp "else" exp "endif")
("if" exp "elseif" exp "elseif" exp "else" exp "endif")
("if" exp "elseif" exp "elseif" exp "else" exp "end")
("switch" exp "case" exp "endswitch")
("switch" exp "case" exp "otherwise" exp "endswitch")
("switch" exp "case" exp "case" exp "otherwise" exp "endswitch")
("switch" exp "case" exp "case" exp "otherwise" exp "end")
("function" exp "endfunction")
("function" exp "end")
("enumeration" exp "endenumeration")
("enumeration" exp "end")
("events" exp "endevents")
("events" exp "end")
("methods" exp "endmethods")
("methods" exp "end")
("properties" exp "endproperties")
("properties" exp "end")
("classdef" exp "endclassdef")
("classdef" exp "end"))
;; (fundesc (atom "=" atom))
))
(defconst octave-smie-grammar
(smie-prec2->grammar
(smie-merge-prec2s
(smie-bnf->prec2 octave-smie-bnf-table
'((assoc "\n" ";")))
(smie-precs->prec2 octave-operator-table))))
;; Tokenizing needs to be refined so that ";;" is treated as two
;; tokens and also so as to recognize the \n separator (and
;; corresponding continuation lines).
(defconst octave-operator-regexp
(regexp-opt (apply 'append (mapcar 'cdr octave-operator-table))))
(defun octave-smie-backward-token ()
(let ((pos (point)))
(forward-comment (- (point)))
(cond
((and (not (eq (char-before) ?\;)) ;Coalesce ";" and "\n".
(> pos (line-end-position))
(if (looking-back octave-continuation-marker-regexp (- (point) 3))
(progn
(goto-char (match-beginning 0))
(forward-comment (- (point)))
nil)
t)
;; Ignore it if it's within parentheses.
(let ((ppss (syntax-ppss)))
(not (and (nth 1 ppss)
(eq ?\( (char-after (nth 1 ppss)))))))
(skip-chars-forward " \t")
;; Why bother distinguishing \n and ;?
";") ;;"\n"
((and (looking-back octave-operator-regexp (- (point) 3) 'greedy)
;; Don't mistake a string quote for a transpose.
(not (looking-back "\\s\"" (1- (point)))))
(goto-char (match-beginning 0))
(match-string-no-properties 0))
(t
(smie-default-backward-token)))))
(defun octave-smie-forward-token ()
(skip-chars-forward " \t")
(when (looking-at (eval-when-compile
(concat "\\(" octave-continuation-marker-regexp
"\\)[ \t]*\\($\\|[%#]\\)")))
(goto-char (match-end 1))
(forward-comment 1))
(cond
((and (looking-at "[%#\n]")
(not (or (save-excursion (skip-chars-backward " \t")
;; Only add implicit ; when needed.
(or (bolp) (eq (char-before) ?\;)))
;; Ignore it if it's within parentheses.
(let ((ppss (syntax-ppss)))
(and (nth 1 ppss)
(eq ?\( (char-after (nth 1 ppss))))))))
(if (eolp) (forward-char 1) (forward-comment 1))
;; Why bother distinguishing \n and ;?
";") ;;"\n"
((progn (forward-comment (point-max)) nil))
((looking-at ";[ \t]*\\($\\|[%#]\\)")
;; Combine the ; with the subsequent \n.
(goto-char (match-beginning 1))
(forward-comment 1)
";")
((and (looking-at octave-operator-regexp)
;; Don't mistake a string quote for a transpose.
(not (looking-at "\\s\"")))
(goto-char (match-end 0))
(match-string-no-properties 0))
(t
(smie-default-forward-token))))
(defun octave-smie-rules (kind token)
(pcase (cons kind token)
;; We could set smie-indent-basic instead, but that would have two
;; disadvantages:
;; - changes to octave-block-offset wouldn't take effect immediately.
;; - edebug wouldn't show the use of this variable.
(`(:elem . basic) octave-block-offset)
;; Since "case" is in the same BNF rules as switch..end, SMIE by default
;; aligns it with "switch".
(`(:before . "case") (if (not (smie-rule-sibling-p)) octave-block-offset))
(`(:after . ";")
(if (smie-rule-parent-p "classdef" "events" "enumeration" "function" "if"
"while" "else" "elseif" "for" "parfor"
"properties" "methods" "otherwise" "case"
"try" "catch" "unwind_protect"
"unwind_protect_cleanup")
(smie-rule-parent octave-block-offset)
;; For (invalid) code between switch and case.
;; (if (smie-parent-p "switch") 4)
nil))))
(defun octave-indent-comment ()
"A function for `smie-indent-functions' (which see)."
(save-excursion
(back-to-indentation)
(cond
((octave-in-string-or-comment-p) nil)
((looking-at-p "\\(\\s<\\)\\1\\{2,\\}")
0)
;; Exclude %{, %} and %!.
((and (looking-at-p "\\s<\\(?:[^{}!]\\|$\\)")
(not (looking-at-p "\\(\\s<\\)\\1")))
(comment-choose-indent)))))
\f
(defvar octave-font-lock-keywords
(list
;; Fontify all builtin keywords.
(cons (concat "\\_<\\("
(regexp-opt octave-reserved-words)
"\\)\\_>")
'font-lock-keyword-face)
;; Note: 'end' also serves as the last index in an indexing expression.
;; Ref: http://www.mathworks.com/help/matlab/ref/end.html
(list (lambda (limit)
(while (re-search-forward "\\_<end\\_>" limit 'move)
(let ((beg (match-beginning 0))
(end (match-end 0)))
(unless (octave-in-string-or-comment-p)
(condition-case nil
(progn
(goto-char beg)
(backward-up-list)
(when (memq (char-after) '(?\( ?\[ ?\{))
(put-text-property beg end 'face nil))
(goto-char end))
(error (goto-char end))))))
nil))
;; Fontify all operators.
(cons octave-operator-regexp 'font-lock-builtin-face)
;; Fontify all function declarations.
(list octave-function-header-regexp
'(1 font-lock-keyword-face)
'(3 font-lock-function-name-face nil t)))
"Additional Octave expressions to highlight.")
(defun octave-syntax-propertize-function (start end)
(goto-char start)
(octave-syntax-propertize-sqs end)
(funcall (syntax-propertize-rules
("\\\\" (0 (when (eq (nth 3 (save-excursion
(syntax-ppss (match-beginning 0))))
?\")
(string-to-syntax "\\"))))
;; Try to distinguish the string-quotes from the transpose-quotes.
("\\(?:^\\|[[({,; ]\\)\\('\\)"
(1 (prog1 "\"'" (octave-syntax-propertize-sqs end)))))
(point) end))
(defun octave-syntax-propertize-sqs (end)
"Propertize the content/end of single-quote strings."
(when (eq (nth 3 (syntax-ppss)) ?\')
;; A '..' string.
(when (re-search-forward
"\\(?:\\=\\|[^']\\)\\(?:''\\)*\\('\\)\\($\\|[^']\\)" end 'move)
(goto-char (match-beginning 2))
(when (eq (char-before (match-beginning 1)) ?\\)
;; Backslash cannot escape a single quote.
(put-text-property (1- (match-beginning 1)) (match-beginning 1)
'syntax-table (string-to-syntax ".")))
(put-text-property (match-beginning 1) (match-end 1)
'syntax-table (string-to-syntax "\"'")))))
(defvar electric-layout-rules)
;;;###autoload
(define-derived-mode octave-mode prog-mode "Octave"
"Major mode for editing Octave code.
Octave is a high-level language, primarily intended for numerical
computations. It provides a convenient command line interface
for solving linear and nonlinear problems numerically. Function
definitions can also be stored in files and used in batch mode."
:abbrev-table octave-abbrev-table
(smie-setup octave-smie-grammar #'octave-smie-rules
:forward-token #'octave-smie-forward-token
:backward-token #'octave-smie-backward-token)
(setq-local smie-indent-basic 'octave-block-offset)
(add-hook 'smie-indent-functions #'octave-indent-comment nil t)
(setq-local smie-blink-matching-triggers
(cons ?\; smie-blink-matching-triggers))
(unless octave-blink-matching-block
(remove-hook 'post-self-insert-hook #'smie-blink-matching-open 'local))
(setq-local electric-indent-chars
(cons ?\; electric-indent-chars))
;; IIUC matlab-mode takes the opposite approach: it makes RET insert
;; a ";" at those places where it's correct (i.e. outside of parens).
(setq-local electric-layout-rules '((?\; . after)))
(setq-local comment-use-global-state t)
(setq-local comment-start octave-comment-start)
(setq-local comment-end "")
(setq-local comment-start-skip octave-comment-start-skip)
(setq-local comment-add 1)
(setq-local parse-sexp-ignore-comments t)
(setq-local paragraph-start (concat "\\s-*$\\|" page-delimiter))
(setq-local paragraph-separate paragraph-start)
(setq-local paragraph-ignore-fill-prefix t)
(setq-local fill-paragraph-function 'octave-fill-paragraph)
(setq-local fill-nobreak-predicate
(lambda () (eq (octave-in-string-p) ?')))
(with-no-warnings
(if (fboundp 'add-function) ; new in 24.4
(add-function :around (local 'comment-line-break-function)
#'octave--indent-new-comment-line)
(setq-local comment-line-break-function
(apply-partially #'octave--indent-new-comment-line
#'comment-indent-new-line))))
(setq font-lock-defaults '(octave-font-lock-keywords))
(setq-local syntax-propertize-function #'octave-syntax-propertize-function)
(setq-local imenu-generic-expression octave-mode-imenu-generic-expression)
(setq-local imenu-case-fold-search nil)
(setq-local add-log-current-defun-function #'octave-add-log-current-defun)
(add-hook 'completion-at-point-functions 'octave-completion-at-point nil t)
(add-hook 'before-save-hook 'octave-sync-function-file-names nil t)
(setq-local beginning-of-defun-function 'octave-beginning-of-defun)
(and octave-font-lock-texinfo-comment (octave-font-lock-texinfo-comment))
(setq-local eldoc-documentation-function 'octave-eldoc-function)
(easy-menu-add octave-mode-menu))
\f
(defcustom inferior-octave-program "octave"
"Program invoked by `inferior-octave'."
:type 'string
:group 'octave)
(defcustom inferior-octave-buffer "*Inferior Octave*"
"Name of buffer for running an inferior Octave process."
:type 'string
:group 'octave)
(defcustom inferior-octave-prompt
"\\(^octave\\(\\|.bin\\|.exe\\)\\(-[.0-9]+\\)?\\(:[0-9]+\\)?\\|^debug\\|^\\)>+ "
"Regexp to match prompts for the inferior Octave process."
:type 'regexp
:group 'octave)
(defcustom inferior-octave-prompt-read-only comint-prompt-read-only
"If non-nil, the Octave prompt is read only.
See `comint-prompt-read-only' for details."
:type 'boolean
:group 'octave
:version "24.4")
(defcustom inferior-octave-startup-file
(let ((n (file-name-nondirectory inferior-octave-program)))
(locate-user-emacs-file (format "init_%s.m" n) (format ".emacs-%s" n)))
"Name of the inferior Octave startup file.
The contents of this file are sent to the inferior Octave process on
startup."
:type '(choice (const :tag "None" nil) file)
:group 'octave
:version "24.4")
(defcustom inferior-octave-startup-args '("-i" "--no-line-editing")
"List of command line arguments for the inferior Octave process.
For example, for suppressing the startup message and using `traditional'
mode, include \"-q\" and \"--traditional\"."
:type '(repeat string)
:group 'octave
:version "24.4")
(defcustom inferior-octave-mode-hook nil
"Hook to be run when Inferior Octave mode is started."
:type 'hook
:group 'octave)
(defvar inferior-octave-process nil)
(defvar inferior-octave-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map comint-mode-map)
(define-key map "\M-." 'octave-find-definition)
(define-key map "\t" 'completion-at-point)
(define-key map "\C-hd" 'octave-help)
(define-key map "\C-ha" 'octave-lookfor)
;; Same as in `shell-mode'.
(define-key map "\M-?" 'comint-dynamic-list-filename-completions)
(define-key map "\C-c\C-l" 'inferior-octave-dynamic-list-input-ring)
(define-key map [menu-bar inout list-history]
'("List Input History" . inferior-octave-dynamic-list-input-ring))
map)
"Keymap used in Inferior Octave mode.")
(defvar inferior-octave-mode-syntax-table
(let ((table (make-syntax-table octave-mode-syntax-table)))
table)
"Syntax table in use in `inferior-octave-mode' buffers.")
(defvar inferior-octave-font-lock-keywords
(list
(cons inferior-octave-prompt 'font-lock-type-face))
;; Could certainly do more font locking in inferior Octave ...
"Additional expressions to highlight in Inferior Octave mode.")
(defvar inferior-octave-output-list nil)
(defvar inferior-octave-output-string nil)
(defvar inferior-octave-receive-in-progress nil)
(define-obsolete-variable-alias 'inferior-octave-startup-hook
'inferior-octave-mode-hook "24.4")
(defvar inferior-octave-dynamic-complete-functions
'(inferior-octave-completion-at-point comint-filename-completion)
"List of functions called to perform completion for inferior Octave.
This variable is used to initialize `comint-dynamic-complete-functions'
in the Inferior Octave buffer.")
(defvar info-lookup-mode)
(define-derived-mode inferior-octave-mode comint-mode "Inferior Octave"
"Major mode for interacting with an inferior Octave process."
:abbrev-table octave-abbrev-table
(setq comint-prompt-regexp inferior-octave-prompt)
(setq-local comment-use-global-state t)
(setq-local comment-start octave-comment-start)
(setq-local comment-end "")
(setq comment-column 32)
(setq-local comment-start-skip octave-comment-start-skip)
(setq font-lock-defaults '(inferior-octave-font-lock-keywords nil nil))
(setq-local info-lookup-mode 'octave-mode)
(setq-local eldoc-documentation-function 'octave-eldoc-function)
(setq comint-input-ring-file-name
(or (getenv "OCTAVE_HISTFILE") "~/.octave_hist")
comint-input-ring-size (or (getenv "OCTAVE_HISTSIZE") 1024))
(setq-local comint-dynamic-complete-functions
inferior-octave-dynamic-complete-functions)
(setq-local comint-prompt-read-only inferior-octave-prompt-read-only)
(add-hook 'comint-input-filter-functions
'inferior-octave-directory-tracker nil t)
;; http://thread.gmane.org/gmane.comp.gnu.octave.general/48572
(add-hook 'window-configuration-change-hook
'inferior-octave-track-window-width-change nil t)
(comint-read-input-ring t))
;;;###autoload
(defun inferior-octave (&optional arg)
"Run an inferior Octave process, I/O via `inferior-octave-buffer'.
This buffer is put in Inferior Octave mode. See `inferior-octave-mode'.
Unless ARG is non-nil, switches to this buffer.
The elements of the list `inferior-octave-startup-args' are sent as
command line arguments to the inferior Octave process on startup.
Additional commands to be executed on startup can be provided either in
the file specified by `inferior-octave-startup-file' or by the default
startup file, `~/.emacs-octave'."
(interactive "P")
(let ((buffer (get-buffer-create inferior-octave-buffer)))
(unless arg
(pop-to-buffer buffer))
(unless (comint-check-proc buffer)
(with-current-buffer buffer
(inferior-octave-startup)
(inferior-octave-mode)))
buffer))
;;;###autoload
(defalias 'run-octave 'inferior-octave)
(defun inferior-octave-startup ()
"Start an inferior Octave process."
(let ((proc (comint-exec-1
(substring inferior-octave-buffer 1 -1)
inferior-octave-buffer
inferior-octave-program
(append
inferior-octave-startup-args
;; --no-gui is introduced in Octave > 3.7
(and (not (member "--no-gui" inferior-octave-startup-args))
(zerop (process-file inferior-octave-program
nil nil nil "--no-gui" "--help"))
'("--no-gui"))))))
(set-process-filter proc 'inferior-octave-output-digest)
(setq inferior-octave-process proc
inferior-octave-output-list nil
inferior-octave-output-string nil
inferior-octave-receive-in-progress t)
;; This may look complicated ... However, we need to make sure that
;; we additional startup code only AFTER Octave is ready (otherwise,
;; output may be mixed up). Hence, we need to digest the Octave
;; output to see when it issues a prompt.
(while inferior-octave-receive-in-progress
(or (process-live-p inferior-octave-process)
(error "Process `%s' died" inferior-octave-process))
(accept-process-output inferior-octave-process))
(goto-char (point-max))
(set-marker (process-mark proc) (point))
(insert-before-markers
(concat
(if (not (bobp)) "\f\n")
(if inferior-octave-output-list
(concat (mapconcat
'identity inferior-octave-output-list "\n")
"\n"))))
;; An empty secondary prompt, as e.g. obtained by '--braindead',
;; means trouble.
(inferior-octave-send-list-and-digest (list "PS2\n"))
(when (string-match "\\(PS2\\|ans\\) = *$"
(car inferior-octave-output-list))
(inferior-octave-send-list-and-digest (list "PS2 ('> ');\n")))
(inferior-octave-send-list-and-digest
(list "disp (getenv ('OCTAVE_SRCDIR'))\n"))
(process-put proc 'octave-srcdir
(unless (equal (car inferior-octave-output-list) "")
(car inferior-octave-output-list)))
;; O.K., now we are ready for the Inferior Octave startup commands.
(inferior-octave-send-list-and-digest
(list "more off;\n"
(unless (equal inferior-octave-output-string ">> ")
"PS1 ('\\s> ');\n")
(when (and inferior-octave-startup-file
(file-exists-p inferior-octave-startup-file))
(format "source ('%s');\n" inferior-octave-startup-file))))
(when inferior-octave-output-list
(insert-before-markers
(mapconcat 'identity inferior-octave-output-list "\n")))
;; And finally, everything is back to normal.
(set-process-filter proc 'comint-output-filter)
;; Just in case, to be sure a cd in the startup file won't have
;; detrimental effects.
(with-demoted-errors (inferior-octave-resync-dirs))
;; Generate a proper prompt, which is critical to
;; `comint-history-isearch-backward-regexp'. Bug#14433.
(comint-send-string proc "\n")))
(defvar inferior-octave-completion-table
;;
;; Use cache to avoid repetitive computation of completions due to
;; bug#11906 - http://debbugs.gnu.org/11906 - which may cause
;; noticeable delay. CACHE: (CMD . VALUE).
(let ((cache))
(completion-table-dynamic
(lambda (command)
(unless (equal (car cache) command)
(inferior-octave-send-list-and-digest
(list (format "completion_matches ('%s');\n" command)))
(setq cache (cons command
(delete-consecutive-dups
(sort inferior-octave-output-list 'string-lessp)))))
(cdr cache)))))
(defun inferior-octave-completion-at-point ()
"Return the data to complete the Octave symbol at point."
;; http://debbugs.gnu.org/14300
(unless (string-match-p "/" (or (comint--match-partial-filename) ""))
(let ((beg (save-excursion
(skip-syntax-backward "w_" (comint-line-beginning-position))
(point)))
(end (point)))
(when (and beg (> end beg))
(list beg end (completion-table-in-turn
inferior-octave-completion-table
'comint-completion-file-name-table))))))
(define-obsolete-function-alias 'inferior-octave-complete
'completion-at-point "24.1")
(defun inferior-octave-dynamic-list-input-ring ()
"List the buffer's input history in a help buffer."
;; We cannot use `comint-dynamic-list-input-ring', because it replaces
;; "completion" by "history reference" ...
(interactive)
(if (or (not (ring-p comint-input-ring))
(ring-empty-p comint-input-ring))
(message "No history")
(let ((history nil)
(history-buffer " *Input History*")
(index (1- (ring-length comint-input-ring)))
(conf (current-window-configuration)))
;; We have to build up a list ourselves from the ring vector.
(while (>= index 0)
(setq history (cons (ring-ref comint-input-ring index) history)
index (1- index)))
;; Change "completion" to "history reference"
;; to make the display accurate.
(with-output-to-temp-buffer history-buffer
(display-completion-list history)
(set-buffer history-buffer))
(message "Hit space to flush")
(let ((ch (read-event)))
(if (eq ch ?\ )
(set-window-configuration conf)
(setq unread-command-events (list ch)))))))
(defun inferior-octave-output-digest (_proc string)
"Special output filter for the inferior Octave process.
Save all output between newlines into `inferior-octave-output-list', and
the rest to `inferior-octave-output-string'."
(setq string (concat inferior-octave-output-string string))
(while (string-match "\n" string)
(setq inferior-octave-output-list
(append inferior-octave-output-list
(list (substring string 0 (match-beginning 0))))
string (substring string (match-end 0))))
(if (string-match inferior-octave-prompt string)
(setq inferior-octave-receive-in-progress nil))
(setq inferior-octave-output-string string))
(defun inferior-octave-check-process ()
(or (and inferior-octave-process
(process-live-p inferior-octave-process))
(error (substitute-command-keys
"No inferior octave process running. Type \\[run-octave]"))))
(defun inferior-octave-send-list-and-digest (list)
"Send LIST to the inferior Octave process and digest the output.
The elements of LIST have to be strings and are sent one by one. All
output is passed to the filter `inferior-octave-output-digest'."
(inferior-octave-check-process)
(let* ((proc inferior-octave-process)
(filter (process-filter proc))
string)
(set-process-filter proc 'inferior-octave-output-digest)
(setq inferior-octave-output-list nil)
(unwind-protect
(while (setq string (car list))
(setq inferior-octave-output-string nil
inferior-octave-receive-in-progress t)
(comint-send-string proc string)
(while inferior-octave-receive-in-progress
(accept-process-output proc))
(setq list (cdr list)))
(set-process-filter proc filter))))
(defvar inferior-octave-directory-tracker-resync nil)
(make-variable-buffer-local 'inferior-octave-directory-tracker-resync)
(defun inferior-octave-directory-tracker (string)
"Tracks `cd' commands issued to the inferior Octave process.
Use \\[inferior-octave-resync-dirs] to resync if Emacs gets confused."
(when inferior-octave-directory-tracker-resync
(or (inferior-octave-resync-dirs 'noerror)
(setq inferior-octave-directory-tracker-resync nil)))
(cond
((string-match "^[ \t]*cd[ \t;]*$" string)
(cd "~"))
((string-match "^[ \t]*cd[ \t]+\\([^ \t\n;]*\\)[ \t\n;]*" string)
(condition-case err
(cd (match-string 1 string))
(error (setq inferior-octave-directory-tracker-resync t)
(message "%s: `%s'"
(error-message-string err)
(match-string 1 string)))))))
(defun inferior-octave-resync-dirs (&optional noerror)
"Resync the buffer's idea of the current directory.
This command queries the inferior Octave process about its current
directory and makes this the current buffer's default directory."
(interactive)
(inferior-octave-send-list-and-digest '("disp (pwd ())\n"))
(condition-case err
(progn
(cd (car inferior-octave-output-list))
t)
(error (unless noerror (signal (car err) (cdr err))))))
(defcustom inferior-octave-minimal-columns 80
"The minimal column width for the inferior Octave process."
:type 'integer
:group 'octave
:version "24.4")
(defvar inferior-octave-last-column-width nil)
(defun inferior-octave-track-window-width-change ()
;; http://thread.gmane.org/gmane.comp.gnu.octave.general/48572
(let ((width (max inferior-octave-minimal-columns (window-width))))
(unless (eq inferior-octave-last-column-width width)
(setq-local inferior-octave-last-column-width width)
(when (and inferior-octave-process
(process-live-p inferior-octave-process))
(inferior-octave-send-list-and-digest
(list (format "putenv ('COLUMNS', '%s');\n" width)))))))
\f
;;; Miscellaneous useful functions
(defun octave-in-comment-p ()
"Return non-nil if point is inside an Octave comment."
(nth 4 (syntax-ppss)))
(defun octave-in-string-p ()
"Return non-nil if point is inside an Octave string."
(nth 3 (syntax-ppss)))
(defun octave-in-string-or-comment-p ()
"Return non-nil if point is inside an Octave string or comment."
(nth 8 (syntax-ppss)))
(defun octave-looking-at-kw (regexp)
"Like `looking-at', but sets `case-fold-search' nil."
(let ((case-fold-search nil))
(looking-at regexp)))
(defun octave-maybe-insert-continuation-string ()
(if (or (octave-in-comment-p)
(save-excursion
(beginning-of-line)
(looking-at octave-continuation-regexp)))
nil
(delete-horizontal-space)
(insert (concat " " octave-continuation-string))))
(defun octave-completing-read ()
(let ((def (or (thing-at-point 'symbol)
(save-excursion
(skip-syntax-backward "-(")
(thing-at-point 'symbol)))))
(completing-read
(format (if def "Function (default %s): "
"Function: ") def)
inferior-octave-completion-table
nil nil nil nil def)))
(defun octave-goto-function-definition (fn)
"Go to the function definition of FN in current buffer."
(let ((search
(lambda (re sub)
(let ((orig (point)) found)
(goto-char (point-min))
(while (and (not found) (re-search-forward re nil t))
(when (and (equal (match-string sub) fn)
(not (nth 8 (syntax-ppss))))
(setq found t)))
(unless found (goto-char orig))
found))))
(pcase (and buffer-file-name (file-name-extension buffer-file-name))
(`"cc" (funcall search
"\\_<DEFUN\\(?:_DLD\\)?\\s-*(\\s-*\\(\\(?:\\sw\\|\\s_\\)+\\)" 1))
(t (funcall search octave-function-header-regexp 3)))))
(defun octave-function-file-p ()
"Return non-nil if the first token is \"function\".
The value is (START END NAME-START NAME-END) of the function."
(save-excursion
(goto-char (point-min))
(when (equal (funcall smie-forward-token-function) "function")
(forward-word -1)
(let* ((start (point))
(end (progn (forward-sexp 1) (point)))
(name (when (progn
(goto-char start)
(re-search-forward octave-function-header-regexp
end t))
(list (match-beginning 3) (match-end 3)))))
(cons start (cons end name))))))
;; Like forward-comment but stop at non-comment blank
(defun octave-skip-comment-forward (limit)
(let ((ppss (syntax-ppss)))
(if (nth 4 ppss)
(goto-char (nth 8 ppss))
(goto-char (or (comment-search-forward limit t) (point)))))
(while (and (< (point) limit) (looking-at-p "\\s<"))
(forward-comment 1)))
;;; First non-copyright comment block
(defun octave-function-file-comment ()
"Beginning and end positions of the function file comment."
(save-excursion
(goto-char (point-min))
;; Copyright block: octave/libinterp/parse-tree/lex.ll around line 1634
(while (save-excursion
(when (comment-search-forward (point-max) t)
(when (eq (char-after) ?\{) ; case of block comment
(forward-char 1))
(skip-syntax-forward "-")
(let ((case-fold-search t))
(looking-at-p "\\(?:copyright\\|author\\)\\_>"))))
(octave-skip-comment-forward (point-max)))
(let ((beg (comment-search-forward (point-max) t)))
(when beg
(goto-char beg)
(octave-skip-comment-forward (point-max))
(list beg (point))))))
(defun octave-sync-function-file-names ()
"Ensure function name agree with function file name.
See Info node `(octave)Function Files'."
(interactive)
(when buffer-file-name
(pcase-let ((`(,start ,_end ,name-start ,name-end)
(octave-function-file-p)))
(when (and start name-start)
(let* ((func (buffer-substring name-start name-end))
(file (file-name-sans-extension
(file-name-nondirectory buffer-file-name)))
(help-form (format "\
a: Use function name `%s'
b: Use file name `%s'
q: Don't fix\n" func file))
(c (unless (equal file func)
(save-window-excursion
(help-form-show)
(read-char-choice
"Which name to use? (a/b/q) " '(?a ?b ?q))))))
(pcase c
(`?a (let ((newname (expand-file-name
(concat func (file-name-extension
buffer-file-name t)))))
(when (or (not (file-exists-p newname))
(yes-or-no-p
(format "Target file %s exists; proceed? " newname)))
(when (file-exists-p buffer-file-name)
(rename-file buffer-file-name newname t))
(set-visited-file-name newname))))
(`?b (save-excursion
(goto-char name-start)
(delete-region name-start name-end)
(insert file)))))))))
(defun octave-update-function-file-comment (beg end)
"Query replace function names in function file comment."
(interactive
(progn
(barf-if-buffer-read-only)
(if (use-region-p)
(list (region-beginning) (region-end))
(or (octave-function-file-comment)
(error "No function file comment found")))))
(save-excursion
(let* ((bounds (or (octave-function-file-p)
(error "Not in a function file buffer")))
(func (if (cddr bounds)
(apply #'buffer-substring (cddr bounds))
(error "Function name not found")))
(old-func (progn
(goto-char beg)
(when (re-search-forward
"[=}]\\s-*\\(\\(?:\\sw\\|\\s_\\)+\\)\\_>"
(min (line-end-position 4) end)
t)
(match-string 1))))
(old-func (read-string (format (if old-func
"Name to replace (default %s): "
"Name to replace: ")
old-func)
nil nil old-func)))
(if (and func old-func (not (equal func old-func)))
(perform-replace old-func func 'query
nil 'delimited nil nil beg end)
(message "Function names match")))))
(defface octave-function-comment-block
'((t (:inherit font-lock-doc-face)))
"Face used to highlight function comment block."
:group 'octave)
(eval-when-compile (require 'texinfo))
(defun octave-font-lock-texinfo-comment ()
(let ((kws
(eval-when-compile
(delq nil (mapcar
(lambda (kw)
(if (numberp (nth 1 kw))
`(,(nth 0 kw) ,(nth 1 kw) ,(nth 2 kw) prepend)
(message "Ignoring Texinfo highlight: %S" kw)))
texinfo-font-lock-keywords)))))
(font-lock-add-keywords
nil
`((,(lambda (limit)
(while (and (< (point) limit)
(search-forward "-*- texinfo -*-" limit t)
(octave-in-comment-p))
(let ((beg (nth 8 (syntax-ppss)))
(end (progn
(octave-skip-comment-forward (point-max))
(point))))
(put-text-property beg end 'font-lock-multiline t)
(font-lock-prepend-text-property
beg end 'face 'octave-function-comment-block)
(dolist (kw kws)
(goto-char beg)
(while (re-search-forward (car kw) end 'move)
(font-lock-apply-highlight (cdr kw))))))
nil)))
'append)))
\f
;;; Indentation
(defun octave-indent-new-comment-line (&optional soft)
"Break Octave line at point, continuing comment if within one.
Insert `octave-continuation-string' before breaking the line
unless inside a list. Signal an error if within a single-quoted
string."
(interactive)
(funcall comment-line-break-function soft))
(defun octave--indent-new-comment-line (orig &rest args)
(cond
((octave-in-comment-p) nil)
((eq (octave-in-string-p) ?')
(error "Cannot split a single-quoted string"))
((eq (octave-in-string-p) ?\")
(insert octave-continuation-string))
(t
(delete-horizontal-space)
(unless (and (cadr (syntax-ppss))
(eq (char-after (cadr (syntax-ppss))) ?\())
(insert " " octave-continuation-string))))
(apply orig args)
(indent-according-to-mode))
(define-obsolete-function-alias
'octave-indent-defun 'prog-indent-sexp "24.4")
\f
;;; Motion
(defun octave-next-code-line (&optional arg)
"Move ARG lines of Octave code forward (backward if ARG is negative).
Skips past all empty and comment lines. Default for ARG is 1.
On success, return 0. Otherwise, go as far as possible and return -1."
(interactive "p")
(or arg (setq arg 1))
(beginning-of-line)
(let ((n 0)
(inc (if (> arg 0) 1 -1)))
(while (and (/= arg 0) (= n 0))
(setq n (forward-line inc))
(while (and (= n 0)
(looking-at "\\s-*\\($\\|\\s<\\)"))
(setq n (forward-line inc)))
(setq arg (- arg inc)))
n))
(defun octave-previous-code-line (&optional arg)
"Move ARG lines of Octave code backward (forward if ARG is negative).
Skips past all empty and comment lines. Default for ARG is 1.
On success, return 0. Otherwise, go as far as possible and return -1."
(interactive "p")
(or arg (setq arg 1))
(octave-next-code-line (- arg)))
(defun octave-beginning-of-line ()
"Move point to beginning of current Octave line.
If on an empty or comment line, go to the beginning of that line.
Otherwise, move backward to the beginning of the first Octave code line
which is not inside a continuation statement, i.e., which does not
follow a code line ending with `...' or is inside an open
parenthesis list."
(interactive)
(beginning-of-line)
(unless (looking-at "\\s-*\\($\\|\\s<\\)")
(while (or (when (cadr (syntax-ppss))
(goto-char (cadr (syntax-ppss)))
(beginning-of-line)
t)
(and (or (looking-at "\\s-*\\($\\|\\s<\\)")
(save-excursion
(if (zerop (octave-previous-code-line))
(looking-at octave-continuation-regexp))))
(zerop (forward-line -1)))))))
(defun octave-end-of-line ()
"Move point to end of current Octave line.
If on an empty or comment line, go to the end of that line.
Otherwise, move forward to the end of the first Octave code line which
does not end with `...' or is inside an open parenthesis list."
(interactive)
(end-of-line)
(unless (save-excursion
(beginning-of-line)
(looking-at "\\s-*\\($\\|\\s<\\)"))
(while (or (when (cadr (syntax-ppss))
(condition-case nil
(progn
(up-list 1)
(end-of-line)
t)
(error nil)))
(and (save-excursion
(beginning-of-line)
(or (looking-at "\\s-*\\($\\|\\s<\\)")
(looking-at octave-continuation-regexp)))
(zerop (forward-line 1)))))
(end-of-line)))
(defun octave-mark-block ()
"Put point at the beginning of this Octave block, mark at the end.
The block marked is the one that contains point or follows point."
(interactive)
(if (and (looking-at "\\sw\\|\\s_")
(looking-back "\\sw\\|\\s_" (1- (point))))
(skip-syntax-forward "w_"))
(unless (or (looking-at "\\s(")
(save-excursion
(let* ((token (funcall smie-forward-token-function))
(level (assoc token smie-grammar)))
(and level (not (numberp (cadr level)))))))
(backward-up-list 1))
(mark-sexp))
(defun octave-beginning-of-defun (&optional arg)
"Octave-specific `beginning-of-defun-function' (which see)."
(or arg (setq arg 1))
;; Move out of strings or comments.
(when (octave-in-string-or-comment-p)
(goto-char (octave-in-string-or-comment-p)))
(letrec ((orig (point))
(toplevel (lambda (pos)
(condition-case nil
(progn
(backward-up-list 1)
(funcall toplevel (point)))
(scan-error pos)))))
(goto-char (funcall toplevel (point)))
(when (and (> arg 0) (/= orig (point)))
(setq arg (1- arg)))
(forward-sexp (- arg))
(and (< arg 0) (forward-sexp -1))
(/= orig (point))))
(defun octave-fill-paragraph (&optional _arg)
"Fill paragraph of Octave code, handling Octave comments."
;; FIXME: difference with generic fill-paragraph:
;; - code lines are only split, never joined.
;; - \n that end comments are never removed.
;; - insert continuation marker when splitting code lines.
(interactive "P")
(save-excursion
(let ((end (progn (forward-paragraph) (copy-marker (point) t)))
(beg (progn
(forward-paragraph -1)
(skip-chars-forward " \t\n")
(beginning-of-line)
(point)))
(cfc (current-fill-column))
comment-prefix)
(goto-char beg)
(while (< (point) end)
(condition-case nil
(indent-according-to-mode)
(error nil))
(move-to-column cfc)
;; First check whether we need to combine non-empty comment lines
(if (and (< (current-column) cfc)
(octave-in-comment-p)
(not (save-excursion
(beginning-of-line)
(looking-at "^\\s-*\\s<+\\s-*$"))))
;; This is a nonempty comment line which does not extend
;; past the fill column. If it is followed by a nonempty
;; comment line with the same comment prefix, try to
;; combine them, and repeat this until either we reach the
;; fill-column or there is nothing more to combine.
(progn
;; Get the comment prefix
(save-excursion
(beginning-of-line)
(while (and (re-search-forward "\\s<+")
(not (octave-in-comment-p))))
(setq comment-prefix (match-string 0)))
;; And keep combining ...
(while (and (< (current-column) cfc)
(save-excursion
(forward-line 1)
(and (looking-at
(concat "^\\s-*"
comment-prefix
"\\S<"))
(not (looking-at
(concat "^\\s-*"
comment-prefix
"\\s-*$"))))))
(delete-char 1)
(re-search-forward comment-prefix)
(delete-region (match-beginning 0) (match-end 0))
(fixup-whitespace)
(move-to-column cfc))))
;; We might also try to combine continued code lines> Perhaps
;; some other time ...
(skip-chars-forward "^ \t\n")
(delete-horizontal-space)
(if (or (< (current-column) cfc)
(and (= (current-column) cfc) (eolp)))
(forward-line 1)
(if (not (eolp)) (insert " "))
(or (funcall normal-auto-fill-function)
(forward-line 1))))
t)))
(defun octave-completion-at-point ()
"Find the text to complete and the corresponding table."
(let* ((beg (save-excursion (skip-syntax-backward "w_") (point)))
(end (point)))
(if (< beg (point))
;; Extend region past point, if applicable.
(save-excursion (skip-syntax-forward "w_")
(setq end (point))))
(when (> end beg)
(list beg end (or (and inferior-octave-process
(process-live-p inferior-octave-process)
inferior-octave-completion-table)
octave-reserved-words)))))
(define-obsolete-function-alias 'octave-complete-symbol
'completion-at-point "24.1")
(defun octave-add-log-current-defun ()
"A function for `add-log-current-defun-function' (which see)."
(save-excursion
(end-of-line)
(and (beginning-of-defun)
(re-search-forward octave-function-header-regexp
(line-end-position) t)
(match-string 3))))
\f
;;; Electric characters && friends
(define-skeleton octave-insert-defun
"Insert an Octave function skeleton.
Prompt for the function's name, arguments and return values (to be
entered without parens)."
(let* ((defname (file-name-sans-extension (buffer-name)))
(name (read-string (format "Function name (default %s): " defname)
nil nil defname))
(args (read-string "Arguments: "))
(vals (read-string "Return values: ")))
(format "%s%s (%s)"
(cond
((string-equal vals "") vals)
((string-match "[ ,]" vals) (concat "[" vals "] = "))
(t (concat vals " = ")))
name
args))
\n octave-block-comment-start "usage: " str \n
octave-block-comment-start '(delete-horizontal-space) \n
octave-block-comment-start '(delete-horizontal-space) \n
"function " > str \n
_ \n
"endfunction" > \n)
;;; Communication with the inferior Octave process
(defun octave-kill-process ()
"Kill inferior Octave process and its buffer."
(interactive)
(if inferior-octave-process
(progn
(process-send-string inferior-octave-process "quit;\n")
(accept-process-output inferior-octave-process)))
(if inferior-octave-buffer
(kill-buffer inferior-octave-buffer)))
(defun octave-show-process-buffer ()
"Make sure that `inferior-octave-buffer' is displayed."
(interactive)
(if (get-buffer inferior-octave-buffer)
(display-buffer inferior-octave-buffer)
(message "No buffer named %s" inferior-octave-buffer)))
(defun octave-hide-process-buffer ()
"Delete all windows that display `inferior-octave-buffer'."
(interactive)
(if (get-buffer inferior-octave-buffer)
(delete-windows-on inferior-octave-buffer)
(message "No buffer named %s" inferior-octave-buffer)))
(defun octave-send-region (beg end)
"Send current region to the inferior Octave process."
(interactive "r")
(inferior-octave t)
(let ((proc inferior-octave-process)
(string (buffer-substring-no-properties beg end))
line)
(with-current-buffer inferior-octave-buffer
(setq inferior-octave-output-list nil)
(while (not (string-equal string ""))
(if (string-match "\n" string)
(setq line (substring string 0 (match-beginning 0))
string (substring string (match-end 0)))
(setq line string string ""))
(setq inferior-octave-receive-in-progress t)
(inferior-octave-send-list-and-digest (list (concat line "\n")))
(while inferior-octave-receive-in-progress
(accept-process-output proc))
(insert-before-markers
(mapconcat 'identity
(append
(if octave-send-echo-input (list line) (list ""))
inferior-octave-output-list
(list inferior-octave-output-string))
"\n")))))
(if octave-send-show-buffer
(display-buffer inferior-octave-buffer)))
(defun octave-send-buffer ()
"Send current buffer to the inferior Octave process."
(interactive)
(octave-send-region (point-min) (point-max)))
(defun octave-send-block ()
"Send current Octave block to the inferior Octave process."
(interactive)
(save-excursion
(octave-mark-block)
(octave-send-region (point) (mark))))
(defun octave-send-defun ()
"Send current Octave function to the inferior Octave process."
(interactive)
(save-excursion
(mark-defun)
(octave-send-region (point) (mark))))
(defun octave-send-line (&optional arg)
"Send current Octave code line to the inferior Octave process.
With positive prefix ARG, send that many lines.
If `octave-send-line-auto-forward' is non-nil, go to the next unsent
code line."
(interactive "P")
(or arg (setq arg 1))
(if (> arg 0)
(let (beg end)
(beginning-of-line)
(setq beg (point))
(octave-next-code-line (- arg 1))
(end-of-line)
(setq end (point))
(if octave-send-line-auto-forward
(octave-next-code-line 1))
(octave-send-region beg end))))
(defun octave-eval-print-last-sexp ()
"Evaluate Octave sexp before point and print value into current buffer."
(interactive)
(inferior-octave t)
(let ((standard-output (current-buffer))
(print-escape-newlines nil)
(opoint (point)))
(terpri)
(prin1
(save-excursion
(forward-sexp -1)
(inferior-octave-send-list-and-digest
(list (concat (buffer-substring-no-properties (point) opoint)
"\n")))
(mapconcat 'identity inferior-octave-output-list "\n")))
(terpri)))
\f
(defcustom octave-eldoc-message-style 'auto
"Octave eldoc message style: auto, oneline, multiline."
:type '(choice (const :tag "Automatic" auto)
(const :tag "One Line" oneline)
(const :tag "Multi Line" multiline))
:group 'octave
:version "24.4")
;; (FN SIGNATURE1 SIGNATURE2 ...)
(defvar octave-eldoc-cache nil)
(defun octave-eldoc-function-signatures (fn)
(unless (equal fn (car octave-eldoc-cache))
(inferior-octave-send-list-and-digest
(list (format "print_usage ('%s');\n" fn)))
(let (result)
(dolist (line inferior-octave-output-list)
(when (string-match
"\\s-*\\(?:--[^:]+\\|usage\\):\\s-*\\(.*\\)$"
line)
(push (match-string 1 line) result)))
(setq octave-eldoc-cache
(cons (substring-no-properties fn)
(nreverse result)))))
(cdr octave-eldoc-cache))
(defun octave-eldoc-function ()
"A function for `eldoc-documentation-function' (which see)."
(when (and inferior-octave-process
(process-live-p inferior-octave-process))
(let* ((ppss (syntax-ppss))
(paren-pos (cadr ppss))
(fn (save-excursion
(if (and paren-pos
;; PAREN-POS must be after the prompt
(>= paren-pos
(if (eq (get-buffer-process (current-buffer))
inferior-octave-process)
(process-mark inferior-octave-process)
(point-min)))
(or (not (eq (get-buffer-process (current-buffer))
inferior-octave-process))
(< (process-mark inferior-octave-process)
paren-pos))
(eq (char-after paren-pos) ?\())
(goto-char paren-pos)
(setq paren-pos nil))
(when (or (< (skip-syntax-backward "-") 0) paren-pos)
(thing-at-point 'symbol))))
(sigs (and fn (octave-eldoc-function-signatures fn)))
(oneline (mapconcat 'identity sigs
(propertize " | " 'face 'warning)))
(multiline (mapconcat (lambda (s) (concat "-- " s)) sigs "\n")))
;;
;; Return the value according to style.
(pcase octave-eldoc-message-style
(`auto (if (< (length oneline) (window-width (minibuffer-window)))
oneline
multiline))
(`oneline oneline)
(`multiline multiline)))))
(defcustom octave-help-buffer "*Octave Help*"
"Buffer name for `octave-help'."
:type 'string
:group 'octave
:version "24.4")
;; Used in a mode derived from help-mode.
(declare-function help-button-action "help-mode" (button))
(define-button-type 'octave-help-file
'follow-link t
'action #'help-button-action
'help-function 'octave-find-definition)
(define-button-type 'octave-help-function
'follow-link t
'action (lambda (b)
(octave-help
(buffer-substring (button-start b) (button-end b)))))
(defvar octave-help-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\M-." 'octave-find-definition)
(define-key map "\C-hd" 'octave-help)
(define-key map "\C-ha" 'octave-lookfor)
map))
(define-derived-mode octave-help-mode help-mode "OctHelp"
"Major mode for displaying Octave documentation."
:abbrev-table nil
:syntax-table octave-mode-syntax-table
(eval-and-compile (require 'help-mode))
;; Mostly stolen from `help-make-xrefs'.
(let ((inhibit-read-only t))
(setq-local info-lookup-mode 'octave-mode)
;; Delete extraneous newlines at the end of the docstring
(goto-char (point-max))
(while (and (not (bobp)) (bolp))
(delete-char -1))
(insert "\n")
(when (or help-xref-stack help-xref-forward-stack)
(insert "\n"))
(when help-xref-stack
(help-insert-xref-button help-back-label 'help-back
(current-buffer)))
(when help-xref-forward-stack
(when help-xref-stack
(insert "\t"))
(help-insert-xref-button help-forward-label 'help-forward
(current-buffer)))
(when (or help-xref-stack help-xref-forward-stack)
(insert "\n"))))
(defun octave-help (fn)
"Display the documentation of FN."
(interactive (list (octave-completing-read)))
(inferior-octave-send-list-and-digest
(list (format "help ('%s');\n" fn)))
(let ((lines inferior-octave-output-list)
(inhibit-read-only t))
(when (string-match "error: \\(.*\\)$" (car lines))
(error "%s" (match-string 1 (car lines))))
(with-help-window octave-help-buffer
(princ (mapconcat 'identity lines "\n"))
(with-current-buffer octave-help-buffer
;; Bound to t so that `help-buffer' returns current buffer for
;; `help-setup-xref'.
(let ((help-xref-following t))
(help-setup-xref (list 'octave-help fn)
(called-interactively-p 'interactive)))
;; Note: can be turned off by suppress_verbose_help_message.
;;
;; Remove boring trailing text: Additional help for built-in functions
;; and operators ...
(goto-char (point-max))
(when (search-backward "\n\n\n" nil t)
(goto-char (match-beginning 0))
(delete-region (point) (point-max)))
;; File name highlight
(goto-char (point-min))
(when (re-search-forward "from the file \\(.*\\)$"
(line-end-position)
t)
(let* ((file (match-string 1))
(dir (file-name-directory
(directory-file-name (file-name-directory file)))))
(replace-match "" nil nil nil 1)
(insert "`")
;; Include the parent directory which may be regarded as
;; the category for the FN.
(help-insert-xref-button (file-relative-name file dir)
'octave-help-file fn)
(insert "'")))
;; Make 'See also' clickable.
(with-syntax-table octave-mode-syntax-table
(when (re-search-forward "^\\s-*See also:" nil t)
(let ((end (save-excursion (re-search-forward "^\\s-*$" nil t))))
(while (re-search-forward
"\\s-*\\([^,\n]+?\\)\\s-*\\(?:[,]\\|[.]?$\\)" end t)
(make-text-button (match-beginning 1) (match-end 1)
:type 'octave-help-function)))))
(octave-help-mode)))))
(defun octave-lookfor (str &optional all)
"Search for the string STR in all function help strings.
If ALL is non-nil search the entire help string else only search the first
sentence."
(interactive "sSearch for: \nP")
(inferior-octave-send-list-and-digest
(list (format "lookfor (%s'%s');\n"
(if all "'-all', " "")
str)))
(let ((lines inferior-octave-output-list))
(when (string-match "error: \\(.*\\)$" (car lines))
(error "%s" (match-string 1 (car lines))))
(with-help-window octave-help-buffer
(princ (mapconcat 'identity lines "\n"))
(with-current-buffer octave-help-buffer
;; Bound to t so that `help-buffer' returns current buffer for
;; `help-setup-xref'.
(let ((help-xref-following t))
(help-setup-xref (list 'octave-lookfor str all)
(called-interactively-p 'interactive)))
(goto-char (point-min))
(while (re-search-forward "^\\([^[:blank:]]+\\) " nil 'noerror)
(make-text-button (match-beginning 1) (match-end 1)
:type 'octave-help-function))
(octave-help-mode)))))
(defcustom octave-source-directories nil
"A list of directories for Octave sources.
If the environment variable OCTAVE_SRCDIR is set, it is searched first."
:type '(repeat directory)
:group 'octave
:version "24.4")
(defun octave-source-directories ()
(let ((srcdir (or (and inferior-octave-process
(process-get inferior-octave-process 'octave-srcdir))
(getenv "OCTAVE_SRCDIR"))))
(if srcdir
(cons srcdir octave-source-directories)
octave-source-directories)))
(defvar octave-find-definition-filename-function
#'octave-find-definition-default-filename)
(defun octave-find-definition-default-filename (name)
"Default value for `octave-find-definition-filename-function'."
(pcase (file-name-extension name)
(`"oct"
(octave-find-definition-default-filename
(concat "libinterp/dldfcn/"
(file-name-sans-extension (file-name-nondirectory name))
".cc")))
(`"cc"
(let ((file (or (locate-file name (octave-source-directories))
(locate-file (file-name-nondirectory name)
(octave-source-directories)))))
(or (and file (file-exists-p file))
(error "File `%s' not found" name))
file))
(`"mex"
(if (yes-or-no-p (format "File `%s' may be binary; open? "
(file-name-nondirectory name)))
name
(user-error "Aborted")))
(t name)))
(defvar find-tag-marker-ring)
(defun octave-find-definition (fn)
"Find the definition of FN.
Functions implemented in C++ can be found if
variable `octave-source-directories' is set correctly."
(interactive (list (octave-completing-read)))
(require 'etags)
(let ((orig (point)))
(if (and (derived-mode-p 'octave-mode)
(octave-goto-function-definition fn))
(ring-insert find-tag-marker-ring (copy-marker orig))
(inferior-octave-send-list-and-digest
;; help NAME is more verbose
(list (format "\
if iskeyword('%s') disp('`%s'' is a keyword') else which('%s') endif\n"
fn fn fn)))
(let (line file)
;; Skip garbage lines such as
;; warning: fmincg.m: possible Matlab-style ....
(while (and (not file) (consp inferior-octave-output-list))
(setq line (pop inferior-octave-output-list))
(when (string-match "from the file \\(.*\\)$" line)
(setq file (match-string 1 line))))
(if (not file)
(user-error "%s" (or line (format "`%s' not found" fn)))
(ring-insert find-tag-marker-ring (point-marker))
(setq file (funcall octave-find-definition-filename-function file))
(when file
(find-file file)
(octave-goto-function-definition fn)))))))
(provide 'octave)
;;; octave.el ends here
|