/*
Copyright (C) 2015-2021, 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: dk4stt.ctr
*/

#ifndef DK4STT_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4STT_H_INCLUDED 1


/**	@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
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include <libdk4base/dk4types.h>
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4STRM_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include <libdk4c/dk4strm.h>
#else
#include <dktools-4/dk4strm.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include <libdk4base/dk4error.h>
#else
#include <dktools-4/dk4error.h>
#endif
#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	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		*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