guacamole-spice-protocol/protocols/ssh/include/terminal.h

506 lines
12 KiB
C

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is libguac-client-ssh.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2011
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef _SSH_GUAC_TERMINAL_H
#define _SSH_GUAC_TERMINAL_H
#include <stdbool.h>
#include <pango/pangocairo.h>
#include <guacamole/client.h>
typedef struct guac_terminal guac_terminal;
/**
* Handler for characters printed to the terminal. When a character is printed,
* the current char handler for the terminal is called and given that
* character.
*/
typedef int guac_terminal_char_handler(guac_terminal* term, char c);
/**
* An RGB color, where each component ranges from 0 to 255.
*/
typedef struct guac_terminal_color {
/**
* The red component of this color.
*/
int red;
/**
* The green component of this color.
*/
int green;
/**
* The blue component of this color.
*/
int blue;
} guac_terminal_color;
/**
* Terminal attributes, as can be applied to a single character.
*/
typedef struct guac_terminal_attributes {
/**
* Whether the character should be rendered bold.
*/
bool bold;
/**
* Whether the character should be rendered with reversed colors
* (background becomes foreground and vice-versa).
*/
bool reverse;
/**
* Whether to render the character with underscore.
*/
bool underscore;
/**
* The foreground color of this character, as a palette index.
*/
int foreground;
/**
* The background color of this character, as a palette index.
*/
int background;
} guac_terminal_attributes;
/**
* The available color palette. All integer colors within structures
* here are indices into this palette.
*/
extern const guac_terminal_color guac_terminal_palette[16];
/**
* Represents a single character for display in a terminal, including actual
* character value, foreground color, and background color.
*/
typedef struct guac_terminal_char {
/**
* The character value of the character to display.
*/
char value;
/**
* The attributes of the character to display.
*/
guac_terminal_attributes attributes;
} guac_terminal_char;
/**
* All available terminal operations which affect character cells.
*/
typedef enum guac_terminal_operation_type {
/**
* Operation which does nothing.
*/
GUAC_CHAR_NOP,
/**
* Operation which copies a character from a given row/column coordinate.
*/
GUAC_CHAR_COPY,
/**
* Operation which sets the character and attributes.
*/
GUAC_CHAR_SET
} guac_terminal_operation_type;
/**
* A pairing of a guac_terminal_operation_type and all parameters required by
* that operation type.
*/
typedef struct guac_terminal_operation {
/**
* The type of operation to perform.
*/
guac_terminal_operation_type type;
/**
* The character (and attributes) to set the current location to. This is
* only applicable to GUAC_CHAR_SET.
*/
guac_terminal_char character;
/**
* The row to copy a character from. This is only applicable to
* GUAC_CHAR_COPY.
*/
int row;
/**
* The column to copy a character from. This is only applicable to
* GUAC_CHAR_COPY.
*/
int column;
} guac_terminal_operation;
/**
* Set of all pending operations for the currently-visible screen area.
*/
typedef struct guac_terminal_delta {
/**
* Array of all operations pending for the visible screen area.
*/
guac_terminal_operation* operations;
/**
* The width of the screen, in characters.
*/
int width;
/**
* The height of the screen, in characters.
*/
int height;
} guac_terminal_delta;
/**
* Dynamically-resizable character buffer.
*/
typedef struct guac_terminal_buffer {
/**
* Array of characters.
*/
guac_terminal_char* characters;
/**
* The width of this buffer in characters.
*/
int width;
/**
* The height of this buffer in characters.
*/
int height;
} guac_terminal_buffer;
/**
* Represents a terminal emulator which uses a given Guacamole client to
* render itself.
*/
struct guac_terminal {
/**
* The Guacamole client this terminal emulator will use for rendering.
*/
guac_client* client;
/**
* The description of the font to use for rendering.
*/
PangoFontDescription* font_desc;
/**
* Index of next glyph to create
*/
int next_glyph;
/**
* Index of locations for each glyph in the stroke and fill layers.
*/
int glyphs[256];
/**
* Color of glyphs in copy buffer
*/
int glyph_foreground;
/**
* Color of glyphs in copy buffer
*/
int glyph_background;
/**
* A single wide layer holding each glyph, with each glyph only
* colored with foreground color (background remains transparent).
*/
guac_layer* glyph_stroke;
/**
* A single wide layer holding each glyph, with each glyph properly
* colored with foreground and background color (no transparency at all).
*/
guac_layer* filled_glyphs;
/**
* Array of scrollback buffer rows, where each row is an array of
* characters.
*/
guac_terminal_char** scrollback;
/**
* The width of each character, in pixels.
*/
int char_width;
/**
* The height of each character, in pixels.
*/
int char_height;
/**
* The width of the terminal, in characters.
*/
int term_width;
/**
* The height of the terminal, in characters.
*/
int term_height;
/**
* The index of the first row in the scrolling region.
*/
int scroll_start;
/**
* The index of the last row in the scrolling region.
*/
int scroll_end;
/**
* The current row location of the cursor.
*/
int cursor_row;
/**
* The current column location of the cursor.
*/
int cursor_col;
/**
* The attributes which will be applied to future characters.
*/
guac_terminal_attributes current_attributes;
/**
* The attributes which will be applied to characters by default, unless
* other attributes are explicitly specified.
*/
guac_terminal_attributes default_attributes;
/**
* Handler which will receive all printed characters, updating the terminal
* accordingly.
*/
guac_terminal_char_handler* char_handler;
/**
* The difference between the currently-rendered screen and the current
* state of the terminal.
*/
guac_terminal_delta* delta;
/**
* Current terminal display state. All characters present on the screen
* are within this buffer. This has nothing to do with the delta, which
* facilitates transfer of a set of changes to the remote display.
*/
guac_terminal_buffer* buffer;
};
/**
* Creates a new guac_terminal, having the given width and height, and
* rendering to the given client.
*/
guac_terminal* guac_terminal_create(guac_client* client,
int width, int height);
/**
* Frees all resources associated with the given terminal.
*/
void guac_terminal_free(guac_terminal* term);
/**
* Writes the given string of characters to the terminal.
*/
int guac_terminal_write(guac_terminal* term, const char* c, int size);
/**
* Sets the character at the given row and column to the specified value.
*/
int guac_terminal_set(guac_terminal* term, int row, int col, char c);
/**
* Copies a rectangular region of characters which may overlap with the
* destination.
*/
int guac_terminal_copy(guac_terminal* term,
int src_row, int src_col, int rows, int cols,
int dst_row, int dst_col);
/**
* Clears a rectangular region of characters, replacing them with the
* current background color and attributes.
*/
int guac_terminal_clear(guac_terminal* term,
int row, int col, int rows, int cols);
/**
* Clears the given region from right-to-left, top-to-bottom, replacing
* all characters with the current background color and attributes.
*/
int guac_terminal_clear_range(guac_terminal* term,
int start_row, int start_col,
int end_row, int end_col);
/**
* Scrolls the terminal's current scroll region up by one row.
*/
int guac_terminal_scroll_up(guac_terminal* term,
int start_row, int end_row, int amount);
/**
* Scrolls the terminal's current scroll region down by one row.
*/
int guac_terminal_scroll_down(guac_terminal* term,
int start_row, int end_row, int amount);
/**
* Toggles the reverse attribute of the character at the given location.
*/
int guac_terminal_toggle_reverse(guac_terminal* term, int row, int col);
/**
* Allocates a new guac_terminal_delta.
*/
guac_terminal_delta* guac_terminal_delta_alloc(int width, int height);
/**
* Frees the given guac_terminal_delta.
*/
void guac_terminal_delta_free(guac_terminal_delta* delta);
/**
* Resizes the given guac_terminal_delta to the given dimensions.
*/
void guac_terminal_delta_resize(guac_terminal_delta* delta,
int width, int height);
/**
* Stores a set operation at the given location.
*/
void guac_terminal_delta_set(guac_terminal_delta* delta, int r, int c,
guac_terminal_char* character);
/**
* Stores a rectangle of copy operations, copying existing operations as
* necessary.
*/
void guac_terminal_delta_copy(guac_terminal_delta* delta,
int dst_row, int dst_column,
int src_row, int src_column,
int w, int h);
/**
* Sets a rectangle of character data to the given character value.
*/
void guac_terminal_delta_set_rect(guac_terminal_delta* delta,
int row, int column, int w, int h,
guac_terminal_char* character);
/**
* Flushes all pending operations within the given guac_client_delta to the
* given guac_terminal.
*/
void guac_terminal_delta_flush(guac_terminal_delta* delta,
guac_terminal* terminal);
/**
* Allocates a new character buffer having the given dimensions.
*/
guac_terminal_buffer* guac_terminal_buffer_alloc(int width, int height);
/**
* Resizes the given character buffer to the given dimensions.
*/
void guac_terminal_buffer_resize(guac_terminal_buffer* buffer,
int width, int height);
/**
* Sets the character at the given location within the buffer to the given
* value.
*/
void guac_terminal_buffer_set(guac_terminal_buffer* buffer, int r, int c,
guac_terminal_char* character);
/**
* Copies a rectangle of character data within the buffer. The source and
* destination may overlap.
*/
void guac_terminal_buffer_copy(guac_terminal_buffer* buffer,
int dst_row, int dst_column,
int src_row, int src_column,
int w, int h);
/**
* Sets a rectangle of character data to the given character value.
*/
void guac_terminal_buffer_set_rect(guac_terminal_buffer* buffer,
int row, int column, int w, int h,
guac_terminal_char* character);
/**
* Frees the given character buffer.
*/
void guac_terminal_buffer_free(guac_terminal_buffer* buffer);
#endif