ICU 70.1 70.1

usprep.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4 *******************************************************************************
5 *
6 * Copyright (C) 2003-2014, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: usprep.h
11 * encoding: UTF-8
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 2003jul2
16 * created by: Ram Viswanadha
17 */
18
19#ifndef __USPREP_H__
20#define __USPREP_H__
21
27#include "unicode/utypes.h"
28
29#if U_SHOW_CPLUSPLUS_API
30#include "unicode/localpointer.h"
31#endif // U_SHOW_CPLUSPLUS_API
32
65#if !UCONFIG_NO_IDNA
66
67#include "unicode/parseerr.h"
68
73 typedef struct UStringPrepProfile UStringPrepProfile;
74
75
82#define USPREP_DEFAULT 0x0000
83
90#define USPREP_ALLOW_UNASSIGNED 0x0001
91
98 typedef enum UStringPrepProfileType {
103 USPREP_RFC3491_NAMEPREP,
108 USPREP_RFC3530_NFS4_CS_PREP,
113 USPREP_RFC3530_NFS4_CS_PREP_CI,
118 USPREP_RFC3530_NFS4_CIS_PREP,
123 USPREP_RFC3530_NFS4_MIXED_PREP_PREFIX,
128 USPREP_RFC3530_NFS4_MIXED_PREP_SUFFIX,
133 USPREP_RFC3722_ISCSI,
138 USPREP_RFC3920_NODEPREP,
143 USPREP_RFC3920_RESOURCEPREP,
148 USPREP_RFC4011_MIB,
153 USPREP_RFC4013_SASLPREP,
158 USPREP_RFC4505_TRACE,
163 USPREP_RFC4518_LDAP,
169 USPREP_RFC4518_LDAP_CI
170} UStringPrepProfileType;
171
187 U_CAPI UStringPrepProfile* U_EXPORT2
188 usprep_open(const char* path,
189 const char* fileName,
190 UErrorCode* status);
191
203 U_CAPI UStringPrepProfile* U_EXPORT2
204 usprep_openByType(UStringPrepProfileType type,
205 UErrorCode* status);
206
212 U_CAPI void U_EXPORT2
213 usprep_close(UStringPrepProfile* profile);
214
215#if U_SHOW_CPLUSPLUS_API
216
217U_NAMESPACE_BEGIN
218
228 U_DEFINE_LOCAL_OPEN_POINTER(LocalUStringPrepProfilePointer, UStringPrepProfile, usprep_close);
229
230U_NAMESPACE_END
231
232#endif
233
263 U_CAPI int32_t U_EXPORT2
264 usprep_prepare( const UStringPrepProfile* prep,
265 const UChar* src, int32_t srcLength,
266 UChar* dest, int32_t destCapacity,
267 int32_t options,
268 UParseError* parseError,
269 UErrorCode* status );
270
271
272#endif /* #if !UCONFIG_NO_IDNA */
273
274#endif
LocalUStringPrepProfilePointer
"Smart pointer" class, closes a UStringPrepProfile via usprep_close().
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:550
parseerr.h
C API: Parse Error Information.
UParseError
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
UChar
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:418
usprep_open
U_CAPI UStringPrepProfile * usprep_open(const char *path, const char *fileName, UErrorCode *status)
Creates a StringPrep profile from the data file.
UStringPrepProfile
struct UStringPrepProfile UStringPrepProfile
StringPrep API implements the StingPrep framework as described by RFC 3454.
Definition: usprep.h:73
UStringPrepProfileType
UStringPrepProfileType
enums for the standard stringprep profile types supported by usprep_openByType.
Definition: usprep.h:98
USPREP_RFC4011_MIB
@ USPREP_RFC4011_MIB
RFC4011 Policy MIB Stringprep.
Definition: usprep.h:148
USPREP_RFC4505_TRACE
@ USPREP_RFC4505_TRACE
RFC4505 trace.
Definition: usprep.h:158
USPREP_RFC3530_NFS4_MIXED_PREP_SUFFIX
@ USPREP_RFC3530_NFS4_MIXED_PREP_SUFFIX
RFC3530 nfs4_mixed_prep for suffix.
Definition: usprep.h:128
USPREP_RFC3530_NFS4_CS_PREP
@ USPREP_RFC3530_NFS4_CS_PREP
RFC3530 nfs4_cs_prep.
Definition: usprep.h:108
USPREP_RFC3722_ISCSI
@ USPREP_RFC3722_ISCSI
RFC3722 iSCSI.
Definition: usprep.h:133
USPREP_RFC4518_LDAP_CI
@ USPREP_RFC4518_LDAP_CI
RFC4518 LDAP for case ignore, numeric and stored prefix matching rules.
Definition: usprep.h:169
USPREP_RFC3530_NFS4_CS_PREP_CI
@ USPREP_RFC3530_NFS4_CS_PREP_CI
RFC3530 nfs4_cs_prep with case insensitive option.
Definition: usprep.h:113
USPREP_RFC4518_LDAP
@ USPREP_RFC4518_LDAP
RFC4518 LDAP.
Definition: usprep.h:163
USPREP_RFC4013_SASLPREP
@ USPREP_RFC4013_SASLPREP
RFC4013 SASLprep.
Definition: usprep.h:153
USPREP_RFC3920_NODEPREP
@ USPREP_RFC3920_NODEPREP
RFC3920 XMPP Nodeprep.
Definition: usprep.h:138
USPREP_RFC3530_NFS4_CIS_PREP
@ USPREP_RFC3530_NFS4_CIS_PREP
RFC3530 nfs4_cis_prep.
Definition: usprep.h:118
USPREP_RFC3530_NFS4_MIXED_PREP_PREFIX
@ USPREP_RFC3530_NFS4_MIXED_PREP_PREFIX
RFC3530 nfs4_mixed_prep for prefix.
Definition: usprep.h:123
USPREP_RFC3920_RESOURCEPREP
@ USPREP_RFC3920_RESOURCEPREP
RFC3920 XMPP Resourceprep.
Definition: usprep.h:143
USPREP_RFC3491_NAMEPREP
@ USPREP_RFC3491_NAMEPREP
RFC3491 Nameprep.
Definition: usprep.h:103
usprep_prepare
U_CAPI 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.
usprep_close
U_CAPI void usprep_close(UStringPrepProfile *profile)
Closes the profile.
usprep_openByType
U_CAPI UStringPrepProfile * usprep_openByType(UStringPrepProfileType type, UErrorCode *status)
Creates a StringPrep profile for the specified profile type.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415