/*
	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: dk4rec03.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 DK4REC03_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4REC03_H_INCLUDED 1


#line 9 "dk4rec03.ctr"

/**	@file
	String recoding from ASCII to UTF-8.

	CRT on Windows: Not used.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Recode string from ASCII to UTF-8.
	@param	dstb	Destination buffer.
	@param	szdstb	Size of destination buffer (number of bytes).
	@param	src	Source string to convert.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if src or dstb is NULL or szdstb is 0,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if dstb is too small,
	- DK4_E_SYNTAX<br>
	  with the number of successfully recoded characters in nelem if a
	  non-recodable character was found.
*/
int
dk4recode_ascii_to_utf8(
  char *dstb, size_t szdstb, const char *src, dk4_er_t *erp
);

/**	Calculate required buffer size (including final 0x00 byte)
	for ASCII to UTF-8 conversion.
	@param	src	ASCII encoded string.
	@param	erp	Error report, may be NULL.
	@return	Positive value on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if src is NULL,
	- DK4_E_SYNTAX<br>
	  if there are encoding errors,
	- DK4_E_MATH_OVERFLOW<br>
	  if a numeric overflow occured in size calculation.
*/
size_t
dk4recode_size_ascii_to_utf8(const char *src, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif