Annotation of qemu/readline.c, revision 1.1.1.5

1.1       root        1: /*
                      2:  * QEMU readline utility
1.1.1.2   root        3:  *
1.1       root        4:  * Copyright (c) 2003-2004 Fabrice Bellard
1.1.1.2   root        5:  *
1.1       root        6:  * Permission is hereby granted, free of charge, to any person obtaining a copy
                      7:  * of this software and associated documentation files (the "Software"), to deal
                      8:  * in the Software without restriction, including without limitation the rights
                      9:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
                     10:  * copies of the Software, and to permit persons to whom the Software is
                     11:  * furnished to do so, subject to the following conditions:
                     12:  *
                     13:  * The above copyright notice and this permission notice shall be included in
                     14:  * all copies or substantial portions of the Software.
                     15:  *
                     16:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                     17:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
                     18:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
                     19:  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
                     20:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
                     21:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
                     22:  * THE SOFTWARE.
                     23:  */
1.1.1.4   root       24: #include "readline.h"
                     25: #include "monitor.h"
1.1       root       26: 
                     27: #define IS_NORM 0
                     28: #define IS_ESC  1
                     29: #define IS_CSI  2
                     30: 
1.1.1.5 ! root       31: #undef printf
1.1       root       32: #define printf do_not_use_printf
                     33: 
1.1.1.4   root       34: void readline_show_prompt(ReadLineState *rs)
1.1       root       35: {
1.1.1.4   root       36:     monitor_printf(rs->mon, "%s", rs->prompt);
                     37:     monitor_flush(rs->mon);
                     38:     rs->last_cmd_buf_index = 0;
                     39:     rs->last_cmd_buf_size = 0;
                     40:     rs->esc_state = IS_NORM;
1.1       root       41: }
                     42: 
                     43: /* update the displayed command line */
1.1.1.4   root       44: static void readline_update(ReadLineState *rs)
1.1       root       45: {
                     46:     int i, delta, len;
                     47: 
1.1.1.4   root       48:     if (rs->cmd_buf_size != rs->last_cmd_buf_size ||
                     49:         memcmp(rs->cmd_buf, rs->last_cmd_buf, rs->cmd_buf_size) != 0) {
                     50:         for(i = 0; i < rs->last_cmd_buf_index; i++) {
                     51:             monitor_printf(rs->mon, "\033[D");
                     52:         }
                     53:         rs->cmd_buf[rs->cmd_buf_size] = '\0';
                     54:         if (rs->read_password) {
                     55:             len = strlen(rs->cmd_buf);
1.1       root       56:             for(i = 0; i < len; i++)
1.1.1.4   root       57:                 monitor_printf(rs->mon, "*");
1.1       root       58:         } else {
1.1.1.4   root       59:             monitor_printf(rs->mon, "%s", rs->cmd_buf);
1.1       root       60:         }
1.1.1.4   root       61:         monitor_printf(rs->mon, "\033[K");
                     62:         memcpy(rs->last_cmd_buf, rs->cmd_buf, rs->cmd_buf_size);
                     63:         rs->last_cmd_buf_size = rs->cmd_buf_size;
                     64:         rs->last_cmd_buf_index = rs->cmd_buf_size;
1.1       root       65:     }
1.1.1.4   root       66:     if (rs->cmd_buf_index != rs->last_cmd_buf_index) {
                     67:         delta = rs->cmd_buf_index - rs->last_cmd_buf_index;
1.1       root       68:         if (delta > 0) {
                     69:             for(i = 0;i < delta; i++) {
1.1.1.4   root       70:                 monitor_printf(rs->mon, "\033[C");
1.1       root       71:             }
                     72:         } else {
                     73:             delta = -delta;
                     74:             for(i = 0;i < delta; i++) {
1.1.1.4   root       75:                 monitor_printf(rs->mon, "\033[D");
1.1       root       76:             }
                     77:         }
1.1.1.4   root       78:         rs->last_cmd_buf_index = rs->cmd_buf_index;
1.1       root       79:     }
1.1.1.4   root       80:     monitor_flush(rs->mon);
1.1       root       81: }
                     82: 
1.1.1.4   root       83: static void readline_insert_char(ReadLineState *rs, int ch)
1.1       root       84: {
1.1.1.4   root       85:     if (rs->cmd_buf_index < READLINE_CMD_BUF_SIZE) {
                     86:         memmove(rs->cmd_buf + rs->cmd_buf_index + 1,
                     87:                 rs->cmd_buf + rs->cmd_buf_index,
                     88:                 rs->cmd_buf_size - rs->cmd_buf_index);
                     89:         rs->cmd_buf[rs->cmd_buf_index] = ch;
                     90:         rs->cmd_buf_size++;
                     91:         rs->cmd_buf_index++;
1.1       root       92:     }
                     93: }
                     94: 
1.1.1.4   root       95: static void readline_backward_char(ReadLineState *rs)
1.1       root       96: {
1.1.1.4   root       97:     if (rs->cmd_buf_index > 0) {
                     98:         rs->cmd_buf_index--;
1.1       root       99:     }
                    100: }
                    101: 
1.1.1.4   root      102: static void readline_forward_char(ReadLineState *rs)
1.1       root      103: {
1.1.1.4   root      104:     if (rs->cmd_buf_index < rs->cmd_buf_size) {
                    105:         rs->cmd_buf_index++;
1.1       root      106:     }
                    107: }
                    108: 
1.1.1.4   root      109: static void readline_delete_char(ReadLineState *rs)
1.1       root      110: {
1.1.1.4   root      111:     if (rs->cmd_buf_index < rs->cmd_buf_size) {
                    112:         memmove(rs->cmd_buf + rs->cmd_buf_index,
                    113:                 rs->cmd_buf + rs->cmd_buf_index + 1,
                    114:                 rs->cmd_buf_size - rs->cmd_buf_index - 1);
                    115:         rs->cmd_buf_size--;
1.1       root      116:     }
                    117: }
                    118: 
1.1.1.4   root      119: static void readline_backspace(ReadLineState *rs)
1.1       root      120: {
1.1.1.4   root      121:     if (rs->cmd_buf_index > 0) {
                    122:         readline_backward_char(rs);
                    123:         readline_delete_char(rs);
1.1       root      124:     }
                    125: }
                    126: 
1.1.1.4   root      127: static void readline_backword(ReadLineState *rs)
1.1.1.2   root      128: {
                    129:     int start;
                    130: 
1.1.1.4   root      131:     if (rs->cmd_buf_index == 0 || rs->cmd_buf_index > rs->cmd_buf_size) {
1.1.1.2   root      132:         return;
                    133:     }
                    134: 
1.1.1.4   root      135:     start = rs->cmd_buf_index - 1;
1.1.1.2   root      136: 
                    137:     /* find first word (backwards) */
                    138:     while (start > 0) {
1.1.1.4   root      139:         if (!qemu_isspace(rs->cmd_buf[start])) {
1.1.1.2   root      140:             break;
                    141:         }
                    142: 
                    143:         --start;
                    144:     }
                    145: 
                    146:     /* find first space (backwards) */
                    147:     while (start > 0) {
1.1.1.4   root      148:         if (qemu_isspace(rs->cmd_buf[start])) {
1.1.1.2   root      149:             ++start;
                    150:             break;
                    151:         }
                    152: 
                    153:         --start;
                    154:     }
                    155: 
                    156:     /* remove word */
1.1.1.4   root      157:     if (start < rs->cmd_buf_index) {
                    158:         memmove(rs->cmd_buf + start,
                    159:                 rs->cmd_buf + rs->cmd_buf_index,
                    160:                 rs->cmd_buf_size - rs->cmd_buf_index);
                    161:         rs->cmd_buf_size -= rs->cmd_buf_index - start;
                    162:         rs->cmd_buf_index = start;
1.1.1.2   root      163:     }
                    164: }
                    165: 
1.1.1.4   root      166: static void readline_bol(ReadLineState *rs)
1.1       root      167: {
1.1.1.4   root      168:     rs->cmd_buf_index = 0;
1.1       root      169: }
                    170: 
1.1.1.4   root      171: static void readline_eol(ReadLineState *rs)
1.1       root      172: {
1.1.1.4   root      173:     rs->cmd_buf_index = rs->cmd_buf_size;
1.1       root      174: }
                    175: 
1.1.1.4   root      176: static void readline_up_char(ReadLineState *rs)
1.1       root      177: {
                    178:     int idx;
                    179: 
1.1.1.4   root      180:     if (rs->hist_entry == 0)
1.1       root      181:        return;
1.1.1.4   root      182:     if (rs->hist_entry == -1) {
1.1       root      183:        /* Find latest entry */
1.1.1.4   root      184:        for (idx = 0; idx < READLINE_MAX_CMDS; idx++) {
                    185:            if (rs->history[idx] == NULL)
1.1       root      186:                break;
                    187:        }
1.1.1.4   root      188:        rs->hist_entry = idx;
1.1       root      189:     }
1.1.1.4   root      190:     rs->hist_entry--;
                    191:     if (rs->hist_entry >= 0) {
                    192:        pstrcpy(rs->cmd_buf, sizeof(rs->cmd_buf),
                    193:                 rs->history[rs->hist_entry]);
                    194:        rs->cmd_buf_index = rs->cmd_buf_size = strlen(rs->cmd_buf);
1.1       root      195:     }
                    196: }
                    197: 
1.1.1.4   root      198: static void readline_down_char(ReadLineState *rs)
1.1       root      199: {
1.1.1.4   root      200:     if (rs->hist_entry == -1)
                    201:         return;
                    202:     if (rs->hist_entry < READLINE_MAX_CMDS - 1 &&
                    203:         rs->history[++rs->hist_entry] != NULL) {
                    204:        pstrcpy(rs->cmd_buf, sizeof(rs->cmd_buf),
                    205:                 rs->history[rs->hist_entry]);
1.1       root      206:     } else {
1.1.1.4   root      207:         rs->cmd_buf[0] = 0;
                    208:        rs->hist_entry = -1;
1.1       root      209:     }
1.1.1.4   root      210:     rs->cmd_buf_index = rs->cmd_buf_size = strlen(rs->cmd_buf);
1.1       root      211: }
                    212: 
1.1.1.4   root      213: static void readline_hist_add(ReadLineState *rs, const char *cmdline)
1.1       root      214: {
                    215:     char *hist_entry, *new_entry;
                    216:     int idx;
                    217: 
                    218:     if (cmdline[0] == '\0')
                    219:        return;
                    220:     new_entry = NULL;
1.1.1.4   root      221:     if (rs->hist_entry != -1) {
1.1       root      222:        /* We were editing an existing history entry: replace it */
1.1.1.4   root      223:        hist_entry = rs->history[rs->hist_entry];
                    224:        idx = rs->hist_entry;
1.1       root      225:        if (strcmp(hist_entry, cmdline) == 0) {
                    226:            goto same_entry;
                    227:        }
                    228:     }
                    229:     /* Search cmdline in history buffers */
1.1.1.4   root      230:     for (idx = 0; idx < READLINE_MAX_CMDS; idx++) {
                    231:        hist_entry = rs->history[idx];
1.1       root      232:        if (hist_entry == NULL)
                    233:            break;
                    234:        if (strcmp(hist_entry, cmdline) == 0) {
                    235:        same_entry:
                    236:            new_entry = hist_entry;
                    237:            /* Put this entry at the end of history */
1.1.1.4   root      238:            memmove(&rs->history[idx], &rs->history[idx + 1],
                    239:                    (READLINE_MAX_CMDS - idx + 1) * sizeof(char *));
                    240:            rs->history[READLINE_MAX_CMDS - 1] = NULL;
                    241:            for (; idx < READLINE_MAX_CMDS; idx++) {
                    242:                if (rs->history[idx] == NULL)
1.1       root      243:                    break;
                    244:            }
                    245:            break;
                    246:        }
                    247:     }
1.1.1.4   root      248:     if (idx == READLINE_MAX_CMDS) {
1.1       root      249:        /* Need to get one free slot */
1.1.1.4   root      250:        free(rs->history[0]);
                    251:        memcpy(rs->history, &rs->history[1],
                    252:               (READLINE_MAX_CMDS - 1) * sizeof(char *));
                    253:        rs->history[READLINE_MAX_CMDS - 1] = NULL;
                    254:        idx = READLINE_MAX_CMDS - 1;
1.1       root      255:     }
                    256:     if (new_entry == NULL)
                    257:        new_entry = strdup(cmdline);
1.1.1.4   root      258:     rs->history[idx] = new_entry;
                    259:     rs->hist_entry = -1;
1.1       root      260: }
                    261: 
                    262: /* completion support */
                    263: 
1.1.1.4   root      264: void readline_add_completion(ReadLineState *rs, const char *str)
1.1       root      265: {
1.1.1.4   root      266:     if (rs->nb_completions < READLINE_MAX_COMPLETIONS) {
                    267:         rs->completions[rs->nb_completions++] = qemu_strdup(str);
1.1       root      268:     }
                    269: }
                    270: 
1.1.1.4   root      271: void readline_set_completion_index(ReadLineState *rs, int index)
1.1       root      272: {
1.1.1.4   root      273:     rs->completion_index = index;
                    274: }
                    275: 
                    276: static void readline_completion(ReadLineState *rs)
                    277: {
                    278:     Monitor *mon = cur_mon;
1.1.1.2   root      279:     int len, i, j, max_width, nb_cols, max_prefix;
1.1       root      280:     char *cmdline;
                    281: 
1.1.1.4   root      282:     rs->nb_completions = 0;
1.1.1.2   root      283: 
1.1.1.4   root      284:     cmdline = qemu_malloc(rs->cmd_buf_index + 1);
                    285:     memcpy(cmdline, rs->cmd_buf, rs->cmd_buf_index);
                    286:     cmdline[rs->cmd_buf_index] = '\0';
                    287:     rs->completion_finder(cmdline);
1.1       root      288:     qemu_free(cmdline);
                    289: 
                    290:     /* no completion found */
1.1.1.4   root      291:     if (rs->nb_completions <= 0)
1.1       root      292:         return;
1.1.1.4   root      293:     if (rs->nb_completions == 1) {
                    294:         len = strlen(rs->completions[0]);
                    295:         for(i = rs->completion_index; i < len; i++) {
                    296:             readline_insert_char(rs, rs->completions[0][i]);
1.1       root      297:         }
                    298:         /* extra space for next argument. XXX: make it more generic */
1.1.1.4   root      299:         if (len > 0 && rs->completions[0][len - 1] != '/')
                    300:             readline_insert_char(rs, ' ');
1.1       root      301:     } else {
1.1.1.4   root      302:         monitor_printf(mon, "\n");
1.1       root      303:         max_width = 0;
1.1.1.2   root      304:         max_prefix = 0;        
1.1.1.4   root      305:         for(i = 0; i < rs->nb_completions; i++) {
                    306:             len = strlen(rs->completions[i]);
1.1.1.2   root      307:             if (i==0) {
                    308:                 max_prefix = len;
                    309:             } else {
                    310:                 if (len < max_prefix)
                    311:                     max_prefix = len;
                    312:                 for(j=0; j<max_prefix; j++) {
1.1.1.4   root      313:                     if (rs->completions[i][j] != rs->completions[0][j])
1.1.1.2   root      314:                         max_prefix = j;
                    315:                 }
                    316:             }
1.1       root      317:             if (len > max_width)
                    318:                 max_width = len;
                    319:         }
1.1.1.2   root      320:         if (max_prefix > 0) 
1.1.1.4   root      321:             for(i = rs->completion_index; i < max_prefix; i++) {
                    322:                 readline_insert_char(rs, rs->completions[0][i]);
1.1.1.2   root      323:             }
1.1       root      324:         max_width += 2;
                    325:         if (max_width < 10)
                    326:             max_width = 10;
                    327:         else if (max_width > 80)
                    328:             max_width = 80;
                    329:         nb_cols = 80 / max_width;
                    330:         j = 0;
1.1.1.4   root      331:         for(i = 0; i < rs->nb_completions; i++) {
                    332:             monitor_printf(rs->mon, "%-*s", max_width, rs->completions[i]);
                    333:             if (++j == nb_cols || i == (rs->nb_completions - 1)) {
                    334:                 monitor_printf(rs->mon, "\n");
1.1       root      335:                 j = 0;
                    336:             }
                    337:         }
1.1.1.4   root      338:         readline_show_prompt(rs);
1.1       root      339:     }
                    340: }
                    341: 
                    342: /* return true if command handled */
1.1.1.4   root      343: void readline_handle_byte(ReadLineState *rs, int ch)
1.1       root      344: {
1.1.1.4   root      345:     switch(rs->esc_state) {
1.1       root      346:     case IS_NORM:
                    347:         switch(ch) {
                    348:         case 1:
1.1.1.4   root      349:             readline_bol(rs);
1.1       root      350:             break;
                    351:         case 4:
1.1.1.4   root      352:             readline_delete_char(rs);
1.1       root      353:             break;
                    354:         case 5:
1.1.1.4   root      355:             readline_eol(rs);
1.1       root      356:             break;
                    357:         case 9:
1.1.1.4   root      358:             readline_completion(rs);
1.1       root      359:             break;
                    360:         case 10:
                    361:         case 13:
1.1.1.4   root      362:             rs->cmd_buf[rs->cmd_buf_size] = '\0';
                    363:             if (!rs->read_password)
                    364:                 readline_hist_add(rs, rs->cmd_buf);
                    365:             monitor_printf(rs->mon, "\n");
                    366:             rs->cmd_buf_index = 0;
                    367:             rs->cmd_buf_size = 0;
                    368:             rs->last_cmd_buf_index = 0;
                    369:             rs->last_cmd_buf_size = 0;
                    370:             rs->readline_func(rs->mon, rs->cmd_buf, rs->readline_opaque);
1.1       root      371:             break;
1.1.1.2   root      372:         case 23:
                    373:             /* ^W */
1.1.1.4   root      374:             readline_backword(rs);
1.1.1.2   root      375:             break;
1.1       root      376:         case 27:
1.1.1.4   root      377:             rs->esc_state = IS_ESC;
1.1       root      378:             break;
                    379:         case 127:
                    380:         case 8:
1.1.1.4   root      381:             readline_backspace(rs);
1.1       root      382:             break;
                    383:        case 155:
1.1.1.4   root      384:             rs->esc_state = IS_CSI;
1.1       root      385:            break;
                    386:         default:
                    387:             if (ch >= 32) {
1.1.1.4   root      388:                 readline_insert_char(rs, ch);
1.1       root      389:             }
                    390:             break;
                    391:         }
                    392:         break;
                    393:     case IS_ESC:
                    394:         if (ch == '[') {
1.1.1.4   root      395:             rs->esc_state = IS_CSI;
                    396:             rs->esc_param = 0;
1.1       root      397:         } else {
1.1.1.4   root      398:             rs->esc_state = IS_NORM;
1.1       root      399:         }
                    400:         break;
                    401:     case IS_CSI:
                    402:         switch(ch) {
                    403:        case 'A':
                    404:        case 'F':
1.1.1.4   root      405:            readline_up_char(rs);
1.1       root      406:            break;
                    407:        case 'B':
                    408:        case 'E':
1.1.1.4   root      409:            readline_down_char(rs);
1.1       root      410:            break;
                    411:         case 'D':
1.1.1.4   root      412:             readline_backward_char(rs);
1.1       root      413:             break;
                    414:         case 'C':
1.1.1.4   root      415:             readline_forward_char(rs);
1.1       root      416:             break;
                    417:         case '0' ... '9':
1.1.1.4   root      418:             rs->esc_param = rs->esc_param * 10 + (ch - '0');
1.1       root      419:             goto the_end;
                    420:         case '~':
1.1.1.4   root      421:             switch(rs->esc_param) {
1.1       root      422:             case 1:
1.1.1.4   root      423:                 readline_bol(rs);
1.1       root      424:                 break;
                    425:             case 3:
1.1.1.4   root      426:                 readline_delete_char(rs);
1.1       root      427:                 break;
                    428:             case 4:
1.1.1.4   root      429:                 readline_eol(rs);
1.1       root      430:                 break;
                    431:             }
                    432:             break;
                    433:         default:
                    434:             break;
                    435:         }
1.1.1.4   root      436:         rs->esc_state = IS_NORM;
1.1       root      437:     the_end:
                    438:         break;
                    439:     }
1.1.1.4   root      440:     readline_update(rs);
1.1       root      441: }
                    442: 
1.1.1.4   root      443: void readline_start(ReadLineState *rs, const char *prompt, int read_password,
1.1       root      444:                     ReadLineFunc *readline_func, void *opaque)
                    445: {
1.1.1.4   root      446:     pstrcpy(rs->prompt, sizeof(rs->prompt), prompt);
                    447:     rs->readline_func = readline_func;
                    448:     rs->readline_opaque = opaque;
                    449:     rs->read_password = read_password;
                    450:     readline_restart(rs);
                    451: }
                    452: 
                    453: void readline_restart(ReadLineState *rs)
                    454: {
                    455:     rs->cmd_buf_index = 0;
                    456:     rs->cmd_buf_size = 0;
1.1       root      457: }
                    458: 
1.1.1.4   root      459: const char *readline_get_history(ReadLineState *rs, unsigned int index)
1.1       root      460: {
1.1.1.4   root      461:     if (index >= READLINE_MAX_CMDS)
1.1       root      462:         return NULL;
1.1.1.4   root      463:     return rs->history[index];
                    464: }
                    465: 
                    466: ReadLineState *readline_init(Monitor *mon,
                    467:                              ReadLineCompletionFunc *completion_finder)
                    468: {
                    469:     ReadLineState *rs = qemu_mallocz(sizeof(*rs));
                    470: 
                    471:     rs->hist_entry = -1;
                    472:     rs->mon = mon;
                    473:     rs->completion_finder = completion_finder;
                    474: 
                    475:     return rs;
1.1       root      476: }

unix.superglobalmegacorp.com