ICU 76.1: common/unicode/ucnvsel.h Source File

ICU 76.1 76.1

ucnvsel.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) 2008-2011, International Business Machines
7* Corporation, Google and others. All Rights Reserved.
8*
9*******************************************************************************
10*/
11/*
12 * Author : eldawy@google.com (Mohamed Eldawy)
13 * ucnvsel.h
14 *
15 * Purpose: To generate a list of encodings capable of handling
16 * a given Unicode text
17 *
18 * Started 09-April-2008
19 */
20
21#ifndef __ICU_UCNV_SEL_H__
22#define __ICU_UCNV_SEL_H__
23
24#include "unicode/utypes.h"
25
26#if !UCONFIG_NO_CONVERSION
27
28#include "unicode/uset.h"
29#include "unicode/utf16.h"
30#include "unicode/uenum.h"
31#include "unicode/ucnv.h"
32
33#if U_SHOW_CPLUSPLUS_API
34#include "unicode/localpointer.h"
35#endif // U_SHOW_CPLUSPLUS_API
36
49struct UConverterSelector;
54 typedef struct UConverterSelector UConverterSelector;
79 U_CAPI UConverterSelector* U_EXPORT2
80ucnvsel_open(const char* const* converterList, int32_t converterListSize,
81 const USet* excludedCodePoints,
82 const UConverterUnicodeSet whichSet, UErrorCode* status);
83
97 U_CAPI void U_EXPORT2
98ucnvsel_close(UConverterSelector *sel);
99
100#if U_SHOW_CPLUSPLUS_API
101
102U_NAMESPACE_BEGIN
103
113 U_DEFINE_LOCAL_OPEN_POINTER(LocalUConverterSelectorPointer, UConverterSelector, ucnvsel_close);
114
115U_NAMESPACE_END
116
117#endif
118
134 U_CAPI UConverterSelector* U_EXPORT2
135ucnvsel_openFromSerialized(const void* buffer, int32_t length, UErrorCode* status);
136
151 U_CAPI int32_t U_EXPORT2
152ucnvsel_serialize(const UConverterSelector* sel,
153 void* buffer, int32_t bufferCapacity, UErrorCode* status);
154
169 U_CAPI UEnumeration * U_EXPORT2
170ucnvsel_selectForString(const UConverterSelector* sel,
171 const UChar *s, int32_t length, UErrorCode *status);
172
187 U_CAPI UEnumeration * U_EXPORT2
188ucnvsel_selectForUTF8(const UConverterSelector* sel,
189 const char *s, int32_t length, UErrorCode *status);
190
191#endif /* !UCONFIG_NO_CONVERSION */
192
193#endif /* __ICU_UCNV_SEL_H__ */
LocalUConverterSelectorPointer
"Smart pointer" class, closes a UConverterSelector via ucnvsel_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
ucnv.h
C API: Character conversion.
UConverterUnicodeSet
UConverterUnicodeSet
Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet().
Definition ucnv.h:952
ucnvsel_serialize
U_CAPI int32_t ucnvsel_serialize(const UConverterSelector *sel, void *buffer, int32_t bufferCapacity, UErrorCode *status)
Serialize a selector into a linear buffer.
ucnvsel_selectForString
U_CAPI UEnumeration * ucnvsel_selectForString(const UConverterSelector *sel, const UChar *s, int32_t length, UErrorCode *status)
Select converters that can map all characters in a UTF-16 string, ignoring the excluded code points.
UConverterSelector
struct UConverterSelector UConverterSelector
Typedef for selector data structure.
Definition ucnvsel.h:54
ucnvsel_open
U_CAPI UConverterSelector * ucnvsel_open(const char *const *converterList, int32_t converterListSize, const USet *excludedCodePoints, const UConverterUnicodeSet whichSet, UErrorCode *status)
Open a selector.
ucnvsel_selectForUTF8
U_CAPI UEnumeration * ucnvsel_selectForUTF8(const UConverterSelector *sel, const char *s, int32_t length, UErrorCode *status)
Select converters that can map all characters in a UTF-8 string, ignoring the excluded code points.
ucnvsel_close
U_CAPI void ucnvsel_close(UConverterSelector *sel)
Closes a selector.
ucnvsel_openFromSerialized
U_CAPI UConverterSelector * ucnvsel_openFromSerialized(const void *buffer, int32_t length, UErrorCode *status)
Open a selector from its serialized form.
uenum.h
C API: String Enumeration.
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition uenum.h:44
UChar
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:378
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition umachine.h:110
uset.h
C API: Unicode Set.
USet
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition uset.h:53
utf16.h
C API: 16-bit Unicode handling macros.
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:430