/* WARNING: This file was generated by dkct. Changes you make here will be lost if dkct is run again! You should modify the original source and run dkct on it. Original source: dk4tsp08.ctr */ /* Copyright (C) 2015-2017, Dirk Krause Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above opyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the author nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef DK4TSP08_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4TSP08_H_INCLUDED 1 #line 10 "dk4tsp08.ctr" /** @file dk4tsp08.h Text stream processing for 8 bit characters. CRT on Windows: Optional. */ #ifndef DK4CONF_H_INCLUDED #include "dk4conf.h" #endif #ifndef DK4TYPES_H_INCLUDED #include "dk4types.h" #endif #ifndef DK4ERROR_H_INCLUDED #include "dk4error.h" #endif #ifndef DK4BOM_H_INCLUDED #include "dk4bom.h" #endif #ifndef DK4TSP_H_INCLUDED #include "dk4tsp.h" #endif #ifndef DK4UTF8_H_INCLUDED #include "dk4utf8.h" #endif #ifndef DK4UTF16_H_INCLUDED #include "dk4utf16.h" #endif #ifndef DK4C32_H_INCLUDED #include "dk4c32.h" #endif /** Handler function for single characters. @param obj Object to modify while processing the character. @param c Character to process. @param pos Current position in file or data stream. @param erp Error report, may be NULL. @return DK4_TSP_RES_OK if the character was processed successfully, DK4_TSP_RES_ERROR if there was an error but we can continue, DK4_TSP_RES_FATAL if there was a fatal error so we should abort processing. */ typedef int dk4_c8_handler_t( void *obj, char c, dk4_text_stream_position_t *pos, dk4_er_t *erp ); /** Handler function for text lines. @param obj Object to modify while processing the character. @param line Text line to process. @param lineno Current line number. @param erp Error report, may be NULL. @return DK4_TSP_RES_OK if the character was processed successfully, DK4_TSP_RES_ERROR if there was an error but we can continue, DK4_TSP_RES_FATAL if there was a fatal error so we should abort processing. */ typedef int dk4_c8_line_handler_t( void *obj, char *line, dk4_um_t lineno, dk4_er_t *erp ); /** Structure for 8 bit character processing. */ typedef struct { union { dk4_utf8_decoder_t u08; /**< UTF-8 decoder. */ dk4_utf16_byte_decoder_t u16; /**< UTF-16 decoder. */ dk4_c32_byte_decoder_t c32; /**< 32 bit char decoder. */ } dec; /**< Input decoder. */ dk4_bom_detector_t bomd; /**< BOM detector. */ dk4_text_stream_position_t pos; /**< Current position. */ dk4_er_t er_en; /**< Errors in input decoding. */ dk4_er_t er_pr; /**< Errors in processing. */ union { dk4_c8_line_handler_t *lh; /**< Handler function for lines. */ dk4_c8_handler_t *ch; /**< Handler function for char. */ } fct; /**< Handler function. */ char *inbuf; /**< Buffer for input line. */ void *obj; /**< Object to modify in processing. */ size_t in_sz; /**< Size of input line buffer. */ size_t in_us; /**< Used bytes in input line buffer. */ int upt; /**< Flag: Enable UTF-8 pass through. */ int ief; /**< Input encoding found. */ int iee; /**< Input encoding expected. */ int pen; /**< Encoding for processing. */ int pst; /**< Processing stage. */ int pth; /**< Flag: Pass through. */ } dk4_tsp08_t; #ifdef __cplusplus extern "C" { #endif /** Set up processor for byte by byte processing. @param tsp Processor to set up. @param obj Object to modify when processing input, may be NULL. @param fct Handler function to call for each character. @param pre Encoding required for processing. @param eie Expected input encoding. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if tsp or fct is NULL or pre is not an encoding for 8-bit characters. */ int dk4tsp08_setup_char( dk4_tsp08_t *tsp, void *obj, dk4_c8_handler_t *fct, int pre, int eie, dk4_er_t *erp ); /** Set up processor for line processing. @param tsp Processor to set up. @param obj Object to modify when processing input, may be NULL. @param fct Handler function to invoke for each line. @param inbuf Input line buffer. @param szin Size of input line buffer. @param pre Encoding required for processing. @param eie Expected input encoding. @param erp Error report, may be NULL. @return 1 on success, 0 on error. Error codes: - DK4_E_INVALID_ARGUMENTS
if tsp, fct or inbuf is NULL, szin is 0 or pre is not a valid encoding for 8-bit characters. */ int dk4tsp08_setup_line( dk4_tsp08_t *tsp, void *obj, dk4_c8_line_handler_t *fct, char *inbuf, size_t szin, int pre, int eie, dk4_er_t *erp ); /** Enable or disable pass-through of UTF-8 encoded data. Use this function after dk4tsp08_setup_line() or dk4tsp08_setup_char() but before adding the first byte. @param tsp Text stream processor to configure. @param fl Flag: Enabled. */ void dk4tsp08_enable_utf8_pass_through(dk4_tsp08_t *tsp, int fl); /** Add one single byte. @param tsp Text stream processor. @param inbyte Byte to process. @return DK4_TSP_RES_OK if the character was processed successfully, DK4_TSP_RES_ERROR if there was an error but we can continue, DK4_TSP_RES_FATAL if there was a fatal error so we should abort processing. */ int dk4tsp08_add_one_byte( dk4_tsp08_t *tsp, unsigned char inbyte ); /** Add multiple bytes. @param tsp Text stream processor. @param buffer Buffer start address. @param sz Number of bytes in buffer. @return DK4_TSP_RES_OK if the character was processed successfully, DK4_TSP_RES_ERROR if there was an error but we can continue, DK4_TSP_RES_FATAL if there was a fatal error so we should abort processing. */ int dk4tsp08_add_bytes( dk4_tsp08_t *tsp, const unsigned char *buffer, size_t sz ); /** Finish processing. @param tsp Text stream processor. @return DK4_TSP_RES_OK if processing was finished successfully, DK4_TSP_RES_ERROR if there was an error, DK4_TSP_RES_FATAL if there was a fatal error. */ int dk4tsp08_finish(dk4_tsp08_t *tsp); /** Retrieve error reports for encoding/decoding and processing. @param er_en Destination error report buffer for encoding/decoding. @param er_pr Destination error report buffer for processing. @param tsp Text stream processor to retrieve errors from. Error codes er_en: - DK4_E_BUFFER_TOO_SMALL
if the input buffer provided in dk4tsp08_setup_line() is too small, - DK4_E_INVALID_ARGUMENTS
if no character processing function was provided, - DK4_E_DECODING_FAILED
if there were decoding errors, - DK4_E_ENCODING_FAILED
if there were encoding errors. Error codes er_pr: - The error codes returned in er_pr depend on the processing function. */ void dk4tsp08_get_errors(dk4_er_t *er_en, dk4_er_t *er_pr, dk4_tsp08_t *tsp); #ifdef __cplusplus } #endif #endif