summaryrefslogtreecommitdiff
path: root/json-glib/json-generator.h
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@openedhand.com>2007-10-01 17:48:34 +0100
committerEmmanuele Bassi <ebassi@openedhand.com>2007-10-01 17:48:34 +0100
commitbfa60e9ef9da71e3c0d171f81cd08e8eac749061 (patch)
tree6b4752f056651ec8022859c678b0c5daf707be6a /json-glib/json-generator.h
parent41849494890f1f51bc7c4429f0ee7b5d168da302 (diff)
downloadjson-glib-bfa60e9ef9da71e3c0d171f81cd08e8eac749061.tar.gz
Add stub class for JsonGenerator
JsonGenerator is an object that creates JSON data streams from a data model tree. This commit adds the JsonGenerator class to the build and API reference.
Diffstat (limited to 'json-glib/json-generator.h')
-rw-r--r--json-glib/json-generator.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/json-glib/json-generator.h b/json-glib/json-generator.h
new file mode 100644
index 0000000..8fbe0f2
--- /dev/null
+++ b/json-glib/json-generator.h
@@ -0,0 +1,82 @@
+/* json-generator.h - JSON streams generator
+ *
+ * This file is part of JSON-GLib
+ * Copyright (C) 2007 OpenedHand Ltd.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * Author:
+ * Emmanuele Bassi <ebassi@openedhand.com>
+ */
+
+#ifndef __JSON_GENERATOR_H__
+#define __JSON_GENERATOR_H__
+
+#include <json-glib/json-types.h>
+
+G_BEGIN_DECLS
+
+#define JSON_TYPE_GENERATOR (json_generator_get_type ())
+#define JSON_GENERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), JSON_TYPE_GENERATOR, JsonGenerator))
+#define JSON_IS_GENERATOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), JSON_TYPE_GENERATOR))
+#define JSON_GENERATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), JSON_TYPE_GENERATOR, JsonGeneratorClass))
+#define JSON_IS_GENERATOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), JSON_TYPE_GENERATOR))
+#define JSON_GENERATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), JSON_TYPE_GENERATOR, JsonGeneratorClass))
+
+typedef struct _JsonGenerator JsonGenerator;
+typedef struct _JsonGeneratorPrivate JsonGeneratorPrivate;
+typedef struct _JsonGeneratorClass JsonGeneratorClass;
+
+/**
+ * JsonGenerator:
+ *
+ * JSON data streams generator. The contents of the #JsonGenerator structure
+ * are private and should only be accessed via the provided API.
+ */
+struct _JsonGenerator
+{
+ /*< private >*/
+ GObject parent_instance;
+
+ JsonGeneratorPrivate *priv;
+};
+
+/**
+ * JsonGeneratorClass:
+ *
+ * #JsonGenerator class
+ */
+struct _JsonGeneratorClass
+{
+ /*< private >*/
+ GObjectClass parent_class;
+
+ /* padding, for future expansion */
+ void (* _json_reserved1) (void);
+ void (* _json_reserved2) (void);
+ void (* _json_reserved3) (void);
+ void (* _json_reserved4) (void);
+};
+
+GType json_generator_get_type (void) G_GNUC_CONST;
+
+JsonGenerator *json_generator_new (void);
+gchar * json_generator_to_data (JsonGenerator *generator,
+ gsize *length);
+gboolean json_generator_to_file (JsonGenerator *generator,
+ const gchar *filename,
+ GError **error);
+void json_generator_set_root (JsonGenerator *generator,
+ JsonNode *node);
+
+G_END_DECLS
+
+#endif /* __JSON_GENERATOR_H__ */