![]() |
![]() |
![]() |
GSF Reference Manual | ![]() |
---|
utilsutils — |
void gsf_init (void); void gsf_shutdown (void); extern int libgsf_major_version; extern int libgsf_minor_version; extern int libgsf_micro_version; #define GSF_CLASS (name, prefix, class_init, instance_init, parent) #define GSF_CLASS_FULL (name, prefix, class_init, instance_init, parent_type, \ abstract, interface_decl) #define GSF_CLASS_ABSTRACT (name, prefix, class_init, instance_init, parent) #define GSF_DYNAMIC_CLASS (name, prefix, class_init, instance_init, parent, plugin, type) #define GSF_DYNAMIC_CLASS_FULL (name, prefix, class_init, instance_init, parent_type, \ abstract, interface_decl, plugin, type) #define GSF_DYNAMIC_CLASS_ABSTRACT (name, prefix, class_init, instance_init, parent, plugin, type) #define GSF_INTERFACE (init_func, iface_type) #define GSF_INTERFACE_FULL (type, init_func, iface_type) #define GSF_PARAM_STATIC void gsf_mem_dump (guint8 const *ptr, size_t len); void gsf_input_dump (GsfInput *input, gboolean dump_as_hex); #define GSF_OFF_T_FORMAT typedef gsf_off_t; char* gsf_filename_to_utf8 (char const *filename, gboolean quoted); void gsf_iconv_close (GIConv handle); charconst * gsf_extension_pointer (char const *path); guint8* gsf_base64_encode_simple (guint8 const *data, size_t len); size_t gsf_base64_encode_close (guint8 const *in, size_t inlen, gboolean break_lines, guint8 *out, int *state, guint *save); size_t gsf_base64_encode_step (guint8 const *in, size_t len, gboolean break_lines, guint8 *out, int *state, guint *save); size_t gsf_base64_decode_simple (guint8 *data, size_t len); size_t gsf_base64_decode_step (guint8 const *in, size_t len, guint8 *out, int *state, guint *save); #define GSF_LE_GET_GINT8 (p) #define GSF_LE_GET_GUINT64 (p) #define GSF_LE_GET_GINT16 (p) #define GSF_LE_GET_GUINT8 (p) #define GSF_LE_GET_GINT32 (p) #define GSF_LE_GET_GUINT16 (p) #define GSF_LE_GET_GUINT32 (p) #define GSF_LE_GET_GINT64 (p) guint64 gsf_le_get_guint64 (void const *p); #define GSF_LE_GET_FLOAT (p) float gsf_le_get_float (void const *p); #define GSF_LE_GET_DOUBLE (p) double gsf_le_get_double (void const *p); #define GSF_LE_SET_GUINT8 (p, dat) #define GSF_LE_SET_GUINT16 (p, dat) #define GSF_LE_SET_GUINT32 (p, dat) #define GSF_LE_SET_GINT8 (p,dat) #define GSF_LE_SET_GINT16 (p,dat) #define GSF_LE_SET_GINT32 (p,dat) #define GSF_LE_SET_GINT64 (p,dat) #define GSF_LE_SET_GUINT64 (p, dat) #define GSF_LE_SET_FLOAT (p,dat) #define GSF_LE_SET_DOUBLE (p,dat) void gsf_le_set_float (void *p, float f); void gsf_le_set_double (void *p, double d); GsfTimestamp; GsfTimestamp* gsf_timestamp_new (GDate const *date, glong seconds, char const *tz); GsfTimestamp* gsf_timestamp_new_now (void); GsfTimestamp* gsf_timestamp_copy (GsfTimestamp const *stamp); void gsf_timestamp_free (GsfTimestamp *stamp); char* gsf_timestamp_as_string (GsfTimestamp const *stamp); int gsf_timestamp_parse (char const *spec, GsfTimestamp *stamp); guint gsf_timestamp_hash (GsfTimestamp const *stamp); gboolean gsf_timestamp_equal (GsfTimestamp const *a, GsfTimestamp const *b); void gsf_value_set_timestamp (GValue *value, GsfTimestamp const *stamp); #define VAL_IS_GSF_TIMESTAMP (v) GValue* gsf_doc_prop_swap_val (GsfDocProp *prop, GValue *val); void gsf_property_settings_collect (GType object_type, GParameter **p_params, size_t *p_n_params, const gchar *first_property_name, ...); void gsf_property_settings_collect_valist (GType object_type, GParameter **p_params, size_t *p_n_params, const gchar *first_property_name, va_list var_args); void gsf_property_settings_free (GParameter *params, size_t n_params);
#define GSF_CLASS(name, prefix, class_init, instance_init, parent)
name : |
|
prefix : |
|
class_init : |
|
instance_init : |
|
parent : |
#define GSF_CLASS_FULL(name, prefix, class_init, instance_init, parent_type, \ abstract, interface_decl)
name : |
|
prefix : |
|
class_init : |
|
instance_init : |
|
parent_type : |
@\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: |
interface_decl : |
#define GSF_CLASS_ABSTRACT(name, prefix, class_init, instance_init, parent)
name : |
|
prefix : |
|
class_init : |
|
instance_init : |
|
parent : |
#define GSF_DYNAMIC_CLASS(name, prefix, class_init, instance_init, parent, plugin, type)
name : |
|
prefix : |
|
class_init : |
|
instance_init : |
|
parent : |
|
plugin : |
|
type : |
#define GSF_DYNAMIC_CLASS_FULL(name, prefix, class_init, instance_init, parent_type, \ abstract, interface_decl, plugin, type)
name : |
|
prefix : |
|
class_init : |
|
instance_init : |
|
parent_type : |
@\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: @\ abstract: |
interface_decl : |
|
plugin : |
|
type : |
#define GSF_DYNAMIC_CLASS_ABSTRACT(name, prefix, class_init, instance_init, parent, plugin, type)
name : |
|
prefix : |
|
class_init : |
|
instance_init : |
|
parent : |
|
plugin : |
|
type : |
#define GSF_INTERFACE_FULL(type, init_func, iface_type)
type : |
|
init_func : |
|
iface_type : |
void gsf_mem_dump (guint8 const *ptr, size_t len);
Dump len
bytes from the memory location given by ptr
.
ptr : |
memory area to be dumped. |
len : |
how many bytes will be dumped. |
void gsf_input_dump (GsfInput *input, gboolean dump_as_hex);
Dumps input
's contents to STDOUT, optionally in hex format.
input : |
a GsfInput |
dump_as_hex : |
If TRUE, dump in hexidecmal format |
char* gsf_filename_to_utf8 (char const *filename, gboolean quoted);
A utility wrapper to make sure filenames are valid utf8. Caller must g_free the result.
filename : |
file name suitable for open(2). |
quoted : |
if TRUE, the resulting utf8 file name will be quoted (unless it is invalid). |
Returns : |
filename using utf-8 encoding for display
|
charconst * gsf_extension_pointer (char const *path);
Extracts the extension from the end of a filename (the part after the final '.' in the filename).
path : |
A filename or file path. |
Returns : | A pointer to the extension part of the filename, or a pointer to the end of the string if the filename does not have an extension. |
guint8* gsf_base64_encode_simple (guint8 const *data, size_t len);
data : |
|
len : |
|
Returns : |
size_t gsf_base64_encode_close (guint8 const *in, size_t inlen, gboolean break_lines, guint8 *out, int *state, guint *save);
in : |
|
inlen : |
|
break_lines : |
|
out : |
|
state : |
|
save : |
|
Returns : |
size_t gsf_base64_encode_step (guint8 const *in, size_t len, gboolean break_lines, guint8 *out, int *state, guint *save);
in : |
|
len : |
|
break_lines : |
|
out : |
|
state : |
|
save : |
|
Returns : |
size_t gsf_base64_decode_simple (guint8 *data, size_t len);
data : |
|
len : |
|
Returns : |
size_t gsf_base64_decode_step (guint8 const *in, size_t len, guint8 *out, int *state, guint *save);
Decodes a chunk of base64 encoded data
in : |
input stream |
len : |
max length of data to decode |
out : |
output stream |
state : |
holds the number of bits that are stored in save
|
save : |
leftover bits that have not yet been decoded |
Returns : | the number of bytes converted |
typedef struct { GDate date; /* In local timezone */ glong seconds; /* time of day */ GString time_zone; /* possibly blank */ guint32 timet; } GsfTimestamp;
GsfTimestamp* gsf_timestamp_new (GDate const *date, glong seconds, char const *tz);
date : |
|
seconds : |
|
tz : |
|
Returns : |
GsfTimestamp* gsf_timestamp_copy (GsfTimestamp const *stamp);
stamp : |
|
Returns : |
char* gsf_timestamp_as_string (GsfTimestamp const *stamp);
stamp : |
|
Returns : |
int gsf_timestamp_parse (char const *spec, GsfTimestamp *stamp);
spec : |
|
stamp : |
|
Returns : |
gboolean gsf_timestamp_equal (GsfTimestamp const *a, GsfTimestamp const *b);
a : |
|
b : |
|
Returns : |
void gsf_value_set_timestamp (GValue *value, GsfTimestamp const *stamp);
value : |
|
stamp : |
#define VAL_IS_GSF_TIMESTAMP(v) (G_TYPE_CHECK_VALUE_TYPE((v), GSF_TIMESTAMP_TYPE))
v : |
GValue* gsf_doc_prop_swap_val (GsfDocProp *prop, GValue *val);
prop : |
GsfDocProp |
val : |
GValue |
Returns : | the current value of prop , and replaces it with val
Caller is responsible for unsetting and freeing the result.
|
void gsf_property_settings_collect (GType object_type, GParameter **p_params, size_t *p_n_params, const gchar *first_property_name, ...);
object_type : |
|
p_params : |
|
p_n_params : |
|
first_property_name : |
|
... : |
void gsf_property_settings_collect_valist (GType object_type, GParameter **p_params, size_t *p_n_params, const gchar *first_property_name, va_list var_args);
This function builds a GParameter array suitable for g_object_newv.
object_type : |
the GType for which the properties are being set. |
p_params : |
a pointer to the GParameter array that holds the properties. (Used for both input and output. This may point to a NULL pointer if there are no properties collected yet.) |
p_n_params : |
a pointer to the number of properties collected. (Used for both input and output.) |
first_property_name : |
the name of the first property being set, or NULL. |
var_args : |
a va_list holding the remainder of the property names and values, terminated by a NULL. |
<< Miscellaneous | Index >> |