/* 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: dk4stt.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 DK4STT_H_INCLUDED /** Avoid multiple inclusions. */ #define DK4STT_H_INCLUDED 1 #line 9 "dk4stt.ctr" /** @file String table data type. Normally there is no need for you to deal with string tables manually. String tables are handled by the dk4_app_t related functions. CRT on Windows: Optional. */ #ifndef DK4CONF_H_INCLUDED #include "dk4conf.h" #endif #ifndef DK4TYPES_H_INCLUDED #include "dk4types.h" #endif #ifndef DK4STRM_H_INCLUDED #include "dk4strm.h" #endif #ifndef DK4ERROR_H_INCLUDED #include "dk4error.h" #endif /** String table. */ typedef struct { dkChar *shrtfn; /**< Short file name. */ dkChar **strings; /**< Strings read from file. */ size_t nstrings; /**< Number of strings. */ } dk4_string_table_t; #ifdef __cplusplus extern "C" { #endif /** Create string table from file. @param fn Short file name to store in structure. @param sz Number of lines required. @param erp Error report, may be NULL. @return Pointer to new string table structure on success, NULL on error. */ dk4_string_table_t * dk4stt_open(const dkChar *fn, size_t sz, dk4_er_t *erp); /** Apply a text stream to a string table. @param tptr String table to configure. @param strm Text stream, opened for reading. @param pre Processing encoding. @param erp1 Error report for decoding/encoding, may be NULL. @param erp2 Error report for processing, may be NULL. @return 1 on success, 0 on error. */ int dk4stt_apply_stream( dk4_string_table_t *tptr, dk4_stream_t *strm, int pre, dk4_er_t *erp1, dk4_er_t *erp2 ); /** Destroy a string table, free allocated memory. @param ptr String table to destroy. */ void dk4stt_close(dk4_string_table_t *ptr); /** Compare two string tables by short name. @param l Left pointer (always string table). @param r Right pointer (string table or short name). @param cr Comparison criteria (0=string table/string table, 1=string table/short name). @return Comparison result. */ int dk4stt_compare(const void *l, const void *r, int cr); #ifdef __cplusplus } #endif #endif