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 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538
|
;; verilog-mode.el --- major mode for editing verilog source in Emacs
;;
;; $Id: verilog-mode.el,v 3.57 2001/08/13 18:46:41 mac Exp $
;; Copyright (C) 2001 Free Software Foundation, Inc.
;; Author: Michael McNamara (mac@surefirev.com)
;; Senior Vice President of Technology, Verisity Design, Inc.
;; (SureFire and Verisity merged October 1999)
;; http://www.verisity.com
;; AUTO features, signal, modsig; by: Wilson Snyder
;; (wsnyder@wsnyder.org or wsnyder@world.std.com)
;; http://www.veripool.com
;; Keywords: languages
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
;;; Commentary:
;; This mode borrows heavily from the Pascal-mode and the cc-mode of emacs
;; USAGE
;; =====
;; A major mode for editing Verilog HDL source code. When you have
;; entered Verilog mode, you may get more info by pressing C-h m. You
;; may also get online help describing various functions by: C-h f
;; <Name of function you want described>
;; You can get step by step help in installing this file by going to
;; <http://www.verilog.com/emacs_install.html>
;; The short list of installation instructions are: To set up
;; automatic verilog mode, put this file in your load path, and put
;; the following in code (please un comment it first!) in your
;; .emacs, or in your site's site-load.el
; (autoload 'verilog-mode "verilog-mode" "Verilog mode" t )
; (setq auto-mode-alist (cons '("\\.v\\'" . verilog-mode) auto-mode-alist))
; (setq auto-mode-alist (cons '("\\.dv\\'" . verilog-mode) auto-mode-alist))
;; If you want to customize Verilog mode to fit your needs better,
;; you may add these lines (the values of the variables presented
;; here are the defaults). Note also that if you use an emacs that
;; supports custom, it's probably better to use the custom menu to
;; edit these.
;;
;; Be sure to examine at the help for verilog-auto, and the other
;; verilog-auto-* functions for some major coding time savers.
;;
; ;; User customization for Verilog mode
; (setq verilog-indent-level 3
; verilog-indent-level-module 3
; verilog-indent-level-declaration 3
; verilog-indent-level-behavioral 3
; verilog-indent-level-directive 1
; verilog-case-indent 2
; verilog-auto-newline t
; verilog-auto-indent-on-newline t
; verilog-tab-always-indent t
; verilog-auto-endcomments t
; verilog-minimum-comment-distance 40
; verilog-indent-begin-after-if t
; verilog-auto-lineup '(all))
;; KNOWN BUGS / BUG REPORTS
;; =======================
;; This is beta code, and likely has bugs. Please report any and all
;; bugs to me at verilog-mode-bugs@surefirev.com. Use
;; verilog-submit-bug-report to submit a report.
;;
;;; History:
;;
;;
;;; Code:
(provide 'verilog-mode)
;; This variable will always hold the version number of the mode
(defconst verilog-mode-version "$$Revision: 3.57 $$"
"Version of this verilog mode.")
(defconst verilog-running-on-xemacs (string-match "XEmacs" emacs-version))
(defun verilog-version ()
"Inform caller of the version of this file."
(interactive)
(message (concat "Using verilog-mode version " (substring verilog-mode-version 12 -3 )) ))
;; Insure we have certain packages, and deal with it if we don't
(if (fboundp 'eval-when-compile)
(eval-when-compile
(condition-case nil
(require 'imenu)
(error nil))
(condition-case nil
(require 'reporter)
(error nil))
(condition-case nil
(require 'easymenu)
(error nil))
(condition-case nil
(load "skeleton") ;; bug in 19.28 through 19.30 skeleton.el, not provided.
(error nil))
(condition-case nil
(if (fboundp 'when)
nil ;; fab
(defmacro when (var &rest body)
(` (cond ( (, var) (,@ body))))))
(error nil))
(condition-case nil
(if (fboundp 'unless)
nil ;; fab
(defmacro unless (var &rest body)
(` (if (, var) nil (,@ body)))))
(error nil))
(condition-case nil
(if (fboundp 'store-match-data)
nil ;; fab
(defmacro store-match-data (&rest args) nil))
(error nil))
(condition-case nil
(if (boundp 'current-menubar)
nil ;; great
(defmacro set-buffer-menubar (&rest args) nil)
(defmacro add-submenu (&rest args) nil))
(error nil))
(condition-case nil
(if (fboundp 'zmacs-activate-region)
nil ;; great
(defmacro zmacs-activate-region (&rest args) nil))
(error nil))
;; Requires to define variables that would be "free" warnings
(condition-case nil
(require 'font-lock)
(error nil))
(condition-case nil
(require 'compile)
(error nil))
(condition-case nil
(require 'custom)
(error nil))
(condition-case nil
(require 'dinotrace)
(error nil))
(condition-case nil
(if (fboundp 'dinotrace-unannotate-all)
nil ;; great
(defun dinotrace-unannotate-all (&rest args) nil))
(error nil))
(condition-case nil
(if (fboundp 'customize-apropos)
nil ;; great
(defun customize-apropos (&rest args) nil))
(error nil))
(condition-case nil
(if (fboundp 'match-string-no-properties)
nil ;; great
(defsubst match-string-no-properties (match)
(buffer-substring-no-properties (match-beginning match) (match-end match))))
(error nil))
(if (and (featurep 'custom) (fboundp 'custom-declare-variable))
nil ;; We've got what we needed
;; We have the old custom-library, hack around it!
(defmacro defgroup (&rest args) nil)
(defmacro customize (&rest args)
(message "Sorry, Customize is not available with this version of emacs"))
(defmacro defcustom (var value doc &rest args)
(` (defvar (, var) (, value) (, doc))))
)
(if (fboundp 'defface)
nil ; great!
(defmacro defface (var value doc &rest args)
(` (make-face (, var))))
)
(if (and (featurep 'custom) (fboundp 'customize-group))
nil ;; We've got what we needed
;; We have an intermediate custom-library, hack around it!
(defmacro customize-group (var &rest args)
(`(customize (, var) )))
)
))
(unless (fboundp 'regexp-opt)
(defun regexp-opt (strings &optional paren shy)
(let ((open (if paren "\\(" "")) (close (if paren "\\)" "")))
(concat open (mapconcat 'regexp-quote strings "\\|") close))))
(eval-when-compile
(defun verilog-regexp-opt (a b)
"Wrapper to deal with XEmacs and FSF emacs having similar functions with differing number of arguments."
(if (string-match "XEmacs" emacs-version)
(regexp-opt a b 't)
(regexp-opt a b)))
)
(defun verilog-regexp-opt (a b)
"Deal with XEmacs & FSF both have `regexp-opt'; with different interface.
Call 'regexp-opt' on A and B."
(if verilog-running-on-xemacs
(unwind-protect (regexp-opt a b 't))
(regexp-opt a b)))
(defun verilog-customize ()
"Link to customize screen for Verilog."
(interactive)
(customize-group 'verilog-mode))
(defun verilog-font-customize ()
"Link to customize fonts used for Verilog."
(interactive)
(customize-apropos "font-lock-*" 'faces))
(defgroup verilog-mode nil
"Facilitates easy editing of Verilog source text"
:group 'languages)
; (defgroup verilog-mode-fonts nil
; "Facilitates easy customization fonts used in Verilog source text"
; :link '(customize-apropos "font-lock-*" 'faces)
; :group 'verilog-mode)
(defgroup verilog-mode-indent nil
"Customize indentation and highlighting of verilog source text"
:group 'verilog-mode)
(defgroup verilog-mode-actions nil
"Customize actions on verilog source text"
:group 'verilog-mode)
(defgroup verilog-mode-auto nil
"Customize AUTO actions when expanding verilog source text"
:group 'verilog-mode)
(defcustom verilog-linter "surelint --std --synth --style --sim --race --fsm --msglimit=none "
"*Unix program and arguments to call to run a lint checker on verilog source.
Invoked when you type \\[compile]. \\[next-error] will take you to
the next lint error as expected."
:type 'string
:group 'verilog-mode-actions)
(defcustom verilog-coverage "surecov --code --fsm --expr "
"*Program and arguments to use to annotate for coverage verilog source."
:type 'string
:group 'verilog-mode-actions)
(defcustom verilog-simulator "verilog "
"*Program and arguments to use to interpret verilog source."
:type 'string
:group 'verilog-mode-actions)
(defcustom verilog-compiler "vcs "
"*Program and arguments to use to compile verilog source."
:type 'string
:group 'verilog-mode-actions)
(defvar verilog-tool 'verilog-linter)
(defcustom verilog-highlight-translate-off nil
"*Non-nil means background-highlight code excluded from translation.
That is, all code between \"// synopsys translate_off\" and
\"// synopsys translate_on\" is highlighted using a different background color
\(face `verilog-font-lock-translate-off-face').
Note: this will slow down on-the-fly fontification (and thus editing).
NOTE: Activate the new setting in a Verilog buffer by re-fontifying it (menu
entry \"Fontify Buffer\"). XEmacs: turn off and on font locking."
:type 'boolean
:group 'verilog-mode-indent)
(defcustom verilog-indent-level 3
"*Indentation of Verilog statements with respect to containing block."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-indent-level-module 3
"* Indentation of Module level Verilog statements. (eg always, initial)
Set to 0 to get initial and always statements lined up
on the left side of your screen."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-indent-level-declaration 3
"*Indentation of declarations with respect to containing block.
Set to 0 to get them list right under containing block."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-indent-declaration-macros nil
"*How to treat macro expansions in a declaration.
If nil, indent as:
input [31:0] a;
input `CP;
output c;
If non nil, treat as
input [31:0] a;
input `CP ;
output c;"
:group 'verilog-mode-indent
:type 'boolean)
(defcustom verilog-indent-lists t
"*How to treat indenting items in a list.
If t (the default), indent as:
always @( posedge a or
reset ) begin
If nil, treat as
always @( posedge a or
reset ) begin"
:group 'verilog-mode-indent
:type 'boolean)
(defcustom verilog-indent-level-behavioral 3
"*Absolute indentation of first begin in a task or function block.
Set to 0 to get such code to start at the left side of the screen."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-indent-level-directive 1
"*Indentation to add to each level of `ifdef declarations.
Set to 0 to have all directives start at the left side of the screen."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-cexp-indent 2
"*Indentation of Verilog statements split across lines."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-case-indent 2
"*Indentation for case statements."
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-auto-newline t
"*True means automatically newline after semicolons."
:group 'verilog-mode-indent
:type 'boolean)
(defcustom verilog-auto-indent-on-newline t
"*True means automatically indent line after newline."
:group 'verilog-mode-indent
:type 'boolean)
(defcustom verilog-tab-always-indent t
"*True means TAB should always re-indent the current line.
Nil means TAB will only reindent when at the beginning of the line."
:group 'verilog-mode-indent
:type 'boolean)
(defcustom verilog-tab-to-comment nil
"*True means TAB moves to the right hand column in preparation for a comment."
:group 'verilog-mode-actions
:type 'boolean)
(defcustom verilog-indent-begin-after-if t
"*If true, indent begin statements following if, else, while, for and repeat.
Otherwise, line them up."
:group 'verilog-mode-indent
:type 'boolean )
(defcustom verilog-align-ifelse nil
"*If true, align `else' under matching `if'.
Otherwise else is lined up with first character on line holding matching if."
:group 'verilog-mode-indent
:type 'boolean )
(defcustom verilog-minimum-comment-distance 10
"*Minimum distance (in lines) between begin and end required before a comment.
Setting this variable to zero results in every end acquiring a comment; the
default avoids too many redundant comments in tight quarters"
:group 'verilog-mode-indent
:type 'integer)
(defcustom verilog-auto-endcomments t
"*True means insert a comment /* ... */ after 'end's.
The name of the function or case will be set between the braces."
:group 'verilog-mode-actions
:type 'boolean )
(defcustom verilog-auto-read-includes nil
"*True means do a `verilog-read-defines' and `verilog-read-includes'
before each AUTO expansion. This makes it easier to embed defines and
includes, but can result in very slow reading times if there are many or
large include files."
:group 'verilog-mode-actions
:type 'boolean )
(defcustom verilog-auto-save-policy nil
"*Non-nil indicates action to take when saving a Verilog buffer with AUTOs.
A value of `force' will always do a \\[verilog-auto] automatically if
needed on every save. A value of `detect' will do \\[verilog-auto]
automatically when it thinks necessary. A value of `ask' will query the
user when it thinks updating is needed.
You should not rely on the 'ask or 'detect policies, they are safeguards
only. They do not detect when AUTOINSTs need to be updated because a
sub-module's port list has changed."
:group 'verilog-mode-actions
:type '(choice (const nil) (const ask) (const detect) (const force)))
(defvar verilog-auto-update-tick nil
"Modification tick at which autos were last performed.")
(defvar verilog-error-regexp-add-didit nil)
(defvar verilog-error-regexp nil)
(setq verilog-error-regexp-add-didit nil
verilog-error-regexp
'(
; SureLint
;; ("[^\n]*\\[\\([^:]+\\):\\([0-9]+\\)\\]" 1 2)
; Most SureFire tools
("\\(WARNING\\|ERROR\\|INFO\\)[^:]*: \\([^,]+\\), line \\([0-9]+\\):" 2 3 )
("\
\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\)\\([) \t]\\|\
:\\([^0-9\n]\\|\\([0-9]+:\\)\\)\\)" 1 2 5)
; vcs
("\\(Error\\|Warning\\):[^(]*(\\([^ \t]+\\) line *\\([0-9]+\\))" 2 3)
("Warning:.*(port.*(\\([^ \t]+\\) line \\([0-9]+\\))" 1 2)
("\\(Error\\|Warning\\):[\n.]*\\([^ \t]+\\) *\\([0-9]+\\):" 2 3)
("syntax error:.*\n\\([^ \t]+\\) *\\([0-9]+\\):" 1 2)
; vxl
("\\(Error\\|Warning\\)!.*\n?.*\"\\([^\"]+\\)\", \\([0-9]+\\)" 2 3)
("([WE][0-9A-Z]+)[ \t]+\\([^ \t\n,]+\\)[, \t]+\\([0-9]+\\):.*$" 1 2) ; vxl
("([WE][0-9A-Z]+)[ \t]+\\([^ \t\n,]+\\)[, \t]+line[ \t]+\\([0-9]+\\):.*$" 1 2)
)
; "*List of regexps for verilog compilers, like verilint. See compilation-error-regexp-alist for the formatting."
)
(defvar verilog-error-font-lock-keywords
'(
("[^\n]*\\[\\([^:]+\\):\\([0-9]+\\)\\]" 1 bold t)
("[^\n]*\\[\\([^:]+\\):\\([0-9]+\\)\\]" 2 bold t)
("\\(WARNING\\|ERROR\\|INFO\\): \\([^,]+\\), line \\([0-9]+\\):" 2 bold t)
("\\(WARNING\\|ERROR\\|INFO\\): \\([^,]+\\), line \\([0-9]+\\):" 3 bold t)
("\
\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\)\\([) \t]\\|\
:\\([^0-9\n]\\|\\([0-9]+:\\)\\)\\)" 1 bold t)
("\
\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\)\\([) \t]\\|\
:\\([^0-9\n]\\|\\([0-9]+:\\)\\)\\)" 1 bold t)
("\\(Error\\|Warning\\):[^(]*(\\([^ \t]+\\) line *\\([0-9]+\\))" 2 bold t)
("\\(Error\\|Warning\\):[^(]*(\\([^ \t]+\\) line *\\([0-9]+\\))" 3 bold t)
("Warning:.*(port.*(\\([^ \t]+\\) line \\([0-9]+\\))" 1 bold t)
("Warning:.*(port.*(\\([^ \t]+\\) line \\([0-9]+\\))" 1 bold t)
("\\(Error\\|Warning\\):[\n.]*\\([^ \t]+\\) *\\([0-9]+\\):" 2 bold t)
("\\(Error\\|Warning\\):[\n.]*\\([^ \t]+\\) *\\([0-9]+\\):" 3 bold t)
("syntax error:.*\n\\([^ \t]+\\) *\\([0-9]+\\):" 1 bold t)
("syntax error:.*\n\\([^ \t]+\\) *\\([0-9]+\\):" 2 bold t)
; vxl
("\\(Error\\|Warning\\)!.*\n?.*\"\\([^\"]+\\)\", \\([0-9]+\\)" 2 bold t)
("\\(Error\\|Warning\\)!.*\n?.*\"\\([^\"]+\\)\", \\([0-9]+\\)" 2 bold t)
("([WE][0-9A-Z]+)[ \t]+\\([^ \t\n,]+\\)[, \t]+\\([0-9]+\\):.*$" 1 bold t)
("([WE][0-9A-Z]+)[ \t]+\\([^ \t\n,]+\\)[, \t]+\\([0-9]+\\):.*$" 2 bold t)
("([WE][0-9A-Z]+)[ \t]+\\([^ \t\n,]+\\)[, \t]+line[ \t]+\\([0-9]+\\):.*$" 1 bold t)
("([WE][0-9A-Z]+)[ \t]+\\([^ \t\n,]+\\)[, \t]+line[ \t]+\\([0-9]+\\):.*$" 2 bold t)
)
"*Keywords to also highlight in Verilog *compilation* buffers."
)
(defcustom verilog-library-directories '(".")
"*List of directories when looking for files for /*AUTOINST*/.
The directory may be relative to the current file, or absolute. Having at
least the current directory is a good idea.
You might want these defined in each file; put at the *END* of your file
something like:
// Local Variables:
// verilog-library-directories:(\".\" \"subdir\" \"subdir2\")
// End:
Note these are only read when the file is first visited, you must use
\\[find-alternate-file] RET to have these take effect after editing them!
See also verilog-library-files and verilog-library-extensions."
:group 'verilog-mode-auto
:type '(repeat file))
(defcustom verilog-library-files '(".")
"*List of files to search for modules in when looking for files for
/*AUTOINST*/. This is a complete path, usually to a technology file with
many standard cells defined in it.
You might want these defined in each file; put at the *END* of your file
something like:
// Local Variables:
// verilog-library-files:(\"/some/path/technology.v\" \"/some/path/tech2.v\")
// End:
Note these are only read when the file is first visited, you must use
\\[find-alternate-file] RET to have these take effect after editing them!
See also verilog-library-directories."
:group 'verilog-mode-auto
:type '(repeat directory))
(defcustom verilog-library-extensions '(".v")
"*List of extensions to use when looking for files for /*AUTOINST*/.
See also `verilog-library-directories'."
:type '(repeat string)
:group 'verilog-mode-auto)
(defcustom verilog-auto-sense-include-inputs nil
"*If true, AUTOSENSE should include all inputs.
If nil, only inputs that are NOT output signals in the same block are
included."
:type 'boolean
:group 'verilog-mode-auto)
(defcustom verilog-auto-sense-defines-constant nil
"*If true, AUTOSENSE should assume all defines represent constants.
When true, the defines will not be included in sensitivity lists. To
maintain compatibility with other sites, this should be set at the bottom
of each verilog file that requires it, rather then being set globally."
:type 'boolean
:group 'verilog-mode-auto)
(defcustom verilog-auto-inst-vector t
"*If true, when creating default ports with AUTOINST, use bus subscripts.
If nil, skip the subscript when it matches the entire bus as declared in
the module (AUTOWIRE signals always are subscripted.) Nil may speed up
some simulators, but is less general and harder to read."
:group 'verilog-mode-auto
:type 'boolean )
(defcustom verilog-mode-hook 'verilog-set-compile-command
"*Hook (List of functions) run after verilog mode is loaded."
:type 'hook
:group 'verilog-mode)
(defcustom verilog-before-auto-hook nil
"*Hook run before `verilog-mode' updates AUTOs."
:type 'hook
:group 'verilog-mode-auto
)
(defcustom verilog-auto-hook nil
"*Hook run after `verilog-mode' updates AUTOs."
:type 'hook
:group 'verilog-mode-auto)
(defvar verilog-auto-lineup '(all)
"*List of contexts where auto lineup of :'s or ='s should be done.
Elements can be of type: 'declaration' or 'case', which will do auto
lineup in declarations or case-statements respectively. The word 'all'
will do all lineups. '(case declaration) for instance will do lineup
in case-statements and parameter list, while '(all) will do all
lineups.")
(defvar verilog-mode-abbrev-table nil
"Abbrev table in use in Verilog-mode buffers.")
(defvar verilog-imenu-generic-expression
'((nil "^\\s-*\\(\\(m\\(odule\\|acromodule\\)\\)\\|primitive\\)\\s-+\\([a-zA-Z0-9_.:]+\\)" 4)
("*Vars*" "^\\s-*\\(reg\\|wire\\)\\s-+\\(\\|\\[[^]]+\\]\\s-+\\)\\([A-Za-z0-9_]+\\)" 3))
"Imenu expression for Verilog-mode. See `imenu-generic-expression'.")
(defvar verilog-mode-abbrev-table nil
"Abbrev table in use in Verilog-mode buffers.")
;;
;; provide a verilog-header function.
;; Customization variables:
;;
(defvar verilog-date-scientific-format nil
"*If non-nil, dates are written in scientific format (e.g. 1997/09/17).
If nil, in European format (e.g. 17.09.1997). The brain-dead American
format (e.g. 09/17/1997) is not supported.")
(defvar verilog-company nil
"*Default name of Company for verilog header.
If set will become buffer local.")
(defvar verilog-project nil
"*Default name of Project for verilog header.
If set will become buffer local.")
(define-abbrev-table 'verilog-mode-abbrev-table ())
(defvar verilog-mode-map ()
"Keymap used in Verilog mode.")
(if verilog-mode-map
()
(setq verilog-mode-map (make-sparse-keymap))
(define-key verilog-mode-map ";" 'electric-verilog-semi)
(define-key verilog-mode-map [(control 59)] 'electric-verilog-semi-with-comment)
(define-key verilog-mode-map ":" 'electric-verilog-colon)
(define-key verilog-mode-map "=" 'electric-verilog-equal)
(define-key verilog-mode-map "\`" 'electric-verilog-tick)
(define-key verilog-mode-map "\t" 'electric-verilog-tab)
(define-key verilog-mode-map "\r" 'electric-verilog-terminate-line)
;; backspace/delete key bindings
(define-key verilog-mode-map [backspace] 'backward-delete-char-untabify)
(unless (boundp 'delete-key-deletes-forward) ; XEmacs variable
(define-key verilog-mode-map [delete] 'delete-char)
(define-key verilog-mode-map [(meta delete)] 'kill-word))
(define-key verilog-mode-map "\M-\C-b" 'electric-verilog-backward-sexp)
(define-key verilog-mode-map "\M-\C-f" 'electric-verilog-forward-sexp)
(define-key verilog-mode-map "\M-\r" (function (lambda ()
(interactive) (electric-verilog-terminate-line 1))))
(define-key verilog-mode-map "\M-\t" 'verilog-complete-word)
(define-key verilog-mode-map "\M-?" 'verilog-show-completions)
(define-key verilog-mode-map [(meta control h)] 'verilog-mark-defun)
(define-key verilog-mode-map "\C-c\`" 'verilog-lint-off)
(define-key verilog-mode-map "\C-c\C-r" 'verilog-label-be)
(define-key verilog-mode-map "\C-c\C-i" 'verilog-pretty-declarations)
(define-key verilog-mode-map "\C-c=" 'verilog-pretty-expr)
(define-key verilog-mode-map "\C-c\C-b" 'verilog-submit-bug-report)
(define-key verilog-mode-map "\M-*" 'verilog-star-comment)
(define-key verilog-mode-map "\C-c\C-c" 'verilog-comment-region)
(define-key verilog-mode-map "\C-c\C-u" 'verilog-uncomment-region)
(define-key verilog-mode-map "\M-\C-a" 'verilog-beg-of-defun)
(define-key verilog-mode-map "\M-\C-e" 'verilog-end-of-defun)
(define-key verilog-mode-map "\C-c\C-d" 'verilog-goto-defun)
(define-key verilog-mode-map "\C-c\C-k" 'verilog-delete-auto)
(define-key verilog-mode-map "\C-c\C-a" 'verilog-auto)
(define-key verilog-mode-map "\C-c\C-s" 'verilog-auto-save-compile)
(define-key verilog-mode-map "\C-c\C-e" 'verilog-expand-vector)
(define-key verilog-mode-map "\C-c\C-h" 'verilog-header)
)
;; menus
(defvar verilog-which-tool 1)
(defvar verilog-xemacs-menu
'("Verilog"
("Choose Compilation Action"
["Lint"
(progn
(setq verilog-tool 'verilog-linter)
(setq verilog-which-tool 1)
(verilog-set-compile-command))
:style radio
:selected (= verilog-which-tool 1)]
["Coverage"
(progn
(setq verilog-tool 'verilog-coverage)
(setq verilog-which-tool 2)
(verilog-set-compile-command))
:style radio
:selected (= verilog-which-tool 2)]
["Simulator"
(progn
(setq verilog-tool 'verilog-simulator)
(setq verilog-which-tool 3)
(verilog-set-compile-command))
:style radio
:selected (= verilog-which-tool 3)]
["Compiler"
(progn
(setq verilog-tool 'verilog-compiler)
(setq verilog-which-tool 4)
(verilog-set-compile-command))
:style radio
:selected (= verilog-which-tool 4)]
)
("Move"
["Beginning of function" verilog-beg-of-defun t]
["End of function" verilog-end-of-defun t]
["Mark function" verilog-mark-defun t]
["Goto function" verilog-goto-defun t]
["Move to beginning of block" electric-verilog-backward-sexp t]
["Move to end of block" electric-verilog-forward-sexp t]
)
("Comments"
["Comment Region" verilog-comment-region t]
["UnComment Region" verilog-uncomment-region t]
["Multi-line comment insert" verilog-star-comment t]
["Lint error to comment" verilog-lint-off t]
)
"----"
["Compile" compile t]
["AUTO, Save, Compile" verilog-auto-save-compile t]
["Next Compile Error" next-error t]
["Ignore Lint Warning at point" verilog-lint-off t]
"----"
["Line up declarations around point" verilog-pretty-declarations t]
["Line up equations around point" verilog-pretty-expr t]
["Redo/insert comments on every end" verilog-label-be t]
["Expand [x:y] vector line" verilog-expand-vector t]
["Insert begin-end block" verilog-insert-block t]
["Complete word" verilog-complete-word t]
"----"
["Recompute AUTOs" verilog-auto t]
["Kill AUTOs" verilog-delete-auto t]
("AUTO Help..."
["AUTO General" (describe-function 'verilog-auto) t]
["AUTO Library Path" (describe-variable 'verilog-library-directories) t]
["AUTO Library Files" (describe-variable 'verilog-library-files) t]
["AUTO Library Extensions" (describe-variable 'verilog-library-extensions) t]
["AUTO `define Reading" (describe-function 'verilog-read-defines) t]
["AUTO `include Reading" (describe-function 'verilog-read-includes) t]
["AUTOARG" (describe-function 'verilog-auto-arg) t]
["AUTOASCIIENUM" (describe-function 'verilog-auto-ascii-enum) t]
["AUTOINOUTMODULE" (describe-function 'verilog-auto-inout-module) t]
["AUTOINPUT" (describe-function 'verilog-auto-input) t]
["AUTOINST" (describe-function 'verilog-auto-inst) t]
["AUTOOUTPUT" (describe-function 'verilog-auto-output) t]
["AUTOOUTPUTEVERY" (describe-function 'verilog-auto-output-every) t]
["AUTOREG" (describe-function 'verilog-auto-reg) t]
["AUTOREGINPUT" (describe-function 'verilog-auto-reg-input) t]
["AUTORESET" (describe-function 'verilog-auto-reset) t]
["AUTOSENSE" (describe-function 'verilog-auto-sense) t]
["AUTOWIRE" (describe-function 'verilog-auto-wire) t]
)
"----"
["Submit bug report" verilog-submit-bug-report t]
["Customize Verilog Mode..." verilog-customize t]
["Customize Verilog Fonts & Colors" verilog-font-customize t]
)
"Emacs menu for VERILOG mode."
)
(unless verilog-running-on-xemacs
(easy-menu-define verilog-menu verilog-mode-map "Menu for Verilog mode"
verilog-xemacs-menu))
(defvar verilog-mode-abbrev-table nil
"Abbrev table in use in Verilog-mode buffers.")
(define-abbrev-table 'verilog-mode-abbrev-table ())
;; compilation program
(defun verilog-set-compile-command ()
"Function to compute shell command to compile verilog.
Can be the path and arguments for your Verilog simulator:
\"vcs -p123 -O\"
or a string like
\"(cd /tmp; surecov %s)\".
In the former case, the path to the current buffer is concat'ed to the
value of verilog-tool; in the later, the path to the current buffer is
substituted for the %s"
(interactive)
(or (file-exists-p "makefile") ;If there is a makefile, use it
(file-exists-p "Makefile")
(progn (make-local-variable 'compile-command)
(setq compile-command
(if (string-match "%s" (eval verilog-tool))
(format (eval verilog-tool) (or buffer-file-name ""))
(concat (eval verilog-tool) " " (or buffer-file-name "")))))))
(defun verilog-error-regexp-add ()
"Add the messages to the `compilation-error-regexp-alist'.
Called by `compilation-mode-hook'. This allows \\[next-error] to find the errors."
(if (not verilog-error-regexp-add-didit)
(progn
(setq verilog-error-regexp-add-didit t)
(setq-default compilation-error-regexp-alist
(append (default-value 'compilation-error-regexp-alist)
verilog-error-regexp))
;; Could be buffer local at this point; maybe also in let; change all three
(setq compilation-error-regexp-alist (default-value 'compilation-error-regexp-alist))
(set (make-local-variable 'compilation-error-regexp-alist)
(default-value 'compilation-error-regexp-alist))
)))
(add-hook 'compilation-mode-hook 'verilog-error-regexp-add)
;;
;; Regular expressions used to calculate indent, etc.
;;
(defconst verilog-symbol-re "\\<[a-zA-Z_][a-zA-Z_0-9.]*\\>")
(defconst verilog-case-re "\\(\\<case[xz]?\\>\\)")
;; Want to match
;; aa :
;; aa,bb :
;; a[34:32] :
;; a,
;; b :
(defconst
verilog-no-indent-begin-re
"\\<\\(if\\|else\\|while\\|for\\|repeat\\|always\\)\\>")
(defconst verilog-ends-re
(concat
"\\(\\<else\\>\\)\\|"
"\\(\\<if\\>\\)\\|"
"\\(\\<end\\>\\)\\|"
"\\(\\<join\\>\\)\\|"
"\\(\\<endcase\\>\\)\\|"
"\\(\\<endtable\\>\\)\\|"
"\\(\\<endspecify\\>\\)\\|"
"\\(\\<endfunction\\>\\)\\|"
"\\(\\<endtask\\>\\)"))
(defconst verilog-enders-re
(concat "\\(\\<endcase\\>\\)\\|"
"\\(\\<end\\>\\)\\|"
"\\(\\<end\\(\\(function\\)\\|\\(task\\)\\|\\(module\\)\\|\\(primitive\\)\\)\\>\\)"))
(defconst verilog-endcomment-reason-re
(concat
"\\(\\<fork\\>\\)\\|"
"\\(\\<begin\\>\\)\\|"
"\\(\\<if\\>\\)\\|"
"\\(\\<else\\>\\)\\|"
"\\(\\<end\\>.*\\<else\\>\\)\\|"
"\\(\\<task\\>\\)\\|"
"\\(\\<function\\>\\)\\|"
"\\(\\<initial\\>\\)\\|"
"\\(\\<always\\>\\(\[ \t\]*@\\)?\\)\\|"
"\\(@\\)\\|"
"\\(\\<while\\>\\)\\|"
"\\(\\<for\\(ever\\)?\\>\\)\\|"
"\\(\\<repeat\\>\\)\\|\\(\\<wait\\>\\)\\|"
"#"))
(defconst verilog-named-block-re "begin[ \t]*:")
(defconst verilog-beg-block-re
;; "begin" "case" "casex" "fork" "casez" "table" "specify" "function" "task"
"\\(\\<\\(begin\\>\\|case\\(\\>\\|x\\>\\|z\\>\\)\\|generate\\|f\\(ork\\>\\|unction\\>\\)\\|specify\\>\\|ta\\(ble\\>\\|sk\\>\\)\\)\\)")
(defconst verilog-beg-block-re-1
"\\<\\(begin\\)\\|\\(case[xz]?\\)\\|\\(fork\\)\\|\\(table\\)\\|\\(specify\\)\\|\\(function\\)\\|\\(task\\)\\|\\(generate\\)\\>")
(defconst verilog-end-block-re
;; "end" "join" "endcase" "endtable" "endspecify" "endtask" "endfunction"
"\\<\\(end\\(\\>\\|case\\>\\|function\\>\\|specify\\>\\|ta\\(ble\\>\\|sk\\>\\)\\)\\|join\\>\\)")
(defconst verilog-end-block-re-1 "\\(\\<end\\>\\)\\|\\(\\<endcase\\>\\)\\|\\(\\<join\\>\\)\\|\\(\\<endtable\\>\\)\\|\\(\\<endspecify\\>\\)\\|\\(\\<endfunction\\>\\)\\|\\(\\<endtask\\>\\)")
(defconst verilog-declaration-re
(eval-when-compile
(concat "\\<"
(verilog-regexp-opt
(list
"assign" "defparam" "event" "inout" "input" "integer" "output"
"parameter" "real" "realtime" "reg" "supply" "supply0" "supply1"
"time" "tri" "tri0" "tri1" "triand" "trior" "trireg" "wand" "wire"
"wor") t )
"\\>")))
(defconst verilog-range-re "\\[[^]]*\\]")
(defconst verilog-macroexp-re "`\\sw+")
(defconst verilog-delay-re "#\\s-*\\(\\([0-9_]+\\('[hdxbo][0-9a-fA-F_xz]+\\)?\\)\\|\\(([^)]*)\\)\\|\\(\\sw+\\)\\)")
(defconst verilog-declaration-re-2-no-macro
(concat "\\s-*" verilog-declaration-re
"\\s-*\\(\\(" verilog-range-re "\\)\\|\\(" verilog-delay-re "\\)"
; "\\|\\(" verilog-macroexp-re "\\)"
"\\)?"))
(defconst verilog-declaration-re-2-macro
(concat "\\s-*" verilog-declaration-re
"\\s-*\\(\\(" verilog-range-re "\\)\\|\\(" verilog-delay-re "\\)"
"\\|\\(" verilog-macroexp-re "\\)"
"\\)?"))
(defconst verilog-declaration-re-1-macro (concat "^" verilog-declaration-re-2-macro))
(defconst verilog-declaration-re-1-no-macro (concat "^" verilog-declaration-re-2-no-macro))
(defconst verilog-defun-re
;;"module" "macromodule" "primitive"
"\\(\\<\\(m\\(acromodule\\>\\|odule\\>\\)\\|primitive\\>\\)\\)")
(defconst verilog-end-defun-re
;; "endmodule" "endprimitive"
"\\(\\<end\\(module\\>\\|primitive\\>\\)\\)")
(defconst verilog-zero-indent-re
(concat verilog-defun-re "\\|" verilog-end-defun-re))
(defconst verilog-directive-re
;; "`case" "`default" "`define" "`define" "`else" "`endfor" "`endif"
;; "`endprotect" "`endswitch" "`endwhile" "`for" "`format" "`if" "`ifdef"
;; "`ifndef" "`include" "`let" "`protect" "`switch" "`timescale"
;; "`time_scale" "`undef" "`while"
"\\<`\\(case\\|def\\(ault\\|ine\\(\\)?\\)\\|e\\(lse\\|nd\\(for\\|if\\|protect\\|switch\\|while\\)\\)\\|for\\(mat\\)?\\|i\\(f\\(def\\|ndef\\)?\\|nclude\\)\\|let\\|protect\\|switch\\|time\\(_scale\\|scale\\)\\|undef\\|while\\)\\>")
(defconst verilog-directive-begin
"\\<`\\(for\\|i\\(f\\|fdef\\|fndef\\)\\|switch\\|while\\)\\>")
(defconst verilog-directive-middle
"\\<`\\(else\\|default\\|case\\)\\>")
(defconst verilog-directive-end
"`\\(endfor\\|endif\\|endswitch\\|endwhile\\)\\>")
(defconst verilog-directive-re-1
(concat "[ \t]*" verilog-directive-re))
(defconst verilog-autoindent-lines-re
;; "macromodule" "module" "primitive" "end" "endcase" "endfunction"
;; "endtask" "endmodule" "endprimitive" "endspecify" "endtable" "join"
;; "begin" "else" "`else" "`ifdef" "`endif" "`define" "`undef" "`include"
(concat "\\("
verilog-directive-re
"\\|\\(\\<begin\\>\\|e\\(lse\\>\\|nd\\(\\>\\|case\\>\\|function\\>\\|module\\>\\|primitive\\>\\|specify\\>\\|ta\\(ble\\>\\|sk\\>\\)\\)\\)\\|join\\>\\|m\\(acromodule\\>\\|odule\\>\\)\\|primitive\\>\\)\\)" ))
(defconst verilog-behavioral-block-beg-re
"\\(\\<initial\\>\\|\\<always\\>\\|\\<function\\>\\|\\<task\\>\\)")
(defconst verilog-indent-reg
(concat
"\\(\\<begin\\>\\|\\<case[xz]?\\>\\|\\<specify\\>\\|\\<fork\\>\\|\\<table\\>\\)\\|"
"\\(\\<end\\>\\|\\<join\\>\\|\\<endcase\\>\\|\\<endtable\\>\\|\\<endspecify\\>\\)\\|"
"\\(\\<module\\>\\|\\<macromodule\\>\\|\\<primitive\\>\\|\\<initial\\>\\|\\<always\\>\\)\\|"
"\\(\\<endmodule\\>\\|\\<endprimitive\\>\\)\\|"
"\\(\\<generate\\>\\|\\<endgenerate\\>\\)\\|"
"\\(\\<endtask\\>\\|\\<endfunction\\>\\)\\|"
"\\(\\<function\\>\\|\\<task\\>\\)"
;; "\\|\\(\\<if\\>\\|\\<else\\>\\)"
))
(defconst verilog-indent-re
(concat
"\\(\\<\\(always\\>\\|begin\\>\\|case\\(\\>\\|x\\>\\|z\\>\\)\\|end\\(\\>\\|case\\>\\|function\\>\\|module\\>\\|primitive\\>\\|specify\\>\\|ta\\(ble\\>\\|sk\\>\\)\\)\\|f\\(ork\\>\\|unction\\>\\)\\|initial\\>\\|join\\>\\|m\\(acromodule\\>\\|odule\\>\\)\\|primitive\\>\\|specify\\>\\|ta\\(ble\\>\\|sk\\>\\)\\)"
"\\|" verilog-directive-re "\\)"))
(defconst verilog-defun-level-re
;; "module" "macromodule" "primitive" "initial" "always" "endtask" "endfunction"
"\\(\\<\\(always\\>\\|end\\(function\\>\\|task\\>\\)\\|initial\\>\\|m\\(acromodule\\>\\|odule\\>\\)\\|primitive\\>\\)\\)")
(defconst verilog-cpp-level-re
;;"endmodule" "endprimitive"
"\\(\\<end\\(module\\>\\|primitive\\>\\)\\)")
(defconst verilog-behavioral-level-re
;; "function" "task"
"\\(\\<\\(function\\>\\|task\\>\\)\\)")
(defconst verilog-complete-reg
;; "always" "initial" "repeat" "case" "casex" "casez" "while" "if" "for" "forever" "else"
"\\<\\(always\\|case\\(\\|[xz]\\)\\|begin\\|else\\|generate\\|for\\(\\|ever\\)\\|i\\(f\\|nitial\\)\\|repeat\\|while\\)\\>")
(defconst verilog-end-statement-re
(concat "\\(" verilog-beg-block-re "\\)\\|\\("
verilog-end-block-re "\\)"))
(defconst verilog-endcase-re
(concat verilog-case-re "\\|"
"\\(endcase\\)\\|"
verilog-defun-re
))
;; Strings used to mark beginning and end of excluded text
(defconst verilog-exclude-str-start "/* -----\\/----- EXCLUDED -----\\/-----")
(defconst verilog-exclude-str-end " -----/\\----- EXCLUDED -----/\\----- */")
(defconst verilog-keywords
'("`define" "`else" "`endif" "`ifdef" "`include" "`timescale"
"`undef" "always" "and" "assign" "begin" "buf" "bufif0" "bufif1"
"case" "casex" "casez" "cmos" "default" "defparam" "disable" "else" "end"
"endcase" "endfunction" "endgenerate" "endmodule" "endprimitive"
"endspecify" "endtable" "endtask" "event" "for" "force" "forever"
"fork" "function" "generate" "if" "initial" "inout" "input" "integer"
"join" "macromodule" "makefile" "module" "nand" "negedge" "nmos" "nor"
"not" "notif0" "notif1" "or" "output" "parameter" "pmos" "posedge"
"primitive" "pulldown" "pullup" "rcmos" "real" "realtime" "reg"
"repeat" "rnmos" "rpmos" "rtran" "rtranif0" "rtranif1" "signed"
"specify" "supply" "supply0" "supply1" "table" "task" "time" "tran"
"tranif0" "tranif1" "tri" "tri0" "tri1" "triand" "trior" "trireg"
"vectored" "wait" "wand" "while" "wire" "wor" "xnor" "xor" )
"List of Verilog keywords.")
(defconst verilog-emacs-features
(let ((major (and (boundp 'emacs-major-version)
emacs-major-version))
(minor (and (boundp 'emacs-minor-version)
emacs-minor-version))
flavor comments flock-syntax)
;; figure out version numbers if not already discovered
(and (or (not major) (not minor))
(string-match "\\([0-9]+\\).\\([0-9]+\\)" emacs-version)
(setq major (string-to-int (substring emacs-version
(match-beginning 1)
(match-end 1)))
minor (string-to-int (substring emacs-version
(match-beginning 2)
(match-end 2)))))
(if (not (and major minor))
(error "Cannot figure out the major and minor version numbers"))
;; calculate the major version
(cond
((= major 4) (setq major 'v18)) ;Epoch 4
((= major 18) (setq major 'v18)) ;Emacs 18
((= major 19) (setq major 'v19 ;Emacs 19
flavor (if (or (string-match "Lucid" emacs-version)
(string-match "XEmacs" emacs-version))
'XEmacs 'FSF)))
((> major 19) (setq major 'v20
flavor (if (or (string-match "Lucid" emacs-version)
(string-match "XEmacs" emacs-version))
'XEmacs 'FSF)))
;; I don't know
(t (error "Cannot recognize major version number: %s" major)))
;; XEmacs 19 uses 8-bit modify-syntax-entry flags, as do all
;; patched Emacs 19, Emacs 18, Epoch 4's. Only Emacs 19 uses a
;; 1-bit flag. Let's be as smart as we can about figuring this
;; out.
(if (or (eq major 'v20) (eq major 'v19))
(let ((table (copy-syntax-table)))
(modify-syntax-entry ?a ". 12345678" table)
(cond
;; XEmacs pre 20 and Emacs pre 19.30 use vectors for syntax tables.
((vectorp table)
(if (= (logand (lsh (aref table ?a) -16) 255) 255)
(setq comments '8-bit)
(setq comments '1-bit)))
;; XEmacs 20 is known to be 8-bit
((eq flavor 'XEmacs) (setq comments '8-bit))
;; Emacs 19.30 and beyond are known to be 1-bit
((eq flavor 'FSF) (setq comments '1-bit))
;; Don't know what this is
(t (error "Couldn't figure out syntax table format"))
))
;; Emacs 18 has no support for dual comments
(setq comments 'no-dual-comments))
;; determine whether to use old or new font lock syntax
;; We can assume 8-bit syntax table emacsen aupport new syntax, otherwise
;; look for version > 19.30
(setq flock-syntax
(if (or (equal comments '8-bit)
(equal major 'v20)
(and (equal major 'v19) (> minor 30)))
'flock-syntax-after-1930
'flock-syntax-before-1930))
;; lets do some minimal sanity checking.
(if (or
;; Lemacs before 19.6 had bugs
(and (eq major 'v19) (eq flavor 'XEmacs) (< minor 6))
;; Emacs 19 before 19.21 has known bugs
(and (eq major 'v19) (eq flavor 'FSF) (< minor 21))
)
(with-output-to-temp-buffer "*verilog-mode warnings*"
(print (format
"The version of Emacs that you are running, %s,
has known bugs in its syntax parsing routines which will affect the
performance of verilog-mode. You should strongly consider upgrading to the
latest available version. verilog-mode may continue to work, after a
fashion, but strange indentation errors could be encountered."
emacs-version))))
;; Emacs 18, with no patch is not too good
(if (and (eq major 'v18) (eq comments 'no-dual-comments))
(with-output-to-temp-buffer "*verilog-mode warnings*"
(print (format
"The version of Emacs 18 you are running, %s,
has known deficiencies in its ability to handle the dual verilog
(and C++) comments, (e.g. the // and /* */ comments). This will
not be much of a problem for you if you only use the /* */ comments,
but you really should strongly consider upgrading to one of the latest
Emacs 19's. In Emacs 18, you may also experience performance degradations.
Emacs 19 has some new built-in routines which will speed things up for you.
Because of these inherent problems, verilog-mode is not supported
on emacs-18."
emacs-version))))
;; Emacs 18 with the syntax patches are no longer supported
(if (and (eq major 'v18) (not (eq comments 'no-dual-comments)))
(with-output-to-temp-buffer "*verilog-mode warnings*"
(print (format
"You are running a syntax patched Emacs 18 variant. While this should
work for you, you may want to consider upgrading to Emacs 19.
The syntax patches are no longer supported either for verilog-mode."))))
(list major comments flock-syntax))
"A list of features extant in the Emacs you are using.
There are many flavors of Emacs out there, each with different
features supporting those needed by `verilog-mode'. Here's the current
supported list, along with the values for this variable:
Vanilla Emacs 18/Epoch 4: (v18 no-dual-comments flock-syntax-before-1930)
Emacs 18/Epoch 4 (patch2): (v18 8-bit flock-syntax-after-1930)
XEmacs (formerly Lucid) 19: (v19 8-bit flock-syntax-after-1930)
XEmacs 20: (v20 8-bit flock-syntax-after-1930)
Emacs 19.1-19.30: (v19 8-bit flock-syntax-before-1930)
Emacs 19.31-19.xx: (v19 8-bit flock-syntax-after-1930)
Emacs20 : (v20 1-bit flock-syntax-after-1930).")
(defconst verilog-comment-start-regexp "//\\|/\\*"
"Dual comment value for `comment-start-regexp'.")
(defun verilog-populate-syntax-table (table)
"Populate the syntax TABLE."
(modify-syntax-entry ?\\ "\\" table)
(modify-syntax-entry ?+ "." table)
(modify-syntax-entry ?- "." table)
(modify-syntax-entry ?= "." table)
(modify-syntax-entry ?% "." table)
(modify-syntax-entry ?< "." table)
(modify-syntax-entry ?> "." table)
(modify-syntax-entry ?& "." table)
(modify-syntax-entry ?| "." table)
(modify-syntax-entry ?` "w" table)
(modify-syntax-entry ?_ "w" table)
(modify-syntax-entry ?\' "." table)
)
(defun verilog-setup-dual-comments (table)
"Set up TABLE to handle block and line style comments."
(cond
((memq '8-bit verilog-emacs-features)
;; XEmacs (formerly Lucid) has the best implementation
(modify-syntax-entry ?/ ". 1456" table)
(modify-syntax-entry ?* ". 23" table)
(modify-syntax-entry ?\n "> b" table)
)
((memq '1-bit verilog-emacs-features)
;; Emacs 19 does things differently, but we can work with it
(modify-syntax-entry ?/ ". 124b" table)
(modify-syntax-entry ?* ". 23" table)
(modify-syntax-entry ?\n "> b" table)
)
))
(defvar verilog-mode-syntax-table nil
"Syntax table used in `verilog-mode' buffers.")
(defconst verilog-font-lock-keywords nil
"Default highlighting for Verilog mode.")
(defconst verilog-font-lock-keywords-1 nil
"Subdued level highlighting for Verilog mode.")
(defconst verilog-font-lock-keywords-2 nil
"Medium level highlighting for Verilog mode.
See also `verilog-font-lock-extra-types'.")
(defconst verilog-font-lock-keywords-3 nil
"Gaudy level highlighting for Verilog mode.
See also `verilog-font-lock-extra-types'.")
(defvar
verilog-font-lock-translate-off-face
'verilog-font-lock-translate-off-face
"Font to use for translated off regions")
(defface verilog-font-lock-translate-off-face
'((((class color)
(background light))
(:background "gray90" :italic t ))
(((class color)
(background dark))
(:background "gray10" :italic t ))
(((class grayscale) (background light))
(:foreground "DimGray" :italic t))
(((class grayscale) (background dark))
(:foreground "LightGray" :italic t))
(t (:italis t)))
"Font lock mode face used to background highlight translate-off regions."
:group 'font-lock-highlighting-faces)
(let* ((verilog-type-font-keywords
(eval-when-compile
(verilog-regexp-opt
'("defparam" "event" "inout" "input" "integer" "output" "parameter"
"real" "realtime" "reg" "signed" "supply" "supply0" "supply1" "time"
"tri" "tri0" "tri1" "triand" "trior" "trireg" "vectored" "wand" "wire"
"wor" ) nil )))
(verilog-pragma-keywords
(eval-when-compile
(verilog-regexp-opt
'("surefire" "synopsys" "rtl_synthesis" "verilint" ) nil
)))
(verilog-font-keywords
(eval-when-compile
(verilog-regexp-opt
'( "always" "assign" "begin" "case" "casex" "casez" "default" "deassign"
"disable" "else" "end" "endcase" "endfunction" "endgenerate" "endmodule"
"endprimitive" "endspecify" "endtable" "endtask" "for" "force"
"forever" "fork" "function" "generate" "if" "initial" "join" "macromodule"
"module" "negedge" "posedge" "primitive" "repeat" "release" "specify"
"table" "task" "wait" "while" ) nil ))))
(setq verilog-font-lock-keywords
(list
;; Fontify all builtin keywords
(concat "\\<\\(" verilog-font-keywords "\\|"
;; And user/system tasks and functions
"\\$[a-zA-Z][a-zA-Z0-9_\\$]*"
"\\)\\>")
;; Fontify all types
(cons (concat "\\<\\(" verilog-type-font-keywords "\\)\\>")
'font-lock-type-face)
))
(setq verilog-font-lock-keywords-1
(append verilog-font-lock-keywords
(list
;; Fontify module definitions
(list
"\\<\\(\\(macro\\)?module\\|primitive\\|task\\)\\>\\s-*\\(\\sw+\\)"
'(1 font-lock-keyword-face)
'(3 font-lock-function-name-face 'prepend))
;; Fontify function definitions
(list
(concat "\\<function\\>\\s-+\\(integer\\|real\\(time\\)?\\|time\\)\\s-+\\(\\sw+\\)" )
'(1 font-lock-keyword-face)
'(3 font-lock-reference-face prepend)
)
'("\\<function\\>\\s-+\\(\\[[^]]+\\]\\)\\s-+\\(\\sw+\\)"
(1 font-lock-keyword-face)
(2 font-lock-reference-face append)
)
'("\\<function\\>\\s-+\\(\\sw+\\)"
1 'font-lock-reference-face append)
)))
(setq verilog-font-lock-keywords-2
(append verilog-font-lock-keywords-1
(list
;; Fontify pragmas
(concat "\\(//\\s-*" verilog-pragma-keywords "\\s-.*\\)")
;; Fontify escaped names
'("\\(\\\\\\S-*\\s-\\)" 0 font-lock-function-name-face)
;; Fontify macro definitions/ uses
'("`\\s-*[A-Za-z][A-Za-z0-9_]*" 0 font-lock-function-name-face)
;; Fontify delays/numbers
'("\\(@\\)\\|\\(#\\s-*\\(\\(\[0-9_.\]+\\('[hdxbo][0-9a-fA-F_xz]*\\)?\\)\\|\\(([^)]+)\\|\\sw+\\)\\)\\)"
0 font-lock-type-face append)
)))
(setq verilog-font-lock-keywords-3
(append verilog-font-lock-keywords-2
(when verilog-highlight-translate-off
(list
;; Fontify things in translate off regions
'(verilog-match-translate-off (0 'verilog-font-lock-translate-off-face prepend))
)))
)
)
;;
;; Macros
;;
(defsubst verilog-string-replace-matches (from-string to-string fixedcase literal string)
"Replace occurrences of FROM-STRING with TO-STRING.
FIXEDCASE and LITERAL as in `replace-match`. STRING is what to replace.
The case (verilog-string-replace-matches \"o\" \"oo\" nil nil \"foobar\")
will break, as the o's continuously replace. xa -> x works ok though."
;; Hopefully soon to a emacs built-in
(let ((start 0))
(while (string-match from-string string start)
(setq string (replace-match to-string fixedcase literal string)
start (min (length string) (match-end 0))))
string))
(defsubst verilog-string-remove-spaces (string)
"Remove spaces surrounding STRING."
(save-match-data
(setq string (verilog-string-replace-matches "^\\s-+" "" nil nil string))
(setq string (verilog-string-replace-matches "\\s-+$" "" nil nil string))
string))
(defsubst verilog-re-search-forward (REGEXP BOUND NOERROR)
; checkdoc-params: (REGEXP BOUND NOERROR)
"Like `re-search-forward', but skips over match in comments or strings."
(store-match-data '(nil nil))
(while (and
(re-search-forward REGEXP BOUND NOERROR)
(and (verilog-skip-forward-comment-or-string)
(progn
(store-match-data '(nil nil))
(if BOUND
(< (point) BOUND)
t)
))))
(match-end 0))
(defsubst verilog-re-search-backward (REGEXP BOUND NOERROR)
; checkdoc-params: (REGEXP BOUND NOERROR)
"Like `re-search-backward', but skips over match in comments or strings."
(store-match-data '(nil nil))
(while (and
(re-search-backward REGEXP BOUND NOERROR)
(and (verilog-skip-backward-comment-or-string)
(progn
(store-match-data '(nil nil))
(if BOUND
(> (point) BOUND)
t)
))))
(match-end 0))
(defsubst verilog-re-search-forward-quick (regexp bound noerror)
"Like `verilog-re-search-forward', including use of REGEXP BOUND and NOERROR,
but trashes match data and is faster for REGEXP that doesn't match often.
This may at some point use text properties to ignore comments,
so there may be a large up front penalty for the first search."
(let (pt)
(while (and (not pt)
(re-search-forward regexp bound noerror))
(if (not (verilog-inside-comment-p))
(setq pt (match-end 0))))
pt))
(defsubst verilog-re-search-backward-quick (regexp bound noerror)
; checkdoc-params: (REGEXP BOUND NOERROR)
"Like `verilog-re-search-backward', including use of REGEXP BOUND and NOERROR,
but trashes match data and is faster for REGEXP that doesn't match often.
This may at some point use text properties to ignore comments,
so there may be a large up front penalty for the first search."
(let (pt)
(while (and (not pt)
(re-search-backward regexp bound noerror))
(if (not (verilog-inside-comment-p))
(setq pt (match-end 0))))
pt))
(defsubst verilog-get-beg-of-line (&optional arg)
(save-excursion
(beginning-of-line arg)
(point)))
(defsubst verilog-get-end-of-line (&optional arg)
(save-excursion
(end-of-line arg)
(point)))
(defun verilog-inside-comment-p ()
"Check if point inside a nested comment."
(save-excursion
(let ((st-point (point)) hitbeg)
(or (search-backward "//" (verilog-get-beg-of-line) t)
(if (progn
;; This is for tricky case //*, we keep searching if /* is proceeded by // on same line
(while (and (setq hitbeg (search-backward "/*" nil t))
(progn (forward-char 1) (search-backward "//" (verilog-get-beg-of-line) t))))
hitbeg)
(not (search-forward "*/" st-point t)))))))
(defun verilog-declaration-end ()
(search-forward ";"))
(defun verilog-point-text (&optional pointnum)
"Return text describing where POINTNUM or current point is (for errors).
Use filename, if current buffer being edited shorten to just buffer name."
(concat (or (and (equal (window-buffer (selected-window)) (current-buffer))
(buffer-name))
buffer-file-name
(buffer-name))
":" (int-to-string (count-lines (point-min) (or pointnum (point))))))
(defun electric-verilog-backward-sexp ()
"Move backward over a sexp."
(interactive)
;; before that see if we are in a comment
(verilog-backward-sexp)
)
(defun electric-verilog-forward-sexp ()
"Move backward over a sexp."
(interactive)
;; before that see if we are in a comment
(verilog-forward-sexp)
)
(defun verilog-backward-sexp ()
(let ((reg)
(elsec 1)
(found nil)
(st (point))
)
(if (not (looking-at "\\<"))
(forward-word -1))
(cond
((verilog-skip-backward-comment-or-string)
)
((looking-at "\\<else\\>")
(setq reg (concat
verilog-end-block-re
"\\|\\(\\<else\\>\\)"
"\\|\\(\\<if\\>\\)"
))
(while (and (not found)
(verilog-re-search-backward reg nil 'move))
(cond
((match-end 1) ; endblock
; try to leap back to matching outward block by striding across
; indent level changing tokens then immediately
; previous line governs indentation.
(verilog-leap-to-head))
((match-end 2) ; else, we're in deep
(setq elsec (1+ elsec)))
((match-end 3) ; found it
(setq elsec (1- elsec))
(if (= 0 elsec)
;; Now previous line describes syntax
(setq found 't)
))
)
)
)
((looking-at verilog-end-block-re)
(verilog-leap-to-head))
((looking-at "\\(endmodule\\>\\)\\|\\(\\<endprimitive\\>\\)")
(cond
((match-end 1)
(verilog-re-search-backward "\\<\\(macro\\)?module\\>" nil 'move))
((match-end 2)
(verilog-re-search-backward "\\<primitive\\>" nil 'move))
(t
(goto-char st)
(backward-sexp 1))))
(t
(goto-char st)
(backward-sexp))
) ;; cond
))
(defun verilog-forward-sexp ()
(let ((reg)
(st (point)))
(if (not (looking-at "\\<"))
(forward-word -1))
(cond
((verilog-skip-forward-comment-or-string)
(verilog-forward-syntactic-ws)
)
((looking-at verilog-beg-block-re-1);; begin|case|fork|table|specify|function|task|generate
(cond
((match-end 1) ; end
;; Search forward for matching begin
(setq reg "\\(\\<begin\\>\\)\\|\\(\\<end\\>\\)" ))
((match-end 2) ; endcase
;; Search forward for matching case
(setq reg "\\(\\<case[xz]?\\>[^:]\\)\\|\\(\\<endcase\\>\\)" ))
((match-end 3) ; join
;; Search forward for matching fork
(setq reg "\\(\\<fork\\>\\)\\|\\(\\<join\\>\\)" ))
((match-end 4) ; endtable
;; Search forward for matching table
(setq reg "\\(\\<table\\>\\)\\|\\(\\<endtable\\>\\)" ))
((match-end 5) ; endspecify
;; Search forward for matching specify
(setq reg "\\(\\<specify\\>\\)\\|\\(\\<endspecify\\>\\)" ))
((match-end 6) ; endfunction
;; Search forward for matching function
(setq reg "\\(\\<function\\>\\)\\|\\(\\<endfunction\\>\\)" ))
((match-end 7) ; endspecify
;; Search forward for matching task
(setq reg "\\(\\<task\\>\\)\\|\\(\\<endtask\\>\\)" ))
((match-end 8) ; endgenerate
;; Search forward for matching generate
(setq reg "\\(\\<generate\\>\\)\\|\\(\\<endgenerate\\>\\)" ))
)
(if (forward-word 1)
(catch 'skip
(let ((nest 1))
(while (verilog-re-search-forward reg nil 'move)
(cond
((match-end 2) ; end
(setq nest (1- nest))
(if (= 0 nest)
(throw 'skip 1)))
((match-end 1) ; begin
(setq nest (1+ nest)))))
)))
)
((looking-at "\\(\\<\\(macro\\)?module\\>\\)\\|\\(\\<primitive\\>\\)")
(cond
((match-end 1)
(verilog-re-search-forward "\\<endmodule\\>" nil 'move))
((match-end 2)
(verilog-re-search-forward "\\<endprimitive\\>" nil 'move))
(t
(goto-char st)
(if (= (following-char) ?\) )
(forward-char 1)
(forward-sexp 1)))))
(t
(goto-char st)
(if (= (following-char) ?\) )
(forward-char 1)
(forward-sexp 1)))
) ;; cond
))
(defun verilog-declaration-beg ()
(verilog-re-search-backward verilog-declaration-re (bobp) t))
(defsubst verilog-within-string ()
(save-excursion
(nth 3 (parse-partial-sexp (verilog-get-beg-of-line) (point)))))
(require 'font-lock)
(defvar verilog-need-fld 1)
(defvar font-lock-defaults-alist nil) ;In case we are XEmacs
(defun verilog-font-lock-init ()
"Initialize fontification."
;; highlight keywords and standardized types, attributes, enumeration
;; values, and subprograms
(setq verilog-font-lock-keywords-3
(append verilog-font-lock-keywords-2
(when verilog-highlight-translate-off
(list
;; Fontify things in translate off regions
'(verilog-match-translate-off (0 'verilog-font-lock-translate-off-face prepend))
))
)
)
(put 'verilog-mode 'font-lock-defaults
'((verilog-font-lock-keywords
verilog-font-lock-keywords-1
verilog-font-lock-keywords-2
verilog-font-lock-keywords-3
)
nil ;; nil means highlight strings & comments as well as keywords
nil ;; nil means keywords must match case
nil ;; syntax table handled elsewhere
verilog-beg-of-defun ;; function to move to beginning of reasonable region to highlight
))
(if verilog-need-fld
(let ((verilog-mode-defaults
'((verilog-font-lock-keywords
verilog-font-lock-keywords-1
verilog-font-lock-keywords-2
verilog-font-lock-keywords-3
)
nil ;; nil means highlight strings & comments as well as keywords
nil ;; nil means keywords must match case
nil ;; syntax table handled elsewhere
verilog-beg-of-defun ;; function to move to beginning of reasonable region to highlight
)))
(setq font-lock-defaults-alist
(append
font-lock-defaults-alist
(list (cons 'verilog-mode verilog-mode-defaults))))
(setq verilog-need-fld 0))))
;; initialize fontification for Verilog Mode
(verilog-font-lock-init)
;;
;;
;; Mode
;;
;;###autoload
(defun verilog-mode ()
"Major mode for editing Verilog code.
\\<verilog-mode-map>
NEWLINE, TAB indents for Verilog code.
Delete converts tabs to spaces as it moves back.
Supports highlighting.
Variables controlling indentation/edit style:
variable `verilog-indent-level' (default 3)
Indentation of Verilog statements with respect to containing block.
`verilog-indent-level-module' (default 3)
Absolute indentation of Module level Verilog statements.
Set to 0 to get initial and always statements lined up
on the left side of your screen.
`verilog-indent-level-declaration' (default 3)
Indentation of declarations with respect to containing block.
Set to 0 to get them list right under containing block.
`verilog-indent-level-behavioral' (default 3)
Indentation of first begin in a task or function block
Set to 0 to get such code to lined up underneath the task or function keyword
`verilog-indent-level-directive' (default 1)
Indentation of `ifdef/`endif blocks
`verilog-cexp-indent' (default 1)
Indentation of Verilog statements broken across lines i.e.:
if (a)
begin
`verilog-case-indent' (default 2)
Indentation for case statements.
`verilog-auto-newline' (default nil)
Non-nil means automatically newline after semicolons and the punctuation
mark after an end.
`verilog-auto-indent-on-newline' (default t)
Non-nil means automatically indent line after newline
`verilog-tab-always-indent' (default t)
Non-nil means TAB in Verilog mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
`verilog-indent-begin-after-if' (default t)
Non-nil means to indent begin statements following a preceding
if, else, while, for and repeat statements, if any. otherwise,
the begin is lined up with the preceding token. If t, you get:
if (a)
begin // amount of indent based on `verilog-cexp-indent'
otherwise you get:
if (a)
begin
`verilog-auto-endcomments' (default t)
Non-nil means a comment /* ... */ is set after the ends which ends
cases, tasks, functions and modules.
The type and name of the object will be set between the braces.
`verilog-minimum-comment-distance' (default 10)
Minimum distance (in lines) between begin and end required before a comment
will be inserted. Setting this variable to zero results in every
end acquiring a comment; the default avoids too many redundant
comments in tight quarters.
`verilog-auto-lineup' (default `(all))
List of contexts where auto lineup of :'s or ='s should be done.
Turning on Verilog mode calls the value of the variable `verilog-mode-hook' with
no args, if that value is non-nil.
Other useful functions are:
\\[verilog-complete-word]\t-complete word with appropriate possibilities
(functions, verilog keywords...)
\\[verilog-comment-region]\t- Put marked area in a comment, fixing
nested comments.
\\[verilog-uncomment-region]\t- Uncomment an area commented with \
\\[verilog-comment-region].
\\[verilog-insert-block]\t- insert begin ... end;
\\[verilog-star-comment]\t- insert /* ... */
\\[verilog-mark-defun]\t- Mark function.
\\[verilog-beg-of-defun]\t- Move to beginning of current function.
\\[verilog-end-of-defun]\t- Move to end of current function.
\\[verilog-label-be]\t- Label matching begin ... end, fork ... join
and case ... endcase statements;
\\[verilog-sk-always] Insert a always @(AS) begin .. end block
\\[verilog-sk-begin] Insert a begin .. end block
\\[verilog-sk-case] Insert a case block, prompting for details
\\[verilog-sk-else] Insert an else begin .. end block
\\[verilog-sk-for] Insert a for (...) begin .. end block, prompting for details
\\[verilog-sk-generate] Insert a generate .. endgenerate block
\\[verilog-sk-header] Insert a nice header block at the top of file
\\[verilog-sk-initial] Insert an initial begin .. end block
\\[verilog-sk-fork] Insert a fork begin .. end .. join block
\\[verilog-sk-module] Insert a module .. (/*AUTOARG*/);.. endmodule block
\\[verilog-sk-primitive] Insert a primitive .. (.. );.. endprimitive block
\\[verilog-sk-repeat] Insert a repeat (..) begin .. end block
\\[verilog-sk-specify] Insert a specify .. endspecify block
\\[verilog-sk-task] Insert a task .. begin .. end endtask block
\\[verilog-sk-while] Insert a while (...) begin .. end block, prompting for details
\\[verilog-sk-casex] Insert a casex (...) item: begin.. end endcase block, prompting for details
\\[verilog-sk-casez] Insert a casez (...) item: begin.. end endcase block, prompting for details
\\[verilog-sk-if] Insert an if (..) begin .. end block
\\[verilog-sk-else-if] Insert an else if (..) begin .. end block
\\[verilog-sk-comment] Insert a comment block
\\[verilog-sk-assign] Insert an assign .. = ..; statement
\\[verilog-sk-function] Insert a function .. begin .. end endfunction block
\\[verilog-sk-input] Insert an input declaration, prompting for details
\\[verilog-sk-output] Insert an output declaration, prompting for details
\\[verilog-sk-state-machine] Insert a state machine definition, prompting for details!
\\[verilog-sk-inout] Insert an inout declaration, prompting for details
\\[verilog-sk-wire] Insert a wire declaration, prompting for details
\\[verilog-sk-reg] Insert a register declaration, prompting for details"
(interactive)
(kill-all-local-variables)
(use-local-map verilog-mode-map)
(setq major-mode 'verilog-mode)
(setq mode-name "Verilog")
(setq local-abbrev-table verilog-mode-abbrev-table)
(setq verilog-mode-syntax-table (make-syntax-table))
(verilog-populate-syntax-table verilog-mode-syntax-table)
;; add extra comment syntax
(verilog-setup-dual-comments verilog-mode-syntax-table)
(set-syntax-table verilog-mode-syntax-table)
(make-local-variable 'indent-line-function)
(setq indent-line-function 'verilog-indent-line-relative)
(setq comment-indent-function 'verilog-comment-indent)
(make-local-variable 'parse-sexp-ignore-comments)
(setq parse-sexp-ignore-comments nil)
(make-local-variable 'comment-start)
(make-local-variable 'comment-end)
(make-local-variable 'comment-multi-line)
(make-local-variable 'comment-start-skip)
(setq comment-start "// "
comment-end ""
comment-start-skip "/\\*+ *\\|// *"
comment-multi-line nil)
;; Set up for compilation
(setq verilog-which-tool 1)
(setq verilog-tool 'verilog-linter)
(verilog-set-compile-command)
;; Setting up things for font-lock
(if verilog-running-on-xemacs
(progn
(if (and current-menubar
(not (assoc "Verilog" current-menubar)))
(progn
;; (set-buffer-menubar (copy-sequence current-menubar))
(add-submenu nil verilog-xemacs-menu))) ))
;; Stuff for GNU emacs
(make-local-variable 'font-lock-defaults)
;; Tell imenu how to handle verilog.
(make-local-variable 'imenu-generic-expression)
(setq imenu-generic-expression verilog-imenu-generic-expression)
;; Stuff for autos
(add-hook 'write-contents-hooks 'verilog-auto-save-check) ; already local
(run-hooks 'verilog-mode-hook))
;;
;; Electric functions
;;
(defun electric-verilog-terminate-line (&optional arg)
"Terminate line and indent next line.
With optional ARG, remove existing end of line comments."
(interactive)
;; before that see if we are in a comment
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(cond
((nth 7 state) ; Inside // comment
(if (eolp)
(progn
(delete-horizontal-space)
(newline))
(progn
(newline)
(insert-string "// ")
(beginning-of-line)))
(verilog-indent-line))
((nth 4 state) ; Inside any comment (hence /**/)
(newline)
(verilog-more-comment))
((eolp)
;; First, check if current line should be indented
(if (save-excursion
(delete-horizontal-space)
(beginning-of-line)
(skip-chars-forward " \t")
(if (looking-at verilog-autoindent-lines-re)
(let ((indent-str (verilog-indent-line)))
;; Maybe we should set some endcomments
(if verilog-auto-endcomments
(verilog-set-auto-endcomments indent-str arg))
(end-of-line)
(delete-horizontal-space)
(if arg
()
(newline))
nil)
(progn
(end-of-line)
(delete-horizontal-space)
't
)))
(newline)
(forward-line 1)
)
;; Indent next line
(if verilog-auto-indent-on-newline
(verilog-indent-line))
)
(t
(newline))
)))
(defun electric-verilog-semi ()
"Insert `;' character and reindent the line."
(interactive)
(insert last-command-char)
(if (or (verilog-in-comment-or-string-p)
(verilog-in-escaped-name-p))
()
(save-excursion
(beginning-of-line)
(verilog-forward-ws&directives)
(verilog-indent-line))
(if (and verilog-auto-newline
(not (verilog-parenthesis-depth)))
(electric-verilog-terminate-line))))
(defun electric-verilog-semi-with-comment ()
"Insert `;' character, reindent the line and indent for comment."
(interactive)
(insert "\;")
(save-excursion
(beginning-of-line)
(verilog-indent-line))
(indent-for-comment))
(defun electric-verilog-colon ()
"Insert `:' and do all indentations except line indent on this line."
(interactive)
(insert last-command-char)
;; Do nothing if within string.
(if (or
(verilog-within-string)
(not (verilog-in-case-region-p)))
()
(save-excursion
(let ((p (point))
(lim (progn (verilog-beg-of-statement) (point))))
(goto-char p)
(verilog-backward-case-item lim)
(verilog-indent-line)))
;; (let ((verilog-tab-always-indent nil))
;; (verilog-indent-line))
))
(defun electric-verilog-equal ()
"Insert `=', and do indentation if within block."
(interactive)
(insert last-command-char)
;; Could auto line up expressions, but not yet
;; (if (eq (car (verilog-calculate-indent)) 'block)
;; (let ((verilog-tab-always-indent nil))
;; (verilog-indent-command)))
)
(defun electric-verilog-tick ()
"Insert back-tick, and indent to column 0 if this is a CPP directive."
(interactive)
(insert last-command-char)
(save-excursion
(if (progn
(beginning-of-line)
(looking-at verilog-directive-re-1))
(verilog-indent-line))))
(defun electric-verilog-tab ()
"Function called when TAB is pressed in Verilog mode."
(interactive)
;; If verilog-tab-always-indent, indent the beginning of the line.
(if (or verilog-tab-always-indent
(save-excursion
(skip-chars-backward " \t")
(bolp)))
(let* ((oldpnt (point))
(boi-point
(save-excursion
(beginning-of-line)
(skip-chars-forward " \t")
(let (type state )
(setq type (verilog-indent-line))
(setq state (car type))
(cond
((eq state 'block)
(if (looking-at verilog-behavioral-block-beg-re )
(error
(concat
(verilog-point-text)
": The reserved word \""
(buffer-substring (match-beginning 0) (match-end 0))
"\" must be at the behavioral level!"))))
))
(back-to-indentation)
(point))))
(if (< (point) boi-point)
(back-to-indentation)
(cond ((not verilog-tab-to-comment))
((not (eolp))
(end-of-line))
(t
(indent-for-comment)
(when (and (eolp) (= oldpnt (point)))
; kill existing comment
(beginning-of-line)
(re-search-forward comment-start-skip oldpnt 'move)
(goto-char (match-beginning 0))
(skip-chars-backward " \t")
(kill-region (point) oldpnt)
))))
)
(progn (insert "\t"))))
;;
;; Interactive functions
;;
(defun verilog-insert-block ()
"Insert Verilog begin ... end; block in the code with right indentation."
(interactive)
(verilog-indent-line)
(insert "begin")
(electric-verilog-terminate-line)
(save-excursion
(electric-verilog-terminate-line)
(insert "end")
(beginning-of-line)
(verilog-indent-line)))
(defun verilog-star-comment ()
"Insert Verilog star comment at point."
(interactive)
(verilog-indent-line)
(insert "/*")
(save-excursion
(newline)
(insert " */"))
(newline)
(insert " * "))
(defun verilog-insert-indices (MAX)
"Insert a set of indices at into the rectangle.
The upper left corner is defined by the current point. Indices always
begin with 0 and extend to the MAX - 1. If no prefix arg is given, the
user is prompted for a value. The indices are surrounded by square brackets
[]. For example, the following code with the point located after the first
'a' gives:
a = b a[ 0] = b
a = b a[ 1] = b
a = b a[ 2] = b
a = b a[ 3] = b
a = b ==> insert-indices ==> a[ 4] = b
a = b a[ 5] = b
a = b a[ 6] = b
a = b a[ 7] = b
a = b a[ 8] = b"
(interactive "MAX?")
(save-excursion
(let ((n 0))
(while (< n MAX)
(save-excursion
(insert (format "[%3d]" n)))
(next-line 1)
(setq n (1+ n))))))
(defun verilog-generate-numbers (MAX)
"Insert a set of generated numbers into a rectangle.
The upper left corner is defined by point. The numbers are padded to three
digits, starting with 000 and extending to (MAX - 1). If no prefix argument
is supplied, then the user is prompted for the MAX number. consider the
following code fragment:
buf buf buf buf000
buf buf buf buf001
buf buf buf buf002
buf buf buf buf003
buf buf ==> insert-indices ==> buf buf004
buf buf buf buf005
buf buf buf buf006
buf buf buf buf007
buf buf buf buf008"
(interactive "NMAX?")
(save-excursion
(let ((n 0))
(while (< n MAX)
(save-excursion
(insert (format "%3.3d" n)))
(next-line 1)
(setq n (1+ n))))))
(defun verilog-mark-defun ()
"Mark the current verilog function (or procedure).
This puts the mark at the end, and point at the beginning."
(interactive)
(push-mark (point))
(verilog-end-of-defun)
(push-mark (point))
(verilog-beg-of-defun)
(zmacs-activate-region))
(defun verilog-comment-region (start end)
; checkdoc-params: (start end)
"Put the region into a Verilog comment.
The comments that are in this area are \"deformed\":
`*)' becomes `!(*' and `}' becomes `!{'.
These deformed comments are returned to normal if you use
\\[verilog-uncomment-region] to undo the commenting.
The commented area starts with `verilog-exclude-str-start', and ends with
`verilog-include-str-end'. But if you change these variables,
\\[verilog-uncomment-region] won't recognize the comments."
(interactive "r")
(save-excursion
;; Insert start and endcomments
(goto-char end)
(if (and (save-excursion (skip-chars-forward " \t") (eolp))
(not (save-excursion (skip-chars-backward " \t") (bolp))))
(forward-line 1)
(beginning-of-line))
(insert verilog-exclude-str-end)
(setq end (point))
(newline)
(goto-char start)
(beginning-of-line)
(insert verilog-exclude-str-start)
(newline)
;; Replace end-comments within commented area
(goto-char end)
(save-excursion
(while (re-search-backward "\\*/" start t)
(replace-match "*-/" t t)))
(save-excursion
(let ((s+1 (1+ start)))
(while (re-search-backward "/\\*" s+1 t)
(replace-match "/-*" t t))))
))
(defun verilog-uncomment-region ()
"Uncomment a commented area; change deformed comments back to normal.
This command does nothing if the pointer is not in a commented
area. See also `verilog-comment-region'."
(interactive)
(save-excursion
(let ((start (point))
(end (point)))
;; Find the boundaries of the comment
(save-excursion
(setq start (progn (search-backward verilog-exclude-str-start nil t)
(point)))
(setq end (progn (search-forward verilog-exclude-str-end nil t)
(point))))
;; Check if we're really inside a comment
(if (or (equal start (point)) (<= end (point)))
(message "Not standing within commented area.")
(progn
;; Remove endcomment
(goto-char end)
(beginning-of-line)
(let ((pos (point)))
(end-of-line)
(delete-region pos (1+ (point))))
;; Change comments back to normal
(save-excursion
(while (re-search-backward "\\*-/" start t)
(replace-match "*/" t t)))
(save-excursion
(while (re-search-backward "/-\\*" start t)
(replace-match "/*" t t)))
;; Remove start comment
(goto-char start)
(beginning-of-line)
(let ((pos (point)))
(end-of-line)
(delete-region pos (1+ (point)))))))))
(defun verilog-beg-of-defun ()
"Move backward to the beginning of the current function or procedure."
(interactive)
(verilog-re-search-backward verilog-defun-re nil 'move))
(defun verilog-end-of-defun ()
"Move forward to the end of the current function or procedure."
(interactive)
(verilog-re-search-forward verilog-end-defun-re nil 'move))
(defun verilog-get-beg-of-defun (&optional warn)
(save-excursion
(cond ((verilog-re-search-forward-quick verilog-defun-re nil t)
(point))
(t
(error "%s: Can't find module beginning" (verilog-point-text))
(point-max)))))
(defun verilog-get-end-of-defun (&optional warn)
(save-excursion
(cond ((verilog-re-search-forward-quick verilog-end-defun-re nil t)
(point))
(t
(error "%s: Can't find endmodule" (verilog-point-text))
(point-max)))))
(defun verilog-label-be (&optional arg)
"Label matching begin ... end, fork ... join and case ... endcase statements.
With ARG, first kill any existing labels."
(interactive)
(let ((cnt 0)
(oldpos (point))
(b (progn
(verilog-beg-of-defun)
(point-marker)))
(e (progn
(verilog-end-of-defun)
(point-marker)))
)
(goto-char (marker-position b))
(if (> (- e b) 200)
(message "Relabeling module..."))
(while (and
(> (marker-position e) (point))
(verilog-re-search-forward
(concat
"\\<end\\(\\(function\\)\\|\\(task\\)\\|\\(module\\)\\|"
"\\(primitive\\)\\|\\(case\\)\\)?\\>"
"\\|\\(`endif\\)\\|\\(`else\\)")
nil 'move))
(goto-char (match-beginning 0))
(let ((indent-str (verilog-indent-line)))
(verilog-set-auto-endcomments indent-str 't)
(end-of-line)
(delete-horizontal-space)
)
(setq cnt (1+ cnt))
(if (= 9 (% cnt 10))
(message "%d..." cnt))
)
(goto-char oldpos)
(if (or
(> (- e b) 200)
(> cnt 20))
(message "%d lines auto commented" cnt))
))
(defun verilog-beg-of-statement ()
"Move backward to beginning of statement."
(interactive)
(while (save-excursion
(and
(not (looking-at verilog-complete-reg))
(verilog-backward-syntactic-ws)
(not (or (bolp) (= (preceding-char) ?\;)))
))
(skip-chars-backward " \t")
(verilog-backward-token))
(let ((last (point)))
(while (progn
(setq last (point))
(and (not (looking-at verilog-complete-reg))
(verilog-continued-line))))
(goto-char last)
(verilog-forward-syntactic-ws)))
(defun verilog-beg-of-statement-1 ()
"Move backward to beginning of statement."
(interactive)
(let ((pt (point)))
(while (and (not (looking-at verilog-complete-reg))
(setq pt (point))
(verilog-backward-token)
(verilog-backward-syntactic-ws)
(setq pt (point))
(not (bolp))
(not (= (preceding-char) ?\;))))
(while (progn
(setq pt (point))
(and (not (looking-at verilog-complete-reg))
(not (= (preceding-char) ?\;))
(verilog-continued-line))))
(goto-char pt)
(verilog-forward-ws&directives)))
(defun verilog-end-of-statement ()
"Move forward to end of current statement."
(interactive)
(let ((nest 0) pos)
(or (looking-at verilog-beg-block-re)
;; Skip to end of statement
(setq pos (catch 'found
(while t
(forward-sexp 1)
(verilog-skip-forward-comment-or-string)
(cond ((looking-at "[ \t]*;")
(skip-chars-forward "^;")
(forward-char 1)
(throw 'found (point)))
((save-excursion
(forward-sexp -1)
(looking-at verilog-beg-block-re))
(goto-char (match-beginning 0))
(throw 'found nil))
((eobp)
(throw 'found (point))))))))
(if (not pos)
;; Skip a whole block
(catch 'found
(while t
(verilog-re-search-forward verilog-end-statement-re nil 'move)
(setq nest (if (match-end 1)
(1+ nest)
(1- nest)))
(cond ((eobp)
(throw 'found (point)))
((= 0 nest)
(throw 'found (verilog-end-of-statement))))))
pos)))
(defun verilog-in-case-region-p ()
"Return TRUE if in a case region;
more specifically, point @ in the line foo : @ begin"
(interactive)
(save-excursion
(if (and
(progn (verilog-forward-syntactic-ws)
(looking-at "\\<begin\\>"))
(progn (verilog-backward-syntactic-ws)
(= (preceding-char) ?\:)))
(catch 'found
(let ((nest 1))
(while t
(verilog-re-search-backward
(concat "\\(\\<module\\>\\)\\|\\(\\<case[xz]?\\>[^:]\\)\\|"
"\\(\\<endcase\\>\\)\\>")
nil 'move)
(cond
((match-end 3)
(setq nest (1+ nest)))
((match-end 2)
(if (= nest 1)
(throw 'found 1))
(setq nest (1- nest)))
(t
(throw 'found (= nest 0)))
))))
nil)))
(defun verilog-in-fork-region-p ()
"Return true if between a fork and join."
(interactive)
(let ((lim (save-excursion (verilog-beg-of-defun) (point)))
(nest 1)
)
(save-excursion
(while (and
(/= nest 0)
(verilog-re-search-backward "\\<\\(fork\\)\\|\\(join\\)\\>" lim 'move)
(cond
((match-end 1) ; fork
(setq nest (1- nest)))
((match-end 2) ; join
(setq nest (1+ nest)))
))
))
(= nest 0) )) ; return nest
(defun verilog-backward-case-item (lim)
"Skip backward to nearest enclosing case item.
Limit search to point LIM."
(interactive)
(let ((str 'nil)
(lim1
(progn
(save-excursion
(verilog-re-search-backward verilog-endcomment-reason-re
lim 'move)
(point)))))
;; Try to find the real :
(if (save-excursion (search-backward ":" lim1 t))
(let ((colon 0)
b e )
(while
(and
(< colon 1)
(verilog-re-search-backward "\\(\\[\\)\\|\\(\\]\\)\\|\\(:\\)"
lim1 'move))
(cond
((match-end 1) ;; [
(setq colon (1+ colon))
(if (>= colon 0)
(error "%s: unbalanced [" (verilog-point-text))))
((match-end 2) ;; ]
(setq colon (1- colon)))
((match-end 3) ;; :
(setq colon (1+ colon)))
))
;; Skip back to beginning of case item
(skip-chars-backward "\t ")
(verilog-skip-backward-comment-or-string)
(setq e (point))
(setq b
(progn
(if
(verilog-re-search-backward
"\\<\\(case[zx]?\\)\\>\\|;\\|\\<end\\>" nil 'move)
(progn
(cond
((match-end 1)
(goto-char (match-end 1))
(verilog-forward-ws&directives)
(if (looking-at "(")
(progn
(forward-sexp)
(verilog-forward-ws&directives)))
(point))
(t
(goto-char (match-end 0))
(verilog-forward-ws&directives)
(point))
))
(error "Malformed case item")
)))
(setq str (buffer-substring b e))
(if
(setq e
(string-match
"[ \t]*\\(\\(\n\\)\\|\\(//\\)\\|\\(/\\*\\)\\)" str))
(setq str (concat (substring str 0 e) "...")))
str)
'nil)))
;;
;; Other functions
;;
(defun kill-existing-comment ()
"Kill auto comment on this line."
(save-excursion
(let* (
(e (progn
(end-of-line)
(point)))
(b (progn
(beginning-of-line)
(search-forward "//" e t))))
(if b
(delete-region (- b 2) e)))))
(defconst verilog-directive-nest-re
(concat "\\(`else\\>\\)\\|"
"\\(`endif\\>\\)\\|"
"\\(`if\\>\\)\\|"
"\\(`ifdef\\>\\)\\|"
"\\(`ifndef\\>\\)"))
(defun verilog-set-auto-endcomments (indent-str kill-existing-comment)
"Add ending comment with given INDENT-STR.
With KILL-EXISTING-COMMENT, remove what was there before.
Insert `// case: 7 ' or `// NAME ' on this line if appropriate.
Insert `// case expr ' if this line ends a case block.
Insert `// ifdef FOO ' if this line ends code conditional on FOO.
Insert `// NAME ' if this line ends a module or primitive named NAME."
(save-excursion
(cond
(; Comment close preprocessor directives
(and
(looking-at "\\(`endif\\)\\|\\(`else\\)")
(or kill-existing-comment
(not (save-excursion
(end-of-line)
(search-backward "//" (verilog-get-beg-of-line) t)))))
(let ((nest 1) b e
m
(else (if (match-end 2) "!" " "))
)
(end-of-line)
(if kill-existing-comment
(kill-existing-comment))
(delete-horizontal-space)
(save-excursion
(backward-sexp 1)
(while (and (/= nest 0)
(verilog-re-search-backward verilog-directive-nest-re nil 'move))
(cond
((match-end 1) ; `else
(if (= nest 1)
(setq else "!")))
((match-end 2) ; `endif
(setq nest (1+ nest)))
((match-end 3) ; `if
(setq nest (1- nest)))
((match-end 4) ; `ifdef
(setq nest (1- nest)))
((match-end 5) ; `ifndef
(setq nest (1- nest)))
))
(if (match-end 0)
(setq
m (buffer-substring
(match-beginning 0)
(match-end 0))
b (progn
(skip-chars-forward "^ \t")
(verilog-forward-syntactic-ws)
(point))
e (progn
(skip-chars-forward "a-zA-Z0-9_")
(point)
))))
(if b
(if (> (count-lines (point) b) verilog-minimum-comment-distance)
(insert (concat " // " else m " " (buffer-substring b e))))
(progn
(insert " // unmatched `else or `endif")
(ding 't))
)))
(; Comment close case/function/task/module and named block
(and (looking-at "\\<end")
(or kill-existing-comment
(not (save-excursion
(end-of-line)
(search-backward "//" (verilog-get-beg-of-line) t)))))
(let ((type (car indent-str)))
(if (eq type 'declaration)
()
(if
(looking-at verilog-enders-re)
(cond
(;- This is a case block; search back for the start of this case
(match-end 1)
(let ((err 't)
(str "UNMATCHED!!"))
(save-excursion
(verilog-leap-to-head)
(if (match-end 0)
(progn
(goto-char (match-end 1))
(setq str (concat (buffer-substring (match-beginning 1) (match-end 1))
(verilog-get-expr)))
(setq err nil))))
(end-of-line)
(if kill-existing-comment
(kill-existing-comment))
(delete-horizontal-space)
(insert (concat " // " str ))
(if err (ding 't))
))
(;- This is a begin..end block
(match-end 2)
(let ((str " // UNMATCHED !!")
(err 't)
(here (point))
there
cntx
)
(save-excursion
(verilog-leap-to-head)
(setq there (point))
(if (not (match-end 0))
(progn
(goto-char here)
(end-of-line)
(if kill-existing-comment
(kill-existing-comment))
(delete-horizontal-space)
(insert str)
(ding 't)
)
(let ((lim
(save-excursion (verilog-beg-of-defun) (point)))
(here (point))
)
(cond
(;-- handle named block differently
(looking-at verilog-named-block-re)
(search-forward ":")
(setq there (point))
(setq str (verilog-get-expr))
(setq err nil)
(setq str (concat " // block: " str )))
((verilog-in-case-region-p) ;-- handle case item differently
(goto-char here)
(setq str (verilog-backward-case-item lim))
(setq there (point))
(setq err nil)
(setq str (concat " // case: " str )))
(;- try to find "reason" for this begin
(cond
(;
(eq here (progn
(verilog-backward-token)
(verilog-beg-of-statement-1)
(point)))
(setq err nil)
(setq str ""))
((looking-at verilog-endcomment-reason-re)
(setq there (match-end 0))
(setq cntx (concat
(buffer-substring (match-beginning 0) (match-end 0)) " "))
(cond
(;- begin
(match-end 2)
(setq err nil)
(save-excursion
(if (and (verilog-continued-line)
(looking-at "\\<repeat\\>\\|\\<wait\\>\\|\\<always\\>"))
(progn
(goto-char (match-end 0))
(setq there (point))
(setq str
(concat " // "
(buffer-substring (match-beginning 0) (match-end 0)) " "
(verilog-get-expr))))
(setq str ""))))
(;- else
(match-end 4)
(let ((nest 0)
( reg "\\(\\<begin\\>\\)\\|\\(\\<end\\>\\)\\|\\(\\<if\\>\\)")
)
(catch 'skip
(while (verilog-re-search-backward reg nil 'move)
(cond
((match-end 1) ; begin
(setq nest (1- nest)))
((match-end 2) ; end
(setq nest (1+ nest)))
((match-end 3)
(if (= 0 nest)
(progn
(goto-char (match-end 0))
(setq there (point))
(setq err nil)
(setq str (verilog-get-expr))
(setq str (concat " // else: !if" str ))
(throw 'skip 1))
)))
))))
(;- end else
(match-end 5)
(goto-char there)
(let ((nest 0)
( reg "\\(\\<begin\\>\\)\\|\\(\\<end\\>\\)\\|\\(\\<if\\>\\)")
)
(catch 'skip
(while (verilog-re-search-backward reg nil 'move)
(cond
((match-end 1) ; begin
(setq nest (1- nest)))
((match-end 2) ; end
(setq nest (1+ nest)))
((match-end 3)
(if (= 0 nest)
(progn
(goto-char (match-end 0))
(setq there (point))
(setq err nil)
(setq str (verilog-get-expr))
(setq str (concat " // else: !if" str ))
(throw 'skip 1))
)))
))))
(;- task/function/initial et cetera
t
(match-end 0)
(goto-char (match-end 0))
(setq there (point))
(setq err nil)
(setq str (verilog-get-expr))
(setq str (concat " // " cntx str )))
(;-- otherwise...
(setq str " // auto-endcomment confused "))
))
((and
(verilog-in-case-region-p) ;-- handle case item differently
(progn
(setq there (point))
(goto-char here)
(setq str (verilog-backward-case-item lim))))
(setq err nil)
(setq str (concat " // case: " str )))
((verilog-in-fork-region-p)
(setq err nil)
(setq str " // fork branch" ))
((looking-at "\\<end\\>")
;; HERE
(forward-word 1)
(verilog-forward-syntactic-ws)
(setq err nil)
(setq str (verilog-get-expr))
(setq str (concat " // " cntx str )))
))))
(goto-char here)
(end-of-line)
(if kill-existing-comment
(kill-existing-comment))
(delete-horizontal-space)
(if (or err
(> (count-lines here there) verilog-minimum-comment-distance))
(insert str))
(if err (ding 't))
))))
(;- this is end{function,task,module}
t
(let (string reg (width nil))
(end-of-line)
(if kill-existing-comment
(save-match-data
(kill-existing-comment)))
(delete-horizontal-space)
(backward-sexp)
(cond
((match-end 5)
(setq reg "\\(\\<function\\>\\)\\|\\(\\<\\(endfunction\\|task\\|\\(macro\\)?module\\|primitive\\)\\>\\)")
(setq width "\\(\\s-*\\(\\[[^]]*\\]\\)\\|\\(real\\(time\\)?\\)\\|\\(integer\\)\\|\\(time\\)\\)?")
)
((match-end 6)
(setq reg "\\(\\<task\\>\\)\\|\\(\\<\\(endtask\\|function\\|\\(macro\\)?module\\|primitive\\)\\>\\)"))
((match-end 7)
(setq reg "\\(\\<\\(macro\\)?module\\>\\)\\|\\<endmodule\\>"))
((match-end 8)
(setq reg "\\(\\<primitive\\>\\)\\|\\(\\<\\(endprimitive\\|function\\|task\\|\\(macro\\)?module\\)\\>\\)"))
)
(let (b e)
(save-excursion
(verilog-re-search-backward reg nil 'move)
(cond
((match-end 1)
(setq b (progn
(skip-chars-forward "^ \t")
(verilog-forward-ws&directives)
(if (and width (looking-at width))
(progn
(goto-char (match-end 0))
(verilog-forward-ws&directives)
))
(point))
e (progn
(skip-chars-forward "a-zA-Z0-9_")
(point)))
(setq string (buffer-substring b e)))
(t
(ding 't)
(setq string "unmatched end(function|task|module|primitive)")))))
(end-of-line)
(insert (concat " // " string )))
)))))))))
(defun verilog-get-expr()
"Grab expression at point, e.g, case ( a | b & (c ^d))"
(let* ((b (progn
(verilog-forward-syntactic-ws)
(skip-chars-forward " \t")
(point)))
(e (let ((par 1))
(cond
((looking-at "@")
(forward-char 1)
(verilog-forward-syntactic-ws)
(if (looking-at "(")
(progn
(forward-char 1)
(while (and (/= par 0)
(verilog-re-search-forward "\\((\\)\\|\\()\\)" nil 'move))
(cond
((match-end 1)
(setq par (1+ par)))
((match-end 2)
(setq par (1- par)))))))
(point))
((looking-at "(")
(forward-char 1)
(while (and (/= par 0)
(verilog-re-search-forward "\\((\\)\\|\\()\\)" nil 'move))
(cond
((match-end 1)
(setq par (1+ par)))
((match-end 2)
(setq par (1- par)))))
(point))
((looking-at "\\[")
(forward-char 1)
(while (and (/= par 0)
(verilog-re-search-forward "\\(\\[\\)\\|\\(\\]\\)" nil 'move))
(cond
((match-end 1)
(setq par (1+ par)))
((match-end 2)
(setq par (1- par)))))
(verilog-forward-syntactic-ws)
(skip-chars-forward "^ \t\n")
(point))
((looking-at "/[/\\*]")
b)
('t
(skip-chars-forward "^: \t\n")
(point)
))))
(str (buffer-substring b e)))
(if (setq e (string-match "[ \t]*\\(\\(\n\\)\\|\\(//\\)\\|\\(/\\*\\)\\)" str))
(setq str (concat (substring str 0 e) "...")))
str))
(defun verilog-expand-vector ()
"Take a signal vector on the current line and expand it to multiple lines.
Useful for creating tri's and other expanded fields."
(interactive)
(verilog-expand-vector-internal "[" "]"))
(defun verilog-expand-vector-internal (bra ket)
"Given BRA, the start brace and KET, the end brace, expand one line into many lines."
(save-excursion
(forward-line 0)
(let ((signal-string (buffer-substring (point)
(progn
(end-of-line) (point)))))
(if (string-match (concat "\\(.*\\)"
(regexp-quote bra)
"\\([0-9]*\\)\\(:[0-9]*\\|\\)\\(::[0-9---]*\\|\\)"
(regexp-quote ket)
"\\(.*\\)$") signal-string)
(let* ((sig-head (match-string 1 signal-string))
(vec-start (string-to-int (match-string 2 signal-string)))
(vec-end (if (= (match-beginning 3) (match-end 3))
vec-start
(string-to-int (substring signal-string (1+ (match-beginning 3)) (match-end 3)))))
(vec-range (if (= (match-beginning 4) (match-end 4))
1
(string-to-int (substring signal-string (+ 2 (match-beginning 4)) (match-end 4)))))
(sig-tail (match-string 5 signal-string))
vec)
;; Decode vectors
(setq vec nil)
(if (< vec-range 0)
(let ((tmp vec-start))
(setq vec-start vec-end
vec-end tmp
vec-range (- vec-range))))
(if (< vec-end vec-start)
(while (<= vec-end vec-start)
(setq vec (append vec (list vec-start)))
(setq vec-start (- vec-start vec-range)))
(while (<= vec-start vec-end)
(setq vec (append vec (list vec-start)))
(setq vec-start (+ vec-start vec-range))))
;;
;; Delete current line
(delete-region (point) (progn (forward-line 0) (point)))
;;
;; Expand vector
(while vec
(insert (concat sig-head bra (int-to-string (car vec)) ket sig-tail "\n"))
(setq vec (cdr vec)))
(delete-char -1)
;;
)))))
(defun verilog-strip-comments ()
"Strip all comments from the verilog code."
(interactive)
(goto-char (point-min))
(while (re-search-forward "//" nil t)
(let ((bpt (- (point) 2)))
(end-of-line)
(delete-region bpt (point))))
;;
(goto-char (point-min))
(while (re-search-forward "/\\*" nil t)
(let ((bpt (- (point) 2)))
(re-search-forward "\\*/")
(delete-region bpt (point)))))
(defun verilog-one-line ()
"Converts structural verilog instances to occupy one line."
(interactive)
(goto-char (point-min))
(while (re-search-forward "\\([^;]\\)[ \t]*\n[ \t]*" nil t)
(replace-match "\\1 " nil nil)))
(defun verilog-linter-name ()
"Return name of linter, either surelint or verilint."
(let ((compile-word1 (verilog-string-replace-matches "\\s .*$" "" nil nil
compile-command))
(lint-word1 (verilog-string-replace-matches "\\s .*$" "" nil nil
verilog-linter)))
(cond ((equal compile-word1 "surelint") `surelint)
((equal compile-word1 "verilint") `verilint)
((equal lint-word1 "surelint") `surelint)
((equal lint-word1 "verilint") `verilint)
(t `surelint)))) ;; back compatibility
(defun verilog-lint-off ()
"Convert a Verilog linter warning line into a disable statement.
For example:
pci_bfm_null.v, line 46: Unused input: pci_rst_
becomes a comment for the appropriate tool.
The first word of the `compile-command' or `verilog-linter'
variables are used to determine which product is being used.
See \\[verilog-surelint-off] and \\[verilog-verilint-off]."
(interactive)
(let ((linter (verilog-linter-name)))
(cond ((equal linter `surelint)
(verilog-surelint-off))
((equal linter `verilint)
(verilog-verilint-off))
(t (error "Linter name not set")))))
(defun verilog-surelint-off ()
"Convert a SureLint warning line into a disable statement.
Run from Verilog source window; assumes there is a *compile* buffer
with point set appropriately.
For example:
WARNING [STD-UDDONX]: xx.v, line 8: output out is never assigned.
becomes:
// surefire lint_line_off UDDONX"
(interactive)
(save-excursion
(switch-to-buffer compilation-last-buffer)
(beginning-of-line)
(when
(looking-at "\\(INFO\\|WARNING\\|ERROR\\) \\[[^-]+-\\([^]]+\\)\\]: \\([^,]+\\), line \\([0-9]+\\): \\(.*\\)$")
(let* ((code (match-string 2))
(file (match-string 3))
(line (match-string 4))
(buffer (get-file-buffer file))
dir filename)
(unless buffer
(progn
(setq buffer
(and (file-exists-p file)
(find-file-noselect file)))
(or buffer
(let* ((pop-up-windows t))
(let ((name (expand-file-name
(read-file-name
(format "Find this error in: (default %s) "
file)
dir file t))))
(if (file-directory-p name)
(setq name (expand-file-name filename name)))
(setq buffer
(and (file-exists-p name)
(find-file-noselect name))))))))
(switch-to-buffer buffer)
(goto-line (string-to-number line))
(end-of-line)
(catch 'already
(cond
((verilog-in-slash-comment-p)
(re-search-backward "//")
(cond
((looking-at "// surefire lint_off_line ")
(goto-char (match-end 0))
(let ((lim (save-excursion (end-of-line) (point))))
(if (re-search-forward code lim 'move)
(throw 'already t)
(insert-string (concat " " code)))))
(t
)))
((verilog-in-star-comment-p)
(re-search-backward "/\*")
(insert-string (format " // surefire lint_off_line %6s" code ))
)
(t
(insert-string (format " // surefire lint_off_line %6s" code ))
)))))))
(defun verilog-verilint-off ()
"Convert a Verilint warning line into a disable statement.
For example:
(W240) pci_bfm_null.v, line 46: Unused input: pci_rst_
becomes:
//Verilint 240 off // WARNING: Unused input"
(interactive)
(save-excursion
(beginning-of-line)
(when (looking-at "\\(.*\\)([WE]\\([0-9A-Z]+\\)).*,\\s +line\\s +[0-9]+:\\s +\\([^:\n]+\\):?.*$")
(replace-match (format
;; %3s makes numbers 1-999 line up nicely
"\\1//Verilint %3s off // WARNING: \\3"
(match-string 2)))
(beginning-of-line)
(verilog-indent-line))))
(defun verilog-auto-save-compile ()
"Update automatics with \\[verilog-auto], save the buffer, and compile."
(interactive)
(verilog-auto) ; Always do it for safety
(save-buffer)
(compile compile-command))
;;
;; Indentation
;;
(defconst verilog-indent-alist
'((block . (+ ind verilog-indent-level))
(case . (+ ind verilog-case-indent))
(cparenexp . (+ ind verilog-indent-level))
(cexp . (+ ind verilog-cexp-indent))
(defun . verilog-indent-level-module)
(declaration . verilog-indent-level-declaration)
(directive . (verilog-calculate-indent-directive))
(tf . verilog-indent-level)
(behavioral . (+ verilog-indent-level-behavioral verilog-indent-level-module))
(statement . ind)
(cpp . 0)
(comment . (verilog-comment-indent))
(unknown . 3)
(string . 0)))
(defun verilog-continued-line-1 (lim)
"Return true if this is a continued line.
Set point to where line starts. Limit search to point LIM."
(let ((continued 't))
(if (eq 0 (forward-line -1))
(progn
(end-of-line)
(verilog-backward-ws&directives lim)
(if (bobp)
(setq continued nil)
(setq continued (verilog-backward-token))))
(setq continued nil))
continued))
(defun verilog-calculate-indent ()
"Calculate the indent of the current Verilog line.
Examine previous lines. Once a line is found that is definitive as to the
type of the current line, return that lines' indent level and its
type. Return a list of two elements: (INDENT-TYPE INDENT-LEVEL)."
(save-excursion
(let* ((starting_position (point))
(par 0)
(begin (looking-at "[ \t]*begin\\>"))
(lim (save-excursion (verilog-re-search-backward "\\(\\<begin\\>\\)\\|\\(\\<module\\>\\)" nil t)))
(type (catch 'nesting
;; Keep working backwards until we can figure out
;; what type of statement this is.
;; Basically we need to figure out
;; 1) if this is a continuation of the previous line;
;; 2) are we in a block scope (begin..end)
;; if we are in a comment, done.
(if (verilog-in-star-comment-p) (throw 'nesting 'comment))
;; if we are in a parenthesized list, and the user likes to indent
;; these, return.
(if (and verilog-indent-lists
(verilog-in-paren))
(progn (setq par 1) (throw 'nesting 'block)))
; (if (/= 0 (verilog-parenthesis-depth)) (progn (setq par 1) (throw 'nesting 'block)))
;; if we have a directive, done.
(if (save-excursion
(beginning-of-line)
(looking-at verilog-directive-re-1))
(throw 'nesting 'directive))
;; See if we are continuing a previous line
(while t
;; trap out if we crawl off the top of the buffer
(if (bobp) (throw 'nesting 'cpp))
(if (verilog-continued-line-1 lim)
(let ((sp (point)))
(if (and
(not (looking-at verilog-complete-reg))
(verilog-continued-line-1 lim))
(progn (goto-char sp)
(throw 'nesting 'cexp))
(goto-char sp))
(if (and begin
(not verilog-indent-begin-after-if)
(looking-at verilog-no-indent-begin-re))
(progn
(beginning-of-line)
(skip-chars-forward " \t")
(throw 'nesting 'statement))
(progn
(throw 'nesting 'cexp))))
;; not a continued line
(goto-char starting_position))
(if (looking-at "\\<else\\>")
;; search back for governing if, striding across begin..end pairs
;; appropriately
(let ((elsec 1))
(while (verilog-re-search-backward verilog-ends-re nil 'move)
(cond
((match-end 1) ; else, we're in deep
(setq elsec (1+ elsec)))
((match-end 2) ; found it
(setq elsec (1- elsec))
(if (= 0 elsec)
(if verilog-align-ifelse
(throw 'nesting 'statement)
(progn ;; back up to first word on this line
(beginning-of-line)
(verilog-forward-syntactic-ws)
(throw 'nesting 'statement)))))
(t ; endblock
; try to leap back to matching outward block by striding across
; indent level changing tokens then immediately
; previous line governs indentation.
(let ((reg)(nest 1))
;; verilog-ends => else|if|end|join|endcase|endtable|endspecify|endfunction|endtask
(cond
((match-end 3) ; end
;; Search back for matching begin
(setq reg "\\(\\<begin\\>\\)\\|\\(\\<end\\>\\)" ))
((match-end 5) ; endcase
;; Search back for matching case
(setq reg "\\(\\<case[xz]?\\>[^:]\\)\\|\\(\\<endcase\\>\\)" ))
((match-end 7) ; endspecify
;; Search back for matching specify
(setq reg "\\(\\<specify\\>\\)\\|\\(\\<endspecify\\>\\)" ))
((match-end 8) ; endfunction
;; Search back for matching function
(setq reg "\\(\\<function\\>\\)\\|\\(\\<endfunction\\>\\)" ))
((match-end 9) ; endtask
;; Search back for matching task
(setq reg "\\(\\<task\\>\\)\\|\\(\\<endtask\\>\\)" ))
((match-end 4) ; join
;; Search back for matching fork
(setq reg "\\(\\<fork\\>\\)\\|\\(\\<join\\>\\)" ))
((match-end 6) ; endtable
;; Search back for matching table
(setq reg "\\(\\<table\\>\\)\\|\\(\\<endtable\\>\\)" ))
)
(catch 'skip
(while (verilog-re-search-backward reg nil 'move)
(cond
((match-end 1) ; begin
(setq nest (1- nest))
(if (= 0 nest)
(throw 'skip 1)))
((match-end 2) ; end
(setq nest (1+ nest)))))
)
))
))))
(throw 'nesting (verilog-calc-1))
))))
;; Return type of block and indent level.
(if (not type)
(setq type 'cpp))
(if (> par 0) ; Unclosed Parenthesis
(list 'cparenexp par)
(cond
((eq type 'case)
(list type (verilog-case-indent-level)))
((eq type 'statement)
(list type (current-column)))
((eq type 'defun)
(list type 0))
(t
(list type (verilog-indent-level)))))
)))
(defun verilog-calc-1 ()
(catch 'nesting
(while (verilog-re-search-backward verilog-indent-re nil 'move)
(cond
((looking-at verilog-behavioral-level-re)
(throw 'nesting 'behavioral))
((looking-at verilog-beg-block-re-1)
(cond
((match-end 2) (throw 'nesting 'case))
(t (throw 'nesting 'block))))
((looking-at verilog-end-block-re)
(verilog-leap-to-head)
(if (verilog-in-case-region-p)
(progn
(verilog-leap-to-case-head)
(if (looking-at verilog-case-re)
(throw 'nesting 'case)))))
((looking-at verilog-defun-level-re)
(throw 'nesting 'defun))
((looking-at verilog-cpp-level-re)
(throw 'nesting 'cpp))
((bobp)
(throw 'nesting 'cpp))
))))
(defun verilog-calculate-indent-directive ()
"Return indentation level for directive.
For speed, the searcher looks at the last directive, not the indent
of the appropriate enclosing block."
(let ((base -1) ;; Indent of the line that determines our indentation
(ind 0) ;; Relative offset caused by other directives (like `endif on same line as `else)
)
;; Start at current location, scan back for another directive
(save-excursion
(beginning-of-line)
(while (and (< base 0)
(verilog-re-search-backward verilog-directive-re nil t))
(cond ((save-excursion (skip-chars-backward " \t") (bolp))
(setq base (current-indentation))
))
(cond ((and (looking-at verilog-directive-end) (< base 0)) ;; Only matters when not at BOL
(setq ind (- ind verilog-indent-level-directive)))
((and (looking-at verilog-directive-middle) (>= base 0)) ;; Only matters when at BOL
(setq ind (+ ind verilog-indent-level-directive)))
((looking-at verilog-directive-begin)
(setq ind (+ ind verilog-indent-level-directive)))))
;; Adjust indent to starting indent of critical line
(setq ind (max 0 (+ ind base))))
(save-excursion
(beginning-of-line)
(skip-chars-forward " \t")
(cond ((or (looking-at verilog-directive-middle)
(looking-at verilog-directive-end))
(setq ind (max 0 (- ind verilog-indent-level-directive))))))
ind))
(defun verilog-leap-to-case-head ()
(let ((nest 1))
(while (/= 0 nest)
(verilog-re-search-backward "\\(\\<case[xz]?\\>[^:]\\)\\|\\(\\<endcase\\>\\)" nil 'move)
(cond
((match-end 1)
(setq nest (1- nest)))
((match-end 2)
(setq nest (1+ nest)))
((bobp)
(ding 't)
(setq nest 0))))))
(defun verilog-leap-to-head ()
"Move point to the head of this block; jump from end to matching begin,
from endcase to matching case, and so on."
(let (reg
snest
(nest 1))
(cond
((looking-at "\\<end\\>")
;; Search back for matching begin
(setq reg (concat "\\(\\<begin\\>\\)\\|\\(\\<end\\>\\)\\|"
"\\(\\<endcase\\>\\)\\|\\(\\<join\\>\\)" )))
((looking-at "\\<endcase\\>")
;; Search back for matching case
(setq reg "\\(\\<case[xz]?\\>\\)\\|\\(\\<endcase\\>\\)" ))
((looking-at "\\<join\\>")
;; Search back for matching fork
(setq reg "\\(\\<fork\\>\\)\\|\\(\\<join\\>\\)" ))
((looking-at "\\<endtable\\>")
;; Search back for matching table
(setq reg "\\(\\<table\\>\\)\\|\\(\\<endtable\\>\\)" ))
((looking-at "\\<endspecify\\>")
;; Search back for matching specify
(setq reg "\\(\\<specify\\>\\)\\|\\(\\<endspecify\\>\\)" ))
((looking-at "\\<endfunction\\>")
;; Search back for matching function
(setq reg "\\(\\<function\\>\\)\\|\\(\\<endfunction\\>\\)" ))
((looking-at "\\<endtask\\>")
;; Search back for matching task
(setq reg "\\(\\<task\\>\\)\\|\\(\\<endtask\\>\\)" ))
)
(catch 'skip
(let (sreg)
(while (verilog-re-search-backward reg nil 'move)
(cond
((match-end 1) ; begin
(setq nest (1- nest))
(if (= 0 nest)
;; Now previous line describes syntax
(throw 'skip 1))
(if (and snest
(= snest nest))
(setq reg sreg)))
((match-end 2) ; end
(setq nest (1+ nest)))
((match-end 3)
;; endcase, jump to case
(setq snest nest)
(setq nest (1+ nest))
(setq sreg reg)
(setq reg "\\(\\<case[xz]?\\>[^:]\\)\\|\\(\\<endcase\\>\\)" ))
((match-end 4)
;; join, jump to fork
(setq snest nest)
(setq nest (1+ nest))
(setq sreg reg)
(setq reg "\\(\\<fork\\>\\)\\|\\(\\<join\\>\\)" ))
))))))
(defun verilog-continued-line ()
"Return true if this is a continued line.
Set point to where line starts"
(let ((continued 't))
(if (eq 0 (forward-line -1))
(progn
(end-of-line)
(verilog-backward-ws&directives)
(if (bobp)
(setq continued nil)
(while (and continued
(save-excursion
(skip-chars-backward " \t")
(not (bolp))))
(setq continued (verilog-backward-token))
) ;; while
))
(setq continued nil))
continued))
(defun verilog-backward-token ()
"Step backward token, returning true if we are now at an end of line token."
(verilog-backward-syntactic-ws)
(cond
((bolp)
nil)
(;-- Anything ending in a ; is complete
(= (preceding-char) ?\;)
nil)
(;-- Could be 'case (foo)' or 'always @(bar)' which is complete
; also could be simply '@(foo)'
(= (preceding-char) ?\))
(progn
(backward-char)
(backward-up-list 1)
(verilog-backward-syntactic-ws)
(let ((back (point)))
(forward-word -1)
(cond
((looking-at "\\<\\(always\\|case\\(\\|[xz]\\)\\|for\\(\\|ever\\)\\|i\\(f\\|nitial\\)\\|repeat\\|while\\)\\>")
(not (looking-at "\\<case[xz]?\\>[^:]")))
(t
(goto-char back)
(if (= (preceding-char) ?\@)
(progn (backward-char)
(save-excursion
(verilog-backward-token)
(not (looking-at "\\<\\(always\\|initial\\|while\\)\\>"))))
nil))
))))
(;-- any of begin|initial|while are complete statements; 'begin : foo' is also complete
t
(forward-word -1)
(cond
((looking-at "\\(else\\)\\|\\(initial\\>\\)\\|\\(always\\>\\)")
t)
((looking-at verilog-indent-reg)
nil)
(t
(let
((back (point)))
(verilog-backward-syntactic-ws)
(cond
((= (preceding-char) ?\:)
(backward-char)
(verilog-backward-syntactic-ws)
(backward-sexp)
(if (looking-at "begin")
nil
t)
)
((= (preceding-char) ?\#)
(backward-char)
t)
((= (preceding-char) ?\`)
(backward-char)
t)
(t
(goto-char back)
t)
)))))))
(defun verilog-backward-syntactic-ws (&optional bound)
"Backward skip over syntactic whitespace for Emacs 19.
Optional BOUND limits search."
(save-restriction
(let* ((bound (or bound (point-min))) (here bound) )
(if (< bound (point))
(progn
(narrow-to-region bound (point))
(while (/= here (point))
(setq here (point))
(forward-comment (-(buffer-size)))
)))
))
t)
(defun verilog-forward-syntactic-ws (&optional bound)
"Forward skip over syntactic whitespace for Emacs 19.
Optional BOUND limits search."
(save-restriction
(let* ((bound (or bound (point-max)))
(here bound)
)
(if (> bound (point))
(progn
(narrow-to-region (point) bound)
(while (/= here (point))
(setq here (point))
(forward-comment (buffer-size))
)))
)))
(defun verilog-backward-ws&directives (&optional bound)
"Backward skip over syntactic whitespace and compiler directives for Emacs 19.
Optional BOUND limits search."
(save-restriction
(let* ((bound (or bound (point-min)))
(here bound)
(p nil) )
(if (< bound (point))
(progn
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(cond
((nth 7 state) ;; in // comment
(verilog-re-search-backward "//" nil 'move)
(skip-chars-backward "/"))
((nth 4 state) ;; in /* */ comment
(verilog-re-search-backward "/\*" nil 'move))))
(narrow-to-region bound (point))
(while (/= here (point))
(setq here (point))
(forward-comment (-(buffer-size)))
(setq p
(save-excursion
(beginning-of-line)
(cond
((verilog-within-translate-off)
(verilog-back-to-start-translate-off (point-min)))
((looking-at verilog-directive-re-1)
(point))
(t
nil))))
(if p (goto-char p))
)))
)))
(defun verilog-forward-ws&directives (&optional bound)
"Forward skip over syntactic whitespace and compiler directives for Emacs 19.
Optional BOUND limits search."
(save-restriction
(let* ((bound (or bound (point-max)))
(here bound)
jump
)
(if (> bound (point))
(progn
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(cond
((nth 7 state) ;; in // comment
(verilog-re-search-forward "//" nil 'move))
((nth 4 state) ;; in /* */ comment
(verilog-re-search-forward "/\*" nil 'move))))
(narrow-to-region (point) bound)
(while (/= here (point))
(setq here (point)
jump nil)
(forward-comment (buffer-size))
(save-excursion
(beginning-of-line)
(if (looking-at verilog-directive-re-1)
(setq jump t)))
(if jump
(beginning-of-line 2))
)))
)))
(defun verilog-in-comment-p ()
"Return true if in a star or // comment."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(or (nth 4 state) (nth 7 state))))
(defun verilog-in-star-comment-p ()
"Return true if in a star comment."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(nth 4 state)))
(defun verilog-in-slash-comment-p ()
"Return true if in a slash comment."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(nth 7 state)))
(defun verilog-in-comment-or-string-p ()
"Return true if in a string or comment."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(or (nth 3 state) (nth 4 state) (nth 7 state)))) ; Inside string or comment)
(defun verilog-in-escaped-name-p ()
"Return true if in an escaped name."
(save-excursion
(backward-char)
(skip-chars-backward "^ \t\n")
(if (= (char-after (point) ) ?\\ )
t
nil)))
(defun verilog-in-paren ()
"Return true if in a parenthetical expression."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(/= 0 (nth 0 state))))
(defun verilog-parenthesis-depth ()
"Return non zero if in parenthetical-expression."
(save-excursion
(nth 1 (parse-partial-sexp (point-min) (point)))))
(defun verilog-skip-forward-comment-or-string ()
"Return true if in a string or comment."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(cond
((nth 3 state) ;Inside string
(goto-char (nth 3 state))
t)
((nth 7 state) ;Inside // comment
(forward-line 1)
t)
((nth 4 state) ;Inside any comment (hence /**/)
(search-forward "*/"))
(t
nil))))
(defun verilog-skip-backward-comment-or-string ()
"Return true if in a string or comment."
(let ((state
(save-excursion
(parse-partial-sexp (point-min) (point)))))
(cond
((nth 3 state) ;Inside string
(search-backward "\"")
t)
((nth 7 state) ;Inside // comment
(search-backward "//")
(skip-chars-backward "/")
t)
((nth 4 state) ;Inside /* */ comment
(search-backward "/*")
t)
(t
nil))))
(defun verilog-skip-forward-comment-p ()
"If in comment, move to end and return true."
(let (state)
(progn
(setq state
(save-excursion
(parse-partial-sexp (point-min) (point))))
(cond
((nth 3 state)
t)
((nth 7 state) ;Inside // comment
(end-of-line)
(forward-char 1)
t)
((nth 4 state) ;Inside any comment
t)
(t
nil)))))
(defun verilog-indent-line-relative ()
"Cheap version of indent line.
Only look at a few lines to determine indent level."
(interactive)
(let ((indent-str)
(sp (point)))
(if (looking-at "^[ \t]*$")
(cond ;- A blank line; No need to be too smart.
((bobp)
(setq indent-str (list 'cpp 0)))
((verilog-continued-line)
(let ((sp1 (point)))
(if (verilog-continued-line)
(progn (goto-char sp)
(setq indent-str (list 'statement (verilog-indent-level))))
(goto-char sp1)
(setq indent-str (list 'block (verilog-indent-level)))))
(goto-char sp))
((goto-char sp)
(setq indent-str (verilog-calculate-indent))))
(progn (skip-chars-forward " \t")
(setq indent-str (verilog-calculate-indent))))
(verilog-do-indent indent-str)))
(defun verilog-indent-line ()
"Indent for special part of code."
(verilog-do-indent (verilog-calculate-indent)))
(defun verilog-do-indent (indent-str)
(let ((type (car indent-str))
(ind (car (cdr indent-str))))
(cond
(; handle continued exp
(eq type 'cexp)
(let ((here (point)))
(verilog-backward-syntactic-ws)
(cond
((or
(= (preceding-char) ?\,)
(= (preceding-char) ?\])
(save-excursion
(verilog-beg-of-statement-1)
(looking-at verilog-declaration-re)))
(let* ( fst
(val
(save-excursion
(backward-char 1)
(verilog-beg-of-statement-1)
(setq fst (point))
(if (looking-at verilog-declaration-re)
(progn ;; we have multiple words
(goto-char (match-end 0))
(skip-chars-forward " \t")
(cond
((and verilog-indent-declaration-macros
(= (following-char) ?\`))
(progn
(forward-char 1)
(forward-word 1)
(skip-chars-forward " \t")))
((= (following-char) ?\[)
(progn
(forward-char 1)
(backward-up-list -1)
(skip-chars-forward " \t")))
)
(current-column))
(progn
(goto-char fst)
(+ (current-column) verilog-cexp-indent))
))))
(goto-char here)
(indent-line-to val))
)
((= (preceding-char) ?\) )
(goto-char here)
(let ((val (eval (cdr (assoc type verilog-indent-alist)))))
(indent-line-to val)))
(t
(goto-char here)
(let ((val))
(verilog-beg-of-statement-1)
(if (verilog-re-search-forward "=[ \\t]*" here 'move)
(setq val (current-column))
(setq val (eval (cdr (assoc type verilog-indent-alist)))))
(goto-char here)
(indent-line-to val)))
)))
(; handle inside parenthetical expressions
(eq type 'cparenexp)
(let ((val (save-excursion
(backward-up-list 1)
(forward-char 1)
(skip-chars-forward " \t")
(current-column))))
(indent-line-to val)))
(;-- Handle the ends
(looking-at verilog-end-block-re )
(let ((val (if (eq type 'statement)
(- ind verilog-indent-level)
ind)))
(indent-line-to val)))
(;-- Case -- maybe line 'em up
(and (eq type 'case) (not (looking-at "^[ \t]*$")))
(progn
(cond
((looking-at "\\<endcase\\>")
(indent-line-to ind))
(t
(let ((val (eval (cdr (assoc type verilog-indent-alist)))))
(indent-line-to val))))))
(;-- defun
(and (eq type 'defun)
(looking-at verilog-zero-indent-re))
(indent-line-to 0))
(;-- declaration
(and (or
(eq type 'defun)
(eq type 'block))
(looking-at verilog-declaration-re))
(verilog-indent-declaration ind))
(;-- Everything else
t
(let ((val (eval (cdr (assoc type verilog-indent-alist)))))
(indent-line-to val)))
)
(if (looking-at "[ \t]+$")
(skip-chars-forward " \t"))
indent-str ; Return indent data
))
(defun verilog-indent-level ()
"Return the indent-level the current statement has."
(save-excursion
(let (par-pos)
(beginning-of-line)
(setq par-pos (verilog-parenthesis-depth))
(while par-pos
(goto-char par-pos)
(beginning-of-line)
(setq par-pos (verilog-parenthesis-depth)))
(skip-chars-forward " \t")
(current-column))))
(defun verilog-case-indent-level ()
"Return the indent-level the current statement has.
Do not count named blocks or case-statements."
(save-excursion
(skip-chars-forward " \t")
(cond
((looking-at verilog-named-block-re)
(current-column))
((and (not (looking-at verilog-case-re))
(looking-at "^[^:;]+[ \t]*:"))
(verilog-re-search-forward ":" nil t)
(skip-chars-forward " \t")
(current-column))
(t
(current-column)))))
(defun verilog-indent-comment ()
"Indent current line as comment."
(let* ((stcol
(cond
((verilog-in-star-comment-p)
(save-excursion
(re-search-backward "/\\*" nil t)
(1+(current-column))))
(comment-column
comment-column )
(t
(save-excursion
(re-search-backward "//" nil t)
(current-column)))
)))
(indent-line-to stcol)
stcol))
(defun verilog-more-comment ()
"Make more comment lines like the previous."
(let* ((star 0)
(stcol
(cond
((verilog-in-star-comment-p)
(save-excursion
(setq star 1)
(re-search-backward "/\\*" nil t)
(1+(current-column))))
(comment-column
comment-column )
(t
(save-excursion
(re-search-backward "//" nil t)
(current-column)))
)))
(progn
(indent-to stcol)
(if (and star
(save-excursion
(forward-line -1)
(skip-chars-forward " \t")
(looking-at "\*")))
(insert "* ")))))
(defun verilog-comment-indent (&optional arg)
"Return the column number the line should be indented to.
ARG is ignored, for `comment-indent-function' compatibility."
(cond
((verilog-in-star-comment-p)
(save-excursion
(re-search-backward "/\\*" nil t)
(1+(current-column))))
( comment-column
comment-column )
(t
(save-excursion
(re-search-backward "//" nil t)
(current-column)))))
;;
(defun verilog-pretty-declarations ()
"Line up declarations around point."
(interactive)
(save-excursion
(if (progn
(verilog-beg-of-statement-1)
(looking-at verilog-declaration-re))
(let* ((m1 (make-marker))
(e) (r)
(here (point))
(start
(progn
(verilog-beg-of-statement-1)
(while (looking-at verilog-declaration-re)
(beginning-of-line)
(setq e (point))
(verilog-backward-syntactic-ws)
(backward-char)
(verilog-beg-of-statement-1)) ;Ack, need to grok `define
e))
(end
(progn
(goto-char here)
(verilog-end-of-statement)
(setq e (point)) ;Might be on last line
(verilog-forward-syntactic-ws)
(while (looking-at verilog-declaration-re)
(beginning-of-line)
(verilog-end-of-statement)
(setq e (point))
(verilog-forward-syntactic-ws))
e))
(edpos (set-marker (make-marker) end))
(ind)
(base-ind
(progn
(goto-char start)
(verilog-do-indent (verilog-calculate-indent))
(verilog-forward-ws&directives)
(current-column)))
)
(goto-char end)
(goto-char start)
(if (> (- end start) 100)
(message "Lining up declarations..(please stand by)"))
;; Get the beginning of line indent first
(while (progn (setq e (marker-position edpos))
(< (point) e))
(indent-line-to base-ind)
(forward-line))
;; Now find biggest prefix
(setq ind (verilog-get-lineup-indent start edpos))
;; Now indent each line.
(goto-char start)
(while (progn (setq e (marker-position edpos))
(setq r (- e (point)))
(> r 0))
(setq e (point))
(message "%d" r)
(cond
((or (and verilog-indent-declaration-macros
(looking-at verilog-declaration-re-1-macro))
(looking-at verilog-declaration-re-1-no-macro))
(let ((p (match-end 0)))
(set-marker m1 p)
(if (verilog-re-search-forward "[[#`]" p 'move)
(progn
(forward-char -1)
(just-one-space)
(goto-char (marker-position m1))
(just-one-space)
(indent-to ind))
(progn
(just-one-space)
(indent-to ind))
)))
((verilog-continued-line-1 start)
(goto-char e)
(indent-line-to ind))
(t ; Must be comment or white space
(goto-char e)
(verilog-forward-ws&directives)
(forward-line -1))
)
(forward-line 1))
(message "")))))
(defun verilog-pretty-expr (&optional myre)
"Line up expressions around point"
(interactive)
(save-excursion
(if (not myre)
(setq myre (read-string "Regular Expression: (<=) ")))
(if (string-equal myre "") (setq myre "<="))
(setq myre (concat "\\(^.*\\)\\(" myre "\\)"))
(beginning-of-line)
(if (and (not(looking-at verilog-complete-reg))
(looking-at myre))
(let* ((m1 (make-marker))
(e) (r)
(here (point))
(start
(progn
(beginning-of-line)
(setq e (point))
(verilog-backward-syntactic-ws)
(beginning-of-line)
(while (and (not(looking-at (concat "^\\s-*" verilog-complete-reg)))
(looking-at myre))
(setq e (point))
(verilog-backward-syntactic-ws)
(beginning-of-line)
) ;Ack, need to grok `define
e))
(end
(progn
(goto-char here)
(end-of-line)
(setq e (point)) ;Might be on last line
(verilog-forward-syntactic-ws)
(beginning-of-line)
(while (and (not(looking-at (concat "^\\s-*" verilog-complete-reg)))
(looking-at myre))
(end-of-line)
(setq e (point))
(verilog-forward-syntactic-ws)
(beginning-of-line)
)
e))
(edpos (set-marker (make-marker) end))
(ind)
)
(goto-char start)
(verilog-do-indent (verilog-calculate-indent))
(goto-char end)
;;(insert "/*end*/")
(goto-char start)
;;(insert "/*start*/")
(if (> (- end start) 100)
(message "Lining up expressions..(please stand by)"))
;; Get the begining of line indent first
(while (progn (setq e (marker-position edpos))
(< (point) e))
(beginning-of-line)
(verilog-just-one-space myre)
(forward-line))
;; Now find biggest prefix
(setq ind (verilog-get-lineup-indent-2 myre start edpos))
;; Now indent each line.
(goto-char start)
(while (progn (setq e (marker-position edpos))
(setq r (- e (point)))
(> r 0))
(setq e (point))
(message "%d" r)
(cond
((looking-at myre)
(let ((p1 (match-end 1)))
(set-marker m1 p1)
(progn
(set-marker m1 p1)
(goto-char (marker-position m1))
(indent-to ind)
)))
((verilog-continued-line-1 start)
(goto-char e)
(indent-line-to ind))
(t ; Must be comment or white space
(goto-char e)
(verilog-forward-ws&directives)
(forward-line -1))
)
(forward-line 1))
(message "")
))))
(defun verilog-just-one-space (myre)
"Remove extra spaces around regular expression"
(interactive)
(save-excursion
(if (and (not(looking-at verilog-complete-reg))
(looking-at myre))
(let ((m1 (make-marker))
(p2 (match-end 2))
(p1 (match-end 1)))
(set-marker m1 p1)
(progn
(set-marker m1 p2)
(goto-char (marker-position m1))
(if (looking-at "\\s-")
(just-one-space) )
(set-marker m1 p1)
(goto-char (marker-position m1))
(forward-char -1)
(if (looking-at "\\s-")
(just-one-space))
)
))
(message "")))
(defun verilog-indent-declaration (baseind)
"Indent current lines as declaration.
Line up the variable names based on previous declaration's indentation.
BASEIND is the base indent to offset everything."
(interactive)
(let ((pos (point-marker))
(lim (save-excursion
(verilog-re-search-backward "\\(\\<begin\\>\\)\\|\\(\\<module\\>\\)" nil 'move)
(point)))
(ind)
(val)
(m1 (make-marker))
)
;; Use previous declaration (in this module) as template.
(if (verilog-re-search-backward (or (and verilog-indent-declaration-macros
verilog-declaration-re-1-macro)
verilog-declaration-re-1-no-macro) lim t)
(progn
(goto-char (match-end 0))
(skip-chars-forward " \t")
(setq ind (current-column))
(goto-char pos)
(setq val (+ baseind (eval (cdr (assoc 'declaration verilog-indent-alist)))))
(indent-line-to val)
(if (and verilog-indent-declaration-macros
(looking-at verilog-declaration-re-2-macro))
(let ((p (match-end 0)))
(set-marker m1 p)
(if (verilog-re-search-forward "[[#`]" p 'move)
(progn
(forward-char -1)
(just-one-space)
(goto-char (marker-position m1))
(just-one-space)
(indent-to ind)
)
(if (/= (current-column) ind)
(progn
(just-one-space)
(indent-to ind))
)))
(if (looking-at verilog-declaration-re-2-no-macro)
(let ((p (match-end 0)))
(set-marker m1 p)
(if (verilog-re-search-forward "[[`#]" p 'move)
(progn
(forward-char -1)
(just-one-space)
(goto-char (marker-position m1))
(just-one-space)
(indent-to ind))
(if (/= (current-column) ind)
(progn
(just-one-space)
(indent-to ind))
)))
)))
(let ((val (+ baseind (eval (cdr (assoc 'declaration verilog-indent-alist))))))
(indent-line-to val))
)
(goto-char pos)))
(defun verilog-get-lineup-indent (b edpos)
"Return the indent level that will line up several lines within the region.
Region is defined by B and EDPOS."
(save-excursion
(let ((ind 0) e)
(goto-char b)
;; Get rightmost position
(while (progn (setq e (marker-position edpos))
(< (point) e))
(if (verilog-re-search-forward (or (and verilog-indent-declaration-macros
verilog-declaration-re-1-macro)
verilog-declaration-re-1-no-macro) e 'move)
(progn
(goto-char (match-end 0))
(verilog-backward-syntactic-ws)
(if (> (current-column) ind)
(setq ind (current-column)))
(goto-char (match-end 0)))))
(if (> ind 0)
(1+ ind)
;; No lineup-string found
(goto-char b)
(end-of-line)
(skip-chars-backward " \t")
(1+ (current-column))))))
(defun verilog-get-lineup-indent-2 (myre b edpos)
"Return the indent level that will line up several lines within the region
from b to e nicely. The lineup string is str."
(save-excursion
(let ((ind 0) e)
(goto-char b)
;; Get rightmost position
(while (progn (setq e (marker-position edpos))
(< (point) e))
(if (re-search-forward myre e 'move)
(progn
(goto-char (match-end 0))
(verilog-backward-syntactic-ws)
(if (> (current-column) ind)
(setq ind (current-column)))
(goto-char (match-end 0)))))
(if (> ind 0)
(1+ ind)
;; No lineup-string found
(goto-char b)
(end-of-line)
(skip-chars-backward " \t")
(1+ (current-column))))))
(defun verilog-comment-depth (type val)
"A useful mode debugging aide. TYPE and VAL are comments for insertion."
(save-excursion
(let
((b (prog2
(beginning-of-line)
(point-marker)
(end-of-line)))
(e (point-marker)))
(if (re-search-backward " /\\* \[#-\]# \[a-zA-Z\]+ \[0-9\]+ ## \\*/" b t)
(progn
(replace-match " /* -# ## */")
(end-of-line))
(progn
(end-of-line)
(insert " /* ## ## */"))))
(backward-char 6)
(insert
(format "%s %d" type val))))
;;
;;
;; Completion
;;
(defvar verilog-str nil)
(defvar verilog-all nil)
(defvar verilog-pred nil)
(defvar verilog-buffer-to-use nil)
(defvar verilog-flag nil)
(defvar verilog-toggle-completions nil
"*True means \\<verilog-mode-map>\\[verilog-complete-word] should try all possible completions one by one.
Repeated use of \\[verilog-complete-word] will show you all of them.
Normally, when there is more than one possible completion,
it displays a list of all possible completions.")
(defvar verilog-type-keywords
'("and" "buf" "bufif0" "bufif1" "cmos" "defparam" "inout" "input"
"integer" "nand" "nmos" "nor" "not" "notif0" "notif1" "or" "output" "parameter"
"pmos" "pull0" "pull1" "pullup" "rcmos" "real" "realtime" "reg" "rnmos" "rpmos" "rtran"
"rtranif0" "rtranif1" "time" "tran" "tranif0" "tranif1" "tri" "tri0" "tri1"
"triand" "trior" "trireg" "wand" "wire" "wor" "xnor" "xor" )
"*Keywords for types used when completing a word in a declaration or parmlist.
\(eg. integer, real, reg...)")
(defvar verilog-cpp-keywords
'("module" "macromodule" "primitive" "timescale" "define" "ifdef"
"endif")
"*Keywords to complete when at first word of a line in declarative scope.
\(eg. initial, always, begin, assign.)
The procedures and variables defined within the Verilog program
will be completed runtime and should not be added to this list.")
(defvar verilog-defun-keywords
(append
'("begin" "function" "task" "initial" "always" "assign"
"endmodule" "specify" "endspecify" "generate" "endgenerate")
verilog-type-keywords)
"*Keywords to complete when at first word of a line in declarative scope.
\(eg. initial, always, begin, assign.)
The procedures and variables defined within the Verilog program
will be completed runtime and should not be added to this list.")
(defvar verilog-block-keywords
'("begin" "fork" "join" "case" "end" "if" "else" "for" "while" "repeat"
"endgenerate" "endspecify" "endfunction" "endtask")
"*Keywords to complete when at first word of a line in behavioral scope.
\(eg. begin, if, then, else, for, fork.)
The procedures and variables defined within the Verilog program
will be completed runtime and should not be added to this list.")
(defvar verilog-tf-keywords
'("begin" "fork" "join" "case" "end" "endtask" "endfunction" "if" "else" "for" "while" "repeat")
"*Keywords to complete when at first word of a line in a task or function.
\(eg. begin, if, then, else, for, fork.)
The procedures and variables defined within the Verilog program
will be completed runtime and should not be added to this list.")
(defvar verilog-case-keywords
'("begin" "fork" "join" "case" "end" "endcase" "if" "else" "for" "repeat")
"*Keywords to complete when at first word of a line in case scope.
\(eg. begin, if, then, else, for, fork.)
The procedures and variables defined within the Verilog program
will be completed runtime and should not be added to this list.")
(defvar verilog-separator-keywords
'("else" "then" "begin")
"*Keywords to complete when NOT standing at the first word of a statement.
\(eg. else, then.)
Variables and function names defined within the
Verilog program are completed runtime and should not be added to this list.")
(defun verilog-string-diff (str1 str2)
"Return index of first letter where STR1 and STR2 differs."
(catch 'done
(let ((diff 0))
(while t
(if (or (> (1+ diff) (length str1))
(> (1+ diff) (length str2)))
(throw 'done diff))
(or (equal (aref str1 diff) (aref str2 diff))
(throw 'done diff))
(setq diff (1+ diff))))))
;; Calculate all possible completions for functions if argument is `function',
;; completions for procedures if argument is `procedure' or both functions and
;; procedures otherwise.
(defun verilog-func-completion (type)
"Build regular expression for module/task/function names.
TYPE is 'module, 'tf for task or function, or t if unknown."
(if (string= verilog-str "")
(setq verilog-str "[a-zA-Z_]"))
(let ((verilog-str (concat (cond
((eq type 'module) "\\<\\(module\\)\\s +")
((eq type 'tf) "\\<\\(task\\|function\\)\\s +")
(t "\\<\\(task\\|function\\|module\\)\\s +"))
"\\<\\(" verilog-str "[a-zA-Z0-9_.]*\\)\\>"))
match)
(if (not (looking-at verilog-defun-re))
(verilog-re-search-backward verilog-defun-re nil t))
(forward-char 1)
;; Search through all reachable functions
(goto-char (point-min))
(while (verilog-re-search-forward verilog-str (point-max) t)
(progn (setq match (buffer-substring (match-beginning 2)
(match-end 2)))
(if (or (null verilog-pred)
(funcall verilog-pred match))
(setq verilog-all (cons match verilog-all)))))
(if (match-beginning 0)
(goto-char (match-beginning 0)))))
(defun verilog-get-completion-decl (end)
"Macro for searching through current declaration (var, type or const)
for matches of `str' and adding the occurence tp `all' through point END."
(let ((re (or (and verilog-indent-declaration-macros
verilog-declaration-re-2-macro)
verilog-declaration-re-2-no-macro))
decl-end match)
;; Traverse lines
(while (and (< (point) end)
(verilog-re-search-forward re end t))
;; Traverse current line
(setq decl-end (save-excursion (verilog-declaration-end)))
(while (and (verilog-re-search-forward verilog-symbol-re decl-end t)
(not (match-end 1)))
(setq match (buffer-substring (match-beginning 0) (match-end 0)))
(if (string-match (concat "\\<" verilog-str) match)
(if (or (null verilog-pred)
(funcall verilog-pred match))
(setq verilog-all (cons match verilog-all)))))
(forward-line 1)
)
)
verilog-all
)
(defun verilog-type-completion ()
"Calculate all possible completions for types."
(let ((start (point))
goon)
;; Search for all reachable type declarations
(while (or (verilog-beg-of-defun)
(setq goon (not goon)))
(save-excursion
(if (and (< start (prog1 (save-excursion (verilog-end-of-defun)
(point))
(forward-char 1)))
(verilog-re-search-forward
"\\<type\\>\\|\\<\\(begin\\|function\\|procedure\\)\\>"
start t)
(not (match-end 1)))
;; Check current type declaration
(verilog-get-completion-decl start))))))
(defun verilog-var-completion ()
"Calculate all possible completions for variables (or constants)."
(let ((start (point)))
;; Search for all reachable var declarations
(verilog-beg-of-defun)
(save-excursion
;; Check var declarations
(verilog-get-completion-decl start))))
(defun verilog-keyword-completion (keyword-list)
"Give list of all possible completions of keywords in KEYWORD-LIST."
(mapcar '(lambda (s)
(if (string-match (concat "\\<" verilog-str) s)
(if (or (null verilog-pred)
(funcall verilog-pred s))
(setq verilog-all (cons s verilog-all)))))
keyword-list))
(defun verilog-completion (verilog-str verilog-pred verilog-flag)
"Function passed to `completing-read', `try-completion' or `all-completions'.
Called to get completion on VERILOG-STR. If VERILOG-PRED is non-nil, it
must be a function to be called for every match to check if this should
really be a match. If VERILOG-FLAG is t, the function returns a list of all
possible completions. If VERILOG-FLAG is nil it returns a string, the
longest possible completion, or t if STR is an exact match. If VERILOG-FLAG
is 'lambda, the function returns t if STR is an exact match, nil
otherwise."
(save-excursion
(let ((verilog-all nil))
;; Set buffer to use for searching labels. This should be set
;; within functions which use verilog-completions
(set-buffer verilog-buffer-to-use)
;; Determine what should be completed
(let ((state (car (verilog-calculate-indent))))
(cond ((eq state 'defun)
(save-excursion (verilog-var-completion))
(verilog-func-completion 'module)
(verilog-keyword-completion verilog-defun-keywords))
((eq state 'block)
(save-excursion (verilog-var-completion))
(verilog-func-completion 'tf)
(verilog-keyword-completion verilog-block-keywords))
((eq state 'case)
(save-excursion (verilog-var-completion))
(verilog-func-completion 'tf)
(verilog-keyword-completion verilog-case-keywords))
((eq state 'tf)
(save-excursion (verilog-var-completion))
(verilog-func-completion 'tf)
(verilog-keyword-completion verilog-tf-keywords))
((eq state 'cpp)
(save-excursion (verilog-var-completion))
(verilog-keyword-completion verilog-cpp-keywords))
((eq state 'cparenexp)
(save-excursion (verilog-var-completion)))
(t;--Anywhere else
(save-excursion (verilog-var-completion))
(verilog-func-completion 'both)
(verilog-keyword-completion verilog-separator-keywords))))
;; Now we have built a list of all matches. Give response to caller
(verilog-completion-response))))
(defun verilog-completion-response ()
(cond ((or (equal verilog-flag 'lambda) (null verilog-flag))
;; This was not called by all-completions
(if (null verilog-all)
;; Return nil if there was no matching label
nil
;; Get longest string common in the labels
(let* ((elm (cdr verilog-all))
(match (car verilog-all))
(min (length match))
tmp)
(if (string= match verilog-str)
;; Return t if first match was an exact match
(setq match t)
(while (not (null elm))
;; Find longest common string
(if (< (setq tmp (verilog-string-diff match (car elm))) min)
(progn
(setq min tmp)
(setq match (substring match 0 min))))
;; Terminate with match=t if this is an exact match
(if (string= (car elm) verilog-str)
(progn
(setq match t)
(setq elm nil))
(setq elm (cdr elm)))))
;; If this is a test just for exact match, return nil ot t
(if (and (equal verilog-flag 'lambda) (not (equal match 't)))
nil
match))))
;; If flag is t, this was called by all-completions. Return
;; list of all possible completions
(verilog-flag
verilog-all)))
(defvar verilog-last-word-numb 0)
(defvar verilog-last-word-shown nil)
(defvar verilog-last-completions nil)
(defun verilog-complete-word ()
"Complete word at current point.
\(See also `verilog-toggle-completions', `verilog-type-keywords',
`verilog-start-keywords' and `verilog-separator-keywords'.)"
(interactive)
(let* ((b (save-excursion (skip-chars-backward "a-zA-Z0-9_") (point)))
(e (save-excursion (skip-chars-forward "a-zA-Z0-9_") (point)))
(verilog-str (buffer-substring b e))
;; The following variable is used in verilog-completion
(verilog-buffer-to-use (current-buffer))
(allcomp (if (and verilog-toggle-completions
(string= verilog-last-word-shown verilog-str))
verilog-last-completions
(all-completions verilog-str 'verilog-completion)))
(match (if verilog-toggle-completions
"" (try-completion
verilog-str (mapcar '(lambda (elm)
(cons elm 0)) allcomp)))))
;; Delete old string
(delete-region b e)
;; Toggle-completions inserts whole labels
(if verilog-toggle-completions
(progn
;; Update entry number in list
(setq verilog-last-completions allcomp
verilog-last-word-numb
(if (>= verilog-last-word-numb (1- (length allcomp)))
0
(1+ verilog-last-word-numb)))
(setq verilog-last-word-shown (elt allcomp verilog-last-word-numb))
;; Display next match or same string if no match was found
(if (not (null allcomp))
(insert "" verilog-last-word-shown)
(insert "" verilog-str)
(message "(No match)")))
;; The other form of completion does not necessarily do that.
;; Insert match if found, or the original string if no match
(if (or (null match) (equal match 't))
(progn (insert "" verilog-str)
(message "(No match)"))
(insert "" match))
;; Give message about current status of completion
(cond ((equal match 't)
(if (not (null (cdr allcomp)))
(message "(Complete but not unique)")
(message "(Sole completion)")))
;; Display buffer if the current completion didn't help
;; on completing the label.
((and (not (null (cdr allcomp))) (= (length verilog-str)
(length match)))
(with-output-to-temp-buffer "*Completions*"
(display-completion-list allcomp))
;; Wait for a key press. Then delete *Completion* window
(momentary-string-display "" (point))
(delete-window (get-buffer-window (get-buffer "*Completions*")))
)))))
(defun verilog-show-completions ()
"Show all possible completions at current point."
(interactive)
(let* ((b (save-excursion (skip-chars-backward "a-zA-Z0-9_") (point)))
(e (save-excursion (skip-chars-forward "a-zA-Z0-9_") (point)))
(verilog-str (buffer-substring b e))
;; The following variable is used in verilog-completion
(verilog-buffer-to-use (current-buffer))
(allcomp (if (and verilog-toggle-completions
(string= verilog-last-word-shown verilog-str))
verilog-last-completions
(all-completions verilog-str 'verilog-completion))))
;; Show possible completions in a temporary buffer.
(with-output-to-temp-buffer "*Completions*"
(display-completion-list allcomp))
;; Wait for a key press. Then delete *Completion* window
(momentary-string-display "" (point))
(delete-window (get-buffer-window (get-buffer "*Completions*")))))
(defun verilog-get-default-symbol ()
"Return symbol around current point as a string."
(save-excursion
(buffer-substring (progn
(skip-chars-backward " \t")
(skip-chars-backward "a-zA-Z0-9_")
(point))
(progn
(skip-chars-forward "a-zA-Z0-9_")
(point)))))
(defun verilog-build-defun-re (str &optional arg)
"Return function/task/module starting with STR as regular expression.
With optional second ARG non-nil, STR is the complete name of the instruction."
(if arg
(concat "^\\(function\\|task\\|module\\)[ \t]+\\(" str "\\)\\>")
(concat "^\\(function\\|task\\|module\\)[ \t]+\\(" str "[a-zA-Z0-9_]*\\)\\>")))
(defun verilog-comp-defun (verilog-str verilog-pred verilog-flag)
"Function passed to `completing-read', `try-completion' or `all-completions'.
Returns a completion on any function name based on VERILOG-STR prefix. If
VERILOG-PRED is non-nil, it must be a function to be called for every match
to check if this should really be a match. If VERILOG-FLAG is t, the
function returns a list of all possible completions. If it is nil it
returns a string, the longest possible completion, or t if VERILOG-STR is
an exact match. If VERILOG-FLAG is 'lambda, the function returns t if
VERILOG-STR is an exact match, nil otherwise."
(save-excursion
(let ((verilog-all nil)
match)
;; Set buffer to use for searching labels. This should be set
;; within functions which use verilog-completions
(set-buffer verilog-buffer-to-use)
(let ((verilog-str verilog-str))
;; Build regular expression for functions
(if (string= verilog-str "")
(setq verilog-str (verilog-build-defun-re "[a-zA-Z_]"))
(setq verilog-str (verilog-build-defun-re verilog-str)))
(goto-char (point-min))
;; Build a list of all possible completions
(while (verilog-re-search-forward verilog-str nil t)
(setq match (buffer-substring (match-beginning 2) (match-end 2)))
(if (or (null verilog-pred)
(funcall verilog-pred match))
(setq verilog-all (cons match verilog-all)))))
;; Now we have built a list of all matches. Give response to caller
(verilog-completion-response))))
(defun verilog-goto-defun ()
"Move to specified Verilog module/task/function.
The default is a name found in the buffer around point.
If search fails, other files are checked based on
`verilog-library-directories', `verilog-library-files',
and `verilog-library-extensions'."
(interactive)
(let* ((default (verilog-get-default-symbol))
;; The following variable is used in verilog-comp-function
(verilog-buffer-to-use (current-buffer))
(label (if (not (string= default ""))
;; Do completion with default
(completing-read (concat "Label: (default " default ") ")
'verilog-comp-defun nil nil "")
;; There is no default value. Complete without it
(completing-read "Label: "
'verilog-comp-defun nil nil "")))
pt)
;; If there was no response on prompt, use default value
(if (string= label "")
(setq label default))
;; Goto right place in buffer if label is not an empty string
(or (string= label "")
(progn
(save-excursion
(goto-char (point-min))
(setq pt (re-search-forward (verilog-build-defun-re label t) nil t)))
(when pt
(goto-char pt)
(beginning-of-line))
pt)
(verilog-goto-defun-file label)
)))
;; Eliminate compile warning
(eval-when-compile
(if (not (boundp 'occur-pos-list))
(defvar occur-pos-list nil "Backward compatibility occur positions.")))
(defun verilog-showscopes ()
"List all scopes in this module."
(interactive)
(let ((buffer (current-buffer))
(linenum 1)
(nlines 0)
(first 1)
(prevpos (point-min))
(final-context-start (make-marker))
(regexp "\\(module\\s-+\\w+\\s-*(\\)\\|\\(\\w+\\s-+\\w+\\s-*(\\)")
)
(with-output-to-temp-buffer "*Occur*"
(save-excursion
(message (format "Searching for %s ..." regexp))
;; Find next match, but give up if prev match was at end of buffer.
(while (and (not (= prevpos (point-max)))
(verilog-re-search-forward regexp nil t))
(goto-char (match-beginning 0))
(beginning-of-line)
(save-match-data
(setq linenum (+ linenum (count-lines prevpos (point)))))
(setq prevpos (point))
(goto-char (match-end 0))
(let* ((start (save-excursion
(goto-char (match-beginning 0))
(forward-line (if (< nlines 0) nlines (- nlines)))
(point)))
(end (save-excursion
(goto-char (match-end 0))
(if (> nlines 0)
(forward-line (1+ nlines))
(forward-line 1))
(point)))
(tag (format "%3d" linenum))
(empty (make-string (length tag) ?\ ))
tem)
(save-excursion
(setq tem (make-marker))
(set-marker tem (point))
(set-buffer standard-output)
(setq occur-pos-list (cons tem occur-pos-list))
(or first (zerop nlines)
(insert "--------\n"))
(setq first nil)
(insert-buffer-substring buffer start end)
(backward-char (- end start))
(setq tem (if (< nlines 0) (- nlines) nlines))
(while (> tem 0)
(insert empty ?:)
(forward-line 1)
(setq tem (1- tem)))
(let ((this-linenum linenum))
(set-marker final-context-start
(+ (point) (- (match-end 0) (match-beginning 0))))
(while (< (point) final-context-start)
(if (null tag)
(setq tag (format "%3d" this-linenum)))
(insert tag ?:)))))))
(set-buffer-modified-p nil))))
;; Highlight helper functions
(defconst verilog-directive-regexp "\\(translate\\|coverage\\|lint\\)_")
(defun verilog-within-translate-off ()
"Return point if within translate-off region, else nil."
(and (save-excursion
(re-search-backward
(concat "//\\s-*.*\\s-*" verilog-directive-regexp "\\(on\\|off\\)\\>")
nil t))
(equal "off" (match-string 2))
(point)))
(defun verilog-start-translate-off (limit)
"Return point before translate-off directive if before LIMIT, else nil."
(when (re-search-forward
(concat "//\\s-*.*\\s-*" verilog-directive-regexp "off\\>")
limit t)
(match-beginning 0)))
(defun verilog-back-to-start-translate-off (limit)
"Return point before translate-off directive if before LIMIT, else nil."
(when (re-search-backward
(concat "//\\s-*.*\\s-*" verilog-directive-regexp "off\\>")
limit t)
(match-beginning 0)))
(defun verilog-end-translate-off (limit)
"Return point after translate-on directive if before LIMIT, else nil."
(re-search-forward (concat
"//\\s-*.*\\s-*" verilog-directive-regexp "on\\>") limit t))
(defun verilog-match-translate-off (limit)
"Match a translate-off block, setting `match-data' and returning t, else nil.
Bound search by LIMIT."
(when (< (point) limit)
(let ((start (or (verilog-within-translate-off)
(verilog-start-translate-off limit)))
(case-fold-search t))
(when start
(let ((end (or (verilog-end-translate-off limit) limit)))
(set-match-data (list start end))
(goto-char end))))))
(defun verilog-font-lock-match-item (limit)
"Match, and move over, any declaration item after point.
Bound search by LIMIT. Adapted from
`font-lock-match-c-style-declaration-item-and-skip-to-next'."
(condition-case nil
(save-restriction
(narrow-to-region (point-min) limit)
;; match item
(when (looking-at "\\s-*\\([a-zA-Z]\\w*\\)")
(save-match-data
(goto-char (match-end 1))
;; move to next item
(if (looking-at "\\(\\s-*,\\)")
(goto-char (match-end 1))
(end-of-line) t))))
(error t)))
;; Added by Subbu Meiyappan for Header
(defun verilog-header ()
"Insert a standard Verilog file header."
(interactive)
(let ((start (point)))
(insert "\
//-----------------------------------------------------------------------------
// Title : <title>
// Project : <project>
//-----------------------------------------------------------------------------
// File : <filename>
// Author : <author>
// Created : <credate>
// Last modified : <moddate>
//-----------------------------------------------------------------------------
// Description :
// <description>
//-----------------------------------------------------------------------------
// Copyright (c) <copydate> by <company> This model is the confidential and
// proprietary property of <company> and the possession or use of this
// file requires a written license from <company>.
//------------------------------------------------------------------------------
// Modification history :
// <modhist>
//-----------------------------------------------------------------------------
")
(goto-char start)
(search-forward "<filename>")
(replace-match (buffer-name) t t)
(search-forward "<author>") (replace-match "" t t)
(insert (user-full-name))
(insert " <" (user-login-name) "@" (system-name) ">")
(search-forward "<credate>") (replace-match "" t t)
(insert-date)
(search-forward "<moddate>") (replace-match "" t t)
(insert-date)
(search-forward "<copydate>") (replace-match "" t t)
(insert-year)
(search-forward "<modhist>") (replace-match "" t t)
(insert-date)
(insert " : created")
(goto-char start)
(let (string)
(setq string (read-string "title: "))
(search-forward "<title>")
(replace-match string t t)
(setq string (read-string "project: " verilog-project))
(make-variable-buffer-local 'verilog-project)
(setq verilog-project string)
(search-forward "<project>")
(replace-match string t t)
(setq string (read-string "Company: " verilog-company))
(make-variable-buffer-local 'verilog-company)
(setq verilog-company string)
(search-forward "<company>")
(replace-match string t t)
(search-forward "<company>")
(replace-match string t t)
(search-forward "<company>")
(replace-match string t t)
(search-backward "<description>")
(replace-match "" t t)
)))
;; verilog-header Uses the insert-date function
(defun insert-date ()
"Insert date from the system."
(interactive)
(let ((timpos))
(setq timpos (point))
(if verilog-date-scientific-format
(shell-command "date \"+@%Y/%m/%d\"" t)
(shell-command "date \"+@%d.%m.%Y\"" t))
(search-forward "@")
(delete-region timpos (point))
(end-of-line))
(delete-char 1))
(defun insert-year ()
"Insert year from the system."
(interactive)
(let ((timpos))
(setq timpos (point))
(shell-command "date \"+@%Y\"" t)
(search-forward "@")
(delete-region timpos (point))
(end-of-line))
(delete-char 1))
;;
;; Signal list parsing
;;
(defun verilog-signals-not-in (in-list not-list)
"Return list of signals in IN-LIST that aren't also in NOT-LIST.
Signals must be in standard (base vector) form."
(let (out-list)
(while in-list
(if (not (assoc (car (car in-list)) not-list))
(setq out-list (cons (car in-list) out-list)))
(setq in-list (cdr in-list)))
(nreverse out-list)))
;;(verilog-signals-not-in '(("A" "") ("B" "") ("DEL" "[2:3]")) '(("DEL" "") ("EXT" "")))
(defun verilog-signals-in (in-list other-list)
"Return list of signals in IN-LIST that are also in other-list.
Signals must be in standard (base vector) form."
(let (out-list)
(while in-list
(if (assoc (car (car in-list)) other-list)
(setq out-list (cons (car in-list) out-list)))
(setq in-list (cdr in-list)))
(nreverse out-list)))
;;(verilog-signals-in '(("A" "") ("B" "") ("DEL" "[2:3]")) '(("DEL" "") ("EXT" "")))
(defun verilog-signals-memory (in-list)
"Return list of signals in IN-LIST that are memoried (multidimensional)."
(let (out-list)
(while in-list
(if (nth 3 (car in-list))
(setq out-list (cons (car in-list) out-list)))
(setq in-list (cdr in-list)))
out-list))
;;(verilog-signals-memory '(("A" nil nil "[3:0]")) '(("B" nil nil nil)))
(defun verilog-signals-sort-compare (a b)
"Compare signal A and B for sorting."
(string< (car a) (car b)))
(defun verilog-signals-combine-bus (in-list)
"Return a list of signals in IN-LIST, with busses combined.
Duplicate signals are also removed. For example A[2] and A[1] become A[2:1]."
(let ((combo "")
out-list signal highbit lowbit svhighbit svlowbit comment svbusstring bus)
;; Shove signals so duplicated signals will be adjacent
(setq in-list (sort in-list `verilog-signals-sort-compare))
(while in-list
(setq signal (nth 0 (car in-list))
bus (nth 1 (car in-list))
comment (nth 2 (car in-list)))
(cond ((and bus
(or (and (string-match "\\[\\([0-9]+\\):\\([0-9]+\\)\\]" bus)
(setq highbit (string-to-int (match-string 1 bus))
lowbit (string-to-int (match-string 2 bus))))
(and (string-match "\\[\\([0-9]+\\)\\]" bus)
(setq highbit (string-to-int (match-string 1 bus))
lowbit highbit))))
;; Combine bits in bus
(if svhighbit
(setq svhighbit (max highbit svhighbit)
svlowbit (min lowbit svlowbit))
(setq svhighbit highbit
svlowbit lowbit)))
(bus
;; String, probably something like `preproc:0
(setq svbusstring bus)))
;; Next
(setq in-list (cdr in-list))
(cond ((and in-list (equal (nth 0 (car in-list)) signal))
;; Combine with this signal
(if (and svbusstring (not (equal svbusstring (nth 1 (car in-list)))))
(message (concat "Warning, can't merge into single bus " signal bus
", the AUTOs may be wrong")))
(setq combo ", ...")
)
(t ;; Doesn't match next signal, add to que, zero in prep for next
(setq out-list
(cons (list signal
(or svbusstring
(if svhighbit
(concat "[" (int-to-string svhighbit) ":" (int-to-string svlowbit) "]")))
(concat comment combo))
out-list)
svhighbit nil svbusstring nil combo ""))))
;;
out-list))
;;
;; Port/Wire/Etc Reading
;;
(defun verilog-read-inst-module ()
"Return module_name when point is inside instantiation."
(save-excursion
(verilog-backward-open-paren)
;; Skip over instantiation name
(verilog-re-search-backward-quick "\\b[a-zA-Z0-9`_\$]" nil nil)
(skip-chars-backward "a-zA-Z0-9`_$")
(verilog-re-search-backward-quick "\\(\\b[a-zA-Z0-9`_\$]\\|)\\)" nil nil) ; ) isn't word boundary
;; Check for parameterized instantiations
(when (looking-at ")")
(search-backward "(")
(verilog-re-search-backward-quick "\\b[a-zA-Z0-9`_\$]" nil nil))
(skip-chars-backward "a-zA-Z0-9'_$")
(looking-at "[a-zA-Z0-9`_\$]+")
;; Important: don't use match string, this must work with emacs 19 font-lock on
(buffer-substring-no-properties (match-beginning 0) (match-end 0))))
(defun verilog-read-inst-name ()
"Return instance_name when point is inside instantiation."
(save-excursion
(verilog-backward-open-paren)
(verilog-re-search-backward-quick "\\b[a-zA-Z0-9`_\$]" nil nil)
(skip-chars-backward "a-zA-Z0-9`_$")
(looking-at "[a-zA-Z0-9`_\$]+")
;; Important: don't use match string, this must work with emacs 19 font-lock on
(buffer-substring-no-properties (match-beginning 0) (match-end 0))))
(defun verilog-read-module-name ()
"Return module name when after its ( or ;."
(save-excursion
(re-search-backward "[(;]")
(verilog-re-search-backward-quick "\\b[a-zA-Z0-9`_\$]" nil nil)
(skip-chars-backward "a-zA-Z0-9`_$")
(looking-at "[a-zA-Z0-9`_\$]+")
;; Important: don't use match string, this must work with emacs 19 font-lock on
(buffer-substring-no-properties (match-beginning 0) (match-end 0))))
(defun verilog-read-auto-params (num-param &optional max-param)
"Return parameter list inside auto.
Optional NUM-PARAM and MAX-PARAM check for a specific number of parameters."
(let ((olist))
(save-excursion
;; /*AUTOPUNT("parameter", "parameter")*/
(search-backward "(")
(while (looking-at "(?\\s *\"\\([^\"]*\\)\"\\s *,?")
(setq olist (cons (match-string 1) olist))
(goto-char (match-end 0))))
(or (eq nil num-param)
(<= num-param (length olist))
(error "%s: Expected %d parameters" (verilog-point-text) num-param))
(if (eq max-param nil) (setq max-param num-param))
(or (eq nil max-param)
(>= max-param (length olist))
(error "%s: Expected <= %d parameters" (verilog-point-text) max-param))
(nreverse olist)))
(defun verilog-read-decls ()
"Compute signal declaration information for the current module at point.
Return a array of [outputs inouts inputs wire reg assign const]."
(let ((end-mod-point (or (verilog-get-end-of-defun t) (point-max)))
(functask 0) (paren 0)
sigs-in sigs-out sigs-inout sigs-wire sigs-reg sigs-assign sigs-const
vec expect-signal keywd newsig rvalue enum)
(save-excursion
(verilog-beg-of-defun)
(setq sigs-const (verilog-read-auto-constants (point) end-mod-point))
(while (< (point) end-mod-point)
;;(if dbg (setq dbg (cons (format "Pt %s Vec %s Kwd'%s'\n" (point) vec keywd) dbg)))
(cond
((looking-at "//")
(if (looking-at "[^\n]+synopsys\\s +enum\\s +\\([a-zA-Z0-9_]+\\)")
(setq enum (match-string 1)))
(search-forward "\n"))
((looking-at "/\\*")
(forward-char 2)
(if (looking-at "[^*]+synopsys\\s +enum\\s +\\([a-zA-Z0-9_]+\\)")
(setq enum (match-string 1)))
(or (search-forward "*/")
(error "%s: Unmatched /* */, at char %d" (verilog-point-text) (point))))
((eq ?\" (following-char))
(or (re-search-forward "[^\\]\"" nil t) ;; don't forward-char first, since we look for a non backslash first
(error "%s: Unmatched quotes, at char %d" (verilog-point-text) (point))))
((eq ?\; (following-char))
(setq vec nil expect-signal nil newsig nil paren 0 rvalue nil)
(forward-char 1))
((eq ?= (following-char))
(setq rvalue t newsig nil)
(forward-char 1))
((and rvalue
(cond ((and (eq ?, (following-char))
(eq paren 0))
(setq rvalue nil)
(forward-char 1)
t)
;; ,'s can occur inside {} & funcs
((looking-at "[{(]")
(setq paren (1+ paren))
(forward-char 1)
t)
((looking-at "[})]")
(setq paren (1- paren))
(forward-char 1)
t)
)))
((looking-at "\\s-*\\(\\[[^]]+\\]\\)")
(goto-char (match-end 0))
(cond (newsig ; Memory, not just width. Patch last signal added's memory (nth 3)
(setcar (cdr (cdr (cdr newsig))) (match-string 1)))
(t ;; Bit width
(setq vec (verilog-string-replace-matches
"\\s-+" "" nil nil (match-string 1))))))
;; Normal or escaped identifier -- note we remember the \ if escaped
((looking-at "\\s-*\\([a-zA-Z0-9`_$]+\\|\\\\[^ \t\n]+\\)")
(goto-char (match-end 0))
(setq keywd (match-string 1))
(when (string-match "^\\\\" keywd)
(setq keywd (concat keywd " "))) ;; Escaped ID needs space at end
(cond ((equal keywd "input")
(setq vec nil enum nil expect-signal 'sigs-in))
((equal keywd "output")
(setq vec nil enum nil expect-signal 'sigs-out))
((equal keywd "inout")
(setq vec nil enum nil expect-signal 'sigs-inout))
((or (equal keywd "wire")
(equal keywd "tri"))
(setq vec nil enum nil expect-signal 'sigs-wire))
((or (equal keywd "reg")
(equal keywd "trireg"))
(setq vec nil enum nil expect-signal 'sigs-reg))
((equal keywd "assign")
(setq vec nil enum nil expect-signal 'sigs-assign))
((or (equal keywd "supply0")
(equal keywd "supply1")
(equal keywd "supply")
(equal keywd "parameter"))
(setq vec nil enum nil expect-signal 'sigs-const))
((or (equal keywd "function")
(equal keywd "task"))
(setq functask (1+ functask)))
((or (equal keywd "endfunction")
(equal keywd "endtask"))
(setq functask (1- functask)))
((and expect-signal
(eq functask 0)
(not rvalue))
;; Add new signal to expect-signal's variable
(setq newsig (list keywd vec nil nil enum))
(set expect-signal (cons newsig
(symbol-value expect-signal))))))
(t
(forward-char 1)))
(skip-syntax-forward " "))
;; Return arguments
(vector (nreverse sigs-out)
(nreverse sigs-inout)
(nreverse sigs-in)
(nreverse sigs-wire)
(nreverse sigs-reg)
(nreverse sigs-assign)
(nreverse sigs-const)
))))
(defun verilog-read-sub-decls-line (comment)
"For read-sub-decl, read lines of port defs until none match anymore.
Return the list of signals found, using COMMENT for each signal."
(let (sigs)
(save-excursion
(forward-line 1)
(while (or
(if (looking-at "\\s-*\\.[^(]*(\\s-*\\(\\\\[^ \t\n]*\\)\\s-*)")
(let ((sig (concat (match-string 1) " ")) ;; escaped id's need trailing space
vec)
(or (equal sig "")
(setq sigs (cons (list sig vec comment)
sigs)))))
(if (looking-at "\\s-*\\.[^(]*(\\s-*\\([^[({)]*\\)\\s-*)")
(let ((sig (verilog-string-remove-spaces (match-string 1)))
vec)
(or (equal sig "")
(setq sigs (cons (list sig vec comment)
sigs)))))
(if (looking-at "\\s-*\\.[^(]*(\\s-*\\([^[({)]*\\)\\s-*\\(\\[[^]]+\\]\\)\\s-*)")
(let ((sig (verilog-string-remove-spaces (match-string 1)))
(vec (match-string 2)))
(or (equal sig "")
(setq sigs (cons (list sig vec comment)
sigs)))))
(looking-at "\\s-*\\.[^(]*("))
(forward-line 1))
sigs)))
(defun verilog-read-sub-decls ()
"Parse signals going to modules under this module.
Return a array of [ outputs inouts inputs ] signals for modules that are
instantiated in this module. For example if declare A A (.B(SIG)) and SIG
is a output, then it will be included in the list.
This only works on instantiations created with /*AUTOINST*/ converted by
\\[verilog-auto-instant]. Otherwise, it would have to read in the whole
component library to determine connectivity of the design."
(save-excursion
(let ((end-mod-point (verilog-get-end-of-defun t))
st-point end-inst-point
sigs-out sigs-inout sigs-in comment)
(verilog-beg-of-defun)
(while (search-forward "/*AUTOINST*/" end-mod-point t)
(save-excursion
(goto-char (match-beginning 0))
(unless (verilog-inside-comment-p)
(forward-line 1)
;; Attempt to snarf a comment
(setq comment (concat (verilog-read-inst-name)
" of " (verilog-read-inst-module) ".v"))
;; This could have used a list created by verilog-auto-instant
;; However I want it to be runnable even if that function wasn't called before.
(verilog-backward-open-paren)
(setq end-inst-point (save-excursion (forward-sexp 1) (point))
st-point (point))
(while (re-search-forward "^\\s *// Outputs" end-inst-point t)
(setq sigs-out (append (verilog-read-sub-decls-line
(concat "From " comment)) sigs-out)))
(goto-char st-point)
(while (re-search-forward "\\s *// Inouts" end-inst-point t)
(setq sigs-inout (append (verilog-read-sub-decls-line
(concat "To/From " comment)) sigs-inout)))
(goto-char st-point)
(while (re-search-forward "\\s *// Inputs" end-inst-point t)
(setq sigs-in (append (verilog-read-sub-decls-line
(concat "To " comment)) sigs-in)))
)))
;; Combine duplicate bits
(vector (verilog-signals-combine-bus sigs-out)
(verilog-signals-combine-bus sigs-inout)
(verilog-signals-combine-bus sigs-in)))))
(defun verilog-read-inst-pins ()
"Return a array of [ pins ] for the current instantiation at point.
For example if declare A A (.B(SIG)) then B will be included in the list."
(save-excursion
(let ((end-mod-point (point)) ;; presume at /*AUTOINST*/ point
pins pin)
(verilog-backward-open-paren)
(while (re-search-forward "\\.\\([^( \t\n]*\\)\\s-*(" end-mod-point t)
(setq pin (match-string 1))
(unless (verilog-inside-comment-p)
(setq pins (cons (list pin) pins))))
(vector pins))))
(defun verilog-read-arg-pins ()
"Return a array of [ pins ] for the current argument declaration at point."
(save-excursion
(let ((end-mod-point (point)) ;; presume at /*AUTOARG*/ point
pins pin)
(verilog-backward-open-paren)
(while (re-search-forward "\\([a-zA-Z0-9`_$]+\\)" end-mod-point t)
(setq pin (match-string 1))
(unless (verilog-inside-comment-p)
(setq pins (cons (list pin) pins))))
(vector pins))))
(defun verilog-read-auto-constants (beg end-mod-point)
"Return a list of AUTO_CONSTANTs used in the region from BEG to END-MOD-POINT."
;; Insert new
(save-excursion
(let (sig-list tpl-end-pt)
(goto-char beg)
(while (re-search-forward "\\<AUTO_CONSTANT" end-mod-point t)
(search-forward "(" end-mod-point)
(setq tpl-end-pt (save-excursion
(backward-char 1)
(forward-sexp 1) ;; Moves to paren that closes argdecl's
(backward-char 1)
(point)))
(while (re-search-forward "\\s-*\\([a-zA-Z0-9`_$]+\\)\\s-*,*" tpl-end-pt t)
(setq sig-list (cons (list (match-string 1) nil nil) sig-list))))
sig-list)))
(defun verilog-read-auto-lisp (start end)
"Look for and evaluate a AUTO_LISP between START and END."
(save-excursion
(goto-char start)
(while (re-search-forward "\\<AUTO_LISP(" end t)
(backward-char)
(let* ((beg-pt (prog1 (point)
(forward-sexp 1))) ;; Closing paren
(end-pt (point)))
(eval-region beg-pt end-pt nil)))))
(eval-when-compile
;; These are passed in a let, not global
(if (not (boundp 'sigs-in))
(defvar sigs-in nil) (defvar sigs-out nil)
(defvar got-sig nil) (defvar got-rvalue nil)))
(defun verilog-read-always-signals-recurse
(exit-keywd rvalue ignore-next)
"Recursive routine for parentheses/bracket matching.
EXIT-KEYWD is expression to stop at, nil if top level.
RVALUE is true if at right hand side of equal.
IGNORE-NEXT is true to ignore next token, fake from inside case statement."
(let* ((semi-rvalue (equal "endcase" exit-keywd)) ;; true if after a ; we are looking for rvalue
keywd last-keywd sig-tolk sig-last-tolk gotend end-else-check)
;;(if dbg (setq dbg (concat dbg (format "Recursion %S %S %S\n" exit-keywd rvalue ignore-next))))
(while (not (or (eobp) gotend))
(cond
((looking-at "//")
(search-forward "\n"))
((looking-at "/\\*")
(or (search-forward "*/")
(error "%s: Unmatched /* */, at char %d" (verilog-point-text) (point))))
(t (setq keywd (buffer-substring-no-properties
(point)
(save-excursion (when (eq 0 (skip-chars-forward "a-zA-Z0-9$_.%`"))
(forward-char 1))
(point)))
sig-last-tolk sig-tolk
sig-tolk nil)
;;(if dbg (setq dbg (concat dbg (format "\tPt %S %S\t%S %S\n" (point) keywd rvalue ignore-next))))
(cond
((equal keywd "\"")
(or (re-search-forward "[^\\]\"" nil t)
(error "%s: Unmatched quotes, at char %d" (verilog-point-text) (point))))
;; else at top level loop, keep parsing
((and end-else-check (equal keywd "else"))
;;(if dbg (setq dbg (concat dbg (format "\tif-check-else %s\n" keywd))))
;; no forward movement, want to see else in lower loop
(setq end-else-check nil))
;; End at top level loop
((and end-else-check (looking-at "^[ \t\n]"))
;;(if dbg (setq dbg (concat dbg (format "\tif-check-else-other %s\n" keywd))))
(setq gotend t))
;; Final statement?
((and exit-keywd (equal keywd exit-keywd))
(setq gotend t)
(forward-char (length keywd)))
;; Standard tokens...
((equal keywd ";")
(setq ignore-next nil rvalue semi-rvalue)
;; Final statement at top level loop?
(when (not exit-keywd)
;;(if dbg (setq dbg (concat dbg (format "\ttop-end-check %s\n" keywd))))
(setq end-else-check t))
(forward-char 1))
((equal keywd "'")
(if (looking-at "'[odbhx][_xz?0-9a-fA-F \t]*")
(goto-char (match-end 0))
(forward-char 1)))
((equal keywd ":") ;; Case statement, begin/end label, x?y:z
(cond ((equal "endcase" exit-keywd) ;; case x: y=z; statement next
(setq ignore-next nil rvalue nil))
((not rvalue) ;; begin label
(setq ignore-next t rvalue nil)))
(forward-char 1))
((equal keywd "=")
(setq ignore-next nil rvalue t)
(forward-char 1))
((equal keywd "?")
(forward-char 1)
(verilog-read-always-signals-recurse ":" rvalue nil))
((equal keywd "[")
(forward-char 1)
(verilog-read-always-signals-recurse "]" t nil))
((equal keywd "(")
(forward-char 1)
(cond (sig-last-tolk ;; Function call; zap last signal
(setq got-sig nil)))
(cond ((equal last-keywd "for")
(verilog-read-always-signals-recurse ";" nil nil)
(verilog-read-always-signals-recurse ";" t nil)
(verilog-read-always-signals-recurse ")" nil nil))
(t (verilog-read-always-signals-recurse ")" t nil))))
((equal keywd "begin")
(skip-syntax-forward "w_")
(verilog-read-always-signals-recurse "end" nil nil)
(setq ignore-next nil rvalue semi-rvalue)
(if (not exit-keywd) (setq gotend t))) ;; top level begin/end
((or (equal keywd "case")
(equal keywd "casex")
(equal keywd "casez"))
(skip-syntax-forward "w_")
(verilog-read-always-signals-recurse "endcase" t nil)
(setq ignore-next nil rvalue semi-rvalue)
(if (not exit-keywd) (setq gotend t))) ;; top level begin/end
((string-match "^[$`a-zA-Z_]" keywd) ;; not exactly word constituent
(cond ((equal keywd "`ifdef")
(setq ignore-next t))
((or ignore-next
(member keywd verilog-keywords)
(string-match "^\\$" keywd)) ;; PLI task
(setq ignore-next nil))
(t
(when (string-match "^`" keywd)
;; This only will work if the define is a simple signal, not
;; something like a[b]. Sorry, it should be substituted into the parser
(setq keywd
(verilog-string-replace-matches
"\[[^0-9: \t]+\]" "" nil nil
(or (verilog-symbol-detick keywd nil)
(if verilog-auto-sense-defines-constant
"0"
keywd))))
(if (or (string-match "^[0-9 \t:]+$" keywd)
(string-match "^[---]*[0-9]+$" keywd)
(string-match "^[0-9 \t]+'[odbhx][_xz?0-9a-fA-F \t]*$" keywd)
)
(setq keywd nil))
)
(if got-sig (if got-rvalue
(setq sigs-in (cons got-sig sigs-in))
(setq sigs-out (cons got-sig sigs-out))))
(setq got-rvalue rvalue
got-sig (if (or (not keywd)
(assoc keywd (if got-rvalue sigs-in sigs-out)))
nil (list keywd nil nil))
sig-tolk t)))
(skip-chars-forward "a-zA-Z0-9$_.%`"))
(t
(forward-char 1)))
;; End of non-comment token
(setq last-keywd keywd)
))
(skip-syntax-forward " "))
;;(if dbg (setq dbg (concat dbg (format "ENDRecursion %s\n" exit-keywd))))
))
(defun verilog-read-always-signals ()
"Parse always block at point and return list of (outputs inout inputs)."
;; Insert new
(save-excursion
(let* (;;(dbg "")
sigs-in sigs-out
got-sig got-rvalue) ;; Found signal/rvalue; push if not function
(search-forward ")")
(verilog-read-always-signals-recurse nil nil nil)
;; Return what was found
(if got-sig (if got-rvalue
(setq sigs-in (cons got-sig sigs-in))
(setq sigs-out (cons got-sig sigs-out))))
;;(if dbg (message dbg))
(list sigs-out nil sigs-in))))
(defun verilog-read-instants ()
"Parse module at point and return list of ( ( file instance ) ... )."
(verilog-beg-of-defun)
(let* ((end-mod-point (verilog-get-end-of-defun t))
(state nil)
(instants-list nil))
(save-excursion
(while (< (point) end-mod-point)
;; Stay at level 0, no comments
(while (progn
(setq state (parse-partial-sexp (point) end-mod-point 0 t nil))
(or (> (car state) 0) ; in parens
(nth 5 state) ; comment
))
(forward-line 1))
(beginning-of-line)
(if (looking-at "^\\s-*\\([a-zA-Z0-9`_$]+\\)\\s-+\\([a-zA-Z0-9`_$]+\\)\\s-*(")
;;(if (looking-at "^\\(.+\\)$")
(let ((module (match-string 1))
(instant (match-string 2)))
(if (not (member module verilog-keywords))
(setq instants-list (cons (list module instant) instants-list)))))
(forward-line 1)
))
instants-list))
(defun verilog-read-auto-template (module)
"Look for a auto_template for the instantiation of the given MODULE.
If found returns the signal name connections. Return nil or list of
( (signal_name connection_name)... )"
(save-excursion
;; Find beginning
(let (tpl-sig-list tpl-wild-list tpl-end-pt rep)
(cond ((or
(re-search-backward (concat "^\\s-*/?\\*?\\s-*" module "\\s-+AUTO_TEMPLATE") nil t)
(progn
(goto-char (point-min))
(re-search-forward (concat "^\\s-*/?\\*?\\s-*" module "\\s-+AUTO_TEMPLATE") nil t)))
(search-forward "(")
(setq tpl-end-pt (save-excursion
(backward-char 1)
(forward-sexp 1) ;; Moves to paren that closes argdecl's
(backward-char 1)
(point)))
;;
(while (< (point) tpl-end-pt)
(cond ((looking-at "\\s-*\\.\\([a-zA-Z0-9`_$]+\\)\\s-*(\\(.*\\))\\s-*\\(,\\|)\\s-*;\\)")
(setq tpl-sig-list (cons (list
(match-string 1)
(match-string 2))
tpl-sig-list)))
;; Regexp form??
((looking-at
;; Regexp bug in xemacs disallows ][ inside [], and wants + last
"\\s-*\\.\\(\\([a-zA-Z0-9`_$+@^.*?---]+\\|[][]\\|\\\\[()]\\)+\\)\\s-*(\\(.*\\))\\s-*\\(,\\|)\\s-*;\\)")
(setq rep (match-string 3))
(setq tpl-wild-list
(cons (list
(concat "^"
(verilog-string-replace-matches "@" "\\\\([0-9]+\\\\)" nil nil
(match-string 1))
"$")
rep)
tpl-wild-list))))
(forward-line 1))
;;
(list tpl-sig-list tpl-wild-list)
)))))
;;(progn (find-file "auto-template.v") (verilog-read-auto-template "ptl_entry"))
(defun verilog-set-define (defname defvalue &optional buffer)
"In BUFFER, set the definition DEFNAME to the DEFVALUE."
(save-excursion
(set-buffer (or buffer (current-buffer)))
(let ((mac (intern (concat "vh-" defname))))
;;(message "Define %s=%s" defname defvalue) (sleep-for 1)
(set (make-variable-buffer-local mac) defvalue))))
(defun verilog-read-defines (&optional filename recurse)
"Read `defines for the current file, or from the optional FILENAME.
If the filename is provided, `verilog-library-directories' and
`verilog-library-extensions' will be used to resolve it.
If optional RECURSE is non-nil, recurse through `includes.
Defines must be simple text substitutions, one on a line, starting
at the beginning of the line. Any ifdefs or multiline comments around the
define are ignored.
Defines are stored inside Emacs variables using the name vh-{definename}.
This function is useful for setting vh-* variables. The file variables
feature can be used to set defines that `verilog-mode' can see; put at the
*END* of your file something like:
// Local Variables:
// vh-macro:\"macro_definition\"
// End:
If macros are defined earlier in the same file and you want their values,
you can read them automatically (provided `enable-local-eval' is on):
// Local Variables:
// eval:(verilog-read-defines)
// eval:(verilog-read-defines \"group_standard_includes.v\")
// End:
Note these are only read when the file is first visited, you must use
\\[find-alternate-file] RET to have these take effect after editing them!"
(let ((origbuf (current-buffer)))
(save-excursion
(when filename
(let ((fns (verilog-library-filenames filename (buffer-file-name))))
(if fns
(set-buffer (find-file-noselect (car fns)))
(error (concat (verilog-point-text)
": Can't find verilog-read-defines file: " filename)))))
(when recurse
(goto-char (point-min))
(while (re-search-forward "^\\s-*`include\\s-+\\([^ \t\n]+\\)" nil t)
(let ((inc (verilog-string-replace-matches "\"" "" nil nil (match-string 1))))
(verilog-read-defines inc recurse))))
;; Read `defines
(goto-char (point-min))
(while (verilog-re-search-forward "^\\s-*`define\\s-+\\([a-zA-Z0-9_$]+\\)\\s-+\\(.*\\)$" nil t)
(let ((defname (match-string 1))
(defvalue (match-string 2)))
(setq defvalue (verilog-string-replace-matches "\\s-*/[/*].*$" "" nil nil defvalue))
(verilog-set-define defname defvalue origbuf)))
;; Hack: Read parameters
(goto-char (point-min))
(while (verilog-re-search-forward "^\\s-*parameter\\s-+\\([a-zA-Z0-9_$]+\\)\\s-+=\\s-+\\([^;]*\\)" nil t)
(verilog-set-define (match-string 1) (match-string 2) origbuf))
)))
(defun verilog-read-includes ()
"Read `includes for the current file.
This will find all of the `includes which are at the beginning of lines,
ignoring any ifdefs or multiline comments around them.
`verilog-read-defines' is then performed on the current and each included
file.
It is often useful put at the *END* of your file something like:
// Local Variables:
// eval:(verilog-read-includes)
// End:
Note includes are only read when the file is first visited, you must use
\\[find-alternate-file] RET to have these take effect after editing them!
It is good to get in the habit of including all needed files in each .v
file that needs it, rather then waiting for compile time. This will aid
this process, Verilint, and readability. To prevent defining the same
variable over and over when many modules are compiled together, put a test
around the inside each include file:
foo.v (a include):
`ifdef _FOO_V // include if not already included
`else
`define _FOO_V
... contents of file
`endif // _FOO_V"
;;slow: (verilog-read-defines nil t))
(save-excursion
(goto-char (point-min))
(while (re-search-forward "^\\s-*`include\\s-+\\([^ \t\n]+\\)" nil t)
(let ((inc (verilog-string-replace-matches "\"" "" nil nil (match-string 1))))
(verilog-read-defines inc)))))
(defun verilog-read-signals (&optional start end)
"Return a simple list of all possible signals in the file.
Bounded by optional region from START to END. Overly aggressive but fast.
Some macros and such are also found and included. For dinotrace.el"
(let (sigs-all keywd)
(progn;save-excursion
(goto-char (or start (point-min)))
(setq end (or end (point-max)))
(while (re-search-forward "[\"/a-zA-Z_]" end t)
(forward-char -1)
(cond
((looking-at "//")
(search-forward "\n"))
((looking-at "/\\*")
(search-forward "*/"))
((eq ?\" (following-char))
(re-search-forward "[^\\]\"")) ;; don't forward-char first, since we look for a non backslash first
((looking-at "\\s-*\\([a-zA-Z0-9`_$]+\\)")
(goto-char (match-end 0))
(setq keywd (match-string-no-properties 1))
(or (member keywd verilog-keywords)
(member keywd sigs-all)
(setq sigs-all (cons keywd sigs-all))))
(t (forward-char 1)))
)
;; Return list
sigs-all)))
;;
;; Module name lookup
;;
(defun verilog-module-inside-filename-p (module filename)
"Return point if MODULE is specified inside FILENAME, else nil.
Allows version control to check out the file if need be."
(and (or (file-exists-p filename)
(and
(condition-case nil
(fboundp 'vc-backend)
(error nil))
(vc-backend filename)))
(let (pt)
(save-excursion
(set-buffer (find-file-noselect filename))
(goto-char (point-min))
(while (and
;; It may be tempting to look for verilog-defun-re, don't, it slows things down a lot!
(verilog-re-search-forward-quick "module" nil t)
(verilog-re-search-forward-quick "[(;]" nil t))
(if (equal module (verilog-read-module-name))
(setq pt (point))))
pt))))
(defun verilog-symbol-detick (symbol wing-it)
"Return a expanded SYMBOL name without any defines.
If the variable vh-{symbol} is defined, return that value.
If undefined, and WING-IT, return just SYMBOL without the tick, else nil."
(while (and symbol (string-match "^`" symbol))
(setq symbol (substring symbol 1))
(if (boundp (intern (concat "vh-" symbol)))
(setq symbol (eval (intern (concat "vh-" symbol))))
(if (not wing-it) (setq symbol nil))))
symbol)
;;(verilog-symbol-detick "`mod" nil)
(defun verilog-expand-dirnames (&optional dirnames)
"Return a list of existing directories given a list of wildcarded dirnames
or just the existing dirnames themselves if there are no wildcards."
(interactive)
(unless dirnames (error "verilog-library-directories should include at least '.'"))
(setq dirnames (reverse dirnames)) ; not nreverse
(let ((dirlist nil)
pattern dirfile dirfiles dirname root filename rest)
(while dirnames
(setq dirname (car dirnames)
dirnames (cdr dirnames))
(cond ((string-match (concat "^\\(\\|[/\\]*[^*?]*[/\\]\\)" ;; root
"\\([^/\\]*[*?][^/\\]*\\)" ;; filename with *?
"\\(.*\\)") ;; rest
dirname)
(setq root (match-string 1 dirname)
filename (match-string 2 dirname)
rest (match-string 3 dirname)
pattern filename)
;; now replace those * and ? with .+ and .
;; use ^ and /> to get only whole file names
;;verilog-string-replace-matches
(setq pattern (verilog-string-replace-matches "[*]" ".+" nil nil pattern)
pattern (verilog-string-replace-matches "[?]" "." nil nil pattern)
;; Unfortunately allows abc/*/rtl to match abc/rtl
;; because abc/.. shows up in dirfiles. Solutions welcome.
dirfiles (directory-files root t pattern nil))
(while dirfiles
(setq dirfile (expand-file-name (concat (car dirfiles) rest))
dirfiles (cdr dirfiles))
(if (file-directory-p dirfile)
(setq dirlist (cons dirfile dirlist))))
)
;; Defaults
(t
(if (file-directory-p dirname)
(setq dirlist (cons dirname dirlist))))
))
dirlist))
;;(verilog-expand-dirnames (list "." ".." "nonexist" "../*" "/home/wsnyder/*/v"))
(defun verilog-library-filenames (filename current)
"Return a search path to find the given FILENAME name.
Uses the CURRENT filename, `verilog-library-directories' and
`verilog-library-extensions` variables to build the path."
(let ((ckdir (verilog-expand-dirnames verilog-library-directories))
fn outlist)
(while ckdir
(setq fn (expand-file-name
filename
(expand-file-name (car ckdir) (file-name-directory current))))
(if (file-exists-p fn)
(setq outlist (cons fn outlist)))
(setq ckdir (cdr ckdir)))
(nreverse outlist)))
(defun verilog-module-filenames (module current)
"Return a search path to find the given MODULE name.
Uses the CURRENT filename, `verilog-library-extensions',
`verilog-library-directories' and `verilog-library-files'
variables to build the path."
;; Return search locations for it
(append (list current) ; first, current buffer
(let ((ext verilog-library-extensions) flist)
(while ext
(setq flist
(append (verilog-library-filenames
(concat module (car ext)) current) flist)
ext (cdr ext)))
flist)
verilog-library-files ; finally, any libraries
))
;;
;; Module Information
;;
;; Many of these functions work on "modi" a module information structure
;; A modi is: [module-name-string file-name begin-point]
(defvar verilog-cache-enabled t
"If true, enable caching of signals, etc. Set to nil for debugging to make things SLOW!")
(defvar verilog-modi-cache-list nil
"Cache of ((Module Function) Buf-Tick Buf-Modtime Func-Returns)...
For speeding up verilog-modi-get-* commands.
Buffer-local.")
(defvar verilog-modi-cache-preserve-tick nil
"Modification tick after which the cache is still considered valid.
Use verilog-preserve-cache's to set")
(defvar verilog-modi-cache-preserve-buffer nil
"Modification tick after which the cache is still considered valid.
Use verilog-preserve-cache's to set")
(defun verilog-modi-current ()
"Return the modi structure for the module currently at point."
(let* (name pt)
;; read current module's name
(save-excursion
(verilog-re-search-backward-quick verilog-defun-re nil nil)
(verilog-re-search-forward-quick "(" nil nil)
(setq name (verilog-read-module-name))
(setq pt (point)))
;; return
(vector name (or (buffer-file-name) (current-buffer)) pt)))
(defvar verilog-modi-lookup-last-mod nil "Cache of last module looked up.")
(defvar verilog-modi-lookup-last-current nil "Cache of last current looked up.")
(defvar verilog-modi-lookup-last-modi nil "Cache of last modi returned.")
(defun verilog-modi-lookup (module allow-cache)
"Find the file and point at which MODULE is defined.
If ALLOW-CACHE is set, check and remember cache of previous lookups.
Return modi if successful, else print message."
(let* ((current (or (buffer-file-name) (current-buffer))))
(cond ((and (equal verilog-modi-lookup-last-mod module)
(equal verilog-modi-lookup-last-current current)
verilog-modi-lookup-last-modi
verilog-cache-enabled
allow-cache)
;; ok as is
)
(t (let* ((realmod (verilog-symbol-detick module t))
(orig-filenames (verilog-module-filenames realmod current))
(filenames orig-filenames)
pt)
(while (and filenames (not pt))
(if (not (setq pt (verilog-module-inside-filename-p realmod (car filenames))))
(setq filenames (cdr filenames))))
(cond (pt (setq verilog-modi-lookup-last-modi
(vector realmod (car filenames) pt)))
(t (setq verilog-modi-lookup-last-modi nil)
(error (concat (verilog-point-text)
": Can't locate " module " module definition"
(if (not (equal module realmod))
(concat " (Expanded macro to " realmod ")")
"")
"\n Check the verilog-library-directories variable."
"\n I looked in (if not listed, doesn't exist):\n\t" (mapconcat 'concat orig-filenames "\n\t"))))
)
(setq verilog-modi-lookup-last-mod module
verilog-modi-lookup-last-current current))))
verilog-modi-lookup-last-modi
))
(defsubst verilog-modi-name (modi)
(aref modi 0))
(defun verilog-modi-goto (modi)
"Move point/buffer to specified MODI."
(or modi (error "Passed unfound modi to goto, check earlier"))
(set-buffer (if (bufferp (aref modi 1))
(aref modi 1)
(find-file-noselect (aref modi 1))))
(or (equal major-mode `verilog-mode) ;; Put into verilog mode to get syntax
(verilog-mode))
(goto-char (aref modi 2)))
(defun verilog-goto-defun-file (module)
"Move point to the file at which a given MODULE is defined."
(interactive "sGoto File for Module: ")
(let* ((modi (verilog-modi-lookup module nil)))
(when modi
(verilog-modi-goto modi)
(switch-to-buffer (current-buffer)))))
(defun verilog-modi-cache-results (modi function)
"Run on MODI the given FUNCTION. Locate the module in a file.
Cache the output of function so next call may have faster access."
(let (func-returns fass)
(save-excursion
(verilog-modi-goto modi)
(if (and (setq fass (assoc (list (verilog-modi-name modi) function)
verilog-modi-cache-list))
;; Destroy caching when incorrect; Modified or file changed
(not (and verilog-cache-enabled
(or (equal (buffer-modified-tick) (nth 1 fass))
(and verilog-modi-cache-preserve-tick
(<= verilog-modi-cache-preserve-tick (nth 1 fass))
(equal verilog-modi-cache-preserve-buffer (current-buffer))))
(equal (visited-file-modtime) (nth 2 fass)))))
(setq verilog-modi-cache-list nil
fass nil))
(cond (fass
;; Found
(setq func-returns (nth 3 fass)))
(t
;; Read from file
;; Clear then restore any hilighting to make emacs19 happy
(let ((fontlocked (when (and (memq 'v19 verilog-emacs-features)
(boundp 'font-lock-mode)
font-lock-mode)
(font-lock-mode nil)
t)))
(setq func-returns (funcall function))
(when fontlocked (font-lock-mode t)))
;; Cache for next time
(make-variable-buffer-local 'verilog-modi-cache-list)
(setq verilog-modi-cache-list
(cons (list (list (verilog-modi-name modi) function)
(buffer-modified-tick)
(visited-file-modtime)
func-returns)
verilog-modi-cache-list)))
))
;;
func-returns))
(defun verilog-modi-cache-add (modi function element sig-list)
"Add function return results to the module cache.
Update MODI's cache for given FUNCTION so that the return ELEMENT of that
function now contains the additional SIG-LIST parameters."
(let (fass)
(save-excursion
(verilog-modi-goto modi)
(if (setq fass (assoc (list (verilog-modi-name modi) function)
verilog-modi-cache-list))
(let ((func-returns (nth 3 fass)))
(aset func-returns element
(append sig-list (aref func-returns element))))))))
(defmacro verilog-preserve-cache (&rest body)
"Execute the BODY forms, allowing cache preservation within BODY.
This means that changes to the buffer will not result in the cache being
flushed. If the changes affect the modsig state, they must call the
modsig-cache-add-* function, else the results of later calls may be
incorrect. Without this, changes are assumed to be adding/removing signals
and invalidating the cache."
`(let ((verilog-modi-cache-preserve-tick (buffer-modified-tick))
(verilog-modi-cache-preserve-buffer (current-buffer)))
(progn ,@body)))
(defsubst verilog-modi-get-decls (modi)
(verilog-modi-cache-results modi 'verilog-read-decls))
(defsubst verilog-modi-get-sub-decls (modi)
(verilog-modi-cache-results modi 'verilog-read-sub-decls))
;; Signal reading for given module
;; Note these all take modi's - as returned from the verilog-modi-current function
(defsubst verilog-modi-get-outputs (modi)
(aref (verilog-modi-get-decls modi) 0))
(defsubst verilog-modi-get-inouts (modi)
(aref (verilog-modi-get-decls modi) 1))
(defsubst verilog-modi-get-inputs (modi)
(aref (verilog-modi-get-decls modi) 2))
(defsubst verilog-modi-get-wires (modi)
(aref (verilog-modi-get-decls modi) 3))
(defsubst verilog-modi-get-regs (modi)
(aref (verilog-modi-get-decls modi) 4))
(defsubst verilog-modi-get-assigns (modi)
(aref (verilog-modi-get-decls modi) 5))
(defsubst verilog-modi-get-consts (modi)
(aref (verilog-modi-get-decls modi) 6))
(defsubst verilog-modi-get-sub-outputs (modi)
(aref (verilog-modi-get-sub-decls modi) 0))
(defsubst verilog-modi-get-sub-inouts (modi)
(aref (verilog-modi-get-sub-decls modi) 1))
(defsubst verilog-modi-get-sub-inputs (modi)
(aref (verilog-modi-get-sub-decls modi) 2))
;; Elements of a signal list
(defsubst verilog-sig-name (sig)
(car sig))
(defsubst verilog-sig-bits (sig)
(nth 1 sig))
(defsubst verilog-sig-comment (sig)
(nth 2 sig))
(defsubst verilog-sig-memory (sig)
(nth 3 sig))
(defsubst verilog-sig-enum (sig)
(nth 4 sig))
(defsubst verilog-alw-get-inputs (sigs)
(nth 2 sigs))
(defsubst verilog-alw-get-outputs (sigs)
(nth 0 sigs))
(defun verilog-signals-matching-enum (in-list enum)
"Return all signals in IN-LIST matching the given ENUM."
(let (out-list)
(while in-list
(if (equal (verilog-sig-enum (car in-list)) enum)
(setq out-list (cons (car in-list) out-list)))
(setq in-list (cdr in-list)))
(nreverse out-list)))
;; Combined
(defun verilog-modi-get-signals (modi)
(append
(verilog-modi-get-outputs modi)
(verilog-modi-get-inouts modi)
(verilog-modi-get-inputs modi)
(verilog-modi-get-wires modi)
(verilog-modi-get-regs modi)
(verilog-modi-get-assigns modi)
(verilog-modi-get-consts modi)))
(defun verilog-modi-get-ports (modi)
(append
(verilog-modi-get-outputs modi)
(verilog-modi-get-inouts modi)
(verilog-modi-get-inputs modi)))
(defsubst verilog-modi-cache-add-outputs (modi sig-list)
(verilog-modi-cache-add modi 'verilog-read-decls 0 sig-list))
(defsubst verilog-modi-cache-add-inouts (modi sig-list)
(verilog-modi-cache-add modi 'verilog-read-decls 1 sig-list))
(defsubst verilog-modi-cache-add-inputs (modi sig-list)
(verilog-modi-cache-add modi 'verilog-read-decls 2 sig-list))
(defsubst verilog-modi-cache-add-wires (modi sig-list)
(verilog-modi-cache-add modi 'verilog-read-decls 3 sig-list))
(defsubst verilog-modi-cache-add-regs (modi sig-list)
(verilog-modi-cache-add modi 'verilog-read-decls 4 sig-list))
(defun verilog-signals-from-signame (signame-list)
"Return signals in standard form from SIGNAME-LIST, a simple list of signal names."
(mapcar (function (lambda (name) (list name nil nil)))
signame-list))
;;
;; Auto creation utilities
;;
(defun verilog-auto-search-do (search-for func)
"Search for the given auto text SEARCH-FOR, and perform FUNC where it occurs."
(goto-char (point-min))
(while (search-forward search-for nil t)
(if (not (save-excursion
(goto-char (match-beginning 0))
(verilog-inside-comment-p)))
(funcall func))))
(defun verilog-auto-re-search-do (search-for func)
"Search for the given auto text SEARCH-FOR, and perform FUNC where it occurs."
(goto-char (point-min))
(while (re-search-forward search-for nil t)
(if (not (save-excursion
(goto-char (match-beginning 0))
(verilog-inside-comment-p)))
(funcall func))))
(defun verilog-insert-definition (sigs type indent-pt &optional dont-sort)
"Print out a definition for a list of SIGS of the given TYPE,
with appropriate INDENT-PT indentation. Sort unless DONT-SORT.
TYPE is normally wire/reg/output."
(or dont-sort
(setq sigs (sort (copy-alist sigs) `verilog-signals-sort-compare)))
(while sigs
(let ((sig (car sigs)))
(indent-to indent-pt)
(insert type)
(when (verilog-sig-bits sig)
(insert " " (verilog-sig-bits sig)))
(indent-to (max 24 (+ indent-pt 16)))
(insert (concat (verilog-sig-name sig) ";"))
(if (not (verilog-sig-comment sig))
(insert "\n")
(indent-to (max 48 (+ indent-pt 40)))
(insert (concat "// " (verilog-sig-comment sig) "\n")))
(setq sigs (cdr sigs)))))
(eval-when-compile
(if (not (boundp 'indent-pt))
(defvar indent-pt nil "Local used by insert-indent")))
(defun verilog-insert-indent (&rest stuff)
"Indent to position stored in local `indent-pt' variable, then insert STUFF.
Presumes that any newlines end a list element."
(let ((need-indent t))
(while stuff
(if need-indent (indent-to indent-pt))
(setq need-indent nil)
(insert (car stuff))
(setq need-indent (string-match "\n$" (car stuff))
stuff (cdr stuff)))))
;;(let ((indent-pt 10)) (verilog-insert-indent "hello\n" "addon" "there\n"))
(defun verilog-get-list (start end)
"Return the elements of a comma separated list."
(interactive)
(let ((my-list (list))
my-string)
(save-excursion
(while (< (point) end)
(when (re-search-forward "\\([^,{]+\\)" end t)
(setq my-string (verilog-string-remove-spaces (match-string 1)))
(setq my-list (nconc my-list (list my-string) ))
(goto-char (match-end 0))))
my-list)))
(defun verilog-make-width-expression (range-exp)
"Return an expression calculating the length of a range [x:y]."
(interactive)
;; strip off the []
(string-match "\\[\\([^]]*\\)\\]" range-exp)
(setq range-exp (match-string 1 range-exp))
(setq range-exp (verilog-symbol-detick range-exp t))
(cond ((string-match "\\([^:]*\\):\\([^]]*\\)" range-exp) ;; a range z:y
(let ((range-exp-1 (match-string 1 range-exp))
(range-exp-2 (match-string 2 range-exp)))
(concat "+1+abs(" range-exp-1 "-" range-exp-2 ")")))
((string-match "\\([0-9]+\\)" range-exp) ;; a range number
(let ((range-exp-1 (match-string 1 range-exp)))
(concat "+1")))
((concat "+" range-exp))
))
;;
;; Auto deletion
;;
(defun verilog-delete-autos-lined ()
"Delete autos that occupy multiple lines, between begin and end comments."
(let ((pt (point)))
(forward-line 1)
(when (and
(looking-at "\\s-*// Beginning")
(search-forward "// End of automatic" nil t))
;; End exists
(end-of-line)
(delete-region pt (point))
(forward-line 1))
))
(defun verilog-backward-open-paren ()
"Find the open parenthesis that match the current point,
ignore other open parenthesis with matching close parens"
(let ((parens 1))
(while (> parens 0)
(unless (verilog-re-search-backward-quick "[()]" nil t)
(error "%s: Mismatching ()" (verilog-point-text)))
(cond ((looking-at ")")
(setq parens (1+ parens)))
((looking-at "(")
(setq parens (1- parens)))))))
(defun verilog-delete-to-paren ()
"Delete the automatic inst/sense/arg created by autos.
Deletion stops at the matching end parenthesis."
(delete-region (point)
(save-excursion
(verilog-backward-open-paren)
(forward-sexp 1) ;; Moves to paren that closes argdecl's
(backward-char 1)
(point))))
(defun verilog-delete-auto ()
"Delete the automatic outputs, regs, and wires created by \\[verilog-auto].
Use \\[verilog-auto] to re-insert the updated AUTOs."
(interactive)
(save-excursion
(if (buffer-file-name)
(find-file-noselect (buffer-file-name))) ;; To check we have latest version
;; Remove those that have multi-line insertions
(verilog-auto-re-search-do "/\\*AUTO\\(OUTPUTEVERY\\|CONCATCOMMENT\\|WIRE\\|REG\\|DEFINEVALUE\\|REGINPUT\\|INPUT\\|OUTPUT\\|RESET\\)\\*/"
'verilog-delete-autos-lined)
;; Remove those that have multi-line insertions with parameters
(verilog-auto-re-search-do "/\\*AUTO\\(INOUTMODULE\\|ASCIIENUM\\)([^)]*)\\*/"
'verilog-delete-autos-lined)
;; Remove those that are in parenthesis
(verilog-auto-re-search-do "/\\*\\(AS\\|AUTO\\(ARG\\|CONCATWIDTH\\|INST\\|SENSE\\)\\)\\*/"
'verilog-delete-to-paren)
;; Remove template comments ... anywhere in case was pasted after AUTOINST removed
(goto-char (point-min))
(while (re-search-forward "\\s-*// Templated\\s-*$" nil t)
(replace-match ""))))
;;
;; Auto save
;;
(defun verilog-auto-save-check ()
"On saving see if we need auto update."
(cond ((not verilog-auto-save-policy)) ; disabled
((not (save-excursion
(save-match-data
(let ((case-fold-search nil))
(goto-char (point-min))
(re-search-forward "AUTO" nil t))))))
((eq verilog-auto-save-policy 'force)
(verilog-auto))
((not (buffer-modified-p)))
((eq verilog-auto-update-tick (buffer-modified-tick))) ; up-to-date
((eq verilog-auto-save-policy 'detect)
(verilog-auto))
(t
(when (yes-or-no-p "AUTO statements not recomputed, do it now? ")
(verilog-auto))
;; Don't ask again if didn't update
(set (make-local-variable 'verilog-auto-update-tick) (buffer-modified-tick))
))
nil) ;; Always return nil -- we don't write the file ourselves
;;
;; Auto creation
;;
(defun verilog-auto-arg-ports (sigs message indent-pt)
"Print a list of ports for a AUTOINST.
Takes SIGS list, adds MESSAGE to front and inserts each at INDENT-PT."
(when sigs
(insert "\n")
(indent-to indent-pt)
(insert message)
(insert "\n")
(indent-to indent-pt)
(while sigs
(cond ((> (+ 2 (current-column) (length (verilog-sig-name (car sigs)))) fill-column)
(insert "\n")
(indent-to indent-pt)))
(insert (verilog-sig-name (car sigs)) ", ")
(setq sigs (cdr sigs)))))
(defun verilog-auto-arg ()
"Expand AUTOARG statements.
Replace the argument declarations at the beginning of the
module with ones automatically derived from input and output
statements. This can be dangerous if the module is instantiated
using position-based connections, so use only name-based when
instantiating the resulting module. Long lines are split based
on the `fill-column', see \\[set-fill-column].
Limitations:
Concatenation and outputting partial busses is not supported.
For example:
module ex_arg (/*AUTOARG*/);
input i;
output o;
endmodule
Typing \\[verilog-auto] will make this into:
module ex_arg (/*AUTOARG*/
// Outputs
o,
// Inputs
i
);
input i;
output o;
endmodule
Any ports declared between the ( and /*AUTOARG*/ are presumed to be
predeclared and are not redeclared by AUTOARG. You need to know whether to
put a comma just before the AUTOARG or not, based upon whether there will be
ports in the AUTOARG or not; this is not determined for you. Avoid
declaring ports manually, as it makes code harder to maintain."
(save-excursion
(let ((modi (verilog-modi-current))
(skip-pins (aref (verilog-read-arg-pins) 0))
(pt (point)))
(verilog-auto-arg-ports (verilog-signals-not-in
(verilog-modi-get-outputs modi)
skip-pins)
"// Outputs"
verilog-indent-level-declaration)
(verilog-auto-arg-ports (verilog-signals-not-in
(verilog-modi-get-inouts modi)
skip-pins)
"// Inouts"
verilog-indent-level-declaration)
(verilog-auto-arg-ports (verilog-signals-not-in
(verilog-modi-get-inputs modi)
skip-pins)
"// Inputs"
verilog-indent-level-declaration)
(save-excursion
(if (re-search-backward "," pt t)
(delete-char 2)))
(unless (eq (char-before) ?/ )
(insert "\n"))
(indent-to verilog-indent-level-declaration)
)))
(defun verilog-auto-inst-port-map (port-st)
nil)
(defvar vector-skip-list nil) ; Prevent compile warning
(defun verilog-auto-inst-port (port-st indent-pt tpl-list tpl-num)
"Print out a instantiation connection for this PORT-ST.
Insert to INDENT-PT, use template TPL-LIST.
@ are instantiation numbers, replaced with TPL-NUM.
@\"(expression @)\" are evaluated, with @ as a variable."
(let* ((port (verilog-sig-name port-st))
(tpl-ass (or (assoc port (car tpl-list))
(verilog-auto-inst-port-map port-st)))
;; vl-* are documented for user use
(vl-name (verilog-sig-name port-st))
(vl-bits (if (or verilog-auto-inst-vector
(not (assoc port vector-skip-list))
(not (equal (verilog-sig-bits port-st)
(verilog-sig-bits (assoc port vector-skip-list)))))
(or (verilog-sig-bits port-st) "")
""))
;; Default if not found
(tpl-net (concat port vl-bits)))
;; Find template
(cond (tpl-ass ; Template of exact port name
(setq tpl-net (nth 1 tpl-ass)))
((nth 1 tpl-list) ; Wildcards in template, search them
(let ((wildcards (nth 1 tpl-list)))
(while wildcards
(when (string-match (nth 0 (car wildcards)) port)
(setq tpl-ass t ; so allow @ parsing
tpl-net (replace-match (nth 1 (car wildcards))
t nil port)))
(setq wildcards (cdr wildcards))))))
;; Parse Templated variable
(when tpl-ass
;; Evaluate @"(lispcode)"
(when (string-match "@\".*[^\\]\"" tpl-net)
(while (string-match "@\"\\(\\([^\\\"]*\\(\\\\.\\)*\\)*\\)\"" tpl-net)
(setq tpl-net
(concat
(substring tpl-net 0 (match-beginning 0))
(save-match-data
(let* ((expr (match-string 1 tpl-net))
(value
(progn
(setq expr (verilog-string-replace-matches "\\\\\"" "\"" nil nil expr))
(setq expr (verilog-string-replace-matches "@" tpl-num nil nil expr))
(prin1 (eval (car (read-from-string expr)))
(lambda (ch) ())))))
(if (numberp value) (setq value (number-to-string value)))
value
))
(substring tpl-net (match-end 0))))))
;; Replace @ and [] magic variables in final output
(setq tpl-net (verilog-string-replace-matches "@" tpl-num nil nil tpl-net))
(setq tpl-net (verilog-string-replace-matches "\\[\\]" vl-bits nil nil tpl-net))
)
(indent-to indent-pt)
(insert "." port)
(indent-to 40)
(insert "(" tpl-net "),")
(when tpl-ass
(indent-to 64)
(insert " // Templated"))
(insert "\n")))
;;(verilog-auto-inst-port (list "foo" "[5:0]") 10 (list (list "foo" "a@\"(% (+ @ 1) 4)\"a")) "3")
;;(x "incom[@\"(+ (* 8 @) 7)\":@\"(* 8 @)\"]")
;;(x ".out (outgo[@\"(concat (+ (* 8 @) 7) \\\":\\\" ( * 8 @))\"]));")
(defun verilog-auto-inst ()
"Expand AUTOINST statements, as part of \\[verilog-auto].
Replace the argument calls inside an instantiation with ones
automatically derived from the module header of the instantiated netlist.
Limitations:
Module names must be resolvable to filenames by adding a
verilog-library-extension, and being found in the same directory, or
by changing the variable `verilog-library-directories' or
`verilog-library-files'. Macros `modname are translated through the
vh-{name} Emacs variable, if that is not found, it just ignores the `.
In templates you must have one signal per line, ending in a ), or ));,
and have proper () nesting, including a final ); to end the template.
For example, first take the submodule inst.v:
module inst (o,i)
output [31:0] o;
input i;
wire [31:0] o = {32{i}};
endmodule
This is then used in a upper level module:
module ex_inst (o,i)
output o;
input i;
inst inst (/*AUTOINST*/);
endmodule
Typing \\[verilog-auto] will make this into:
module ex_inst (o,i)
output o;
input i;
inst inst (/*AUTOINST*/
// Outputs
.ov (ov[31:0]),
// Inputs
.i (i));
endmodule
Where the list of inputs and outputs came from the inst module.
Exceptions:
Unless you are instantiating a module multiple times, or the module is
something trivial like a adder, DO NOT CHANGE SIGNAL NAMES ACROSS HIERARCHY.
It just makes for unmaintainable code. To sanitize signal names, try
vrename from http://www.veripool.com
When you need to violate this suggestion there are several ways to list
exceptions.
Any ports defined before the /*AUTOINST*/ are not included in the list of
automatics. This is similar to making a template as described below, but
is restricted to simple connections just like you normally make. Also note
that any signals before the AUTOINST will only be picked up by AUTOWIRE if
you have the appropriate // Input or // Output comment, and exactly the
same line formatting as AUTOINST itself uses.
inst inst (// Inputs
.i (my_i_dont_mess_with_it),
/*AUTOINST*/
// Outputs
.ov (ov[31:0]));
Auto Templates:
For multiple instantiations based upon a single template, create a
commented out template:
/* psm_mas AUTO_TEMPLATE (
.PTL_MAPVALIDX (PTL_MAPVALID[@]),
.PTL_MAPVALIDP1X (PTL_MAPVALID[@\"(% (+ 1 @) 4)\"]),
.PTL_BUS (PTL_BUSNEW[]),
);
*/
Templates go ABOVE the instantiation(s). When a instantiation is expanded
`verilog-mode' simply searches up for the closest template. Thus you can have
multiple templates for the same module, just alternate between the template
for a instantiation and the instantiation itself.
The @ character should be replaced by the instantiation number; the first
digits found in the cell's instantiation name. The module name must be the
same as the name of the module in the instantiation name, and the code
\"AUTO_TEMPLATE\" must be in these exact words and capitalized. Only
signals that must be different for each instantiation need to be listed.
The above template will convert:
psm_mas ms2m (/*AUTOINST*/);
Typing \\[verilog-auto] will make this into:
psm_mas ms2m (/*AUTOINST*/
// Outputs
.INSTDATAOUT (INSTDATAOUT),
.PTL_MAPVALIDX (PTL_MAPVALID[2]),
.PTL_MAPVALIDP1X (PTL_MAPVALID[3]),
.PTL_BUS (PTL_BUSNEW[3:0]),
....
Note the @ character was replaced with the 2 from \"ms2m\". Also, if a
signal wasn't in the template, it is assumed to be a direct connection.
A [] in a template (with nothing else inside the brackets) will be replaced
by the same bus subscript as it is being connected to, or \"\" (nothing) if
it is a single bit signal. See PTL_BUS becoming PTL_BUSNEW above.
Regexp templates:
A template entry of the form
.pci_req\\([0-9]+\\)_l (pci_req_jtag_[\\1]),
will apply a Emacs style regular expression search for any port beginning
in pci_req followed by numbers and ending in _l and connecting that to
the pci_req_jtag_[] net, with the bus subscript coming from what matches
inside the first set of \\( \\). Thus pci_req2_l becomes pci_req_jtag_[2].
Since \\([0-9]+\\) is so common and ugly to read, a @ does the same thing
(Note a @ in replacement text is completely different -- still use \\1
there!) Thus this is the same as the above template:
.pci_req@_l (pci_req_jtag_[\\1]),
Here's another example to remove the _l, if naming conventions specify _
alone to mean active low. Note the use of [] to keep the bus subscript:
.\\(.*\\)_l (\\1_[]),
Lisp templates:
First any regular expression template is expanded.
If the syntax @\"( ... )\" is found, the expression in quotes will be
evaluated as a Lisp expression, with @ replaced by the instantiation
number. The MAPVALIDP1X example above would put @+1 modulo 4 into the
brackets. Quote all double-quotes inside the expression with a leading
backslash (\\\"). There are special variables defined that are useful
in these Lisp functions:
vl-name name portion of the input/output port
vl-bits bus bits portion of the input/output port ('[2:0]')
Normal Lisp variables may be used in expressions. See
`verilog-read-defines' which can set vh-{definename} variables for use
here. Also, any comments of the form:
/*AUTO_LISP(setq foo 1)*/
will evaluate any Lisp expression inside the parenthesis between the
beginning of the buffer and the point of the AUTOINST. This allows
variables to be changed between each instantiation.
After the evaluation is completed, @ substitution and [] substitution
occur."
(save-excursion
;; Find beginning
(let* ((pt (point))
(indent-pt (save-excursion (verilog-backward-open-paren)
(1+ (current-column))))
(modi (verilog-modi-current))
(vector-skip-list (unless verilog-auto-inst-vector
(verilog-modi-get-signals modi)))
submod submodi inst skip-pins tpl-list tpl-num)
;; Find module name that is instantiated
(setq submod (verilog-read-inst-module)
inst (verilog-read-inst-name)
skip-pins (aref (verilog-read-inst-pins) 0))
;; Parse any AUTO_LISP() before here
(verilog-read-auto-lisp (point-min) pt)
;; Lookup position, etc of submodule
;; Note this may raise an error
(when (setq submodi (verilog-modi-lookup submod t))
;; If there's a number in the instantiation, it may be a argument to the
;; automatic variable instantiation program.
(setq tpl-num (if (string-match "\\([0-9]+\\)" inst)
(substring inst (match-beginning 1) (match-end 1))
"")
tpl-list (verilog-read-auto-template submod))
;; Find submodule's signals and dump
(insert "\n")
(let ((sig-list (verilog-signals-not-in
(verilog-modi-get-outputs submodi)
skip-pins)))
(when sig-list
(indent-to indent-pt)
(insert "// Outputs\n") ;; Note these are searched for in verilog-read-sub-decl
(mapcar (function (lambda (port)
(verilog-auto-inst-port port indent-pt tpl-list tpl-num)))
sig-list)))
(let ((sig-list (verilog-signals-not-in
(verilog-modi-get-inouts submodi)
skip-pins)))
(when sig-list
(indent-to indent-pt)
(insert "// Inouts\n")
(mapcar (function (lambda (port)
(verilog-auto-inst-port port indent-pt tpl-list tpl-num)))
sig-list)))
(let ((sig-list (verilog-signals-not-in
(verilog-modi-get-inputs submodi)
skip-pins)))
(when sig-list
(indent-to indent-pt)
(insert "// Inputs\n")
(mapcar (function (lambda (port)
(verilog-auto-inst-port port indent-pt tpl-list tpl-num)))
sig-list)))
;; Kill extra semi
(save-excursion
(cond ((re-search-backward "," pt t)
(delete-char 1)
(insert ");")
(search-forward "\n") ;; Added by inst-port
(delete-backward-char 1)
(if (search-forward ")" nil t) ;; From user, moved up a line
(delete-backward-char 1))
(if (search-forward ";" nil t) ;; Don't error if user had syntax error and forgot it
(delete-backward-char 1))
)
(t
(delete-backward-char 1) ;; Newline Inserted above
)))
))))
(defun verilog-auto-reg ()
"Expand AUTOREG statements, as part of \\[verilog-auto].
Make reg statements for any output that isn't already declared,
and isn't a wire output from a block.
Limitations:
This ONLY detects outputs of AUTOINSTants (see verilog-read-sub-decl).
This does NOT work on memories, declare those yourself.
A simple example:
module ex_reg (o,i)
output o;
input i;
/*AUTOREG*/
always o = i;
endmodule
Typing \\[verilog-auto] will make this into:
module ex_reg (o,i)
output o;
input i;
/*AUTOREG*/
// Beginning of automatic regs (for this module's undeclared outputs)
reg o;
// End of automatics
always o = i;
endmodule"
(save-excursion
;; Point must be at insertion point.
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list (verilog-signals-not-in
(verilog-modi-get-outputs modi)
(append (verilog-modi-get-wires modi)
(verilog-modi-get-regs modi)
(verilog-modi-get-assigns modi)
(verilog-modi-get-consts modi)
(verilog-modi-get-sub-outputs modi)
(verilog-modi-get-sub-inouts modi)
))))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic regs (for this module's undeclared outputs)\n")
(verilog-insert-definition sig-list "reg" indent-pt)
(verilog-modi-cache-add-regs modi sig-list)
(verilog-insert-indent "// End of automatics\n")
)))
(defun verilog-auto-reg-input ()
"Expand AUTOREGINPUT statements, as part of \\[verilog-auto].
Make reg statements instantiation inputs that aren't already declared.
This is useful for making a top level shell for testing the module that is
to be instantiated.
Limitations:
This ONLY detects inputs of AUTOINSTants (see verilog-read-sub-decl).
This does NOT work on memories, declare those yourself.
A simple example (see `verilog-auto-inst' for what else is going on here):
module ex_reg_input (o,i)
output o;
input i;
/*AUTOREGINPUT*/
inst inst (/*AUTOINST*/);
endmodule
Typing \\[verilog-auto] will make this into:
module ex_reg_input (o,i)
output o;
input i;
/*AUTOREGINPUT*/
// Beginning of automatic reg inputs (for undeclared ...
reg [31:0] iv; // From inst of inst.v
// End of automatics
inst inst (/*AUTOINST*/
// Outputs
.o (o[31:0]),
// Inputs
.iv (iv));
endmodule"
(save-excursion
;; Point must be at insertion point.
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list (verilog-signals-combine-bus
(verilog-signals-not-in
(append (verilog-modi-get-sub-inputs modi)
(verilog-modi-get-sub-inouts modi))
(verilog-modi-get-signals modi)
))))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic reg inputs (for undeclared instantiated-module inputs)\n")
(verilog-insert-definition sig-list "reg" indent-pt)
(verilog-modi-cache-add-wires modi sig-list)
(verilog-insert-indent "// End of automatics\n")
)))
(defun verilog-auto-wire ()
"Expand AUTOWIRE statements, as part of \\[verilog-auto].
Make wire statements for instantiations outputs that aren't
already declared.
Limitations:
This ONLY detects outputs of AUTOINSTants (see verilog-read-sub-decl).
This does NOT work on memories, declare those yourself.
A simple example (see `verilog-auto-inst' for what else is going on here):
module ex_wire (o,i)
output o;
input i;
/*AUTOWIRE*/
inst inst (/*AUTOINST*/);
endmodule
Typing \\[verilog-auto] will make this into:
module ex_wire (o,i)
output o;
input i;
/*AUTOWIRE*/
// Beginning of automatic wires
wire [31:0] ov; // From inst of inst.v
// End of automatics
inst inst (/*AUTOINST*/
// Outputs
.ov (ov[31:0]),
// Inputs
.i (i));
wire o = | ov;
endmodule"
(save-excursion
;; Point must be at insertion point.
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list (verilog-signals-combine-bus
(verilog-signals-not-in
(append (verilog-modi-get-sub-outputs modi)
(verilog-modi-get-sub-inouts modi))
(verilog-modi-get-signals modi)
))))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic wires (for undeclared instantiated-module outputs)\n")
(verilog-insert-definition sig-list "wire" indent-pt)
(verilog-modi-cache-add-wires modi sig-list)
(verilog-insert-indent "// End of automatics\n")
(when nil ;; Too slow on huge modules, plus makes everyone's module change
(beginning-of-line)
(setq pnt (point))
(verilog-pretty-declarations)
(goto-char pnt)
(verilog-pretty-expr "//"))
)))
(defun verilog-auto-output ()
"Expand AUTOOUTPUT statements, as part of \\[verilog-auto].
Make output statements for any output signal from an /*AUTOINST*/ that
isn't used elsewhere inside the module. This is useful for modules which
only instantiate other modules.
Limitations:
This ONLY detects outputs of AUTOINSTants (see verilog-read-sub-decl).
If any concatenation, or bit-subscripts are missing in the AUTOINSTant's
instantiation, all bets are off. (For example due to a AUTO_TEMPLATE).
A simple example (see `verilog-auto-inst' for what else is going on here):
module ex_output (ov,i)
input i;
/*AUTOWIRE*/
inst inst (/*AUTOINST*/);
endmodule
Typing \\[verilog-auto] will make this into:
module ex_output (ov,i)
input i;
/*AUTOOUTPUT*/
// Beginning of automatic outputs (from unused autoinst outputs)
output [31:0] ov; // From inst of inst.v
// End of automatics
inst inst (/*AUTOINST*/
// Outputs
.ov (ov[31:0]),
// Inputs
.i (i));
endmodule"
(save-excursion
;; Point must be at insertion point.
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list (verilog-signals-not-in
(verilog-modi-get-sub-outputs modi)
(append (verilog-modi-get-outputs modi)
(verilog-modi-get-inouts modi)
(verilog-modi-get-sub-inputs modi)
(verilog-modi-get-sub-inouts modi)
))))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic outputs (from unused autoinst outputs)\n")
(verilog-insert-definition sig-list "output" indent-pt)
(verilog-modi-cache-add-outputs modi sig-list)
(verilog-insert-indent "// End of automatics\n")
)))
(defun verilog-auto-output-every ()
"Expand AUTOOUTPUTEVERY statements, as part of \\[verilog-auto].
Make output statements for any signals that aren't primary inputs or
outputs already. This makes every signal in the design a output. This is
useful to get Synopsys to preserve every signal in the design, since it
won't optimize away the outputs.
A simple example:
module ex_output_every (o,i,tempa,tempb)
output o;
input i;
/*AUTOOUTPUTEVERY*/
wire tempa = i;
wire tempb = tempa;
wire o = tempb;
endmodule
Typing \\[verilog-auto] will make this into:
module ex_output_every (o,i,tempa,tempb)
output o;
input i;
/*AUTOOUTPUTEVERY*/
// Beginning of automatic outputs (every signal)
output tempb;
output tempa;
// End of automatics
wire tempa = i;
wire tempb = tempa;
wire o = tempb;
endmodule"
(save-excursion
;;Point must be at insertion point
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list (verilog-signals-not-in
(verilog-modi-get-signals modi)
(verilog-modi-get-ports modi)
)))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic outputs (every signal)\n")
(verilog-insert-definition sig-list "output" indent-pt)
(verilog-modi-cache-add-outputs modi sig-list)
(verilog-insert-indent "// End of automatics\n")
)))
(defun verilog-auto-input ()
"Expand AUTOINPUT statements, as part of \\[verilog-auto].
Make input statements for any input signal into an /*AUTOINST*/ that
isn't declared elsewhere inside the module. This is useful for modules which
only instantiate other modules.
Limitations:
This ONLY detects outputs of AUTOINSTants (see verilog-read-sub-decl).
If any concatenation, or bit-subscripts are missing in the AUTOINSTant's
instantiation, all bets are off. (For example due to a AUTO_TEMPLATE).
A simple example (see `verilog-auto-inst' for what else is going on here):
module ex_input (ov,i)
output [31:0] ov;
/*AUTOINPUT*/
inst inst (/*AUTOINST*/);
endmodule
Typing \\[verilog-auto] will make this into:
module ex_input (ov,i)
output [31:0] ov;
/*AUTOINPUT*/
// Beginning of automatic inputs (from unused autoinst inputs)
input i; // From inst of inst.v
// End of automatics
inst inst (/*AUTOINST*/
// Outputs
.ov (ov[31:0]),
// Inputs
.i (i));
endmodule"
(save-excursion
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list (verilog-signals-not-in
(verilog-modi-get-sub-inputs modi)
(append (verilog-modi-get-inputs modi)
(verilog-modi-get-inouts modi)
(verilog-modi-get-wires modi)
(verilog-modi-get-regs modi)
(verilog-modi-get-consts modi)
(verilog-modi-get-sub-outputs modi)
(verilog-modi-get-sub-inouts modi)
))))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic inputs (from unused autoinst inputs)\n")
(verilog-insert-definition sig-list "input" indent-pt)
(verilog-modi-cache-add-inputs modi sig-list)
(verilog-insert-indent "// End of automatics\n")
)))
(defun verilog-auto-inout-module ()
"Expand AUTOINOUTMODULE statements, as part of \\[verilog-auto].
Take input/output/inout statements from the specified module and insert
into the current module. This is useful for making null templates and
shell modules which need to have identical I/O with another module. Any
I/O which are already defined in this module will not be redefined.
Limitations:
Concatenation and outputting partial busses is not supported.
Module names must be resolvable to filenames. See \\[verilog-auto-inst].
Signals are not inserted in the same order as in the original module,
though they will appear to be in the same order to a AUTOINST
instantiating either module.
A simple example:
module ex_shell (/*AUTOARG*/)
/*AUTOINOUTMODULE(\"ex_main\")*/
endmodule
module ex_main (i,o,io)
input i;
output o;
inout io;
endmodule
Typing \\[verilog-auto] will make this into:
module ex_shell (/*AUTOARG*/i,o,io)
/*AUTOINOUTMODULE(\"ex_main\")*/
// Beginning of automatic in/out/inouts (from specific module)
input i;
output o;
inout io;
// End of automatics
endmodule"
(save-excursion
(let* ((submod (car (verilog-read-auto-params 1))) submodi)
;; Lookup position, etc of co-module
;; Note this may raise an error
(when (setq submodi (verilog-modi-lookup submod t))
(let* ((indent-pt (current-indentation))
(modi (verilog-modi-current))
(sig-list-i (verilog-signals-not-in
(verilog-modi-get-inputs submodi)
(append (verilog-modi-get-inputs modi))))
(sig-list-o (verilog-signals-not-in
(verilog-modi-get-outputs submodi)
(append (verilog-modi-get-outputs modi))))
(sig-list-io (verilog-signals-not-in
(verilog-modi-get-inouts submodi)
(append (verilog-modi-get-inouts modi)))))
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic in/out/inouts (from specific module)\n")
;; Don't sort them so a upper AUTOINST will match the main module
(verilog-insert-definition sig-list-o "output" indent-pt t)
(verilog-insert-definition sig-list-io "inout" indent-pt t)
(verilog-insert-definition sig-list-i "input" indent-pt t)
(verilog-modi-cache-add-inputs modi sig-list-i)
(verilog-modi-cache-add-outputs modi sig-list-o)
(verilog-modi-cache-add-inouts modi sig-list-io)
(verilog-insert-indent "// End of automatics\n")
)))))
(defun verilog-auto-sense ()
"Expand AUTOSENSE statements, as part of \\[verilog-auto].
Replace the always (/*AUTOSENSE*/) sensitivity list (/*AS*/ for short)
with one automatically derived from all inputs declared in the always
statement. Signals that are generated within the same always block are NOT
placed into the sensitivity list (see `verilog-auto-sense-include-inputs').
Long lines are split based on the `fill-column', see \\[set-fill-column].
Limitations:
Verilog does not allow memories (multidimensional arrays) in sensitivity
lists. AUTOSENSE will thus exclude them, and add a /*memory or*/ comment.
Constant signals:
AUTOSENSE cannot always determine if a `define is a constant or a signal
(it could be in a include file for example). If a `define or other signal
is put into the AUTOSENSE list and is not desired, use the AUTO_CONSTANT
declaration anywhere in the module (parenthesis are required):
/* AUTO_CONSTANT ( `this_is_really_constant_dont_autosense_it ) */
Better yet, use a parameter, which will be understood to be constant
automatically.
OOps!
If AUTOSENSE makes a mistake, please report it. (First try putting
a begin/end after your always!) As a workaround, if a signal that
shouldn't be in the sensitivity list was, use the AUTO_CONSTANT above.
If a signal should be in the sensitivity list wasn't, placing it before
the /*AUTOSENSE*/ comment will prevent it from being deleted when the
autos are updated (or added if it occurs there already).
A simple example:
always @ (/*AUTOSENSE*/) begin
/* AUTO_CONSTANT (`constant) */
outin = ina | inb | `constant;
out = outin;
end
Typing \\[verilog-auto] will make this into:
always @ (/*AUTOSENSE*/ina or inb) begin
/* AUTO_CONSTANT (`constant) */
outin = ina | inb | `constant;
out = outin;
end"
(save-excursion
;; Find beginning
(let* ((indent-pt (save-excursion
(or (and (search-backward "(" nil t) (1+ (current-column)))
(current-indentation))))
(modi (verilog-modi-current))
(sig-memories (verilog-signals-memory (verilog-modi-get-regs modi)))
sigss sig-list not-first presense-sigs)
;; Read signals in always, eliminate outputs from sense list
(setq presense-sigs (verilog-signals-from-signame
(save-excursion
(verilog-read-signals (save-excursion
(verilog-re-search-backward "(" nil t)
(point))
(point)))))
(setq sigss (verilog-read-always-signals))
(setq sig-list (verilog-signals-not-in (verilog-alw-get-inputs sigss)
(append (and (not verilog-auto-sense-include-inputs)
(verilog-alw-get-outputs sigss))
(verilog-modi-get-consts modi)
presense-sigs)
))
(when sig-memories
(let ((tlen (length sig-list)))
(setq sig-list (verilog-signals-not-in sig-list sig-memories))
(if (not (eq tlen (length sig-list))) (insert " /*memory or*/ "))))
(setq sig-list (sort sig-list `verilog-signals-sort-compare))
(while sig-list
(cond ((> (+ 4 (current-column) (length (verilog-sig-name (car sig-list)))) fill-column) ;+4 for width of or
(insert "\n")
(indent-to indent-pt)
(if not-first (insert "or ")))
(not-first (insert " or ")))
(insert (verilog-sig-name (car sig-list)))
(setq sig-list (cdr sig-list)
not-first t))
)))
(defun verilog-auto-reset ()
"Expand AUTORESET statements, as part of \\[verilog-auto].
Replace the /*AUTORESET*/ comment with code to initialize all
registers set elsewhere in the always block.
Limitations:
AUTORESET will not clear memories.
OOps!
If AUTORESET makes a mistake, please report it. (First make sure
you have begin/end after your always!) As a workaround, if a signal
should be in the sensitivity list wasn't, placing it before the
/*AUTORESET*/ comment will prevent it from being deleted when the
autos are updated (or added if it occurs there already).
A simple example:
always @(posedge clk or negedge reset_l) begin
if (!reset_l) begin
c <= 1;
/*AUTORESET*/
end
else begin
a <= in_a;
b <= in_b;
c <= in_c;
end
end
Typing \\[verilog-auto] will make this into:
always @(posedge core_clk or negedge reset_l) begin
if (!reset_l) begin
c <= 1;
/*AUTORESET*/
// Beginning of autoreset for uninitialized flops
a <= 0;
b <= 0;
// End of automatics
end
else begin
a <= in_a;
b <= in_b;
c <= in_c;
end
end"
(interactive)
(save-excursion
;; Find beginning
(let* ((indent-pt (current-indentation))
sigss sig-list prereset-sigs)
;; Read signals in always, eliminate outputs from reset list
(setq prereset-sigs (verilog-signals-from-signame
(save-excursion
(verilog-read-signals
(save-excursion
(verilog-re-search-backward "\\(@\\|\\<begin\\>\\|\\<if\\>\\|\\<case\\>\\)" nil t)
(point))
(point)))))
(save-excursion
(verilog-re-search-backward "@" nil t)
(setq sigss (verilog-read-always-signals)))
(setq sig-list (verilog-signals-not-in (verilog-alw-get-outputs sigss)
prereset-sigs))
(setq sig-list (sort sig-list `verilog-signals-sort-compare))
(insert "\n");
(indent-to indent-pt)
(insert "// Beginning of autoreset for uninitialized flops\n");
(indent-to indent-pt)
(while sig-list
(insert (verilog-sig-name (car sig-list)))
(insert " <= 0;\n")
(indent-to indent-pt)
(setq sig-list (cdr sig-list)))
(insert "// End of automatics")
)))
(defun verilog-enum-ascii (signm elim-regexp)
"Convert a enum name SIGNM to a ascii string for insertion.
Remove user provided prefix ELIM-REGEXP."
(or elim-regexp (setq elim-regexp "_ DONT MATCH IT_"))
(let ((case-fold-search t))
;; All upper becomes all lower for readability
(downcase (verilog-string-replace-matches elim-regexp "" nil nil signm))))
(defun verilog-auto-ascii-enum ()
"Expand AUTOASCIIENUM statements, as part of \\[verilog-auto].
Create a register to contain the ASCII decode of a enumerated signal type.
This will allow trace viewers to show the ASCII name of states.
First, parameters are built into a enumeration using the synopsys enum
comment. The comment must be between the keyword and the symbol.
(Annoying, but that's what Synopsys's dc_shell FSM reader requires.)
Next, registers which that enum applies to are also tagged with the same
enum. Synopsys also suggests labeling state vectors, but `verilog-mode'
doesn't care.
Finally, a AUTOASCIIENUM command is used.
The first parameter is the name of the signal to be decoded.
The second parameter is the name to store the ASCII code into. For the
signal foo, I suggest the name _foo__ascii, where the leading _ indicates
a signal that is just for simulation, and the magic characters _ascii
tell viewers like Dinotrace to display in ASCII format.
The final optional parameter is a string which will be removed from the
state names.
A simple example:
//== State enumeration
parameter [2:0] // synopsys enum state_info
SM_IDLE = 3'b000,
SM_SEND = 3'b001,
SM_WAIT1 = 3'b010;
//== State variables
reg [2:0] /* synopsys enum state_info */
state_r; /* synopsys state_vector state_r */
reg [2:0] /* synopsys enum state_info */
state_e1;
//== ASCII state decoding
/*AUTOASCIIENUM(\"state_r\", \"_stateascii_r\", \"sm_\")*/
Typing \\[verilog-auto] will make this into:
... same front matter ...
/*AUTOASCIIENUM(\"state_r\", \"_stateascii_r\", \"sm_\")*/
// Beginning of automatic ASCII enum decoding
reg [39:0] _stateascii_r; // Decode of state_r
always @(state_r) begin
casex ({state_r}) // synopsys full_case parallel_case
SM_IDLE: _stateascii_r = \"idle \";
SM_SEND: _stateascii_r = \"send \";
SM_WAIT1: _stateascii_r = \"wait1\";
default: _stateascii_r = \"%Erro\";
endcase
end
// End of automatics"
(save-excursion
(let* ((params (verilog-read-auto-params 2 3))
(undecode-name (nth 0 params))
(ascii-name (nth 1 params))
(elim-regexp (nth 2 params))
;;
(indent-pt (current-indentation))
(modi (verilog-modi-current))
;;
(sig-list-consts (verilog-modi-get-consts modi))
(sig-list-all (append (verilog-modi-get-regs modi)
(verilog-modi-get-outputs modi)
(verilog-modi-get-inouts modi)
(verilog-modi-get-inputs modi)
(verilog-modi-get-wires modi)))
;;
(undecode-sig (or (assoc undecode-name sig-list-all)
(error "%s: Signal %s not found in design" (verilog-point-text) undecode-name)))
(undecode-enum (or (verilog-sig-enum undecode-sig)
(error "%s: Signal %s does not have a enum tag" (verilog-point-text) undecode-name)))
;;
(enum-sigs (or (verilog-signals-matching-enum sig-list-consts undecode-enum)
(error "%s: No state definitions for %s" (verilog-point-text) undecode-enum)))
;;
(enum-chars 0)
(ascii-chars 0))
;;
;; Find number of ascii chars needed
(let ((tmp-sigs enum-sigs))
(while tmp-sigs
(setq enum-chars (max enum-chars (length (verilog-sig-name (car tmp-sigs))))
ascii-chars (max ascii-chars (length (verilog-enum-ascii
(verilog-sig-name (car tmp-sigs))
elim-regexp)))
tmp-sigs (cdr tmp-sigs))))
;;
(forward-line 1)
(verilog-insert-indent "// Beginning of automatic ASCII enum decoding\n")
(let ((decode-sig-list (list (list ascii-name (format "[%d:0]" (- (* ascii-chars 8) 1))
(concat "Decode of " undecode-name) nil nil))))
(verilog-insert-definition decode-sig-list "reg" indent-pt)
(verilog-modi-cache-add-regs modi decode-sig-list))
;;
(verilog-insert-indent "always @(" undecode-name ") begin\n")
(setq indent-pt (+ indent-pt verilog-indent-level))
(indent-to indent-pt)
(insert "casex ({" undecode-name "}) // synopsys full_case parallel_case\n")
(setq indent-pt (+ indent-pt verilog-case-indent))
;;
(let ((tmp-sigs enum-sigs)
(chrfmt (format "%%-%ds %s = \"%%-%ds\";\n" (1+ (max 8 enum-chars))
ascii-name ascii-chars))
(errname (substring "%Error" 0 (min 6 ascii-chars))))
(while tmp-sigs
(verilog-insert-indent
(format chrfmt (concat (verilog-sig-name (car tmp-sigs)) ":")
(verilog-enum-ascii (verilog-sig-name (car tmp-sigs))
elim-regexp)))
(setq tmp-sigs (cdr tmp-sigs)))
(verilog-insert-indent (format chrfmt "default:" errname)))
;;
(setq indent-pt (- indent-pt verilog-case-indent))
(verilog-insert-indent "endcase\n")
(setq indent-pt (- indent-pt verilog-indent-level))
(verilog-insert-indent "end\n"
"// End of automatics\n")
)))
;;
;; Auto top level
;;
(defun verilog-auto ()
"Expand AUTO statements.
Look for any /*AUTO...*/ commands in the code, as used in
instantiations or argument headers. Update the list of signals
following the /*AUTO...*/ command.
Use \\[verilog-delete-auto] to remove the AUTOs.
The hooks `verilog-before-auto-hook' and `verilog-auto-hook' are
called before and after this function, respectively.
For example:
module (/*AUTOARG*/)
/*AUTOINPUT*/
/*AUTOOUTPUT*/
/*AUTOWIRE*/
/*AUTOREG*/
somesub sub (/*AUTOINST*/);
You can also update the AUTOs from the shell using:
emacs --batch $FILENAME_V -f verilog-auto -f save-buffer
Using \\[describe-function], see also:
`verilog-auto-arg' for AUTOARG module instantiations
`verilog-auto-ascii-enum' for AUTOASCIIENUM enumeration decoding
`verilog-auto-inout-module' for AUTOINOUTMODULE copying i/o from elsewhere
`verilog-auto-input' for AUTOINPUT making hierarchy inputs
`verilog-auto-inst' for AUTOINST argument declarations
`verilog-auto-output' for AUTOOUTPUT making hierarchy outputs
`verilog-auto-output-every' for AUTOOUTPUTEVERY making all outputs
`verilog-auto-reg' for AUTOREG registers
`verilog-auto-reg-input' for AUTOREGINPUT instantiation registers
`verilog-auto-reset' for AUTORESET flop resets
`verilog-auto-sense' for AUTOSENSE always sensitivity lists
`verilog-auto-wire' for AUTOWIRE instantiation wires
`verilog-read-defines' for reading `define values
`verilog-read-includes' for reading `includes
If you have bugs with these autos, try contacting the AUTOAUTHOR
Wilson Snyder (wsnyder@wsnyder.org or wsnyder@world.std.com)"
(interactive)
(unless noninteractive (message "Updating AUTOs..."))
(if (featurep 'dinotrace)
(dinotrace-unannotate-all))
(let ((oldbuf (if (not (buffer-modified-p))
(buffer-string)))
;; Before version 20, match-string with font-lock returns a
;; vector that is not equal to the string. IE if on "input"
;; nil==(equal "input" (progn (looking-at "input") (match-string 0)))
(fontlocked (when (and ;(memq 'v19 verilog-emacs-features)
(boundp 'font-lock-mode)
font-lock-mode)
(font-lock-mode nil)
t)))
(save-excursion
(run-hooks 'verilog-before-auto-hook)
;; This may seem obvious to do, but on large includes it can be way too slow
(when verilog-auto-read-includes
(verilog-read-includes)
(verilog-read-defines))
;; This particular ordering is important
;; INST: Lower modules correct, no internal dependencies, FIRST
(verilog-preserve-cache
;; Clear existing autos else we'll be screwed by existing ones
(verilog-delete-auto)
;;
(verilog-auto-search-do "/*AUTOINST*/" 'verilog-auto-inst)
;; Doesn't matter when done, but combine it with a common changer
(verilog-auto-re-search-do "/\\*\\(AUTOSENSE\\|AS\\)\\*/" 'verilog-auto-sense)
(verilog-auto-re-search-do "/\\*AUTORESET\\*/" 'verilog-auto-reset)
;; Must be done before autoin/out as creates a reg
(verilog-auto-re-search-do "/\\*AUTOASCIIENUM([^)]*)\\*/" 'verilog-auto-ascii-enum)
)
;;
;; Inputs/outputs are mutually independent
(verilog-preserve-cache
;; first in/outs from other files
(verilog-auto-re-search-do "/\\*AUTOINOUTMODULE([^)]*)\\*/" 'verilog-auto-inout-module)
;; next in/outs which need previous sucked inputs first
(verilog-auto-search-do "/*AUTOOUTPUT*/" 'verilog-auto-output)
(verilog-auto-search-do "/*AUTOINPUT*/" 'verilog-auto-input)
;; outputevery needs autooutputs done first
(verilog-auto-search-do "/*AUTOOUTPUTEVERY*/" 'verilog-auto-output-every)
;; Wires/regs must be after inputs/outputs
(verilog-auto-search-do "/*AUTOWIRE*/" 'verilog-auto-wire)
(verilog-auto-search-do "/*AUTOREG*/" 'verilog-auto-reg)
(verilog-auto-search-do "/*AUTOREGINPUT*/" 'verilog-auto-reg-input)
;; Must be after all inputs outputs are generated
(verilog-auto-search-do "/*AUTOARG*/" 'verilog-auto-arg)
)
;;
(run-hooks 'verilog-auto-hook)
;;
(set (make-local-variable 'verilog-auto-update-tick) (buffer-modified-tick))
;;
;; If end result is same as when started, clear modified flag
(cond ((and oldbuf (equal oldbuf (buffer-string)))
(set-buffer-modified-p nil)
(unless noninteractive (message "Updating AUTOs...done (no changes)")))
(t (unless noninteractive (message "Updating AUTOs...done"))))
;; Restore font-lock
(when fontlocked (font-lock-mode t))
)))
;;
;; Skeleton based code insertion
;;
(defvar verilog-template-map nil
"Keymap used in Verilog mode for smart template operations.")
(let ((verilog-mp (make-sparse-keymap)))
(define-key verilog-mp "a" 'verilog-sk-always)
(define-key verilog-mp "b" 'verilog-sk-begin)
(define-key verilog-mp "c" 'verilog-sk-case)
(define-key verilog-mp "e" 'verilog-sk-else)
(define-key verilog-mp "f" 'verilog-sk-for)
(define-key verilog-mp "g" 'verilog-sk-generate)
(define-key verilog-mp "h" 'verilog-sk-header)
(define-key verilog-mp "i" 'verilog-sk-initial)
(define-key verilog-mp "j" 'verilog-sk-fork)
(define-key verilog-mp "m" 'verilog-sk-module)
(define-key verilog-mp "p" 'verilog-sk-primitive)
(define-key verilog-mp "r" 'verilog-sk-repeat)
(define-key verilog-mp "s" 'verilog-sk-specify)
(define-key verilog-mp "t" 'verilog-sk-task)
(define-key verilog-mp "w" 'verilog-sk-while)
(define-key verilog-mp "x" 'verilog-sk-casex)
(define-key verilog-mp "z" 'verilog-sk-casez)
(define-key verilog-mp "?" 'verilog-sk-if)
(define-key verilog-mp ":" 'verilog-sk-else-if)
(define-key verilog-mp "/" 'verilog-sk-comment)
(define-key verilog-mp "A" 'verilog-sk-assign)
(define-key verilog-mp "F" 'verilog-sk-function)
(define-key verilog-mp "I" 'verilog-sk-input)
(define-key verilog-mp "O" 'verilog-sk-output)
(define-key verilog-mp "S" 'verilog-sk-state-machine)
(define-key verilog-mp "=" 'verilog-sk-inout)
(define-key verilog-mp "W" 'verilog-sk-wire)
(define-key verilog-mp "R" 'verilog-sk-reg)
(setq verilog-template-map verilog-mp))
;;
;; Place the templates into Verilog Mode. They may be inserted under any key.
;; C-c C-t will be the default. If you use templates a lot, you
;; may want to consider moving the binding to another key in your .emacs
;; file.
;;
;(define-key verilog-mode-map "\C-ct" verilog-template-map)
(define-key verilog-mode-map "\C-c\C-t" verilog-template-map)
;;; ---- statement skeletons ------------------------------------------
(define-skeleton verilog-sk-prompt-condition
"Prompt for the loop condition."
"[condition]: " str )
(define-skeleton verilog-sk-prompt-init
"Prompt for the loop init statement."
"[initial statement]: " str )
(define-skeleton verilog-sk-prompt-inc
"Prompt for the loop increment statement."
"[increment statement]: " str )
(define-skeleton verilog-sk-prompt-name
"Prompt for the name of something."
"[name]: " str)
(define-skeleton verilog-sk-prompt-clock
"Prompt for the name of something."
"name and edge of clock(s): " str)
(defvar verilog-sk-reset nil)
(defun verilog-sk-prompt-reset ()
"Prompt for the name of a state machine reset."
(setq verilog-sk-reset (read-input "name of reset: " "rst")))
(define-skeleton verilog-sk-prompt-state-selector
"Prompt for the name of a state machine selector."
"name of selector (eg {a,b,c,d}): " str )
(define-skeleton verilog-sk-prompt-output
"Prompt for the name of something."
"output: " str)
(define-skeleton verilog-sk-prompt-msb
"Prompt for least signifcant bit specification."
"msb:" str & ?: & (verilog-sk-prompt-lsb) | -1 )
(define-skeleton verilog-sk-prompt-lsb
"Prompt for least signifcant bit specification."
"lsb:" str )
(defvar verilog-sk-p nil)
(define-skeleton verilog-sk-prompt-width
"Prompt for a width specification."
()
(progn (setq verilog-sk-p (point)) nil)
(verilog-sk-prompt-msb)
(if (> (point) verilog-sk-p) "] " " "))
(defun verilog-sk-header ()
"Insert a descriptive header at the top of the file."
(interactive "*")
(save-excursion
(goto-char (point-min))
(verilog-sk-header-tmpl)))
(define-skeleton verilog-sk-header-tmpl
"Insert a comment block containing the module title, author, etc."
"[Description]: "
"// -*- Mode: Verilog -*-"
"\n// Filename : " (buffer-name)
"\n// Description : " str
"\n// Author : " (user-full-name)
"\n// Created On : " (current-time-string)
"\n// Last Modified By: ."
"\n// Last Modified On: ."
"\n// Update Count : 0"
"\n// Status : Unknown, Use with caution!"
"\n")
(define-skeleton verilog-sk-module
"Insert a module definition."
()
> "module " (verilog-sk-prompt-name) " (/*AUTOARG*/ ) ;" \n
> _ \n
> (- verilog-indent-level-behavioral) "endmodule" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-primitive
"Insert a task definition."
()
> "primitive " (verilog-sk-prompt-name) " ( " (verilog-sk-prompt-output) ("input:" ", " str ) " );"\n
> _ \n
> (- verilog-indent-level-behavioral) "endprimitive" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-task
"Insert a task definition."
()
> "task " (verilog-sk-prompt-name) & ?; \n
> _ \n
> "begin" \n
> \n
> (- verilog-indent-level-behavioral) "end" \n
> (- verilog-indent-level-behavioral) "endtask" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-function
"Insert a function definition."
()
> "function [" (verilog-sk-prompt-width) | -1 (verilog-sk-prompt-name) ?; \n
> _ \n
> "begin" \n
> \n
> (- verilog-indent-level-behavioral) "end" \n
> (- verilog-indent-level-behavioral) "endfunction" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-always
"Insert always block. Uses the minibuffer to prompt
for sensitivity list."
()
> "always @ ( /*AUTOSENSE*/ ) begin\n"
> _ \n
> (- verilog-indent-level-behavioral) "end" \n >
)
(define-skeleton verilog-sk-initial
"Insert an initial block."
()
> "initial begin\n"
> _ \n
> (- verilog-indent-level-behavioral) "end" \n > )
(define-skeleton verilog-sk-specify
"Insert specify block. "
()
> "specify\n"
> _ \n
> (- verilog-indent-level-behavioral) "endspecify" \n > )
(define-skeleton verilog-sk-generate
"Insert generate block. "
()
> "generate\n"
> _ \n
> (- verilog-indent-level-behavioral) "endgenerate" \n > )
(define-skeleton verilog-sk-begin
"Insert begin end block. Uses the minibuffer to prompt for name"
()
> "begin" (verilog-sk-prompt-name) \n
> _ \n
> (- verilog-indent-level-behavioral) "end"
)
(define-skeleton verilog-sk-fork
"Insert an fork join block."
()
> "fork\n"
> "begin" \n
> _ \n
> (- verilog-indent-level-behavioral) "end" \n
> "begin" \n
> \n
> (- verilog-indent-level-behavioral) "end" \n
> (- verilog-indent-level-behavioral) "join" \n
> )
(define-skeleton verilog-sk-case
"Build skeleton case statement, prompting for the selector expression,
and the case items."
"[selector expression]: "
> "case (" str ") " \n
> ("case selector: " str ": begin" \n > _ \n > (- verilog-indent-level-behavioral) "end" \n )
resume: > (- verilog-case-indent) "endcase" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-casex
"Build skeleton casex statement, prompting for the selector expression,
and the case items."
"[selector expression]: "
> "casex (" str ") " \n
> ("case selector: " str ": begin" \n > _ \n > (- verilog-indent-level-behavioral) "end" \n )
resume: > (- verilog-case-indent) "endcase" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-casez
"Build skeleton casez statement, prompting for the selector expression,
and the case items."
"[selector expression]: "
> "casez (" str ") " \n
> ("case selector: " str ": begin" \n > _ \n > (- verilog-indent-level-behavioral) "end" \n )
resume: > (- verilog-case-indent) "endcase" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-if
"Insert a skeleton if statement."
> "if (" (verilog-sk-prompt-condition) & ")" " begin" \n
> _ \n
> (- verilog-indent-level-behavioral) "end " \n )
(define-skeleton verilog-sk-else-if
"Insert a skeleton else if statement."
> (verilog-indent-line) "else if ("
(progn (setq verilog-sk-p (point)) nil) (verilog-sk-prompt-condition) (if (> (point) verilog-sk-p) ") " -1 ) & " begin" \n
> _ \n
> "end" (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-datadef
"Common routine to get data definition"
()
(verilog-sk-prompt-width) | -1 ("name (RET to end):" str ", ") -2 ";" \n)
(define-skeleton verilog-sk-input
"Insert an input definition."
()
> "input [" (verilog-sk-datadef))
(define-skeleton verilog-sk-output
"Insert an output definition."
()
> "output [" (verilog-sk-datadef))
(define-skeleton verilog-sk-inout
"Insert an inout definition."
()
> "inout [" (verilog-sk-datadef))
(define-skeleton verilog-sk-reg
"Insert a reg definition."
()
> "reg [" (verilog-sk-datadef))
(define-skeleton verilog-sk-wire
"Insert a wire definition."
()
> "wire [" (verilog-sk-datadef))
(define-skeleton verilog-sk-assign
"Insert a skeleton assign statement."
()
> "assign " (verilog-sk-prompt-name) " = " _ ";" \n)
(define-skeleton verilog-sk-while
"Insert a skeleton while loop statement."
()
> "while (" (verilog-sk-prompt-condition) ") begin" \n
> _ \n
> (- verilog-indent-level-behavioral) "end " (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-repeat
"Insert a skeleton repeat loop statement."
()
> "repeat (" (verilog-sk-prompt-condition) ") begin" \n
> _ \n
> (- verilog-indent-level-behavioral) "end " (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-for
"Insert a skeleton while loop statement."
()
> "for ("
(verilog-sk-prompt-init) "; "
(verilog-sk-prompt-condition) "; "
(verilog-sk-prompt-inc)
") begin" \n
> _ \n
> (- verilog-indent-level-behavioral) "end " (progn (electric-verilog-terminate-line) nil))
(define-skeleton verilog-sk-comment
"Inserts three comment lines, making a display comment."
()
> "/*\n"
> "* " _ \n
> "*/")
(define-skeleton verilog-sk-state-machine
"Insert a state machine definition."
"Name of state variable: "
'(setq input "state")
> "// State registers for " str | -23 \n
'(setq verilog-sk-state str)
> "reg [" (verilog-sk-prompt-width) | -1 verilog-sk-state ", next_" verilog-sk-state ?; \n
'(setq input nil)
> \n
> "// State FF for " verilog-sk-state \n
> "always @ ( " (read-string "clock:" "posedge clk") " or " (verilog-sk-prompt-reset) " ) begin" \n
> "if ( " verilog-sk-reset " ) " verilog-sk-state " = 0; else" \n
> verilog-sk-state " = next_" verilog-sk-state ?; \n
> (- verilog-indent-level-behavioral) "end" (progn (electric-verilog-terminate-line) nil)
> \n
> "// Next State Logic for " verilog-sk-state \n
> "always @ ( /*AUTOSENSE*/ ) begin\n"
> "case (" (verilog-sk-prompt-state-selector) ") " \n
> ("case selector: " str ": begin" \n > "next_" verilog-sk-state " = " _ ";" \n > (- verilog-indent-level-behavioral) "end" \n )
resume: > (- verilog-case-indent) "endcase" (progn (electric-verilog-terminate-line) nil)
> (- verilog-indent-level-behavioral) "end" (progn (electric-verilog-terminate-line) nil))
;; Eliminate compile warning
(eval-when-compile
(if (not (boundp 'mode-popup-menu))
(defvar mode-popup-menu nil "Compatibility with XEmacs.")))
;; ---- add menu 'Statements' in Verilog mode (MH)
(defun verilog-add-statement-menu ()
"Add the menu 'Statements' to the menu bar in Verilog mode."
(easy-menu-define verilog-stmt-menu verilog-mode-map
"Menu for statement templates in Verilog."
'("Statements"
["Header" verilog-sk-header t]
["Comment" verilog-sk-comment t]
"----"
["Module" verilog-sk-module t]
["Primitive" verilog-sk-primitive t]
"----"
["Input" verilog-sk-input t]
["Output" verilog-sk-output t]
["Inout" verilog-sk-inout t]
["Wire" verilog-sk-wire t]
["Reg" verilog-sk-reg t]
"----"
["Initial" verilog-sk-initial t]
["Always" verilog-sk-always t]
["Function" verilog-sk-function t]
["Task" verilog-sk-task t]
["Specify" verilog-sk-specify t]
["Generate" verilog-sk-generate t]
"----"
["Begin" verilog-sk-begin t]
["If" verilog-sk-if t]
["(if) else" verilog-sk-else-if t]
["For" verilog-sk-for t]
["While" verilog-sk-while t]
["Fork" verilog-sk-fork t]
["Repeat" verilog-sk-repeat t]
["Case" verilog-sk-case t]
["Casex" verilog-sk-casex t]
["Casez" verilog-sk-casez t]
))
(if verilog-running-on-xemacs
(progn
(easy-menu-add verilog-stmt-menu)
(setq mode-popup-menu (cons "Verilog Mode" verilog-stmt-menu)))))
(add-hook 'verilog-mode-hook 'verilog-add-statement-menu)
;;
;; Bug reporting
;;
(defun verilog-submit-bug-report ()
"Submit via mail a bug report on lazy-lock.el."
(interactive)
(let ((reporter-prompt-for-summary-p t))
(reporter-submit-bug-report
"verilog-mode-bugs@surefirev.com"
(concat "verilog-mode v" (substring verilog-mode-version 12 -3))
'(
verilog-align-ifelse
verilog-auto-endcomments
verilog-auto-hook
verilog-auto-indent-on-newline
verilog-auto-inst-vector
verilog-auto-lineup
verilog-auto-newline
verilog-auto-save-policy
verilog-auto-sense-defines-constant
verilog-auto-sense-include-inputs
verilog-before-auto-hook
verilog-case-indent
verilog-cexp-indent
verilog-compiler
verilog-coverage
verilog-highlight-translate-off
verilog-indent-begin-after-if
verilog-indent-declaration-macros
verilog-indent-level
verilog-indent-level-behavioral
verilog-indent-level-declaration
verilog-indent-level-directive
verilog-indent-level-module
verilog-indent-lists
verilog-library-directories
verilog-library-extensions
verilog-library-files
verilog-linter
verilog-minimum-comment-distance
verilog-mode-hook
verilog-simulator
verilog-tab-always-indent
verilog-tab-to-comment
)
nil nil
(concat "Hi Mac,
I want to report a bug. I've read the `Bugs' section of `Info' on
Emacs, so I know how to make a clear and unambiguous report. To get
to that Info section, I typed
M-x info RET m " invocation-name " RET m bugs RET
Before I go further, I want to say that Verilog mode has changed my life.
I save so much time, my files are colored nicely, my co workers respect
my coding ability... until now. I'd really appreciate anything you
could do to help me out with this minor deficiency in the product.
To reproduce the bug, start a fresh Emacs via " invocation-name "
-no-init-file -no-site-file'. In a new buffer, in verilog mode, type
the code included below.
If you have bugs with the AUTO functions, please CC the AUTOAUTHOR
Wilson Snyder (wsnyder@wsnyder.org or wsnyder@world.std.com)
Given those lines, I expected [[Fill in here]] to happen;
but instead, [[Fill in here]] happens!.
== The code: =="))))
;; Local Variables:
;; checkdoc-permit-comma-termination-flag:t
;; checkdoc-force-docstrings-flag:nil
;; End:
;;; verilog-mode.el ends here
|