diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt index eb6136312..4586ef6aa 100644 --- a/library/CMakeLists.txt +++ b/library/CMakeLists.txt @@ -7,6 +7,7 @@ OPTION(BUILD_DOXYGEN "Create/install/package doxygen documentation for DFHack (F include_directories (include) include_directories (depends/md5) +include_directories (depends/libnoise) include_directories (depends/tinyxml) include_directories (private) @@ -87,12 +88,14 @@ SET(PROJECT_SRCS_LINUX FakeSDL-linux.cpp Console-linux.cpp Process-linux.cpp +depends/libnoise/linenoise.cpp ) SET(PROJECT_SRCS_WINDOWS FakeSDL-windows.cpp Console-windows.cpp Process-windows.cpp +depends/libnoise/linenoise_win32.cpp ) IF(UNIX) diff --git a/library/Console-linux.cpp b/library/Console-linux.cpp index b47e1274c..4313d4d8e 100644 --- a/library/Console-linux.cpp +++ b/library/Console-linux.cpp @@ -26,6 +26,7 @@ distribution. #include #include #include +#include using namespace DFHack; duthomhas::stdiostream dfout; diff --git a/library/Core.cpp b/library/Core.cpp index 444f95027..ea8d26084 100644 --- a/library/Core.cpp +++ b/library/Core.cpp @@ -45,9 +45,11 @@ using namespace std; #include "dfhack/modules/Gui.h" #include "dfhack/SDL_fakes/events.h" +#include "linenoise.h" #include #include +#include using namespace DFHack; struct Core::Cond @@ -132,8 +134,16 @@ int fIOthread(void * iodata) while (true) { string command = ""; - dfout <<"[DFHack]# "; - getline(cin, command); + //dfout <<"[DFHack]# "; + char * line = linenoise("[DFHack]# ", dfout_C); + // dfout <<"[DFHack]# "; + if(line) + { + command=line; + linenoiseHistoryAdd(line); + free(line); + } + //getline(cin, command); if (cin.eof()) { command = "q"; @@ -146,6 +156,8 @@ int fIOthread(void * iodata) for(int i = 0; i < plug_mgr->size();i++) { const Plugin * plug = (plug_mgr->operator[](i)); + if(!plug->size()) + continue; dfout << "Plugin " << plug->getName() << " :" << std::endl; for (int j = 0; j < plug->size();j++) { @@ -339,6 +351,7 @@ int Core::Update() return 0; }; +// FIXME: needs to terminate the IO threads and properly dismantle all the machinery involved. int Core::Shutdown ( void ) { errorstate = 1; diff --git a/library/depends/libnoise/Makefile b/library/depends/libnoise/Makefile new file mode 100644 index 000000000..0f54158fc --- /dev/null +++ b/library/depends/libnoise/Makefile @@ -0,0 +1,10 @@ +linenoise_example: linenoise.h linenoise.c + +linenoise_example: linenoise.c example.c + $(CC) -Wall -W -Os -g -o linenoise_example linenoise.c example.c + +test_cpp_compile: linenoise.h linenoise.c + g++ -Wall -W -Os -g -c -o linenoise.o linenoise.c + +clean: + rm -f linenoise_example diff --git a/library/depends/libnoise/README.markdown b/library/depends/libnoise/README.markdown new file mode 100644 index 000000000..6c693ed0b --- /dev/null +++ b/library/depends/libnoise/README.markdown @@ -0,0 +1,47 @@ +# Linenoise + +A minimal, zero-config, BSD licensed, readline replacement. + +News: linenoise now includes minimal completion support, thanks to Pieter Noordhuis (@pnoordhuis). + +News: linenoise is now part of [Android](http://android.git.kernel.org/?p=platform/system/core.git;a=tree;f=liblinenoise;h=56450eaed7f783760e5e6a5993ef75cde2e29dea;hb=HEAD Android)! + +## Can a line editing library be 20k lines of code? + +Line editing with some support for history is a really important feature for command line utilities. Instead of retyping almost the same stuff again and again it's just much better to hit the up arrow and edit on syntax errors, or in order to try a slightly different command. But apparently code dealing with terminals is some sort of Black Magic: readline is 30k lines of code, libedit 20k. Is it reasonable to link small utilities to huge libraries just to get a minimal support for line editing? + +So what usually happens is either: + + * Large programs with configure scripts disabling line editing if readline is not present in the system, or not supporting it at all since readline is GPL licensed and libedit (the BSD clone) is not as known and available as readline is (Readl world example of this problem: Tclsh). + * Smaller programs not using a configure script not supporting line editing at all (A problem we had with Redis-cli for instance). + +The result is a pollution of binaries without line editing support. + +So I spent more or less two hours doing a reality check resulting in this little library: is it *really* needed for a line editing library to be 20k lines of code? Apparently not, it is possibe to get a very small, zero configuration, trivial to embed library, that solves the problem. Smaller programs will just include this, supporing line editing out of the box. Larger programs may use this little library or just checking with configure if readline/libedit is available and resorting to linenoise if not. + +## Terminals, in 2010. + +Apparently almost every terminal you can happen to use today has some kind of support for VT100 alike escape sequences. So I tried to write a lib using just very basic VT100 features. The resulting library appears to work everywhere I tried to use it. + +Since it's so young I guess there are a few bugs, or the lib may not compile or work with some operating system, but it's a matter of a few weeks and eventually we'll get it right, and there will be no excuses for not shipping command line tools without built-in line editing support. + +The library is currently less than 400 lines of code. In order to use it in your project just look at the *example.c* file in the source distribution, it is trivial. Linenoise is BSD code, so you can use both in free software and commercial software. + +## Tested with... + + * Linux text only console ($TERM = linux) + * Linux KDE terminal application ($TERM = xterm) + * Linux xterm ($TERM = xterm) + * Mac OS X iTerm ($TERM = xterm) + * Mac OS X default Terminal.app ($TERM = xterm) + * OpenBSD 4.5 through an OSX Terminal.app ($TERM = screen) + * IBM AIX 6.1 + * FreeBSD xterm ($TERM = xterm) + +Please test it everywhere you can and report back! + +## Let's push this forward! + +Please fork it and add something interesting and send me a pull request. What's especially interesting are fixes, new key bindings, completion. + +Send feedbacks to antirez at gmail diff --git a/library/depends/libnoise/example.c b/library/depends/libnoise/example.c new file mode 100644 index 000000000..ea0b515c1 --- /dev/null +++ b/library/depends/libnoise/example.c @@ -0,0 +1,27 @@ +#include +#include +#include "linenoise.h" + + +void completion(const char *buf, linenoiseCompletions *lc) { + if (buf[0] == 'h') { + linenoiseAddCompletion(lc,"hello"); + linenoiseAddCompletion(lc,"hello there"); + } +} + +int main(void) { + char *line; + + linenoiseSetCompletionCallback(completion); + linenoiseHistoryLoad("history.txt"); /* Load the history at startup */ + while((line = linenoise("hello> ")) != NULL) { + if (line[0] != '\0') { + printf("echo: '%s'\n", line); + linenoiseHistoryAdd(line); + linenoiseHistorySave("history.txt"); /* Save every new entry */ + } + free(line); + } + return 0; +} diff --git a/library/depends/libnoise/linenoise.cpp b/library/depends/libnoise/linenoise.cpp new file mode 100644 index 000000000..863590f53 --- /dev/null +++ b/library/depends/libnoise/linenoise.cpp @@ -0,0 +1,653 @@ +/* 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/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 + * Copyright (c) 2010, Pieter Noordhuis + * + * 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 + * + * Todo list: + * - Switch to gets() if $TERM is something we can't support. + * - Filter bogus Ctrl+ combinations. + * - Win32 support + * + * Bloat: + * - Completion? + * - History search like Ctrl+r in readline? + * + * List of escape sequences used by this program, we do everything just + * with three sequences. In order to be so cheap we may have some + * flickering effect with some slow terminal, but the lesser sequences + * the more compatible. + * + * CHA (Cursor Horizontal Absolute) + * Sequence: ESC [ n G + * Effect: moves cursor to column n (1 based) + * + * EL (Erase Line) + * Sequence: ESC [ n K + * Effect: if n is 0 or missing, clear from cursor to end of line + * Effect: if n is 1, clear from beginning of line to cursor + * Effect: if n is 2, clear entire line + * + * CUF (CUrsor Forward) + * Sequence: ESC [ n C + * Effect: moves cursor forward of n chars + * + * 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 + * + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "linenoise.h" + +#define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100 +#define LINENOISE_MAX_LINE 4096 +static const char *unsupported_term[] = {"dumb","cons25",NULL}; +static linenoiseCompletionCallback *completionCallback = NULL; + +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 int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN; +static int history_len = 0; +char **history = NULL; + +static void linenoiseAtExit(void); +int linenoiseHistoryAdd(const char *line); + +static int isUnsupportedTerm(void) { + char *term = getenv("TERM"); + int j; + + if (term == NULL) return 0; + for (j = 0; unsupported_term[j]; j++) + if (!strcasecmp(term,unsupported_term[j])) return 1; + return 0; +} + +static void freeHistory(void) { + if (history) { + int j; + + for (j = 0; j < history_len; j++) + free(history[j]); + free(history); + } +} + +static int enableRawMode(int fd) { + struct termios raw; + + if (!isatty(STDIN_FILENO)) goto fatal; + if (!atexit_registered) { + atexit(linenoiseAtExit); + atexit_registered = 1; + } + if (tcgetattr(fd,&orig_termios) == -1) goto fatal; + + 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 - 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(fd,TCSAFLUSH,&raw) < 0) goto fatal; + rawmode = 1; + return 0; + +fatal: + errno = ENOTTY; + return -1; +} + +static void disableRawMode(int fd) { + /* Don't even check the return value as it's too late. */ + if (rawmode && tcsetattr(fd,TCSAFLUSH,&orig_termios) != -1) + rawmode = 0; +} + +/* At exit we'll try to fix the terminal to the initial conditions. */ +static void linenoiseAtExit(void) { + disableRawMode(STDIN_FILENO); + freeHistory(); +} + +static int getColumns(void) { + struct winsize ws; + + if (ioctl(1, TIOCGWINSZ, &ws) == -1) return 80; + return ws.ws_col; +} + +static void refreshLine(int fd, const char *prompt, char *buf, size_t len, size_t pos, size_t cols) { + char seq[64]; + size_t plen = strlen(prompt); + + while((plen+pos) >= cols) { + buf++; + len--; + pos--; + } + while (plen+len > cols) { + len--; + } + + /* Cursor to left edge */ + snprintf(seq,64,"\x1b[1G"); + if (write(fd,seq,strlen(seq)) == -1) return; + /* Write the prompt and the current buffer content */ + if (write(fd,prompt,strlen(prompt)) == -1) return; + if (write(fd,buf,len) == -1) return; + /* Erase to right */ + snprintf(seq,64,"\x1b[0K"); + if (write(fd,seq,strlen(seq)) == -1) return; + /* Move cursor to original position. */ + snprintf(seq,64,"\x1b[1G\x1b[%dC", (int)(pos+plen)); + if (write(fd,seq,strlen(seq)) == -1) return; +} + +static void beep() { + fprintf(stderr, "\x7"); + fflush(stderr); +} + +static void freeCompletions(linenoiseCompletions *lc) { + size_t i; + for (i = 0; i < lc->len; i++) + free(lc->cvec[i]); + if (lc->cvec != NULL) + free(lc->cvec); +} + +static int completeLine(int fd, const char *prompt, char *buf, size_t buflen, size_t *len, size_t *pos, size_t cols) { + linenoiseCompletions lc = { 0, NULL }; + int nread, nwritten; + char c = 0; + + completionCallback(buf,&lc); + if (lc.len == 0) { + beep(); + } else { + size_t stop = 0, i = 0; + size_t clen; + + while(!stop) { + /* Show completion or original buffer */ + if (i < lc.len) { + clen = strlen(lc.cvec[i]); + refreshLine(fd,prompt,lc.cvec[i],clen,clen,cols); + } else { + refreshLine(fd,prompt,buf,*len,*pos,cols); + } + + nread = read(fd,&c,1); + if (nread <= 0) { + freeCompletions(&lc); + return -1; + } + + switch(c) { + case 9: /* tab */ + i = (i+1) % (lc.len+1); + if (i == lc.len) beep(); + break; + case 27: /* escape */ + /* Re-show original buffer */ + if (i < lc.len) { + refreshLine(fd,prompt,buf,*len,*pos,cols); + } + stop = 1; + break; + default: + /* Update buffer and return */ + if (i < lc.len) { + nwritten = snprintf(buf,buflen,"%s",lc.cvec[i]); + *len = *pos = nwritten; + } + stop = 1; + break; + } + } + } + + freeCompletions(&lc); + return c; /* Return last read character */ +} + +void linenoiseClearScreen(void) { + if (write(STDIN_FILENO,"\x1b[H\x1b[2J",7) <= 0) { + /* nothing to do, just to avoid warning. */ + } +} + +static int linenoisePrompt(int fd, char *buf, size_t buflen, const char *prompt) { + size_t plen = strlen(prompt); + size_t pos = 0; + size_t len = 0; + size_t cols = getColumns(); + int history_index = 0; + + buf[0] = '\0'; + buflen--; /* Make sure there is always space for the nulterm */ + + /* The latest history entry is always our current buffer, that + * initially is just an empty string. */ + linenoiseHistoryAdd(""); + + if (write(fd,prompt,plen) == -1) return -1; + while(1) { + char c; + int nread; + char seq[2], seq2[2]; + + nread = read(fd,&c,1); + if (nread <= 0) return len; + + /* 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 == 9) + { + if( completionCallback != NULL) { + c = completeLine(fd,prompt,buf,buflen,&len,&pos,cols); + /* Return on errors */ + if (c < 0) return len; + /* Read next character when 0 */ + if (c == 0) continue; + } + else + { + // ignore tab + continue; + } + } + + switch(c) { + case 13: /* enter */ + history_len--; + free(history[history_len]); + return (int)len; + case 3: /* ctrl-c */ + errno = EAGAIN; + return -1; + case 127: /* backspace */ + case 8: /* ctrl-h */ + if (pos > 0 && len > 0) { + memmove(buf+pos-1,buf+pos,len-pos); + pos--; + len--; + buf[len] = '\0'; + refreshLine(fd,prompt,buf,len,pos,cols); + } + break; + case 4: /* ctrl-d, remove char at right of cursor */ + if (len > 1 && pos < (len-1)) { + memmove(buf+pos,buf+pos+1,len-pos); + len--; + buf[len] = '\0'; + refreshLine(fd,prompt,buf,len,pos,cols); + } else if (len == 0) { + history_len--; + free(history[history_len]); + return -1; + } + break; + case 20: /* ctrl-t */ + if (pos > 0 && pos < len) { + int aux = buf[pos-1]; + buf[pos-1] = buf[pos]; + buf[pos] = aux; + if (pos != len-1) pos++; + refreshLine(fd,prompt,buf,len,pos,cols); + } + break; + case 2: /* ctrl-b */ + goto left_arrow; + case 6: /* ctrl-f */ + goto right_arrow; + case 16: /* ctrl-p */ + seq[1] = 65; + goto up_down_arrow; + case 14: /* ctrl-n */ + seq[1] = 66; + goto up_down_arrow; + break; + case 27: /* escape sequence */ + if (read(fd,seq,2) == -1) break; + if(seq[0] == '[') + { + if (seq[1] == 'D') + { + left_arrow: + if (pos > 0) { + pos--; + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + else if ( seq[1] == 'C') + { + right_arrow: + /* right arrow */ + if (pos != len) + { + pos++; + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + else if (seq[1] == 'A' || seq[1] == 'B') + { + up_down_arrow: + /* up and down arrow: history */ + 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(buf); + /* Show the new entry */ + history_index += (seq[1] == 65) ? 1 : -1; + if (history_index < 0) + { + history_index = 0; + break; + } + else if (history_index >= history_len) + { + history_index = history_len-1; + break; + } + strncpy(buf,history[history_len-1-history_index],buflen); + buf[buflen] = '\0'; + len = pos = strlen(buf); + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + else if(seq[1] == 'H') // home + { + pos = 0; + refreshLine(fd,prompt, buf, len, pos, cols); + } + else if(seq[1] == 'F') // end + { + pos = len; + refreshLine(fd,prompt, buf, len, pos, cols); + } + else if (seq[1] > '0' && seq[1] < '7') + { + /* extended escape */ + if (read(fd,seq2,2) == -1) break; + if (seq2[0] == '~' && seq[1] == '3') + { + /* delete */ + if (len > 0 && pos < len) + { + memmove(buf+pos,buf+pos+1,len-pos-1); + len--; + buf[len] = '\0'; + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + } + } + break; + default: + if (len < buflen) + { + if (len == pos) + { + buf[pos] = c; + pos++; + len++; + buf[len] = '\0'; + if (plen+len < cols) + { + /* Avoid a full update of the line in the + * trivial case. */ + if (write(fd,&c,1) == -1) return -1; + } + else + { + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + else + { + memmove(buf+pos+1,buf+pos,len-pos); + buf[pos] = c; + len++; + pos++; + buf[len] = '\0'; + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + break; + case 21: /* Ctrl+u, delete the whole line. */ + buf[0] = '\0'; + pos = len = 0; + refreshLine(fd,prompt,buf,len,pos,cols); + break; + case 11: /* Ctrl+k, delete from current to end of line. */ + buf[pos] = '\0'; + len = pos; + refreshLine(fd,prompt,buf,len,pos,cols); + break; + case 1: /* Ctrl+a, go to the start of the line */ + pos = 0; + refreshLine(fd,prompt,buf,len,pos,cols); + break; + case 5: /* ctrl+e, go to the end of the line */ + pos = len; + refreshLine(fd,prompt,buf,len,pos,cols); + break; + case 12: /* ctrl+l, clear screen */ + linenoiseClearScreen(); + refreshLine(fd,prompt,buf,len,pos,cols); + } + } + return len; +} + +static int linenoiseRaw(char *buf, size_t buflen, const char *prompt, FILE * out) { + int fd = STDIN_FILENO; + int count; + + if (buflen == 0) { + errno = EINVAL; + return -1; + } + if (!isatty(STDIN_FILENO)) { + if (fgets(buf, buflen, stdin) == NULL) return -1; + count = strlen(buf); + if (count && buf[count-1] == '\n') { + count--; + buf[count] = '\0'; + } + } else { + if (enableRawMode(fd) == -1) return -1; + count = linenoisePrompt(fd, buf, buflen, prompt); + disableRawMode(fd); + fprintf(out,"\n"); + } + return count; +} + +char *linenoise(const char *prompt, FILE * out) { + char buf[LINENOISE_MAX_LINE]; + int count; + + if (isUnsupportedTerm()) { + size_t len; + + fprintf(out, "%s",prompt); + fflush(out); + if (fgets(buf,LINENOISE_MAX_LINE,stdin) == NULL) return NULL; + len = strlen(buf); + while(len && (buf[len-1] == '\n' || buf[len-1] == '\r')) { + len--; + buf[len] = '\0'; + } + return strdup(buf); + } else { + count = linenoiseRaw(buf,LINENOISE_MAX_LINE,prompt, out); + if (count == -1) return NULL; + return strdup(buf); + } +} + +/* Register a callback function to be called for tab-completion. */ +void linenoiseSetCompletionCallback(linenoiseCompletionCallback *fn) { + completionCallback = fn; +} + +void linenoiseAddCompletion(linenoiseCompletions *lc, const char *str) { + size_t len = strlen(str); + char *copy = (char*)malloc(len+1); + memcpy(copy,str,len+1); + lc->cvec = (char**)realloc(lc->cvec,sizeof(char*)*(lc->len+1)); + lc->cvec[lc->len++] = copy; +} + +/* Using a circular buffer is smarter, but a bit more complex to handle. */ +int linenoiseHistoryAdd(const char *line) { + char *linecopy; + + if (history_max_len == 0) return 0; + if (history == NULL) { + history = (char**)malloc(sizeof(char*)*history_max_len); + if (history == NULL) return 0; + memset(history,0,(sizeof(char*)*history_max_len)); + } + linecopy = strdup(line); + if (!linecopy) return 0; + if (history_len == history_max_len) { + free(history[0]); + memmove(history,history+1,sizeof(char*)*(history_max_len-1)); + history_len--; + } + history[history_len] = linecopy; + history_len++; + return 1; +} + +int linenoiseHistorySetMaxLen(int len) { + char **newHistory; + + if (len < 1) return 0; + if (history) { + int tocopy = history_len; + + newHistory = (char**)malloc(sizeof(char*)*len); + if (newHistory == NULL) return 0; + if (len < tocopy) tocopy = len; + memcpy(newHistory,history+(history_max_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++) + fprintf(fp,"%s\n",history[j]); + fclose(fp); + return 0; +} + +/* Load the history from the specified file. If the file does not exist + * zero is returned and no operation is performed. + * + * If the file exists and the operation succeeded 0 is returned, otherwise + * on error -1 is returned. */ +int linenoiseHistoryLoad(const char *filename) { + FILE *fp = fopen(filename,"r"); + char buf[LINENOISE_MAX_LINE]; + + if (fp == NULL) return -1; + + while (fgets(buf,LINENOISE_MAX_LINE,fp) != NULL) { + char *p; + + p = strchr(buf,'\r'); + if (!p) p = strchr(buf,'\n'); + if (p) *p = '\0'; + linenoiseHistoryAdd(buf); + } + fclose(fp); + return 0; +} diff --git a/library/depends/libnoise/linenoise.h b/library/depends/libnoise/linenoise.h new file mode 100644 index 000000000..e21763900 --- /dev/null +++ b/library/depends/libnoise/linenoise.h @@ -0,0 +1,54 @@ +/* linenoise.h -- guerrilla line editing library against the idea that a + * line editing lib needs to be 20,000 lines of C code. + * + * See linenoise.c for more information. + * + * ------------------------------------------------------------------------ + * + * Copyright (c) 2010, Salvatore Sanfilippo + * Copyright (c) 2010, Pieter Noordhuis + * + * 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. + */ + +#pragma once +#include + +typedef struct linenoiseCompletions { + size_t len; + char **cvec; +} linenoiseCompletions; + +typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *); +void linenoiseSetCompletionCallback(linenoiseCompletionCallback *); +void linenoiseAddCompletion(linenoiseCompletions *, const char *); + +char *linenoise(const char *prompt, FILE * out = stdout); +int linenoiseHistoryAdd(const char *line); +int linenoiseHistorySetMaxLen(int len); +int linenoiseHistorySave(const char *filename); +int linenoiseHistoryLoad(const char *filename); +void linenoiseClearScreen(void); diff --git a/library/depends/libnoise/linenoise_win32.cpp b/library/depends/libnoise/linenoise_win32.cpp new file mode 100644 index 000000000..316f55a73 --- /dev/null +++ b/library/depends/libnoise/linenoise_win32.cpp @@ -0,0 +1,443 @@ +/* linenoise_win32.c -- Linenoise win32 port. + * + * Modifications copyright 2010, Jon Griffiths . + * All rights reserved. + * Based on linenoise, copyright 2010, Salvatore Sanfilippo . + * The original linenoise can be found at: http://github.com/antirez/linenoise + * + * 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. + * * Neither the name of Redis nor the names of its contributors may be used + * to endorse or promote products derived from this software without + * specific prior written permission. + * + * 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 OWNER 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. + * + * Todo list: + * Actually switch to/from raw mode so emacs key combos work. + * Set a console handler to clean up onn exit. + */ +#include +#include +#include + +/* If ALT_KEYS is defined, emacs key combos using ALT instead of CTRL are + * available. At this time, you don't get key repeats when enabled though. */ +/* #define ALT_KEYS */ + +static HANDLE console_in, console_out; + +#define LINENOISE_DEFAULT_HISTORY_MAX_LEN 100 +#define LINENOISE_MAX_LINE 4096 + +static int history_max_len = LINENOISE_DEFAULT_HISTORY_MAX_LEN; +static int history_len = 0; +char** history = NULL; + +int linenoiseHistoryAdd(const char* line); + +static int enableRawMode() +{ + if (!console_in) + { + console_in = GetStdHandle(STD_INPUT_HANDLE); + console_out = GetStdHandle(STD_OUTPUT_HANDLE); + } + return 0; +} + +static void disableRawMode() +{ + /* Nothing to do yet */ +} + +static void output(const char* str, + size_t len, + int x, + int y) +{ + COORD pos = { (SHORT)x, (SHORT)y }; + DWORD count = 0; + WriteConsoleOutputCharacterA(console_out, str, len, pos, &count); +} + +static void refreshLine(const char* prompt, + char* buf, + size_t len, + size_t pos, + size_t cols) +{ + size_t plen = strlen(prompt); + + while ((plen + pos) >= cols) + { + buf++; + len--; + pos--; + } + while (plen + len > cols) + { + len--; + } + + CONSOLE_SCREEN_BUFFER_INFO inf = { 0 }; + GetConsoleScreenBufferInfo(console_out, &inf); + size_t prompt_len = strlen(prompt); + output(prompt, prompt_len, 0, inf.dwCursorPosition.Y); + output(buf, len, prompt_len, inf.dwCursorPosition.Y); + if (prompt_len + len < (size_t)inf.dwSize.X) + { + /* Blank to EOL */ + char* tmp = (char*)malloc(inf.dwSize.X - (prompt_len + len)); + memset(tmp, ' ', inf.dwSize.X - (prompt_len + len)); + output(tmp, inf.dwSize.X - (prompt_len + len), len + prompt_len, inf.dwCursorPosition.Y); + free(tmp); + } + inf.dwCursorPosition.X = (SHORT)(pos + prompt_len); + SetConsoleCursorPosition(console_out, inf.dwCursorPosition); +} + +static int linenoisePrompt(char* buf, + size_t buflen, + const char* prompt) +{ + size_t plen = strlen(prompt); + size_t pos = 0; + size_t len = 0; + int history_index = 0; +#ifdef ALT_KEYS + unsigned char last_down = 0; +#endif + buf[0] = '\0'; + buflen--; /* Make sure there is always space for the nulterm */ + + /* The latest history entry is always our current buffer, that + * initially is just an empty string. */ + linenoiseHistoryAdd(""); + + CONSOLE_SCREEN_BUFFER_INFO inf = { 0 }; + GetConsoleScreenBufferInfo(console_out, &inf); + size_t cols = inf.dwSize.X; + output(prompt, plen, 0, inf.dwCursorPosition.Y); + inf.dwCursorPosition.X = (SHORT)plen; + SetConsoleCursorPosition(console_out, inf.dwCursorPosition); + + for ( ; ; ) + { + INPUT_RECORD rec; + DWORD count; + ReadConsoleInputA(console_in, &rec, 1, &count); + if (rec.EventType != KEY_EVENT) + continue; +#ifdef ALT_KEYS + if (rec.Event.KeyEvent.bKeyDown) + { + last_down = rec.Event.KeyEvent.uChar.AsciiChar; + continue; + } +#else + if (!rec.Event.KeyEvent.bKeyDown) + { + continue; + } +#endif + switch (rec.Event.KeyEvent.wVirtualKeyCode) + { + case VK_RETURN: /* enter */ + history_len--; + free(history[history_len]); + return (int)len; + case VK_BACK: /* backspace */ +#ifdef ALT_KEYS + backspace: +#endif + if (pos > 0 && len > 0) + { + memmove(buf + pos - 1, buf + pos, len - pos); + pos--; + len--; + buf[len] = '\0'; + refreshLine(prompt, buf, len, pos, cols); + } + break; + case VK_LEFT: +#ifdef ALT_KEYS + left_arrow: +#endif + /* left arrow */ + if (pos > 0) + { + pos--; + refreshLine(prompt, buf, len, pos, cols); + } + break; + case VK_RIGHT: +#ifdef ALT_KEYS + right_arrow: +#endif + /* right arrow */ + if (pos != len) + { + pos++; + refreshLine(prompt, buf, len, pos, cols); + } + break; + case VK_UP: + case VK_DOWN: +#ifdef ALT_KEYS + up_down_arrow: +#endif + /* up and down arrow: history */ + 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(buf); + /* Show the new entry */ + history_index += (rec.Event.KeyEvent.wVirtualKeyCode == VK_UP) ? 1 : -1; + if (history_index < 0) + { + history_index = 0; + break; + } + else if (history_index >= history_len) + { + history_index = history_len - 1; + break; + } + strncpy(buf, history[history_len - 1 - history_index], buflen); + buf[buflen] = '\0'; + len = pos = strlen(buf); + refreshLine(prompt, buf, len, pos, cols); + } + break; + case VK_DELETE: + /* delete */ + if (len > 0 && pos < len) + { + memmove(buf + pos, buf + pos + 1, len - pos - 1); + len--; + buf[len] = '\0'; + refreshLine(prompt, buf, len, pos, cols); + } + break; + case VK_HOME: /* Ctrl+a, go to the start of the line */ +#ifdef ALT_KEYS + home: +#endif + pos = 0; + refreshLine(prompt, buf, len, pos, cols); + break; + case VK_END: /* ctrl+e, go to the end of the line */ +#ifdef ALT_KEYS + end: +#endif + pos = len; + refreshLine(prompt, buf, len, pos, cols); + break; + default: +#ifdef ALT_KEYS + /* Use alt instead of CTRL since windows eats CTRL+char combos */ + if (rec.Event.KeyEvent.dwControlKeyState & (LEFT_ALT_PRESSED | RIGHT_ALT_PRESSED)) + { + switch (last_down) + { + case 'a': /* ctrl-t */ + goto home; + case 'e': /* ctrl-t */ + goto end; + case 't': /* ctrl-t */ + if (pos > 0 && pos < len) + { + int aux = buf[pos - 1]; + buf[pos - 1] = buf[pos]; + buf[pos] = aux; + if (pos != len - 1) + pos++; + refreshLine(prompt, buf, len, pos, cols); + } + break; + case 'h': /* ctrl-h */ + goto backspace; + case 'b': /* ctrl-b */ + goto left_arrow; + case 'f': /* ctrl-f */ + goto right_arrow; + case 'p': /* ctrl-p */ + rec.Event.KeyEvent.wVirtualKeyCode = VK_UP; + goto up_down_arrow; + case 'n': /* ctrl-n */ + rec.Event.KeyEvent.wVirtualKeyCode = VK_DOWN; + goto up_down_arrow; + case 'u': /* Ctrl+u, delete the whole line. */ + buf[0] = '\0'; + pos = len = 0; + refreshLine(prompt, buf, len, pos, cols); + break; + case 'k': /* Ctrl+k, delete from current to end of line. */ + buf[pos] = '\0'; + len = pos; + refreshLine(prompt, buf, len, pos, cols); + break; + } + continue; + } +#endif /* ALT_KEYS */ + if (rec.Event.KeyEvent.uChar.AsciiChar < ' ' || + rec.Event.KeyEvent.uChar.AsciiChar > '~') + continue; + + if (len < buflen) + { + if (len != pos) + memmove(buf + pos + 1, buf + pos, len - pos); + buf[pos] = rec.Event.KeyEvent.uChar.AsciiChar; + len++; + pos++; + buf[len] = '\0'; + refreshLine(prompt, buf, len, pos, cols); + } + break; + } + } +} + +static int linenoiseRaw(char* buf, + size_t buflen, + const char* prompt, + FILE * out ) +{ + int count = -1; + + if (buflen != 0) + { + if (enableRawMode() == -1) + return -1; + count = linenoisePrompt(buf, buflen, prompt); + disableRawMode(); + fprintf(out, "\n"); + } + return count; +} + +char* linenoise(const char* prompt, FILE * out) +{ + char buf[LINENOISE_MAX_LINE]; + int count = linenoiseRaw(buf, LINENOISE_MAX_LINE, prompt, out); + if (count == -1) + return NULL; + return _strdup(buf); +} + +/* Using a circular buffer is smarter, but a bit more complex to handle. */ +int linenoiseHistoryAdd(const char* line) +{ + char* linecopy; + + if (history_max_len == 0) + return 0; + if (history == NULL) + { + history = (char**)malloc(sizeof(char*) * history_max_len); + if (history == NULL) + return 0; + memset(history, 0, (sizeof(char*) * history_max_len)); + } + linecopy = _strdup(line); + if (!linecopy) + return 0; + if (history_len == history_max_len) + { + free(history[0]); + memmove(history, history + 1, sizeof(char*) * (history_max_len - 1)); + history_len--; + } + history[history_len] = linecopy; + history_len++; + return 1; +} + +int linenoiseHistorySetMaxLen(int len) +{ + char** new_history; + + if (len < 1) + return 0; + if (history) + { + int tocopy = history_len; + + new_history = (char**)malloc(sizeof(char*) * len); + if (new_history == NULL) + return 0; + if (len < tocopy) + tocopy = len; + memcpy(new_history, history + (history_max_len - tocopy), sizeof(char*) * tocopy); + free(history); + history = new_history; + } + 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++) + fprintf(fp, "%s\n", history[j]); + fclose(fp); + return 0; +} + +/* Load the history from the specified file. If the file does not exist + * zero is returned and no operation is performed. + * + * If the file exists and the operation succeeded 0 is returned, otherwise + * on error -1 is returned. */ +int linenoiseHistoryLoad(const char* filename) +{ + FILE* fp = fopen(filename, "r"); + char buf[LINENOISE_MAX_LINE]; + + if (fp == NULL) + return -1; + + while (fgets(buf, LINENOISE_MAX_LINE, fp) != NULL) + { + char* p; + + p = strchr(buf, '\r'); + if (!p) + p = strchr(buf, '\n'); + if (p) + *p = '\0'; + linenoiseHistoryAdd(buf); + } + fclose(fp); + return 0; +} diff --git a/plugins/prospector.cpp b/plugins/prospector.cpp index c2c4d614b..639f1900d 100644 --- a/plugins/prospector.cpp +++ b/plugins/prospector.cpp @@ -74,7 +74,7 @@ DFhackCExport const char * plugin_name ( void ) DFhackCExport command_result plugin_init ( Core * c, std::vector &commands) { commands.clear(); - commands.push_back(PluginCommand("prospector","Show stats of available raw resources. Use parameter 'all' to show hidden resources.",prospector)); + commands.push_back(PluginCommand("prospect","Show stats of available raw resources. Use parameter 'all' to show hidden resources.",prospector)); return CR_OK; } diff --git a/plugins/vdig.cpp b/plugins/vdig.cpp index 4720c38bb..934825fbc 100644 --- a/plugins/vdig.cpp +++ b/plugins/vdig.cpp @@ -196,5 +196,5 @@ DFhackCExport command_result vdig (Core * c, vector & parameters) DFhackCExport command_result autodig (Core * c, vector & parameters) { - return CR_OK; + return CR_NOT_IMPLEMENTED; } \ No newline at end of file