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


#line 9 "dk4strmo32.ctr"

/**	@file
	String output over dk4_stream_t API,
	32 bit character strings.

	CRT on Windows: Not used.
*/

#include "dk4strm.h"

#ifdef __cplusplus
extern "C" {
#endif

/**	Set output encoding for 32 bit character output.
	@param	strm	Stream to modify.
	@param	oe	New output encoding.
*/
void
dk4stream_set_output_encoding(dk4_stream_t *strm, int oe);

/**	Write one 32 bit character to stream.
	@param	strm	Stream to write to.
	@param	c32	Character to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is null or not set up for writing,
	- DK4_E_ENCODING_FAILED<br>
	  if it is not possible to encode c32 to the output encoding for the
	  stream,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flushing data downwards failed.
*/
int
dk4stream_c32_putc(dk4_stream_t *strm, dk4_c32_t c32, dk4_er_t *erp);

/**	Write one 32 bit character string to stream.
	@param	strm	Stream to write to.
	@param	txt	Text string to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is null or not set up for writing,
	- DK4_E_ENCODING_FAILED<br>
	  if it is not possible to encode c32 to the output encoding for the
	  stream,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flushing data downwards failed.
*/
int
dk4stream_c32_puts(dk4_stream_t *strm, const dk4_c32_t *txt, dk4_er_t *erp);

/**	Write byte order marker for those output encodings
	supporting a BOM.
	@param	strm	Stream to write the BOM to.
	@param	erp	Error report, may be NULL.
	@return	1 on success (BOM written or not required), 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm is null or not set up for writing,
	- DK4_E_ENCODING_FAILED<br>
	  if it is not possible to encode c32 to the output encoding for the
	  stream,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flushing data downwards failed.
*/
int
dk4stream_write_bom_if_necessary(dk4_stream_t *strm, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif