iPXE
lineconsole.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 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., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 /** @file
27  *
28  * Line-based console
29  *
30  */
31 
32 #include <stdint.h>
33 #include <stddef.h>
34 #include <ipxe/ansiesc.h>
35 #include <ipxe/lineconsole.h>
36 
37 /**
38  * Print a character to a line-based console
39  *
40  * @v character Character to be printed
41  * @ret print Print line
42  */
43 size_t line_putchar ( struct line_console *line, int character ) {
44 
45  /* Strip ANSI escape sequences */
46  character = ansiesc_process ( &line->ctx, character );
47  if ( character < 0 )
48  return 0;
49 
50  /* Handle backspace characters */
51  if ( character == '\b' ) {
52  if ( line->index )
53  line->index--;
54  return 0;
55  }
56 
57  /* Ignore carriage return */
58  if ( character == '\r' )
59  return 0;
60 
61  /* Treat newline as a terminator */
62  if ( character == '\n' )
63  character = 0;
64 
65  /* Add character to buffer */
66  line->buffer[line->index++] = character;
67 
68  /* Do nothing more unless we reach end-of-line (or end-of-buffer) */
69  if ( ( character != 0 ) &&
70  ( line->index < ( line->len - 1 /* NUL */ ) ) ) {
71  return 0;
72  }
73 
74  /* Reset to start of buffer */
75  line->index = 0;
76 
77  return 1;
78 }
size_t index
Current index within buffer.
Definition: lineconsole.h:23
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
A line-based console.
Definition: lineconsole.h:16
Line-based console.
size_t len
Length of buffer.
Definition: lineconsole.h:29
size_t line_putchar(struct line_console *line, int character)
Print a character to a line-based console.
Definition: lineconsole.c:43
int ansiesc_process(struct ansiesc_context *ctx, int c)
Process character that may be part of ANSI escape sequence.
Definition: ansiesc.c:74
ANSI escape sequences.
struct ansiesc_context ctx
ANSI escape sequence context.
Definition: lineconsole.h:31
char * buffer
Data buffer.
Definition: lineconsole.h:21