ICU 56.1: ucsdet.h Source File

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

ucsdet.h
Go to the documentation of this file.
1 /*
2 **********************************************************************
3 * Copyright (C) 2005-2013, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 **********************************************************************
6 * file name: ucsdet.h
7 * encoding: US-ASCII
8 * indentation:4
9 *
10 * created on: 2005Aug04
11 * created by: Andy Heninger
12 *
13 * ICU Character Set Detection, API for C
14 *
15 * Draft version 18 Oct 2005
16 *
17 */
18
19 #ifndef __UCSDET_H
20 #define __UCSDET_H
21
22 #include "unicode/utypes.h"
23
24 #if !UCONFIG_NO_CONVERSION
25
26 #include "unicode/localpointer.h"
27 #include "unicode/uenum.h"
28
49 struct UCharsetDetector;
54 typedef struct UCharsetDetector UCharsetDetector;
55
56 struct UCharsetMatch;
62 typedef struct UCharsetMatch UCharsetMatch;
63
72 U_STABLE UCharsetDetector * U_EXPORT2
73 ucsdet_open(UErrorCode *status);
74
84 U_STABLE void U_EXPORT2
85 ucsdet_close(UCharsetDetector *ucsd);
86
87 #if U_SHOW_CPLUSPLUS_API
88
89 U_NAMESPACE_BEGIN
90
100 U_DEFINE_LOCAL_OPEN_POINTER(LocalUCharsetDetectorPointer, UCharsetDetector, ucsdet_close);
101
102 U_NAMESPACE_END
103
104 #endif
105
121 U_STABLE void U_EXPORT2
122 ucsdet_setText(UCharsetDetector *ucsd, const char *textIn, int32_t len, UErrorCode *status);
123
124
143 U_STABLE void U_EXPORT2
144 ucsdet_setDeclaredEncoding(UCharsetDetector *ucsd, const char *encoding, int32_t length, UErrorCode *status);
145
146
172 U_STABLE const UCharsetMatch * U_EXPORT2
173 ucsdet_detect(UCharsetDetector *ucsd, UErrorCode *status);
174
175
206 U_STABLE const UCharsetMatch ** U_EXPORT2
207 ucsdet_detectAll(UCharsetDetector *ucsd, int32_t *matchesFound, UErrorCode *status);
208
209
210
226 U_STABLE const char * U_EXPORT2
227 ucsdet_getName(const UCharsetMatch *ucsm, UErrorCode *status);
228
252 U_STABLE int32_t U_EXPORT2
253 ucsdet_getConfidence(const UCharsetMatch *ucsm, UErrorCode *status);
254
284 U_STABLE const char * U_EXPORT2
285 ucsdet_getLanguage(const UCharsetMatch *ucsm, UErrorCode *status);
286
287
310 U_STABLE int32_t U_EXPORT2
311 ucsdet_getUChars(const UCharsetMatch *ucsm,
312 UChar *buf, int32_t cap, UErrorCode *status);
313
314
315
344 U_STABLE UEnumeration * U_EXPORT2
345 ucsdet_getAllDetectableCharsets(const UCharsetDetector *ucsd, UErrorCode *status);
346
358 U_STABLE UBool U_EXPORT2
359 ucsdet_isInputFilterEnabled(const UCharsetDetector *ucsd);
360
361
373 U_STABLE UBool U_EXPORT2
374 ucsdet_enableInputFilter(UCharsetDetector *ucsd, UBool filter);
375
376 #ifndef U_HIDE_INTERNAL_API
377
390 U_INTERNAL UEnumeration * U_EXPORT2
391 ucsdet_getDetectableCharsets(const UCharsetDetector *ucsd, UErrorCode *status);
392
406 U_INTERNAL void U_EXPORT2
407 ucsdet_setDetectableCharset(UCharsetDetector *ucsd, const char *encoding, UBool enabled, UErrorCode *status);
408 #endif /* U_HIDE_INTERNAL_API */
409
410 #endif
411 #endif /* __UCSDET_H */
412
413
ucsdet_setDetectableCharset
void ucsdet_setDetectableCharset(UCharsetDetector *ucsd, const char *encoding, UBool enabled, UErrorCode *status)
Enable or disable individual charset encoding.
ucsdet_enableInputFilter
UBool ucsdet_enableInputFilter(UCharsetDetector *ucsd, UBool filter)
Enable filtering of input text.
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:39
ucsdet_getName
const char * ucsdet_getName(const UCharsetMatch *ucsm, UErrorCode *status)
Get the name of the charset represented by a UCharsetMatch.
U_INTERNAL
#define U_INTERNAL
This is used to declare a function as an internal ICU C API.
Definition: umachine.h:117
ucsdet_close
void ucsdet_close(UCharsetDetector *ucsd)
Close a charset detector.
ucsdet_getUChars
int32_t ucsdet_getUChars(const UCharsetMatch *ucsm, UChar *buf, int32_t cap, UErrorCode *status)
Get the entire input text as a UChar string, placing it into a caller-supplied buffer.
ucsdet_getDetectableCharsets
UEnumeration * ucsdet_getDetectableCharsets(const UCharsetDetector *ucsd, UErrorCode *status)
Get an iterator over the set of detectable charsets - over the charsets that are enabled by the speci...
ucsdet_detect
const UCharsetMatch * ucsdet_detect(UCharsetDetector *ucsd, UErrorCode *status)
Return the charset that best matches the supplied input data.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
ucsdet_setText
void ucsdet_setText(UCharsetDetector *ucsd, const char *textIn, int32_t len, UErrorCode *status)
Set the input byte data whose charset is to detected.
ucsdet_setDeclaredEncoding
void ucsdet_setDeclaredEncoding(UCharsetDetector *ucsd, const char *encoding, int32_t length, UErrorCode *status)
Set the declared encoding for charset detection.
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:535
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
UCharsetDetector
struct UCharsetDetector UCharsetDetector
Structure representing a charset detector.
Definition: ucsdet.h:54
LocalUCharsetDetectorPointer
"Smart pointer" class, closes a UCharsetDetector via ucsdet_close().
UChar
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
ucsdet_detectAll
const UCharsetMatch ** ucsdet_detectAll(UCharsetDetector *ucsd, int32_t *matchesFound, UErrorCode *status)
Find all charset matches that appear to be consistent with the input, returning an array of results...
ucsdet_getAllDetectableCharsets
UEnumeration * ucsdet_getAllDetectableCharsets(const UCharsetDetector *ucsd, UErrorCode *status)
Get an iterator over the set of all detectable charsets - over the charsets that are known to the cha...
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
ucsdet_open
UCharsetDetector * ucsdet_open(UErrorCode *status)
Open a charset detector.
uenum.h
C API: String Enumeration.
ucsdet_getConfidence
int32_t ucsdet_getConfidence(const UCharsetMatch *ucsm, UErrorCode *status)
Get a confidence number for the quality of the match of the byte data with the charset.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
ucsdet_isInputFilterEnabled
UBool ucsdet_isInputFilterEnabled(const UCharsetDetector *ucsd)
Test whether input filtering is enabled for this charset detector.
ucsdet_getLanguage
const char * ucsdet_getLanguage(const UCharsetMatch *ucsm, UErrorCode *status)
Get the RFC 3066 code for the language of the input data.
UCharsetMatch
struct UCharsetMatch UCharsetMatch
Opaque structure representing a match that was identified from a charset detection operation...
Definition: ucsdet.h:62
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234