maride/guacamole-spice-protocol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Refactor delta to display.

Browse Source
This commit is contained in:
Michael Jumper 2013-03-27 03:06:45 -07:00
parent 87c36ca2a5
commit 2c78613821
3 changed files with 175 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
protocols/ssh/include/terminal.h
View File

@ -186,14 +186,33 @@ typedef struct guac_terminal_operation {
} guac_terminal_operation; } guac_terminal_operation;
/** /**
* Set of all pending operations for the currently-visible screen area. * A terminal character with two states - a current state, and a future state
* represented by a pairing of an operation with a terminal character.
*/ */
typedef struct guac_terminal_delta { typedef struct guac_terminal_display_char {
/** /**
* Array of all operations pending for the visible screen area. * The current state of this character.
*/ */
guac_terminal_operation* operations; guac_terminal_char current;
/**
* The next state of this character, as an operation upon this
* character.
*/
guac_terminal_operation next;
} guac_terminal_display_char;
/**
* Set of all characters for the currently-visible screen area.
*/
typedef struct guac_terminal_display {
/**
* Array of all characters within the visible screen area.
*/
guac_terminal_display_char* characters;
/** /**
* The width of the screen, in characters. * The width of the screen, in characters.
@ -205,7 +224,7 @@ typedef struct guac_terminal_delta {
*/ */
int height; int height;
} guac_terminal_delta; } guac_terminal_display;
/** /**
* Represents a terminal emulator which uses a given Guacamole client to * Represents a terminal emulator which uses a given Guacamole client to
@ -319,10 +338,9 @@ struct guac_terminal {
guac_terminal_char_handler* char_handler; guac_terminal_char_handler* char_handler;
/** /**
* The difference between the currently-rendered screen and the current * The current display state and pending state.
* state of the terminal.
*/ */
guac_terminal_delta* delta; guac_terminal_display* display;
}; };
@ -384,32 +402,32 @@ int guac_terminal_scroll_down(guac_terminal* term,
int start_row, int end_row, int amount); int start_row, int end_row, int amount);
/** /**
* Allocates a new guac_terminal_delta. * Allocates a new guac_terminal_display.
*/ */
guac_terminal_delta* guac_terminal_delta_alloc(int width, int height); guac_terminal_display* guac_terminal_display_alloc(int width, int height);
/** /**
* Frees the given guac_terminal_delta. * Frees the given guac_terminal_display.
*/ */
void guac_terminal_delta_free(guac_terminal_delta* delta); void guac_terminal_display_free(guac_terminal_display* display);
/** /**
* Resizes the given guac_terminal_delta to the given dimensions. * Resizes the given guac_terminal_display to the given dimensions.
*/ */
void guac_terminal_delta_resize(guac_terminal_delta* delta, void guac_terminal_display_resize(guac_terminal_display* display,
int width, int height); int width, int height);
/** /**
* Stores a set operation at the given location. * Stores a set operation at the given location.
*/ */
void guac_terminal_delta_set(guac_terminal_delta* delta, int r, int c, void guac_terminal_display_set(guac_terminal_display* display, int r, int c,
guac_terminal_char* character); guac_terminal_char* character);
/** /**
* Stores a rectangle of copy operations, copying existing operations as * Stores a rectangle of copy operations, copying existing operations as
* necessary. * necessary.
*/ */
void guac_terminal_delta_copy(guac_terminal_delta* delta, void guac_terminal_display_copy(guac_terminal_display* display,
int dst_row, int dst_column, int dst_row, int dst_column,
int src_row, int src_column, int src_row, int src_column,
int w, int h); int w, int h);
@ -417,15 +435,15 @@ void guac_terminal_delta_copy(guac_terminal_delta* delta,
/** /**
* Sets a rectangle of character data to the given character value. * Sets a rectangle of character data to the given character value.
*/ */
void guac_terminal_delta_set_rect(guac_terminal_delta* delta, void guac_terminal_display_set_rect(guac_terminal_display* display,
int row, int column, int w, int h, int row, int column, int w, int h,
guac_terminal_char* character); guac_terminal_char* character);
/** /**
* Flushes all pending operations within the given guac_client_delta to the * Flushes all pending operations within the given guac_terminal_display to the
* given guac_terminal. * given guac_terminal.
*/ */
void guac_terminal_delta_flush(guac_terminal_delta* delta, void guac_terminal_display_flush(guac_terminal_display* display,
guac_terminal* terminal); guac_terminal* terminal);
#endif #endif

4
protocols/ssh/src/ssh_handlers.c
View File

@ -104,8 +104,8 @@ int ssh_guac_client_handle_messages(guac_client* client) {
} }
} }
/* Flush terminal delta */ /* Flush terminal display */
guac_terminal_delta_flush(client_data->term->delta, client_data->term); guac_terminal_display_flush(client_data->term->display, client_data->term);
return 0; return 0;
} }

256
protocols/ssh/src/terminal.c
View File

@ -163,8 +163,8 @@ guac_terminal* guac_terminal_create(guac_client* client,
} }
/* Init delta */ /* Init display */
term->delta = guac_terminal_delta_alloc(term->term_width, term->display = guac_terminal_display_alloc(term->term_width,
term->term_height); term->term_height);
/* Clear with background color */ /* Clear with background color */
@ -184,8 +184,8 @@ void guac_terminal_free(guac_terminal* term) {
free(term->scrollback); free(term->scrollback);
/* Free delta */ /* Free display */
guac_terminal_delta_free(term->delta); guac_terminal_display_free(term->display);
} }
@ -353,7 +353,7 @@ int __guac_terminal_set_colors(guac_terminal* term,
/** /**
* Sends the given character to the terminal at the given row and column, * Sends the given character to the terminal at the given row and column,
* rendering the charater immediately. This bypasses the guac_terminal_delta * rendering the charater immediately. This bypasses the guac_terminal_display
* mechanism and is intended for flushing of updates only. * mechanism and is intended for flushing of updates only.
*/ */
int __guac_terminal_set(guac_terminal* term, int row, int col, char c) { int __guac_terminal_set(guac_terminal* term, int row, int col, char c) {
@ -377,8 +377,8 @@ int guac_terminal_set(guac_terminal* term, int row, int col, char c) {
guac_char.value = c; guac_char.value = c;
guac_char.attributes = term->current_attributes; guac_char.attributes = term->current_attributes;
/* Set delta */ /* Set display */
guac_terminal_delta_set(term->delta, row, col, &guac_char); guac_terminal_display_set(term->display, row, col, &guac_char);
return 0; return 0;
} }
@ -398,8 +398,8 @@ int guac_terminal_copy(guac_terminal* term,
int src_row, int src_col, int rows, int cols, int src_row, int src_col, int rows, int cols,
int dst_row, int dst_col) { int dst_row, int dst_col) {
/* Update delta */ /* Update display */
guac_terminal_delta_copy(term->delta, guac_terminal_display_copy(term->display,
dst_row, dst_col, dst_row, dst_col,
src_row, src_col, src_row, src_col,
cols, rows); cols, rows);
@ -419,7 +419,7 @@ int guac_terminal_clear(guac_terminal* term,
character.attributes.background = background_color; character.attributes.background = background_color;
/* Fill with color */ /* Fill with color */
guac_terminal_delta_set_rect(term->delta, guac_terminal_display_set_rect(term->display,
row, col, cols, rows, &character); row, col, cols, rows, &character);
return 0; return 0;
@ -513,64 +513,76 @@ int guac_terminal_clear_range(guac_terminal* term,
} }
guac_terminal_delta* guac_terminal_delta_alloc(int width, int height) { guac_terminal_display* guac_terminal_display_alloc(int width, int height) {
guac_terminal_operation* current; guac_terminal_display_char* current;
int x, y; int x, y;
/* Allocate delta */ /* Allocate display */
guac_terminal_delta* delta = malloc(sizeof(guac_terminal_delta)); guac_terminal_display* display = malloc(sizeof(guac_terminal_display));
/* Initial value of all characters in the display */
guac_terminal_char blank = {
.value = ' ',
.attributes = {
.background = 0
}
};
/* Set width and height */ /* Set width and height */
delta->width = width; display->width = width;
delta->height = height; display->height = height;
/* Alloc operations */ /* Alloc display */
delta->operations = malloc(width * height * display->characters = malloc(width * height *
sizeof(guac_terminal_operation)); sizeof(guac_terminal_display_char));
/* Init each operation buffer row */ /* Init each display buffer row */
current = delta->operations; current = display->characters;
for (y=0; y<height; y++) { for (y=0; y<height; y++) {
/* Init entire row to NOP */ /* Init entire row to NOP */
for (x=0; x<width; x++) for (x=0; x<width; x++) {
(current++)->type = GUAC_CHAR_NOP; current->current = blank;
current->next.type = GUAC_CHAR_NOP;
current++;
}
} }
return delta; return display;
} }
void guac_terminal_delta_free(guac_terminal_delta* delta) { void guac_terminal_display_free(guac_terminal_display* display) {
/* Free operations buffer */ /* Free characters buffer */
free(delta->operations); free(display->characters);
/* Free delta */ /* Free display */
free(delta); free(display);
} }
void guac_terminal_delta_resize(guac_terminal_delta* delta, void guac_terminal_display_resize(guac_terminal_display* display,
int width, int height) { int width, int height) {
/* STUB */ /* STUB */
} }
void guac_terminal_delta_set(guac_terminal_delta* delta, int r, int c, void guac_terminal_display_set(guac_terminal_display* display, int r, int c,
guac_terminal_char* character) { guac_terminal_char* character) {
/* Get operation at coordinate */ /* Get operation at coordinate */
guac_terminal_operation* op = &(delta->operations[r*delta->width + c]); guac_terminal_display_char* disp_char =
&(display->characters[r*display->width + c]);
/* Store operation */ /* Store operation */
op->type = GUAC_CHAR_SET; disp_char->next.type = GUAC_CHAR_SET;
op->character = *character; disp_char->next.character = *character;
} }
void guac_terminal_delta_copy(guac_terminal_delta* delta, void guac_terminal_display_copy(guac_terminal_display* display,
int dst_row, int dst_column, int dst_row, int dst_column,
int src_row, int src_column, int src_row, int src_column,
int w, int h) { int w, int h) {
@ -579,30 +591,30 @@ void guac_terminal_delta_copy(guac_terminal_delta* delta,
/* FIXME: Handle intersections between src and dst rects */ /* FIXME: Handle intersections between src and dst rects */
guac_terminal_operation* current_row = guac_terminal_display_char* current_row =
&(delta->operations[dst_row*delta->width + dst_column]); &(display->characters[dst_row*display->width + dst_column]);
guac_terminal_operation* src_current_row = guac_terminal_display_char* src_current_row =
&(delta->operations[src_row*delta->width + src_column]); &(display->characters[src_row*display->width + src_column]);
/* Set rectangle to copy operations */ /* Set rectangle to copy operations */
for (row=0; row<h; row++) { for (row=0; row<h; row++) {
guac_terminal_operation* current = current_row; guac_terminal_display_char* current = current_row;
guac_terminal_operation* src_current = src_current_row; guac_terminal_display_char* src_current = src_current_row;
for (column=0; column<w; column++) { for (column=0; column<w; column++) {
/* If copying existing delta operation, just copy that rather /* If copying existing display operation, just copy that rather
* than create a new copy op */ * than create a new copy op */
if (src_current->type != GUAC_CHAR_NOP) if (src_current->next.type != GUAC_CHAR_NOP)
*current = *src_current; current->next = src_current->next;
/* Store operation */ /* Store operation */
else { else {
current->type = GUAC_CHAR_COPY; current->next.type = GUAC_CHAR_COPY;
current->row = src_row + row; current->next.row = src_row + row;
current->column = src_column + column; current->next.column = src_column + column;
} }
/* Next column */ /* Next column */
@ -612,8 +624,8 @@ void guac_terminal_delta_copy(guac_terminal_delta* delta,
} }
/* Next row */ /* Next row */
current_row += delta->width; current_row += display->width;
src_current_row += delta->width; src_current_row += display->width;
} }
@ -621,23 +633,23 @@ void guac_terminal_delta_copy(guac_terminal_delta* delta,
} }
void guac_terminal_delta_set_rect(guac_terminal_delta* delta, void guac_terminal_display_set_rect(guac_terminal_display* display,
int row, int column, int w, int h, int row, int column, int w, int h,
guac_terminal_char* character) { guac_terminal_char* character) {
guac_terminal_operation* current_row = guac_terminal_display_char* current_row =
&(delta->operations[row*delta->width + column]); &(display->characters[row*display->width + column]);
/* Set rectangle contents to given character */ /* Set rectangle contents to given character */
for (row=0; row<h; row++) { for (row=0; row<h; row++) {
guac_terminal_operation* current = current_row; guac_terminal_display_char* current = current_row;
for (column=0; column<w; column++) { for (column=0; column<w; column++) {
/* Store operation */ /* Store operation */
current->type = GUAC_CHAR_SET; current->next.type = GUAC_CHAR_SET;
current->character = *character; current->next.character = *character;
/* Next column */ /* Next column */
current++; current++;
@ -645,24 +657,24 @@ void guac_terminal_delta_set_rect(guac_terminal_delta* delta,
} }
/* Next row */ /* Next row */
current_row += delta->width; current_row += display->width;
} }
} }
void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta, void __guac_terminal_display_flush_copy(guac_terminal_display* display,
guac_terminal* terminal) { guac_terminal* terminal) {
guac_terminal_operation* current = delta->operations; guac_terminal_display_char* current = display->characters;
int row, col; int row, col;
/* For each operation */ /* For each operation */
for (row=0; row<delta->height; row++) { for (row=0; row<display->height; row++) {
for (col=0; col<delta->width; col++) { for (col=0; col<display->width; col++) {
/* If operation is a copy operation */ /* If operation is a copy operation */
if (current->type == GUAC_CHAR_COPY) { if (current->next.type == GUAC_CHAR_COPY) {
/* The determined bounds of the rectangle of contiguous /* The determined bounds of the rectangle of contiguous
* operations */ * operations */
@ -680,23 +692,23 @@ void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta,
int expected_row, expected_col; int expected_row, expected_col;
/* Current row within a subrect */ /* Current row within a subrect */
guac_terminal_operation* rect_current_row; guac_terminal_display_char* rect_current_row;
/* Determine bounds of rectangle */ /* Determine bounds of rectangle */
rect_current_row = current; rect_current_row = current;
expected_row = current->row; expected_row = current->next.row;
for (rect_row=row; rect_row<delta->height; rect_row++) { for (rect_row=row; rect_row<display->height; rect_row++) {
guac_terminal_operation* rect_current = rect_current_row; guac_terminal_display_char* rect_current = rect_current_row;
expected_col = current->column; expected_col = current->next.column;
/* Find width */ /* Find width */
for (rect_col=col; rect_col<delta->width; rect_col++) { for (rect_col=col; rect_col<display->width; rect_col++) {
/* If not identical operation, stop */ /* If not identical operation, stop */
if (rect_current->type != GUAC_CHAR_COPY if (rect_current->next.type != GUAC_CHAR_COPY
|| rect_current->row != expected_row || rect_current->next.row != expected_row
|| rect_current->column != expected_col) || rect_current->next.column != expected_col)
break; break;
/* Next column */ /* Next column */
@ -717,7 +729,7 @@ void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta,
detected_right = rect_col - 1; detected_right = rect_col - 1;
/* Next row */ /* Next row */
rect_current_row += delta->width; rect_current_row += display->width;
expected_row++; expected_row++;
} }
@ -728,19 +740,19 @@ void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta,
/* Mark rect as NOP (as it has been handled) */ /* Mark rect as NOP (as it has been handled) */
rect_current_row = current; rect_current_row = current;
expected_row = current->row; expected_row = current->next.row;
for (rect_row=0; rect_row<rect_height; rect_row++) { for (rect_row=0; rect_row<rect_height; rect_row++) {
guac_terminal_operation* rect_current = rect_current_row; guac_terminal_display_char* rect_current = rect_current_row;
expected_col = current->column; expected_col = current->next.column;
for (rect_col=0; rect_col<rect_width; rect_col++) { for (rect_col=0; rect_col<rect_width; rect_col++) {
/* Mark copy operations as NOP */ /* Mark copy operations as NOP */
if (rect_current->type == GUAC_CHAR_COPY if (rect_current->next.type == GUAC_CHAR_COPY
&& rect_current->row == expected_row && rect_current->next.row == expected_row
&& rect_current->column == expected_col) && rect_current->next.column == expected_col)
rect_current->type = GUAC_CHAR_NOP; rect_current->next.type = GUAC_CHAR_NOP;
/* Next column */ /* Next column */
rect_current++; rect_current++;
@ -749,7 +761,7 @@ void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta,
} }
/* Next row */ /* Next row */
rect_current_row += delta->width; rect_current_row += display->width;
expected_row++; expected_row++;
} }
@ -758,8 +770,8 @@ void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta,
guac_protocol_send_copy(terminal->client->socket, guac_protocol_send_copy(terminal->client->socket,
GUAC_DEFAULT_LAYER, GUAC_DEFAULT_LAYER,
current->column * terminal->char_width, current->next.column * terminal->char_width,
current->row * terminal->char_height, current->next.row * terminal->char_height,
rect_width * terminal->char_width, rect_width * terminal->char_width,
rect_height * terminal->char_height, rect_height * terminal->char_height,
@ -779,19 +791,19 @@ void __guac_terminal_delta_flush_copy(guac_terminal_delta* delta,
} }
void __guac_terminal_delta_flush_clear(guac_terminal_delta* delta, void __guac_terminal_display_flush_clear(guac_terminal_display* display,
guac_terminal* terminal) { guac_terminal* terminal) {
guac_terminal_operation* current = delta->operations; guac_terminal_display_char* current = display->characters;
int row, col; int row, col;
/* For each operation */ /* For each operation */
for (row=0; row<delta->height; row++) { for (row=0; row<display->height; row++) {
for (col=0; col<delta->width; col++) { for (col=0; col<display->width; col++) {
/* If operation is a cler operation (set to space) */ /* If operation is a cler operation (set to space) */
if (current->type == GUAC_CHAR_SET && if (current->next.type == GUAC_CHAR_SET &&
current->character.value == ' ') { current->next.character.value == ' ') {
/* The determined bounds of the rectangle of contiguous /* The determined bounds of the rectangle of contiguous
* operations */ * operations */
@ -806,35 +818,37 @@ void __guac_terminal_delta_flush_clear(guac_terminal_delta* delta,
/* Color of the rectangle to draw */ /* Color of the rectangle to draw */
int color; int color;
if (current->character.attributes.reverse) if (current->next.character.attributes.reverse)
color = current->character.attributes.foreground; color = current->next.character.attributes.foreground;
else else
color = current->character.attributes.background; color = current->next.character.attributes.background;
const guac_terminal_color* guac_color = const guac_terminal_color* guac_color =
&guac_terminal_palette[color]; &guac_terminal_palette[color];
/* Current row within a subrect */ /* Current row within a subrect */
guac_terminal_operation* rect_current_row; guac_terminal_display_char* rect_current_row;
/* Determine bounds of rectangle */ /* Determine bounds of rectangle */
rect_current_row = current; rect_current_row = current;
for (rect_row=row; rect_row<delta->height; rect_row++) { for (rect_row=row; rect_row<display->height; rect_row++) {
guac_terminal_operation* rect_current = rect_current_row; guac_terminal_display_char* rect_current = rect_current_row;
/* Find width */ /* Find width */
for (rect_col=col; rect_col<delta->width; rect_col++) { for (rect_col=col; rect_col<display->width; rect_col++) {
int joining_color; int joining_color;
if (rect_current->character.attributes.reverse) if (rect_current->next.character.attributes.reverse)
joining_color = current->character.attributes.foreground; joining_color =
current->next.character.attributes.foreground;
else else
joining_color = current->character.attributes.background; joining_color =
current->next.character.attributes.background;
/* If not identical operation, stop */ /* If not identical operation, stop */
if (rect_current->type != GUAC_CHAR_SET if (rect_current->next.type != GUAC_CHAR_SET
|| rect_current->character.value != ' ' || rect_current->next.character.value != ' '
|| joining_color != color) || joining_color != color)
break; break;
@ -855,7 +869,7 @@ void __guac_terminal_delta_flush_clear(guac_terminal_delta* delta,
detected_right = rect_col - 1; detected_right = rect_col - 1;
/* Next row */ /* Next row */
rect_current_row += delta->width; rect_current_row += display->width;
} }
@ -867,21 +881,23 @@ void __guac_terminal_delta_flush_clear(guac_terminal_delta* delta,
rect_current_row = current; rect_current_row = current;
for (rect_row=0; rect_row<rect_height; rect_row++) { for (rect_row=0; rect_row<rect_height; rect_row++) {
guac_terminal_operation* rect_current = rect_current_row; guac_terminal_display_char* rect_current = rect_current_row;
for (rect_col=0; rect_col<rect_width; rect_col++) { for (rect_col=0; rect_col<rect_width; rect_col++) {
int joining_color; int joining_color;
if (rect_current->character.attributes.reverse) if (rect_current->next.character.attributes.reverse)
joining_color = current->character.attributes.foreground; joining_color =
current->next.character.attributes.foreground;
else else
joining_color = current->character.attributes.background; joining_color =
current->next.character.attributes.background;
/* Mark clear operations as NOP */ /* Mark clear operations as NOP */
if (rect_current->type == GUAC_CHAR_SET if (rect_current->next.type == GUAC_CHAR_SET
&& rect_current->character.value == ' ' && rect_current->next.character.value == ' '
&& joining_color == color) && joining_color == color)
rect_current->type = GUAC_CHAR_NOP; rect_current->next.type = GUAC_CHAR_NOP;
/* Next column */ /* Next column */
rect_current++; rect_current++;
@ -889,7 +905,7 @@ void __guac_terminal_delta_flush_clear(guac_terminal_delta* delta,
} }
/* Next row */ /* Next row */
rect_current_row += delta->width; rect_current_row += display->width;
} }
@ -917,29 +933,29 @@ void __guac_terminal_delta_flush_clear(guac_terminal_delta* delta,
} }
void __guac_terminal_delta_flush_set(guac_terminal_delta* delta, void __guac_terminal_display_flush_set(guac_terminal_display* display,
guac_terminal* terminal) { guac_terminal* terminal) {
guac_terminal_operation* current = delta->operations; guac_terminal_display_char* current = display->characters;
int row, col; int row, col;
/* For each operation */ /* For each operation */
for (row=0; row<delta->height; row++) { for (row=0; row<display->height; row++) {
for (col=0; col<delta->width; col++) { for (col=0; col<display->width; col++) {
/* Perform given operation */ /* Perform given operation */
if (current->type == GUAC_CHAR_SET) { if (current->next.type == GUAC_CHAR_SET) {
/* Set attributes */ /* Set attributes */
__guac_terminal_set_colors(terminal, __guac_terminal_set_colors(terminal,
&(current->character.attributes)); &(current->next.character.attributes));
/* Send character */ /* Send character */
__guac_terminal_set(terminal, row, col, __guac_terminal_set(terminal, row, col,
current->character.value); current->next.character.value);
/* Mark operation as handled */ /* Mark operation as handled */
current->type = GUAC_CHAR_NOP; current->next.type = GUAC_CHAR_NOP;
} }
@ -951,17 +967,17 @@ void __guac_terminal_delta_flush_set(guac_terminal_delta* delta,
} }
void guac_terminal_delta_flush(guac_terminal_delta* delta, void guac_terminal_display_flush(guac_terminal_display* display,
guac_terminal* terminal) { guac_terminal* terminal) {
/* Flush copy operations first */ /* Flush copy operations first */
__guac_terminal_delta_flush_copy(delta, terminal); __guac_terminal_display_flush_copy(display, terminal);
/* Flush clear operations (as they're just rects) */ /* Flush clear operations (as they're just rects) */
__guac_terminal_delta_flush_clear(delta, terminal); __guac_terminal_display_flush_clear(display, terminal);
/* Flush set operations (the only operations remaining) */ /* Flush set operations (the only operations remaining) */
__guac_terminal_delta_flush_set(delta, terminal); __guac_terminal_display_flush_set(display, terminal);
} }