Adaptive Framework  0.9.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Modules | Data Structures | Macros | Typedefs

Modules

 afw_writer
 

Data Structures

struct  afw_writer_s
 Interface afw_writer public struct. More...
 
struct  afw_writer_inf_s
 Interface afw_writer_inf_s struct. More...
 

Macros

#define AFW_WRITER_INTERFACE_NAME   "afw_writer"
 define for interface afw_writer name.
 
#define afw_writer_release(instance, xctx)
 Call method release of interface afw_writer. More...
 
#define afw_writer_flush(instance, xctx)
 Call method flush of interface afw_writer. More...
 
#define afw_writer_write(instance, buffer, size, xctx)
 Call method write of interface afw_writer. More...
 
#define afw_writer_write_eol(instance, xctx)
 Call method write_eol of interface afw_writer. More...
 
#define afw_writer_increment_indent(instance, xctx)
 Call method increment_indent of interface afw_writer. More...
 
#define afw_writer_decrement_indent(instance, xctx)
 Call method decrement_indent of interface afw_writer. More...
 

Typedefs

typedef void(* afw_writer_release_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_writer_flush_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_writer_write_t) (const afw_writer_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
 
typedef void(* afw_writer_write_eol_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_writer_increment_indent_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
 
typedef void(* afw_writer_decrement_indent_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
 

Detailed Description

An interface for a writer.

Macro Definition Documentation

◆ afw_writer_decrement_indent

#define afw_writer_decrement_indent (   instance,
  xctx 
)
Value:
(instance)->inf->decrement_indent( \
(instance), \
(xctx) \
)

Call method decrement_indent of interface afw_writer.

Parameters
instancePointer to this writer instance.
xctxThis is the caller's xctx.

Definition at line 5703 of file afw_interface.h.

◆ afw_writer_flush

#define afw_writer_flush (   instance,
  xctx 
)
Value:
(instance)->inf->flush( \
(instance), \
(xctx) \
)

Call method flush of interface afw_writer.

Parameters
instancePointer to this writer instance.
xctxThis is the caller's xctx.

Definition at line 5641 of file afw_interface.h.

◆ afw_writer_increment_indent

#define afw_writer_increment_indent (   instance,
  xctx 
)
Value:
(instance)->inf->increment_indent( \
(instance), \
(xctx) \
)

Call method increment_indent of interface afw_writer.

Parameters
instancePointer to this writer instance.
xctxThis is the caller's xctx.

Definition at line 5689 of file afw_interface.h.

◆ afw_writer_release

#define afw_writer_release (   instance,
  xctx 
)
Value:
(instance)->inf->release( \
(instance), \
(xctx) \
)

Call method release of interface afw_writer.

Parameters
instancePointer to this writer instance.
xctxThis is the caller's xctx.

Definition at line 5627 of file afw_interface.h.

◆ afw_writer_write

#define afw_writer_write (   instance,
  buffer,
  size,
  xctx 
)
Value:
(instance)->inf->write( \
(instance), \
(buffer), \
(size), \
(xctx) \
)

Call method write of interface afw_writer.

Parameters
instancePointer to this writer instance.
bufferBuffer to write.
sizeSize of buffer.
xctxThis is the caller's xctx.

Definition at line 5657 of file afw_interface.h.

◆ afw_writer_write_eol

#define afw_writer_write_eol (   instance,
  xctx 
)
Value:
(instance)->inf->write_eol( \
(instance), \
(xctx) \
)

Call method write_eol of interface afw_writer.

Parameters
instancePointer to this writer instance.
xctxThis is the caller's xctx.

Definition at line 5675 of file afw_interface.h.

Typedef Documentation

◆ afw_writer_decrement_indent_t

typedef void(* afw_writer_decrement_indent_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
See also
afw_writer_decrement_indent()

Definition at line 5606 of file afw_interface.h.

◆ afw_writer_flush_t

typedef void(* afw_writer_flush_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
See also
afw_writer_flush()

Definition at line 5580 of file afw_interface.h.

◆ afw_writer_increment_indent_t

typedef void(* afw_writer_increment_indent_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
See also
afw_writer_increment_indent()

Definition at line 5600 of file afw_interface.h.

◆ afw_writer_release_t

typedef void(* afw_writer_release_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
See also
afw_writer_release()

Definition at line 5574 of file afw_interface.h.

◆ afw_writer_write_eol_t

typedef void(* afw_writer_write_eol_t) (const afw_writer_t *instance, afw_xctx_t *xctx)
See also
afw_writer_write_eol()

Definition at line 5594 of file afw_interface.h.

◆ afw_writer_write_t

typedef void(* afw_writer_write_t) (const afw_writer_t *instance, const void *buffer, afw_size_t size, afw_xctx_t *xctx)
See also
afw_writer_write()

Definition at line 5586 of file afw_interface.h.