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

GUAC-1389: Update comments to match latest standard.

Browse Source
This commit is contained in:
Michael Jumper 2016-03-07 15:05:31 -08:00
parent 5a6c16ab24
commit 12f166c0fc
16 changed files with 355 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
src/protocols/rdp/rdp_bitmap.h
View File

@ -64,16 +64,22 @@ typedef struct guac_rdp_bitmap {
* destroyed, we defer actual remote-side caching of RDP bitmaps until they are
* used at least once.
*
* @param context The rdpContext associated with the current RDP session.
* @param bitmap The bitmap to cache.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The bitmap to cache.
*/
void guac_rdp_cache_bitmap(rdpContext* context, rdpBitmap* bitmap);
/**
* Initializes the given newly-created rdpBitmap.
*
* @param context The rdpContext associated with the current RDP session.
* @param bitmap The bitmap to initialize.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The bitmap to initialize.
*/
void guac_rdp_bitmap_new(rdpContext* context, rdpBitmap* bitmap);
@ -82,7 +88,8 @@ void guac_rdp_bitmap_new(rdpContext* context, rdpBitmap* bitmap);
* operation does NOT draw to the "current" surface set by calls to
* guac_rdp_bitmap_setsurface().
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The bitmap to paint. This structure will also contain the specifics of
@ -94,8 +101,11 @@ void guac_rdp_bitmap_paint(rdpContext* context, rdpBitmap* bitmap);
/**
* Frees any Guacamole-specific data associated with the given rdpBitmap.
*
* @param context The rdpContext associated with the current RDP session.
* @param bitmap The bitmap whose Guacamole-specific data is to be freed.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The bitmap whose Guacamole-specific data is to be freed.
*/
void guac_rdp_bitmap_free(rdpContext* context, rdpBitmap* bitmap);
@ -104,7 +114,8 @@ void guac_rdp_bitmap_free(rdpContext* context, rdpBitmap* bitmap);
* if the primary flag is set, resets the current drawing surface to the
* primary drawing surface of the remote display.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The rdpBitmap to set as the current drawing surface. This parameter is
@ -125,17 +136,29 @@ void guac_rdp_bitmap_setsurface(rdpContext* context, rdpBitmap* bitmap,
* received data is not compressed, it is the duty of this function to also
* flip received data, if the row order is backwards.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The bitmap in which the decompressed/copied data should be stored.
*
* @param data Possibly-compressed image data.
* @param width The width of the image data, in pixels.
* @param height The height of the image data, in pixels.
* @param bpp The number of bits per pixel in the image data.
* @param length The length of the image data, in bytes.
* @param compressed TRUE if the image data is compressed, FALSE otherwise.
* @param data
* Possibly-compressed image data.
*
* @param width
* The width of the image data, in pixels.
*
* @param height
* The height of the image data, in pixels.
*
* @param bpp
* The number of bits per pixel in the image data.
*
* @param length
* The length of the image data, in bytes.
*
* @param compressed
* TRUE if the image data is compressed, FALSE otherwise.
*/
void guac_rdp_bitmap_decompress(rdpContext* context, rdpBitmap* bitmap,
UINT8* data, int width, int height, int bpp, int length,
@ -147,17 +170,29 @@ void guac_rdp_bitmap_decompress(rdpContext* context, rdpBitmap* bitmap,
* received data is not compressed, it is the duty of this function to also
* flip received data, if the row order is backwards.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bitmap
* The bitmap in which the decompressed/copied data should be stored.
*
* @param data Possibly-compressed image data.
* @param width The width of the image data, in pixels.
* @param height The height of the image data, in pixels.
* @param bpp The number of bits per pixel in the image data.
* @param length The length of the image data, in bytes.
* @param compressed TRUE if the image data is compressed, FALSE otherwise.
* @param data
* Possibly-compressed image data.
*
* @param width
* The width of the image data, in pixels.
*
* @param height
* The height of the image data, in pixels.
*
* @param bpp
* The number of bits per pixel in the image data.
*
* @param length
* The length of the image data, in bytes.
*
* @param compressed
* TRUE if the image data is compressed, FALSE otherwise.
*
* @param codec_id
* The ID of the codec used to compress the image data. This parameter is

4
src/protocols/rdp/rdp_cliprdr.c
View File

@ -116,7 +116,9 @@ void guac_rdp_process_cb_monitor_ready(guac_client* client, wMessage* event) {
/**
* Sends a clipboard data request for the given format.
*
* @param client The guac_client associated with the current RDP session.
* @param client
* The guac_client associated with the current RDP session.
*
* @param format
* The clipboard format to request. This format must be one of the
* documented values used by the CLIPRDR channel for clipboard format IDs.

19
src/protocols/rdp/rdp_cliprdr.h
View File

@ -55,8 +55,11 @@
* received. This function will dispatch that message to an appropriate
* function, specific to that message type.
*
* @param client The guac_client associated with the current RDP session.
* @param event The received CLIPRDR message.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The received CLIPRDR message.
*/
void guac_rdp_process_cliprdr_event(guac_client* client, wMessage* event);
@ -65,7 +68,8 @@ void guac_rdp_process_cliprdr_event(guac_client* client, wMessage* event);
* is the responsibility of this function to respond to the Monitor Ready
* event with a list of supported clipboard formats.
*
* @param client The guac_client associated with the current RDP session.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The received CLIPRDR message, which must be a Monitor Ready event.
@ -78,7 +82,8 @@ void guac_rdp_process_cb_monitor_ready(guac_client* client, wMessage* event);
* event with a request for clipboard data in one of the enumerated formats.
* This event is fired whenever remote clipboard data is available.
*
* @param client The guac_client associated with the current RDP session.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The received CLIPRDR message, which must be a Format List event.
@ -91,7 +96,8 @@ void guac_rdp_process_cb_format_list(guac_client* client,
* is the responsibility of this function to respond to the Data Request
* event with a data response containing the current clipoard contents.
*
* @param client The guac_client associated with the current RDP session.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The received CLIPRDR message, which must be a Data Request event.
@ -104,7 +110,8 @@ void guac_rdp_process_cb_data_request(guac_client* client,
* is the responsibility of this function to read and forward the received
* clipboard data to connected clients.
*
* @param client The guac_client associated with the current RDP session.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The received CLIPRDR message, which must be a Data Response event.

8
src/protocols/rdp/rdp_color.h
View File

@ -36,8 +36,12 @@
* referring to the palette, a 16-bit or 32-bit color, etc. all depending on
* the current color depth of the RDP session.
*
* @param context The rdpContext associated with the current RDP session.
* @param color A color value in the format of the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param color
* A color value in the format of the current RDP session.
*
* @return
* A 32-bit ARGB color, where the low 8 bits are the blue component and
* the high 8 bits are alpha.

3
src/protocols/rdp/rdp_fs.c
View File

@ -113,7 +113,8 @@ void* guac_rdp_fs_expose(guac_user* user, void* data) {
* on the path provided, which is assumed to have already been normalized and
* validated as absolute.
*
* @param fs The filesystem containing the file whose path is being translated.
* @param fs
* The filesystem containing the file whose path is being translated.
*
* @param virtual_path
* The absolute path to the file on the simulated filesystem, relative to

112
src/protocols/rdp/rdp_fs.h
View File

@ -340,7 +340,8 @@ guac_rdp_fs* guac_rdp_fs_alloc(guac_client* client, const char* drive_path,
/**
* Frees the given filesystem.
*
* @param fs The filesystem to free.
* @param fs
* The filesystem to free.
*/
void guac_rdp_fs_free(guac_rdp_fs* fs);
@ -392,9 +393,14 @@ void* guac_rdp_fs_expose(guac_user* user, void* data);
* Converts the given relative path to an absolute path based on the given
* parent path. If the path cannot be converted, non-zero is returned.
*
* @param parent The parent directory of the relative path.
* @param rel_path The relative path to convert.
* @return Zero if the path was converted successfully, non-zero otherwise.
* @param parent
* The parent directory of the relative path.
*
* @param rel_path
* The relative path to convert.
*
* @return
* Zero if the path was converted successfully, non-zero otherwise.
*/
int guac_rdp_fs_convert_path(const char* parent, const char* rel_path,
char* abs_path);
@ -402,7 +408,8 @@ int guac_rdp_fs_convert_path(const char* parent, const char* rel_path,
/**
* Translates the given errno error code to a GUAC_RDP_FS error code.
*
* @param err The error code, as returned within errno by a system call.
* @param err
* The error code, as returned within errno by a system call.
*
* @return
* A GUAC_RDP_FS error code, such as GUAC_RDP_FS_ENFILE,
@ -428,8 +435,11 @@ int guac_rdp_fs_get_status(int err);
* than zero if an error occurs. The given path MUST be absolute, and will be
* translated to be relative to the drive path of the simulated filesystem.
*
* @param fs The filesystem to use when opening the file.
* @param path The absolute path to the file within the simulated filesystem.
* @param fs
* The filesystem to use when opening the file.
*
* @param path
* The absolute path to the file within the simulated filesystem.
*
* @param access
* A bitwise-OR of various RDPDR access flags, such as ACCESS_GENERIC_ALL
@ -466,14 +476,20 @@ int guac_rdp_fs_open(guac_rdp_fs* fs, const char* path,
* file having the given ID. Returns the number of bytes read, zero on EOF,
* and an error code if an error occurs.
*
* @param fs The filesystem containing the file from which data is to be read.
* @param fs
* The filesystem containing the file from which data is to be read.
*
* @param file_id
* The ID of the file to read data from, as returned by guac_rdp_fs_open().
*
* @param offset The byte offset within the file to start reading from.
* @param buffer The buffer to fill with data from the file.
* @param length The maximum number of bytes to read from the file.
* @param offset
* The byte offset within the file to start reading from.
*
* @param buffer
* The buffer to fill with data from the file.
*
* @param length
* The maximum number of bytes to read from the file.
*
* @return
* The number of bytes actually read, zero on EOF, or an error code if an
@ -488,14 +504,20 @@ int guac_rdp_fs_read(guac_rdp_fs* fs, int file_id, int offset,
* file having the given ID. Returns the number of bytes written, and an
* error code if an error occurs.
*
* @param fs The filesystem containing the file to which data is to be written.
* @param fs
* The filesystem containing the file to which data is to be written.
*
* @param file_id
* The ID of the file to write data to, as returned by guac_rdp_fs_open().
*
* @param offset The byte offset within the file to start writinging at.
* @param buffer The buffer containing the data to write.
* @param length The maximum number of bytes to write to the file.
* @param offset
* The byte offset within the file to start writinging at.
*
* @param buffer
* The buffer containing the data to write.
*
* @param length
* The maximum number of bytes to write to the file.
*
* @return
* The number of bytes actually written, or an error code if an error
@ -509,12 +531,14 @@ int guac_rdp_fs_write(guac_rdp_fs* fs, int file_id, int offset,
* Renames (moves) the file with the given ID to the new path specified.
* Returns zero on success, or an error code if an error occurs.
*
* @param fs The filesystem containing the file to rename.
* @param fs
* The filesystem containing the file to rename.
*
* @param file_id
* The ID of the file to rename, as returned by guac_rdp_fs_open().
*
* @param new_path The absolute path to move the file to.
* @param new_path
* The absolute path to move the file to.
*
* @return
* Zero if the rename succeeded, or an error code if an error occurs. All
@ -527,7 +551,8 @@ int guac_rdp_fs_rename(guac_rdp_fs* fs, int file_id,
/**
* Deletes the file with the given ID.
*
* @param fs The filesystem containing the file to delete.
* @param fs
* The filesystem containing the file to delete.
*
* @param file_id
* The ID of the file to delete, as returned by guac_rdp_fs_open().
@ -543,7 +568,8 @@ int guac_rdp_fs_delete(guac_rdp_fs* fs, int file_id);
* Truncates the file with the given ID to the given length (in bytes), which
* may be larger.
*
* @param fs The filesystem containing the file to truncate.
* @param fs
* The filesystem containing the file to truncate.
*
* @param file_id
* The ID of the file to truncate, as returned by guac_rdp_fs_open().
@ -562,7 +588,8 @@ int guac_rdp_fs_truncate(guac_rdp_fs* fs, int file_id, int length);
/**
* Frees the given file ID, allowing future open operations to reuse it.
*
* @param fs The filesystem containing the file to close.
* @param fs
* The filesystem containing the file to close.
*
* @param file_id
* The ID of the file to close, as returned by guac_rdp_fs_open().
@ -574,12 +601,15 @@ void guac_rdp_fs_close(guac_rdp_fs* fs, int file_id);
* absolute path which does NOT contain ".." or ".". The given path MUST
* be absolute.
*
* @param path The absolute path to normalize.
* @param path
* The absolute path to normalize.
*
* @param abs_path
* The buffer to populate with the normalized path. The normalized path
* will not contain relative path components like ".." or ".".
*
* @return Zero if normalization succeeded, non-zero otherwise.
* @return
* Zero if normalization succeeded, non-zero otherwise.
*/
int guac_rdp_fs_normalize_path(const char* path, char* abs_path);
@ -590,14 +620,16 @@ int guac_rdp_fs_normalize_path(const char* path, char* abs_path);
* @param parent
* The absolute path of the parent directory of the relative path.
*
* @param rel_path The relative path to convert.
* @param rel_path
* The relative path to convert.
*
* @param abs_path
* The buffer to populate with the absolute, normalized path. The
* normalized path will not contain relative path components like ".." or
* ".".
*
* @return Zero if conversion succeeded, non-zero otherwise.
* @return
* Zero if conversion succeeded, non-zero otherwise.
*/
int guac_rdp_fs_convert_path(const char* parent, const char* rel_path,
char* abs_path);
@ -606,7 +638,8 @@ int guac_rdp_fs_convert_path(const char* parent, const char* rel_path,
* Returns the next filename within the directory having the given file ID,
* or NULL if no more files.
*
* @param fs The filesystem containing the file to read directory entries from.
* @param fs
* The filesystem containing the file to read directory entries from.
*
* @param file_id
* The ID of the file to read directory entries from, as returned by
@ -621,9 +654,14 @@ const char* guac_rdp_fs_read_dir(guac_rdp_fs* fs, int file_id);
/**
* Returns the file having the given ID, or NULL if no such file exists.
*
* @param fs The filesystem containing the desired file.
* @param file_id The ID of the desired, as returned by guac_rdp_fs_open().
* @return The file having the given ID, or NULL is no such file exists.
* @param fs
* The filesystem containing the desired file.
*
* @param file_id
* The ID of the desired, as returned by guac_rdp_fs_open().
*
* @return
* The file having the given ID, or NULL is no such file exists.
*/
guac_rdp_fs_file* guac_rdp_fs_get_file(guac_rdp_fs* fs, int file_id);
@ -633,9 +671,14 @@ guac_rdp_fs_file* guac_rdp_fs_get_file(guac_rdp_fs* fs, int file_id);
* function. Backslashes will be interpreted as literal backslashes, not
* escape characters.
*
* @param filename The filename to check
* @param pattern The pattern to check the filename against.
* @return Non-zero if the pattern matches, zero otherwise.
* @param filename
* The filename to check
*
* @param pattern
* The pattern to check the filename against.
*
* @return
* Non-zero if the pattern matches, zero otherwise.
*/
int guac_rdp_fs_matches(const char* filename, const char* pattern);
@ -643,8 +686,11 @@ int guac_rdp_fs_matches(const char* filename, const char* pattern);
* Populates the given structure with information about the filesystem,
* particularly the amount of space available.
*
* @param fs The filesystem to obtain information from.
* @param info The guac_rdp_fs_info structure to populate.
* @param fs
* The filesystem to obtain information from.
*
* @param info
* The guac_rdp_fs_info structure to populate.
*
* @return
* Zero if information retrieval succeeded, or an error code if an error

3
src/protocols/rdp/rdp_gdi.c
View File

@ -344,7 +344,8 @@ void guac_rdp_gdi_opaquerect(rdpContext* context, OPAQUE_RECT_ORDER* opaque_rect
* Updates the palette within a FreeRDP CLRCONV object using the new palette
* entries provided by an RDP palette update.
*
* @param clrconv The FreeRDP CLRCONV object to update.
* @param clrconv
* The FreeRDP CLRCONV object to update.
*
* @param palette
* An RDP palette update message containing the palette to store within the

58
src/protocols/rdp/rdp_gdi.h
View File

@ -35,8 +35,11 @@
*
* http://msdn.microsoft.com/en-us/library/cc241583.aspx
*
* @param client The guac_client associated with the current RDP session.
* @param rop3 The ROP3 operation index to translate.
* @param client
* The guac_client associated with the current RDP session.
*
* @param rop3
* The ROP3 operation index to translate.
*
* @return
* The guac_composite_mode that equates to, or most closely approximates,
@ -48,40 +51,55 @@ guac_composite_mode guac_rdp_rop3_transfer_function(guac_client* client,
/**
* Handler for RDP DSTBLT update.
*
* @param context The rdpContext associated with the current RDP session.
* @param dstblt The DSTBLT update to handle.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param dstblt
* The DSTBLT update to handle.
*/
void guac_rdp_gdi_dstblt(rdpContext* context, DSTBLT_ORDER* dstblt);
/**
* Handler for RDP PATBLT update.
*
* @param context The rdpContext associated with the current RDP session.
* @param patblt The PATBLT update to handle.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param patblt
* The PATBLT update to handle.
*/
void guac_rdp_gdi_patblt(rdpContext* context, PATBLT_ORDER* patblt);
/**
* Handler for RDP SCRBLT update.
*
* @param context The rdpContext associated with the current RDP session.
* @param scrblt The SCRBLT update to handle.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param scrblt
* The SCRBLT update to handle.
*/
void guac_rdp_gdi_scrblt(rdpContext* context, SCRBLT_ORDER* scrblt);
/**
* Handler for RDP MEMBLT update.
*
* @param context The rdpContext associated with the current RDP session.
* @param memblt The MEMBLT update to handle.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param memblt
* The MEMBLT update to handle.
*/
void guac_rdp_gdi_memblt(rdpContext* context, MEMBLT_ORDER* memblt);
/**
* Handler for RDP OPAQUE RECT update.
*
* @param context The rdpContext associated with the current RDP session.
* @param opaque_rect The OPAQUE RECT update to handle.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param opaque_rect
* The OPAQUE RECT update to handle.
*/
void guac_rdp_gdi_opaquerect(rdpContext* context,
OPAQUE_RECT_ORDER* opaque_rect);
@ -89,8 +107,11 @@ void guac_rdp_gdi_opaquerect(rdpContext* context,
/**
* Handler called when the remote color palette is changing.
*
* @param context The rdpContext associated with the current RDP session.
* @param palette The PALETTE update containing the new palette.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param palette
* The PALETTE update containing the new palette.
*/
void guac_rdp_gdi_palette_update(rdpContext* context, PALETTE_UPDATE* palette);
@ -100,7 +121,8 @@ void guac_rdp_gdi_palette_update(rdpContext* context, PALETTE_UPDATE* palette);
* update, but is called by FreeRDP before and after any update involving
* clipping.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param bounds
* The clipping rectangle to set, or NULL to remove any applied clipping
@ -112,7 +134,8 @@ void guac_rdp_gdi_set_bounds(rdpContext* context, rdpBounds* bounds);
* Handler called when a paint operation is complete. We don't actually
* use this, but FreeRDP requires it. Calling this function has no effect.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*/
void guac_rdp_gdi_end_paint(rdpContext* context);
@ -125,7 +148,8 @@ void guac_rdp_gdi_end_paint(rdpContext* context);
* The new screen size will be made available within the settings associated
* with the given context.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*/
void guac_rdp_gdi_desktop_resize(rdpContext* context);

35
src/protocols/rdp/rdp_glyph.h
View File

@ -56,8 +56,11 @@ typedef struct guac_rdp_glyph {
* Caches the given glyph. Note that this caching currently only occurs server-
* side, as it is more efficient to transmit the text as PNG.
*
* @param context The rdpContext associated with the current RDP session.
* @param glyph The glyph to cache.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param glyph
* The glyph to cache.
*/
void guac_rdp_glyph_new(rdpContext* context, rdpGlyph* glyph);
@ -65,10 +68,17 @@ void guac_rdp_glyph_new(rdpContext* context, rdpGlyph* glyph);
* Draws a previously-cached glyph at the given coordinates within the current
* drawing surface.
*
* @param context The rdpContext associated with the current RDP session.
* @param glyph The cached glyph to draw.
* @param x The destination X coordinate of the upper-left corner of the glyph.
* @param y The destination Y coordinate of the upper-left corner of the glyph.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param glyph
* The cached glyph to draw.
*
* @param x
* The destination X coordinate of the upper-left corner of the glyph.
*
* @param y
* The destination Y coordinate of the upper-left corner of the glyph.
*/
void guac_rdp_glyph_draw(rdpContext* context, rdpGlyph* glyph, int x, int y);
@ -76,8 +86,11 @@ void guac_rdp_glyph_draw(rdpContext* context, rdpGlyph* glyph, int x, int y);
* Frees any Guacamole-specific data associated with the given glyph, such that
* it can be safely freed by FreeRDP.
*
* @param context The rdpContext associated with the current RDP session.
* @param glyph The cached glyph to free.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param glyph
* The cached glyph to free.
*/
void guac_rdp_glyph_free(rdpContext* context, rdpGlyph* glyph);
@ -86,7 +99,8 @@ void guac_rdp_glyph_free(rdpContext* context, rdpGlyph* glyph);
* called, the glyphs will be individually rendered by calls to
* guac_rdp_glyph_draw().
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param x
* The X coordinate of the upper-left corner of the background rectangle of
@ -124,7 +138,8 @@ void guac_rdp_glyph_begindraw(rdpContext* context,
* of this function whether the background color is opaque or transparent. We
* currently do NOT implement this function.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param x
* The X coordinate of the upper-left corner of the background rectangle of

17
src/protocols/rdp/rdp_keymap.h
View File

@ -113,8 +113,11 @@ typedef int guac_rdp_keysym_state_map[0x200][0x100];
* Simple macro for determing whether a keysym can be stored (or retrieved)
* from any keymap.
*
* @param keysym The keysym to check.
* @return Non-zero if the keysym can be stored or retrieved, zero otherwise.
* @param keysym
* The keysym to check.
*
* @return
* Non-zero if the keysym can be stored or retrieved, zero otherwise.
*/
#define GUAC_RDP_KEYSYM_STORABLE(keysym) ((keysym) <= 0xFFFF || ((keysym) & 0xFFFF0000) == 0x01000000)
@ -128,7 +131,8 @@ typedef int guac_rdp_keysym_state_map[0x200][0x100];
* A 512-entry array of 256-entry arrays of arbitrary values, where the
* location of each array and value is determined by the given keysym.
*
* @param keysym The keysym of the entry to look up.
* @param keysym
* The keysym of the entry to look up.
*/
#define GUAC_RDP_KEYSYM_LOOKUP(keysym_mapping, keysym) ( \
(keysym_mapping) \
@ -206,8 +210,11 @@ extern const guac_rdp_keymap* GUAC_KEYMAPS[];
/**
* Return the keymap having the given name, if any, or NULL otherwise.
*
* @param name The name of the keymap to find.
* @return The keymap having the given name, or NULL if no such keymap exists.
* @param name
* The name of the keymap to find.
*
* @return
* The keymap having the given name, or NULL if no such keymap exists.
*/
const guac_rdp_keymap* guac_rdp_keymap_find(const char* name);

27
src/protocols/rdp/rdp_pointer.h
View File

@ -50,8 +50,11 @@ typedef struct guac_rdp_pointer {
* Caches a new pointer, which can later be set via guac_rdp_pointer_set() as
* the current mouse pointer.
*
* @param context The rdpContext associated with the current RDP session.
* @param pointer The pointer to cache.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param pointer
* The pointer to cache.
*/
void guac_rdp_pointer_new(rdpContext* context, rdpPointer* pointer);
@ -59,8 +62,11 @@ void guac_rdp_pointer_new(rdpContext* context, rdpPointer* pointer);
* Sets the given cached pointer as the current pointer. The given pointer must
* have already been initialized through a call to guac_rdp_pointer_new().
*
* @param context The rdpContext associated with the current RDP session.
* @param pointer The pointer to set as the current mouse pointer.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param pointer
* The pointer to set as the current mouse pointer.
*/
void guac_rdp_pointer_set(rdpContext* context, rdpPointer* pointer);
@ -68,15 +74,19 @@ void guac_rdp_pointer_set(rdpContext* context, rdpPointer* pointer);
* Frees all Guacamole-related data associated with the given pointer, allowing
* FreeRDP to free the rest safely.
*
* @param context The rdpContext associated with the current RDP session.
* @param pointer The pointer to free.
* @param context
* The rdpContext associated with the current RDP session.
*
* @param pointer
* The pointer to free.
*/
void guac_rdp_pointer_free(rdpContext* context, rdpPointer* pointer);
/**
* Hides the current mouse pointer.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*/
void guac_rdp_pointer_set_null(rdpContext* context);
@ -84,7 +94,8 @@ void guac_rdp_pointer_set_null(rdpContext* context);
* Sets the system-dependent (as in dependent on the client system) default
* pointer as the current pointer, rather than a cached pointer.
*
* @param context The rdpContext associated with the current RDP session.
* @param context
* The rdpContext associated with the current RDP session.
*/
void guac_rdp_pointer_set_default(rdpContext* context);

14
src/protocols/rdp/rdp_rail.h
View File

@ -37,8 +37,11 @@
/**
* Dispatches a given RAIL event to the appropriate handler.
*
* @param client The guac_client associated with the current RDP session.
* @param event The RAIL event to process.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The RAIL event to process.
*/
void guac_rdp_process_rail_event(guac_client* client, wMessage* event);
@ -46,8 +49,11 @@ void guac_rdp_process_rail_event(guac_client* client, wMessage* event);
* Handles the event sent when updating system parameters. The event given
* MUST be a SYSPARAM event.
*
* @param client The guac_client associated with the current RDP session.
* @param event The system parameter event to process.
* @param client
* The guac_client associated with the current RDP session.
*
* @param event
* The system parameter event to process.
*/
void guac_rdp_process_rail_get_sysparam(guac_client* client, wMessage* event);

28
src/protocols/rdp/rdp_settings.h
View File

@ -369,32 +369,44 @@ extern const char* GUAC_RDP_CLIENT_ARGS[];
/**
* Save all given settings to the given freerdp instance.
*
* @param guac_settings The guac_rdp_settings object to save.
* @param rdp The RDP instance to save settings to.
* @param guac_settings
* The guac_rdp_settings object to save.
*
* @param rdp
* The RDP instance to save settings to.
*/
void guac_rdp_push_settings(guac_rdp_settings* guac_settings, freerdp* rdp);
/**
* Returns the width of the RDP session display.
*
* @param rdp The RDP instance to retrieve the width from.
* @return The current width of the RDP display, in pixels.
* @param rdp
* The RDP instance to retrieve the width from.
*
* @return
* The current width of the RDP display, in pixels.
*/
int guac_rdp_get_width(freerdp* rdp);
/**
* Returns the height of the RDP session display.
*
* @param rdp The RDP instance to retrieve the height from.
* @return The current height of the RDP display, in pixels.
* @param rdp
* The RDP instance to retrieve the height from.
*
* @return
* The current height of the RDP display, in pixels.
*/
int guac_rdp_get_height(freerdp* rdp);
/**
* Returns the depth of the RDP session display.
*
* @param rdp The RDP instance to retrieve the depth from.
* @return The current depth of the RDP display, in bits per pixel.
* @param rdp
* The RDP instance to retrieve the depth from.
*
* @return
* The current depth of the RDP display, in bits per pixel.
*/
int guac_rdp_get_depth(freerdp* rdp);

42
src/protocols/rdp/rdp_svc.h
View File

@ -66,16 +66,22 @@ typedef struct guac_rdp_svc {
/**
* Allocate a new SVC with the given name.
*
* @param client The guac_client associated with the current RDP session.
* @param name The name of the virtual channel to allocate.
* @return A newly-allocated static virtual channel.
* @param client
* The guac_client associated with the current RDP session.
*
* @param name
* The name of the virtual channel to allocate.
*
* @return
* A newly-allocated static virtual channel.
*/
guac_rdp_svc* guac_rdp_alloc_svc(guac_client* client, char* name);
/**
* Free the given SVC.
*
* @param svc The static virtual channel to free.
* @param svc
* The static virtual channel to free.
*/
void guac_rdp_free_svc(guac_rdp_svc* svc);
@ -107,7 +113,8 @@ void guac_rdp_svc_send_pipes(guac_user* user);
/**
* Add the given SVC to the list of all available SVCs.
*
* @param client The guac_client associated with the current RDP session.
* @param client
* The guac_client associated with the current RDP session.
*
* @param svc
* The static virtual channel to add to the list of all such channels
@ -118,8 +125,11 @@ void guac_rdp_add_svc(guac_client* client, guac_rdp_svc* svc);
/**
* Retrieve the SVC with the given name from the list stored in the client.
*
* @param client The guac_client associated with the current RDP session.
* @param name The name of the static virtual channel to retrieve.
* @param client
* The guac_client associated with the current RDP session.
*
* @param name
* The name of the static virtual channel to retrieve.
*
* @return
* The static virtual channel with the given name, or NULL if no such
@ -130,8 +140,11 @@ guac_rdp_svc* guac_rdp_get_svc(guac_client* client, const char* name);
/**
* Remove the SVC with the given name from the list stored in the client.
*
* @param client The guac_client associated with the current RDP session.
* @param name The name of the static virtual channel to remove.
* @param client
* The guac_client associated with the current RDP session.
*
* @param name
* The name of the static virtual channel to remove.
*
* @return
* The static virtual channel that was removed, or NULL if no such virtual
@ -142,9 +155,14 @@ guac_rdp_svc* guac_rdp_remove_svc(guac_client* client, const char* name);
/**
* Write the given blob of data to the virtual channel.
*
* @param svc The static virtual channel to write data to.
* @param data The data to write.
* @param length The number of bytes to write.
* @param svc
* The static virtual channel to write data to.
*
* @param data
* The data to write.
*
* @param length
* The number of bytes to write.
*/
void guac_rdp_svc_write(guac_rdp_svc* svc, void* data, int length);

20
src/protocols/rdp/resolution.h
View File

@ -29,9 +29,14 @@
* Returns whether the given resolution is reasonable for the given user,
* based on arbitrary criteria for reasonability.
*
* @param user The guac_user to test the given resolution against.
* @param resolution The resolution to test, in DPI.
* @return Non-zero if the resolution is reasonable, zero otherwise.
* @param user
* The guac_user to test the given resolution against.
*
* @param resolution
* The resolution to test, in DPI.
*
* @return
* Non-zero if the resolution is reasonable, zero otherwise.
*/
int guac_rdp_resolution_reasonable(guac_user* user, int resolution);
@ -39,9 +44,12 @@ int guac_rdp_resolution_reasonable(guac_user* user, int resolution);
* Returns a reasonable resolution for the remote display, given the size and
* resolution of a guac_user.
*
* @param user The guac_user whose size and resolution shall be used to
* determine an appropriate remote display resolution.
* @return A reasonable resolution for the remote display, in DPI.
* @param user
* The guac_user whose size and resolution shall be used to determine an
* appropriate remote display resolution.
*
* @return
* A reasonable resolution for the remote display, in DPI.
*/
int guac_rdp_suggest_resolution(guac_user* user);

30
src/protocols/rdp/unicode.h
View File

@ -26,10 +26,17 @@
/**
* Convert the given number of UTF-16 characters to UTF-8 characters.
*
* @param utf16 Arbitrary UTF-16 data.
* @param length The length of the UTF-16 data, in characters.
* @param utf8 Buffer to which the converted UTF-8 data will be written.
* @param size The maximum number of bytes available in the UTF-8 buffer.
* @param utf16
* Arbitrary UTF-16 data.
*
* @param length
* The length of the UTF-16 data, in characters.
*
* @param utf8
* Buffer to which the converted UTF-8 data will be written.
*
* @param size
* The maximum number of bytes available in the UTF-8 buffer.
*/
void guac_rdp_utf16_to_utf8(const unsigned char* utf16, int length,
char* utf8, int size);
@ -37,10 +44,17 @@ void guac_rdp_utf16_to_utf8(const unsigned char* utf16, int length,
/**
* Convert the given number of UTF-8 characters to UTF-16 characters.
*
* @param utf8 Arbitrary UTF-8 data.
* @param length The length of the UTF-8 data, in characters.
* @param utf16 Buffer to which the converted UTF-16 data will be written.
* @param size The maximum number of bytes available in the UTF-16 buffer.
* @param utf8
* Arbitrary UTF-8 data.
*
* @param length
* The length of the UTF-8 data, in characters.
*
* @param utf16
* Buffer to which the converted UTF-16 data will be written.
*
* @param size
* The maximum number of bytes available in the UTF-16 buffer.
*/
void guac_rdp_utf8_to_utf16(const unsigned char* utf8, int length,
char* utf16, int size);