ender  0.0.9
Descriptorlibrary
Typedefs | Enumerations | Functions
Item

An item represents any identifier a Ender_Lib might have. More...

Typedefs

typedef struct _Ender_Item Ender_Item
 Item handle.

Enumerations

enum  Ender_Item_Type {
  ENDER_ITEM_TYPE_INVALID,
  ENDER_ITEM_TYPE_BASIC,
  ENDER_ITEM_TYPE_FUNCTION,
  ENDER_ITEM_TYPE_ATTR,
  ENDER_ITEM_TYPE_ARG,
  ENDER_ITEM_TYPE_OBJECT,
  ENDER_ITEM_TYPE_STRUCT,
  ENDER_ITEM_TYPE_CONSTANT,
  ENDER_ITEM_TYPE_ENUM,
  ENDER_ITEM_TYPE_DEF
}
enum  Ender_Item_Transfer {
  ENDER_ITEM_TRANSFER_FULL,
  ENDER_ITEM_TRANSFER_NONE,
  ENDER_ITEM_TRANSFER_CONTAINER,
  ENDER_ITEM_TRANSFER_CONTENT
}

Functions

EAPI Ender_Itemender_item_ref (Ender_Item *thiz)
 Increase the reference counter of an item.
EAPI void ender_item_unref (Ender_Item *thiz)
 Decrease the reference counter of an item.
EAPI const char * ender_item_name_get (Ender_Item *thiz)
EAPI char * ender_item_full_name_get (Ender_Item *thiz)
EAPI Ender_Item_Type ender_item_type_get (Ender_Item *thiz)
EAPI Ender_Itemender_item_parent_get (Ender_Item *thiz)
EAPI const char * ender_item_type_name_get (Ender_Item_Type type)
EAPI const Ender_Libender_item_lib_get (Ender_Item *thiz)
EAPI Eina_Bool ender_item_is_exception (Ender_Item *i)

Detailed Description

An item represents any identifier a Ender_Lib might have.


Typedef Documentation

typedef struct _Ender_Item Ender_Item

Item handle.


Enumeration Type Documentation

The type of an item

See also:
ender_item_type_get
Enumerator:
ENDER_ITEM_TYPE_INVALID 

Impossible case

ENDER_ITEM_TYPE_BASIC 

The item is a Basic

ENDER_ITEM_TYPE_FUNCTION 

The item is a Function

ENDER_ITEM_TYPE_ATTR 

The item is a Attr

ENDER_ITEM_TYPE_ARG 

The item is a Arg

ENDER_ITEM_TYPE_OBJECT 

The item is a Object

ENDER_ITEM_TYPE_STRUCT 

The item is a Struct

ENDER_ITEM_TYPE_CONSTANT 

The item is a Constant

ENDER_ITEM_TYPE_ENUM 

The item is a Enum

ENDER_ITEM_TYPE_DEF 

The item is a Def

The type of transfer


Function Documentation

Increase the reference counter of an item.

Parameters:
[in]thizThe item
Returns:
The input parameter thiz for programming convenience
EAPI void ender_item_unref ( Ender_Item thiz)

Decrease the reference counter of an item.

Parameters:
[in]thizThe item
EAPI const char* ender_item_name_get ( Ender_Item thiz)

Get the name of an item

Parameters:
thizThe item to get the name from
Returns:
The name of the item
EAPI char* ender_item_full_name_get ( Ender_Item thiz)

Get the full name of an item

The full name is the actual item's name appended to every parent's name

Parameters:
thizThe item to get the full name from
Returns:
The full name [full]

Get the type of an item

Parameters:
thizThe item to get the type from
Returns:
The item type

Get the parent of an item

Depending on the type of item, the item might have or not a parent. The Arg for example has always a Function as a parent.

Parameters:
thizThe item to get the parent from
Returns:
The parent of the item. transfer[none]
EAPI const Ender_Lib* ender_item_lib_get ( Ender_Item thiz)

Get the library an item belongs to

Parameters:
thizThe item to get the library from
Returns:
The library the item belongs to
EAPI Eina_Bool ender_item_is_exception ( Ender_Item i)

Check if the item is an exception item An exception item is an item of type eina.error

Parameters:
iThe item to check
Returns:
EINA_TRUE if the item is an exception, EINA_FALSE otherwise
 All Data Structures