/usr/share/emacs/site-lisp/ocaml-mode/caml.el is in ocaml-mode 3.12.1-2ubuntu2.
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 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 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 | ;(***********************************************************************)
;(* *)
;(* Objective Caml *)
;(* *)
;(* Jacques Garrigue and Ian T Zimmerman *)
;(* *)
;(* Copyright 1997 Institut National de Recherche en Informatique et *)
;(* en Automatique. All rights reserved. This file is distributed *)
;(* under the terms of the GNU General Public License. *)
;(* *)
;(***********************************************************************)
;(* $Id: caml.el 11055 2011-05-20 07:40:01Z garrigue $ *)
;;; caml.el --- O'Caml code editing commands for Emacs
;; Xavier Leroy, july 1993.
;;indentation code is Copyright (C) 1996 by Ian T Zimmerman <itz@rahul.net>
;;copying: covered by the current FSF General Public License.
;; indentation code adapted for Objective Caml by Jacques Garrigue,
;; july 1997. <garrigue@kurims.kyoto-u.ac.jp>
;;user customizable variables
(defvar caml-quote-char "'"
"*Quote for character constants. \"'\" for Objective Caml, \"`\" for Caml-Light.")
(defvar caml-imenu-enable nil
"*Enable Imenu support.")
(defvar caml-mode-indentation 2
"*Used for \\[caml-unindent-command].")
(defvar caml-lookback-limit 5000
"*How far to look back for syntax things in caml mode.")
(defvar caml-max-indent-priority 8
"*Bounds priority of operators permitted to affect caml indentation.
Priorities are assigned to `interesting' caml operators as follows:
all keywords 0 to 7 8
type, val, ... + 0 7
:: ^ 6
@ 5
:= <- 4
if 3
fun, let, match ... 2
module 1
opening keywords 0.")
(defvar caml-apply-extra-indent 2
"*How many spaces to add to indentation for an application in caml mode.")
(make-variable-buffer-local 'caml-apply-extra-indent)
(defvar caml-begin-indent 2
"*How many spaces to indent from a begin keyword in caml mode.")
(make-variable-buffer-local 'caml-begin-indent)
(defvar caml-class-indent 2
"*How many spaces to indent from a class keyword in caml mode.")
(make-variable-buffer-local 'caml-class-indent)
(defvar caml-exception-indent 2
"*How many spaces to indent from a exception keyword in caml mode.")
(make-variable-buffer-local 'caml-exception-indent)
(defvar caml-for-indent 2
"*How many spaces to indent from a for keyword in caml mode.")
(make-variable-buffer-local 'caml-for-indent)
(defvar caml-fun-indent 2
"*How many spaces to indent from a fun keyword in caml mode.")
(make-variable-buffer-local 'caml-fun-indent)
(defvar caml-function-indent 4
"*How many spaces to indent from a function keyword in caml mode.")
(make-variable-buffer-local 'caml-function-indent)
(defvar caml-if-indent 2
"*How many spaces to indent from a if keyword in caml mode.")
(make-variable-buffer-local 'caml-if-indent)
(defvar caml-if-else-indent 0
"*How many spaces to indent from an if .. else line in caml mode.")
(make-variable-buffer-local 'caml-if-else-indent)
(defvar caml-inherit-indent 2
"*How many spaces to indent from a inherit keyword in caml mode.")
(make-variable-buffer-local 'caml-inherit-indent)
(defvar caml-initializer-indent 2
"*How many spaces to indent from a initializer keyword in caml mode.")
(make-variable-buffer-local 'caml-initializer-indent)
(defvar caml-include-indent 2
"*How many spaces to indent from a include keyword in caml mode.")
(make-variable-buffer-local 'caml-include-indent)
(defvar caml-let-indent 2
"*How many spaces to indent from a let keyword in caml mode.")
(make-variable-buffer-local 'caml-let-indent)
(defvar caml-let-in-indent 0
"*How many spaces to indent from a let .. in keyword in caml mode.")
(make-variable-buffer-local 'caml-let-in-indent)
(defvar caml-match-indent 2
"*How many spaces to indent from a match keyword in caml mode.")
(make-variable-buffer-local 'caml-match-indent)
(defvar caml-method-indent 2
"*How many spaces to indent from a method keyword in caml mode.")
(make-variable-buffer-local 'caml-method-indent)
(defvar caml-module-indent 2
"*How many spaces to indent from a module keyword in caml mode.")
(make-variable-buffer-local 'caml-module-indent)
(defvar caml-object-indent 2
"*How many spaces to indent from a object keyword in caml mode.")
(make-variable-buffer-local 'caml-object-indent)
(defvar caml-of-indent 2
"*How many spaces to indent from a of keyword in caml mode.")
(make-variable-buffer-local 'caml-of-indent)
(defvar caml-parser-indent 4
"*How many spaces to indent from a parser keyword in caml mode.")
(make-variable-buffer-local 'caml-parser-indent)
(defvar caml-sig-indent 2
"*How many spaces to indent from a sig keyword in caml mode.")
(make-variable-buffer-local 'caml-sig-indent)
(defvar caml-struct-indent 2
"*How many spaces to indent from a struct keyword in caml mode.")
(make-variable-buffer-local 'caml-struct-indent)
(defvar caml-try-indent 2
"*How many spaces to indent from a try keyword in caml mode.")
(make-variable-buffer-local 'caml-try-indent)
(defvar caml-type-indent 4
"*How many spaces to indent from a type keyword in caml mode.")
(make-variable-buffer-local 'caml-type-indent)
(defvar caml-val-indent 2
"*How many spaces to indent from a val keyword in caml mode.")
(make-variable-buffer-local 'caml-val-indent)
(defvar caml-while-indent 2
"*How many spaces to indent from a while keyword in caml mode.")
(make-variable-buffer-local 'caml-while-indent)
(defvar caml-::-indent 2
"*How many spaces to indent from a :: operator in caml mode.")
(make-variable-buffer-local 'caml-::-indent)
(defvar caml-@-indent 2
"*How many spaces to indent from a @ operator in caml mode.")
(make-variable-buffer-local 'caml-@-indent)
(defvar caml-:=-indent 2
"*How many spaces to indent from a := operator in caml mode.")
(make-variable-buffer-local 'caml-:=-indent)
(defvar caml-<--indent 2
"*How many spaces to indent from a <- operator in caml mode.")
(make-variable-buffer-local 'caml-<--indent)
(defvar caml-->-indent 2
"*How many spaces to indent from a -> operator in caml mode.")
(make-variable-buffer-local 'caml-->-indent)
(defvar caml-lb-indent 2
"*How many spaces to indent from a \[ operator in caml mode.")
(make-variable-buffer-local 'caml-lb-indent)
(defvar caml-lc-indent 2
"*How many spaces to indent from a \{ operator in caml mode.")
(make-variable-buffer-local 'caml-lc-indent)
(defvar caml-lp-indent 1
"*How many spaces to indent from a \( operator in caml mode.")
(make-variable-buffer-local 'caml-lp-indent)
(defvar caml-and-extra-indent nil
"*Extra indent for caml lines starting with the and keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-and-extra-indent)
(defvar caml-do-extra-indent nil
"*Extra indent for caml lines starting with the do keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-do-extra-indent)
(defvar caml-done-extra-indent nil
"*Extra indent for caml lines starting with the done keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-done-extra-indent)
(defvar caml-else-extra-indent nil
"*Extra indent for caml lines starting with the else keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-else-extra-indent)
(defvar caml-end-extra-indent nil
"*Extra indent for caml lines starting with the end keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-end-extra-indent)
(defvar caml-in-extra-indent nil
"*Extra indent for caml lines starting with the in keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-in-extra-indent)
(defvar caml-then-extra-indent nil
"*Extra indent for caml lines starting with the then keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-then-extra-indent)
(defvar caml-to-extra-indent -1
"*Extra indent for caml lines starting with the to keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-to-extra-indent)
(defvar caml-with-extra-indent nil
"*Extra indent for caml lines starting with the with keyword.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-with-extra-indent)
(defvar caml-comment-indent 3
"*Indent inside comments.")
(make-variable-buffer-local 'caml-comment-indent)
(defvar caml-|-extra-indent -2
"*Extra indent for caml lines starting with the | operator.
Usually negative. nil is align on master.")
(make-variable-buffer-local 'caml-|-extra-indent)
(defvar caml-rb-extra-indent -2
"*Extra indent for caml lines statring with ].
Usually negative. nil is align on master.")
(defvar caml-rc-extra-indent -2
"*Extra indent for caml lines starting with }.
Usually negative. nil is align on master.")
(defvar caml-rp-extra-indent -1
"*Extra indent for caml lines starting with ).
Usually negative. nil is align on master.")
(defvar caml-electric-indent t
"*Non-nil means electrically indent lines starting with |, ] or }.
Many people find eletric keys irritating, so you can disable them if
you are one.")
(defvar caml-electric-close-vector t
"*Non-nil means electrically insert a | before a vector-closing ].
Many people find eletric keys irritating, so you can disable them if
you are one. You should probably have this on, though, if you also
have caml-electric-indent on, which see.")
;;code
(if (or (not (fboundp 'indent-line-to))
(not (fboundp 'buffer-substring-no-properties)))
(require 'caml-compat))
(defvar caml-shell-active nil
"Non nil when a subshell is running.")
(defvar running-xemacs (string-match "XEmacs" emacs-version)
"Non-nil if we are running in the XEmacs environment.")
(defvar caml-mode-map nil
"Keymap used in Caml mode.")
(if caml-mode-map
()
(setq caml-mode-map (make-sparse-keymap))
(define-key caml-mode-map "|" 'caml-electric-pipe)
(define-key caml-mode-map "}" 'caml-electric-pipe)
(define-key caml-mode-map "]" 'caml-electric-rb)
(define-key caml-mode-map "\t" 'caml-indent-command)
(define-key caml-mode-map [backtab] 'caml-unindent-command)
;itz 04-21-96 instead of defining a new function, use defadvice
;that way we get out effect even when we do \C-x` in compilation buffer
; (define-key caml-mode-map "\C-x`" 'caml-next-error)
(if running-xemacs
(define-key caml-mode-map 'backspace 'backward-delete-char-untabify)
(define-key caml-mode-map "\177" 'backward-delete-char-untabify))
;; caml-types
(define-key caml-mode-map [?\C-c?\C-t] 'caml-types-show-type) ; "type"
(define-key caml-mode-map [?\C-c?\C-f] 'caml-types-show-call) ; "function"
(define-key caml-mode-map [?\C-c?\C-l] 'caml-types-show-ident) ; "let"
;; must be a mouse-down event. Can be any button and any prefix
(define-key caml-mode-map [?\C-c down-mouse-1] 'caml-types-explore)
;; caml-help
(define-key caml-mode-map [?\C-c?i] 'ocaml-add-path)
(define-key caml-mode-map [?\C-c?]] 'ocaml-close-module)
(define-key caml-mode-map [?\C-c?[] 'ocaml-open-module)
(define-key caml-mode-map [?\C-c?\C-h] 'caml-help)
(define-key caml-mode-map [?\C-c?\t] 'caml-complete)
;; others
(define-key caml-mode-map "\C-cb" 'caml-insert-begin-form)
(define-key caml-mode-map "\C-cf" 'caml-insert-for-form)
(define-key caml-mode-map "\C-ci" 'caml-insert-if-form)
(define-key caml-mode-map "\C-cl" 'caml-insert-let-form)
(define-key caml-mode-map "\C-cm" 'caml-insert-match-form)
(define-key caml-mode-map "\C-ct" 'caml-insert-try-form)
(define-key caml-mode-map "\C-cw" 'caml-insert-while-form)
(define-key caml-mode-map "\C-c`" 'caml-goto-phrase-error)
(define-key caml-mode-map "\C-c\C-a" 'caml-find-alternate-file)
(define-key caml-mode-map "\C-c\C-c" 'compile)
(define-key caml-mode-map "\C-c\C-e" 'caml-eval-phrase)
(define-key caml-mode-map "\C-c\C-\[" 'caml-backward-to-less-indent)
(define-key caml-mode-map "\C-c\C-\]" 'caml-forward-to-less-indent)
(define-key caml-mode-map "\C-c\C-q" 'caml-indent-phrase)
(define-key caml-mode-map "\C-c\C-r" 'caml-eval-region)
(define-key caml-mode-map "\C-c\C-s" 'caml-show-subshell)
(define-key caml-mode-map "\M-\C-h" 'caml-mark-phrase)
(define-key caml-mode-map "\M-\C-q" 'caml-indent-phrase)
(define-key caml-mode-map "\M-\C-x" 'caml-eval-phrase)
(if running-xemacs nil ; if not running xemacs
(let ((map (make-sparse-keymap "Caml"))
(forms (make-sparse-keymap "Forms")))
(define-key caml-mode-map "\C-c\C-d" 'caml-show-imenu)
(define-key caml-mode-map [menu-bar] (make-sparse-keymap))
(define-key caml-mode-map [menu-bar caml] (cons "Caml" map))
;; caml-help
(define-key map [open] '("Open add path" . ocaml-add-path ))
(define-key map [close]
'("Close module for help" . ocaml-close-module))
(define-key map [open] '("Open module for help" . ocaml-open-module))
(define-key map [help] '("Help for identifier" . caml-help))
(define-key map [complete] '("Complete identifier" . caml-complete))
(define-key map [separator-help] '("---"))
;; caml-types
(define-key map [show-type]
'("Show type at point" . caml-types-show-type ))
(define-key map [separator-types] '("---"))
;; others
(define-key map [camldebug] '("Call debugger..." . camldebug))
(define-key map [run-caml] '("Start subshell..." . run-caml))
(define-key map [compile] '("Compile..." . compile))
(define-key map [switch-view]
'("Switch view" . caml-find-alternate-file))
(define-key map [separator-format] '("--"))
(define-key map [forms] (cons "Forms" forms))
(define-key map [show-imenu] '("Show index" . caml-show-imenu))
(put 'caml-show-imenu 'menu-enable '(not caml-imenu-shown))
(define-key map [show-subshell] '("Show subshell" . caml-show-subshell))
(put 'caml-show-subshell 'menu-enable 'caml-shell-active)
(define-key map [eval-phrase] '("Eval phrase" . caml-eval-phrase))
(put 'caml-eval-phrase 'menu-enable 'caml-shell-active)
(define-key map [indent-phrase] '("Indent phrase" . caml-indent-phrase))
(define-key forms [while]
'("while .. do .. done" . caml-insert-while-form))
(define-key forms [try] '("try .. with .." . caml-insert-try-form))
(define-key forms [match] '("match .. with .." . caml-insert-match-form))
(define-key forms [let] '("let .. in .." . caml-insert-let-form))
(define-key forms [if] '("if .. then .. else .." . caml-insert-if-form))
(define-key forms [begin] '("for .. do .. done" . caml-insert-for-form))
(define-key forms [begin] '("begin .. end" . caml-insert-begin-form)))))
(defvar caml-mode-xemacs-menu
(if running-xemacs
'("Caml"
[ "Indent phrase" caml-indent-phrase :keys "C-M-q" ]
[ "Eval phrase" caml-eval-phrase
:active caml-shell-active :keys "C-M-x" ]
[ "Show subshell" caml-show-subshell caml-shell-active ]
("Forms"
[ "while .. do .. done" caml-insert-while-form t]
[ "try .. with .." caml-insert-try-form t ]
[ "match .. with .." caml-insert-match-form t ]
[ "let .. in .." caml-insert-let-form t ]
[ "if .. then .. else .." caml-insert-if-form t ]
[ "for .. do .. done" caml-insert-for-form t ]
[ "begin .. end" caml-insert-begin-form t ])
"---"
[ "Switch view" caml-find-alternate-file t ]
[ "Compile..." compile t ]
[ "Start subshell..." run-caml t ]
"---"
[ "Show type at point" caml-types-show-type t ]
"---"
[ "Complete identifier" caml-complete t ]
[ "Help for identifier" caml-help t ]
[ "Add path for documentation" ocaml-add-path t ]
[ "Open module for documentation" ocaml-open t ]
[ "Close module for documentation" ocaml-close t ]
))
"Menu to add to the menubar when running Xemacs")
(defvar caml-mode-syntax-table nil
"Syntax table in use in Caml mode buffers.")
(if caml-mode-syntax-table
()
(setq caml-mode-syntax-table (make-syntax-table))
; backslash is an escape sequence
(modify-syntax-entry ?\\ "\\" caml-mode-syntax-table)
; ( is first character of comment start
(modify-syntax-entry ?\( "()1n" caml-mode-syntax-table)
; * is second character of comment start,
; and first character of comment end
(modify-syntax-entry ?* ". 23n" caml-mode-syntax-table)
; ) is last character of comment end
(modify-syntax-entry ?\) ")(4" caml-mode-syntax-table)
; backquote was a string-like delimiter (for character literals)
; (modify-syntax-entry ?` "\"" caml-mode-syntax-table)
; quote and underscore are part of words
(modify-syntax-entry ?' "w" caml-mode-syntax-table)
(modify-syntax-entry ?_ "w" caml-mode-syntax-table)
; ISO-latin accented letters and EUC kanjis are part of words
(let ((i 160))
(while (< i 256)
(modify-syntax-entry i "w" caml-mode-syntax-table)
(setq i (1+ i)))))
(defvar caml-mode-abbrev-table nil
"Abbrev table used for Caml mode buffers.")
(if caml-mode-abbrev-table nil
(setq caml-mode-abbrev-table (make-abbrev-table))
(define-abbrev caml-mode-abbrev-table "and" "and" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "do" "do" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "done" "done" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "else" "else" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "end" "end" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "in" "in" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "then" "then" 'caml-abbrev-hook)
(define-abbrev caml-mode-abbrev-table "with" "with" 'caml-abbrev-hook))
;; Other internal variables
(defvar caml-last-noncomment-pos nil
"Caches last buffer position determined not inside a caml comment.")
(make-variable-buffer-local 'caml-last-noncomment-pos)
;;last-noncomment-pos can be a simple position, because we nil it
;;anyway whenever buffer changes upstream. last-comment-start and -end
;;have to be markers, because we preserve them when the changes' end
;;doesn't overlap with the comment's start.
(defvar caml-last-comment-start nil
"A marker caching last determined caml comment start.")
(make-variable-buffer-local 'caml-last-comment-start)
(defvar caml-last-comment-end nil
"A marker caching last determined caml comment end.")
(make-variable-buffer-local 'caml-last-comment-end)
(make-variable-buffer-local 'before-change-function)
(defvar caml-imenu-shown nil
"True if we have computed definition list.")
(make-variable-buffer-local 'caml-imenu-shown)
(defconst caml-imenu-search-regexp
(concat "\\<in\\>\\|"
"^[ \t]*\\(let\\|class\\|type\\|m\\(odule\\|ethod\\)"
"\\|functor\\|and\\|val\\)[ \t]+"
"\\(\\('[a-zA-Z0-9]+\\|([^)]+)"
"\\|mutable\\|private\\|rec\\|type\\)[ \t]+\\)?"
"\\([a-zA-Z][a-zA-Z0-9_']*\\)"))
;;; The major mode
(eval-when-compile
(if (and (boundp 'running-xemacs) running-xemacs) nil
(require 'imenu)))
;;
(defvar caml-mode-hook nil
"Hook for caml-mode")
(defun caml-mode ()
"Major mode for editing Caml code.
\\{caml-mode-map}"
(interactive)
(kill-all-local-variables)
(setq major-mode 'caml-mode)
(setq mode-name "caml")
(use-local-map caml-mode-map)
(set-syntax-table caml-mode-syntax-table)
(setq local-abbrev-table caml-mode-abbrev-table)
(make-local-variable 'paragraph-start)
(setq paragraph-start (concat "^$\\|" page-delimiter))
(make-local-variable 'paragraph-separate)
(setq paragraph-separate paragraph-start)
(make-local-variable 'paragraph-ignore-fill-prefix)
(setq paragraph-ignore-fill-prefix t)
(make-local-variable 'require-final-newline)
(setq require-final-newline t)
(make-local-variable 'comment-start)
(setq comment-start "(*")
(make-local-variable 'comment-end)
(setq comment-end "*)")
(make-local-variable 'comment-column)
(setq comment-column 40)
(make-local-variable 'comment-start-skip)
(setq comment-start-skip "(\\*+ *")
(make-local-variable 'parse-sexp-ignore-comments)
(setq parse-sexp-ignore-comments nil)
(make-local-variable 'indent-line-function)
(setq indent-line-function 'caml-indent-command)
;itz Fri Sep 25 13:23:49 PDT 1998
(make-local-variable 'add-log-current-defun-function)
(setq add-log-current-defun-function 'caml-current-defun)
;itz 03-25-96
(setq before-change-function 'caml-before-change-function)
(setq caml-last-noncomment-pos nil)
(setq caml-last-comment-start (make-marker))
(setq caml-last-comment-end (make-marker))
;garrigue 27-11-96
(setq case-fold-search nil)
;garrigue july 97
(if running-xemacs ; from Xemacs lisp mode
(if (and (featurep 'menubar)
current-menubar)
(progn
;; make a local copy of the menubar, so our modes don't
;; change the global menubar
(set-buffer-menubar current-menubar)
(add-submenu nil caml-mode-xemacs-menu)))
;imenu support (not for Xemacs)
(make-local-variable 'imenu-create-index-function)
(setq imenu-create-index-function 'caml-create-index-function)
(make-local-variable 'imenu-generic-expression)
(setq imenu-generic-expression caml-imenu-search-regexp)
(if (and caml-imenu-enable (< (buffer-size) 10000))
(caml-show-imenu)))
(run-hooks 'caml-mode-hook))
(defun caml-set-compile-command ()
"Hook to set compile-command locally, unless there is a Makefile or
a _build directory or a _tags file in the current directory."
(interactive)
(unless (or (null buffer-file-name)
(file-exists-p "makefile")
(file-exists-p "Makefile")
(file-exists-p "_build")
(file-exists-p "_tags"))
(let* ((filename (file-name-nondirectory buffer-file-name))
(basename (file-name-sans-extension filename))
(command nil))
(cond
((string-match ".*\\.mli\$" filename)
(setq command "ocamlc -c"))
((string-match ".*\\.ml\$" filename)
(setq command "ocamlc -c") ; (concat "ocamlc -o " basename)
)
((string-match ".*\\.mll\$" filename)
(setq command "ocamllex"))
((string-match ".*\\.mll\$" filename)
(setq command "ocamlyacc"))
)
(if command
(progn
(make-local-variable 'compile-command)
(setq compile-command (concat command " " filename))))
)))
(add-hook 'caml-mode-hook 'caml-set-compile-command)
;;; Auxiliary function. Garrigue 96-11-01.
(defun caml-find-alternate-file ()
(interactive)
(let ((name (buffer-file-name)))
(if (string-match "^\\(.*\\)\\.\\(ml\\|mli\\)$" name)
(find-file
(concat
(caml-match-string 1 name)
(if (string= "ml" (caml-match-string 2 name)) ".mli" ".ml"))))))
;;; subshell support
(defun caml-eval-region (start end)
"Send the current region to the inferior Caml process."
(interactive"r")
(require 'inf-caml)
(inferior-caml-eval-region start end))
;; old version ---to be deleted later
;
; (defun caml-eval-phrase ()
; "Send the current Caml phrase to the inferior Caml process."
; (interactive)
; (save-excursion
; (let ((bounds (caml-mark-phrase)))
; (inferior-caml-eval-region (car bounds) (cdr bounds)))))
(defun caml-eval-phrase (arg &optional min max)
"Send the phrase containing the point to the CAML process.
With prefix-arg send as many phrases as its numeric value,
If an error occurs during evalutaion, stop at this phrase and
repport the error.
Return nil if noerror and position of error if any.
If arg's numeric value is zero or negative, evaluate the current phrase
or as many as prefix arg, ignoring evaluation errors.
This allows to jump other erroneous phrases.
Optional arguments min max defines a region within which the phrase
should lies."
(interactive "p")
(require 'inf-caml)
(inferior-caml-eval-phrase arg min max))
(defun caml-eval-buffer (arg)
"Evaluate the buffer from the beginning to the phrase under the point.
With prefix arg, evaluate past the whole buffer, no stopping at
the current point."
(interactive "p")
(let ((here (point)) err)
(goto-char (point-min))
(setq err
(caml-eval-phrase 500 (point-min) (if arg (point-max) here)))
(if err (set-mark err))
(goto-char here)))
(defun caml-show-subshell ()
(interactive)
(require 'inf-caml)
(inferior-caml-show-subshell))
;;; Imenu support
(defun caml-show-imenu ()
(interactive)
(require 'imenu)
(switch-to-buffer (current-buffer))
(imenu-add-to-menubar "Defs")
(setq caml-imenu-shown t))
(defun caml-prev-index-position-function ()
(let (found data)
(while (and (setq found
(re-search-backward caml-imenu-search-regexp nil 'move))
(progn (setq data (match-data)) t)
(or (caml-in-literal-p)
(caml-in-comment-p)
(if (looking-at "in") (caml-find-in-match)))))
(set-match-data data)
found))
(defun caml-create-index-function ()
(let (value-alist
type-alist
class-alist
method-alist
module-alist
and-alist
all-alist
menu-alist
(prev-pos (point-max))
index)
(goto-char prev-pos)
(imenu-progress-message prev-pos 0 t)
;; collect definitions
(while (caml-prev-index-position-function)
(setq index (cons (caml-match-string 5) (point)))
(imenu-progress-message prev-pos nil t)
(setq all-alist (cons index all-alist))
(cond
((looking-at "[ \t]*and")
(setq and-alist (cons index and-alist)))
((looking-at "[ \t]*let")
(setq value-alist (cons index (append and-alist value-alist)))
(setq and-alist nil))
((looking-at "[ \t]*type")
(setq type-alist (cons index (append and-alist type-alist)))
(setq and-alist nil))
((looking-at "[ \t]*class")
(setq class-alist (cons index (append and-alist class-alist)))
(setq and-alist nil))
((looking-at "[ \t]*val")
(setq value-alist (cons index value-alist)))
((looking-at "[ \t]*\\(module\\|functor\\)")
(setq module-alist (cons index module-alist)))
((looking-at "[ \t]*method")
(setq method-alist (cons index method-alist)))))
;; build menu
(mapcar
'(lambda (pair)
(if (symbol-value (cdr pair))
(setq menu-alist
(cons
(cons (car pair)
(sort (symbol-value (cdr pair)) 'imenu--sort-by-name))
menu-alist))))
'(("Values" . value-alist)
("Types" . type-alist)
("Modules" . module-alist)
("Methods" . method-alist)
("Classes" . class-alist)))
(if all-alist (setq menu-alist (cons (cons "Index" all-alist) menu-alist)))
(imenu-progress-message prev-pos 100 t)
menu-alist))
;;; Indentation stuff
(defun caml-in-indentation ()
"Tests whether all characters between beginning of line and point
are blanks."
(save-excursion
(skip-chars-backward " \t")
(bolp)))
;;; The command
;;; Sorry, I didn't like the previous behaviour... Garrigue 96/11/01
(defun caml-indent-command (&optional p)
"Indent the current line in Caml mode.
Compute new indentation based on caml syntax. If prefixed, indent
the line all the way to where point is."
(interactive "*p")
(cond
((and p (> p 1)) (indent-line-to (current-column)))
((caml-in-indentation) (indent-line-to (caml-compute-final-indent)))
(t (save-excursion
(indent-line-to
(caml-compute-final-indent))))))
(defun caml-unindent-command ()
"Decrease indentation by one level in Caml mode.
Works only if the point is at the beginning of an indented line
\(i.e. all characters between beginning of line and point are
blanks\). Does nothing otherwise. The unindent size is given by the
variable caml-mode-indentation."
(interactive "*")
(let* ((begline
(save-excursion
(beginning-of-line)
(point)))
(current-offset
(- (point) begline)))
(if (and (>= current-offset caml-mode-indentation)
(caml-in-indentation))
(backward-delete-char-untabify caml-mode-indentation))))
;;;
;;; Error processing
;;;
;; Error positions are given in bytes, not in characters
;; This function switches to monobyte mode
(if (not (fboundp 'char-bytes))
(defalias 'forward-byte 'forward-char)
(defun caml-char-bytes (ch)
(let ((l (char-bytes ch)))
(if (> l 1) (- l 1) l)))
(defun forward-byte (count)
(if (> count 0)
(while (> count 0)
(let ((char (char-after)))
(if (null char)
(setq count 0)
(setq count (- count (caml-char-bytes (char-after))))
(forward-char))))
(while (< count 0)
(let ((char (char-after)))
(if (null char)
(setq count 0)
(setq count (+ count (caml-char-bytes (char-before))))
(backward-char))))
)))
(require 'compile)
;; In Emacs 19, the regexps in compilation-error-regexp-alist do not
;; match the error messages when the language is not English.
;; Hence we add a regexp.
(defconst caml-error-regexp
"^[ A-\377]+ \"\\([^\"\n]+\\)\", [A-\377]+ \\([0-9]+\\)[-,:]"
"Regular expression matching the error messages produced by camlc.")
(if (boundp 'compilation-error-regexp-alist)
(or (assoc caml-error-regexp
compilation-error-regexp-alist)
(setq compilation-error-regexp-alist
(cons (list caml-error-regexp 1 2)
compilation-error-regexp-alist))))
;; A regexp to extract the range info
(defconst caml-error-chars-regexp
".*, .*, [A-\377]+ \\([0-9]+\\)-\\([0-9]+\\):?"
"Regular expression extracting the character numbers
from an error message produced by camlc.")
;; Wrapper around next-error.
(defvar caml-error-overlay nil)
(defvar caml-next-error-skip-warnings-flag nil)
(if (fboundp 'string-to-number)
(defalias 'caml-string-to-int 'string-to-number)
(defalias 'caml-string-to-int 'string-to-int))
;;itz 04-21-96 somebody didn't get the documentation for next-error
;;right. When the optional argument is a number n, it should move
;;forward n errors, not reparse.
;itz 04-21-96 instead of defining a new function, use defadvice
;that way we get our effect even when we do \C-x` in compilation buffer
(defadvice next-error (after caml-next-error activate)
"Reads the extra positional information provided by the Caml compiler.
Puts the point and the mark exactly around the erroneous program
fragment. The erroneous fragment is also temporarily highlighted if
possible."
(if (eq major-mode 'caml-mode)
(let (skip bol beg end)
(save-excursion
(set-buffer
(if (boundp 'compilation-last-buffer)
compilation-last-buffer ;Emacs 19
"*compilation*")) ;Emacs 18
(save-excursion
(goto-char (window-point (get-buffer-window (current-buffer))))
(if (looking-at caml-error-chars-regexp)
(setq beg
(caml-string-to-int
(buffer-substring (match-beginning 1) (match-end 1)))
end
(caml-string-to-int
(buffer-substring (match-beginning 2) (match-end 2)))))
(next-line)
(beginning-of-line)
(if (and (looking-at "Warning")
caml-next-error-skip-warnings-flag)
(setq skip 't))))
(cond
(skip (next-error))
(beg
(setq end (- end beg))
(beginning-of-line)
(forward-byte beg)
(setq beg (point))
(forward-byte end)
(setq end (point))
(goto-char beg)
(push-mark end t)
(cond ((fboundp 'make-overlay)
(if caml-error-overlay ()
(setq caml-error-overlay (make-overlay 1 1))
(overlay-put caml-error-overlay 'face 'region))
(unwind-protect
(progn
(move-overlay caml-error-overlay
beg end (current-buffer))
(sit-for 60))
(delete-overlay caml-error-overlay)))))))))
(defun caml-next-error-skip-warnings (&rest args)
(let ((old-flag caml-next-error-skip-warnings-flag))
(unwind-protect
(progn (setq caml-next-error-skip-warnings-flag 't)
(apply 'next-error args))
(setq caml-next-error-skip-warnings-flag old-flag))))
;; Usual match-string doesn't work properly with font-lock-mode
;; on some emacs.
(defun caml-match-string (num &optional string)
"Return string of text matched by last search, without properties.
NUM specifies which parenthesized expression in the last regexp.
Value is nil if NUMth pair didn't match, or there were less than NUM
pairs. Zero means the entire text matched by the whole regexp or
whole string."
(let* ((data (match-data))
(begin (nth (* 2 num) data))
(end (nth (1+ (* 2 num)) data)))
(if string (substring string begin end)
(buffer-substring-no-properties begin end))))
;; itz Thu Sep 24 19:02:42 PDT 1998 this is to have some level of
;; comfort when sending phrases to the toplevel and getting errors.
(defun caml-goto-phrase-error ()
"Find the error location in current Caml phrase."
(interactive)
(require 'inf-caml)
(let ((bounds (save-excursion (caml-mark-phrase))))
(inferior-caml-goto-error (car bounds) (cdr bounds))))
;;; Phrases
;itz the heuristics used to see if we're `between two phrases'
;didn't seem right to me.
(defconst caml-phrase-start-keywords
(concat "\\<\\(class\\|ex\\(ternal\\|ception\\)\\|functor"
"\\|let\\|module\\|open\\|type\\|val\\)\\>")
"Keywords starting phrases in files")
;; a phrase starts when a toplevel keyword is at the beginning of a line
(defun caml-at-phrase-start-p ()
(and (bolp)
(or (looking-at "#")
(looking-at caml-phrase-start-keywords))))
(defun caml-skip-comments-forward ()
(skip-chars-forward " \n\t")
(while (or (looking-at comment-start-skip) (caml-in-comment-p))
(if (= (following-char) ?\)) (forward-char)
(search-forward comment-end))
(skip-chars-forward " \n\t")))
(defun caml-skip-comments-backward ()
(skip-chars-backward " \n\t")
(while (and (eq (preceding-char) ?\)) (eq (char-after (- (point) 2)) ?*))
(backward-char)
(while (caml-in-comment-p) (search-backward comment-start))
(skip-chars-backward " \n\t")))
(defconst caml-phrase-sep-keywords (concat ";;\\|" caml-phrase-start-keywords))
(defun caml-find-phrase (&optional min-pos max-pos)
"Find the CAML phrase containing the point.
Return the position of the beginning of the phrase, and move point
to the end.
"
(interactive)
(if (not min-pos) (setq min-pos (point-min)))
(if (not max-pos) (setq max-pos (point-max)))
(let (beg end use-semi kwop)
;(caml-skip-comments-backward)
(cond
; shall we have special processing for semicolons?
;((and (eq (char-before (- (point) 1)) ?\;) (eq (char-before) ?\;))
; (forward-char)
; (caml-skip-comments-forward)
; (setq beg (point))
; (while (and (search-forward ";;" max-pos 'move)
; (or (caml-in-comment-p) (caml-in-literal-p)))))
(t
(caml-skip-comments-forward)
(if (caml-at-phrase-start-p) (forward-char))
(while (and (cond
((re-search-forward caml-phrase-sep-keywords max-pos 'move)
(goto-char (match-beginning 0)) t))
(or (not (or (bolp) (looking-at ";;")))
(caml-in-comment-p)
(caml-in-literal-p)))
(forward-char))
(setq end (+ (point) (if (looking-at ";;") 2 0)))
(while (and
(setq kwop (caml-find-kwop caml-phrase-sep-keywords min-pos))
(not (string= kwop ";;"))
(not (bolp))))
(if (string= kwop ";;") (forward-char 2))
(if (not kwop) (goto-char min-pos))
(caml-skip-comments-forward)
(setq beg (point))
(if (>= beg end) (error "no phrase before point"))
(goto-char end)))
(caml-skip-comments-forward)
beg))
(defun caml-mark-phrase (&optional min-pos max-pos)
"Put mark at end of this Caml phrase, point at beginning.
"
(interactive)
(let* ((beg (caml-find-phrase min-pos max-pos)) (end (point)))
(push-mark)
(goto-char beg)
(cons beg end)))
;;itz Fri Sep 25 12:58:13 PDT 1998 support for adding change-log entries
(defun caml-current-defun ()
(save-excursion
(caml-mark-phrase)
(if (not (looking-at caml-phrase-start-keywords)) nil
(re-search-forward caml-phrase-start-keywords)
(let ((done nil))
(while (not done)
(cond
((looking-at "\\s ")
(skip-syntax-forward " "))
((char-equal (following-char) ?\( )
(forward-sexp 1))
((char-equal (following-char) ?')
(skip-syntax-forward "w_"))
(t (setq done t)))))
(re-search-forward "\\(\\sw\\|\\s_\\)+")
(match-string 0))))
(defun caml-overlap (b1 e1 b2 e2)
(<= (max b1 b2) (min e1 e2)))
;this clears the last comment cache if necessary
(defun caml-before-change-function (begin end)
(if (and caml-last-noncomment-pos
(> caml-last-noncomment-pos begin))
(setq caml-last-noncomment-pos nil))
(if (and (marker-position caml-last-comment-start)
(marker-position caml-last-comment-end)
(caml-overlap begin end
caml-last-comment-start
caml-last-comment-end))
(prog2
(set-marker caml-last-comment-start nil)
(set-marker caml-last-comment-end nil)))
(let ((orig-function (default-value 'before-change-function)))
(if orig-function (funcall orig-function begin end))))
(defun caml-in-literal-p ()
"Returns non-nil if point is inside a caml literal."
(let* ((start-literal (concat "[\"" caml-quote-char "]"))
(char-literal
(concat "\\([^\\]\\|\\\\\\.\\|\\\\[0-9][0-9][0-9]\\)"
caml-quote-char))
(pos (point))
(eol (progn (end-of-line 1) (point)))
state in-str)
(beginning-of-line 1)
(while (and (not state)
(re-search-forward start-literal eol t)
(<= (point) pos))
(cond
((string= (caml-match-string 0) "\"")
(setq in-str t)
(while (and in-str (not state)
(re-search-forward "\"\\|\\\\\"" eol t))
(if (> (point) pos) (setq state t))
(if (string= (caml-match-string 0) "\"") (setq in-str nil)))
(if in-str (setq state t)))
((looking-at char-literal)
(if (and (>= pos (match-beginning 0)) (< pos (match-end 0)))
(setq state t)
(goto-char (match-end 0))))))
(goto-char pos)
state))
(defun caml-forward-comment ()
"Skip one (eventually nested) comment."
(let ((count 1) match)
(while (> count 0)
(if (not (re-search-forward "(\\*\\|\\*)" nil 'move))
(setq count -1)
(setq match (caml-match-string 0))
(cond
((caml-in-literal-p)
nil)
((string= match comment-start)
(setq count (1+ count)))
(t
(setq count (1- count))))))
(= count 0)))
(defun caml-backward-comment ()
"Skip one (eventually nested) comment."
(let ((count 1) match)
(while (> count 0)
(if (not (re-search-backward "(\\*\\|\\*)" nil 'move))
(setq count -1)
(setq match (caml-match-string 0))
(cond
((caml-in-literal-p)
nil)
((string= match comment-start)
(setq count (1- count)))
(t
(setq count (1+ count))))))
(= count 0)))
(defun caml-in-comment-p ()
"Returns non-nil if point is inside a caml comment.
Returns nil for the parenthesis openning a comment."
;;we look for comments differently than literals. there are two
;;reasons for this. first, caml has nested comments and it is not so
;;clear that parse-partial-sexp supports them; second, if proper
;;style is used, literals are never split across lines, so we don't
;;have to worry about bogus phrase breaks inside literals, while we
;;have to account for that possibility in comments.
(if caml-last-comment-start
(save-excursion
(let* ((cached-pos caml-last-noncomment-pos)
(cached-begin (marker-position caml-last-comment-start))
(cached-end (marker-position caml-last-comment-end)))
(cond
((and cached-begin cached-end
(< cached-begin (point)) (< (point) cached-end)) t)
((and cached-pos (= cached-pos (point))) nil)
((and cached-pos (> cached-pos (point))
(< (abs (- cached-pos (point))) caml-lookback-limit))
(let (end found (here (point)))
; go back to somewhere sure
(goto-char cached-pos)
(while (> (point) here)
; look for the end of a comment
(while (and (if (search-backward comment-end (1- here) 'move)
(setq end (match-end 0))
(setq end nil))
(caml-in-literal-p)))
(if end (setq found (caml-backward-comment))))
(if (and found (= (point) here)) (setq end nil))
(if (not end)
(setq caml-last-noncomment-pos here)
(set-marker caml-last-comment-start (point))
(set-marker caml-last-comment-end end))
end))
(t
(let (begin found (here (point)))
;; go back to somewhere sure (or far enough)
(goto-char
(if cached-pos cached-pos (- (point) caml-lookback-limit)))
(while (< (point) here)
;; look for the beginning of a comment
(while (and (if (search-forward comment-start (1+ here) 'move)
(setq begin (match-beginning 0))
(setq begin nil))
(caml-in-literal-p)))
(if begin (setq found (caml-forward-comment))))
(if (and found (= (point) here)) (setq begin nil))
(if (not begin)
(setq caml-last-noncomment-pos here)
(set-marker caml-last-comment-start begin)
(set-marker caml-last-comment-end (point)))
begin)))))))
;; Various constants and regexps
(defconst caml-before-expr-prefix
(concat "\\<\\(asr\\|begin\\|class\\|do\\(wnto\\)?\\|else"
"\\|i\\(f\\|n\\(herit\\|itializer\\)?\\)"
"\\|f\\(or\\|un\\(ct\\(ion\\|or\\)\\)?\\)"
"\\|l\\(and\\|or\\|s[lr]\\|xor\\)\\|m\\(atch\\|od\\)"
"\\|o[fr]\\|parser\\|s\\(ig\\|truct\\)\\|t\\(hen\\|o\\|ry\\)"
"\\|w\\(h\\(en\\|ile\\)\\|ith\\)\\)\\>\\|:begin\\>"
"\\|[=<>@^|&+-*/$%][!$%*+-./:<=>?@^|~]*\\|:[:=]\\|[[({,;]")
"Keywords that may appear immediately before an expression.
Used to distinguish it from toplevel let construct.")
(defconst caml-matching-kw-regexp
(concat
"\\<\\(and\\|do\\(ne\\|wnto\\)?\\|e\\(lse\\|nd\\)\\|in\\|t\\(hen\\|o\\)"
"\\|with\\)\\>\\|[^[|]|")
"Regexp used in caml mode for skipping back over nested blocks.")
(defconst caml-matching-kw-alist
'(("|" . caml-find-pipe-match)
(";" . caml-find-semi-match)
("," . caml-find-comma-match)
("end" . caml-find-end-match)
("done" . caml-find-done-match)
("in" . caml-find-in-match)
("with" . caml-find-with-match)
("else" . caml-find-else-match)
("then" . caml-find-then-match)
("to" . caml-find-done-match)
("downto" . caml-find-done-match)
("do" . caml-find-done-match)
("and" . caml-find-and-match))
"Association list used in caml mode for skipping back over nested blocks.")
(defconst caml-kwop-regexps (make-vector 9 nil)
"Array of regexps representing caml keywords of different priorities.")
(defun caml-in-expr-p ()
(let ((pos (point)) (in-expr t))
(caml-find-kwop
(concat caml-before-expr-prefix "\\|"
caml-matching-kw-regexp "\\|"
(aref caml-kwop-regexps caml-max-indent-priority)))
(cond
; special case for ;;
((and (> (point) 1) (= (preceding-char) ?\;) (= (following-char) ?\;))
(setq in-expr nil))
((looking-at caml-before-expr-prefix)
(if (not (looking-at "(\\*")) (goto-char (match-end 0)))
(skip-chars-forward " \t\n")
(while (looking-at "(\\*")
(forward-char)
(caml-forward-comment)
(skip-chars-forward " \t\n"))
(if (<= pos (point)) (setq in-expr nil))))
(goto-char pos)
in-expr))
(defun caml-at-sexp-close-p ()
(or (char-equal ?\) (following-char))
(char-equal ?\] (following-char))
(char-equal ?} (following-char))))
(defun caml-find-kwop (kwop-regexp &optional min-pos)
"Look back for a caml keyword or operator matching KWOP-REGEXP.
Second optional argument MIN-POS bounds the search.
Ignore occurences inside literals. If found, return a list of two
values: the actual text of the keyword or operator, and a boolean
indicating whether the keyword was one we looked for explicitly
{non-nil}, or on the other hand one of the block-terminating
keywords."
(let ((start-literal (concat "[\"" caml-quote-char "]"))
found kwop)
(while (and (> (point) 1) (not found)
(re-search-backward kwop-regexp min-pos 'move))
(setq kwop (caml-match-string 0))
(cond
((looking-at "(\\*")
(if (> (point) 1) (backward-char)))
((caml-in-comment-p)
(search-backward "(" min-pos 'move))
((looking-at start-literal))
((caml-in-literal-p)
(re-search-backward start-literal min-pos 'move)) ;ugly hack
((setq found t))))
(if found
(if (not (string-match "\\`[^|[]|[^]|]?\\'" kwop)) ;arrrrgh!!
kwop
(forward-char 1) "|") nil)))
; Association list of indentation values based on governing keywords.
;
;Each element is of the form (KEYWORD OP-TYPE PRIO INDENT). OP-TYPE is
;non-nil for operator-type nodes, which affect indentation in a
;different way from keywords: subsequent lines are indented to the
;actual occurrence of an operator, but relative to the indentation of
;the line where the governing keyword occurs.
(defconst caml-no-indent 0)
(defconst caml-kwop-alist
'(("begin" nil 6 caml-begin-indent)
(":begin" nil 6 caml-begin-indent) ; hack
("class" nil 0 caml-class-indent)
("constraint" nil 0 caml-val-indent)
("sig" nil 1 caml-sig-indent)
("struct" nil 1 caml-struct-indent)
("exception" nil 0 caml-exception-indent)
("for" nil 6 caml-for-indent)
("fun" nil 3 caml-fun-indent)
("function" nil 3 caml-function-indent)
("if" nil 6 caml-if-indent)
("if-else" nil 6 caml-if-else-indent)
("include" nil 0 caml-include-indent)
("inherit" nil 0 caml-inherit-indent)
("initializer" nil 0 caml-initializer-indent)
("let" nil 6 caml-let-indent)
("let-in" nil 6 caml-let-in-indent)
("match" nil 6 caml-match-indent)
("method" nil 0 caml-method-indent)
("module" nil 0 caml-module-indent)
("object" nil 6 caml-object-indent)
("of" nil 7 caml-of-indent)
("open" nil 0 caml-no-indent)
("parser" nil 3 caml-parser-indent)
("try" nil 6 caml-try-indent)
("type" nil 0 caml-type-indent)
("val" nil 0 caml-val-indent)
("when" nil 2 caml-if-indent)
("while" nil 6 caml-while-indent)
("::" t 5 caml-::-indent)
("@" t 4 caml-@-indent)
("^" t 4 caml-@-indent)
(":=" nil 3 caml-:=-indent)
("<-" nil 3 caml-<--indent)
("->" nil 2 caml-->-indent)
("\[" t 8 caml-lb-indent)
("{" t 8 caml-lc-indent)
("\(" t 8 caml-lp-indent)
("|" nil 2 caml-no-indent)
(";;" nil 0 caml-no-indent))
; if-else and let-in are not keywords but idioms
; "|" is not in the regexps
; all these 3 values correspond to hard-coded names
"Association list of indentation values based on governing keywords.
Each element is of the form (KEYWORD OP-TYPE PRIO INDENT). OP-TYPE is
non-nil for operator-type nodes, which affect indentation in a
different way from keywords: subsequent lines are indented to the
actual occurrence of an operator, but relative to the indentation of
the line where the governing keyword occurs.")
;;Originally, we had caml-kwop-regexp create these at runtime, from an
;;additional field in caml-kwop-alist. That proved way too slow,
;;although I still can't understand why. itz
(aset caml-kwop-regexps 0
(concat
"\\<\\(begin\\|object\\|for\\|s\\(ig\\|truct\\)\\|while\\)\\>"
"\\|:begin\\>\\|[[({]\\|;;"))
(aset caml-kwop-regexps 1
(concat (aref caml-kwop-regexps 0) "\\|\\<\\(class\\|module\\)\\>"))
(aset caml-kwop-regexps 2
(concat
(aref caml-kwop-regexps 1)
"\\|\\<\\(fun\\(ction\\)?\\|initializer\\|let\\|m\\(atch\\|ethod\\)"
"\\|parser\\|try\\|val\\)\\>\\|->"))
(aset caml-kwop-regexps 3
(concat (aref caml-kwop-regexps 2) "\\|\\<if\\|when\\>"))
(aset caml-kwop-regexps 4
(concat (aref caml-kwop-regexps 3) "\\|:=\\|<-"))
(aset caml-kwop-regexps 5
(concat (aref caml-kwop-regexps 4) "\\|@"))
(aset caml-kwop-regexps 6
(concat (aref caml-kwop-regexps 5) "\\|::\\|\\^"))
(aset caml-kwop-regexps 7
(concat
(aref caml-kwop-regexps 0)
"\\|\\<\\(constraint\\|exception\\|in\\(herit\\|clude\\)"
"\\|o\\(f\\|pen\\)\\|type\\|val\\)\\>"))
(aset caml-kwop-regexps 8
(concat (aref caml-kwop-regexps 6)
"\\|\\<\\(constraint\\|exception\\|in\\(herit\\|clude\\)"
"\\|o\\(f\\|pen\\)\\|type\\)\\>"))
(defun caml-find-done-match ()
(let ((unbalanced 1) (kwop t))
(while (and (not (= 0 unbalanced)) kwop)
(setq kwop (caml-find-kwop "\\<\\(done\\|for\\|while\\)\\>"))
(cond
((not kwop))
((string= kwop "done") (setq unbalanced (1+ unbalanced)))
(t (setq unbalanced (1- unbalanced)))))
kwop))
(defun caml-find-end-match ()
(let ((unbalanced 1) (kwop t))
(while (and (not (= 0 unbalanced)) kwop)
(setq kwop
(caml-find-kwop
"\\<\\(end\\|begin\\|object\\|s\\(ig\\|truct\\)\\)\\>\\|:begin\\>\\|;;"))
(cond
((not kwop))
((string= kwop ";;") (setq kwop nil) (forward-line 1))
((string= kwop "end") (setq unbalanced (1+ unbalanced)))
( t (setq unbalanced (1- unbalanced)))))
(if (string= kwop ":begin") "begin"
kwop)))
(defun caml-find-in-match ()
(let ((unbalanced 1) (kwop t))
(while (and (not (= 0 unbalanced)) kwop)
(setq kwop (caml-find-kwop "\\<\\(in\\|let\\|end\\)\\>"))
(cond
((not kwop))
((string= kwop "end") (caml-find-end-match))
((string= kwop "in") (setq unbalanced (1+ unbalanced)))
(t (setq unbalanced (1- unbalanced)))))
kwop))
(defun caml-find-with-match ()
(let ((unbalanced 1) (kwop t))
(while (and (not (= 0 unbalanced)) kwop)
(setq kwop
(caml-find-kwop
"\\<\\(with\\|try\\|m\\(atch\\|odule\\)\\|functor\\)\\>\\|[{}()]"))
(cond
((not kwop))
((caml-at-sexp-close-p)
(caml-find-paren-match (following-char)))
((string= kwop "with")
(setq unbalanced (1+ unbalanced)))
((or (string= kwop "module")
(string= kwop "functor")
(string= kwop "{")
(string= kwop "("))
(setq unbalanced 0))
(t (setq unbalanced (1- unbalanced)))))
kwop))
(defun caml-find-paren-match (close)
(let ((unbalanced 1)
(regexp (cond ((= close ?\)) "[()]")
((= close ?\]) "[][]")
((= close ?\}) "[{}]"))))
(while (and (> unbalanced 0)
(caml-find-kwop regexp))
(if (= close (following-char))
(setq unbalanced (1+ unbalanced))
(setq unbalanced (1- unbalanced))))))
(defun caml-find-then-match (&optional from-else)
(let ((bol (if from-else
(save-excursion
(progn (beginning-of-line) (point)))))
kwop done matching-fun)
(while (not done)
(setq kwop
(caml-find-kwop
"\\<\\(e\\(nd\\|lse\\)\\|done\\|then\\|if\\|with\\)\\>\\|[])};]"))
(cond
((not kwop) (setq done t))
((caml-at-sexp-close-p)
(caml-find-paren-match (following-char)))
((string= kwop "if") (setq done t))
((string= kwop "then")
(if (not from-else) (setq kwop (caml-find-then-match))))
((setq matching-fun (cdr-safe (assoc kwop caml-matching-kw-alist)))
(setq kwop (funcall matching-fun)))))
(if (and bol (>= (point) bol))
"if-else"
kwop)))
(defun caml-find-pipe-match ()
(let ((done nil) (kwop)
(re (concat
"\\<\\(try\\|match\\|with\\|function\\|parser\\|type"
"\\|e\\(nd\\|lse\\)\\|done\\|then\\|in\\)\\>"
"\\|[^[|]|\\|[])}]")))
(while (not done)
(setq kwop (caml-find-kwop re))
(cond
((not kwop) (setq done t))
((looking-at "[^[|]\\(|\\)")
(goto-char (match-beginning 1))
(setq kwop "|")
(setq done t))
((caml-at-sexp-close-p)
(caml-find-paren-match (following-char)))
((string= kwop "with")
(setq kwop (caml-find-with-match))
(setq done t))
((string= kwop "parser")
(if (re-search-backward "\\<with\\>" (- (point) 5) t)
(setq kwop (caml-find-with-match)))
(setq done t))
((string= kwop "done") (caml-find-done-match))
((string= kwop "end") (caml-find-end-match))
((string= kwop "then") (caml-find-then-match))
((string= kwop "else") (caml-find-else-match))
((string= kwop "in") (caml-find-in-match))
(t (setq done t))))
kwop))
(defun caml-find-and-match ()
(let ((done nil) (kwop))
(while (not done)
(setq kwop (caml-find-kwop
"\\<\\(object\\|exception\\|let\\|type\\|end\\|in\\)\\>"))
(cond
((not kwop) (setq done t))
((string= kwop "end") (caml-find-end-match))
((string= kwop "in") (caml-find-in-match))
(t (setq done t))))
kwop))
(defun caml-find-else-match ()
(caml-find-then-match t))
(defun caml-find-semi-match ()
(caml-find-kwop-skipping-blocks 2))
(defun caml-find-comma-match ()
(caml-find-kwop-skipping-blocks 3))
(defun caml-find-kwop-skipping-blocks (prio)
"Look back for a caml keyword matching caml-kwop-regexps [PRIO].
Skip nested blocks."
(let ((done nil) (kwop nil) (matching-fun)
(kwop-list (aref caml-kwop-regexps prio)))
(while (not done)
(setq kwop (caml-find-kwop
(concat caml-matching-kw-regexp
(cond ((> prio 3) "\\|[])},;]\\|")
((> prio 2) "\\|[])};]\\|")
(t "\\|[])}]\\|"))
kwop-list)))
(cond
((not kwop) (setq done t))
((caml-at-sexp-close-p)
(caml-find-paren-match (following-char)))
((or (string= kwop ";;")
(and (string= kwop ";") (= (preceding-char) ?\;)))
(forward-line 1)
(setq kwop ";;")
(setq done t))
((and (>= prio 2) (string= kwop "|")) (setq done t))
((string= kwop "end") (caml-find-end-match))
((string= kwop "done") (caml-find-done-match))
((string= kwop "in")
(cond ((and (caml-find-in-match) (>= prio 2))
(setq kwop "let-in")
(setq done t))))
((and (string= kwop "parser") (>= prio 2)
(re-search-backward "\\<with\\>" (- (point) 5) t))
(setq kwop (caml-find-with-match))
(setq done t))
((setq matching-fun (cdr-safe (assoc kwop caml-matching-kw-alist)))
(setq kwop (funcall matching-fun))
(if (looking-at kwop-list) (setq done t)))
(t (let* ((kwop-info (assoc kwop caml-kwop-alist))
(is-op (and (nth 1 kwop-info)
; check that we are not at beginning of line
(let ((pos (point)) bti)
(back-to-indentation)
(setq bti (point))
(goto-char pos)
(< bti pos)))))
(if (and is-op (looking-at
(concat (regexp-quote kwop)
"|?[ \t]*\\(\n\\|(\\*\\)")))
(setq kwop-list
(aref caml-kwop-regexps (nth 2 kwop-info)))
(setq done t))))))
kwop))
(defun caml-compute-basic-indent (prio)
"Compute indent of current caml line, ignoring leading keywords.
Find the `governing node' for current line. Compute desired
indentation based on the node and the indentation alists.
Assumes point is exactly at line indentation.
Does not preserve point."
(let* (in-expr
(kwop (cond
((looking-at ";;")
(beginning-of-line 1))
((looking-at "|\\([^]|]\\|\\'\\)")
(caml-find-pipe-match))
((and (looking-at caml-phrase-start-keywords)
(caml-in-expr-p))
(caml-find-end-match))
((and (looking-at caml-matching-kw-regexp)
(assoc (caml-match-string 0) caml-matching-kw-alist))
(funcall (cdr-safe (assoc (caml-match-string 0)
caml-matching-kw-alist))))
((looking-at
(aref caml-kwop-regexps caml-max-indent-priority))
(let* ((kwop (caml-match-string 0))
(kwop-info (assoc kwop caml-kwop-alist))
(prio (if kwop-info (nth 2 kwop-info)
caml-max-indent-priority)))
(if (and (looking-at (aref caml-kwop-regexps 0))
(not (looking-at "object"))
(caml-in-expr-p))
(setq in-expr t))
(caml-find-kwop-skipping-blocks prio)))
(t
(if (and (= prio caml-max-indent-priority) (caml-in-expr-p))
(setq in-expr t))
(caml-find-kwop-skipping-blocks prio))))
(kwop-info (assoc kwop caml-kwop-alist))
(indent-diff
(cond
((not kwop-info) (beginning-of-line 1) 0)
((looking-at "[[({][|<]?[ \t]*")
(length (caml-match-string 0)))
((nth 1 kwop-info) (symbol-value (nth 3 kwop-info)))
(t
(let ((pos (point)))
(back-to-indentation)
; (if (looking-at "\\<let\\>") (goto-char pos))
(- (symbol-value (nth 3 kwop-info))
(if (looking-at "|") caml-|-extra-indent 0))))))
(extra (if in-expr caml-apply-extra-indent 0)))
(+ indent-diff extra (current-column))))
(defconst caml-leading-kwops-regexp
(concat
"\\<\\(and\\|do\\(ne\\|wnto\\)?\\|e\\(lse\\|nd\\)\\|in"
"\\|t\\(hen\\|o\\)\\|with\\)\\>\\|[]|})]")
"Regexp matching caml keywords which need special indentation.")
(defconst caml-leading-kwops-alist
'(("and" caml-and-extra-indent 2)
("do" caml-do-extra-indent 0)
("done" caml-done-extra-indent 0)
("else" caml-else-extra-indent 3)
("end" caml-end-extra-indent 0)
("in" caml-in-extra-indent 2)
("then" caml-then-extra-indent 3)
("to" caml-to-extra-indent 0)
("downto" caml-to-extra-indent 0)
("with" caml-with-extra-indent 2)
("|" caml-|-extra-indent 2)
("]" caml-rb-extra-indent 0)
("}" caml-rc-extra-indent 0)
(")" caml-rp-extra-indent 0))
"Association list of special caml keyword indent values.
Each member is of the form (KEYWORD EXTRA-INDENT PRIO) where
EXTRA-INDENT is the variable holding extra indentation amount for
KEYWORD (usually negative) and PRIO is upper bound on priority of
matching nodes to determine KEYWORD's final indentation.")
(defun caml-compute-final-indent ()
(save-excursion
(back-to-indentation)
(cond
((and (bolp) (looking-at comment-start-skip)) (current-column))
((caml-in-comment-p)
(let ((closing (looking-at "\\*)"))
(comment-mark (looking-at "\\*")))
(caml-backward-comment)
(looking-at comment-start-skip)
(+ (current-column)
(cond
(closing 1)
(comment-mark 1)
(t (- (match-end 0) (match-beginning 0)))))))
(t (let* ((leading (looking-at caml-leading-kwops-regexp))
(assoc-val (if leading (assoc (caml-match-string 0)
caml-leading-kwops-alist)))
(extra (if leading (symbol-value (nth 1 assoc-val)) 0))
(prio (if leading (nth 2 assoc-val)
caml-max-indent-priority))
(basic (caml-compute-basic-indent prio)))
(max 0 (if extra (+ extra basic) (current-column))))))))
(defun caml-split-string ()
"Called whenever a line is broken inside a caml string literal."
(insert-before-markers "\"^\"")
(backward-char 1))
(defadvice indent-new-comment-line (around
caml-indent-new-comment-line
activate)
"Handle multi-line strings in caml mode."
;this advice doesn't make sense in other modes. I wish there were a
;cleaner way to do this: I haven't found one.
(let ((hooked (and (eq major-mode 'caml-mode) (caml-in-literal-p)))
(split-mark))
(if (not hooked) nil
(setq split-mark (set-marker (make-marker) (point)))
(caml-split-string))
ad-do-it
(if (not hooked) nil
(goto-char split-mark)
(set-marker split-mark nil))))
(defadvice newline-and-indent (around
caml-newline-and-indent
activate)
"Handle multi-line strings in caml mode."
(let ((hooked (and (eq major-mode 'caml-mode) (caml-in-literal-p)))
(split-mark))
(if (not hooked) nil
(setq split-mark (set-marker (make-marker) (point)))
(caml-split-string))
ad-do-it
(if (not hooked) nil
(goto-char split-mark)
(set-marker split-mark nil))))
(defun caml-electric-pipe ()
"If inserting a | or } operator at beginning of line, reindent the line.
Unfortunately there is a situation where this mechanism gets
confused. It's when | is the first character of a |] sequence. This is
a misfeature of caml syntax and cannot be fixed, however, as a
workaround, the electric ] inserts | itself if the matching [ is
followed by |."
(interactive "*")
(let ((electric (and caml-electric-indent
(caml-in-indentation)
(not (caml-in-comment-p)))))
(self-insert-command 1)
(if electric (save-excursion (caml-indent-command)))))
(defun caml-electric-rb ()
"If inserting a ] operator at beginning of line, reindent the line.
Also, if the matching [ is followed by a | and this ] is not preceded
by |, insert one."
(interactive "*")
(let* ((prec (preceding-char))
(use-pipe (and caml-electric-close-vector
(not (caml-in-comment-p))
(not (caml-in-literal-p))
(or (not (numberp prec))
(not (char-equal ?| prec)))))
(electric (and caml-electric-indent
(caml-in-indentation)
(not (caml-in-comment-p)))))
(self-insert-command 1)
(if electric (save-excursion (caml-indent-command)))
(if (and use-pipe
(save-excursion
(condition-case nil
(prog2
(backward-list 1)
(looking-at "\\[|"))
(error ""))))
(save-excursion
(backward-char 1)
(insert "|")))))
(defun caml-abbrev-hook ()
"If inserting a leading keyword at beginning of line, reindent the line."
;itz unfortunately we need a special case
(if (and (not (caml-in-comment-p)) (not (= last-command-char ?_)))
(let* ((bol (save-excursion (beginning-of-line) (point)))
(kw (save-excursion
(and (re-search-backward "^[ \t]*\\(\\sw+\\)\\=" bol t)
(caml-match-string 1)))))
(if kw
(let ((indent (save-excursion
(goto-char (match-beginning 1))
(caml-indent-command)
(current-column)))
(abbrev-correct (if (= last-command-char ?\ ) 1 0)))
(indent-to (- indent
(or
(symbol-value
(nth 1
(assoc kw caml-leading-kwops-alist)))
0)
abbrev-correct)))))))
; (defun caml-indent-phrase ()
; (interactive "*")
; (let ((bounds (caml-mark-phrase)))
; (indent-region (car bounds) (cdr bounds) nil)))
;;; Additional commands by Didier to report errors in toplevel mode
(defun caml-skip-blank-forward ()
(if (looking-at "[ \t\n]*\\((\\*\\([^*]\\|[^(]\\*[^)]\\)*\\*)[ \t\n]*\\)*")
(goto-char (match-end 0))))
;; to mark phrases, so that repeated calls will take several of them
;; knows little about Ocaml appart literals and comments, so it should work
;; with other dialects as long as ;; marks the end of phrase.
(defun caml-indent-phrase (arg)
"Indent current phrase
with prefix arg, indent that many phrases starting with the current phrase."
(interactive "p")
(save-excursion
(let ((beg (caml-find-phrase)))
(while (progn (setq arg (- arg 1)) (> arg 0)) (caml-find-phrase))
(indent-region beg (point) nil))))
(defun caml-indent-buffer ()
(interactive)
(indent-region (point-min) (point-max) nil))
(defun caml-backward-to-less-indent (&optional n)
"Move cursor back N lines with less or same indentation."
(interactive "p")
(beginning-of-line 1)
(if (< n 0) (caml-forward-to-less-indent (- n))
(while (> n 0)
(let ((i (current-indentation)))
(forward-line -1)
(while (or (> (current-indentation) i)
(caml-in-comment-p)
(looking-at
(concat "[ \t]*\\(\n\\|" comment-start-skip "\\)")))
(forward-line -1)))
(setq n (1- n))))
(back-to-indentation))
(defun caml-forward-to-less-indent (&optional n)
"Move cursor back N lines with less or same indentation."
(interactive "p")
(beginning-of-line 1)
(if (< n 0) (caml-backward-to-less-indent (- n))
(while (> n 0)
(let ((i (current-indentation)))
(forward-line 1)
(while (or (> (current-indentation) i)
(caml-in-comment-p)
(looking-at
(concat "[ \t]*\\(\n\\|" comment-start-skip "\\)")))
(forward-line 1)))
(setq n (1- n))))
(back-to-indentation))
(defun caml-insert-begin-form ()
"Inserts a nicely formatted begin-end form, leaving a mark after end."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)) (i (+ caml-begin-indent c)))
(insert "begin\n\nend")
(push-mark)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)))
(defun caml-insert-for-form ()
"Inserts a nicely formatted for-do-done form, leaving a mark after do(ne)."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)) (i (+ caml-for-indent c)))
(insert "for do\n\ndone")
(push-mark)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)
(push-mark)
(beginning-of-line 1)
(backward-char 4)))
(defun caml-insert-if-form ()
"Insert nicely formatted if-then-else form leaving mark after then, else."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)) (i (+ caml-if-indent c)))
(insert "if\n\nthen\n\nelse\n")
(indent-line-to i)
(push-mark)
(forward-line -1)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)
(push-mark)
(forward-line -1)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)))
(defun caml-insert-match-form ()
"Insert nicely formatted match-with form leaving mark after with."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)) (i (+ caml-match-indent c)))
(insert "match\n\nwith\n")
(indent-line-to i)
(push-mark)
(forward-line -1)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)))
(defun caml-insert-let-form ()
"Insert nicely formatted let-in form leaving mark after in."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)))
(insert "let in\n")
(indent-line-to c)
(push-mark)
(forward-line -1)
(forward-char (+ c 4))))
(defun caml-insert-try-form ()
"Insert nicely formatted try-with form leaving mark after with."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)) (i (+ caml-try-indent c)))
(insert "try\n\nwith\n")
(indent-line-to i)
(push-mark)
(forward-line -1)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)))
(defun caml-insert-while-form ()
"Insert nicely formatted while-do-done form leaving mark after do, done."
(interactive "*")
(let ((prec (preceding-char)))
(if (and (numberp prec) (not (char-equal ?\ (char-syntax prec))))
(insert " ")))
(let* ((c (current-indentation)) (i (+ caml-if-indent c)))
(insert "while do\n\ndone")
(push-mark)
(indent-line-to c)
(forward-line -1)
(indent-line-to i)
(push-mark)
(beginning-of-line 1)
(backward-char 4)))
(autoload 'run-caml "inf-caml" "Run an inferior Caml process." t)
(autoload 'caml-types-show-type "caml-types"
"Show the type of expression or pattern at point." t)
(autoload 'caml-types-explore "caml-types"
"Explore type annotations by mouse dragging." t)
(autoload 'caml-help "caml-help"
"Show documentation for qualilifed OCaml identifier." t)
(autoload 'caml-complete "caml-help"
"Does completion for documented qualified OCaml identifier." t)
(autoload 'ocaml-open-module "caml-help"
"Add module in documentation search path." t)
(autoload 'ocaml-close-module "caml-help"
"Remove module from documentation search path." t)
(autoload 'ocaml-add-path "caml-help"
"Add search path for documentation." t)
;;; caml.el ends here
(provide 'caml)
|