Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
alphaindex.h	26.53 KB	-rw-r--r--	2023-02-22 10:28
appendable.h	8.53 KB	-rw-r--r--	2023-02-22 10:28
basictz.h	9.98 KB	-rw-r--r--	2023-02-22 10:28
brkiter.h	27.81 KB	-rw-r--r--	2023-02-22 10:28
bytestream.h	10.75 KB	-rw-r--r--	2023-02-22 10:28
bytestrie.h	20.78 KB	-rw-r--r--	2023-02-22 10:28
bytestriebuilder.h	7.48 KB	-rw-r--r--	2023-02-22 10:28
calendar.h	102.25 KB	-rw-r--r--	2023-02-22 10:28
caniter.h	7.47 KB	-rw-r--r--	2023-02-22 10:28
casemap.h	25.33 KB	-rw-r--r--	2023-02-22 10:28
char16ptr.h	7.22 KB	-rw-r--r--	2023-02-22 10:28
chariter.h	24.06 KB	-rw-r--r--	2023-02-22 10:28
choicfmt.h	23.98 KB	-rw-r--r--	2023-02-22 10:28
coleitr.h	13.78 KB	-rw-r--r--	2023-02-22 10:28
coll.h	56.27 KB	-rw-r--r--	2023-02-22 10:28
compactdecimalformat.h	6.88 KB	-rw-r--r--	2023-02-22 10:28
curramt.h	3.78 KB	-rw-r--r--	2023-02-22 10:28
currpinf.h	7.3 KB	-rw-r--r--	2023-02-22 10:28
currunit.h	4.02 KB	-rw-r--r--	2023-02-22 10:28
datefmt.h	40.71 KB	-rw-r--r--	2023-02-22 10:28
dbbi.h	1.19 KB	-rw-r--r--	2023-02-22 10:28
dcfmtsym.h	20.61 KB	-rw-r--r--	2023-02-22 10:28
decimfmt.h	87.57 KB	-rw-r--r--	2023-02-22 10:28
displayoptions.h	7.11 KB	-rw-r--r--	2023-02-22 10:28
docmain.h	7.21 KB	-rw-r--r--	2023-02-22 10:28
dtfmtsym.h	38.22 KB	-rw-r--r--	2023-02-22 10:28
dtintrv.h	3.85 KB	-rw-r--r--	2023-02-22 10:28
dtitvfmt.h	49.27 KB	-rw-r--r--	2023-02-22 10:28
dtitvinf.h	18.63 KB	-rw-r--r--	2023-02-22 10:28
dtptngen.h	28.69 KB	-rw-r--r--	2023-02-22 10:28
dtrule.h	8.69 KB	-rw-r--r--	2023-02-22 10:28
edits.h	20.74 KB	-rw-r--r--	2023-02-22 10:28
enumset.h	2.08 KB	-rw-r--r--	2023-02-22 10:28
errorcode.h	4.84 KB	-rw-r--r--	2023-02-22 10:28
fieldpos.h	8.7 KB	-rw-r--r--	2023-02-22 10:28
filteredbrk.h	5.37 KB	-rw-r--r--	2023-02-22 10:28
fmtable.h	24.43 KB	-rw-r--r--	2023-02-22 10:28
format.h	12.5 KB	-rw-r--r--	2023-02-22 10:28
formattedvalue.h	9.75 KB	-rw-r--r--	2023-02-22 10:28
fpositer.h	3.03 KB	-rw-r--r--	2023-02-22 10:28
gender.h	3.35 KB	-rw-r--r--	2023-02-22 10:28
gregocal.h	31.04 KB	-rw-r--r--	2023-02-22 10:28
icudataver.h	1.02 KB	-rw-r--r--	2023-02-22 10:28
icuplug.h	11.83 KB	-rw-r--r--	2023-02-22 10:28
idna.h	12.71 KB	-rw-r--r--	2023-02-22 10:28
listformatter.h	8.61 KB	-rw-r--r--	2023-02-22 10:28
localebuilder.h	11.08 KB	-rw-r--r--	2023-02-22 10:28
localematcher.h	26.84 KB	-rw-r--r--	2023-02-22 10:28
localpointer.h	19.36 KB	-rw-r--r--	2023-02-22 10:28
locdspnm.h	7.12 KB	-rw-r--r--	2023-02-22 10:28
locid.h	47.66 KB	-rw-r--r--	2023-02-22 10:28
measfmt.h	11.42 KB	-rw-r--r--	2023-02-22 10:28
measunit.h	106.33 KB	-rw-r--r--	2023-02-22 10:28
measure.h	4.33 KB	-rw-r--r--	2023-02-22 10:28
messagepattern.h	33.71 KB	-rw-r--r--	2023-02-22 10:28
msgfmt.h	44.17 KB	-rw-r--r--	2023-02-22 10:28
normalizer2.h	33.66 KB	-rw-r--r--	2023-02-22 10:28
normlzr.h	30.96 KB	-rw-r--r--	2023-02-22 10:28
nounit.h	2.25 KB	-rw-r--r--	2023-02-22 10:28
numberformatter.h	94.82 KB	-rw-r--r--	2023-02-22 10:28
numberrangeformatter.h	25.02 KB	-rw-r--r--	2023-02-22 10:28
numfmt.h	49.84 KB	-rw-r--r--	2023-02-22 10:28
numsys.h	7.22 KB	-rw-r--r--	2023-02-22 10:28
parseerr.h	3.08 KB	-rw-r--r--	2023-02-22 10:28
parsepos.h	5.57 KB	-rw-r--r--	2023-02-22 10:28
platform.h	28.55 KB	-rw-r--r--	2023-02-22 10:28
plurfmt.h	25.25 KB	-rw-r--r--	2023-02-22 10:28
plurrule.h	20.62 KB	-rw-r--r--	2023-02-22 10:28
ptypes.h	3.49 KB	-rw-r--r--	2023-02-22 10:28
putil.h	6.32 KB	-rw-r--r--	2023-02-22 10:28
rbbi.h	28.46 KB	-rw-r--r--	2023-02-22 10:28
rbnf.h	49.82 KB	-rw-r--r--	2023-02-22 10:28
rbtz.h	15.77 KB	-rw-r--r--	2023-02-22 10:28
regex.h	84.41 KB	-rw-r--r--	2023-02-22 10:28
region.h	9.18 KB	-rw-r--r--	2023-02-22 10:28
reldatefmt.h	22.22 KB	-rw-r--r--	2023-02-22 10:28
rep.h	9.37 KB	-rw-r--r--	2023-02-22 10:28
resbund.h	18.09 KB	-rw-r--r--	2023-02-22 10:28
schriter.h	6.1 KB	-rw-r--r--	2023-02-22 10:28
scientificnumberformatter.h	6.44 KB	-rw-r--r--	2023-02-22 10:28
search.h	22.22 KB	-rw-r--r--	2023-02-22 10:28
selfmt.h	14.35 KB	-rw-r--r--	2023-02-22 10:28
simpleformatter.h	12.59 KB	-rw-r--r--	2023-02-22 10:28
simpletz.h	45.65 KB	-rw-r--r--	2023-02-22 10:28
smpdtfmt.h	71.93 KB	-rw-r--r--	2023-02-22 10:28
sortkey.h	11.18 KB	-rw-r--r--	2023-02-22 10:28
std_string.h	1.05 KB	-rw-r--r--	2023-02-22 10:28
strenum.h	9.92 KB	-rw-r--r--	2023-02-22 10:28
stringoptions.h	5.79 KB	-rw-r--r--	2023-02-22 10:28
stringpiece.h	10.05 KB	-rw-r--r--	2023-02-22 10:28
stringtriebuilder.h	15.47 KB	-rw-r--r--	2023-02-22 10:28
stsearch.h	21.42 KB	-rw-r--r--	2023-02-22 10:28
symtable.h	4.27 KB	-rw-r--r--	2023-02-22 10:28
tblcoll.h	36.92 KB	-rw-r--r--	2023-02-22 10:28
timezone.h	43.81 KB	-rw-r--r--	2023-02-22 10:28
tmunit.h	3.4 KB	-rw-r--r--	2023-02-22 10:28
tmutamt.h	4.91 KB	-rw-r--r--	2023-02-22 10:28
tmutfmt.h	7.42 KB	-rw-r--r--	2023-02-22 10:28
translit.h	65.82 KB	-rw-r--r--	2023-02-22 10:28
tzfmt.h	42.93 KB	-rw-r--r--	2023-02-22 10:28
tznames.h	16.85 KB	-rw-r--r--	2023-02-22 10:28
tzrule.h	34.86 KB	-rw-r--r--	2023-02-22 10:28
tztrans.h	6.13 KB	-rw-r--r--	2023-02-22 10:28
ubidi.h	89.61 KB	-rw-r--r--	2023-02-22 10:28
ubiditransform.h	12.71 KB	-rw-r--r--	2023-02-22 10:28
ubrk.h	24.43 KB	-rw-r--r--	2023-02-22 10:28
ucal.h	60.68 KB	-rw-r--r--	2023-02-22 10:28
ucasemap.h	15.21 KB	-rw-r--r--	2023-02-22 10:28
ucat.h	5.35 KB	-rw-r--r--	2023-02-22 10:28
uchar.h	145.09 KB	-rw-r--r--	2023-02-22 10:28
ucharstrie.h	22.53 KB	-rw-r--r--	2023-02-22 10:28
ucharstriebuilder.h	7.48 KB	-rw-r--r--	2023-02-22 10:28
uchriter.h	13.42 KB	-rw-r--r--	2023-02-22 10:28
uclean.h	11.2 KB	-rw-r--r--	2023-02-22 10:28
ucnv.h	83.46 KB	-rw-r--r--	2023-02-22 10:28
ucnv_cb.h	6.58 KB	-rw-r--r--	2023-02-22 10:28
ucnv_err.h	20.98 KB	-rw-r--r--	2023-02-22 10:28
ucnvsel.h	6.24 KB	-rw-r--r--	2023-02-22 10:28
ucol.h	61.95 KB	-rw-r--r--	2023-02-22 10:28
ucoleitr.h	9.82 KB	-rw-r--r--	2023-02-22 10:28
uconfig.h	12.07 KB	-rw-r--r--	2023-02-22 10:28
ucpmap.h	5.54 KB	-rw-r--r--	2023-02-22 10:28
ucptrie.h	22.51 KB	-rw-r--r--	2023-02-22 10:28
ucsdet.h	14.69 KB	-rw-r--r--	2023-02-22 10:28
ucurr.h	16.72 KB	-rw-r--r--	2023-02-22 10:28
udat.h	62.36 KB	-rw-r--r--	2023-02-22 10:28
udata.h	15.63 KB	-rw-r--r--	2023-02-22 10:28
udateintervalformat.h	11.93 KB	-rw-r--r--	2023-02-22 10:28
udatpg.h	30.18 KB	-rw-r--r--	2023-02-22 10:28
udisplaycontext.h	5.94 KB	-rw-r--r--	2023-02-22 10:28
udisplayoptions.h	8.8 KB	-rw-r--r--	2023-02-22 10:28
uenum.h	7.79 KB	-rw-r--r--	2023-02-22 10:28
ufieldpositer.h	4.41 KB	-rw-r--r--	2023-02-22 10:28
uformattable.h	10.97 KB	-rw-r--r--	2023-02-22 10:28
uformattedvalue.h	12.25 KB	-rw-r--r--	2023-02-22 10:28
ugender.h	2.06 KB	-rw-r--r--	2023-02-22 10:28
uidna.h	33.43 KB	-rw-r--r--	2023-02-22 10:28
uiter.h	22.75 KB	-rw-r--r--	2023-02-22 10:28
uldnames.h	10.48 KB	-rw-r--r--	2023-02-22 10:28
ulistformatter.h	10.78 KB	-rw-r--r--	2023-02-22 10:28
uloc.h	54.66 KB	-rw-r--r--	2023-02-22 10:28
ulocdata.h	11.3 KB	-rw-r--r--	2023-02-22 10:28
umachine.h	15.73 KB	-rw-r--r--	2023-02-22 10:28
umisc.h	1.34 KB	-rw-r--r--	2023-02-22 10:28
umsg.h	24.25 KB	-rw-r--r--	2023-02-22 10:28
umutablecptrie.h	8.3 KB	-rw-r--r--	2023-02-22 10:28
unifilt.h	4 KB	-rw-r--r--	2023-02-22 10:28
unifunct.h	4.05 KB	-rw-r--r--	2023-02-22 10:28
unimatch.h	6.1 KB	-rw-r--r--	2023-02-22 10:28
unirepl.h	3.38 KB	-rw-r--r--	2023-02-22 10:28
uniset.h	66.12 KB	-rw-r--r--	2023-02-22 10:28
unistr.h	170.53 KB	-rw-r--r--	2023-02-22 10:28
unorm.h	20.55 KB	-rw-r--r--	2023-02-22 10:28
unorm2.h	24.68 KB	-rw-r--r--	2023-02-22 10:28
unum.h	56.6 KB	-rw-r--r--	2023-02-22 10:28
unumberformatter.h	30.26 KB	-rw-r--r--	2023-02-22 10:28
unumberrangeformatter.h	15.35 KB	-rw-r--r--	2023-02-22 10:28
unumsys.h	7.26 KB	-rw-r--r--	2023-02-22 10:28
uobject.h	10.68 KB	-rw-r--r--	2023-02-22 10:28
upluralrules.h	8.79 KB	-rw-r--r--	2023-02-22 10:28
uregex.h	71.99 KB	-rw-r--r--	2023-02-22 10:28
uregion.h	9.81 KB	-rw-r--r--	2023-02-22 10:28
ureldatefmt.h	17.04 KB	-rw-r--r--	2023-02-22 10:28
urename.h	135.69 KB	-rw-r--r--	2023-02-22 10:28
urep.h	5.38 KB	-rw-r--r--	2023-02-22 10:28
ures.h	36.54 KB	-rw-r--r--	2023-02-22 10:28
uscript.h	27.8 KB	-rw-r--r--	2023-02-22 10:28
usearch.h	39.21 KB	-rw-r--r--	2023-02-22 10:28
uset.h	44.19 KB	-rw-r--r--	2023-02-22 10:28
usetiter.h	9.63 KB	-rw-r--r--	2023-02-22 10:28
ushape.h	18 KB	-rw-r--r--	2023-02-22 10:28
uspoof.h	65.84 KB	-rw-r--r--	2023-02-22 10:28
usprep.h	8.19 KB	-rw-r--r--	2023-02-22 10:28
ustdio.h	38.56 KB	-rw-r--r--	2023-02-22 10:28
ustream.h	1.89 KB	-rw-r--r--	2023-02-22 10:28
ustring.h	72.36 KB	-rw-r--r--	2023-02-22 10:28
ustringtrie.h	3.15 KB	-rw-r--r--	2023-02-22 10:28
utext.h	58.08 KB	-rw-r--r--	2023-02-22 10:28
utf.h	7.87 KB	-rw-r--r--	2023-02-22 10:28
utf16.h	23.35 KB	-rw-r--r--	2023-02-22 10:28
utf32.h	763 B	-rw-r--r--	2023-02-22 10:28
utf8.h	30.83 KB	-rw-r--r--	2023-02-22 10:28
utf_old.h	45.8 KB	-rw-r--r--	2023-02-22 10:28
utmscale.h	13.78 KB	-rw-r--r--	2023-02-22 10:28
utrace.h	17.18 KB	-rw-r--r--	2023-02-22 10:28
utrans.h	25.54 KB	-rw-r--r--	2023-02-22 10:28
utypes.h	31.06 KB	-rw-r--r--	2023-02-22 10:28
uvernum.h	6.33 KB	-rw-r--r--	2023-02-22 10:28
uversion.h	5.99 KB	-rw-r--r--	2023-02-22 10:28
vtzone.h	20.68 KB	-rw-r--r--	2023-02-22 10:28

Rename

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
 *******************************************************************************
 *
 *   Copyright (C) 2003-2014, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 *
 *******************************************************************************
 *   file name:  usprep.h
 *   encoding:   UTF-8
 *   tab size:   8 (not used)
 *   indentation:4
 *
 *   created on: 2003jul2
 *   created by: Ram Viswanadha
 */

#ifndef __USPREP_H__
#define __USPREP_H__

/**
 * \file 
 * \brief C API: Implements the StringPrep algorithm.
 */

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API
#include "unicode/localpointer.h"
#endif   // U_SHOW_CPLUSPLUS_API

/**
 *
 * 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 classified into
 * <ul>
 *     <li> Unassigned Table: Contains code points that are unassigned 
 *          in the Unicode Version supported by StringPrep. Currently 
 *          RFC 3454 supports Unicode 3.2. </li>
 *     <li> Prohibited Table: Contains code points that are prohibited from
 *          the output of the StringPrep processing function. </li>
 *     <li> Mapping Table: Contains code points that are deleted from the output or case mapped. </li>
 * </ul>
 * 
 * The procedure for preparing Unicode strings:
 * <ol>
 *      <li> Map: For each character in the input, check if it has a mapping
 *           and, if so, replace it with its mapping. </li>
 *      <li> Normalize: Possibly normalize the result of step 1 using Unicode
 *           normalization. </li>
 *      <li> Prohibit: Check for any characters that are not allowed in the
 *        output.  If any are found, return an error.</li>
 *      <li> Check bidi: Possibly check for right-to-left characters, and if
 *           any are found, make sure that the whole string satisfies the
 *           requirements for bidirectional strings.  If the string does not
 *           satisfy the requirements for bidirectional strings, return an
 *           error.  </li>
 * </ol>
 * @author Ram Viswanadha
 */
#if !UCONFIG_NO_IDNA

#include "unicode/parseerr.h"

/**
 * The StringPrep profile
 * @stable ICU 2.8
 */
typedef struct UStringPrepProfile UStringPrepProfile;

/** 
 * Option to prohibit processing of unassigned code points in the input
 * 
 * @see  usprep_prepare
 * @stable ICU 2.8
 */
#define USPREP_DEFAULT 0x0000

/** 
 * Option to allow processing of unassigned code points in the input
 * 
 * @see  usprep_prepare
 * @stable ICU 2.8
 */
#define USPREP_ALLOW_UNASSIGNED 0x0001

/**
 * enums for the standard stringprep profile types
 * supported by usprep_openByType.
 * @see usprep_openByType
 * @stable ICU 4.2
 */
typedef enum UStringPrepProfileType {
    /**
     * RFC3491 Nameprep
     * @stable ICU 4.2
     */
    USPREP_RFC3491_NAMEPREP,
    /**
     * RFC3530 nfs4_cs_prep
     * @stable ICU 4.2
     */
	USPREP_RFC3530_NFS4_CS_PREP,
    /**
     * RFC3530 nfs4_cs_prep with case insensitive option
     * @stable ICU 4.2
     */
	USPREP_RFC3530_NFS4_CS_PREP_CI,
    /**
     * RFC3530 nfs4_cis_prep
     * @stable ICU 4.2
     */
	USPREP_RFC3530_NFS4_CIS_PREP,
    /**
     * RFC3530 nfs4_mixed_prep for prefix
     * @stable ICU 4.2
     */
	USPREP_RFC3530_NFS4_MIXED_PREP_PREFIX,
    /**
     * RFC3530 nfs4_mixed_prep for suffix
     * @stable ICU 4.2
     */
	USPREP_RFC3530_NFS4_MIXED_PREP_SUFFIX,
    /**
     * RFC3722 iSCSI
     * @stable ICU 4.2
     */
	USPREP_RFC3722_ISCSI,
    /**
     * RFC3920 XMPP Nodeprep
     * @stable ICU 4.2
     */
	USPREP_RFC3920_NODEPREP,
    /**
     * RFC3920 XMPP Resourceprep
     * @stable ICU 4.2
     */
	USPREP_RFC3920_RESOURCEPREP,
    /**
     * RFC4011 Policy MIB Stringprep
     * @stable ICU 4.2
     */
	USPREP_RFC4011_MIB,
    /**
     * RFC4013 SASLprep
     * @stable ICU 4.2
     */
    USPREP_RFC4013_SASLPREP,
    /**
     * RFC4505 trace
     * @stable ICU 4.2
     */
	USPREP_RFC4505_TRACE,
    /**
     * RFC4518 LDAP
     * @stable ICU 4.2
     */
	USPREP_RFC4518_LDAP,
    /**
     * RFC4518 LDAP for case ignore, numeric and stored prefix
     * matching rules
     * @stable ICU 4.2
     */
	USPREP_RFC4518_LDAP_CI
} UStringPrepProfileType;

/**
 * Creates a StringPrep profile from the data file.
 *
 * @param 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.
 * @param fileName  name of the profile file to be opened
 * @param status    ICU error code in/out parameter. Must not be NULL.
 *                  Must fulfill U_SUCCESS before the function call.
 * @return Pointer to UStringPrepProfile that is opened. Should be closed by
 * calling usprep_close()
 * @see usprep_close()
 * @stable ICU 2.8
 */
U_CAPI UStringPrepProfile* U_EXPORT2
usprep_open(const char* path, 
            const char* fileName,
            UErrorCode* status);

/**
 * Creates a StringPrep profile for the specified profile type.
 *
 * @param type		The profile type
 * @param status    ICU error code in/out parameter. Must not be NULL.
 *                  Must fulfill U_SUCCESS before the function call.
 * @return          Pointer to UStringPrepProfile that is opened. Should be closed by
 *                  calling usprep_close()
 * @see usprep_close()
 * @stable ICU 4.2
 */
U_CAPI UStringPrepProfile* U_EXPORT2
usprep_openByType(UStringPrepProfileType type,
				  UErrorCode* status);

/**
 * Closes the profile
 * @param profile The profile to close
 * @stable ICU 2.8
 */
U_CAPI void U_EXPORT2
usprep_close(UStringPrepProfile* profile);

#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

/**
 * \class LocalUStringPrepProfilePointer
 * "Smart pointer" class, closes a UStringPrepProfile via usprep_close().
 * For most methods see the LocalPointerBase base class.
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 4.4
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUStringPrepProfilePointer, UStringPrepProfile, usprep_close);

U_NAMESPACE_END

#endif

/**
 * Prepare the input buffer for use in applications with the given profile. This operation maps, normalizes(NFKC),
 * checks for prohibited and BiDi characters in the order defined by RFC 3454
 * depending on the options specified in the profile.
 *
 * @param prep          The profile to use 
 * @param src           Pointer to UChar buffer containing the string to prepare
 * @param srcLength     Number of characters in the source string
 * @param dest          Pointer to the destination buffer to receive the output
 * @param destCapacity  The capacity of destination array
 * @param options       A bit set of options:
 *
 *  - USPREP_DEFAULT            Prohibit processing of unassigned code points in the input
 *
 *  - USPREP_ALLOW_UNASSIGNED   Treat the unassigned code points are in the input 
 *                              as normal Unicode code points.
 *
 * @param parseError        Pointer to UParseError struct to receive information on position 
 *                          of error if an error is encountered. Can be NULL.
 * @param 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
 * @return The number of UChars in the destination buffer
 * @stable ICU 2.8
 */

U_CAPI int32_t U_EXPORT2
usprep_prepare(   const UStringPrepProfile* prep,
                  const UChar* src, int32_t srcLength, 
                  UChar* dest, int32_t destCapacity,
                  int32_t options,
                  UParseError* parseError,
                  UErrorCode* status );

#endif /* #if !UCONFIG_NO_IDNA */

#endif