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.

1 files changed, 255 insertions, 0 deletions

diff --git a/json-glib/json-generator.c b/json-glib/json-generator.c
new file mode 100644
index 0000000..798e6c1
--- /dev/null
+++ b/json-glib/json-generator.c
@@ -0,0 +1,255 @@
+/* json-generator.c - 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>
+ */
+
+/**
+ * SECTION:json-generator
+ * @short_description: Generates JSON data streams
+ *
+ * #JsonGenerator provides an object for generating a JSON data stream and
+ * put it into a buffer or a file.
+ */
+
+#include "config.h"
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "json-marshal.h"
+#include "json-generator.h"
+#include "json-private.h"
+
+#define JSON_GENERATOR_GET_PRIVATE(obj) \
+        (G_TYPE_INSTANCE_GET_PRIVATE ((obj), JSON_TYPE_GENERATOR, JsonGeneratorPrivate))
+
+struct _JsonGeneratorPrivate
+{
+  JsonNode *root;
+
+  guint indent;
+
+  guint pretty : 1;
+};
+
+enum
+{
+  PROP_0,
+
+  PROP_PRETTY,
+  PROP_INDENT
+};
+
+G_DEFINE_TYPE (JsonGenerator, json_generator, G_TYPE_OBJECT);
+
+static void
+json_generator_finalize (GObject *gobject)
+{
+  JsonGeneratorPrivate *priv = JSON_GENERATOR_GET_PRIVATE (gobject);
+
+  if (priv->root)
+    json_node_free (priv->root);
+
+  G_OBJECT_CLASS (json_generator_parent_class)->finalize (gobject);
+}
+
+static void
+json_generator_set_property (GObject      *gobject,
+                             guint         prop_id,
+                             const GValue *value,
+                             GParamSpec   *pspec)
+{
+  JsonGeneratorPrivate *priv = JSON_GENERATOR_GET_PRIVATE (gobject);
+
+  switch (prop_id)
+    {
+    case PROP_PRETTY:
+      priv->pretty = g_value_get_boolean (value);
+      break;
+    case PROP_INDENT:
+      priv->indent = g_value_get_uint (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);
+      break;
+    }
+}
+
+static void
+json_generator_get_property (GObject    *gobject,
+                             guint       prop_id,
+                             GValue     *value,
+                             GParamSpec *pspec)
+{
+  JsonGeneratorPrivate *priv = JSON_GENERATOR_GET_PRIVATE (gobject);
+
+  switch (prop_id)
+    {
+    case PROP_PRETTY:
+      g_value_set_boolean (value, priv->pretty);
+      break;
+    case PROP_INDENT:
+      g_value_set_uint (value, priv->indent);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (gobject, prop_id, pspec);
+      break;
+    }
+}
+
+static void
+json_generator_class_init (JsonGeneratorClass *klass)
+{
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+  g_type_class_add_private (klass, sizeof (JsonGeneratorPrivate));
+
+  gobject_class->set_property = json_generator_set_property;
+  gobject_class->get_property = json_generator_get_property;
+  gobject_class->finalize = json_generator_finalize;
+
+  /**
+   * JsonGenerator:pretty:
+   *
+   * Whether the output should be "pretty-printed", with indentation and
+   * newlines. The indentation level can be controlled by using the
+   * JsonGenerator:indent property
+   */
+  g_object_class_install_property (gobject_class,
+                                   PROP_PRETTY,
+                                   g_param_spec_boolean ("pretty",
+                                                         "Pretty",
+                                                         "Pretty-print the output",
+                                                         FALSE,
+                                                         G_PARAM_READWRITE));
+  /**
+   * JsonGenerator:indent:
+   *
+   * Number of spaces to be used to indent when pretty printing.
+   */
+  g_object_class_install_property (gobject_class,
+                                   PROP_INDENT,
+                                   g_param_spec_uint ("indent",
+                                                      "Indent",
+                                                      "Number of indentation spaces",
+                                                      0, G_MAXUINT,
+                                                      2,
+                                                      G_PARAM_READWRITE));
+}
+
+static void
+json_generator_init (JsonGenerator *generator)
+{
+  JsonGeneratorPrivate *priv;
+
+  generator->priv = priv = JSON_GENERATOR_GET_PRIVATE (generator);
+
+  priv->pretty = FALSE;
+  priv->indent = 2;
+}
+
+/**
+ * json_generator_new:
+ * 
+ * Creates a new #JsonGenerator. You can use this object to generate a
+ * JSON data stream starting from a data object model composed by
+ * #JsonNode<!-- -->s.
+ *
+ * Return value: the newly created #JsonGenerator instance
+ */
+JsonGenerator *
+json_generator_new (void)
+{
+  return g_object_new (JSON_TYPE_GENERATOR, NULL);
+}
+
+/**
+ * json_generator_to_data:
+ * @generator: a #JsonGenerator
+ * @length: return location for the length of the returned buffer, or %NULL
+ *
+ * Generates a JSON data stream from @generator and returns it as a
+ * buffer.
+ *
+ * Return value: a newly allocated buffer holding a JSON data stream. Use
+ *   g_free() to free the allocated resources.
+ */
+gchar *
+json_generator_to_data (JsonGenerator *generator,
+                        gsize         *length)
+{
+  g_return_val_if_fail (JSON_IS_GENERATOR (generator), NULL);
+  
+  if (length)
+    *length = 0;
+
+  return NULL;
+}
+
+/**
+ * json_generator_to_file:
+ * @generator: a #JsonGenerator
+ * @filename: path to the target file
+ * @error: return location for a #GError, or %NULL
+ *
+ * Creates a JSON data stream and puts it inside @filename, overwriting the
+ * current file contents. This operation is atomic.
+ *
+ * Return value: %TRUE if saving was successful.
+ */
+gboolean
+json_generator_to_file (JsonGenerator  *generator,
+                        const gchar    *filename,
+                        GError        **error)
+{
+  gchar *buffer;
+  gsize len;
+  gboolean retval;
+
+  g_return_val_if_fail (JSON_IS_GENERATOR (generator), FALSE);
+  g_return_val_if_fail (filename != NULL, FALSE);
+
+  buffer = json_generator_to_data (generator, &len);
+  retval = g_file_set_contents (filename, buffer, len, error);
+  g_free (buffer);
+
+  return retval;
+}
+
+/**
+ * json_generator_set_root:
+ * @generator: a #JsonGenerator
+ * @node: a #JsonNode
+ *
+ * Sets @node as the root of the JSON data stream to be serialized by
+ * the #JsonGenerator.
+ */
+void
+json_generator_set_root (JsonGenerator *generator,
+                         JsonNode      *node)
+{
+  g_return_if_fail (JSON_IS_GENERATOR (generator));
+
+  if (generator->priv->root)
+    {
+      json_node_free (generator->priv->root);
+      generator->priv->root = NULL;
+    }
+
+  if (node)
+    generator->priv->root = json_node_copy (node);
+}