readline.c 9.62 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

27
#include <stdio.h>
Dave Hylands's avatar
Dave Hylands committed
28
#include <stdint.h>
29
30
31
#include <string.h>

#include "mpconfig.h"
32
#include "misc.h"
33
34
35
#include "qstr.h"
#include "misc.h"
#include "obj.h"
36
#include MICROPY_HAL_H
37
38
#include "readline.h"
#include "usb.h"
39
40
#include "uart.h"
#include "pybstdio.h"
41

42
43
44
45
46
47
48
#if 0 // print debugging info
#define DEBUG_PRINT (1)
#define DEBUG_printf printf
#else // don't print debugging info
#define DEBUG_printf(...) (void)0
#endif

49
50
51
52
#define READLINE_HIST_SIZE (8)

static const char *readline_hist[READLINE_HIST_SIZE] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};

53
enum { ESEQ_NONE, ESEQ_ESC, ESEQ_ESC_BRACKET, ESEQ_ESC_BRACKET_DIGIT, ESEQ_ESC_O };
54

55
void readline_init0(void) {
56
57
58
    memset(readline_hist, 0, READLINE_HIST_SIZE * sizeof(const char*));
}

59
STATIC char *str_dup_maybe(const char *str) {
60
    uint32_t len = strlen(str);
61
62
63
64
65
    char *s2 = m_new_maybe(char, len + 1);
    if (s2 == NULL) {
        return NULL;
    }
    memcpy(s2, str, len + 1);
66
67
68
69
70
71
    return s2;
}

int readline(vstr_t *line, const char *prompt) {
    stdout_tx_str(prompt);
    int orig_line_len = line->len;
72
    int escape_seq = ESEQ_NONE;
73
    char escape_seq_buf[1] = {0};
74
75
76
77
78
79
80
81
    int hist_cur = -1;
    int cursor_pos = orig_line_len;
    for (;;) {
        int c = stdin_rx_chr();
        int last_line_len = line->len;
        int redraw_step_back = 0;
        bool redraw_from_cursor = false;
        int redraw_step_forward = 0;
82
        if (escape_seq == ESEQ_NONE) {
83
84
85
            if (VCP_CHAR_CTRL_A <= c && c <= VCP_CHAR_CTRL_D && vstr_len(line) == orig_line_len) {
                // control character with empty line
                return c;
86
87
            } else if (c == VCP_CHAR_CTRL_A) {
                // CTRL-A with non-empty line is go-to-start-of-line
88
                goto home_key;
89
90
            } else if (c == VCP_CHAR_CTRL_E) {
                // CTRL-E is go-to-end-of-line
91
                goto end_key;
92
93
94
95
96
97
            } else if (c == '\r') {
                // newline
                stdout_tx_str("\r\n");
                if (line->len > orig_line_len && (readline_hist[0] == NULL || strcmp(readline_hist[0], line->buf + orig_line_len) != 0)) {
                    // a line which is not empty and different from the last one
                    // so update the history
98
99
100
101
102
103
                    char *most_recent_hist = str_dup_maybe(line->buf + orig_line_len);
                    if (most_recent_hist != NULL) {
                        for (int i = READLINE_HIST_SIZE - 1; i > 0; i--) {
                            readline_hist[i] = readline_hist[i - 1];
                        }
                        readline_hist[0] = most_recent_hist;
104
105
106
107
108
                    }
                }
                return 0;
            } else if (c == 27) {
                // escape sequence
109
                escape_seq = ESEQ_ESC;
110
111
            } else if (c == 8 || c == 127) {
                // backspace/delete
112
113
114
115
116
117
118
119
120
121
122
123
124
                if (cursor_pos > orig_line_len) {
                    vstr_cut_out_bytes(line, cursor_pos - 1, 1);
                    // set redraw parameters
                    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
                redraw_from_cursor = true;
                redraw_step_forward = 1;
            }
125
        } else if (escape_seq == ESEQ_ESC) {
126
127
            switch (c) {
                case '[':
128
                    escape_seq = ESEQ_ESC_BRACKET;
129
130
                    break;
                case 'O':
131
                    escape_seq = ESEQ_ESC_O;
132
133
                    break;
                default:
134
135
                    DEBUG_printf("(ESC %d)", c);
                    escape_seq = ESEQ_NONE;
136
            }
137
        } else if (escape_seq == ESEQ_ESC_BRACKET) {
138
            if ('0' <= c && c <= '9') {
139
                escape_seq = ESEQ_ESC_BRACKET_DIGIT;
140
141
                escape_seq_buf[0] = c;
            } else {
142
                escape_seq = ESEQ_NONE;
143
144
145
146
147
148
149
                if (c == 'A') {
                    // up arrow
                    if (hist_cur + 1 < READLINE_HIST_SIZE && readline_hist[hist_cur + 1] != NULL) {
                        // increase hist num
                        hist_cur += 1;
                        // set line to history
                        line->len = orig_line_len;
150
                        vstr_add_str(line, readline_hist[hist_cur]);
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
                        // 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 == 'B') {
                    // down arrow
                    if (hist_cur >= 0) {
                        // decrease hist num
                        hist_cur -= 1;
                        // set line to history
                        vstr_cut_tail_bytes(line, line->len - orig_line_len);
                        if (hist_cur >= 0) {
                            vstr_add_str(line, 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;
180
                    }
181
182
183
184
185
186
187
188
                } else if (c == 'H') {
                    // home
                    goto home_key;
                } else if (c == 'F') {
                    // end
                    goto end_key;
                } else {
                    DEBUG_printf("(ESC [ %d)", c);
189
                }
190
            }
191
        } else if (escape_seq == ESEQ_ESC_BRACKET_DIGIT) {
192
193
            if (c == '~') {
                if (escape_seq_buf[0] == '1' || escape_seq_buf[0] == '7') {
194
home_key:
195
196
                    redraw_step_back = cursor_pos - orig_line_len;
                } else if (escape_seq_buf[0] == '4' || escape_seq_buf[0] == '8') {
197
end_key:
198
                    redraw_step_forward = line->len - cursor_pos;
199
200
                } else {
                    DEBUG_printf("(ESC [ %c %d)", escape_seq_buf[0], c);
201
                }
202
203
            } else {
                DEBUG_printf("(ESC [ %c %d)", escape_seq_buf[0], c);
204
            }
205
206
            escape_seq = ESEQ_NONE;
        } else if (escape_seq == ESEQ_ESC_O) {
207
208
209
210
211
212
            switch (c) {
                case 'H':
                    goto home_key;
                case 'F':
                    goto end_key;
                default:
213
214
                    DEBUG_printf("(ESC O %d)", c);
                    escape_seq = ESEQ_NONE;
215
            }
216
        } else {
217
            escape_seq = ESEQ_NONE;
218
219
220
        }

        // redraw command prompt, efficiently
221
        // TODO we can probably use some more sophisticated VT100 commands here
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
        if (redraw_step_back > 0) {
            for (int i = 0; i < redraw_step_back; i++) {
                stdout_tx_str("\b");
            }
            cursor_pos -= redraw_step_back;
        }
        if (redraw_from_cursor) {
            if (line->len < last_line_len) {
                // erase old chars
                for (int i = cursor_pos; i < last_line_len; i++) {
                    stdout_tx_str(" ");
                }
                // step back
                for (int i = cursor_pos; i < last_line_len; i++) {
                    stdout_tx_str("\b");
                }
            }
            // draw new chars
            stdout_tx_strn(line->buf + cursor_pos, line->len - cursor_pos);
            // 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");
            }
            cursor_pos += redraw_step_forward;
        } else if (redraw_step_forward > 0) {
            // draw over old chars to move cursor forwards
            stdout_tx_strn(line->buf + cursor_pos, redraw_step_forward);
            cursor_pos += redraw_step_forward;
        }

        HAL_Delay(1);
    }
}