#include "unicode/utypes.h"
#include "unicode/parseerr.h"
Go to the source code of this file.
Defines | |
#define | USPREP_DEFAULT 0x0000 |
Option to prohibit processing of unassigned code points in the input. | |
#define | USPREP_ALLOW_UNASSIGNED 0x0001 |
Option to allow processing of unassigned code points in the input. | |
Typedefs | |
typedef struct UStringPrepProfile | UStringPrepProfile |
StringPrep API implements the StingPrep framework as described by RFC 3454. | |
Functions | |
UStringPrepProfile * | usprep_open (const char *path, const char *fileName, UErrorCode *status) |
Creates a StringPrep profile from the data file. | |
void | usprep_close (UStringPrepProfile *profile) |
Closes the profile. | |
int32_t | usprep_prepare (const UStringPrepProfile *prep, const UChar *src, int32_t srcLength, UChar *dest, int32_t destCapacity, int32_t options, UParseError *parseError, UErrorCode *status) |
Prepare the input buffer for use in applications with the given profile. |
Definition in file usprep.h.
#define USPREP_ALLOW_UNASSIGNED 0x0001 |
Option to allow processing of unassigned code points in the input.
#define USPREP_DEFAULT 0x0000 |
Option to prohibit processing of unassigned code points in the input.
typedef struct UStringPrepProfile UStringPrepProfile |
StringPrep API implements the StingPrep framework as described by RFC 3454.
StringPrep prepares Unicode strings for use in network protocols. Profiles of StingPrep are set of rules and data according to with the Unicode Strings are prepared. Each profiles contains tables which describe how a code point should be treated. The tables are broadly classied into
The procedure for preparing Unicode strings:
void usprep_close | ( | UStringPrepProfile * | profile | ) |
UStringPrepProfile* usprep_open | ( | const char * | path, | |
const char * | fileName, | |||
UErrorCode * | status | |||
) |
Creates a StringPrep profile from the data file.
path | string containing the full path pointing to the directory where the profile reside followed by the package name e.g. "/usr/resource/my_app/profiles/mydata" on a Unix system. if NULL, ICU default data files will be used. | |
fileName | name of the profile file to be opened | |
status | ICU error code in/out parameter. Must not be NULL. Must fulfill U_SUCCESS before the function call. |
int32_t usprep_prepare | ( | const UStringPrepProfile * | prep, | |
const UChar * | src, | |||
int32_t | srcLength, | |||
UChar * | dest, | |||
int32_t | destCapacity, | |||
int32_t | options, | |||
UParseError * | parseError, | |||
UErrorCode * | status | |||
) |
Prepare the input buffer for use in applications with the given profile.
This operation maps, normalizes(NFKC), checks for prohited and BiDi characters in the order defined by RFC 3454 depending on the options specified in the profile.
prep | The profile to use | |
src | Pointer to UChar buffer containing the string to prepare | |
srcLength | Number of characters in the source string | |
dest | Pointer to the destination buffer to receive the output | |
destCapacity | The capacity of destination array | |
options | A bit set of options: |
parseError | Pointer to UParseError struct to receive information on position of error if an error is encountered. Can be NULL. | |
status | ICU in/out error code parameter. U_INVALID_CHAR_FOUND if src contains unmatched single surrogates. U_INDEX_OUTOFBOUNDS_ERROR if src contains too many code points. U_BUFFER_OVERFLOW_ERROR if destCapacity is not enough |