codec.h

Go to the documentation of this file.

/*
 * This file is part of LibParserUtils.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2007 John-Mark Bell <jmb@netsurf-browser.org>
 */
 
#ifndef parserutils_charset_codec_h_
#define parserutils_charset_codec_h_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <inttypes.h>
 
#include <parserutils/errors.h>
#include <parserutils/functypes.h>
 
typedef struct parserutils_charset_codec parserutils_charset_codec;
 
#define PARSERUTILS_CHARSET_CODEC_NULL (0xffffffffU)
 
typedef enum parserutils_charset_codec_errormode {
    PARSERUTILS_CHARSET_CODEC_ERROR_STRICT   = 0,
    PARSERUTILS_CHARSET_CODEC_ERROR_LOOSE    = 1,
    PARSERUTILS_CHARSET_CODEC_ERROR_TRANSLIT = 2
} parserutils_charset_codec_errormode;
 
typedef enum parserutils_charset_codec_opttype {
    PARSERUTILS_CHARSET_CODEC_ERROR_MODE  = 1
} parserutils_charset_codec_opttype;
 
typedef union parserutils_charset_codec_optparams {
    struct {
        parserutils_charset_codec_errormode mode;
    } error_mode;
} parserutils_charset_codec_optparams;
 
 
/* Create a charset codec */
parserutils_error parserutils_charset_codec_create(const char *charset,
        parserutils_charset_codec **codec);
/* Destroy a charset codec */
parserutils_error parserutils_charset_codec_destroy(
        parserutils_charset_codec *codec);
 
/* Configure a charset codec */
parserutils_error parserutils_charset_codec_setopt(
        parserutils_charset_codec *codec,
        parserutils_charset_codec_opttype type, 
        parserutils_charset_codec_optparams *params);
 
/* Encode a chunk of UCS-4 data into a codec's charset */
parserutils_error parserutils_charset_codec_encode(
        parserutils_charset_codec *codec,
        const uint8_t **source, size_t *sourcelen,
        uint8_t **dest, size_t *destlen);
 
/* Decode a chunk of data in a codec's charset into UCS-4 */
parserutils_error parserutils_charset_codec_decode(
        parserutils_charset_codec *codec,
        const uint8_t **source, size_t *sourcelen,
        uint8_t **dest, size_t *destlen);
 
/* Reset a charset codec */
parserutils_error parserutils_charset_codec_reset(
        parserutils_charset_codec *codec);
 
#ifdef __cplusplus
}
#endif
 
#endif