afw_content_type

Modules
	afw_content_type

Data Structures
struct	afw_content_type_s
	Interface afw_content_type public struct. More...
struct	afw_content_type_inf_s
	Interface afw_content_type_inf_s struct. More...

Macros
#define	AFW_CONTENT_TYPE_INTERFACE_NAME   "afw_content_type"
	define for interface afw_content_type name.
#define	afw_content_type_raw_to_value(instance, raw, source_location, p, xctx)
	Call method raw_to_value of interface afw_content_type. More...
#define	afw_content_type_raw_to_object(instance, raw, source_location, adaptor_id, object_type_id, object_id, cede_p, p, xctx)
	Call method raw_to_object of interface afw_content_type. More...
#define	afw_content_type_write_value(instance, value, options, context, callback, p, xctx)
	Call method write_value of interface afw_content_type. More...
#define	afw_content_type_create_object_list_writer(instance, options, context, callback, p, xctx)
	Call method create_object_list_writer of interface afw_content_type. More...

Typedefs
typedef const afw_value_t *(*	afw_content_type_raw_to_value_t) (const afw_content_type_t *instance, const afw_memory_t *raw, const afw_utf8_t *source_location, const afw_pool_t *p, afw_xctx_t *xctx)
typedef const afw_object_t *(*	afw_content_type_raw_to_object_t) (const afw_content_type_t *instance, const afw_memory_t *raw, const afw_utf8_t *source_location, const afw_utf8_t *adaptor_id, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, afw_boolean_t cede_p, const afw_pool_t *p, afw_xctx_t *xctx)
typedef void(*	afw_content_type_write_value_t) (const afw_content_type_t *instance, const afw_value_t *value, const afw_object_options_t *options, void *context, afw_write_cb_t callback, const afw_pool_t *p, afw_xctx_t *xctx)
typedef const afw_content_type_object_list_writer_t *(*	afw_content_type_create_object_list_writer_t) (const afw_content_type_t *instance, const afw_object_options_t *options, void *context, afw_write_cb_t callback, const afw_pool_t *p, afw_xctx_t *xctx)

Detailed Description

Adaptive Content Type.

Macro Definition Documentation

afw_content_type_create_object_list_writer

#define afw_content_type_create_object_list_writer	(		instance,
			options,
			context,
			callback,
			p,
			xctx
	)

Value:

(instance)->inf->create_object_list_writer( \
    (instance), \
    (options), \
    (context), \
    (callback), \
    (p), \
    (xctx) \
)

Call method create_object_list_writer of interface afw_content_type.

Parameters

instance	Pointer to this content type instance.
options	These options can determine if none, some, or all object meta information should be included in output. See afw_object_options_t for more information. Only options flagged for use by content type processing are honored. All other options are ignored. For instance, a call to afw_object_view_create() with the composite option is needed before calling a content type write function if inherited properties should be included in output.
context	Pointer passed to callback routine.
callback	Callback function that will be called each time the object list writer has something to write.
p	Pool to use.
xctx	This is the caller's xctx.

Definition at line 1982 of file afw_interface.h.

afw_content_type_raw_to_object

#define afw_content_type_raw_to_object	(		instance,
			raw,
			source_location,
			adaptor_id,
			object_type_id,
			object_id,
			cede_p,
			p,
			xctx
	)

Value:

(instance)->inf->raw_to_object( \
    (instance), \
    (raw), \
    (source_location), \
    (adaptor_id), \
    (object_type_id), \
    (object_id), \
    (cede_p), \
    (p), \
    (xctx) \
)

Call method raw_to_object of interface afw_content_type.

Parameters

instance	Pointer to this content type instance.
raw	Raw encoded object representation of this content type.
source_location	Source location or NULL.
adaptor_id	Adaptor id for created object.
object_type_id	Object type id for created object.
object_id	Object id for created object.
cede_p	If true, cede control of p to the created object. If false, a subpool will be created in p for the object.
p	The pool to use.
xctx	This is the caller's xctx.

Definition at line 1907 of file afw_interface.h.

afw_content_type_raw_to_value

#define afw_content_type_raw_to_value	(		instance,
			raw,
			source_location,
			p,
			xctx
	)

Value:

(instance)->inf->raw_to_value( \
    (instance), \
    (raw), \
    (source_location), \
    (p), \
    (xctx) \
)

Call method raw_to_value of interface afw_content_type.

Parameters

instance	Pointer to this content type instance.
raw	Raw encoded representation of this content type.
source_location	Source location or NULL.
p	Pool to use to hold returned value.
xctx	This is the caller's xctx.

Definition at line 1879 of file afw_interface.h.

afw_content_type_write_value

#define afw_content_type_write_value	(		instance,
			value,
			options,
			context,
			callback,
			p,
			xctx
	)

Value:

(instance)->inf->write_value( \
    (instance), \
    (value), \
    (options), \
    (context), \
    (callback), \
    (p), \
    (xctx) \
)

Call method write_value of interface afw_content_type.

Parameters

instance	Pointer to this content type instance.
value	Adaptive value to convert and write.
options	These options can determine if none, some, or all object meta information should be included in output. See afw_object_options_t for more information. Only options flagged for use by content type processing are honored. All other options are ignored. For instance, a call to afw_object_view_create() with the composite option is needed before calling a content type write function if inherited properties should be included in output.
context	Pointer passed to callback routine.
callback	Callback function that will be called to write multiple times to write the raw representation of the value.
p	Pool to use.
xctx	This is the caller's xctx.

Definition at line 1947 of file afw_interface.h.

Typedef Documentation

afw_content_type_create_object_list_writer_t

typedef const afw_content_type_object_list_writer_t*(* afw_content_type_create_object_list_writer_t) (const afw_content_type_t *instance, const afw_object_options_t *options, void *context, afw_write_cb_t callback, const afw_pool_t *p, afw_xctx_t *xctx)

See also

afw_content_type_create_object_list_writer()

Definition at line 1853 of file afw_interface.h.

afw_content_type_raw_to_object_t

typedef const afw_object_t*(* afw_content_type_raw_to_object_t) (const afw_content_type_t *instance, const afw_memory_t *raw, const afw_utf8_t *source_location, const afw_utf8_t *adaptor_id, const afw_utf8_t *object_type_id, const afw_utf8_t *object_id, afw_boolean_t cede_p, const afw_pool_t *p, afw_xctx_t *xctx)

See also

afw_content_type_raw_to_object()

Definition at line 1829 of file afw_interface.h.

afw_content_type_raw_to_value_t

typedef const afw_value_t*(* afw_content_type_raw_to_value_t) (const afw_content_type_t *instance, const afw_memory_t *raw, const afw_utf8_t *source_location, const afw_pool_t *p, afw_xctx_t *xctx)

See also

afw_content_type_raw_to_value()

Definition at line 1820 of file afw_interface.h.

afw_content_type_write_value_t

typedef void(* afw_content_type_write_value_t) (const afw_content_type_t *instance, const afw_value_t *value, const afw_object_options_t *options, void *context, afw_write_cb_t callback, const afw_pool_t *p, afw_xctx_t *xctx)

See also

afw_content_type_write_value()

Definition at line 1842 of file afw_interface.h.