uchardet/src/uchardet.h
Jehan dc371f3ba9 uchardet_get_charset() must return iconv-compatible names.
It was not clear if our naming followed any kind of rules. In particular,
iconv is a widely used encoding conversion API. We will follow its
naming.
At least 1 returned name was found invalid: x-euc-tw instead of EUC-TW.
Other names have been uppercased to follow naming from `iconv --list`
though iconv is mostly case-insensitive so it should not have been a
problem. "Just in case".
Prober names can still have free naming (only used for output display
apparently).
Finally HZ-GB-2312 is absent from my iconv list, but I can still see
this encoding in libiconv master code with this name. So I will
consider it valid.
2015-11-17 16:15:21 +01:00

93 lines
2.9 KiB
C

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Universal charset detector code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* BYVoid <byvoid.kcp@gmail.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef UCHARDET_H___
#define UCHARDET_H___
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h>
typedef struct uchardet * uchardet_t;
/**
* Create an encoding detector.
* @return a handle of a instance of uchardet
*/
uchardet_t uchardet_new(void);
/**
* Delete an encoding detector.
* @param ud [in] handle of a instance of uchardet
*/
void uchardet_delete(uchardet_t ud);
/**
* Feed data to an encoding detector.
* @param ud [in] handle of a instance of uchardet
* @param data [in] data
* @param len [in] number of byte of data
* @return non-zero number on failure.
*/
int uchardet_handle_data(uchardet_t ud, const char * data, size_t len);
/**
* Notify an end of data to an encoding detctor.
* @param ud [in] handle of a instance of uchardet
*/
void uchardet_data_end(uchardet_t ud);
/**
* Reset an encoding detector.
* @param ud [in] handle of a instance of uchardet
*/
void uchardet_reset(uchardet_t ud);
/**
* Get an iconv-compatible name of the encoding that was detected.
* @param ud [in] handle of a instance of uchardet
* @return name of charset on success and "" on failure or pure ascii.
*/
const char * uchardet_get_charset(uchardet_t ud);
#ifdef __cplusplus
}
#endif
#endif