Print multiple commands per line in help
[people/xl0/gpxe.git] / 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 <stdio.h>
20 #include <string.h>
21 #include <stdlib.h>
22 #include <console.h>
23 #include <gpxe/keys.h>
24 #include <gpxe/editstring.h>
25 #include <readline/readline.h>
26
27 /** @file
28  *
29  * Minimal readline
30  *
31  */
32
33 #define READLINE_MAX 256
34
35 /**
36  * Synchronise console with edited string
37  *
38  * @v string            Editable string
39  */
40 static void sync_console ( struct edit_string *string ) {
41         unsigned int mod_start = string->mod_start;
42         unsigned int mod_end = string->mod_end;
43         unsigned int cursor = string->last_cursor;
44         size_t len = strlen ( string->buf );
45
46         /* Expand region back to old cursor position if applicable */
47         if ( mod_start > string->last_cursor )
48                 mod_start = string->last_cursor;
49
50         /* Expand region forward to new cursor position if applicable */
51         if ( mod_end < string->cursor )
52                 mod_end = string->cursor;
53
54         /* Backspace to start of region */
55         while ( cursor > mod_start ) {
56                 putchar ( '\b' );
57                 cursor--;
58         }
59
60         /* Print modified region */
61         while ( cursor < mod_end ) {
62                 putchar ( ( cursor >= len ) ? ' ' : string->buf[cursor] );
63                 cursor++;
64         }
65
66         /* Backspace to new cursor position */
67         while ( cursor > string->cursor ) {
68                 putchar ( '\b' );
69                 cursor--;
70         }
71 }
72
73 /**
74  * Read line from console
75  *
76  * @v prompt            Prompt string
77  * @ret line            Line read from console (excluding terminating newline)
78  *
79  * The returned line is allocated with malloc(); the caller must
80  * eventually call free() to release the storage.
81  */
82 char * readline ( const char *prompt ) {
83         char buf[READLINE_MAX];
84         struct edit_string string;
85         int key;
86         char *line;
87
88         if ( prompt )
89                 printf ( "%s", prompt );
90
91         memset ( &string, 0, sizeof ( string ) );
92         string.buf = buf;
93         string.len = sizeof ( buf );
94         buf[0] = '\0';
95
96         while ( 1 ) {
97                 key = edit_string ( &string, getkey() );
98                 sync_console ( &string );
99                 switch ( key ) {
100                 case CR:
101                 case LF:
102                         putchar ( '\n' );
103                         line = strdup ( buf );
104                         if ( ! line )
105                                 printf ( "Out of memory\n" );
106                         return line;
107                 case CTRL_C:
108                         putchar ( '\n' );
109                         return NULL;
110                 default:
111                         /* Do nothing */
112                         break;
113                 }
114         }
115 }