|  |  |  | GSF Reference Manual |  | 
|---|---|---|---|---|
                    GsfXMLIn;
                    GsfXMLInDoc;
gboolean            (*GsfXMLInUnknownFunc)              (GsfXMLIn *xin,
                                                         xmlChar const *elem,
                                                         xmlChar const **attrs);
                    GsfXMLInNS;
                    GsfXMLInNode;
void                (*GsfXMLInExtDtor)                  (GsfXMLIn *xin,
                                                         gpointer old_state);
enum                GsfXMLContent;
                    GsfXMLBlob;
                    GsfInputHTTP;
#define             GSF_XML_IN_NODE_FULL                (parent_id, id, ns, name, has_content, 	
                                                         			     share_children_with_parent, check_ns, start, end, user)
#define             GSF_XML_IN_NODE                     (parent_id, id, ns, name, has_content, start, end)
#define             GSF_XML_IN_NODE_END
#define             GSF_XML_IN_NS                       (id, uri)
#define             GSF_XML_IN_NS_END
GsfXMLInDoc*        gsf_xml_in_doc_new                  (GsfXMLInNode const *nodes,
                                                         GsfXMLInNS const *ns);
void                gsf_xml_in_doc_free                 (GsfXMLInDoc *doc);
gboolean            gsf_xml_in_doc_parse                (GsfXMLInDoc *doc,
                                                         GsfInput *input,
                                                         gpointer user_state);
void                gsf_xml_in_doc_set_unknown_handler  (GsfXMLInDoc *doc,
                                                         GsfXMLInUnknownFunc handler);
void                gsf_xml_in_push_state               (GsfXMLIn *xin,
                                                         GsfXMLInDoc const *doc,
                                                         gpointer new_state,
                                                         GsfXMLInExtDtor dtor,
                                                         xmlChar const **attrs);
gboolean            gsf_xml_in_namecmp                  (GsfXMLIn const *xin,
                                                         char const *str,
                                                         unsigned int ns_id,
                                                         char const *name);
charconst  *        gsf_xml_in_check_ns                 (GsfXMLIn const *xin,
                                                         char const *str,
                                                         unsigned int ns_id);
GsfInput*           gsf_xml_in_get_input                (GsfXMLIn const *xin);
                    GsfXMLOut;
GsfXMLOut*          gsf_xml_out_new                     (GsfOutput *output);
void                gsf_xml_out_set_doc_type            (GsfXMLOut *xout,
                                                         char const *type);
GsfOutput*          gsf_xml_out_get_output              (GsfXMLOut const *xout);
void                gsf_xml_out_start_element           (GsfXMLOut *xout,
                                                         char const *id);
charconst *         gsf_xml_out_end_element             (GsfXMLOut *xout);
void                gsf_xml_out_add_cstr                (GsfXMLOut *xout,
                                                         char const *id,
                                                         char const *val_utf8);
void                gsf_xml_out_add_cstr_unchecked      (GsfXMLOut *xout,
                                                         char const *id,
                                                         char const *val_utf8);
void                gsf_xml_out_add_bool                (GsfXMLOut *xout,
                                                         char const *id,
                                                         gboolean val);
void                gsf_xml_out_add_int                 (GsfXMLOut *xout,
                                                         char const *id,
                                                         int val);
void                gsf_xml_out_add_uint                (GsfXMLOut *xout,
                                                         char const *id,
                                                         unsigned int val);
void                gsf_xml_out_add_float               (GsfXMLOut *xout,
                                                         char const *id,
                                                         double val,
                                                         int precision);
void                gsf_xml_out_add_enum                (GsfXMLOut *xout,
                                                         char const *id,
                                                         GType etype,
                                                         gint val);
void                gsf_xml_out_add_color               (GsfXMLOut *xout,
                                                         char const *id,
                                                         unsigned int r,
                                                         unsigned int g,
                                                         unsigned int b);
void                gsf_xml_out_add_base64              (GsfXMLOut *xout,
                                                         char const *id,
                                                         guint8 const *data,
                                                         unsigned int len);
void                gsf_xml_out_add_gvalue              (GsfXMLOut *xout,
                                                         char const *id,
                                                         GValue const *val);
void                gsf_xml_out_simple_element          (GsfXMLOut *xout,
                                                         char const *id,
                                                         char const *content);
void                gsf_xml_out_simple_float_element    (GsfXMLOut *xout,
                                                         char const *id,
                                                         double val,
                                                         int precision);
void                gsf_xml_out_simple_int_element      (GsfXMLOut *xout,
                                                         char const *id,
                                                         int val);
gchar*              gsf_input_http_get_content_type     (GsfInputHTTP *input);
GType               gsf_input_http_get_type             (void);
gchar*              gsf_input_http_get_url              (GsfInputHTTP *input);
xmlParserCtxt*      gsf_xml_parser_context              (GsfInput *input);
gboolean            gsf_xml_gvalue_from_str             (GValue *res,
                                                         GType t,
                                                         char const *str);
int                 gsf_xmlDocFormatDump                (GsfOutput *output,
                                                         xmlDoc *cur,
                                                         char const *encoding,
                                                         gboolean format);
typedef struct {
	/* public state : read only */
	gpointer	    user_state;
	GString		   *content;
	GsfXMLInDoc  const *doc;
	GsfXMLInNode const *node;	/* current node (not on the stack) */
	GSList	 	   *node_stack;	/* stack of GsfXMLInNode */
} GsfXMLIn;
gboolean (*GsfXMLInUnknownFunc) (GsfXMLIn *xin, xmlChar const *elem, xmlChar const **attrs);
| 
 | |
| 
 | |
| 
 | |
| Returns : | 
typedef struct {
	char const *id;		/* unique in the entire tree */
	int	    ns_id;
	char const *name;
	char const *parent_id;
	void (*start) (GsfXMLIn *xin, xmlChar const **attrs);
	void (*end)   (GsfXMLIn *xin, GsfXMLBlob *unknown);
	union {
		int	    v_int;
		gboolean    v_bool;
		gpointer    v_blob;
		char const *v_str;
	} user_data;
	GsfXMLContent has_content;
	unsigned int check_children_for_ns : 1;
	unsigned int share_children_with_parent : 1;
} GsfXMLInNode;
typedef enum {
	GSF_XML_NO_CONTENT = FALSE,
	GSF_XML_CONTENT,
	GSF_XML_SHARED_CONTENT
} GsfXMLContent;
#define             GSF_XML_IN_NODE_FULL(parent_id, id, ns, name, has_content, 	\
            			     share_children_with_parent, check_ns, start, end, user)
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | 
#define GSF_XML_IN_NODE(parent_id, id, ns, name, has_content, start, end)
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | 
GsfXMLInDoc* gsf_xml_in_doc_new (GsfXMLInNode const *nodes, GsfXMLInNS const *ns);
Combine the nodes in the NULL terminated array starting at nodes with the
name spaces in the NULL terminated array starting at ns.  Prepare the
data structures necessary to validate a doument based on that description.
| 
 | an array of node descriptors | 
| 
 | an array of namespace identifiers | 
| Returns : | NULLon error | 
void gsf_xml_in_doc_free (GsfXMLInDoc *doc);
Free up resources
| 
 | GsfXMLInDoc | 
gboolean gsf_xml_in_doc_parse (GsfXMLInDoc *doc, GsfInput *input, gpointer user_state);
Read an xout document from input and parse based on the the descriptor in
doc
| 
 | GsfXMLInDoc | 
| 
 | GsfInput | 
| 
 | |
| Returns : | FALSEon error | 
void gsf_xml_in_doc_set_unknown_handler (GsfXMLInDoc *doc, GsfXMLInUnknownFunc handler);
Call the function handler when an unexpected child node is found
| 
 | GsfXMLInDoc | 
| 
 | The function to call | 
void gsf_xml_in_push_state (GsfXMLIn *xin, GsfXMLInDoc const *doc, gpointer new_state, GsfXMLInExtDtor dtor, xmlChar const **attrs);
Take the first node from doc as the current node and call it's start handler.
| 
 | GsfXMLIn | 
| 
 | GsfXMLInDoc | 
| 
 | |
| 
 | GsfXMLInExtDtor | 
| 
 | array of xmlChar const * | 
gboolean gsf_xml_in_namecmp (GsfXMLIn const *xin, char const *str, unsigned int ns_id, char const *name);
| 
 | The GsfXMLIn we are reading from. | 
| 
 | The potentially namespace qualified node name. | 
| 
 | The name space id to check | 
| 
 | The target node name | 
| Returns : | TRUEifstr==ns_id:nameaccording tostate. | 
charconst * gsf_xml_in_check_ns (GsfXMLIn const *xin, char const *str, unsigned int ns_id);
According to state is str in the namespace ns_id ?
| 
 | GsfXMLIn | 
| 
 | |
| 
 | |
| Returns : | a pointer to strafter the namespace if successful,
	otherwise NULL. | 
GsfInput* gsf_xml_in_get_input (GsfXMLIn const *xin);
(New in 1.14.2)
| 
 | GsfXMLIn | 
| Returns : | (but does not reference) the stream being parsed. | 
void gsf_xml_out_set_doc_type (GsfXMLOut *xout, char const *type);
Store some optional some <!DOCTYPE .. > content
| 
 | GsfXMLOut | 
| 
 | the document type declaration | 
GsfOutput* gsf_xml_out_get_output (GsfXMLOut const *xout);
| 
 | |
| Returns : | 
void gsf_xml_out_start_element (GsfXMLOut *xout, char const *id);
Output a start element id, if necessary preceeded by an XML declaration.
| 
 | GsfXMLOut | 
| 
 | Element name | 
charconst * gsf_xml_out_end_element (GsfXMLOut *xout);
Closes/ends an XML element.
| 
 | GsfXMLOut | 
| Returns : | the element that has been closed. | 
void gsf_xml_out_add_cstr (GsfXMLOut *xout, char const *id, char const *val_utf8);
dump val_utf8 to an attribute named id or as the nodes content escaping
characters as necessary.  If val_utf8 is NULL do nothing (no warning, no
output)
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | a utf8 encoded string | 
void gsf_xml_out_add_cstr_unchecked (GsfXMLOut *xout, char const *id, char const *val_utf8);
dump val_utf8 to an attribute named id without checking to see if the
content needs escaping.  A useful performance enhancement when the
application knows that structure of the content well.  If val_utf8 is NULL
do nothing (no warning, no output)
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | a utf8 encoded string to export | 
void gsf_xml_out_add_bool (GsfXMLOut *xout, char const *id, gboolean val);
dump boolean value val to an attribute named id or as the nodes content
Use '1' or '0' to simplify import
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | a boolean | 
void gsf_xml_out_add_int (GsfXMLOut *xout, char const *id, int val);
dump integer value val to an attribute named id or as the nodes content
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | the value | 
void gsf_xml_out_add_uint (GsfXMLOut *xout, char const *id, unsigned int val);
dump unsigned integer value val to an attribute named id or as the nodes
content
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | the value | 
void gsf_xml_out_add_float (GsfXMLOut *xout, char const *id, double val, int precision);
dump float value val to an attribute named id or as the nodes
content with precision precision.  The number will be formattted
according to the "C" locale.
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | the value | 
| 
 | the number of significant digits to use, -1 meaning "enough". | 
void gsf_xml_out_add_enum (GsfXMLOut *xout, char const *id, GType etype, gint val);
Output the name of value val of enumeration type etype.
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | GType | 
| 
 | enum element number | 
void gsf_xml_out_add_color (GsfXMLOut *xout, char const *id, unsigned int r, unsigned int g, unsigned int b);
dump Color r.g.b to an attribute named id or as the nodes content
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | Red value | 
| 
 | Green value | 
| 
 | Blue value | 
void gsf_xml_out_add_base64 (GsfXMLOut *xout, char const *id, guint8 const *data, unsigned int len);
dump len bytes in data into the content of node id using base64
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | Data to be written | 
| 
 | Length of data | 
void gsf_xml_out_add_gvalue (GsfXMLOut *xout, char const *id, GValue const *val);
Output the value of val as a string.  Does NOT store any type information
with the string, just thevalue.
| 
 | GsfXMLOut | 
| 
 | optionally NULL for content | 
| 
 | GValue | 
void gsf_xml_out_simple_element (GsfXMLOut *xout, char const *id, char const *content);
Convenience routine to output a simple id element with content content.
| 
 | GsfXMLOut | 
| 
 | Element name | 
| 
 | Content of the element | 
void gsf_xml_out_simple_float_element (GsfXMLOut *xout, char const *id, double val, int precision);
Convenience routine to output an element id with float value val using
precision significant digits.
| 
 | GsfXMLOut | 
| 
 | Element name | 
| 
 | Element value | 
| 
 | the number of significant digits to use, -1 meaning "enough". | 
void gsf_xml_out_simple_int_element (GsfXMLOut *xout, char const *id, int val);
Convenience routine to output an element id with integer value val.
| 
 | GsfXMLOut | 
| 
 | Element name | 
| 
 | Element value | 
gchar* gsf_input_http_get_content_type (GsfInputHTTP *input);
| 
 | GsfInputHTTP | 
| Returns : | an allocated string containing the Content-Type field of the HTTP response. | 
gchar* gsf_input_http_get_url (GsfInputHTTP *input);
| 
 | GsfInputHTTP | 
| Returns : | an allocated string containing the URL used for input. | 
xmlParserCtxt* gsf_xml_parser_context (GsfInput *input);
Create a libxml2 pull style parser context wrapper around gsf input input.
This signature will probably change to supply a SAX structure.
input.
| 
 | GsfInput | 
| Returns : | A parser context or NULL | 
gboolean            gsf_xml_gvalue_from_str             (GValue *res,
                                                         GType t,
                                                         char const *str);
Try to parse str as a value of type t into res.
| 
 | Result value | 
| 
 | Type of data | 
| 
 | Value string | 
| Returns : | True when parsing of stras a value of typetwas succesfull;
false otherwise. | 
int gsf_xmlDocFormatDump (GsfOutput *output, xmlDoc *cur, char const *encoding, gboolean format);
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| Returns : |