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

Modules

 afw_list
 

Data Structures

struct  afw_list_s
 Interface afw_list public struct. More...
 
struct  afw_list_inf_s
 Interface afw_list_inf_s struct. More...
 

Macros

#define AFW_LIST_INTERFACE_NAME   "afw_list"
 define for interface afw_list name.
 
#define afw_list_release(instance, xctx)
 Call method release of interface afw_list. More...
 
#define afw_list_get_count(instance, xctx)
 Call method get_count of interface afw_list. More...
 
#define afw_list_get_data_type(instance, xctx)
 Call method get_data_type of interface afw_list. More...
 
#define afw_list_get_entry_meta(instance, index, p, xctx)
 Call method get_entry_meta of interface afw_list. More...
 
#define afw_list_get_entry_internal(instance, index, data_type, internal, xctx)
 Call method get_entry_internal of interface afw_list. More...
 
#define afw_list_get_entry_value(instance, index, p, xctx)
 Call method get_entry_value of interface afw_list. More...
 
#define afw_list_get_next_entry_meta(instance, iterator, p, xctx)
 Call method get_next_entry_meta of interface afw_list. More...
 
#define afw_list_get_next_internal(instance, iterator, data_type, internal, xctx)
 Call method get_next_internal of interface afw_list. More...
 
#define afw_list_get_next_value(instance, iterator, p, xctx)
 Call method get_next_value of interface afw_list. More...
 
#define afw_list_get_setter(instance, xctx)
 Call method get_setter of interface afw_list. More...
 

Typedefs

typedef void(* afw_list_release_t) (const afw_list_t *instance, afw_xctx_t *xctx)
 
typedef afw_size_t(* afw_list_get_count_t) (const afw_list_t *instance, afw_xctx_t *xctx)
 
typedef const afw_data_type_t *(* afw_list_get_data_type_t) (const afw_list_t *instance, afw_xctx_t *xctx)
 
typedef const afw_value_t *(* afw_list_get_entry_meta_t) (const afw_list_t *instance, afw_integer_t index, const afw_pool_t *p, afw_xctx_t *xctx)
 
typedef afw_boolean_t(* afw_list_get_entry_internal_t) (const afw_list_t *instance, afw_integer_t index, const afw_data_type_t **data_type, const void **internal, afw_xctx_t *xctx)
 
typedef const afw_value_t *(* afw_list_get_entry_value_t) (const afw_list_t *instance, afw_integer_t index, const afw_pool_t *p, afw_xctx_t *xctx)
 
typedef const afw_value_t *(* afw_list_get_next_entry_meta_t) (const afw_list_t *instance, const afw_iterator_t **iterator, const afw_pool_t *p, afw_xctx_t *xctx)
 
typedef afw_boolean_t(* afw_list_get_next_internal_t) (const afw_list_t *instance, const afw_iterator_t **iterator, const afw_data_type_t **data_type, const void **internal, afw_xctx_t *xctx)
 
typedef const afw_value_t *(* afw_list_get_next_value_t) (const afw_list_t *instance, const afw_iterator_t **iterator, const afw_pool_t *p, afw_xctx_t *xctx)
 
typedef const afw_list_setter_t *(* afw_list_get_setter_t) (const afw_list_t *instance, afw_xctx_t *xctx)
 

Detailed Description

Adaptive value list interface.

Macro Definition Documentation

◆ afw_list_get_count

#define afw_list_get_count (   instance,
  xctx 
)
Value:
(instance)->inf->get_count( \
(instance), \
(xctx) \
)

Call method get_count of interface afw_list.

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

Definition at line 2765 of file afw_interface.h.

◆ afw_list_get_data_type

#define afw_list_get_data_type (   instance,
  xctx 
)
Value:
(instance)->inf->get_data_type( \
(instance), \
(xctx) \
)

Call method get_data_type of interface afw_list.

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

Definition at line 2779 of file afw_interface.h.

◆ afw_list_get_entry_internal

#define afw_list_get_entry_internal (   instance,
  index,
  data_type,
  internal,
  xctx 
)
Value:
(instance)->inf->get_entry_internal( \
(instance), \
(index), \
(data_type), \
(internal), \
(xctx) \
)

Call method get_entry_internal of interface afw_list.

Parameters
instancePointer to this value list instance.
indexZero-based index of list entry to return.
data_typePlace to put data type pointer or NULL.
internalPlace to put data_type->cType pointer to the internal at the specified index. This will be set to NULL if index is out of range.
xctxThis is the caller's xctx.

Definition at line 2818 of file afw_interface.h.

◆ afw_list_get_entry_meta

#define afw_list_get_entry_meta (   instance,
  index,
  p,
  xctx 
)
Value:
(instance)->inf->get_entry_meta( \
(instance), \
(index), \
(p), \
(xctx) \
)

Call method get_entry_meta of interface afw_list.

Parameters
instancePointer to this value list instance.
indexZero-based index of list entry to return.
pIf necessary, this pool is used to create the return value.
xctxThis is the caller's xctx.

Definition at line 2795 of file afw_interface.h.

◆ afw_list_get_entry_value

#define afw_list_get_entry_value (   instance,
  index,
  p,
  xctx 
)
Value:
(instance)->inf->get_entry_value( \
(instance), \
(index), \
(p), \
(xctx) \
)

Call method get_entry_value of interface afw_list.

Parameters
instancePointer to this value list instance.
indexZero-based index of list entry to return.
pIf necessary, this pool is used to create the return value.
xctxThis is the caller's xctx.

Definition at line 2840 of file afw_interface.h.

◆ afw_list_get_next_entry_meta

#define afw_list_get_next_entry_meta (   instance,
  iterator,
  p,
  xctx 
)
Value:
(instance)->inf->get_next_entry_meta( \
(instance), \
(iterator), \
(p), \
(xctx) \
)

Call method get_next_entry_meta of interface afw_list.

Parameters
instancePointer to this value list instance.
iteratorAddress of iterator pointer.
pIf necessary, this pool is used to create the return value.
xctxThis is the caller's xctx.

Definition at line 2860 of file afw_interface.h.

◆ afw_list_get_next_internal

#define afw_list_get_next_internal (   instance,
  iterator,
  data_type,
  internal,
  xctx 
)
Value:
(instance)->inf->get_next_internal( \
(instance), \
(iterator), \
(data_type), \
(internal), \
(xctx) \
)

Call method get_next_internal of interface afw_list.

Parameters
instancePointer to this value list instance.
iteratorAddress of iterator pointer.
data_typePlace to put data type pointer or NULL.
internalPlace to put data_type->cType pointer to next internal.
This will be set to NULL if there is no next internal.
xctxThis is the caller's xctx.

Definition at line 2882 of file afw_interface.h.

◆ afw_list_get_next_value

#define afw_list_get_next_value (   instance,
  iterator,
  p,
  xctx 
)
Value:
(instance)->inf->get_next_value( \
(instance), \
(iterator), \
(p), \
(xctx) \
)

Call method get_next_value of interface afw_list.

Parameters
instancePointer to this value list instance.
iteratorAddress of iterator pointer.
pIf necessary, this pool is used to create the return value.
xctxThis is the caller's xctx.

Definition at line 2904 of file afw_interface.h.

◆ afw_list_get_setter

#define afw_list_get_setter (   instance,
  xctx 
)
Value:
(instance)->inf->get_setter( \
(instance), \
(xctx) \
)

Call method get_setter of interface afw_list.

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

Definition at line 2922 of file afw_interface.h.

◆ afw_list_release

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

Call method release of interface afw_list.

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

Definition at line 2751 of file afw_interface.h.

Typedef Documentation

◆ afw_list_get_count_t

typedef afw_size_t(* afw_list_get_count_t) (const afw_list_t *instance, afw_xctx_t *xctx)
See also
afw_list_get_count()

Definition at line 2664 of file afw_interface.h.

◆ afw_list_get_data_type_t

typedef const afw_data_type_t*(* afw_list_get_data_type_t) (const afw_list_t *instance, afw_xctx_t *xctx)
See also
afw_list_get_data_type()

Definition at line 2670 of file afw_interface.h.

◆ afw_list_get_entry_internal_t

typedef afw_boolean_t(* afw_list_get_entry_internal_t) (const afw_list_t *instance, afw_integer_t index, const afw_data_type_t **data_type, const void **internal, afw_xctx_t *xctx)
See also
afw_list_get_entry_internal()

Definition at line 2684 of file afw_interface.h.

◆ afw_list_get_entry_meta_t

typedef const afw_value_t*(* afw_list_get_entry_meta_t) (const afw_list_t *instance, afw_integer_t index, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_list_get_entry_meta()

Definition at line 2676 of file afw_interface.h.

◆ afw_list_get_entry_value_t

typedef const afw_value_t*(* afw_list_get_entry_value_t) (const afw_list_t *instance, afw_integer_t index, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_list_get_entry_value()

Definition at line 2693 of file afw_interface.h.

◆ afw_list_get_next_entry_meta_t

typedef const afw_value_t*(* afw_list_get_next_entry_meta_t) (const afw_list_t *instance, const afw_iterator_t **iterator, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_list_get_next_entry_meta()

Definition at line 2701 of file afw_interface.h.

◆ afw_list_get_next_internal_t

typedef afw_boolean_t(* afw_list_get_next_internal_t) (const afw_list_t *instance, const afw_iterator_t **iterator, const afw_data_type_t **data_type, const void **internal, afw_xctx_t *xctx)
See also
afw_list_get_next_internal()

Definition at line 2709 of file afw_interface.h.

◆ afw_list_get_next_value_t

typedef const afw_value_t*(* afw_list_get_next_value_t) (const afw_list_t *instance, const afw_iterator_t **iterator, const afw_pool_t *p, afw_xctx_t *xctx)
See also
afw_list_get_next_value()

Definition at line 2718 of file afw_interface.h.

◆ afw_list_get_setter_t

typedef const afw_list_setter_t*(* afw_list_get_setter_t) (const afw_list_t *instance, afw_xctx_t *xctx)
See also
afw_list_get_setter()

Definition at line 2726 of file afw_interface.h.

◆ afw_list_release_t

typedef void(* afw_list_release_t) (const afw_list_t *instance, afw_xctx_t *xctx)
See also
afw_list_release()

Definition at line 2658 of file afw_interface.h.