Basic Types and Enumerations

Name

Basic Types and Enumerations -- 

Synopsis



enum        GdomeNodeType;
enum        GdomeExceptionCode;
enum        GdomeAccessType;

typedef     GdomeBoolean;
typedef     GdomeDOMTimeStamp;
typedef     GdomeException;

struct      GdomeDOMString;
GdomeDOMString* gdome_str_mkref             (const gchar *str);
GdomeDOMString* gdome_str_mkref_own         (gchar *str);
GdomeDOMString* gdome_str_mkref_dup         (const gchar *str);
void        gdome_str_ref                   (GdomeDOMString *self);
void        gdome_str_unref                 (GdomeDOMString *self);
GdomeBoolean gdome_str_equal                (GdomeDOMString *self,
                                             GdomeDOMString *str);

struct      GdomePrivateList;
GdomePrivateList* gdome_private_list_append (GdomePrivateList *list,
                                             void *data);
GdomePrivateList* gdome_private_list_prepend
                                            (GdomePrivateList *list,
                                             void *data);
unsigned int gdome_private_list_length      (GdomePrivateList *list);
GdomePrivateList* gdome_private_list_remove (GdomePrivateList *list,
                                             void *data);
GdomePrivateList* gdome_private_list_nth    (GdomePrivateList *list,
                                             unsigned int n);

Description

Details

enum GdomeNodeType

typedef enum {
	GDOME_ELEMENT_NODE = 1,
	GDOME_ATTRIBUTE_NODE = 2,
	GDOME_TEXT_NODE = 3,
	GDOME_CDATA_SECTION_NODE = 4,
	GDOME_ENTITY_REFERENCE_NODE = 5,
	GDOME_ENTITY_NODE = 6,
	GDOME_PROCESSING_INSTRUCTION_NODE = 7,
	GDOME_COMMENT_NODE = 8,
	GDOME_DOCUMENT_NODE = 9,
	GDOME_DOCUMENT_TYPE_NODE = 10,
	GDOME_DOCUMENT_FRAGMENT_NODE = 11,
	GDOME_NOTATION_NODE = 12
} GdomeNodeType;


enum GdomeExceptionCode

typedef enum {
	GDOME_INDEX_SIZE_ERR = 1,
	GDOME_DOMSTRING_SIZE_ERR = 2,
	GDOME_HIERARCHY_REQUEST_ERR = 3,
	GDOME_WRONG_DOCUMENT_ERR = 4,
	GDOME_INVALID_CHARACTER_ERR = 5,
	GDOME_DATA_ALLOWED_ERR = 6,
	GDOME_NO_MODIFICATION_ALLOWED_ERR = 7,
	GDOME_NOT_FOUND_ERR = 8,
	GDOME_NOT_SUPPORTED_ERR = 9,
	GDOME_INUSE_ATTRIBUTE_ERR = 10,
	GDOME_INVALID_STATE_ERR = 11,
	GDOME_SYNTAX_ERR = 12,
	GDOME_INVALID_MODIFICATION_ERR = 13,
	GDOME_NAMESPACE_ERR = 14,
	GDOME_INVALID_ACCESS_ERR = 15,
	GDOME_NULL_POINTER_ERR = 100
} GdomeExceptionCode;


enum GdomeAccessType

typedef enum {
	GDOME_READONLY_NODE = 0,
	GDOME_READWRITE_NODE = 1
} GdomeAccessType;


GdomeBoolean

typedef int GdomeBoolean;


GdomeDOMTimeStamp

typedef long long GdomeDOMTimeStamp;


GdomeException

typedef unsigned short GdomeException;


struct GdomeDOMString

struct GdomeDOMString {
	gchar *str;
	gint refcnt;
	void (*unref) (GdomeDOMString *self);
};


gdome_str_mkref ()

GdomeDOMString* gdome_str_mkref             (const gchar *str);

Creates a GdomeDOMString from a statically allocated string.

str : a NULL terminated string
Returns : the new DOMString object.


gdome_str_mkref_own ()

GdomeDOMString* gdome_str_mkref_own         (gchar *str);

Creates a GdomeDOMString from a dynamically allocated gchar buffer.

str : a NULL terminated string
Returns : the new DOMString object.


gdome_str_mkref_dup ()

GdomeDOMString* gdome_str_mkref_dup         (const gchar *str);

Creates a GdomeDOMString from a static or dynamically allocated gchar buffer, but a copy of the initializing string is done before construction.

str : a NULL terminated string
Returns : the new DOMString object.


gdome_str_ref ()

void        gdome_str_ref                   (GdomeDOMString *self);

Increase the reference count of the specified GdomeDOMString.

self : DOMString Object ref


gdome_str_unref ()

void        gdome_str_unref                 (GdomeDOMString *self);

Decrease the reference count of the specified GdomeDOMString. Free the structure if the object will have zero reference.

self : DOMString Object ref


gdome_str_equal ()

GdomeBoolean gdome_str_equal                (GdomeDOMString *self,
                                             GdomeDOMString *str);

self : DOMString Object ref
str : DOMString to be compared
Returns : TRUE if the strings are equal, FALSE otherwise.


struct GdomePrivateList

struct GdomePrivateList {
	void *data;
	GdomePrivateList *next;
};


gdome_private_list_append ()

GdomePrivateList* gdome_private_list_append (GdomePrivateList *list,
                                             void *data);

Append a new element containing data to the list specified.

list : a pointer to the list to which append a new element
data : a pointer to the data that we want to add to the list
Returns : the list with the new element appended.


gdome_private_list_prepend ()

GdomePrivateList* gdome_private_list_prepend
                                            (GdomePrivateList *list,
                                             void *data);

Add a new element containing data at the first position of list specified.

list : a pointer to the list to which add a new element in the first position
data : a pointer to the data that we want to add to the list
Returns :the list with the new element added.


gdome_private_list_length ()

unsigned int gdome_private_list_length      (GdomePrivateList *list);

list : a pointer to a list
Returns : the number of elements in the list specified.


gdome_private_list_remove ()

GdomePrivateList* gdome_private_list_remove (GdomePrivateList *list,
                                             void *data);

Remove the element containing data from the list.

list : a pointer to the list to which remove an element
data : the pointer to the data that is to be removed from the list
Returns : the resulted list.


gdome_private_list_nth ()

GdomePrivateList* gdome_private_list_nth    (GdomePrivateList *list,
                                             unsigned int n);

list : a pointer to the list of which the nth element is wanted
n : the index to the element wanted
Returns : a pointer to the nth element of the list specified.