axl main logo
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
Modules | Macros | Typedefs | Enumerations | Functions
Axl Declarations: Common Axl declarations, Types, macros, and support functions.

Modules

 Axl Handlers: Handlers declarations used by Axl Library functions.
 

Macros

#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. More...
 
#define AXL_FALSE   (axl_false)
 (DEPRECATED use axl_false) Type definition to represent a* boolean false value, that is equal to 0. More...
 
#define axl_false   ((int)0)
 Common definition to have false (axl_false) value (which is defined to 0 integer value). More...
 
#define axl_new(type, count)   (type *) axl_calloc (count, sizeof (type))
 Support macro to allocate memory using axl_calloc function, making a casting and using the sizeof keyword. More...
 
#define AXL_OS_UNIX   (1)
 Allows to get current platform configuration. More...
 
#define AXL_OS_WIN32   (1)
 Allows to get current platform configuration. More...
 
#define AXL_OS_WIN32   (1)
 Allows to get current platform configuration. More...
 
#define AXL_OS_WIN64   (0)
 If defined to 1, it means we are compiling in a windows platform running 64 bit version. More...
 
#define AXL_OS_WIN64   (1)
 If defined to 1, it means we are compiling in a windows platform running 64 bit version. More...
 
#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. More...
 
#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. More...
 
#define AXL_TRUE   (axl_true)
 (DEPRECATED use axl_true) Type definition to represent a boolean true value, that is equal to 1. More...
 
#define axl_true   ((int)1)
 Common definition to have true (axl_true) value (which is defined to 1 integer value). More...
 
#define false   axl_false
 DEPRECATED: boolean false definition provided to support applications and libraries using this type as defined by Axl Library before 0.5.5 release. More...
 
#define INT_TO_PTR(integer)   ((axlPointer) (long) ((int)integer))
 Allows to convert integer value (including constant values) into a pointer representation. More...
 
#define INT_TO_PTR(integer)   ((axlPointer) (integer))
 Allows to convert integer value (including constant values) into a pointer representation. More...
 
#define INT_TO_PTR(integer)   IntToPtr(integer)
 Allows to convert integer value (including constant values) into a pointer representation. More...
 
#define PTR_TO_INT(ptr)   ((int) (long) (ptr))
 Allows to convert a pointer reference (axlPointer), which stores an integer that was stored using INT_TO_PTR. More...
 
#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. More...
 
#define PTR_TO_INT(ptr)   PtrToInt((const void *)ptr)
 Allows to convert a pointer reference (axlPointer), which stores an integer that was stored using INT_TO_PTR. More...
 
#define true   axl_true
 DEPRECATED: boolean true definition provided to support applications and libraries using this type as defined by Axl Library before 0.5.5 release. More...
 

Typedefs

typedef int aboolean
 Alias declaration to bind the int to the boolean concept (TRUE / FALSE states) (DEPRECATED). More...
 
typedef int axl_bool
 Bool definition for the Axl library. More...
 
typedef struct _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). More...
 
typedef struct _axlBinaryStack axlBinaryStack
 Compact binary state representation stack. More...
 
typedef void(* axlDestroyFunc )(axlPointer ptr)
 Handler definition which represent deallocation functions. More...
 
typedef struct _axlDoc axlDoc
 Axl XML document type definition. More...
 
typedef struct _axlDtd axlDtd
 Axl DTD entity representation. More...
 
typedef struct _axtDtdAttr axlDtdAttr
 Axl DTD entity attribute element declaration. More...
 
typedef struct _axlDtdAttribute axlDtdAttribute
 Axl DTD attribute declaration (<!ATTLIST..>) More...
 
typedef struct _axlDtdAttributeDecl axlDtdAttributeDecl
 Axl DTD attribute list decleration inside axlDtdAttribute. More...
 
typedef struct _axlDtdElement axlDtdElement
 Axl DTD entity element declaration. More...
 
typedef struct _axlDtdElementList axlDtdElementList
 Axl DTD item list element declaration. More...
 
typedef struct
_axlDtdElementListNode 
axlDtdElementListNode
 Axl DTD item list element declaration. More...
 
typedef struct _axlDtdEntity axlDtdEntity
 Axl DTD entity declaration (<!ENTITY support>) More...
 
typedef struct
_axlDtdEntityExternalData 
axlDtdEntityExternalData
 Support type definition for axlDtdEntity, which holds information about external resource pointed by the axlDtdEntity instance. More...
 
typedef int(* axlEqualFunc )(axlPointer a, axlPointer b)
 Handler definition used to compare two elements. More...
 
typedef struct _axlError axlError
 Axl error reporting variable. More...
 
typedef struct _axlHash axlHash
 axlHash definition, a hash table to store key indexed values. More...
 
typedef struct _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). More...
 
typedef struct _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. More...
 
typedef struct _axlList axlList
 axlList definition, a list implementation. More...
 
typedef struct _axlListCursor axlListCursor
 axlListCursor definition, a iterator type used to traverse an axlList in a efficient way. More...
 
typedef struct _axlNode axlNode
 Axl XML node type definition. More...
 
typedef struct _axlPI axlPI
 Axl Processing instruction type definition. More...
 
typedef void * axlPointer
 Pointer to any structure definition. More...
 
typedef struct _axlStack axlStack
 axlStack definitinon, a stack implementation on top of axlList. More...
 
typedef struct _axlStream axlStream
 Axl Stream representation (an abstraction API to manage source of data with convenience functions). More...
 
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. More...
 
typedef int(* axlStreamContentCheck )(const char *source, int source_size, const char *source_encoding, axlPointer user_data, axlError **error)
 A handler definition used by axl stream API to define the set of functions that can be used to check content read from a file into the axl stream buffer. More...
 
typedef int(* axlStreamDecode )(const char *source, int source_size, const char *source_encoding, char *output, int output_size, int *output_converted, int *remain_source_index, axlPointer user_data)
 Handler definition for the set of functions that allows to translate content into a particular format back to utf-8, which is the default format used for internal data stored by Axl. More...
 
typedef int bool
 Boolean, deprecated, compatibility mode provided for those applications and libraries built on top of Axl Library or any library on top of it (like Vortex Library) to support people from C user space using bool type definition and its corresponding values false and true as they was available before 0.5.5 release. More...
 
typedef AxlDtdElementType ElementType
 Simple alias for the AxlDtdElementType. More...
 

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

axlPointer axl_calloc (size_t count, size_t size)
 Calloc helper for axl library. More...
 
void axl_free (axlPointer ref)
 Allows to deallocate memory referenced by ref but checking before that the reference is different from null. More...
 
axlPointer axl_realloc (axlPointer ref, size_t size)
 Realloc helper for axl library. More...
 

Detailed Description