|
Packit |
4b6dd7 |
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
|
|
Packit |
4b6dd7 |
/*
|
|
Packit |
4b6dd7 |
* GData Client
|
|
Packit |
4b6dd7 |
* Copyright (C) Philip Withnall 2009 <philip@tecnocode.co.uk>
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* GData Client is free software; you can redistribute it and/or
|
|
Packit |
4b6dd7 |
* modify it under the terms of the GNU Lesser General Public
|
|
Packit |
4b6dd7 |
* License as published by the Free Software Foundation; either
|
|
Packit |
4b6dd7 |
* version 2.1 of the License, or (at your option) any later version.
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* GData Client is distributed in the hope that it will be useful,
|
|
Packit |
4b6dd7 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit |
4b6dd7 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit |
4b6dd7 |
* Lesser General Public License for more details.
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* You should have received a copy of the GNU Lesser General Public
|
|
Packit |
4b6dd7 |
* License along with GData Client. If not, see <http://www.gnu.org/licenses/>.
|
|
Packit |
4b6dd7 |
*/
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#ifndef GDATA_PARSABLE_H
|
|
Packit |
4b6dd7 |
#define GDATA_PARSABLE_H
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#include <glib.h>
|
|
Packit |
4b6dd7 |
#include <glib-object.h>
|
|
Packit |
4b6dd7 |
#include <libxml/parser.h>
|
|
Packit |
4b6dd7 |
#include <json-glib/json-glib.h>
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
G_BEGIN_DECLS
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
/**
|
|
Packit |
4b6dd7 |
* GDataParserError:
|
|
Packit |
4b6dd7 |
* @GDATA_PARSER_ERROR_PARSING_STRING: Error parsing the XML or JSON syntax itself
|
|
Packit |
4b6dd7 |
* @GDATA_PARSER_ERROR_EMPTY_DOCUMENT: Empty document
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* Error codes for XML or JSON parsing operations.
|
|
Packit |
4b6dd7 |
*/
|
|
Packit |
4b6dd7 |
typedef enum {
|
|
Packit |
4b6dd7 |
GDATA_PARSER_ERROR_PARSING_STRING = 1,
|
|
Packit |
4b6dd7 |
GDATA_PARSER_ERROR_EMPTY_DOCUMENT
|
|
Packit |
4b6dd7 |
} GDataParserError;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define GDATA_PARSER_ERROR gdata_parser_error_quark ()
|
|
Packit |
4b6dd7 |
GQuark gdata_parser_error_quark (void) G_GNUC_CONST;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#define GDATA_TYPE_PARSABLE (gdata_parsable_get_type ())
|
|
Packit |
4b6dd7 |
#define GDATA_PARSABLE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GDATA_TYPE_PARSABLE, GDataParsable))
|
|
Packit |
4b6dd7 |
#define GDATA_PARSABLE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GDATA_TYPE_PARSABLE, GDataParsableClass))
|
|
Packit |
4b6dd7 |
#define GDATA_IS_PARSABLE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GDATA_TYPE_PARSABLE))
|
|
Packit |
4b6dd7 |
#define GDATA_IS_PARSABLE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GDATA_TYPE_PARSABLE))
|
|
Packit |
4b6dd7 |
#define GDATA_PARSABLE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GDATA_TYPE_PARSABLE, GDataParsableClass))
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
typedef struct _GDataParsablePrivate GDataParsablePrivate;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
/**
|
|
Packit |
4b6dd7 |
* GDataParsable:
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* All the fields in the #GDataParsable structure are private and should never be accessed directly.
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* Since: 0.3.0
|
|
Packit |
4b6dd7 |
*/
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
GObject parent;
|
|
Packit |
4b6dd7 |
GDataParsablePrivate *priv;
|
|
Packit |
4b6dd7 |
} GDataParsable;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
/**
|
|
Packit |
4b6dd7 |
* GDataParsableClass:
|
|
Packit |
4b6dd7 |
* @parent: the parent class
|
|
Packit |
4b6dd7 |
* @pre_parse_xml: a function called before parsing of an XML tree is started, which allows properties from the root node to be extracted
|
|
Packit |
4b6dd7 |
* and used in @parsable
|
|
Packit |
4b6dd7 |
* @parse_xml: a function to parse an XML representation of the #GDataParsable to set the properties of the @parsable
|
|
Packit |
4b6dd7 |
* @post_parse_xml: a function called after parsing an XML tree, to allow the @parsable to validate the parsed properties
|
|
Packit |
4b6dd7 |
* @pre_get_xml: a function called before building the XML representation of the children of the #GDataParsable, which allows attributes of the root
|
|
Packit |
4b6dd7 |
* XML node to be added to @xml_string
|
|
Packit |
4b6dd7 |
* @get_xml: a function to build an XML representation of the #GDataParsable in its current state, appending it to the provided #GString
|
|
Packit |
4b6dd7 |
* @get_namespaces: a function to return a string containing the namespace declarations used by the @parsable when represented in XML form
|
|
Packit |
4b6dd7 |
* @parse_json: a function to parse a JSON representation of the #GDataParsable to set the properties of the @parsable
|
|
Packit |
4b6dd7 |
* @post_parse_json: a function called after parsing a JSON object, to allow the @parsable to validate the parsed properties
|
|
Packit |
4b6dd7 |
* @get_json: a function to build a JSON representation of the #GDataParsable in its current state, appending it to the provided #JsonBuilder
|
|
Packit |
4b6dd7 |
* @get_content_type: a function which returns content type upon which is #GDataParsable built
|
|
Packit |
4b6dd7 |
* @element_name: the name of the XML element which represents this parsable
|
|
Packit |
4b6dd7 |
* @element_namespace: the prefix of the XML namespace used for the parsable
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* The class structure for the #GDataParsable class. Note that JSON and XML functions are mutually exclusive:
|
|
Packit |
4b6dd7 |
* a given implementation of #GDataParsable is represented as exactly one of JSON and XML.
|
|
Packit |
4b6dd7 |
*
|
|
Packit |
4b6dd7 |
* Since: 0.3.0
|
|
Packit |
4b6dd7 |
*/
|
|
Packit |
4b6dd7 |
typedef struct {
|
|
Packit |
4b6dd7 |
GObjectClass parent;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean (*pre_parse_xml) (GDataParsable *parsable, xmlDoc *doc, xmlNode *root_node, gpointer user_data, GError **error);
|
|
Packit |
4b6dd7 |
gboolean (*parse_xml) (GDataParsable *parsable, xmlDoc *doc, xmlNode *node, gpointer user_data, GError **error);
|
|
Packit |
4b6dd7 |
gboolean (*post_parse_xml) (GDataParsable *parsable, gpointer user_data, GError **error);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
void (*pre_get_xml) (GDataParsable *parsable, GString *xml_string);
|
|
Packit |
4b6dd7 |
void (*get_xml) (GDataParsable *parsable, GString *xml_string);
|
|
Packit |
4b6dd7 |
void (*get_namespaces) (GDataParsable *parsable, GHashTable *namespaces);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
gboolean (*parse_json) (GDataParsable *parsable, JsonReader *reader, gpointer user_data, GError **error);
|
|
Packit |
4b6dd7 |
gboolean (*post_parse_json) (GDataParsable *parsable, gpointer user_data, GError **error);
|
|
Packit |
4b6dd7 |
void (*get_json) (GDataParsable *parsable, JsonBuilder *builder);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *(*get_content_type) (void);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *element_name;
|
|
Packit |
4b6dd7 |
const gchar *element_namespace;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
/*< private >*/
|
|
Packit |
4b6dd7 |
/* Padding for future expansion */
|
|
Packit |
4b6dd7 |
void (*_g_reserved0) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved1) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved2) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved3) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved4) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved5) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved6) (void);
|
|
Packit |
4b6dd7 |
void (*_g_reserved7) (void);
|
|
Packit |
4b6dd7 |
} GDataParsableClass;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GType gdata_parsable_get_type (void) G_GNUC_CONST;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
const gchar *gdata_parsable_get_content_type (GDataParsable *self);
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataParsable *gdata_parsable_new_from_xml (GType parsable_type, const gchar *xml, gint length,
|
|
Packit |
4b6dd7 |
GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
|
|
Packit |
4b6dd7 |
gchar *gdata_parsable_get_xml (GDataParsable *self) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
GDataParsable *gdata_parsable_new_from_json (GType parsable_type, const gchar *json, gint length,
|
|
Packit |
4b6dd7 |
GError **error) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
|
|
Packit |
4b6dd7 |
gchar *gdata_parsable_get_json (GDataParsable *self) G_GNUC_WARN_UNUSED_RESULT G_GNUC_MALLOC;
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
G_END_DECLS
|
|
Packit |
4b6dd7 |
|
|
Packit |
4b6dd7 |
#endif /* !GDATA_PARSABLE_H */
|