---

ucnvsel.h

// 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /* ******************************************************************************* * * Copyright (C) 2008-2011, International Business Machines * Corporation, Google and others. All Rights Reserved. * ******************************************************************************* */ /* * Author : eldawy@google.com (Mohamed Eldawy) * ucnvsel.h * * Purpose: To generate a list of encodings capable of handling * a given Unicode text * * Started 09-April-2008 */ #ifndef __ICU_UCNV_SEL_H__ #define __ICU_UCNV_SEL_H__ #include "unicode/utypes.h" #if !UCONFIG_NO_CONVERSION #include "unicode/uset.h" #include "unicode/utf16.h" #include "unicode/uenum.h" #include "unicode/ucnv.h" #include "unicode/localpointer.h" /** * \file * * A converter selector is built with a set of encoding/charset names * and given an input string returns the set of names of the * corresponding converters which can convert the string. * * A converter selector can be serialized into a buffer and reopened * from the serialized form. */ /** * @{ * The selector data structure */ struct UConverterSelector; typedef struct UConverterSelector UConverterSelector; /** @} */ /** * Open a selector. * If converterListSize is 0, build for all available converters. * If excludedCodePoints is NULL, don't exclude any code points. * * @param converterList a pointer to encoding names needed to be involved. * Can be NULL if converterListSize==0. * The list and the names will be cloned, and the caller * retains ownership of the original. * @param converterListSize number of encodings in above list. * If 0, builds a selector for all available converters. * @param excludedCodePoints a set of code points to be excluded from consideration. * That is, excluded code points in a string do not change * the selection result. (They might be handled by a callback.) * Use NULL to exclude nothing. * @param whichSet what converter set to use? Use this to determine whether * to consider only roundtrip mappings or also fallbacks. * @param status an in/out ICU UErrorCode * @return the new selector * * @stable ICU 4.2 */ U_STABLE UConverterSelector* U_EXPORT2 ucnvsel_open(const char* const* converterList, int32_t converterListSize, const USet* excludedCodePoints, const UConverterUnicodeSet whichSet, UErrorCode* status); /** * Closes a selector. * If any Enumerations were returned by ucnv_select*, they become invalid. * They can be closed before or after calling ucnv_closeSelector, * but should never be used after the selector is closed. * * @see ucnv_selectForString * @see ucnv_selectForUTF8 * * @param sel selector to close * * @stable ICU 4.2 */ U_STABLE void U_EXPORT2 ucnvsel_close(UConverterSelector *sel); #if U_SHOW_CPLUSPLUS_API U_NAMESPACE_BEGIN /** * \class LocalUConverterSelectorPointer * "Smart pointer" class, closes a UConverterSelector via ucnvsel_close(). * For most methods see the LocalPointerBase base class. * * @see LocalPointerBase * @see LocalPointer * @stable ICU 4.4 */ U_DEFINE_LOCAL_OPEN_POINTER(LocalUConverterSelectorPointer, UConverterSelector, ucnvsel_close); U_NAMESPACE_END #endif /** * Open a selector from its serialized form. * The buffer must remain valid and unchanged for the lifetime of the selector. * This is much faster than creating a selector from scratch. * Using a serialized form from a different machine (endianness/charset) is supported. * * @param buffer pointer to the serialized form of a converter selector; * must be 32-bit-aligned * @param length the capacity of this buffer (can be equal to or larger than * the actual data length) * @param status an in/out ICU UErrorCode * @return the new selector * * @stable ICU 4.2 */ U_STABLE UConverterSelector* U_EXPORT2 ucnvsel_openFromSerialized(const void* buffer, int32_t length, UErrorCode* status); /** * Serialize a selector into a linear buffer. * The serialized form is portable to different machines. * * @param sel selector to consider * @param buffer pointer to 32-bit-aligned memory to be filled with the * serialized form of this converter selector * @param bufferCapacity the capacity of this buffer * @param status an in/out ICU UErrorCode * @return the required buffer capacity to hold serialize data (even if the call fails * with a U_BUFFER_OVERFLOW_ERROR, it will return the required capacity) * * @stable ICU 4.2 */ U_STABLE int32_t U_EXPORT2 ucnvsel_serialize(const UConverterSelector* sel, void* buffer, int32_t bufferCapacity, UErrorCode* status); /** * Select converters that can map all characters in a UTF-16 string, * ignoring the excluded code points. * * @param sel a selector * @param s UTF-16 string * @param length length of the string, or -1 if NUL-terminated * @param status an in/out ICU UErrorCode * @return an enumeration containing encoding names. * The returned encoding names and their order will be the same as * supplied when building the selector. * * @stable ICU 4.2 */ U_STABLE UEnumeration * U_EXPORT2 ucnvsel_selectForString(const UConverterSelector* sel, const UChar *s, int32_t length, UErrorCode *status); /** * Select converters that can map all characters in a UTF-8 string, * ignoring the excluded code points. * * @param sel a selector * @param s UTF-8 string * @param length length of the string, or -1 if NUL-terminated * @param status an in/out ICU UErrorCode * @return an enumeration containing encoding names. * The returned encoding names and their order will be the same as * supplied when building the selector. * * @stable ICU 4.2 */ U_STABLE UEnumeration * U_EXPORT2 ucnvsel_selectForUTF8(const UConverterSelector* sel, const char *s, int32_t length, UErrorCode *status); #endif /* !UCONFIG_NO_CONVERSION */ #endif /* __ICU_UCNV_SEL_H__ */

---

docroot: /home/induvedam/public_html

---

curdir: /usr/include/unicode

	.		8192
	..		8192
X	alphaindex.h		27118
X	appendable.h		8694
X	basictz.h		9491
X	brkiter.h		28464
X	bytestream.h		11037
X	bytestrie.h		21266
X	bytestriebuilder.h		7248
X	calendar.h		108278
X	caniter.h		7611
X	casemap.h		25933
X	char16ptr.h		7393
X	chariter.h		24632
X	choicfmt.h		24482
X	coleitr.h		14094
X	coll.h		57581
X	compactdecimalformat.h		7047
X	curramt.h		3851
X	currpinf.h		7473
X	currunit.h		4094
X	datefmt.h		41641
X	dbbi.h		1223
X	dcfmtsym.h		20897
X	decimfmt.h		89278
X	docmain.h		7142
X	dtfmtsym.h		38609
X	dtintrv.h		3930
X	dtitvfmt.h		47634
X	dtitvinf.h		19064
X	dtptngen.h		26419
X	dtrule.h		8888
X	edits.h		21237
X	enumset.h		2130
X	errorcode.h		4956
X	fieldpos.h		8899
X	filteredbrk.h		5501
X	fmtable.h		25007
X	format.h		12802
X	formattedvalue.h		9987
X	fpositer.h		3109
X	gender.h		3408
X	gregocal.h		32472
X	icudataver.h		1051
X	icuplug.h		12166
X	idna.h		13000
X	listformatter.h		9493
X	localebuilder.h		11502
X	localematcher.h		25147
X	localpointer.h		19829
X	locdspnm.h		7292
X	locid.h		48821
X	measfmt.h		11603
X	measunit.h		97563
X	measure.h		4423
X	messagepattern.h		34521
X	msgfmt.h		45168
X	normalizer2.h		34851
X	normlzr.h		31682
X	nounit.h		2754
X	numberformatter.h		86276
X	numberrangeformatter.h		28617
X	numfmt.h		50950
X	numsys.h		7500
X	parseerr.h		3155
X	parsepos.h		5692
X	platform.h		28751
X	plurfmt.h		25800
X	plurrule.h		18780
X	ptypes.h		3577
X	putil.h		6487
X	rbbi.h		27218
X	rbnf.h		49899
X	rbtz.h		15979
X	regex.h		86367
X	region.h		9404
X	reldatefmt.h		22801
X	rep.h		9599
X	resbund.h		18503
X	schriter.h		6475
X	scientificnumberformatter.h		6553
X	search.h		22757
X	selfmt.h		14643
X	simpleformatter.h		12888
X	simpletz.h		46527
X	smpdtfmt.h		72713
X	sortkey.h		11444
X	std_string.h		1076
X	strenum.h		10158
X	stringoptions.h		5926
X	stringpiece.h		10597
X	stringtriebuilder.h		15698
X	stsearch.h		21810
X	symtable.h		4374
X	tblcoll.h		37489
X	timezone.h		42005
X	tmunit.h		3461
X	tmutamt.h		5015
X	tmutfmt.h		8042
X	translit.h		67400
X	tzfmt.h		43916
X	tznames.h		17252
X	tzrule.h		36215
X	tztrans.h		6271
X	ubidi.h		91711
X	ubiditransform.h		12950
X	ubrk.h		24547
X	ucal.h		58265
X	ucasemap.h		15546
X	ucat.h		5484
X	uchar.h		144630
X	ucharstrie.h		23120
X	ucharstriebuilder.h		7378
X	uchriter.h		13521
X	uclean.h		11474
X	ucnv.h		85085
X	ucnv_cb.h		6748
X	ucnv_err.h		21492
X	ucnvsel.h		6283
X	ucol.h		62939
X	ucoleitr.h		9684
X	uconfig.h		12356
X	ucpmap.h		5663
X	ucptrie.h		23002
X	ucsdet.h		15018
X	ucurr.h		16507
X	udat.h		62851
X	udata.h		15930
X	udateintervalformat.h		10995
X	udatpg.h		27447
X	udisplaycontext.h		6029
X	uenum.h		7970
X	ufieldpositer.h		4461
X	uformattable.h		11198
X	uformattedvalue.h		12413
X	ugender.h		2052
X	uidna.h		34169
X	uiter.h		23319
X	uldnames.h		10702
X	ulistformatter.h		11086
X	uloc.h		54432
X	ulocdata.h		11533
X	umachine.h		14884
X	umisc.h		1365
X	umsg.h		24812
X	umutablecptrie.h		8435
X	unifilt.h		4055
X	unifunct.h		4141
X	unimatch.h		6244
X	unirepl.h		3464
X	uniset.h		66459
X	unistr.h		174523
X	unorm.h		21015
X	unorm2.h		25254
X	unum.h		54743
X	unumberformatter.h		25824
X	unumsys.h		7387
X	uobject.h		10936
X	upluralrules.h		8013
X	uregex.h		73784
X	uregion.h		10073
X	ureldatefmt.h		17409
X	urename.h		134449
X	urep.h		5507
X	ures.h		37415
X	uscript.h		27867
X	usearch.h		39039
X	uset.h		40958
X	usetiter.h		9781
X	ushape.h		18432
X	uspoof.h		67480
X	usprep.h		8331
X	ustdio.h		39469
X	ustream.h		1934
X	ustring.h		74211
X	ustringtrie.h		3224
X	utext.h		59527
X	utf.h		8046
X	utf16.h		23878
X	utf32.h		763
X	utf8.h		31700
X	utf_old.h		46929
X	utmscale.h		14113
X	utrace.h		17706
X	utrans.h		26130
X	utypes.h		31481
X	uvernum.h		6832
X	uversion.h		6145
X	vtzone.h		20784