/* Copyright (C) 2015-2020, Dirk Krause SPDX-License-Identifier: BSD-3-Clause */ /* WARNING: This file was generated by the dkct program (see http://dktools.sourceforge.net/ for details). 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: dk4tspdk.ctr */ #ifndef DK4TSPDK_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4TSPDK_H_INCLUDED 1 #line 10 "dk4tspdk.ctr" /** @file Text stream processing for dkChar characters. CRT on Windows: Optional. */ #ifndef DK4CONF_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4conf.h" #else #include #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #endif #endif #if DK4_CHAR_SIZE > 1 #if DK4_CHAR_SIZE > 2 /* +++++ dkChar 4 bytes */ #ifndef DK4TSP32_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4tsp32.h" #else #include #endif #endif /** Handler function to process a single character. */ typedef dk4_c32_handler_t dk4_dk_handler_t; /** Handler function to process an input line. */ typedef dk4_c32_line_handler_t dk4_dk_line_handler_t; /** Text stream processor. */ typedef dk4_tsp32_t dk4_tspdk_t; /* ----- dkChar 4 bytes */ #else /* +++++ dkChar 2 bytes */ #ifndef DK4TSP16_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4tsp16.h" #else #include #endif #endif /** Handler function to process a single character. */ typedef dk4_c16_handler_t dk4_dk_handler_t; /** Handler function to process an input line. */ typedef dk4_c16_line_handler_t dk4_dk_line_handler_t; /** Text stream processor. */ typedef dk4_tsp16_t dk4_tspdk_t; /* ----- dkChar 2 bytes */ #endif #else /* +++++ dkChar 1 byte */ #ifndef DK4TSP08_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4tsp08.h" #else #include #endif #endif /** Handler function to process a single character. */ typedef dk4_c8_handler_t dk4_dk_handler_t; /** Handler function to process an input line. */ typedef dk4_c8_line_handler_t dk4_dk_line_handler_t; /** Text stream processor. */ typedef dk4_tsp08_t dk4_tspdk_t; /* ----- dkChar 1 byte */ #endif #ifdef __cplusplus extern "C" { #endif /** Set up processor for char by char 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. */ int dk4tspdk_setup_char( dk4_tspdk_t *tsp, void *obj, dk4_dk_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. */ int dk4tspdk_setup_line( dk4_tspdk_t *tsp, void *obj, dk4_dk_line_handler_t *fct, dkChar *inbuf, size_t szin, int pre, int eie, dk4_er_t *erp ); /** Allow pass-through of UTF-8 encoded data. @param tsp Text stream processor to set up. @param fl Flag: Enable pass-through of UTF-8 encoded data. */ void dk4tspdk_enable_utf8_pass_through(dk4_tspdk_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 dk4tspdk_add_one_byte( dk4_tspdk_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 dk4tspdk_add_bytes( dk4_tspdk_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 dk4tspdk_finish(dk4_tspdk_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. */ void dk4tspdk_get_errors(dk4_er_t *er_en, dk4_er_t *er_pr, dk4_tspdk_t const *tsp); #ifdef __cplusplus } #endif #endif