afw_writer

Files
file	afw_writer_impl_declares.h
	Interface afw_interface implementation declares.

Macros
#define	__AFW_WRITER_IMPL_DECLARES_H__   1
#define	_AFW_IMPLEMENTATION_ID_   "unspecified"
#define	_AFW_IMPLEMENTATION_SPECIFIC_   NULL
#define	_AFW_IMPLEMENTATION_SOURCE_FILE_   __FILE__

Functions
	impl_afw_writer_release (const afw_writer_t *instance, afw_xctx_t *xctx)
	impl_afw_writer_flush (const afw_writer_t *instance, afw_xctx_t *xctx)
	impl_afw_writer_write (const afw_writer_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
	impl_afw_writer_write_eol (const afw_writer_t *instance, afw_xctx_t *xctx)
	impl_afw_writer_increment_indent (const afw_writer_t *instance, afw_xctx_t *xctx)
	impl_afw_writer_decrement_indent (const afw_writer_t *instance, afw_xctx_t *xctx)

Detailed Description

This file should only be included in c source files that implement interface afw_writer.

You can find a skeleton for using this #include file in the corresponding source directory in file generated/interface_closet/skeleton_afw_writer.c.

Mutiple *_impl.declares.h can be included in each c source file, but only one for each interface name.

After the #include for afw_writer_impl_declares.h:

1. declarations will exist for all of the interfaces methods with names of impl_afw_writer_ followed by the method name.
2. rti will be defined with a name of impl_afw_writer_rti.
3. inf will be defined with a name of impl_afw_writer_inf.

Before including, define the following symbols:

• AFW_IMPLEMENTATION_ID - Implementation id string for this implementation.
• AFW_IMPLEMENTATION_INF_SPECIFIER - (optional) defaults to static.
• AFW_IMPLEMENTATION_INF_LABEL - (optional) defaults to impl_afw_writer_inf.

Example:

     static const sometype_t impl_myimpl_stuff =  {
         ...
     };
  
     #define AFW_IMPLEMENTATION_ID "myimpl"
     #define AFW_IMPLEMENTATION_SPECIFIC &impl_myimpl_stuff
     #include "afw_writer_impl_declares.h"
  
   A second #include "afw_writer_impl_declares.h" can be specified if
" *   #define "AFW_WRITER_INF_ONLY" is specified to generate inf only."

Function Documentation

impl_afw_writer_write()

impl_afw_writer_write	(	const afw_writer_t *	instance,
		const void *	buffer,
		afw_size_t	size,
		afw_xctx_t *	xctx
	)

Todo:

loop if everything is not returned???

Definition at line 125 of file afw_utf8_writer.c.

impl_afw_writer_write_eol()

impl_afw_writer_write_eol	(	const afw_writer_t *	instance,
		afw_xctx_t *	xctx
	)

Todo:

loop if everything is not returned???

Definition at line 160 of file afw_utf8_writer.c.