/usr/share/emacs/site-lisp/agda/agda2-mode.el is in agda-mode 2.4.0.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | ;;; agda2-mode.el --- Major mode for Agda
;;; Commentary:
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Dependency
;;; Code:
(defvar agda2-version "2.4.0.2"
"The version of the Agda mode.
Note that the same version of the Agda executable must be used.")
(require 'cl)
(set (make-local-variable 'lisp-indent-function)
'common-lisp-indent-function)
(require 'compile)
(require 'pp)
(require 'time-date)
(require 'eri)
(require 'annotation)
(require 'agda-input)
(require 'agda2-highlight)
(require 'agda2-abbrevs)
(require 'agda2-queue)
(eval-and-compile
;; Load filladapt, if it is installed.
(condition-case nil
(require 'filladapt)
(error nil))
(unless (fboundp 'overlays-in) (load "overlay")) ; for Xemacs
(unless (fboundp 'propertize) ; for Xemacs 21.4
(defun propertize (string &rest properties)
"Return a copy of STRING with text properties added.
First argument is the string to copy.
Remaining arguments form a sequence of PROPERTY VALUE pairs for text
properties to add to the result."
(let ((str (copy-sequence string)))
(add-text-properties 0 (length str) properties str)
str)))
(unless (fboundp 'run-mode-hooks)
(fset 'run-mode-hooks 'run-hooks)) ; For Emacs versions < 21.
(unless (fboundp 'cl-labels)
(fset 'cl-labels 'labels)) ; For Emacs versions < 24.2.
(unless (fboundp 'cl-flet)
(fset 'cl-flet 'flet))) ; For Emacs versions < 24.2.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Utilities
(defmacro agda2-let (varbind funcbind &rest body)
"Expands to (let* VARBIND (cl-labels FUNCBIND BODY...)).
Or possibly (let* VARBIND (labels FUNCBIND BODY...))."
(declare (debug ((&rest [&or symbolp (symbolp form)])
(&rest (cl-defun))
body)))
`(let* ,varbind (cl-labels ,funcbind ,@body)))
(put 'agda2-let 'lisp-indent-function 2)
(defun agda2-chunkify (n xs)
"Returns a list containing chunks of XS of length at most N.
All the elements of XS are included, in their original order."
(let ((i 0)
(len (length xs))
out)
(while (< i len)
(let ((new-i (+ i (min n (- len i)))))
(setq out (cons (subseq xs i new-i) out))
(setq i new-i)))
(nreverse out)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; User options
(defgroup agda2 nil
"Major mode for interactively developing Agda programs."
:group 'languages)
(defcustom agda2-include-dirs
'(".")
"The directories Agda uses to search for files.
The directory names should either be absolute or be relative to
the root of the current project."
:type '(repeat directory)
:group 'agda2)
(defcustom agda2-program-name "agda"
"The name of the Agda executable."
:type 'string
:group 'agda2)
(defcustom agda2-program-args nil
"Command-line arguments given to the Agda executable (one per string).
Note: Do not give several arguments in the same string.
The flag \"--interaction\" is always included as the first
argument, and does not need to be listed here."
:type '(repeat string)
:group 'agda2)
(defcustom agda2-backend
"MAlonzo"
"The backend which is used to compile Agda programs."
:type '(choice (const "MAlonzo")
(const "MAlonzoNoMain")
(const "Epic")
(const "JS"))
:group 'agda2)
(defcustom agda2-toplevel-module "Agda.Interaction.GhciTop"
"The name of the Agda toplevel module."
:type 'string :group 'agda2)
(defcustom agda2-information-window-max-height
0.35
"The maximum height of the information window.
A multiple of the frame height."
:type 'number
:group 'agda2)
(defcustom agda2-fontset-name
(unless (or (eq window-system 'mac)
;; Emacs-23 uses a revamped font engine which should
;; make agda2-fontset-name unnecessary in most cases.
;; And if it turns out to be necessary, we should
;; probably use face-remapping-alist rather than
;; set-frame-font so the special font only applies to
;; Agda buffers, and so it applies in all frames where
;; Agda buffers are displayed.
(boundp 'face-remapping-alist))
"fontset-agda2")
"Default font to use in the selected frame when activating the Agda mode.
This is only used if it's non-nil and Emacs is not running in a
terminal.
Note that this setting (if non-nil) affects non-Agda buffers as
well, and that you have to restart Emacs if you want settings to
this variable to take effect."
:type '(choice (string :tag "Fontset name")
(const :tag "Do not change the font" nil))
:group 'agda2)
(defcustom agda2-fontset-spec-of-fontset-agda2
"-*-fixed-Medium-r-Normal-*-18-*-*-*-c-*-fontset-agda2,
ascii:-Misc-Fixed-Medium-R-Normal--18-120-100-100-C-90-ISO8859-1,
latin-iso8859-2:-*-Fixed-*-r-*-*-18-*-*-*-c-*-iso8859-2,
latin-iso8859-3:-*-Fixed-*-r-*-*-18-*-*-*-c-*-iso8859-3,
latin-iso8859-4:-*-Fixed-*-r-*-*-18-*-*-*-c-*-iso8859-4,
cyrillic-iso8859-5:-*-Fixed-*-r-*-*-18-*-*-*-c-*-iso8859-5,
greek-iso8859-7:-*-Fixed-*-r-*-*-18-*-*-*-c-*-iso8859-7,
latin-iso8859-9:-*-Fixed-*-r-*-*-18-*-*-*-c-*-iso8859-9,
mule-unicode-0100-24ff:-Misc-Fixed-Medium-R-Normal--18-120-100-100-C-90-ISO10646-1,
mule-unicode-2500-33ff:-Misc-Fixed-Medium-R-Normal--18-120-100-100-C-90-ISO10646-1,
mule-unicode-e000-ffff:-Misc-Fixed-Medium-R-Normal--18-120-100-100-C-90-ISO10646-1,
japanese-jisx0208:-Misc-Fixed-Medium-R-Normal-ja-18-*-*-*-C-*-JISX0208.1990-0,
japanese-jisx0212:-Misc-Fixed-Medium-R-Normal-ja-18-*-*-*-C-*-JISX0212.1990-0,
thai-tis620:-Misc-Fixed-Medium-R-Normal--24-240-72-72-C-120-TIS620.2529-1,
lao:-Misc-Fixed-Medium-R-Normal--24-240-72-72-C-120-MuleLao-1,
tibetan:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-160-MuleTibetan-0,
tibetan-1-column:-TibMdXA-fixed-medium-r-normal--16-160-72-72-m-80-MuleTibetan-1,
korean-ksc5601:-Daewoo-Mincho-Medium-R-Normal--16-120-100-100-C-160-KSC5601.1987-0,
chinese-gb2312:-ISAS-Fangsong ti-Medium-R-Normal--16-160-72-72-c-160-GB2312.1980-0,
chinese-cns11643-1:-HKU-Fixed-Medium-R-Normal--16-160-72-72-C-160-CNS11643.1992.1-0,
chinese-big5-1:-ETen-Fixed-Medium-R-Normal--16-150-75-75-C-160-Big5.ETen-0,
chinese-big5-2:-ETen-Fixed-Medium-R-Normal--16-150-75-75-C-160-Big5.ETen-0"
"Specification of the \"fontset-agda2\" fontset.
This fontset is only created if `agda2-fontset-name' is
\"fontset-agda2\" and Emacs is not run in a terminal.
Note that the text \"fontset-agda2\" has to be part of the
string (in a certain way; see the default setting) in order for the
agda2 fontset to be created properly.
Note also that the default setting may not work unless suitable
fonts are installed on your system. Refer to the README file
accompanying the Agda distribution for more details.
Note finally that you have to restart Emacs if you want settings
to this variable to take effect."
:group 'agda2
:type 'string)
(if (and (equal agda2-fontset-name "fontset-agda2") window-system)
(create-fontset-from-fontset-spec agda2-fontset-spec-of-fontset-agda2 t t))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Global and buffer-local vars, initialization
(defvar agda2-mode-syntax-table
(let ((tbl (make-syntax-table)))
;; Set the syntax of every char to "w" except for those whose default
;; syntax in `standard-syntax-table' is `paren' or `whitespace'.
(map-char-table (lambda (keys val)
;; `keys' here can be a normal char, a generic char
;; (Emacs<23), or a char range (Emacs>=23).
(unless (memq (car val)
(eval-when-compile
(mapcar 'car
(list (string-to-syntax "(")
(string-to-syntax ")")
(string-to-syntax " ")))))
(modify-syntax-entry keys "w" tbl)))
(standard-syntax-table))
;; Then override the remaining special cases.
(dolist (cs '((?{ . "(}1n") (?} . "){4n") (?- . "w 123b") (?\n . "> b")
(?. . ".") (?\; . ".") (?_ . ".") (?! . ".")))
(modify-syntax-entry (car cs) (cdr cs) tbl))
tbl)
"Syntax table used by the Agda mode:
{} | Comment characters, matching parentheses.
- | Comment character, word constituent.
\n | Comment ender.
.;_! | Punctuation.
Remaining characters inherit their syntax classes from the
standard syntax table if that table treats them as matching
parentheses or whitespace. Otherwise they are treated as word
constituents.")
(defconst agda2-command-table
`(
(agda2-load "\C-c\C-l" (global) "Load")
(agda2-load "\C-c\C-x\C-l")
(agda2-compile "\C-c\C-x\C-c" (global) "Compile")
(agda2-quit "\C-c\C-x\C-q" (global) "Quit")
(agda2-restart "\C-c\C-x\C-r" (global) "Kill and restart Agda")
(agda2-remove-annotations "\C-c\C-x\C-d" (global) "Remove goals and highlighting (\"deactivate\")")
(agda2-display-implicit-arguments "\C-c\C-x\C-h" (global) "Toggle display of hidden arguments")
(agda2-show-constraints ,(kbd "C-c C-=") (global) "Show constraints")
(agda2-solveAll ,(kbd "C-c C-s") (global) "Solve constraints")
(agda2-show-goals ,(kbd "C-c C-?") (global) "Show goals")
(agda2-next-goal "\C-c\C-f" (global) "Next goal") ; Forward.
(agda2-previous-goal "\C-c\C-b" (global) "Previous goal") ; Back.
(agda2-give ,(kbd "C-c C-SPC") (local) "Give")
(agda2-refine "\C-c\C-r" (local) "Refine")
(agda2-auto "\C-c\C-a" (local) "Auto")
(agda2-make-case "\C-c\C-c" (local) "Case")
(agda2-goal-type "\C-c\C-t" (local) "Goal type")
(agda2-show-context "\C-c\C-e" (local) "Context (environment)")
(agda2-helper-function-type "\C-c\C-h" (local) "Helper function type")
(agda2-infer-type-maybe-toplevel "\C-c\C-d" (local global) "Infer (deduce) type")
(agda2-why-in-scope-maybe-toplevel "\C-c\C-w" (local global) "Explain why a particular name is in scope")
(agda2-goal-and-context ,(kbd "C-c C-,") (local) "Goal type and context")
(agda2-goal-and-context-and-inferred ,(kbd "C-c C-.") (local) "Goal type, context and inferred type")
(agda2-module-contents-maybe-toplevel ,(kbd "C-c C-o") (local global) "Module contents")
(agda2-compute-normalised-maybe-toplevel "\C-c\C-n" (local global) "Evaluate term to normal form")
(describe-char nil (global) "Information about the character at point")
(agda2-comment-dwim-rest-of-buffer ,(kbd "C-c C-x M-;") (global) "Comment/uncomment the rest of the buffer")
(eri-indent ,(kbd "TAB"))
(eri-indent-reverse [S-iso-lefttab])
(eri-indent-reverse [S-lefttab])
(eri-indent-reverse [S-tab])
(agda2-goto-definition-mouse [mouse-2])
(agda2-goto-definition-keyboard "\M-.")
(agda2-go-back "\M-*")
)
"Table of commands, used to build keymaps and menus.
Each element has the form (CMD &optional KEYS WHERE DESC) where
CMD is a command; KEYS is its key binding (if any); WHERE is a
list which should contain 'local if the command should exist in
the goal menu and 'global if the command should exist in the main
menu; and DESC is the description of the command used in the
menus.")
(defvar agda2-mode-map
(let ((map (make-sparse-keymap "Agda mode")))
(define-key map [menu-bar Agda]
(cons "Agda" (make-sparse-keymap "Agda")))
(define-key map [down-mouse-3] 'agda2-popup-menu-3)
(dolist (d (reverse agda2-command-table))
(destructuring-bind (f &optional keys kinds desc) d
(if keys (define-key map keys f))
(if (member 'global kinds)
(define-key map
(vector 'menu-bar 'Agda (intern desc)) (cons desc f)))))
map)
"Keymap for `agda2-mode'.")
(defvar agda2-goal-map
(let ((map (make-sparse-keymap "Agda goal")))
(dolist (d (reverse agda2-command-table))
(destructuring-bind (f &optional keys kinds desc) d
(if (member 'local kinds)
(define-key map
(vector (intern desc)) (cons desc f)))))
map)
"Keymap for agda2 goal menu.")
(defvar agda2-info-buffer nil
"Agda information buffer.")
(defvar agda2-process-buffer nil
"Agda subprocess buffer.
Set in `agda2-restart'.")
(defvar agda2-process nil
"Agda subprocess.
Set in `agda2-restart'.")
(defvar agda2-in-progress nil
"Is the Agda process currently busy?")
;; Some buffer locals
(defvar agda2-buffer-external-status ""
"External status of an `agda2-mode' buffer (dictated by the Haskell side).")
(make-variable-buffer-local 'agda2-buffer-external-status)
(defvar agda2-output-prompt "Agda2> "
"The Agda2 buffer's prompt.")
(defconst agda2-help-address
""
"Address accepting submissions of bug reports and questions.")
;; Annotation for a goal
;; {! .... !}
;; ---------- overlay: agda2-gn num, face highlight, after-string num,
;; modification-hooks (agda2-protect-goal-markers)
;; - text-props: category agda2-delim1
;; - text-props: category agda2-delim2
;; - text-props: category agda2-delim3
;; - text-props: category agda2-delim4
;;
;; Char categories for {! ... !}
(defvar agda2-open-brace "{")
(defvar agda2-close-brace " }")
(setplist 'agda2-delim1 `(display ,agda2-open-brace))
(setplist 'agda2-delim2 `(display ,agda2-open-brace rear-nonsticky t
agda2-delim2 t))
(setplist 'agda2-delim3 `(display ,agda2-close-brace agda2-delim3 t))
(setplist 'agda2-delim4 `(display ,agda2-close-brace rear-nonsticky t))
;; Note that strings used with the display property are compared by
;; reference. If the agda2-*-brace definitions were inlined, then
;; goals would be displayed as "{{ }}n" instead of "{ }n".
(defvar agda2-measure-data nil
"Used by `agda2-measure-load-time'.
This value is either nil or a pair containing a continuation (or
nil) and the time at which the measurement was started.")
(make-variable-buffer-local 'agda2-measure-data)
;; The following variables are used by the filter process,
;; `agda2-output-filter'. Their values are only modified by the filter
;; process, `agda2-go', `agda2-restart', and
;; `agda2-abort-highlighting'.
(defvar agda2-responses-expected nil
"Is the Agda process expected to produce at least one response?")
(make-variable-buffer-local 'agda2-responses-expected)
(defvar agda2-responses 0
"The number of encountered response commands.")
(make-variable-buffer-local 'agda2-responses)
(defvar agda2-output-chunk-incomplete (agda2-queue-empty)
"Buffer for incomplete lines.
\(See `agda2-output-filter'.)")
(make-variable-buffer-local 'agda2-output-chunk-incomplete)
(defvar agda2-last-responses nil
"Response commands which should be run after other commands.
The command which arrived last is stored first in the list.")
(make-variable-buffer-local 'agda2-last-responses)
(defvar agda2-file-buffer nil
"The Agda buffer.
Note that this variable is not buffer-local.")
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; agda2-mode
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.l?agda\\'" . agda2-mode))
;;;###autoload
(modify-coding-system-alist 'file "\\.l?agda\\'" 'utf-8)
;;;###autoload
(eval `(define-derived-mode agda2-mode
,(if (fboundp 'prog-mode) 'prog-mode)
"Agda"
"Major mode for Agda files.
The following paragraph does not apply to Emacs 23 or newer.
Note that when this mode is activated the default font of the
current frame is changed to the fontset `agda2-fontset-name'.
The reason is that Agda programs often use mathematical symbols
and other Unicode characters, so we try to provide a suitable
default font setting, which can display many of the characters
encountered. If you prefer to use your own settings, set
`agda2-fontset-name' to nil.
Special commands:
\\{agda2-mode-map}"
;; Check that the right version of Agda is used.
(let* ((coding-system-for-read 'utf-8)
(output (with-output-to-string
(call-process agda2-program-name
nil standard-output nil "--version")))
(version (and (string-match "^Agda version \\([0-9.]+\\)$" output)
(match-string 1 output))))
(unless (equal version agda2-version)
(error "The Agda mode's version (%s) does not match that of %s (%s)."
agda2-version
agda2-program-name (or version "unknown"))))
(setq local-abbrev-table agda2-mode-abbrev-table
indent-tabs-mode nil
mode-line-process
'((:eval (unless (eq 0 (length agda2-buffer-external-status))
(concat ":" agda2-buffer-external-status)))))
(let ((l '(max-specpdl-size 2600
max-lisp-eval-depth 2800)))
(while l (set (make-local-variable (pop l)) (pop l))))
(if (and window-system agda2-fontset-name)
(condition-case nil
(set-frame-font agda2-fontset-name)
(error (error "Unable to change the font; change agda2-fontset-name or tweak agda2-fontset-spec-of-fontset-agda2"))))
;; Deactivate highlighting if the buffer is edited before
;; typechecking is complete.
(add-hook 'first-change-hook 'agda2-abort-highlighting nil 'local)
;; If Agda is not running syntax highlighting does not work properly.
(unless (eq 'run (agda2-process-status))
(agda2-restart))
(agda2-highlight-setup)
(condition-case err
(agda2-highlight-reload)
(error (message "Highlighting not loaded: %s"
(error-message-string err))))
(agda2-comments-and-paragraphs-setup)
(force-mode-line-update)
;; Protect global value of default-input-method from set-input-method.
(make-local-variable 'default-input-method)
(set-input-method "Agda")
;; Highlighting etc. is removed when we switch from the Agda mode.
;; Use case: When a file M.lagda with a local variables list
;; including "mode: latex" is loaded chances are that the Agda mode
;; is activated before the LaTeX mode, and the LaTeX mode does not
;; seem to remove the text properties set by the Agda mode.
(add-hook 'change-major-mode-hook 'agda2-quit nil 'local)))
(defun agda2-restart ()
"Kill and restart the *agda2* buffer and load `agda2-toplevel-module'."
(interactive)
(save-excursion (let ((agda2-bufname "*agda2*"))
(condition-case nil
(agda2-term)
(error nil))
;; Start the Agda2 process in a new buffer.
(message "Starting agda process `%s'." agda2-program-name)
(let ((process-connection-type nil)) ; pipes are faster than PTYs
(apply 'start-process "Agda2" agda2-bufname
agda2-program-name
(cons "--interaction" agda2-program-args)))
;; Select agda buffer temporarily.
(with-current-buffer agda2-bufname
(setq process-adaptive-read-buffering t)
;; Clear message area.
(message "")
(setq agda2-process (get-buffer-process agda2-bufname)
agda2-process-buffer (process-buffer agda2-process)
agda2-in-progress nil
mode-name "Agda executable"
agda2-last-responses nil)
(set-buffer-file-coding-system 'utf-8)
(set-buffer-process-coding-system 'utf-8 'utf-8)
(set-process-query-on-exit-flag agda2-process nil))))
(setq agda2-file-buffer (current-buffer))
(set-process-filter agda2-process 'agda2-output-filter)
(agda2-remove-annotations))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Communicating with Agda
(defun agda2-raise-error ()
"Raises an error.
The error message directs the user to the *agda2* buffer."
(error "Problem encountered. The *agda2* buffer can perhaps explain why."))
(defun agda2-running-p nil
"Does the *agda2* buffer exist, and is the Agda2 process running?"
(and (buffer-live-p agda2-process-buffer)
(eq (agda2-process-status) 'run)))
(defun agda2-send-command (restart &rest args)
"Send a command to the Agda2 asyncronous process. Saves the buffer
and sends the list of strings ARGS to Agda2. If RESTART is non-nil
and the Agda2 process is not running, or the *agda2* buffer does not
exist, then an attempt is made to restart the process."
(save-buffer)
(when (and restart (not (agda2-running-p)))
;; Try restarting automatically, but only once, in case there is
;; some major problem.
(agda2-restart)
(unless (agda2-running-p)
(agda2-raise-error)))
(let ((command (apply 'concat (agda2-intersperse " " args))))
(with-current-buffer agda2-process-buffer
(goto-char (point-max))
(insert command)
(insert "\n")
(process-send-string agda2-process (concat command "\n")))))
(defun agda2-abort-if-in-progress ()
"Raise an error if the Agda process is (thought to be) busy."
(when agda2-in-progress
(error "Another command is currently in progress
\(if a command has been aborted you may want to restart Agda)")))
(defun agda2-go (responses-expected highlight do-abort &rest args)
"Executes commands in the Agda2 interpreter.
Sends the list of strings ARGS to the Agda2 interpreter, waits for
output and executes the responses, if any. If no responses are
received, and RESPONSES-EXPECTED is non-nil, then an error is
raised. If HIGHLIGHT is non-nil, then the buffer's syntax
highlighting may be updated."
(if do-abort (agda2-abort-if-in-progress))
(setq agda2-in-progress t
agda2-highlight-in-progress highlight
agda2-responses-expected responses-expected
agda2-responses 0
agda2-output-chunk-incomplete (agda2-queue-empty)
agda2-file-buffer (current-buffer))
(apply 'agda2-send-command
'restart
"IOTCM"
(agda2-string-quote (buffer-file-name))
(if highlight (agda2-highlight-level) "None")
"Indirect"
"("
(append args '(")"))))
(defun agda2-output-filter (proc chunk)
"Evaluate the Agda process's commands.
This filter function assumes that every line contains either some
kind of error message (which cannot be parsed as a list), or
exactly one command. Incomplete lines are stored in a
buffer (`agda2-output-chunk-incomplete').
Every command is run by this function, unless it has the form
\"(('last . priority) . cmd)\", in which case it is run by
`agda2-run-last-commands' at the end, after the Agda2 prompt
has reappeared, after all non-last commands, and after all
interactive highlighting is complete. The last commands can have
different integer priorities; those with the lowest priority are
executed first.
Non-last commands should not call the Agda process.
All commands are echoed to the *agda2* buffer, with the exception
of commands of the form \"(agda2-highlight-... ...)\".
The non-last commands are run in the order in which they appear.
When the prompt has been reached an error is raised if
`agda2-responses-expected' is non-nil and no commands have
arrived. Otherwise highlighting annotations are
reloaded from `agda2-highlighting-file', unless
`agda2-highlighting-in-progress' is nil."
(let (;; The input lines in the current chunk.
(lines (split-string chunk "\n"))
;; Non-last commands found in the current chunk (reversed).
(non-last-commands ())
;; Last incomplete line, if any.
(output-chunk-incomplete ""))
(with-current-buffer agda2-file-buffer
(when (consp lines)
(agda2-queue-enqueue agda2-output-chunk-incomplete (pop lines))
(when (consp lines)
;; The previous uncomplete chunk is now complete.
(push (agda2-queue-to-string agda2-output-chunk-incomplete)
lines)
;; Stash away the last incomplete line, if any. (Note that
;; (split-string "...\n" "\n") evaluates to (... "").)
(setq output-chunk-incomplete (car (last lines))
agda2-output-chunk-incomplete
(agda2-queue-from-string output-chunk-incomplete))
;; Handle every complete line.
(dolist (line (butlast lines))
(let* (;; The command. Lines which cannot be parsed as a single
;; list, without any junk, are ignored.
(cmd (condition-case nil
(let ((result (read-from-string line)))
(if (and (listp (car result))
(= (cdr result) (length line)))
(car result)))
(error nil))))
(when cmd
(unless (and (symbolp (car cmd))
(let ((case-fold-search nil))
(string-match "^agda2-highlight-"
(symbol-name (car cmd)))))
;; Do not echo highlighting commands.
(with-current-buffer agda2-process-buffer
(save-excursion
(goto-char (point-max))
(insert line)
(insert "\n")))
(incf agda2-responses))
(if (equal 'last (car-safe (car cmd)))
(push (cons (cdr (car cmd)) (cdr cmd))
agda2-last-responses)
(push cmd non-last-commands)))))
;; Run non-last commands.
(mapc 'agda2-exec-response (nreverse non-last-commands)))
;; Check if the prompt has been reached. This function assumes
;; that the prompt does not include any newline characters.
(when (agda2-queue-is-prefix-of agda2-output-prompt
agda2-output-chunk-incomplete)
(with-current-buffer agda2-process-buffer
(insert output-chunk-incomplete))
(setq agda2-output-chunk-incomplete (agda2-queue-empty)
agda2-in-progress nil
agda2-last-responses (nreverse agda2-last-responses))
(when (and agda2-responses-expected
(equal agda2-responses 0))
(agda2-raise-error))
(agda2-run-last-commands)
(when agda2-measure-data
(let ((elapsed
(format "%.2fs"
(float-time (time-since
(cdr agda2-measure-data)))))
(continuation (car agda2-measure-data)))
(setq agda2-measure-data nil)
(message "Load time: %s." elapsed)
(when continuation
(funcall continuation elapsed)))))))))
(defun agda2-run-last-commands nil
"Execute the last commands in the right order.
\(After the prompt has reappeared.) See `agda2-output-filter'."
;; with-current-buffer is used repeatedly below, because some last
;; commands may switch the focus to another buffer.
(while (with-current-buffer agda2-file-buffer
(and (not agda2-in-progress) (consp agda2-last-responses)))
(with-current-buffer agda2-file-buffer
;; The list is sorted repeatedly because this function may be
;; called recursively (via `agda2-exec-response').
(setq agda2-last-responses (sort agda2-last-responses
(lambda (x y) (<= (car x) (car y)))))
(let ((r (pop agda2-last-responses)))
(agda2-exec-response (cdr r)))))
;; Unset agda2-highlight-in-progress when all the asynchronous
;; commands have terminated.
(unless agda2-in-progress
(setq agda2-highlight-in-progress nil)))
(defun agda2-abort-highlighting nil
"Abort any interactive highlighting.
This function should be used in `first-change-hook'."
(when agda2-highlight-in-progress
(setq agda2-highlight-in-progress nil)
(message "\"%s\" has been modified. Interrupting highlighting."
(buffer-name (current-buffer)))))
(defun agda2-goal-cmd (cmd &optional want ask &rest args)
"Reads input from goal or minibuffer and sends command to Agda.
An error is raised if point is not in a goal.
The command sent to Agda is
CMD <goal number> <goal range> <user input> ARGS.
The user input is computed as follows:
* If WANT is nil, then the user input is the empty string.
* If WANT is a string, and either ASK is non-nil or the goal only
contains whitespace, then the input is taken from the
minibuffer. In this case WANT is used as the prompt string.
* Otherwise (including if WANT is 'goal) the goal contents are
used.
If the user input is not taken from the goal, then an empty goal
range is given.
An error is raised if no responses are received."
(multiple-value-bind (o g) (agda2-goal-at (point))
(unless g (error "For this command, please place the cursor in a goal"))
(let ((txt (buffer-substring-no-properties (+ (overlay-start o) 2)
(- (overlay-end o) 2)))
(input-from-goal nil))
(cond ((null want) (setq txt ""))
((and (stringp want)
(or ask (string-match "\\`\\s *\\'" txt)))
(setq txt (read-string (concat want ": ") nil nil txt t)))
(t (setq input-from-goal t)))
(apply 'agda2-go t t t cmd
(format "%d" g)
(if input-from-goal (agda2-goal-Range o) "noRange")
(agda2-string-quote txt) args))))
;; Note that the following function is a security risk, since it
;; evaluates code without first inspecting it. The code (supposedly)
;; comes from the Agda backend, but there could be bugs in the backend
;; which can be exploited by an attacker which manages to trick
;; someone into type-checking compromised Agda code.
(defun agda2-exec-response (response)
"Interprets response."
(let ((inhibit-read-only t))
(eval response)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; User commands and response processing
(defun agda2-load ()
"Load current buffer."
(interactive)
(agda2-go t t t "Cmd_load"
(agda2-string-quote (buffer-file-name))
(agda2-list-quote agda2-include-dirs)
))
(defun agda2-measure-load-time
(&optional highlighting-level dont-touch continuation)
"Load the current buffer and print how much time it takes.
\(Wall-clock time.)
The given HIGHLIGHTING-LEVEL is used (if non-nil).
The file is first saved and \"touched\", unless DONT-TOUCH is
non-nil.
If CONTINUATION is non-nil, then CONTINUATION is applied to the
resulting time (represented as a string)."
(interactive)
(agda2-abort-if-in-progress)
(unless dont-touch
(save-buffer)
(shell-command (concat "touch \"" (buffer-file-name) "\"")))
(let* ((agda2-highlight-level
(or highlighting-level agda2-highlight-level)))
(setq agda2-measure-data (cons continuation (current-time)))
(agda2-load)))
(defun agda2-compile ()
"Compile the current module.
The variable `agda2-backend' determines which backend is used."
(interactive)
(agda2-go t t t "Cmd_compile"
agda2-backend
(agda2-string-quote (buffer-file-name))
(agda2-list-quote agda2-include-dirs)
))
(defun agda2-give()
"Give to the goal at point the expression in it" (interactive)
(agda2-goal-cmd "Cmd_give" "expression to give"))
(defun agda2-give-action (old-g paren)
"Update the goal OLD-G with the expression in it."
(let
;; Don't run modification hooks: we don't want this to
;; trigger agda2-abort-highlighting.
((inhibit-modification-hooks t))
(agda2-update old-g paren)))
(defun agda2-refine (pmlambda)
"Refine the goal at point.
If the goal contains an expression e, and some \"suffix\" of the
type of e unifies with the goal type, then the goal is replaced
by e applied to a suitable number of new goals.
PMLAMBDA is only used if the goal has a functional type.
When the prefix argument is given a pattern maching lambda will
be inserted, otherwise a standard lambda will be used.
If the goal is empty, the goal type is a data type, and there is
exactly one constructor which unifies with this type, then the
goal is replaced by the constructor applied to a suitable number
of new goals."
(interactive "P")
(if pmlambda
(agda2-goal-cmd "Cmd_refine_or_intro True" 'goal)
(agda2-goal-cmd "Cmd_refine_or_intro False" 'goal)))
(defun agda2-auto ()
"Simple proof search" (interactive)
(agda2-goal-cmd "Cmd_auto" 'goal))
(defun agda2-make-case ()
"Refine the pattern variables given in the goal.
Assumes that <clause> = {!<variables>!} is on one line."
(interactive)
(agda2-goal-cmd "Cmd_make_case" "pattern variables to case"))
(defun agda2-make-case-action (newcls)
"Replace the line at point with new clauses NEWCLS and reload."
(agda2-forget-all-goals);; we reload later anyway.
(let* ((p0 (point))
;; (p1 (goto-char (agda2-decl-beginning)))
(p1 (goto-char (+ (current-indentation) (line-beginning-position))))
(indent (current-column))
cl)
(goto-char p0)
(re-search-forward "!}" (line-end-position) 'noerr)
(delete-region p1 (point))
(while (setq cl (pop newcls))
(insert cl)
(if newcls (insert "\n" (make-string indent ? ))))
(goto-char p1))
(agda2-load))
(defun agda2-make-case-action-extendlam (newcls)
"Replace definition of extended lambda with new clauses NEWCLS and reload."
(agda2-forget-all-goals);; we reload later anyway.
(let* ((pmax (- (re-search-forward "\\([^!]}\\)\\|;") 1))
(bracketCount 0)
cl)
(re-search-backward "{!")
(while (and (not (equal (preceding-char) ?\;)) (>= bracketCount 0))
(backward-char)
(if (equal (preceding-char) ?}) (incf bracketCount))
(if (equal (preceding-char) ?{) (decf bracketCount)))
(let ((p (point)))
(delete-region (point) pmax)
(insert " ")
(while (setq cl (pop newcls))
(insert cl)
(if newcls (insert " ; ")))
(insert " ")
(goto-char p)))
(agda2-load))
(defun agda2-status-action (status)
"Display the string STATUS in the current buffer's mode line.
\(precondition: the current buffer has to use the Agda mode as the
major mode)."
(setq agda2-buffer-external-status status))
(defun agda2-info-buffer nil
"Creates the Agda info buffer, if it does not already exist.
The buffer is returned."
(unless (buffer-live-p agda2-info-buffer)
(setq agda2-info-buffer
(generate-new-buffer "*Agda information*"))
(with-current-buffer agda2-info-buffer
(compilation-mode "AgdaInfo")
;; Support for jumping to positions mentioned in the text.
(set (make-local-variable 'compilation-error-regexp-alist)
'(("\\([\\\\/][^[:space:]]*\\):\\([0-9]+\\),\\([0-9]+\\)-\\(\\([0-9]+\\),\\)?\\([0-9]+\\)"
1 (2 . 5) (3 . 6))))
;; No support for recompilation. The key binding is removed, and
;; attempts to run `recompile' will (hopefully) result in an
;; error.
(let ((map (copy-keymap (current-local-map))))
(define-key map (kbd "g") 'undefined)
(use-local-map map))
(set (make-local-variable 'compile-command)
'agda2-does-not-support-compilation-via-the-compilation-mode)
(set-syntax-table agda2-mode-syntax-table)
(set-input-method "Agda")))
agda2-info-buffer)
(defun agda2-info-action (name text &optional append)
"Insert TEXT into the Agda info buffer and display it.
NAME is displayed in the buffer's mode line.
If APPEND is non-nil, then TEXT is appended at the end of the
buffer, and point placed after this text.
If APPEND is nil, then any previous text is removed before TEXT
is inserted, and point is placed before this text."
(interactive)
(with-current-buffer (agda2-info-buffer)
;; In some cases the jump-to-position-mentioned-in-text
;; functionality (see compilation-error-regexp-alist above) didn't
;; work: Emacs jumped to the wrong position. However, it seems to
;; work if compilation-forget-errors is used. This problem may be
;; related to Emacs bug #9679
;; (http://debbugs.gnu.org/cgi/bugreport.cgi?bug=9679). The idea
;; to use compilation-forget-errors comes from a comment due to
;; Oleksandr Manzyuk
;; (https://github.com/haskell/haskell-mode/issues/67).
(compilation-forget-errors)
(unless append (erase-buffer))
(save-excursion
(goto-char (point-max))
(insert text))
(put-text-property 0 (length name) 'face '(:weight bold) name)
(setq mode-line-buffer-identification name)
(save-selected-window
(let (;; If there is only one window, then the info window
;; should be created above or below the code window, not
;; to the left or right.
(split-width-threshold nil)
(buf (current-buffer))
)
;; Andreas, 2014-02-23, issue 1061
;; If the buffer is already displayed in some window,
;; do not display it again. Also, do not raise its frame.
;; This allows undisturbed working on something else while
;; Agda is type-checking.
;; The solution is to query for the window displaying the buffer
;; via get-buffer-window. Only if it return nil, we pop-to-buffer.
;; Credits go to Iqbal Ansari who anwered my question on
;; http://stackoverflow.com/questions/21955162/emacs-how-to-display-a-buffer-without-switching-window-and-without-raising-fram
;; 2014-03-01 DISABLED FIX
;; (unless (get-buffer-window buf t)
(pop-to-buffer buf nil 'norecord)
(fit-window-to-buffer nil
(truncate
(* (frame-height) agda2-information-window-max-height)))
;; )
(if append
(goto-char (point-max))
(goto-char (point-min)))))))
(defun agda2-info-action-and-copy (name text &optional append)
"Same as agda2-info-action but also puts TEXT in the kill ring."
(kill-new text)
(agda2-info-action name text append))
(defun agda2-show-goals()
"Show all goals." (interactive)
(agda2-go t t t "Cmd_metas"))
(defun agda2-show-constraints()
"Show constraints." (interactive)
(agda2-go t t t "Cmd_constraints"))
(defun agda2-remove-annotations ()
"Removes buffer annotations (overlays and text properties)."
(interactive)
(dolist (o (overlays-in (point-min) (point-max)))
(delete-overlay o))
(let ((inhibit-read-only t))
(annotation-preserve-mod-p-and-undo
(set-text-properties (point-min) (point-max) '()))
(force-mode-line-update)))
(defun agda2-next-goal () "Go to the next goal, if any." (interactive)
(agda2-mv-goal 'next-single-property-change 'agda2-delim2 1 (point-min)))
(defun agda2-previous-goal () "Go to the previous goal, if any." (interactive)
(agda2-mv-goal 'previous-single-property-change 'agda2-delim3 0 (point-max)))
(defun agda2-mv-goal (change delim adjust wrapped)
(agda2-let ()
((go (p) (while (and (setq p (funcall change p 'category))
(not (eq (get-text-property p 'category) delim))))
(if p (goto-char (+ adjust p)))))
(or (go (point)) (go wrapped) (message "No goals in the buffer"))))
(defun agda2-quit ()
"Quit and clean up after agda2."
(interactive)
(remove-hook 'first-change-hook 'agda2-abort-highlighting 'local)
(agda2-remove-annotations)
(agda2-term))
(defun agda2-term ()
"Send a SIGTERM signal to the Agda2 process, then kill its buffer."
(interactive)
(with-current-buffer agda2-process-buffer
(condition-case nil
(signal-process agda2-process 'SIGTERM)
(error nil))
(kill-buffer)))
(defmacro agda2-maybe-normalised (name comment cmd want)
"This macro constructs a function NAME which runs CMD.
COMMENT is used to build the function's comment. The function
NAME takes a prefix argument which tells whether it should
normalise types or not when running CMD (through
`agda2-goal-cmd'; WANT is used as `agda2-goal-cmd's WANT
argument)."
(let ((eval (make-symbol "eval")))
`(defun ,name (&optional prefix)
,(concat comment ".
The form of the result depends on the prefix argument:
* If the prefix argument is `nil' (i.e., if no prefix argument is
given), then the result is simplified.
* If the prefix argument is `(4)' (for instance if C-u is typed
exactly once right before the command is invoked), then the
result is neither explicitly normalised nor simplified.
* If any other prefix argument is used (for instance if C-u is
typed twice right before the command is invoked), then the
result is normalised.")
(interactive "P")
(let ((,eval (cond ((equal prefix nil) "Simplified")
((equal prefix '(4)) "Instantiated")
("Normalised"))))
(agda2-goal-cmd (concat ,cmd " " ,eval)
,want)))))
(defmacro agda2-maybe-normalised-toplevel (name comment cmd prompt)
"This macro constructs a function NAME which runs CMD.
COMMENT is used to build the function's comments. The function
NAME takes a prefix argument which tells whether it should
normalise types or not when running CMD (through
`agda2-go' t nil t; the string PROMPT is used as the goal command
prompt)."
(let ((eval (make-symbol "eval")))
`(defun ,name (prefix expr)
,(concat comment ".
The form of the result depends on the prefix argument:
* If the prefix argument is `nil' (i.e., if no prefix argument is
given), then the result is simplified.
* If the prefix argument is `(4)' (for instance if C-u is typed
exactly once right before the command is invoked), then the
result is neither explicitly normalised nor simplified.
* If any other prefix argument is used (for instance if C-u is
typed twice right before the command is invoked), then the
result is normalised.")
(interactive ,(concat "P\nM" prompt ": "))
(let ((,eval (cond ((equal prefix nil) "Simplified")
((equal prefix '(4)) "Instantiated")
("Normalised"))))
(agda2-go t nil t
(concat ,cmd " " ,eval " "
(agda2-string-quote expr)))))))
(agda2-maybe-normalised
agda2-goal-type
"Show the type of the goal at point"
"Cmd_goal_type"
nil)
(agda2-maybe-normalised
agda2-infer-type
"Infer the type of the goal at point"
"Cmd_infer"
"expression to type")
(agda2-maybe-normalised-toplevel
agda2-infer-type-toplevel
"Infers the type of the given expression. The scope used for
the expression is that of the last point inside the current
top-level module"
"Cmd_infer_toplevel"
"Expression")
(defun agda2-infer-type-maybe-toplevel ()
"Infers the type of the given expression.
Either uses the scope of the current goal or, if point is not in a goal, the
top-level scope."
(interactive)
(call-interactively (if (agda2-goal-at (point))
'agda2-infer-type
'agda2-infer-type-toplevel)))
(defun agda2-why-in-scope ()
"Explain why something is in scope in a goal."
(interactive)
(agda2-goal-cmd "Cmd_why_in_scope" "Name"))
(defun agda2-why-in-scope-toplevel (name)
"Explain why something is in scope at the top level."
(interactive "MName: ")
(agda2-go t nil t
"Cmd_why_in_scope_toplevel"
(agda2-string-quote name)))
(defun agda2-why-in-scope-maybe-toplevel ()
"Explains why a given name is in scope."
(interactive)
(call-interactively (if (agda2-goal-at (point))
'agda2-why-in-scope
'agda2-why-in-scope-toplevel)))
(agda2-maybe-normalised
agda2-goal-and-context
"Shows the type of the goal at point and the currect context"
"Cmd_goal_type_context"
nil)
(agda2-maybe-normalised
agda2-goal-and-context-and-inferred
"Shows the context, the goal and the given expression's inferred type"
"Cmd_goal_type_context_infer"
"expression to type")
(agda2-maybe-normalised
agda2-show-context
"Show the context of the goal at point"
"Cmd_context"
nil)
(agda2-maybe-normalised
agda2-helper-function-type
"Compute the type of a hypothetical helper function."
"Cmd_helper_function"
"Expression")
(defun agda2-module-contents ()
"Shows all the top-level names in the given module.
Along with their types."
(interactive)
(agda2-goal-cmd "Cmd_show_module_contents" "Module name"))
(defun agda2-module-contents-toplevel (module)
"Shows all the top-level names in the given module.
Along with their types."
(interactive "MModule name: ")
(agda2-go t nil t
"Cmd_show_module_contents_toplevel"
(agda2-string-quote module)))
(defun agda2-module-contents-maybe-toplevel ()
"Shows all the top-level names in the given module.
Along with their types.
Uses either the scope of the current goal or, if point is not in
a goal, the top-level scope."
(interactive)
(call-interactively (if (agda2-goal-at (point))
'agda2-module-contents
'agda2-module-contents-toplevel)))
(defun agda2-solveAll ()
"Solves all goals that are already instantiated internally."
(interactive)
(agda2-go t t t "Cmd_solveAll"))
(defun agda2-solveAll-action (iss)
(while iss
(let* ((g (pop iss)) (txt (pop iss))
(cmd (cons 'agda2-solve-action (cons g (cons txt nil)))))
(if (null agda2-last-responses)
(push (cons 1 cmd) agda2-last-responses)
(nconc agda2-last-responses (cons (cons 3 cmd) nil))))))
(defun agda2-solve-action (g txt)
(save-excursion
(agda2-replace-goal g txt)
(agda2-goto-goal g)
(agda2-give)))
(defun agda2-compute-normalised (&optional arg)
"Compute the normal form of the expression in the goal at point.
With a prefix argument \"abstract\" is ignored during the computation."
(interactive "P")
(let ((cmd (concat "Cmd_compute"
(if arg " True" " False"))))
(agda2-goal-cmd cmd "expression to normalise")))
(defun agda2-compute-normalised-toplevel (expr &optional arg)
"Computes the normal form of the given expression.
The scope used for the expression is that of the last point inside the current
top-level module.
With a prefix argument \"abstract\" is ignored during the computation."
(interactive "MExpression: \nP")
(let ((cmd (concat "Cmd_compute_toplevel"
(if arg " True" " False")
" ")))
(agda2-go t nil t (concat cmd (agda2-string-quote expr)))))
(defun agda2-compute-normalised-maybe-toplevel ()
"Computes the normal form of the given expression,
using the scope of the current goal or, if point is not in a goal, the
top-level scope.
With a prefix argument \"abstract\" is ignored during the computation."
(interactive)
(if (agda2-goal-at (point))
(call-interactively 'agda2-compute-normalised)
(call-interactively 'agda2-compute-normalised-toplevel)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;
(defun agda2-highlight-reload nil
"Loads precomputed syntax highlighting info for the current buffer.
If there is any to load."
(agda2-go nil t t
"Cmd_load_highlighting_info"
(agda2-string-quote (buffer-file-name))))
(defun agda2-literate-p ()
"Is the current buffer a literate Agda buffer?"
(equal (file-name-extension (buffer-name)) "lagda"))
(defun agda2-goals-action (goals)
"Annotates the goals in the current buffer with text properties.
GOALS is a list of the buffer's goal numbers, in the order in
which they appear in the buffer. Note that this function should
be run /after/ syntax highlighting information has been loaded,
because the two highlighting mechanisms interact in unfortunate
ways."
(agda2-forget-all-goals)
(agda2-let
((literate (agda2-literate-p))
stk
top
;; Don't run modification hooks: we don't want this function to
;; trigger agda2-abort-highlighting.
(inhibit-modification-hooks t))
((delims() (re-search-forward "[?]\\|[{][-!]\\|[-!][}]\\|--\\|\\\\begin{code}\\|\\\\end{code}" nil t))
;; is-proper checks whether string s (e.g. "?" or "--") is proper
;; i.e., is not part of an identifier.
;; comment-starter is true if s starts a comment (e.g. "--")
(is-proper (s comment-starter)
(save-excursion
(save-match-data
(backward-char (length s))
(unless (bolp) (backward-char 1)) ;; bolp = pointer at beginning of line
;; Andreas, 2014-05-17 Issue 1132
;; A questionmark can also follow immediately after a .
;; for instance to be a place holder for a dot pattern.
(looking-at (concat "\\([.{}();]\\|^\\|\\s \\)" ;; \\s = whitespace
(regexp-quote s)
(unless comment-starter
"\\([{}();]\\|$\\|\\s \\)"))))))
(make(p) (agda2-make-goal p (point) (pop goals)))
(inside-comment() (and stk (null (car stk))))
(inside-goal() (and stk (integerp (car stk))))
(outside-code() (and stk (eq (car stk) 'outside)))
(inside-code() (not (outside-code)))
;; inside a multi-line comment ignore everything but the multi-line comment markers
(safe-delims()
(if (inside-comment)
(re-search-forward "{-\\|-}" nil t)
(delims))))
(save-excursion
;; In literate mode we should start out in the "outside of code"
;; state.
(if literate (push 'outside stk))
(goto-char (point-min))
(while (and goals (safe-delims))
(cl-labels ((c (s) (equal s (match-string 0))))
(cond
((c "\\begin{code}") (when (outside-code) (pop stk)))
((c "\\end{code}") (when (not stk) (push 'outside stk)))
((c "--") (when (and (not stk)
(is-proper "--" t)) (end-of-line)))
((c "{-") (when (and (inside-code)
(not (inside-goal))) (push nil stk)))
((c "-}") (when (inside-comment) (pop stk)))
((c "{!") (when (and (inside-code)
(not (inside-comment))) (push (- (point) 2) stk)))
((c "!}") (when (inside-goal)
(setq top (pop stk))
(unless stk (make top))))
((c "?") (progn
(when (and (not stk) (is-proper "?" nil))
(delete-char -1)
(insert "{!!}")
(make (- (point) 4)))))))))))
(defun agda2-make-goal (p q n)
"Make a goal with number N at <P>{!...!}<Q>. Assume the region is clean."
(annotation-preserve-mod-p-and-undo
(cl-flet ((atp (x ps) (add-text-properties x (1+ x) ps)))
(atp p '(category agda2-delim1))
(atp (1+ p) '(category agda2-delim2))
(atp (- q 2) '(category agda2-delim3))
(atp (1- q) '(category agda2-delim4)))
(let ((o (make-overlay p q nil t nil)))
(overlay-put o 'modification-hooks '(agda2-protect-goal-markers))
(overlay-put o 'agda2-gn n)
(overlay-put o 'face 'highlight)
(overlay-put o 'after-string (propertize (format "%s" n) 'face 'highlight)))))
(defun agda2-protect-goal-markers (ol action beg end &optional length)
"Ensures that the goal markers cannot be tampered with.
Except if `inhibit-read-only' is non-nil or /all/ of the goal is
modified."
(if action
;; This is the after-change hook.
nil
;; This is the before-change hook.
(cond
((and (<= beg (overlay-start ol)) (>= end (overlay-end ol)))
;; The user is trying to remove the whole goal:
;; manually evaporate the overlay and add an undo-log entry so
;; it gets re-added if needed.
(when (listp buffer-undo-list)
(push (list 'apply 0 (overlay-start ol) (overlay-end ol)
'move-overlay ol (overlay-start ol) (overlay-end ol))
buffer-undo-list))
(delete-overlay ol))
((or (< beg (+ (overlay-start ol) 2))
(> end (- (overlay-end ol) 2)))
(unless inhibit-read-only
(signal 'text-read-only nil))))))
(defun agda2-update (old-g new-txt)
"Update the goal OLD-G.
If NEW-TXT is a string, then the goal is replaced by the string,
and otherwise the text inside the goal is retained (parenthesised
if NEW-TXT is `'paren').
Removes the goal braces, but does not remove the goal overlay or
text properties."
(multiple-value-bind (p q) (agda2-range-of-goal old-g)
(save-excursion
(cond ((stringp new-txt)
(agda2-replace-goal old-g new-txt))
((equal new-txt 'paren)
(goto-char (- q 2)) (insert ")")
(goto-char (+ p 2)) (insert "(")))
(multiple-value-bind (p q) (agda2-range-of-goal old-g)
(delete-region (- q 2) q)
(delete-region p (+ p 2)))
;; Update highlighting
(if (and (not (equal new-txt 'paren)) (not (equal new-txt 'no-paren)))
(apply 'agda2-go t t nil "Cmd_highlight"
(format "%d" old-g)
(agda2-mkRange p (- q 2))
(agda2-string-quote new-txt) nil))
)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; Misc
(defun agda2-process-status ()
"Status of `agda2-process-buffer', or \"no process\"."
(condition-case nil
(process-status agda2-process)
(error "no process")))
(defun agda2-intersperse (sep xs)
(let(ys)(while xs (push (pop xs) ys)(push sep ys))(pop ys)(nreverse ys)))
(defun agda2-goal-Range (o)
"The Haskell Range of goal overlay O."
(agda2-mkRange (+ (overlay-start o) 2)
(- (overlay-end o) 2)))
(defun agda2-mkRange (p q)
"The Haskell Range corresponding to two points."
(format "(Range [Interval %s %s])"
(agda2-mkPos p)
(agda2-mkPos q)))
(defun agda2-mkPos (&optional p)
"The Haskell Position corresponding to P or `point'."
(save-excursion
(if p (goto-char p))
(format "(Pn (Just (mkAbsolute %s)) %d %d %d)"
(agda2-string-quote (file-truename (buffer-file-name)))
(point)
(count-lines (point-min) (point))
(1+ (current-column)))))
(defun agda2-char-quote (c)
"Convert character C to the notation used in Haskell strings.
The non-ASCII characters are actually rendered as
\"\\xNNNN\\&\", i.e. followed by a \"null character\", to avoid
problems if they are followed by digits. ASCII characters (code
points < 128) are converted to singleton strings."
(if (< c 128)
(list c)
;; FIXME: Why return a list rather than a string? --Stef
(append (format "\\x%x\\&" (encode-char c 'ucs)) nil)))
(defun agda2-string-quote (s)
"Format S as a Haskell string literal.
Removes any text properties, escapes newlines, double quotes,
etc., adds surrounding double quotes, and converts non-ASCII
characters to the \\xNNNN notation used in Haskell strings."
(let ((pp-escape-newlines t)
(s2 (copy-sequence s)))
(set-text-properties 0 (length s2) nil s2)
(mapconcat 'agda2-char-quote (pp-to-string s2) "")))
(defun agda2-list-quote (strings)
"Convert a list of STRINGS into a string representing it in Haskell syntax."
(concat "[" (mapconcat 'agda2-string-quote strings ", ") "]"))
(defun agda2-goal-at(pos)
"Return (goal overlay, goal number) at POS, or nil."
(let ((os (and pos (overlays-at pos))) o g)
(while (and os (not(setq g (overlay-get (setq o (pop os)) 'agda2-gn)))))
(if g (list o g))))
(defun agda2-goal-overlay (g)
"Returns the overlay of goal number G, if any."
(car
(remove nil
(mapcar (lambda (o) (if (equal (overlay-get o 'agda2-gn) g) o))
(overlays-in (point-min) (point-max))))))
(defun agda2-range-of-goal (g)
"The range of goal G."
(let ((o (agda2-goal-overlay g)))
(if o (list (overlay-start o) (overlay-end o)))))
(defun agda2-goto-goal (g)
(let ((p (+ 2 (car (agda2-range-of-goal g)))))
(if p (goto-char p))))
(defun agda2-replace-goal (g newtxt)
"Replace the content of goal G with NEWTXT." (interactive)
(save-excursion
(multiple-value-bind (p q) (agda2-range-of-goal g)
(setq p (+ p 2) q (- q 2))
(let ((indent (and (goto-char p) (current-column))))
(delete-region p q) (insert newtxt)
(while (re-search-backward "^" p t)
(insert-char ? indent) (backward-char (1+ indent)))))))
(defun agda2-forget-all-goals ()
"Remove all goal annotations.
\(Including some text properties which might be used by other
\(minor) modes.)"
(annotation-preserve-mod-p-and-undo
(remove-text-properties (point-min) (point-max)
'(category nil agda2-delim2 nil agda2-delim3 nil
display nil rear-nonsticky nil)))
(let ((p (point-min)))
(while (< (setq p (next-single-char-property-change p 'agda2-gn))
(point-max))
(delete-overlay (car (agda2-goal-at p))))))
(defun agda2-decl-beginning ()
"Find the beginning point of the declaration containing the point.
To do: dealing with semicolon separated decls."
(interactive)
(save-excursion
(let* ((pEnd (point))
(pDef (progn (goto-char (point-min))
(re-search-forward "\\s *" pEnd t)))
(cDef (current-column)))
(while (re-search-forward
"where\\(\\s +\\)\\S \\|^\\(\\s *\\)\\S " pEnd t)
(if (match-end 1)
(setq pDef (goto-char (match-end 1))
cDef (current-column))
(goto-char (match-end 2))
(if (>= cDef (current-column))
(setq pDef (point)
cDef (current-column))))
(forward-char))
(goto-char pDef)
(if (equal (current-word) "mutual")
(or (match-end 2) (match-end 1))
pDef))))
(defun agda2-beginning-of-decl ()
(interactive)
(goto-char (agda2-decl-beginning)))
(defvar agda2-debug-buffer-name "*Agda debug*"
"The name of the buffer used for Agda debug messages.")
(defun agda2-verbose (msg)
"Appends the string MSG to the `agda2-debug-buffer-name' buffer.
Note that this buffer's contents is not erased automatically when
a file is loaded."
(with-current-buffer (get-buffer-create agda2-debug-buffer-name)
(save-excursion
(goto-char (point-max))
(insert msg))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Comments and paragraphs
(defun agda2-comments-and-paragraphs-setup nil
"Set up comment and paragraph handling for Agda mode."
;; Syntax table setup for comments is done elsewhere.
;; Enable highlighting of comments via Font Lock mode (which uses
;; the syntax table).
(set (make-local-variable 'font-lock-defaults)
'(nil nil nil nil nil))
;; If the following s-expression is removed, then highlighting of
;; comments stops working.
(when font-lock-mode
(font-lock-mode t))
;; Empty lines (all white space according to Emacs) delimit
;; paragraphs.
(set (make-local-variable 'paragraph-start) "\\s-*$")
(set (make-local-variable 'paragraph-separate) paragraph-start)
;; Support for adding/removing comments.
(set (make-local-variable 'comment-start) "-- ")
;; Support for proper filling of text in comments (requires that
;; Filladapt is activated).
(when (featurep 'filladapt)
(add-to-list (make-local-variable
'filladapt-token-table)
'("--" agda2-comment))
(add-to-list (make-local-variable 'filladapt-token-match-table)
'(agda2-comment agda2-comment) t)
(add-to-list (make-local-variable 'filladapt-token-conversion-table)
'(agda2-comment . exact))))
(defun agda2-comment-dwim-rest-of-buffer ()
"Comment or uncomment the rest of the buffer.
From the beginning of the current line to the end of the buffer."
(interactive)
(save-excursion
(forward-line 0)
(push-mark (point) 'no-message 'activate-mark)
(unwind-protect
(progn
(goto-char (point-max))
(comment-dwim nil))
(pop-mark))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Go to definition site
(defun agda2-goto (filepos &optional other-window)
"Like `annotation-goto', unless `agda2-highlight-in-progress' is nil."
(if agda2-highlight-in-progress
(annotation-goto filepos other-window)))
(defun agda2-goto-definition-keyboard (&optional other-window)
"Go to the definition site of the name under point (if any).
If this function is invoked with a prefix argument then another window is used
to display the given position."
(interactive "P")
(annotation-goto-indirect (point) other-window))
(defun agda2-goto-definition-mouse (ev)
"Go to the definition site of the name clicked on, if any.
Otherwise, yank (see `mouse-yank-primary')."
(interactive "e")
(let ((pos (posn-point (event-end ev))))
(if (annotation-goto-possible pos)
(annotation-goto-indirect pos)
;; FIXME: Shouldn't we use something like
;; (call-interactively (key-binding ev))? --Stef
(mouse-yank-primary ev))))
(defun agda2-go-back nil
"Go back to the previous position in which
`agda2-goto-definition-keyboard' or `agda2-goto-definition-mouse' was
invoked."
(interactive)
(annotation-go-back))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Implicit arguments
(defun agda2-display-implicit-arguments (&optional arg)
"Toggle display of implicit arguments.
With prefix argument, turn on display of implicit arguments if
the argument is a positive number, otherwise turn it off."
(interactive "P")
(cond ((eq arg nil) (agda2-go t t t "ToggleImplicitArgs"))
((and (numberp arg)
(> arg 0)) (agda2-go t t t "ShowImplicitArgs" "True"))
(t (agda2-go t t t "ShowImplicitArgs" "False"))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;
(defun agda2-popup-menu-3 (ev)
"If in a goal, popup the goal menu and call chosen command."
(interactive "e")
(let (choice)
(save-excursion
(and (agda2-goal-at (goto-char (posn-point (event-end ev))))
(setq choice (x-popup-menu ev agda2-goal-map))
(call-interactively
(lookup-key agda2-goal-map (apply 'vector choice)))))))
(provide 'agda2-mode)
;;; agda2-mode.el ends here
|