djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lib/mp-readline: Refactor to support coroutine/event-driven usage.

Browse Source 
readline_process_char() can be fed character by character, for example,
received from external event loop. This will allow to integrate MicroPython
into cooperative multitasking systems.
This commit is contained in:
Paul Sokolovsky 2015-01-12 04:36:57 +02:00
parent 708574b082
commit 3f9f9cac75
2 changed files with 200 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

362
lib/mp-readline/readline.c
View File

@ -57,190 +57,220 @@ STATIC char *str_dup_maybe(const char *str) {
return s2; return s2;
} }
int readline(vstr_t *line, const char *prompt) { typedef struct _readline_t {
stdout_tx_str(prompt); vstr_t *line;
int orig_line_len = line->len; int orig_line_len;
int escape_seq = ESEQ_NONE; int escape_seq;
char escape_seq_buf[1] = {0}; int hist_cur;
int hist_cur = -1; int cursor_pos;
int cursor_pos = orig_line_len; char escape_seq_buf[1];
for (;;) { } readline_t;
int c = stdin_rx_chr();
int last_line_len = line->len; readline_t rl;
int redraw_step_back = 0;
bool redraw_from_cursor = false; int readline_process_char(int c) {
int redraw_step_forward = 0; int last_line_len = rl.line->len;
if (escape_seq == ESEQ_NONE) { int redraw_step_back = 0;
if (CHAR_CTRL_A <= c && c <= CHAR_CTRL_D && vstr_len(line) == orig_line_len) { bool redraw_from_cursor = false;
// control character with empty line int redraw_step_forward = 0;
return c; if (rl.escape_seq == ESEQ_NONE) {
} else if (c == CHAR_CTRL_A) { if (CHAR_CTRL_A <= c && c <= CHAR_CTRL_D && vstr_len(rl.line) == rl.orig_line_len) {
// CTRL-A with non-empty line is go-to-start-of-line // control character with empty line
goto home_key; return c;
} else if (c == CHAR_CTRL_C) { } else if (c == CHAR_CTRL_A) {
// CTRL-C with non-empty line is cancel // CTRL-A with non-empty line is go-to-start-of-line
return c; goto home_key;
} else if (c == CHAR_CTRL_E) { } else if (c == CHAR_CTRL_C) {
// CTRL-E is go-to-end-of-line // CTRL-C with non-empty line is cancel
goto end_key; return c;
} else if (c == '\r') { } else if (c == CHAR_CTRL_E) {
// newline // CTRL-E is go-to-end-of-line
stdout_tx_str("\r\n"); goto end_key;
if (line->len > orig_line_len && (MP_STATE_PORT(readline_hist)[0] == NULL || strcmp(MP_STATE_PORT(readline_hist)[0], line->buf + orig_line_len) != 0)) { } else if (c == '\r') {
// a line which is not empty and different from the last one // newline
// so update the history stdout_tx_str("\r\n");
char *most_recent_hist = str_dup_maybe(line->buf + orig_line_len); if (rl.line->len > rl.orig_line_len && (MP_STATE_PORT(readline_hist)[0] == NULL || strcmp(MP_STATE_PORT(readline_hist)[0], rl.line->buf + rl.orig_line_len) != 0)) {
if (most_recent_hist != NULL) { // a line which is not empty and different from the last one
for (int i = READLINE_HIST_SIZE - 1; i > 0; i--) { // so update the history
MP_STATE_PORT(readline_hist)[i] = MP_STATE_PORT(readline_hist)[i - 1]; char *most_recent_hist = str_dup_maybe(rl.line->buf + rl.orig_line_len);
} if (most_recent_hist != NULL) {
MP_STATE_PORT(readline_hist)[0] = most_recent_hist; for (int i = READLINE_HIST_SIZE - 1; i > 0; i--) {
MP_STATE_PORT(readline_hist)[i] = MP_STATE_PORT(readline_hist)[i - 1];
} }
MP_STATE_PORT(readline_hist)[0] = most_recent_hist;
} }
return 0; }
} else if (c == 27) { return 0;
// escape sequence } else if (c == 27) {
escape_seq = ESEQ_ESC; // escape sequence
} else if (c == 8 || c == 127) { rl.escape_seq = ESEQ_ESC;
// backspace/delete } else if (c == 8 || c == 127) {
if (cursor_pos > orig_line_len) { // backspace/delete
vstr_cut_out_bytes(line, cursor_pos - 1, 1); if (rl.cursor_pos > rl.orig_line_len) {
// set redraw parameters vstr_cut_out_bytes(rl.line, rl.cursor_pos - 1, 1);
redraw_step_back = 1;
redraw_from_cursor = true;
}
} else if (32 <= c && c <= 126) {
// printable character
vstr_ins_char(line, cursor_pos, c);
// set redraw parameters // set redraw parameters
redraw_step_back = 1;
redraw_from_cursor = true; redraw_from_cursor = true;
redraw_step_forward = 1;
} }
} else if (escape_seq == ESEQ_ESC) { } else if (32 <= c && c <= 126) {
switch (c) { // printable character
case '[': vstr_ins_char(rl.line, rl.cursor_pos, c);
escape_seq = ESEQ_ESC_BRACKET; // set redraw parameters
break; redraw_from_cursor = true;
case 'O': redraw_step_forward = 1;
escape_seq = ESEQ_ESC_O; }
break; } else if (rl.escape_seq == ESEQ_ESC) {
default: switch (c) {
DEBUG_printf("(ESC %d)", c); case '[':
escape_seq = ESEQ_NONE; rl.escape_seq = ESEQ_ESC_BRACKET;
} break;
} else if (escape_seq == ESEQ_ESC_BRACKET) { case 'O':
if ('0' <= c && c <= '9') { rl.escape_seq = ESEQ_ESC_O;
escape_seq = ESEQ_ESC_BRACKET_DIGIT; break;
escape_seq_buf[0] = c; default:
} else { DEBUG_printf("(ESC %d)", c);
escape_seq = ESEQ_NONE; rl.escape_seq = ESEQ_NONE;
if (c == 'A') { }
// up arrow } else if (rl.escape_seq == ESEQ_ESC_BRACKET) {
if (hist_cur + 1 < READLINE_HIST_SIZE && MP_STATE_PORT(readline_hist)[hist_cur + 1] != NULL) { if ('0' <= c && c <= '9') {
// increase hist num rl.escape_seq = ESEQ_ESC_BRACKET_DIGIT;
hist_cur += 1; rl.escape_seq_buf[0] = c;
// set line to history } else {
line->len = orig_line_len; rl.escape_seq = ESEQ_NONE;
vstr_add_str(line, MP_STATE_PORT(readline_hist)[hist_cur]); if (c == 'A') {
// set redraw parameters // up arrow
redraw_step_back = cursor_pos - orig_line_len; if (rl.hist_cur + 1 < READLINE_HIST_SIZE && MP_STATE_PORT(readline_hist)[rl.hist_cur + 1] != NULL) {
redraw_from_cursor = true; // increase hist num
redraw_step_forward = line->len - orig_line_len; rl.hist_cur += 1;
} // set line to history
} else if (c == 'B') { rl.line->len = rl.orig_line_len;
// down arrow vstr_add_str(rl.line, MP_STATE_PORT(readline_hist)[rl.hist_cur]);
if (hist_cur >= 0) { // set redraw parameters
// decrease hist num redraw_step_back = rl.cursor_pos - rl.orig_line_len;
hist_cur -= 1; redraw_from_cursor = true;
// set line to history redraw_step_forward = rl.line->len - rl.orig_line_len;
vstr_cut_tail_bytes(line, line->len - orig_line_len);
if (hist_cur >= 0) {
vstr_add_str(line, MP_STATE_PORT(readline_hist)[hist_cur]);
}
// set redraw parameters
redraw_step_back = cursor_pos - orig_line_len;
redraw_from_cursor = true;
redraw_step_forward = line->len - orig_line_len;
}
} else if (c == 'C') {
// right arrow
if (cursor_pos < line->len) {
redraw_step_forward = 1;
}
} else if (c == 'D') {
// left arrow
if (cursor_pos > orig_line_len) {
redraw_step_back = 1;
}
} else if (c == 'H') {
// home
goto home_key;
} else if (c == 'F') {
// end
goto end_key;
} else {
DEBUG_printf("(ESC [ %d)", c);
} }
} else if (c == 'B') {
// down arrow
if (rl.hist_cur >= 0) {
// decrease hist num
rl.hist_cur -= 1;
// set line to history
vstr_cut_tail_bytes(rl.line, rl.line->len - rl.orig_line_len);
if (rl.hist_cur >= 0) {
vstr_add_str(rl.line, MP_STATE_PORT(readline_hist)[rl.hist_cur]);
}
// set redraw parameters
redraw_step_back = rl.cursor_pos - rl.orig_line_len;
redraw_from_cursor = true;
redraw_step_forward = rl.line->len - rl.orig_line_len;
}
} else if (c == 'C') {
// right arrow
if (rl.cursor_pos < rl.line->len) {
redraw_step_forward = 1;
}
} else if (c == 'D') {
// left arrow
if (rl.cursor_pos > rl.orig_line_len) {
redraw_step_back = 1;
}
} else if (c == 'H') {
// home
goto home_key;
} else if (c == 'F') {
// end
goto end_key;
} else {
DEBUG_printf("(ESC [ %d)", c);
} }
} else if (escape_seq == ESEQ_ESC_BRACKET_DIGIT) { }
if (c == '~') { } else if (rl.escape_seq == ESEQ_ESC_BRACKET_DIGIT) {
if (escape_seq_buf[0] == '1' || escape_seq_buf[0] == '7') { if (c == '~') {
if (rl.escape_seq_buf[0] == '1' || rl.escape_seq_buf[0] == '7') {
home_key: home_key:
redraw_step_back = cursor_pos - orig_line_len; redraw_step_back = rl.cursor_pos - rl.orig_line_len;
} else if (escape_seq_buf[0] == '4' || escape_seq_buf[0] == '8') { } else if (rl.escape_seq_buf[0] == '4' || rl.escape_seq_buf[0] == '8') {
end_key: end_key:
redraw_step_forward = line->len - cursor_pos; redraw_step_forward = rl.line->len - rl.cursor_pos;
} else {
DEBUG_printf("(ESC [ %c %d)", escape_seq_buf[0], c);
}
} else { } else {
DEBUG_printf("(ESC [ %c %d)", escape_seq_buf[0], c); DEBUG_printf("(ESC [ %c %d)", rl.escape_seq_buf[0], c);
}
escape_seq = ESEQ_NONE;
} else if (escape_seq == ESEQ_ESC_O) {
switch (c) {
case 'H':
goto home_key;
case 'F':
goto end_key;
default:
DEBUG_printf("(ESC O %d)", c);
escape_seq = ESEQ_NONE;
} }
} else { } else {
escape_seq = ESEQ_NONE; DEBUG_printf("(ESC [ %c %d)", rl.escape_seq_buf[0], c);
} }
rl.escape_seq = ESEQ_NONE;
} else if (rl.escape_seq == ESEQ_ESC_O) {
switch (c) {
case 'H':
goto home_key;
case 'F':
goto end_key;
default:
DEBUG_printf("(ESC O %d)", c);
rl.escape_seq = ESEQ_NONE;
}
} else {
rl.escape_seq = ESEQ_NONE;
}
// redraw command prompt, efficiently // redraw command prompt, efficiently
// TODO we can probably use some more sophisticated VT100 commands here // TODO we can probably use some more sophisticated VT100 commands here
if (redraw_step_back > 0) { if (redraw_step_back > 0) {
for (int i = 0; i < redraw_step_back; i++) { for (int i = 0; i < redraw_step_back; i++) {
stdout_tx_str("\b"); stdout_tx_str("\b");
}
cursor_pos -= redraw_step_back;
} }
if (redraw_from_cursor) { rl.cursor_pos -= redraw_step_back;
if (line->len < last_line_len) { }
// erase old chars if (redraw_from_cursor) {
for (int i = cursor_pos; i < last_line_len; i++) { if (rl.line->len < last_line_len) {
stdout_tx_str(" "); // erase old chars
} for (int i = rl.cursor_pos; i < last_line_len; i++) {
// step back stdout_tx_str(" ");
for (int i = cursor_pos; i < last_line_len; i++) {
stdout_tx_str("\b");
}
} }
// draw new chars // step back
stdout_tx_strn(line->buf + cursor_pos, line->len - cursor_pos); for (int i = rl.cursor_pos; i < last_line_len; i++) {
// move cursor forward if needed (already moved forward by length of line, so move it back)
for (int i = cursor_pos + redraw_step_forward; i < line->len; i++) {
stdout_tx_str("\b"); stdout_tx_str("\b");
} }
cursor_pos += redraw_step_forward; }
} else if (redraw_step_forward > 0) { // draw new chars
// draw over old chars to move cursor forwards stdout_tx_strn(rl.line->buf + rl.cursor_pos, rl.line->len - rl.cursor_pos);
stdout_tx_strn(line->buf + cursor_pos, redraw_step_forward); // move cursor forward if needed (already moved forward by length of line, so move it back)
cursor_pos += redraw_step_forward; for (int i = rl.cursor_pos + redraw_step_forward; i < rl.line->len; i++) {
stdout_tx_str("\b");
}
rl.cursor_pos += redraw_step_forward;
} else if (redraw_step_forward > 0) {
// draw over old chars to move cursor forwards
stdout_tx_strn(rl.line->buf + rl.cursor_pos, redraw_step_forward);
rl.cursor_pos += redraw_step_forward;
}
return -1;
}
void readline_note_newline() {
rl.orig_line_len = rl.line->len;
rl.cursor_pos = rl.orig_line_len;
}
void readline_init(vstr_t *line) {
rl.line = line;
rl.orig_line_len = line->len;
rl.escape_seq = ESEQ_NONE;
rl.escape_seq_buf[0] = 0;
rl.hist_cur = -1;
rl.cursor_pos = rl.orig_line_len;
}
int readline(vstr_t *line, const char *prompt) {
stdout_tx_str(prompt);
readline_init(line);
for (;;) {
int c = stdin_rx_chr();
int r = readline_process_char(c);
if (r >= 0) {
return r;
} }
} }
} }

4
lib/mp-readline/readline.h
View File

@ -32,3 +32,7 @@
void readline_init0(void); void readline_init0(void);
int readline(vstr_t *line, const char *prompt); int readline(vstr_t *line, const char *prompt);
void readline_init(vstr_t *line);
void readline_note_newline();
int readline_process_char(int c);