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

GUAC-653: Separate terminal API into public/internal/low-level pieces (in spirit).

Browse Source
This commit is contained in:
Michael Jumper 2014-05-06 15:55:30 -07:00
parent f2781ed0cc
commit 81229d9fe4
1 changed files with 46 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
src/terminal/terminal.h
View File

@ -298,16 +298,55 @@ guac_terminal* guac_terminal_create(guac_client* client,
const char* font_name, int font_size, int dpi, const char* font_name, int font_size, int dpi,
int width, int height); int width, int height);
/**
* Resets the state of the given terminal, as if it were just allocated.
*/
void guac_terminal_reset(guac_terminal* term);
/** /**
* Frees all resources associated with the given terminal. * Frees all resources associated with the given terminal.
*/ */
void guac_terminal_free(guac_terminal* term); void guac_terminal_free(guac_terminal* term);
/**
* Acquires exclusive access to the terminal. Note that enforcing this
* exclusive access requires that ALL users of the terminal call this
* function before making further calls to the terminal.
*/
void guac_terminal_lock(guac_terminal* terminal);
/**
* Releases exclusive access to the terminal.
*/
void guac_terminal_unlock(guac_terminal* terminal);
/**
* Handles the given key event, sending data, scrolling, pasting clipboard
* data, etc. as necessary.
*/
int guac_terminal_send_key(guac_terminal* term, int keysym, int pressed);
/**
* Handles the given mouse event, sending data, scrolling, pasting clipboard
* data, etc. as necessary.
*/
int guac_terminal_send_mouse(guac_terminal* term, int x, int y, int mask);
/**
* Clears the current clipboard contents and sets the mimetype for future
* contents.
*/
void guac_terminal_clipboard_reset(guac_terminal* term, const char* mimetype);
/**
* Appends the given data to the current clipboard.
*/
void guac_terminal_clipboard_append(guac_terminal* term, const void* data, int length);
/* INTERNAL FUNCTIONS */
/**
* Resets the state of the given terminal, as if it were just allocated.
*/
void guac_terminal_reset(guac_terminal* term);
/** /**
* Writes the given string of characters to the terminal. * Writes the given string of characters to the terminal.
*/ */
@ -380,8 +419,10 @@ void guac_terminal_select_update(guac_terminal* terminal, int row, int column);
*/ */
void guac_terminal_select_end(guac_terminal* terminal, char* string); void guac_terminal_select_end(guac_terminal* terminal, char* string);
/* LOW-LEVEL TERMINAL OPERATIONS */ /* LOW-LEVEL TERMINAL OPERATIONS */
/** /**
* Copies the given range of columns to a new location, offset from * Copies the given range of columns to a new location, offset from
* the original by the given number of columns. * the original by the given number of columns.
@ -413,18 +454,6 @@ int guac_terminal_resize(guac_terminal* term, int width, int height);
*/ */
void guac_terminal_flush(guac_terminal* terminal); void guac_terminal_flush(guac_terminal* terminal);
/**
* Acquires exclusive access to the terminal. Note that enforcing this
* exclusive access requires that ALL users of the terminal call this
* function before making further calls to the terminal.
*/
void guac_terminal_lock(guac_terminal* terminal);
/**
* Releases exclusive access to the terminal.
*/
void guac_terminal_unlock(guac_terminal* terminal);
/** /**
* Sends the given string as if typed by the user. * Sends the given string as if typed by the user.
*/ */
@ -435,29 +464,6 @@ int guac_terminal_send_data(guac_terminal* term, const char* data, int length);
*/ */
int guac_terminal_send_string(guac_terminal* term, const char* data); int guac_terminal_send_string(guac_terminal* term, const char* data);
/**
* Handles the given key event, sending data, scrolling, pasting clipboard
* data, etc. as necessary.
*/
int guac_terminal_send_key(guac_terminal* term, int keysym, int pressed);
/**
* Handles the given mouse event, sending data, scrolling, pasting clipboard
* data, etc. as necessary.
*/
int guac_terminal_send_mouse(guac_terminal* term, int x, int y, int mask);
/**
* Clears the current clipboard contents and sets the mimetype for future
* contents.
*/
void guac_terminal_clipboard_reset(guac_terminal* term, const char* mimetype);
/**
* Appends the given data to the current clipboard.
*/
void guac_terminal_clipboard_append(guac_terminal* term, const void* data, int length);
/** /**
* Sends data through STDIN as if typed by the user, using the format * Sends data through STDIN as if typed by the user, using the format
* string given and any args (similar to printf). * string given and any args (similar to printf).