Functions
Eina_Value *	eina_value_array_new (const Eina_Value_Type *subtype, unsigned int step)
	Creates generic value storage of type array.
static Eina_Bool	eina_value_array_setup (Eina_Value value, const Eina_Value_Type subtype, unsigned int step)
	Initializes generic value storage of type array.
static unsigned int	eina_value_array_count (const Eina_Value *value)
	Queries number of elements in value of array type.
static Eina_Bool	eina_value_array_remove (Eina_Value *value, unsigned int position)
	Removes element at given position in value of array type.
static Eina_Bool	eina_value_array_set (Eina_Value *value, unsigned int position,...)
	Sets the generic value in an array member.
static Eina_Bool	eina_value_array_get (const Eina_Value *value, unsigned int position,...)
	Gets the generic value from an array member.
static Eina_Bool	eina_value_array_insert (Eina_Value *value, unsigned int position,...)
	Inserts a generic value in an array member position.
static Eina_Bool	eina_value_array_append (Eina_Value *value,...)
	Appends a generic value in an array.
static Eina_Bool	eina_value_array_vset (Eina_Value *value, unsigned int position, va_list args)
	Sets a generic value to an array member.
static Eina_Bool	eina_value_array_vget (const Eina_Value *value, unsigned int position, va_list args)
	Gets the generic value from an array member.
static Eina_Bool	eina_value_array_vinsert (Eina_Value *value, unsigned int position, va_list args)
	Inserts a generic value to an array member position.
static Eina_Bool	eina_value_array_vappend (Eina_Value *value, va_list args)
	Appends a generic value to an array.
static Eina_Bool	eina_value_array_pset (Eina_Value value, unsigned int position, const void ptr)
	Sets a generic value to an array member from a pointer.
static Eina_Bool	eina_value_array_pget (const Eina_Value value, unsigned int position, void ptr)
	Retrieves a generic value into a pointer from an array member.
static Eina_Bool	eina_value_array_pinsert (Eina_Value value, unsigned int position, const void ptr)
	Inserts a generic value to an array member position from a pointer.
static Eina_Bool	eina_value_array_pappend (Eina_Value value, const void ptr)
	Appends a generic value to an array from a pointer.
static Eina_Bool	eina_value_array_value_get (const Eina_Value src, unsigned int position, Eina_Value dst)
	Retrieves a value from the array as an Eina_Value copy.
Typedefs
typedef struct _Eina_Value_Array	Eina_Value_Array

Typedef Documentation

Eina_Value_Array

Value type for EINA_VALUE_TYPE_ARRAY.

See also:: _Eina_Value_Array explains fields.

Since (EFL) :: 1.2

Function Documentation

static Eina_Bool eina_value_array_append	(	Eina_Value *	value,
			...
	)		`[static]`

Appends a generic value in an array.

Parameters:

value Source value object

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The variable argument is dependent on chosen subtype. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char
EINA_VALUE_TYPE_USHORT: unsigned short
EINA_VALUE_TYPE_UINT: unsigned int
EINA_VALUE_TYPE_ULONG: unsigned long
EINA_VALUE_TYPE_UINT64: uint64_t
EINA_VALUE_TYPE_CHAR: char
EINA_VALUE_TYPE_SHORT: short
EINA_VALUE_TYPE_INT: int
EINA_VALUE_TYPE_LONG: long
EINA_VALUE_TYPE_INT64: int64_t
EINA_VALUE_TYPE_FLOAT: float
EINA_VALUE_TYPE_DOUBLE: double
EINA_VALUE_TYPE_STRINGSHARE: const char *
EINA_VALUE_TYPE_STRING: const char *
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
EINA_VALUE_TYPE_LIST: Eina_Value_List
EINA_VALUE_TYPE_HASH: Eina_Value_Hash
EINA_VALUE_TYPE_TIMEVAL: struct timeval
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x;

     eina_value_array_append(value, 1234);
     eina_value_array_get(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vset(); eina_value_array_pset(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

static unsigned int eina_value_array_count ( const Eina_Value * value ) [static]

Queries number of elements in value of array type.

Parameters:

value value object.

Returns:: number of child elements.

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_get	(	const Eina_Value *	value,
		unsigned int	position,
			...
	)		`[static]`

Gets the generic value from an array member.

Parameters:

value	Source value object
position	Index of the member

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The value is returned in the variable argument parameter, and the actual value is type-dependent, but usually it will be what is stored inside the object. There shouldn't be any memory allocation; thus the contents should not be freed.

The variable argument is dependent on chosen subtype. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char*
EINA_VALUE_TYPE_USHORT: unsigned short*
EINA_VALUE_TYPE_UINT: unsigned int*
EINA_VALUE_TYPE_ULONG: unsigned long*
EINA_VALUE_TYPE_UINT64: uint64_t*
EINA_VALUE_TYPE_CHAR: char*
EINA_VALUE_TYPE_SHORT: short*
EINA_VALUE_TYPE_INT: int*
EINA_VALUE_TYPE_LONG: long*
EINA_VALUE_TYPE_INT64: int64_t*
EINA_VALUE_TYPE_FLOAT: float*
EINA_VALUE_TYPE_DOUBLE: double*
EINA_VALUE_TYPE_STRINGSHARE: const char **
EINA_VALUE_TYPE_STRING: const char **
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
EINA_VALUE_TYPE_LIST: Eina_Value_List*
EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
EINA_VALUE_TYPE_TIMEVAL: struct timeval*
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct*

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x;

     eina_value_array_append(value, 1234);
     eina_value_array_get(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_vset(); eina_value_array_pset()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_insert	(	Eina_Value *	value,
		unsigned int	position,
			...
	)		`[static]`

Inserts a generic value in an array member position.

Parameters:

value	Source value object
position	Index of the member

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The variable argument is dependent on chosen subtype. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char
EINA_VALUE_TYPE_USHORT: unsigned short
EINA_VALUE_TYPE_UINT: unsigned int
EINA_VALUE_TYPE_ULONG: unsigned long
EINA_VALUE_TYPE_UINT64: uint64_t
EINA_VALUE_TYPE_CHAR: char
EINA_VALUE_TYPE_SHORT: short
EINA_VALUE_TYPE_INT: int
EINA_VALUE_TYPE_LONG: long
EINA_VALUE_TYPE_INT64: int64_t
EINA_VALUE_TYPE_FLOAT: float
EINA_VALUE_TYPE_DOUBLE: double
EINA_VALUE_TYPE_STRINGSHARE: const char *
EINA_VALUE_TYPE_STRING: const char *
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
EINA_VALUE_TYPE_LIST: Eina_Value_List
EINA_VALUE_TYPE_HASH: Eina_Value_Hash
EINA_VALUE_TYPE_TIMEVAL: struct timeval
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x;

     eina_value_array_insert(value, 0, 1234);
     eina_value_array_get(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vset(); eina_value_array_pset(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

Eina_Value* eina_value_array_new	(	const Eina_Value_Type *	subtype,
		unsigned int	step
	)

Creates generic value storage of type array.

Parameters:

subtype	How to manage this array members.
step	How to grow the members array.

Returns:: The new value or NULL on failure.

Create a new generic value storage of type array. The members are managed using the description specified by subtype.

On failure, NULL is returned.

Note:: This creates from mempool and then uses eina_value_array_setup().

See also:: eina_value_free(); eina_value_array_setup()

Since (EFL) :: 1.2

Since :: 3.0

static Eina_Bool eina_value_array_pappend	(	Eina_Value *	value,
		const void *	ptr
	)		`[static]`

Appends a generic value to an array from a pointer.

Parameters:

value	Source value object
ptr	Pointer to specify the contents.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The pointer type is dependent on chosen value type. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char*
EINA_VALUE_TYPE_USHORT: unsigned short*
EINA_VALUE_TYPE_UINT: unsigned int*
EINA_VALUE_TYPE_ULONG: unsigned long*
EINA_VALUE_TYPE_UINT64: uint64_t*
EINA_VALUE_TYPE_CHAR: char*
EINA_VALUE_TYPE_SHORT: short*
EINA_VALUE_TYPE_INT: int*
EINA_VALUE_TYPE_LONG: long*
EINA_VALUE_TYPE_INT64: int64_t*
EINA_VALUE_TYPE_FLOAT: float*
EINA_VALUE_TYPE_DOUBLE: double*
EINA_VALUE_TYPE_STRINGSHARE: const char **
EINA_VALUE_TYPE_STRING: const char **
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
EINA_VALUE_TYPE_LIST: Eina_Value_List*
EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
EINA_VALUE_TYPE_TIMEVAL: struct timeval*
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct*

Note:: the pointer contents are written using the size defined by type. It can be larger than void* or uint64_t.

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x = 1234;

     eina_value_array_pappend(value, &x);
     eina_value_array_pget(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vset(); eina_value_array_insert(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_pget	(	const Eina_Value *	value,
		unsigned int	position,
		void *	ptr
	)		`[static]`

Retrieves a generic value into a pointer from an array member.

Parameters:

value	Source value object
position	Index of the member
ptr	Pointer to receive the contents.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The value is returned in pointer contents, the actual value is type-dependent, but usually it will be what is stored inside the object. There shouldn't be any memory allocation, thus the contents should not be freed.

The pointer type is dependent on chosen value type. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char*
EINA_VALUE_TYPE_USHORT: unsigned short*
EINA_VALUE_TYPE_UINT: unsigned int*
EINA_VALUE_TYPE_ULONG: unsigned long*
EINA_VALUE_TYPE_UINT64: uint64_t*
EINA_VALUE_TYPE_CHAR: char*
EINA_VALUE_TYPE_SHORT: short*
EINA_VALUE_TYPE_INT: int*
EINA_VALUE_TYPE_LONG: long*
EINA_VALUE_TYPE_INT64: int64_t*
EINA_VALUE_TYPE_FLOAT: float*
EINA_VALUE_TYPE_DOUBLE: double*
EINA_VALUE_TYPE_STRINGSHARE: const char **
EINA_VALUE_TYPE_STRING: const char **
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
EINA_VALUE_TYPE_LIST: Eina_Value_List*
EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
EINA_VALUE_TYPE_TIMEVAL: struct timeval*
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct*

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x;

     eina_value_array_append(value, 1234);
     eina_value_array_pget(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_vset(); eina_value_array_pset()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_pinsert	(	Eina_Value *	value,
		unsigned int	position,
		const void *	ptr
	)		`[static]`

Inserts a generic value to an array member position from a pointer.

Parameters:

value	Source value object
position	Index of the member
ptr	Pointer to specify the contents.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The pointer type is dependent on chosen value type. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char*
EINA_VALUE_TYPE_USHORT: unsigned short*
EINA_VALUE_TYPE_UINT: unsigned int*
EINA_VALUE_TYPE_ULONG: unsigned long*
EINA_VALUE_TYPE_UINT64: uint64_t*
EINA_VALUE_TYPE_CHAR: char*
EINA_VALUE_TYPE_SHORT: short*
EINA_VALUE_TYPE_INT: int*
EINA_VALUE_TYPE_LONG: long*
EINA_VALUE_TYPE_INT64: int64_t*
EINA_VALUE_TYPE_FLOAT: float*
EINA_VALUE_TYPE_DOUBLE: double*
EINA_VALUE_TYPE_STRINGSHARE: const char **
EINA_VALUE_TYPE_STRING: const char **
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
EINA_VALUE_TYPE_LIST: Eina_Value_List*
EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
EINA_VALUE_TYPE_TIMEVAL: struct timeval*
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct*

Note:: the pointer contents are written using the size defined by type. It can be larger than void* or uint64_t.

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x = 1234;

     eina_value_array_pinsert(value, 0, &x);
     eina_value_array_pget(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vset(); eina_value_array_insert(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_pset	(	Eina_Value *	value,
		unsigned int	position,
		const void *	ptr
	)		`[static]`

Sets a generic value to an array member from a pointer.

Parameters:

value	Source value object
position	Index of the member
ptr	Pointer to specify the contents.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The pointer type is dependent on chosen value type. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char*
EINA_VALUE_TYPE_USHORT: unsigned short*
EINA_VALUE_TYPE_UINT: unsigned int*
EINA_VALUE_TYPE_ULONG: unsigned long*
EINA_VALUE_TYPE_UINT64: uint64_t*
EINA_VALUE_TYPE_CHAR: char*
EINA_VALUE_TYPE_SHORT: short*
EINA_VALUE_TYPE_INT: int*
EINA_VALUE_TYPE_LONG: long*
EINA_VALUE_TYPE_INT64: int64_t*
EINA_VALUE_TYPE_FLOAT: float*
EINA_VALUE_TYPE_DOUBLE: double*
EINA_VALUE_TYPE_STRINGSHARE: const char **
EINA_VALUE_TYPE_STRING: const char **
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array*
EINA_VALUE_TYPE_LIST: Eina_Value_List*
EINA_VALUE_TYPE_HASH: Eina_Value_Hash*
EINA_VALUE_TYPE_TIMEVAL: struct timeval*
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob*
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct*

Note:: the pointer contents are written using the size defined by type. It can be larger than void* or uint64_t.

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x = 1234;

     eina_value_array_append(value, 1234);
     eina_value_array_pset(value, 0, &x);
     eina_value_array_pget(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vset(); eina_value_array_insert(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_remove	(	Eina_Value *	value,
		unsigned int	position
	)		`[static]`

Removes element at given position in value of array type.

Parameters:

value	value object.
position	index of the member

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_set	(	Eina_Value *	value,
		unsigned int	position,
			...
	)		`[static]`

Sets the generic value in an array member.

Parameters:

value	Source value object
position	Index of the member

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The variable argument is dependent on chosen subtype. The list for basic types:

EINA_VALUE_TYPE_UCHAR: unsigned char
EINA_VALUE_TYPE_USHORT: unsigned short
EINA_VALUE_TYPE_UINT: unsigned int
EINA_VALUE_TYPE_ULONG: unsigned long
EINA_VALUE_TYPE_UINT64: uint64_t
EINA_VALUE_TYPE_CHAR: char
EINA_VALUE_TYPE_SHORT: short
EINA_VALUE_TYPE_INT: int
EINA_VALUE_TYPE_LONG: long
EINA_VALUE_TYPE_INT64: int64_t
EINA_VALUE_TYPE_FLOAT: float
EINA_VALUE_TYPE_DOUBLE: double
EINA_VALUE_TYPE_STRINGSHARE: const char *
EINA_VALUE_TYPE_STRING: const char *
EINA_VALUE_TYPE_ARRAY: Eina_Value_Array
EINA_VALUE_TYPE_LIST: Eina_Value_List
EINA_VALUE_TYPE_HASH: Eina_Value_Hash
EINA_VALUE_TYPE_TIMEVAL: struct timeval
EINA_VALUE_TYPE_BLOB: Eina_Value_Blob
EINA_VALUE_TYPE_STRUCT: Eina_Value_Struct

     Eina_Value *value = eina_value_array_new(EINA_VALUE_TYPE_INT, 0);
     int x;

     eina_value_array_append(value, 1234);
     eina_value_array_set(value, 0, 5678);
     eina_value_array_get(value, 0, &x);
     eina_value_free(value);

See also:: eina_value_array_get(); eina_value_array_vset(); eina_value_array_pset(); eina_value_array_insert(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_setup	(	Eina_Value *	value,
		const Eina_Value_Type *	subtype,
		unsigned int	step
	)		`[static]`

Initializes generic value storage of type array.

Parameters:

value	Value object
subtype	How to manage array members.
step	How to grow the members array.

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

Initializes new generic value storage of type array with the given subtype.

This is the same as calling eina_value_set() with EINA_VALUE_TYPE_ARRAY followed by eina_value_pset() with the Eina_Value_Array description configured.

Note:: Existing contents are ignored! If the value was previously used, then use eina_value_flush() first.

On failure, EINA_FALSE is returned.

See also:: eina_value_flush()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_value_get	(	const Eina_Value *	src,
		unsigned int	position,
		Eina_Value *	dst
	)		`[static]`

Retrieves a value from the array as an Eina_Value copy.

Parameters:

src	Source value object
position	Index of the member
dst	Where to return the array member

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The argument dst is considered uninitialized and it's setup to the type of the member.

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_vappend	(	Eina_Value *	value,
		va_list	args
	)		`[static]`

Appends a generic value to an array.

Parameters:

value	Source value object
args	Variable argument

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vget(); eina_value_array_pset(); eina_value_array_insert(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_pappend()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_vget	(	const Eina_Value *	value,
		unsigned int	position,
		va_list	args
	)		`[static]`

Gets the generic value from an array member.

Parameters:

value	Source value object
position	Index of the member
args	Variable argument

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

The value is returned in the variable argument parameter, the actual value is type-dependent, but usually it will be what is stored inside the object. There shouldn't be any memory allocation, thus the contents should not be freed.

See also:: eina_value_array_vset(); eina_value_array_get(); eina_value_array_pget()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_vinsert	(	Eina_Value *	value,
		unsigned int	position,
		va_list	args
	)		`[static]`

Inserts a generic value to an array member position.

Parameters:

value	Source value object
position	Index of the member
args	Variable argument

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_vset(); eina_value_array_pset(); eina_value_array_insert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

static Eina_Bool eina_value_array_vset	(	Eina_Value *	value,
		unsigned int	position,
		va_list	args
	)		`[static]`

Sets a generic value to an array member.

Parameters:

value	Source value object
position	Index of the member
args	Variable argument

Returns:: EINA_TRUE on success, EINA_FALSE otherwise.

See also:: eina_value_array_set(); eina_value_array_get(); eina_value_array_pset(); eina_value_array_insert(); eina_value_array_vinsert(); eina_value_array_pinsert(); eina_value_array_append(); eina_value_array_vappend(); eina_value_array_pappend()

Since (EFL) :: 1.2

Functions

Typedefs

Typedef Documentation

Function Documentation