2006-10-02 07:22:43 +10:00
/** \file screen.h High level library for handling the terminal screen
The screen library allows the interactive reader to write its
output to screen efficiently by keeping an inetrnal representation
2008-01-14 02:47:47 +10:00
of the current screen contents and trying to find a reasonably
2006-10-02 07:22:43 +10:00
efficient way for transforming that to the desired screen content .
2008-01-14 02:47:47 +10:00
The current implementation is less smart than ncurses allows
and can not for example move blocks of text around to handle text
insertion .
*/
2006-10-02 02:02:58 +10:00
# ifndef FISH_SCREEN_H
# define FISH_SCREEN_H
2011-12-27 18:41:38 -08:00
# include <vector>
struct line_entry_t
{
wchar_t text ;
int color ;
} ;
/**
A class representing a single line of a screen .
*/
class line_t
{
public :
std : : vector < struct line_entry_t > entries ;
void resize ( size_t size ) {
entries . resize ( size ) ;
}
line_entry_t & entry ( size_t idx ) {
return entries . at ( idx ) ;
}
line_entry_t & create_entry ( size_t idx ) {
if ( idx > = entries . size ( ) ) {
entries . resize ( idx + 1 ) ;
}
return entries . at ( idx ) ;
}
size_t entry_count ( void ) {
return entries . size ( ) ;
}
} ;
/**
A class representing screen contents .
*/
class screen_data_t
{
std : : vector < line_t > line_datas ;
public :
int cursor [ 2 ] ;
line_t & add_line ( void ) {
line_datas . resize ( line_datas . size ( ) + 1 ) ;
return line_datas . back ( ) ;
}
void resize ( size_t size ) {
line_datas . resize ( size ) ;
}
line_t & create_line ( size_t idx ) {
if ( idx > = line_datas . size ( ) ) {
line_datas . resize ( idx + 1 ) ;
}
return line_datas . at ( idx ) ;
}
line_t & line ( size_t idx ) {
return line_datas . at ( idx ) ;
}
size_t line_count ( void ) {
return line_datas . size ( ) ;
}
} ;
2006-10-02 07:22:43 +10:00
/**
The struct representing the current and desired screen contents .
*/
2006-10-02 02:02:58 +10:00
typedef struct
{
2008-01-14 02:47:47 +10:00
/**
2006-10-02 07:22:43 +10:00
The internal representation of the desired screen contents .
*/
2011-12-27 18:41:38 -08:00
screen_data_t desired ;
2006-10-02 07:22:43 +10:00
/**
The internal representation of the actual screen contents .
*/
2011-12-27 18:41:38 -08:00
screen_data_t actual ;
2006-10-02 07:22:43 +10:00
/**
2011-12-27 18:41:38 -08:00
A string containing the prompt which was last printed to
2006-10-02 07:22:43 +10:00
the screen .
*/
2011-12-27 18:41:38 -08:00
wcstring actual_prompt ;
2006-10-05 07:45:02 +10:00
2008-01-14 02:47:47 +10:00
/**
2006-10-05 07:45:02 +10:00
The actual width of the screen at the time of the last screen
write .
*/
2011-12-26 19:18:46 -08:00
int actual_width ;
2006-10-05 09:33:12 +10:00
2006-10-09 23:26:42 +10:00
/**
This flag is set to true when there is reason to suspect that
the parts of the screen lines where the actual content is not
filled in may be non - empty . This means that a clr_eol command
has to be sent to the terminal at the end of each line .
*/
int need_clear ;
2011-12-26 19:18:46 -08:00
2006-10-05 09:33:12 +10:00
/**
These status buffers are used to check if any output has occurred
other than from fish ' s main loop , in which case we need to redraw .
*/
struct stat prev_buff_1 , prev_buff_2 , post_buff_1 , post_buff_2 ;
2006-10-02 02:02:58 +10:00
}
screen_t ;
2006-10-02 07:22:43 +10:00
/**
This is the main function for the screen putput library . It is used
to define the desired contents of the screen . The screen command
will use it ' s knowlege of the current contents of the screen in
order to render the desired output using as few terminal commands
as possible .
*/
2011-12-26 19:18:46 -08:00
void s_write ( screen_t * s ,
wchar_t * prompt ,
2006-10-02 07:22:43 +10:00
wchar_t * commandline ,
2011-12-26 19:18:46 -08:00
int * colors ,
2006-10-07 10:56:25 +10:00
int * indent ,
2006-10-02 07:22:43 +10:00
int cursor_pos ) ;
2011-12-26 19:18:46 -08:00
/**
2007-10-01 08:53:54 +10:00
This function resets the screen buffers internal knowledge about
the contents of the screen . Use this function when some other
function than s_write has written to the screen .
\ param s the screen to reset
2011-12-26 19:18:46 -08:00
\ param reset_cursor whether the line on which the curor has changed should be assumed to have changed . If \ c reset_cursor is set to 0 , the library will attempt to make sure that the screen area does not seem to move up or down on repaint .
2007-10-01 08:53:54 +10:00
If reset_cursor is incorreclt set to 0 , this may result in screen
contents being erased . If it is incorrectly set to one , it may
result in one or more lines of garbage on screen on the next
repaint . If this happens during a loop , such as an interactive
resizing , there will be one line of garbage for every repaint ,
which will quicly fill the screen .
2006-10-02 07:22:43 +10:00
*/
2007-09-24 18:13:01 +10:00
void s_reset ( screen_t * s , int reset_cursor ) ;
2006-10-02 02:02:58 +10:00
# endif