src/hci/readline.c

   1 /*
   2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <string.h>
  20 #include <stdlib.h>
  21 #include <console.h>
  22 #include <gpxe/keys.h>
  23 #include <gpxe/editstring.h>
  24 #include <readline/readline.h>
  25
  26 /** @file
  27  *
  28  * Minimal readline
  29  *
  30  */
  31
  32 #define READLINE_MAX 256
  33
  34 /**
  35  * Synchronise console with edited string
  36  *
  37  * @v string            Editable string
  38  */
  39 static void sync_console ( struct edit_string *string ) {
  40         unsigned int mod_start = string->mod_start;
  41         unsigned int mod_end = string->mod_end;
  42         unsigned int cursor = string->last_cursor;
  43         size_t len = strlen ( string->buf );
  44
  45         /* Expand region back to old cursor position if applicable */
  46         if ( mod_start > string->last_cursor )
  47                 mod_start = string->last_cursor;
  48
  49         /* Expand region forward to new cursor position if applicable */
  50         if ( mod_end < string->cursor )
  51                 mod_end = string->cursor;
  52
  53         /* Backspace to start of region */
  54         while ( cursor > mod_start ) {
  55                 putchar ( '\b' );
  56                 cursor--;
  57         }
  58
  59         /* Print modified region */
  60         while ( cursor < mod_end ) {
  61                 putchar ( ( cursor >= len ) ? ' ' : string->buf[cursor] );
  62                 cursor++;
  63         }
  64
  65         /* Backspace to new cursor position */
  66         while ( cursor > string->cursor ) {
  67                 putchar ( '\b' );
  68                 cursor--;
  69         }
  70 }
  71
  72 /**
  73  * Read line from console
  74  *
  75  * @v prompt            Prompt string
  76  * @ret line            Line read from console (excluding terminating newline)
  77  *
  78  * The returned line is allocated with malloc(); the caller must
  79  * eventually call free() to release the storage.
  80  */
  81 char * readline ( const char *prompt ) {
  82         char buf[READLINE_MAX];
  83         struct edit_string string = {
  84                 .buf = buf,
  85                 .len = sizeof ( buf ),
  86                 .cursor = 0,
  87         };
  88         int key;
  89         char *line;
  90
  91         if ( prompt )
  92                 printf ( "%s", prompt );
  93
  94         buf[0] = '\0';
  95         while ( 1 ) {
  96                 key = edit_string ( &string, getkey() );
  97                 sync_console ( &string );
  98                 switch ( key ) {
  99                 case CR:
 100                 case LF:
 101                         putchar ( '\n' );
 102                         line = strdup ( buf );
 103                         if ( ! line )
 104                                 printf ( "Out of memory\n" );
 105                         return line;
 106                 case CTRL_C:
 107                         putchar ( '\n' );
 108                         return NULL;
 109                 default:
 110                         /* Do nothing */
 111                         break;
 112                 }
 113         }
 114 }