Axl Declarations: Common Axl declarations, Types, macros, and support functions.


Modules

 Axl Handlers: Handlers declarations used by Axl Library functions.

Defines

#define AXL_CONSUME_SPACES(stream)   axl_stream_consume_white_spaces (stream)
 Consumes all spaces found and tabulars on the given stream until a different char is found.
#define AXL_FALSE   (0)
 (DEPRECATED use false) Type definition to represent a boolean false value, that is equal to 0.
#define axl_new(type, count)   (type *) calloc (count, sizeof (type))
 Support macro to allocate memory using the calloc function, making a casting and using the sizeof keyword.
#define AXL_OS_UNIX   (1)
 Allows to get current platform configuration.
#define AXL_OS_WIN32   (1)
 Allows to get current platform configuration.
#define axl_return_if_fail(expr)   if (!(expr)) {__axl_log ("", AXL_LEVEL_CRITICAL, "Expresion '%s' have failed at %s (%s:%d)", #expr, __AXL_PRETTY_FUNCTION__, __AXL_FILE__, __AXL_LINE__); return;}
 Allows to check a condition and return if it is not meet.
#define axl_return_val_if_fail(expr, val)   if (!(expr)) { __axl_log ("", AXL_LEVEL_CRITICAL, "Expresion '%s' have failed, returning: %s at %s (%s:%d)", #expr, #val, __AXL_PRETTY_FUNCTION__, __AXL_FILE__, __AXL_LINE__); return val;}
 Allows to check a condition and return the given value if it is not meet.
#define AXL_TRUE   (1)
 (DEPRECATED use true) Type definition to represent a boolean true value, that is equal to 1.
#define false   (0)
 Common definition to have false value (which is defined to 0 integer value).
#define INT_TO_PTR(integer)   ((axlPointer) (integer))
 Allows to convert integer value (including constant values) into a pointer representation.
#define INT_TO_PTR(integer)   ((axlPointer) (integer))
 Allows to convert integer value (including constant values) into a pointer representation.
#define PTR_TO_INT(ptr)   ((int) (ptr))
 Allows to convert a pointer reference (axlPointer), which stores an integer that was stored using INT_TO_PTR.
#define PTR_TO_INT(ptr)   ((int) (ptr))
 Allows to convert a pointer reference (axlPointer), which stores an integer that was stored using INT_TO_PTR.
#define true   (1)
 Common definition to have true value (which is defined to 1 integer value).

Typedefs

typedef int aboolean
 Alias declaration to bind the int to the boolean concept (TRUE / FALSE states) (DEPRECATED).
typedef _axlAttrCursor axlAttrCursor
 Public cursor type used to iterate over attributes installed on a particular node (see axl_node_attr_cursor_new to get examples and more information).
typedef void(*) axlDestroyFunc (axlPointer ptr)
 Handler definition which represent deallocation functions.
typedef _axlDoc axlDoc
 Axl XML document type definition.
typedef _axlDtd axlDtd
 Axl DTD entity representation.
typedef _axtDtdAttr axlDtdAttr
 Axl DTD entity attribute element declaration.
typedef _axlDtdAttribute axlDtdAttribute
 Axl DTD attribute declaration (<!ATTLIST.
typedef _axlDtdAttributeDecl axlDtdAttributeDecl
 Axl DTD attribute list decleration inside axlDtdAttribute.
typedef _axlDtdElement axlDtdElement
 Axl DTD entity element declaration.
typedef _axlDtdElementList axlDtdElementList
 Axl DTD item list element declaration.
typedef _axlDtdElementListNode axlDtdElementListNode
 Axl DTD item list element declaration.
typedef _axlDtdEntity axlDtdEntity
 Axl DTD entity declaration (<!ENTITY support>).
typedef _axlDtdEntityExternalData axlDtdEntityExternalData
 Support type definition for axlDtdEntity, which holds information about external resource pointed by the axlDtdEntity instance.
typedef int(*) axlEqualFunc (axlPointer a, axlPointer b)
 Handler definition used to compare two elements.
typedef _axlError axlError
 Axl error reporting variable.
typedef _axlHash axlHash
 axlHash definition, a hash table to store key indexed values.
typedef _axlHashCursor axlHashCursor
 axlHashCursor definition, a support type that is used to iterate a hash in a linear mode, without calling to axl_hash_foreach family functions (see axl_hash_cursor_new).
typedef _axlItem axlItem
 An abstraction that allows to hold an xml node or any other content that can be found inside an xml node: comments, content, CDATA-content, PI, entity references.
typedef _axlList axlList
 axlList definition, a list implementation.
typedef _axlListCursor axlListCursor
 axlListCursor definition, a iterator type used to traverse an axlList in a efficient way.
typedef _axlNode axlNode
 Axl XML node type definition.
typedef _axlPI axlPI
 Axl Processing instruction type definition.
typedef void * axlPointer
 Pointer to any structure definition.
typedef _axlStack axlStack
 axlStack definitinon, a stack implementation on top of axlList.
typedef _axlStream axlStream
 Axl Stream representation (an abstraction API to manage source of data with convenience functions).
typedef char *(*) axlStreamAlloc (int size, axlPointer data)
 Handler used to represent the set of functions that could be used to configure the axl stream allocation method.
typedef AxlDtdElementType ElementType
 Simple alias for the AxlDtdElementType.

Enumerations

enum  AxlDebugLevel { AXL_LEVEL_DEBUG, AXL_LEVEL_WARNING, AXL_LEVEL_CRITICAL }
 Axl debug levels. More...
enum  AxlDtdAttributeDefaults { ATT_REQUIRED, ATT_IMPLIED, ATT_FIXED }
 Defines the DTD attribute declaration default state. More...
enum  AxlDtdAttributeType {
  CDATA_ATTRIBUTE, TOKENIZED_TYPE_ID, TOKENIZED_TYPE_IDREF, TOKENIZED_TYPE_IDREFS,
  TOKENIZED_TYPE_ENTITY, TOKENIZED_TYPE_ENTITIES, TOKENIZED_TYPE_NMTOKEN, TOKENIZED_TYPE_NMTOKENS,
  ENUMERATION_TYPE, NOTATION_TYPE
}
 Attribute type declaration (the type of the attribute constrain). More...
enum  AxlDtdElementType { ,
  ELEMENT_TYPE_EMPTY = 1, ELEMENT_TYPE_ANY = 2, ELEMENT_TYPE_MIXED = 3, ELEMENT_TYPE_CHILDREN = 4,
  ELEMENT_TYPE_PCDATA = 5
}
 DTD element type enumeration. More...
enum  axlDtdEntityType { GENERAL_ENTITY, PARAMETER_ENTITY }
 Declares the entity type for a provided axlDtdEntity. More...
enum  AxlDtdNestedType { , CHOICE = 1, SEQUENCE = 2 }
 The type of the DTD sequences stored by the axlDtdElementList. More...
enum  AxlDtdTimes { , ONE_AND_ONLY_ONE = 1, ZERO_OR_ONE = 2, ZERO_OR_MANY = 3, ONE_OR_MANY = 4 }
 Current configuration for elements definied inside a ELEMENT DTD declaration. More...
enum  AxlItemType {
  ITEM_NODE = 1 << 0, ITEM_CONTENT = 1 << 1, ITEM_PI = 1 << 2, ITEM_COMMENT = 1 << 3,
  ITEM_REF = 1 << 4, ITEM_CDATA = 1 << 6
}
 Item types that can hold an xml node (axlNode). More...
enum  AxlIterationMode { DEEP_ITERATION, WIDE_ITERATION }
 Allows to configure how is performed the iteration other the xml document. More...
enum  NodeType { , AXL_ELEMENT_LIST = 2, AXL_ELEMENT_NODE = 3 }
 An indication of the element type stored on the provided axlDtdElementListNode reference. More...

Functions

void axl_free (axlPointer ref)
 Free the provided pointer that was allocated using axl_new.