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
|
#ifndef STRINGBUF_H
#define STRINGBUF_H
/* (c) 2017 Workware Systems Pty Ltd -- All Rights Reserved */
#ifdef __cplusplus
extern "C" {
#endif
/** @file
* A stringbuf is a resizing, null terminated string buffer.
*
* The buffer is reallocated as necessary.
*
* In general it is *not* OK to call these functions with a NULL pointer
* unless stated otherwise.
*
* If USE_UTF8 is defined, supports utf8.
*/
/**
* The stringbuf structure should not be accessed directly.
* Use the functions below.
*/
typedef struct {
int remaining; /**< Allocated, but unused space */
int last; /**< Index of the null terminator (and thus the length of the string) */
#ifdef USE_UTF8
int chars; /**< Count of characters */
#endif
char *data; /**< Allocated memory containing the string or NULL for empty */
} stringbuf;
/**
* Allocates and returns a new stringbuf with no elements.
*/
stringbuf *sb_alloc(void);
/**
* Frees a stringbuf.
* It is OK to call this with NULL.
*/
void sb_free(stringbuf *sb);
/**
* Returns an allocated copy of the stringbuf
*/
stringbuf *sb_copy(stringbuf *sb);
/**
* Returns the length of the buffer.
*
* Returns 0 for both a NULL buffer and an empty buffer.
*/
static inline int sb_len(stringbuf *sb) {
return sb->last;
}
/**
* Returns the utf8 character length of the buffer.
*
* Returns 0 for both a NULL buffer and an empty buffer.
*/
static inline int sb_chars(stringbuf *sb) {
#ifdef USE_UTF8
return sb->chars;
#else
return sb->last;
#endif
}
/**
* Appends a null terminated string to the stringbuf
*/
void sb_append(stringbuf *sb, const char *str);
/**
* Like sb_append() except does not require a null terminated string.
* The length of 'str' is given as 'len'
*
* Note that in utf8 mode, characters will *not* be counted correctly
* if a partial utf8 sequence is added with sb_append_len()
*/
void sb_append_len(stringbuf *sb, const char *str, int len);
/**
* Returns a pointer to the null terminated string in the buffer.
*
* Note this pointer only remains valid until the next modification to the
* string buffer.
*
* The returned pointer can be used to update the buffer in-place
* as long as care is taken to not overwrite the end of the buffer.
*/
static inline char *sb_str(const stringbuf *sb)
{
return sb->data;
}
/**
* Inserts the given string *before* (zero-based) 'index' in the stringbuf.
* If index is past the end of the buffer, the string is appended,
* just like sb_append()
*/
void sb_insert(stringbuf *sb, int index, const char *str);
/**
* Delete 'len' bytes in the string at the given index.
*
* Any bytes past the end of the buffer are ignored.
* The buffer remains null terminated.
*
* If len is -1, deletes to the end of the buffer.
*/
void sb_delete(stringbuf *sb, int index, int len);
/**
* Clear to an empty buffer.
*/
void sb_clear(stringbuf *sb);
/**
* Return an allocated copy of buffer and frees 'sb'.
*
* If 'sb' is empty, returns an allocated copy of "".
*/
char *sb_to_string(stringbuf *sb);
#ifdef __cplusplus
}
#endif
#endif
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <ctype.h>
#include <assert.h>
#ifndef STRINGBUF_H
#include "stringbuf.h"
#endif
#ifdef USE_UTF8
#include "utf8.h"
#endif
#define SB_INCREMENT 200
stringbuf *sb_alloc(void)
{
stringbuf *sb = (stringbuf *)malloc(sizeof(*sb));
sb->remaining = 0;
sb->last = 0;
#ifdef USE_UTF8
sb->chars = 0;
#endif
sb->data = NULL;
return(sb);
}
void sb_free(stringbuf *sb)
{
if (sb) {
free(sb->data);
}
free(sb);
}
void sb_realloc(stringbuf *sb, int newlen)
{
sb->data = (char *)realloc(sb->data, newlen);
sb->remaining = newlen - sb->last;
}
void sb_append(stringbuf *sb, const char *str)
{
sb_append_len(sb, str, strlen(str));
}
void sb_append_len(stringbuf *sb, const char *str, int len)
{
if (sb->remaining < len + 1) {
sb_realloc(sb, sb->last + len + 1 + SB_INCREMENT);
}
memcpy(sb->data + sb->last, str, len);
sb->data[sb->last + len] = 0;
sb->last += len;
sb->remaining -= len;
#ifdef USE_UTF8
sb->chars += utf8_strlen(str, len);
#endif
}
char *sb_to_string(stringbuf *sb)
{
if (sb->data == NULL) {
/* Return an allocated empty string, not null */
return strdup("");
}
else {
/* Just return the data and free the stringbuf structure */
char *pt = sb->data;
free(sb);
return pt;
}
}
/* Insert and delete operations */
/* Moves up all the data at position 'pos' and beyond by 'len' bytes
* to make room for new data
*
* Note: Does *not* update sb->chars
*/
static void sb_insert_space(stringbuf *sb, int pos, int len)
{
assert(pos <= sb->last);
/* Make sure there is enough space */
if (sb->remaining < len) {
sb_realloc(sb, sb->last + len + SB_INCREMENT);
}
/* Now move it up */
memmove(sb->data + pos + len, sb->data + pos, sb->last - pos);
sb->last += len;
sb->remaining -= len;
/* And null terminate */
sb->data[sb->last] = 0;
}
/**
* Move down all the data from pos + len, effectively
* deleting the data at position 'pos' of length 'len'
*/
static void sb_delete_space(stringbuf *sb, int pos, int len)
{
assert(pos < sb->last);
assert(pos + len <= sb->last);
#ifdef USE_UTF8
sb->chars -= utf8_strlen(sb->data + pos, len);
#endif
/* Now move it up */
memmove(sb->data + pos, sb->data + pos + len, sb->last - pos - len);
sb->last -= len;
sb->remaining += len;
/* And null terminate */
sb->data[sb->last] = 0;
}
void sb_insert(stringbuf *sb, int index, const char *str)
{
if (index >= sb->last) {
/* Inserting after the end of the list appends. */
sb_append(sb, str);
}
else {
int len = strlen(str);
sb_insert_space(sb, index, len);
memcpy(sb->data + index, str, len);
#ifdef USE_UTF8
sb->chars += utf8_strlen(str, len);
#endif
}
}
/**
* Delete the bytes at index 'index' for length 'len'
* Has no effect if the index is past the end of the list.
*/
void sb_delete(stringbuf *sb, int index, int len)
{
if (index < sb->last) {
char *pos = sb->data + index;
if (len < 0) {
len = sb->last;
}
sb_delete_space(sb, pos - sb->data, len);
}
}
void sb_clear(stringbuf *sb)
{
if (sb->data) {
/* Null terminate */
sb->data[0] = 0;
sb->last = 0;
#ifdef USE_UTF8
sb->chars = 0;
#endif
}
}
/* linenoise.c -- guerrilla line editing library against the idea that a
* line editing lib needs to be 20,000 lines of C code.
*
* You can find the latest source code at:
*
* http://github.com/msteveb/linenoise
* (forked from http://github.com/antirez/linenoise)
*
* Does a number of crazy assumptions that happen to be true in 99.9999% of
* the 2010 UNIX computers around.
*
* ------------------------------------------------------------------------
*
* Copyright (c) 2010, Salvatore Sanfilippo <antirez at gmail dot com>
* Copyright (c) 2010, Pieter Noordhuis <pcnoordhuis at gmail dot com>
* Copyright (c) 2011, Steve Bennett <steveb at workware dot net dot au>
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ------------------------------------------------------------------------
*
* References:
* - http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
* - http://www.3waylabs.com/nw/WWW/products/wizcon/vt220.html
*
* Bloat:
* - Completion?
*
* Unix/termios
* ------------
* List of escape sequences used by this program, we do everything just
* a few sequences. In order to be so cheap we may have some
* flickering effect with some slow terminal, but the lesser sequences
* the more compatible.
*
* EL (Erase Line)
* Sequence: ESC [ 0 K
* Effect: clear from cursor to end of line
*
* CUF (CUrsor Forward)
* Sequence: ESC [ n C
* Effect: moves cursor forward n chars
*
* CR (Carriage Return)
* Sequence: \r
* Effect: moves cursor to column 1
*
* The following are used to clear the screen: ESC [ H ESC [ 2 J
* This is actually composed of two sequences:
*
* cursorhome
* Sequence: ESC [ H
* Effect: moves the cursor to upper left corner
*
* ED2 (Clear entire screen)
* Sequence: ESC [ 2 J
* Effect: clear the whole screen
*
* == For highlighting control characters, we also use the following two ==
* SO (enter StandOut)
* Sequence: ESC [ 7 m
* Effect: Uses some standout mode such as reverse video
*
* SE (Standout End)
* Sequence: ESC [ 0 m
* Effect: Exit standout mode
*
* == Only used if TIOCGWINSZ fails ==
* DSR/CPR (Report cursor position)
* Sequence: ESC [ 6 n
* Effect: reports current cursor position as ESC [ NNN ; MMM R
*
* == Only used in multiline mode ==
* CUU (Cursor Up)
* Sequence: ESC [ n A
* Effect: moves cursor up n chars.
*
* CUD (Cursor Down)
* Sequence: ESC [ n B
* Effect: moves cursor down n chars.
*
* win32/console
* -------------
* If __MINGW32__ is defined, the win32 console API is used.
* This could probably be made to work for the msvc compiler too.
* This support based in part on work by Jon Griffiths.
*/
#ifdef _WIN32 /* Windows platform, either MinGW or Visual Studio (MSVC) */
#include <windows.h>
#include <fcntl.h>
#define USE_WINCONSOLE
#ifdef __MINGW32__
#define HAVE_UNISTD_H
#else
/* Microsoft headers don't like old POSIX names */
#define strdup _strdup
#define snprintf _snprintf
#endif
#else
#include <termios.h>
#include <sys/ioctl.h>
#include <poll.h>
#define USE_TERMIOS
#define HAVE_UNISTD_H
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <stdlib.h>
#include <stdarg.h>
#include <stdio.h>
#include <assert.h>
#include <errno.h>
#include <string.h>
#include <signal.h>
#include <stdlib.h>
#include <sys/types.h>
#include "linenoise.h"
#ifndef STRINGBUF_H
#include "stringbuf.h"
#endif
#include "utf8.h"
#define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100
#define ctrl(C) ((C) - '@')
/* Use -ve numbers here to co-exist with normal unicode chars */
enum {
SPECIAL_NONE,
/* don't use -1 here since that indicates error */
SPECIAL_UP = -20,
SPECIAL_DOWN = -21,
SPECIAL_LEFT = -22,
SPECIAL_RIGHT = -23,
SPECIAL_DELETE = -24,
SPECIAL_HOME = -25,
SPECIAL_END = -26,
SPECIAL_INSERT = -27,
SPECIAL_PAGE_UP = -28,
SPECIAL_PAGE_DOWN = -29,
/* Some handy names for other special keycodes */
CHAR_ESCAPE = 27,
CHAR_DELETE = 127,
};
static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN;
static int history_len = 0;
static char **history = NULL;
/* Structure to contain the status of the current (being edited) line */
struct current {
stringbuf *buf; /* Current buffer. Always null terminated */
int pos; /* Cursor position, measured in chars */
int cols; /* Size of the window, in chars */
int nrows; /* How many rows are being used in multiline mode (>= 1) */
int rpos; /* The current row containing the cursor - multiline mode only */
int colsright; /* refreshLine() cached cols for insert_char() optimisation */
int colsleft; /* refreshLine() cached cols for remove_char() optimisation */
const char *prompt;
stringbuf *capture; /* capture buffer, or NULL for none. Always null terminated */
stringbuf *output; /* used only during refreshLine() - output accumulator */
#if defined(USE_TERMIOS)
int fd; /* Terminal fd */
#elif defined(USE_WINCONSOLE)
HANDLE outh; /* Console output handle */
HANDLE inh; /* Console input handle */
int rows; /* Screen rows */
int x; /* Current column during output */
int y; /* Current row */
#ifdef USE_UTF8
#define UBUF_MAX_CHARS 132
WORD ubuf[UBUF_MAX_CHARS + 1]; /* Accumulates utf16 output - one extra for final surrogate pairs */
int ubuflen; /* length used in ubuf */
int ubufcols; /* how many columns are represented by the chars in ubuf? */
#endif
#endif
};
static int fd_read(struct current *current);
static int getWindowSize(struct current *current);
static void cursorDown(struct current *current, int n);
static void cursorUp(struct current *current, int n);
static void eraseEol(struct current *current);
static void refreshLine(struct current *current);
static void refreshLineAlt(struct current *current, const char *prompt, const char *buf, int cursor_pos);
static void setCursorPos(struct current *current, int x);
static void setOutputHighlight(struct current *current, const int *props, int nprops);
static void set_current(struct current *current, const char *str);
void linenoiseHistoryFree(void) {
if (history) {
int j;
for (j = 0; j < history_len; j++)
free(history[j]);
free(history);
history = NULL;
history_len = 0;
}
}
struct esc_parser {
enum {
EP_START, /* looking for ESC */
EP_ESC, /* looking for [ */
EP_DIGITS, /* parsing digits */
EP_PROPS, /* parsing digits or semicolons */
EP_END, /* ok */
EP_ERROR, /* error */
} state;
int props[5]; /* properties are stored here */
int maxprops; /* size of the props[] array */
int numprops; /* number of properties found */
int termchar; /* terminator char, or 0 for any alpha */
int current; /* current (partial) property value */
};
/**
* Initialise the escape sequence parser at *parser.
*
* If termchar is 0 any alpha char terminates ok. Otherwise only the given
* char terminates successfully.
* Run the parser state machine with calls to parseEscapeSequence() for each char.
*/
static void initParseEscapeSeq(struct esc_parser *parser, int termchar)
{
parser->state = EP_START;
parser->maxprops = sizeof(parser->props) / sizeof(*parser->props);
parser->numprops = 0;
parser->current = 0;
parser->termchar = termchar;
}
/**
* Pass character 'ch' into the state machine to parse:
* 'ESC' '[' <digits> (';' <digits>)* <termchar>
*
* The first character must be ESC.
* Returns the current state. The state machine is done when it returns either EP_END
* or EP_ERROR.
*
* On EP_END, the "property/attribute" values can be read from parser->props[]
* of length parser->numprops.
*/
static int parseEscapeSequence(struct esc_parser *parser, int ch)
{
switch (parser->state) {
case EP_START:
parser->state = (ch == '\x1b') ? EP_ESC : EP_ERROR;
break;
case EP_ESC:
parser->state = (ch == '[') ? EP_DIGITS : EP_ERROR;
break;
case EP_PROPS:
if (ch == ';') {
parser->state = EP_DIGITS;
donedigits:
if (parser->numprops + 1 < parser->maxprops) {
parser->props[parser->numprops++] = parser->current;
parser->current = 0;
}
break;
}
/* fall through */
case EP_DIGITS:
if (ch >= '0' && ch <= '9') {
parser->current = parser->current * 10 + (ch - '0');
parser->state = EP_PROPS;
break;
}
/* must be terminator */
if (parser->termchar != ch) {
if (parser->termchar != 0 || !((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z'))) {
parser->state = EP_ERROR;
break;
}
}
parser->state = EP_END;
goto donedigits;
case EP_END:
parser->state = EP_ERROR;
break;
case EP_ERROR:
break;
}
return parser->state;
}
/*#define DEBUG_REFRESHLINE*/
#ifdef DEBUG_REFRESHLINE
#define DRL(ARGS...) fprintf(dfh, ARGS)
static FILE *dfh;
static void DRL_CHAR(int ch)
{
if (ch < ' ') {
DRL("^%c", ch + '@');
}
else if (ch > 127) {
DRL("\\u%04x", ch);
}
else {
DRL("%c", ch);
}
}
static void DRL_STR(const char *str)
{
while (*str) {
int ch;
int n = utf8_tounicode(str, &ch);
str += n;
DRL_CHAR(ch);
}
}
#else
#define DRL(ARGS...)
#define DRL_CHAR(ch)
#define DRL_STR(str)
#endif
#if defined(USE_WINCONSOLE)
#include "linenoise-win32.c"
#endif
#if defined(USE_TERMIOS)
static void linenoiseAtExit(void);
static struct termios orig_termios; /* in order to restore at exit */
static int rawmode = 0; /* for atexit() function to check if restore is needed*/
static int atexit_registered = 0; /* register atexit just 1 time */
static const char *unsupported_term[] = {"dumb","cons25","emacs",NULL};
static int isUnsupportedTerm(void) {
char *term = getenv("TERM");
if (term) {
int j;
for (j = 0; unsupported_term[j]; j++) {
if (strcmp(term, unsupported_term[j]) == 0) {
return 1;
}
}
}
return 0;
}
static int enableRawMode(struct current *current) {
struct termios raw;
current->fd = STDIN_FILENO;
current->cols = 0;
if (!isatty(current->fd) || isUnsupportedTerm() ||
tcgetattr(current->fd, &orig_termios) == -1) {
fatal:
errno = ENOTTY;
return -1;
}
if (!atexit_registered) {
atexit(linenoiseAtExit);
atexit_registered = 1;
}
raw = orig_termios; /* modify the original mode */
/* input modes: no break, no CR to NL, no parity check, no strip char,
* no start/stop output control. */
raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
/* output modes - actually, no need to disable post processing */
/*raw.c_oflag &= ~(OPOST);*/
/* control modes - set 8 bit chars */
raw.c_cflag |= (CS8);
/* local modes - choing off, canonical off, no extended functions,
* no signal chars (^Z,^C) */
raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
/* control chars - set return condition: min number of bytes and timer.
* We want read to return every single byte, without timeout. */
raw.c_cc[VMIN] = 1; raw.c_cc[VTIME] = 0; /* 1 byte, no timer */
/* put terminal in raw mode after flushing */
if (tcsetattr(current->fd,TCSADRAIN,&raw) < 0) {
goto fatal;
}
rawmode = 1;
return 0;
}
static void disableRawMode(struct current *current) {
/* Don't even check the return value as it's too late. */
if (rawmode && tcsetattr(current->fd,TCSADRAIN,&orig_termios) != -1)
rawmode = 0;
}
/* At exit we'll try to fix the terminal to the initial conditions. */
static void linenoiseAtExit(void) {
if (rawmode) {
tcsetattr(STDIN_FILENO, TCSADRAIN, &orig_termios);
}
linenoiseHistoryFree();
}
/* gcc/glibc insists that we care about the return code of write!
* Clarification: This means that a void-cast like "(void) (EXPR)"
* does not work.
*/
#define IGNORE_RC(EXPR) if (EXPR) {}
/**
* Output bytes directly, or accumulate output (if current->output is set)
*/
static void outputChars(struct current *current, const char *buf, int len)
{
if (len < 0) {
len = strlen(buf);
}
if (current->output) {
sb_append_len(current->output, buf, len);
}
else {
IGNORE_RC(write(current->fd, buf, len));
}
}
/* Like outputChars, but using printf-style formatting
*/
static void outputFormatted(struct current *current, const char *format, ...)
{
va_list args;
char buf[64];
int n;
va_start(args, format);
n = vsnprintf(buf, sizeof(buf), format, args);
/* This will never happen because we are sure to use outputFormatted() only for short sequences */
assert(n < (int)sizeof(buf));
va_end(args);
outputChars(current, buf, n);
}
static void cursorToLeft(struct current *current)
{
outputChars(current, "\r", -1);
}
static void setOutputHighlight(struct current *current, const int *props, int nprops)
{
outputChars(current, "\x1b[", -1);
while (nprops--) {
outputFormatted(current, "%d%c", *props, (nprops == 0) ? 'm' : ';');
props++;
}
}
static void eraseEol(struct current *current)
{
outputChars(current, "\x1b[0K", -1);
}
static void setCursorPos(struct current *current, int x)
{
if (x == 0) {
cursorToLeft(current);
}
else {
outputFormatted(current, "\r\x1b[%dC", x);
}
}
static void cursorUp(struct current *current, int n)
{
if (n) {
outputFormatted(current, "\x1b[%dA", n);
}
}
static void cursorDown(struct current *current, int n)
{
if (n) {
outputFormatted(current, "\x1b[%dB", n);
}
}
void linenoiseClearScreen(void)
{
IGNORE_RC(write(STDOUT_FILENO, "\x1b[H\x1b[2J", 7));
}
/**
* Reads a char from 'fd', waiting at most 'timeout' milliseconds.
*
* A timeout of -1 means to wait forever.
*
* Returns -1 if no char is received within the time or an error occurs.
*/
static int fd_read_char(int fd, int timeout)
{
struct pollfd p;
unsigned char c;
p.fd = fd;
p.events = POLLIN;
if (poll(&p, 1, timeout) == 0) {
/* timeout */
return -1;
}
if (read(fd, &c, 1) != 1) {
return -1;
}
return c;
}
/**
* Reads a complete utf-8 character
* and returns the unicode value, or -1 on error.
*/
static int fd_read(struct current *current)
{
#ifdef USE_UTF8
char buf[MAX_UTF8_LEN];
int n;
int i;
int c;
if (read(current->fd, &buf[0], 1) != 1) {
return -1;
}
n = utf8_charlen(buf[0]);
if (n < 1) {
return -1;
}
for (i = 1; i < n; i++) {
if (read(current->fd, &buf[i], 1) != 1) {
return -1;
}
}
/* decode and return the character */
utf8_tounicode(buf, &c);
return c;
#else
return fd_read_char(current->fd, -1);
#endif
}
/**
* Stores the current cursor column in '*cols'.
* Returns 1 if OK, or 0 if failed to determine cursor pos.
*/
static int queryCursor(struct current *current, int* cols)
{
struct esc_parser parser;
int ch;
/* Should not be buffering this output, it needs to go immediately */
assert(current->output == NULL);
/* control sequence - report cursor location */
outputChars(current, "\x1b[6n", -1);
/* Parse the response: ESC [ rows ; cols R */
initParseEscapeSeq(&parser, 'R');
while ((ch = fd_read_char(current->fd, 100)) > 0) {
switch (parseEscapeSequence(&parser, ch)) {
default:
continue;
case EP_END:
if (parser.numprops == 2 && parser.props[1] < 1000) {
*cols = parser.props[1];
return 1;
}
break;
case EP_ERROR:
break;
}
/* failed */
break;
}
return 0;
}
/**
* Updates current->cols with the current window size (width)
*/
static int getWindowSize(struct current *current)
{
struct winsize ws;
if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) == 0 && ws.ws_col != 0) {
current->cols = ws.ws_col;
return 0;
}
/* Failed to query the window size. Perhaps we are on a serial terminal.
* Try to query the width by sending the cursor as far to the right
* and reading back the cursor position.
* Note that this is only done once per call to linenoise rather than
* every time the line is refreshed for efficiency reasons.
*
* In more detail, we:
* (a) request current cursor position,
* (b) move cursor far right,
* (c) request cursor position again,
* (d) at last move back to the old position.
* This gives us the width without messing with the externally
* visible cursor position.
*/
if (current->cols == 0) {
int here;
/* If anything fails => default 80 */
current->cols = 80;
/* (a) */
if (queryCursor (current, &here)) {
/* (b) */
setCursorPos(current, 999);
/* (c). Note: If (a) succeeded, then (c) should as well.
* For paranoia we still check and have a fallback action
* for (d) in case of failure..
*/
if (queryCursor (current, ¤t->cols)) {
/* (d) Reset the cursor back to the original location. */
if (current->cols > here) {
setCursorPos(current, here);
}
}
}
}
return 0;
}
/**
* If CHAR_ESCAPE was received, reads subsequent
* chars to determine if this is a known special key.
*
* Returns SPECIAL_NONE if unrecognised, or -1 if EOF.
*
* If no additional char is received within a short time,
* CHAR_ESCAPE is returned.
*/
static int check_special(int fd)
{
int c = fd_read_char(fd, 50);
int c2;
if (c < 0) {
return CHAR_ESCAPE;
}
c2 = fd_read_char(fd, 50);
if (c2 < 0) {
return c2;
}
if (c == '[' || c == 'O') {
/* Potential arrow key */
switch (c2) {
case 'A':
return SPECIAL_UP;
case 'B':
return SPECIAL_DOWN;
case 'C':
return SPECIAL_RIGHT;
case 'D':
return SPECIAL_LEFT;
case 'F':
return SPECIAL_END;
case 'H':
return SPECIAL_HOME;
}
}
if (c == '[' && c2 >= '1' && c2 <= '8') {
/* extended escape */
c = fd_read_char(fd, 50);
if (c == '~') {
switch (c2) {
case '2':
return SPECIAL_INSERT;
case '3':
return SPECIAL_DELETE;
case '5':
return SPECIAL_PAGE_UP;
case '6':
return SPECIAL_PAGE_DOWN;
case '7':
return SPECIAL_HOME;
case '8':
return SPECIAL_END;
}
}
while (c != -1 && c != '~') {
/* .e.g \e[12~ or '\e[11;2~ discard the complete sequence */
c = fd_read_char(fd, 50);
}
}
return SPECIAL_NONE;
}
#endif
static void clearOutputHighlight(struct current *current)
{
int nohighlight = 0;
setOutputHighlight(current, &nohighlight, 1);
}
static void outputControlChar(struct current *current, char ch)
{
int reverse = 7;
setOutputHighlight(current, &reverse, 1);
outputChars(current, "^", 1);
outputChars(current, &ch, 1);
clearOutputHighlight(current);
}
#ifndef utf8_getchars
static int utf8_getchars(char *buf, int c)
{
#ifdef USE_UTF8
return utf8_fromunicode(buf, c);
#else
*buf = c;
return 1;
#endif
}
#endif
/**
* Returns the unicode character at the given offset,
* or -1 if none.
*/
static int get_char(struct current *current, int pos)
{
if (pos >= 0 && pos < sb_chars(current->buf)) {
int c;
int i = utf8_index(sb_str(current->buf), pos);
(void)utf8_tounicode(sb_str(current->buf) + i, &c);
return c;
}
return -1;
}
static int char_display_width(int ch)
{
if (ch < ' ') {
/* control chars take two positions */
return 2;
}
else {
return utf8_width(ch);
}
}
#ifndef NO_COMPLETION
static linenoiseCompletionCallback *completionCallback = NULL;
static void *completionUserdata = NULL;
static int showhints = 1;
static linenoiseHintsCallback *hintsCallback = NULL;
static linenoiseFreeHintsCallback *freeHintsCallback = NULL;
static void *hintsUserdata = NULL;
static void beep() {
#ifdef USE_TERMIOS
fprintf(stderr, "\x7");
fflush(stderr);
#endif
}
static void freeCompletions(linenoiseCompletions *lc) {
size_t i;
for (i = 0; i < lc->len; i++)
free(lc->cvec[i]);
free(lc->cvec);
}
static int completeLine(struct current *current) {
linenoiseCompletions lc = { 0, NULL };
int c = 0;
completionCallback(sb_str(current->buf),&lc,completionUserdata);
if (lc.len == 0) {
beep();
} else {
size_t stop = 0, i = 0;
while(!stop) {
/* Show completion or original buffer */
if (i < lc.len) {
int chars = utf8_strlen(lc.cvec[i], -1);
refreshLineAlt(current, current->prompt, lc.cvec[i], chars);
} else {
refreshLine(current);
}
c = fd_read(current);
if (c == -1) {
break;
}
switch(c) {
case '\t': /* tab */
i = (i+1) % (lc.len+1);
if (i == lc.len) beep();
break;
case CHAR_ESCAPE: /* escape */
/* Re-show original buffer */
if (i < lc.len) {
refreshLine(current);
}
stop = 1;
break;
default:
/* Update buffer and return */
if (i < lc.len) {
set_current(current,lc.cvec[i]);
}
stop = 1;
break;
}
}
}
freeCompletions(&lc);
return c; /* Return last read character */
}
/* Register a callback function to be called for tab-completion.
Returns the prior callback so that the caller may (if needed)
restore it when done. */
linenoiseCompletionCallback * linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn, void *userdata) {
linenoiseCompletionCallback * old = completionCallback;
completionCallback = fn;
completionUserdata = userdata;
return old;
}
void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) {
lc->cvec = (char **)realloc(lc->cvec,sizeof(char*)*(lc->len+1));
lc->cvec[lc->len++] = strdup(str);
}
void linenoiseSetHintsCallback(linenoiseHintsCallback *callback, void *userdata)
{
hintsCallback = callback;
hintsUserdata = userdata;
}
void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *callback)
{
freeHintsCallback = callback;
}
#endif
static const char *reduceSingleBuf(const char *buf, int availcols, int *cursor_pos)
{
/* We have availcols columns available.
* If necessary, strip chars off the front of buf until *cursor_pos
* fits within availcols
*/
int needcols = 0;
int pos = 0;
int new_cursor_pos = *cursor_pos;
const char *pt = buf;
DRL("reduceSingleBuf: availcols=%d, cursor_pos=%d\n", availcols, *cursor_pos);
while (*pt) {
int ch;
int n = utf8_tounicode(pt, &ch);
pt += n;
needcols += char_display_width(ch);
/* If we need too many cols, strip
* chars off the front of buf to make it fit.
* We keep 3 extra cols to the right of the cursor.
* 2 for possible wide chars, 1 for the last column that
* can't be used.
*/
while (needcols >= availcols - 3) {
n = utf8_tounicode(buf, &ch);
buf += n;
needcols -= char_display_width(ch);
DRL_CHAR(ch);
/* and adjust the apparent cursor position */
new_cursor_pos--;
if (buf == pt) {
/* can't remove more than this */
break;
}
}
if (pos++ == *cursor_pos) {
break;
}
}
DRL("<snip>");
DRL_STR(buf);
DRL("\nafter reduce, needcols=%d, new_cursor_pos=%d\n", needcols, new_cursor_pos);
/* Done, now new_cursor_pos contains the adjusted cursor position
* and buf points to he adjusted start
*/
*cursor_pos = new_cursor_pos;
return buf;
}
static int mlmode = 0;
void linenoiseSetMultiLine(int enableml)
{
mlmode = enableml;
}
/* Helper of refreshSingleLine() and refreshMultiLine() to show hints
* to the right of the prompt.
* Returns 1 if a hint was shown, or 0 if not
* If 'display' is 0, does no output. Just returns the appropriate return code.
*/
static int refreshShowHints(struct current *current, const char *buf, int availcols, int display)
{
int rc = 0;
if (showhints && hintsCallback && availcols > 0) {
int bold = 0;
int color = -1;
char *hint = hintsCallback(buf, &color, &bold, hintsUserdata);
if (hint) {
rc = 1;
if (display) {
const char *pt;
if (bold == 1 && color == -1) color = 37;
if (bold || color > 0) {
int props[3] = { bold, color, 49 }; /* bold, color, fgnormal */
setOutputHighlight(current, props, 3);
}
DRL("<hint bold=%d,color=%d>", bold, color);
pt = hint;
while (*pt) {
int ch;
int n = utf8_tounicode(pt, &ch);
int width = char_display_width(ch);
if (width >= availcols) {
DRL("<hinteol>");
break;
}
DRL_CHAR(ch);
availcols -= width;
outputChars(current, pt, n);
pt += n;
}
if (bold || color > 0) {
clearOutputHighlight(current);
}
/* Call the function to free the hint returned. */
if (freeHintsCallback) freeHintsCallback(hint, hintsUserdata);
}
}
}
return rc;
}
#ifdef USE_TERMIOS
static void refreshStart(struct current *current)
{
/* We accumulate all output here */
assert(current->output == NULL);
current->output = sb_alloc();
}
static void refreshEnd(struct current *current)
{
/* Output everything at once */
IGNORE_RC(write(current->fd, sb_str(current->output), sb_len(current->output)));
sb_free(current->output);
current->output = NULL;
}
static void refreshStartChars(struct current *current)
{
}
static void refreshNewline(struct current *current)
{
DRL("<nl>");
outputChars(current, "\n", 1);
}
static void refreshEndChars(struct current *current)
{
}
#endif
static void refreshLineAlt(struct current *current, const char *prompt, const char *buf, int cursor_pos)
{
int i;
const char *pt;
int displaycol;
int displayrow;
int visible;
int currentpos;
int notecursor;
int cursorcol = 0;
int cursorrow = 0;
int hint;
struct esc_parser parser;
#ifdef DEBUG_REFRESHLINE
dfh = fopen("linenoise.debuglog", "a");
#endif
/* Should intercept SIGWINCH. For now, just get the size every time */
getWindowSize(current);
refreshStart(current);
DRL("wincols=%d, cursor_pos=%d, nrows=%d, rpos=%d\n", current->cols, cursor_pos, current->nrows, current->rpos);
/* Here is the plan:
* (a) move the the bottom row, going down the appropriate number of lines
* (b) move to beginning of line and erase the current line
* (c) go up one line and do the same, until we have erased up to the first row
* (d) output the prompt, counting cols and rows, taking into account escape sequences
* (e) output the buffer, counting cols and rows
* (e') when we hit the current pos, save the cursor position
* (f) move the cursor to the saved cursor position
* (g) save the current cursor row and number of rows
*/
/* (a) - The cursor is currently at row rpos */
cursorDown(current, current->nrows - current->rpos - 1);
DRL("<cud=%d>", current->nrows - current->rpos - 1);
/* (b), (c) - Erase lines upwards until we get to the first row */
for (i = 0; i < current->nrows; i++) {
if (i) {
DRL("<cup>");
cursorUp(current, 1);
}
DRL("<clearline>");
cursorToLeft(current);
eraseEol(current);
}
DRL("\n");
/* (d) First output the prompt. control sequences don't take up display space */
pt = prompt;
displaycol = 0; /* current display column */
displayrow = 0; /* current display row */
visible = 1;
refreshStartChars(current);
while (*pt) {
int width;
int ch;
int n = utf8_tounicode(pt, &ch);
if (visible && ch == CHAR_ESCAPE) {
/* The start of an escape sequence, so not visible */
visible = 0;
initParseEscapeSeq(&parser, 'm');
DRL("<esc-seq-start>");
}
if (ch == '\n' || ch == '\r') {
/* treat both CR and NL the same and force wrap */
refreshNewline(current);
displaycol = 0;
displayrow++;
}
else {
width = visible * utf8_width(ch);
displaycol += width;
if (displaycol >= current->cols) {
/* need to wrap to the next line because of newline or if it doesn't fit
* XXX this is a problem in single line mode
*/
refreshNewline(current);
displaycol = width;
displayrow++;
}
DRL_CHAR(ch);
#ifdef USE_WINCONSOLE
if (visible) {
outputChars(current, pt, n);
}
#else
outputChars(current, pt, n);
#endif
}
pt += n;
if (!visible) {
switch (parseEscapeSequence(&parser, ch)) {
case EP_END:
visible = 1;
setOutputHighlight(current, parser.props, parser.numprops);
DRL("<esc-seq-end,numprops=%d>", parser.numprops);
break;
case EP_ERROR:
DRL("<esc-seq-err>");
visible = 1;
break;
}
}
}
/* Now we are at the first line with all lines erased */
DRL("\nafter prompt: displaycol=%d, displayrow=%d\n", displaycol, displayrow);
/* (e) output the buffer, counting cols and rows */
if (mlmode == 0) {
/* In this mode we may need to trim chars from the start of the buffer until the
* cursor fits in the window.
*/
pt = reduceSingleBuf(buf, current->cols - displaycol, &cursor_pos);
}
else {
pt = buf;
}
currentpos = 0;
notecursor = -1;
while (*pt) {
int ch;
int n = utf8_tounicode(pt, &ch);
int width = char_display_width(ch);
if (currentpos == cursor_pos) {
/* (e') wherever we output this character is where we want the cursor */
notecursor = 1;
}
if (displaycol + width >= current->cols) {
if (mlmode == 0) {
/* In single line mode stop once we print as much as we can on one line */
DRL("<slmode>");
break;
}
/* need to wrap to the next line since it doesn't fit */
refreshNewline(current);
displaycol = 0;
displayrow++;
}
if (notecursor == 1) {
/* (e') Save this position as the current cursor position */
cursorcol = displaycol;
cursorrow = displayrow;
notecursor = 0;
DRL("<cursor>");
}
displaycol += width;
if (ch < ' ') {
outputControlChar(current, ch + '@');
}
else {
outputChars(current, pt, n);
}
DRL_CHAR(ch);
if (width != 1) {
DRL("<w=%d>", width);
}
pt += n;
currentpos++;
}
/* If we didn't see the cursor, it is at the current location */
if (notecursor) {
DRL("<cursor>");
cursorcol = displaycol;
cursorrow = displayrow;
}
DRL("\nafter buf: displaycol=%d, displayrow=%d, cursorcol=%d, cursorrow=%d\n", displaycol, displayrow, cursorcol, cursorrow);
/* (f) show hints */
hint = refreshShowHints(current, buf, current->cols - displaycol, 1);
/* Remember how many many cols are available for insert optimisation */
if (prompt == current->prompt && hint == 0) {
current->colsright = current->cols - displaycol;
current->colsleft = displaycol;
}
else {
/* Can't optimise */
current->colsright = 0;
current->colsleft = 0;
}
DRL("\nafter hints: colsleft=%d, colsright=%d\n\n", current->colsleft, current->colsright);
refreshEndChars(current);
/* (g) move the cursor to the correct place */
cursorUp(current, displayrow - cursorrow);
setCursorPos(current, cursorcol);
/* (h) Update the number of rows if larger, but never reduce this */
if (displayrow >= current->nrows) {
current->nrows = displayrow + 1;
}
/* And remember the row that the cursor is on */
current->rpos = cursorrow;
refreshEnd(current);
#ifdef DEBUG_REFRESHLINE
fclose(dfh);
#endif
}
static void refreshLine(struct current *current)
{
refreshLineAlt(current, current->prompt, sb_str(current->buf), current->pos);
}
static void set_current(struct current *current, const char *str)
{
sb_clear(current->buf);
sb_append(current->buf, str);
current->pos = sb_chars(current->buf);
}
/**
* Removes the char at 'pos'.
*
* Returns 1 if the line needs to be refreshed, 2 if not
* and 0 if nothing was removed
*/
static int remove_char(struct current *current, int pos)
{
if (pos >= 0 && pos < sb_chars(current->buf)) {
int offset = utf8_index(sb_str(current->buf), pos);
int nbytes = utf8_index(sb_str(current->buf) + offset, 1);
int rc = 1;
/* Now we try to optimise in the simple but very common case that:
* - outputChars() can be used directly (not win32)
* - we are removing the char at EOL
* - the buffer is not empty
* - there are columns available to the left
* - the char being deleted is not a wide or utf-8 character
* - no hints are being shown
*/
if (current->output && current->pos == pos + 1 && current->pos == sb_chars(current->buf) && pos > 0) {
#ifdef USE_UTF8
/* Could implement utf8_prev_len() but simplest just to not optimise this case */
char last = sb_str(current->buf)[offset];
#else
char last = 0;
#endif
if (current->colsleft > 0 && (last & 0x80) == 0) {
/* Have cols on the left and not a UTF-8 char or continuation */
/* Yes, can optimise */
current->colsleft--;
current->colsright++;
rc = 2;
}
}
sb_delete(current->buf, offset, nbytes);
if (current->pos > pos) {
current->pos--;
}
if (rc == 2) {
if (refreshShowHints(current, sb_str(current->buf), current->colsright, 0)) {
/* A hint needs to be shown, so can't optimise after all */
rc = 1;
}
else {
/* optimised output */
outputChars(current, "\b \b", 3);
}
}
return rc;
return 1;
}
return 0;
}
/**
* Insert 'ch' at position 'pos'
*
* Returns 1 if the line needs to be refreshed, 2 if not
* and 0 if nothing was inserted (no room)
*/
static int insert_char(struct current *current, int pos, int ch)
{
if (pos >= 0 && pos <= sb_chars(current->buf)) {
char buf[MAX_UTF8_LEN + 1];
int offset = utf8_index(sb_str(current->buf), pos);
int n = utf8_getchars(buf, ch);
int rc = 1;
/* null terminate since sb_insert() requires it */
buf[n] = 0;
/* Now we try to optimise in the simple but very common case that:
* - outputChars() can be used directly (not win32)
* - we are inserting at EOL
* - there are enough columns available
* - no hints are being shown
*/
if (current->output && pos == current->pos && pos == sb_chars(current->buf)) {
int width = char_display_width(ch);
if (current->colsright > width) {
/* Yes, can optimise */
current->colsright -= width;
current->colsleft -= width;
rc = 2;
}
}
sb_insert(current->buf, offset, buf);
if (current->pos >= pos) {
current->pos++;
}
if (rc == 2) {
if (refreshShowHints(current, sb_str(current->buf), current->colsright, 0)) {
/* A hint needs to be shown, so can't optimise after all */
rc = 1;
}
else {
/* optimised output */
outputChars(current, buf, n);
}
}
return rc;
}
return 0;
}
/**
* Captures up to 'n' characters starting at 'pos' for the cut buffer.
*
* This replaces any existing characters in the cut buffer.
*/
static void capture_chars(struct current *current, int pos, int nchars)
{
if (pos >= 0 && (pos + nchars - 1) < sb_chars(current->buf)) {
int offset = utf8_index(sb_str(current->buf), pos);
int nbytes = utf8_index(sb_str(current->buf) + offset, nchars);
if (nbytes > 0) {
if (current->capture) {
sb_clear(current->capture);
}
else {
current->capture = sb_alloc();
}
sb_append_len(current->capture, sb_str(current->buf) + offset, nbytes);
}
}
}
/**
* Removes up to 'n' characters at cursor position 'pos'.
*
* Returns 0 if no chars were removed or non-zero otherwise.
*/
static int remove_chars(struct current *current, int pos, int n)
{
int removed = 0;
/* First save any chars which will be removed */
capture_chars(current, pos, n);
while (n-- && remove_char(current, pos)) {
removed++;
}
return removed;
}
/**
* Inserts the characters (string) 'chars' at the cursor position 'pos'.
*
* Returns 0 if no chars were inserted or non-zero otherwise.
*/
static int insert_chars(struct current *current, int pos, const char *chars)
{
int inserted = 0;
while (*chars) {
int ch;
int n = utf8_tounicode(chars, &ch);
if (insert_char(current, pos, ch) == 0) {
break;
}
inserted++;
pos++;
chars += n;
}
return inserted;
}
/**
* Returns the keycode to process, or 0 if none.
*/
static int reverseIncrementalSearch(struct current *current)
{
/* Display the reverse-i-search prompt and process chars */
char rbuf[50];
char rprompt[80];
int rchars = 0;
int rlen = 0;
int searchpos = history_len - 1;
int c;
rbuf[0] = 0;
while (1) {
int n = 0;
const char *p = NULL;
int skipsame = 0;
int searchdir = -1;
snprintf(rprompt, sizeof(rprompt), "(reverse-i-search)'%s': ", rbuf);
refreshLineAlt(current, rprompt, sb_str(current->buf), current->pos);
c = fd_read(current);
if (c == ctrl('H') || c == CHAR_DELETE) {
if (rchars) {
int p = utf8_index(rbuf, --rchars);
rbuf[p] = 0;
rlen = strlen(rbuf);
}
continue;
}
#ifdef USE_TERMIOS
if (c == CHAR_ESCAPE) {
c = check_special(current->fd);
}
#endif
if (c == ctrl('P') || c == SPECIAL_UP) {
/* Search for the previous (earlier) match */
if (searchpos > 0) {
searchpos--;
}
skipsame = 1;
}
else if (c == ctrl('N') || c == SPECIAL_DOWN) {
/* Search for the next (later) match */
if (searchpos < history_len) {
searchpos++;
}
searchdir = 1;
skipsame = 1;
}
else if (c >= ' ') {
/* >= here to allow for null terminator */
if (rlen >= (int)sizeof(rbuf) - MAX_UTF8_LEN) {
continue;
}
n = utf8_getchars(rbuf + rlen, c);
rlen += n;
rchars++;
rbuf[rlen] = 0;
/* Adding a new char resets the search location */
searchpos = history_len - 1;
}
else {
/* Exit from incremental search mode */
break;
}
/* Now search through the history for a match */
for (; searchpos >= 0 && searchpos < history_len; searchpos += searchdir) {
p = strstr(history[searchpos], rbuf);
if (p) {
/* Found a match */
if (skipsame && strcmp(history[searchpos], sb_str(current->buf)) == 0) {
/* But it is identical, so skip it */
continue;
}
/* Copy the matching line and set the cursor position */
set_current(current,history[searchpos]);
current->pos = utf8_strlen(history[searchpos], p - history[searchpos]);
break;
}
}
if (!p && n) {
/* No match, so don't add it */
rchars--;
rlen -= n;
rbuf[rlen] = 0;
}
}
if (c == ctrl('G') || c == ctrl('C')) {
/* ctrl-g terminates the search with no effect */
set_current(current, "");
c = 0;
}
else if (c == ctrl('J')) {
/* ctrl-j terminates the search leaving the buffer in place */
c = 0;
}
/* Go process the char normally */
refreshLine(current);
return c;
}
static int linenoiseEdit(struct current *current) {
int history_index = 0;
/* The latest history entry is always our current buffer, that
* initially is just an empty string. */
linenoiseHistoryAdd("");
set_current(current, "");
refreshLine(current);
while(1) {
int dir = -1;
int c = fd_read(current);
#ifndef NO_COMPLETION
/* Only autocomplete when the callback is set. It returns < 0 when
* there was an error reading from fd. Otherwise it will return the
* character that should be handled next. */
if (c == '\t' && current->pos == sb_chars(current->buf) && completionCallback != NULL) {
c = completeLine(current);
}
#endif
if (c == ctrl('R')) {
/* reverse incremental search will provide an alternative keycode or 0 for none */
c = reverseIncrementalSearch(current);
/* go on to process the returned char normally */
}
#ifdef USE_TERMIOS
if (c == CHAR_ESCAPE) { /* escape sequence */
c = check_special(current->fd);
}
#endif
if (c == -1) {
/* Return on errors */
return sb_len(current->buf);
}
switch(c) {
case SPECIAL_NONE:
break;
case '\r': /* enter/CR */
case '\n': /* LF */
history_len--;
free(history[history_len]);
current->pos = sb_chars(current->buf);
if (mlmode || hintsCallback) {
showhints = 0;
refreshLine(current);
showhints = 1;
}
return sb_len(current->buf);
case ctrl('C'): /* ctrl-c */
errno = EAGAIN;
return -1;
case ctrl('Z'): /* ctrl-z */
#ifdef SIGTSTP
/* send ourselves SIGSUSP */
disableRawMode(current);
raise(SIGTSTP);
/* and resume */
enableRawMode(current);
refreshLine(current);
#endif
continue;
case CHAR_DELETE: /* backspace */
case ctrl('H'):
if (remove_char(current, current->pos - 1) == 1) {
refreshLine(current);
}
break;
case ctrl('D'): /* ctrl-d */
if (sb_len(current->buf) == 0) {
/* Empty line, so EOF */
history_len--;
free(history[history_len]);
return -1;
}
/* Otherwise fall through to delete char to right of cursor */
case SPECIAL_DELETE:
if (remove_char(current, current->pos) == 1) {
refreshLine(current);
}
break;
case SPECIAL_INSERT:
/* Ignore. Expansion Hook.
* Future possibility: Toggle Insert/Overwrite Modes
*/
break;
case ctrl('W'): /* ctrl-w, delete word at left. save deleted chars */
/* eat any spaces on the left */
{
int pos = current->pos;
while (pos > 0 && get_char(current, pos - 1) == ' ') {
pos--;
}
/* now eat any non-spaces on the left */
while (pos > 0 && get_char(current, pos - 1) != ' ') {
pos--;
}
if (remove_chars(current, pos, current->pos - pos)) {
refreshLine(current);
}
}
break;
case ctrl('T'): /* ctrl-t */
if (current->pos > 0 && current->pos <= sb_chars(current->buf)) {
/* If cursor is at end, transpose the previous two chars */
int fixer = (current->pos == sb_chars(current->buf));
c = get_char(current, current->pos - fixer);
remove_char(current, current->pos - fixer);
insert_char(current, current->pos - 1, c);
refreshLine(current);
}
break;
case ctrl('V'): /* ctrl-v */
/* Insert the ^V first */
if (insert_char(current, current->pos, c)) {
refreshLine(current);
/* Now wait for the next char. Can insert anything except \0 */
c = fd_read(current);
/* Remove the ^V first */
remove_char(current, current->pos - 1);
if (c > 0) {
/* Insert the actual char, can't be error or null */
insert_char(current, current->pos, c);
}
refreshLine(current);
}
break;
case ctrl('B'):
case SPECIAL_LEFT:
if (current->pos > 0) {
current->pos--;
refreshLine(current);
}
break;
case ctrl('F'):
case SPECIAL_RIGHT:
if (current->pos < sb_chars(current->buf)) {
current->pos++;
refreshLine(current);
}
break;
case SPECIAL_PAGE_UP:
dir = history_len - history_index - 1; /* move to start of history */
goto history_navigation;
case SPECIAL_PAGE_DOWN:
dir = -history_index; /* move to 0 == end of history, i.e. current */
goto history_navigation;
case ctrl('P'):
case SPECIAL_UP:
dir = 1;
goto history_navigation;
case ctrl('N'):
case SPECIAL_DOWN:
history_navigation:
if (history_len > 1) {
/* Update the current history entry before to
* overwrite it with tne next one. */
free(history[history_len - 1 - history_index]);
history[history_len - 1 - history_index] = strdup(sb_str(current->buf));
/* Show the new entry */
history_index += dir;
if (history_index < 0) {
history_index = 0;
break;
} else if (history_index >= history_len) {
history_index = history_len - 1;
break;
}
set_current(current, history[history_len - 1 - history_index]);
refreshLine(current);
}
break;
case ctrl('A'): /* Ctrl+a, go to the start of the line */
case SPECIAL_HOME:
current->pos = 0;
refreshLine(current);
break;
case ctrl('E'): /* ctrl+e, go to the end of the line */
case SPECIAL_END:
current->pos = sb_chars(current->buf);
refreshLine(current);
break;
case ctrl('U'): /* Ctrl+u, delete to beginning of line, save deleted chars. */
if (remove_chars(current, 0, current->pos)) {
refreshLine(current);
}
break;
case ctrl('K'): /* Ctrl+k, delete from current to end of line, save deleted chars. */
if (remove_chars(current, current->pos, sb_chars(current->buf) - current->pos)) {
refreshLine(current);
}
break;
case ctrl('Y'): /* Ctrl+y, insert saved chars at current position */
if (current->capture && insert_chars(current, current->pos, sb_str(current->capture))) {
refreshLine(current);
}
break;
case ctrl('L'): /* Ctrl+L, clear screen */
linenoiseClearScreen();
/* Force recalc of window size for serial terminals */
current->cols = 0;
current->rpos = 0;
refreshLine(current);
break;
default:
/* Only tab is allowed without ^V */
if (c == '\t' || c >= ' ') {
if (insert_char(current, current->pos, c) == 1) {
refreshLine(current);
}
}
break;
}
}
return sb_len(current->buf);
}
int linenoiseColumns(void)
{
struct current current;
current.output = NULL;
enableRawMode (¤t);
getWindowSize (¤t);
disableRawMode (¤t);
return current.cols;
}
/**
* Reads a line from the file handle (without the trailing NL or CRNL)
* and returns it in a stringbuf.
* Returns NULL if no characters are read before EOF or error.
*
* Note that the character count will *not* be correct for lines containing
* utf8 sequences. Do not rely on the character count.
*/
static stringbuf *sb_getline(FILE *fh)
{
stringbuf *sb = sb_alloc();
int c;
int n = 0;
while ((c = getc(fh)) != EOF) {
char ch;
n++;
if (c == '\r') {
/* CRLF -> LF */
continue;
}
if (c == '\n' || c == '\r') {
break;
}
ch = c;
/* ignore the effect of character count for partial utf8 sequences */
sb_append_len(sb, &ch, 1);
}
if (n == 0) {
sb_free(sb);
return NULL;
}
return sb;
}
char *linenoise(const char *prompt)
{
int count;
struct current current;
stringbuf *sb;
memset(¤t, 0, sizeof(current));
if (enableRawMode(¤t) == -1) {
printf("%s", prompt);
fflush(stdout);
sb = sb_getline(stdin);
}
else {
current.buf = sb_alloc();
current.pos = 0;
current.nrows = 1;
current.prompt = prompt;
count = linenoiseEdit(¤t);
disableRawMode(¤t);
printf("\n");
sb_free(current.capture);
if (count == -1) {
sb_free(current.buf);
return NULL;
}
sb = current.buf;
}
return sb ? sb_to_string(sb) : NULL;
}
/* Using a circular buffer is smarter, but a bit more complex to handle. */
int linenoiseHistoryAddAllocated(char *line) {
if (history_max_len == 0) {
notinserted:
free(line);
return 0;
}
if (history == NULL) {
history = (char **)calloc(sizeof(char*), history_max_len);
}
/* do not insert duplicate lines into history */
if (history_len > 0 && strcmp(line, history[history_len - 1]) == 0) {
goto notinserted;
}
if (history_len == history_max_len) {
free(history[0]);
memmove(history,history+1,sizeof(char*)*(history_max_len-1));
history_len--;
}
history[history_len] = line;
history_len++;
return 1;
}
int linenoiseHistoryAdd(const char *line) {
return linenoiseHistoryAddAllocated(strdup(line));
}
int linenoiseHistoryGetMaxLen(void) {
return history_max_len;
}
int linenoiseHistorySetMaxLen(int len) {
char **newHistory;
if (len < 1) return 0;
if (history) {
int tocopy = history_len;
newHistory = (char **)calloc(sizeof(char*), len);
/* If we can't copy everything, free the elements we'll not use. */
if (len < tocopy) {
int j;
for (j = 0; j < tocopy-len; j++) free(history[j]);
tocopy = len;
}
memcpy(newHistory,history+(history_len-tocopy), sizeof(char*)*tocopy);
free(history);
history = newHistory;
}
history_max_len = len;
if (history_len > history_max_len)
history_len = history_max_len;
return 1;
}
/* Save the history in the specified file. On success 0 is returned
* otherwise -1 is returned. */
int linenoiseHistorySave(const char *filename) {
FILE *fp = fopen(filename,"w");
int j;
if (fp == NULL) return -1;
for (j = 0; j < history_len; j++) {
const char *str = history[j];
/* Need to encode backslash, nl and cr */
while (*str) {
if (*str == '\\') {
fputs("\\\\", fp);
}
else if (*str == '\n') {
fputs("\\n", fp);
}
else if (*str == '\r') {
fputs("\\r", fp);
}
else {
fputc(*str, fp);
}
str++;
}
fputc('\n', fp);
}
fclose(fp);
return 0;
}
/* Load the history from the specified file.
*
* If the file does not exist or can't be opened, no operation is performed
* and -1 is returned.
* Otherwise 0 is returned.
*/
int linenoiseHistoryLoad(const char *filename) {
FILE *fp = fopen(filename,"r");
stringbuf *sb;
if (fp == NULL) return -1;
while ((sb = sb_getline(fp)) != NULL) {
/* Take the stringbuf and decode backslash escaped values */
char *buf = sb_to_string(sb);
char *dest = buf;
const char *src;
for (src = buf; *src; src++) {
char ch = *src;
if (ch == '\\') {
src++;
if (*src == 'n') {
ch = '\n';
}
else if (*src == 'r') {
ch = '\r';
} else {
ch = *src;
}
}
*dest++ = ch;
}
*dest = 0;
linenoiseHistoryAddAllocated(buf);
}
fclose(fp);
return 0;
}
/* Provide access to the history buffer.
*
* If 'len' is not NULL, the length is stored in *len.
*/
char **linenoiseHistory(int *len) {
if (len) {
*len = history_len;
}
return history;
}
|