![]() |
![]() |
![]() |
Buzztard Bt-Core Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <libbtcore/core.h> struct BtPersistenceInterface; void bt_persistence_collect_hashtable_entries (gpointer const key
,gpointer const value
,gpointer const user_data
); gchar * bt_persistence_get_value (GValue * const gvalue
); BtPersistence * bt_persistence_load (const GType type
,const BtPersistence * const self
,xmlNodePtr node
,GError **err
,...
); gboolean bt_persistence_load_hashtable (GHashTable *hashtable
,xmlNodePtr node
); gint bt_persistence_parse_enum (GType enum_type
,const gchar *str
); xmlNodePtr bt_persistence_save (const BtPersistence * const self
,xmlNodePtr const parent_node
); gboolean bt_persistence_save_hashtable (GHashTable *hashtable
,xmlNodePtr const node
); gboolean bt_persistence_save_list (const GList *list
,xmlNodePtr const node
); gboolean bt_persistence_set_value (GValue * const gvalue
,const gchar * const svalue
); const gchar * bt_persistence_strfmt_double (const gdouble val
); const gchar * bt_persistence_strfmt_enum (GType enum_type
,gint value
); const gchar * bt_persistence_strfmt_long (const glong val
); const gchar * bt_persistence_strfmt_uchar (const guchar val
); const gchar * bt_persistence_strfmt_ulong (const gulong val
);
Classes can implement this interface to store their data as xml and restore them from xml. They should call the interface methods on their children objects (which also implement the interface) to serialize/ deserialize a whole object hierarchy.
struct BtPersistenceInterface { /* virtual methods */ xmlNodePtr (*save)(const BtPersistence * const self, xmlNodePtr const node); BtPersistence* (*load)(const GType type, const BtPersistence * const self, xmlNodePtr node, GError **err, va_list var_args); };
BtPersistence interface
void bt_persistence_collect_hashtable_entries (gpointer const key
,gpointer const value
,gpointer const user_data
);
Gather GHashTable entries in a list. Should be used with g_hash_table_foreach()
.
|
hashtable key |
|
hashtable value |
|
GList **list |
gchar * bt_persistence_get_value (GValue * const gvalue
);
Returns the string representation of the given gvalue
. Free it when done.
|
the event cell |
Returns : |
a newly allocated string with the data or NULL on error |
BtPersistence * bt_persistence_load (const GType type
,const BtPersistence * const self
,xmlNodePtr node
,GError **err
,...
);
Deserializes the given object from the node
. If self
is NULL and a type
is
given it constructs a new object.
|
a GObject type |
|
a deserialiable object |
|
the xml node |
|
a GError for deserialisation errors |
|
extra parameters NULL terminated name/value pairs. |
Returns : |
the deserialized object or NULL . |
gboolean bt_persistence_load_hashtable (GHashTable *hashtable
,xmlNodePtr node
);
Iterates over the xml-node and deserializes elements into the hashtable.
|
a GHashTable |
|
the list xml node |
Returns : |
TRUE if all elements have been deserialized. |
gint bt_persistence_parse_enum (GType enum_type
,const gchar *str
);
Convinience methods, that parses a enum value nick and to get the corresponding intger value.
|
the GType for the enum |
|
the enum value name |
Returns : |
the interger value for the enum, or -1 for invalid strings. |
xmlNodePtr bt_persistence_save (const BtPersistence * const self
,xmlNodePtr const parent_node
);
Serializes the given object into node
.
|
a serialiable object |
|
the parent xml node |
Returns : |
the new node if the object has been serialized, else NULL . |
gboolean bt_persistence_save_hashtable (GHashTable *hashtable
,xmlNodePtr const node
);
Iterates over a hashtable with strings and serializes them.
|
a GHashTable with strings |
|
the list xml node |
Returns : |
TRUE if all elements have been serialized. |
gboolean bt_persistence_save_list (const GList *list
,xmlNodePtr const node
);
Iterates over a list of objects, which must implement the BtPersistence
interface and calls bt_persistence_save()
on each item.
|
a GList
doc ; the xml-document |
|
the list xml node |
Returns : |
TRUE if all elements have been serialized. |
gboolean bt_persistence_set_value (GValue * const gvalue
,const gchar * const svalue
);
Stores the supplied value into the given gvalue
.
|
a GValue |
|
the string representation of the value to store |
Returns : |
TRUE for success |
const gchar * bt_persistence_strfmt_double (const gdouble val
);
Convinience methods, that formats a value to be serialized as a string.
|
a value |
Returns : |
a reference to static memory containg the formatted value. |
const gchar * bt_persistence_strfmt_enum (GType enum_type
,gint value
);
Convinience methods, that formats a value to be serialized as a string.
|
the GType for the enum |
|
the integer value for the enum |
Returns : |
a reference to static memory containg the formatted value. |
const gchar * bt_persistence_strfmt_long (const glong val
);
Convinience methods, that formats a value to be serialized as a string.
|
a value |
Returns : |
a reference to static memory containg the formatted value. |
const gchar * bt_persistence_strfmt_uchar (const guchar val
);
Convinience methods, that formats a value to be serialized as a string.
|
a value |
Returns : |
a reference to static memory containg the formatted value. |