iPXE
Functions
lineconsole.c File Reference

Line-based console. More...

#include <stdint.h>
#include <stddef.h>
#include <ipxe/ansiesc.h>
#include <ipxe/lineconsole.h>

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
size_t line_putchar (struct line_console *line, int character)
 Print a character to a line-based console. More...
 

Detailed Description

Line-based console.

Definition in file lineconsole.c.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ line_putchar()

size_t line_putchar ( struct line_console line,
int  character 
)

Print a character to a line-based console.

Parameters
characterCharacter to be printed
Return values
printPrint line

Definition at line 43 of file lineconsole.c.

43  {
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
size_t len
Length of buffer.
Definition: lineconsole.h:29
int ansiesc_process(struct ansiesc_context *ctx, int c)
Process character that may be part of ANSI escape sequence.
Definition: ansiesc.c:74
struct ansiesc_context ctx
ANSI escape sequence context.
Definition: lineconsole.h:31
char * buffer
Data buffer.
Definition: lineconsole.h:21

References ansiesc_process(), line_console::buffer, line_console::ctx, line_console::index, and line_console::len.

Referenced by syslog_putchar(), syslogs_putchar(), and vmconsole_putchar().