Comment util_suite.h thoroughly.
This commit is contained in:
parent
b6581e98d7
commit
b4ffc87033
@ -38,16 +38,53 @@
|
|||||||
#ifndef _GUAC_TEST_UTIL_SUITE_H
|
#ifndef _GUAC_TEST_UTIL_SUITE_H
|
||||||
#define _GUAC_TEST_UTIL_SUITE_H
|
#define _GUAC_TEST_UTIL_SUITE_H
|
||||||
|
|
||||||
/* Unicode (UTF-8) strings */
|
/**
|
||||||
|
* Test suite containing unit tests for utility functions built into libguac.
|
||||||
|
* These utility functions are included for convenience rather as integral
|
||||||
|
* requirements of the core.
|
||||||
|
*
|
||||||
|
* @file util_suite.h
|
||||||
|
*/
|
||||||
|
|
||||||
#define UTF8_1b "g" /* One byte */
|
|
||||||
#define UTF8_2b "\xc4\xa3" /* Two bytes */
|
|
||||||
#define UTF8_3b "\xe7\x8a\xac" /* Three bytes */
|
|
||||||
#define UTF8_4b "\xf0\x90\x84\xa3" /* Four bytes */
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A single Unicode character encoded as one byte with UTF-8.
|
||||||
|
*/
|
||||||
|
#define UTF8_1b "g"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A single Unicode character encoded as two bytes with UTF-8.
|
||||||
|
*/
|
||||||
|
#define UTF8_2b "\xc4\xa3"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A single Unicode character encoded as three bytes with UTF-8.
|
||||||
|
*/
|
||||||
|
#define UTF8_3b "\xe7\x8a\xac"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A single Unicode character encoded as four bytes with UTF-8.
|
||||||
|
*/
|
||||||
|
#define UTF8_4b "\xf0\x90\x84\xa3"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers the utility test suite with CUnit.
|
||||||
|
*/
|
||||||
int register_util_suite();
|
int register_util_suite();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unit test for the guac_pool structure and related functions. The guac_pool
|
||||||
|
* structure provides a consistent source of pooled integers. This unit test
|
||||||
|
* checks that the associated functions behave as documented (returning
|
||||||
|
* integers in the proper order, allocating new integers as necessary, etc.).
|
||||||
|
*/
|
||||||
void test_guac_pool();
|
void test_guac_pool();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unit test for libguac's Unicode convenience functions. This test checks that
|
||||||
|
* the functions provided for determining string length, character length, and
|
||||||
|
* for reading and writing UTF-8 behave as specified in the documentation.
|
||||||
|
*/
|
||||||
void test_guac_unicode();
|
void test_guac_unicode();
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
Loading…
Reference in New Issue
Block a user