summaryrefslogtreecommitdiffstats
path: root/intl/icu/source/i18n/csrecog.h
diff options
context:
space:
mode:
Diffstat (limited to 'intl/icu/source/i18n/csrecog.h')
-rw-r--r--intl/icu/source/i18n/csrecog.h57
1 files changed, 57 insertions, 0 deletions
diff --git a/intl/icu/source/i18n/csrecog.h b/intl/icu/source/i18n/csrecog.h
new file mode 100644
index 000000000..4d0918ba9
--- /dev/null
+++ b/intl/icu/source/i18n/csrecog.h
@@ -0,0 +1,57 @@
+// Copyright (C) 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
+/*
+ **********************************************************************
+ * Copyright (C) 2005-2012, International Business Machines
+ * Corporation and others. All Rights Reserved.
+ **********************************************************************
+ */
+
+#ifndef __CSRECOG_H
+#define __CSRECOG_H
+
+#include "unicode/uobject.h"
+
+#if !UCONFIG_NO_CONVERSION
+
+#include "inputext.h"
+
+U_NAMESPACE_BEGIN
+
+class CharsetMatch;
+
+class CharsetRecognizer : public UMemory
+{
+ public:
+ /**
+ * Get the IANA name of this charset.
+ * Note that some recognizers can recognize more than one charset, but that this API
+ * assumes just one name per recognizer.
+ * TODO: need to account for multiple names in public API that enumerates over the
+ * known detectable charsets.
+ * @return the charset name.
+ */
+ virtual const char *getName() const = 0;
+
+ /**
+ * Get the ISO language code for this charset.
+ * @return the language code, or <code>null</code> if the language cannot be determined.
+ */
+ virtual const char *getLanguage() const;
+
+ /*
+ * Try the given input text against this Charset, and fill in the results object
+ * with the quality of the match plus other information related to the match.
+ *
+ * Return TRUE if the the input bytes are a potential match, and
+ * FALSE if the input data is not compatible with, or illegal in this charset.
+ */
+ virtual UBool match(InputText *textIn, CharsetMatch *results) const = 0;
+
+ virtual ~CharsetRecognizer();
+};
+
+U_NAMESPACE_END
+
+#endif
+#endif /* __CSRECOG_H */