json_parser_new ()

JsonParser *
json_parser_new (void);

Creates a new JsonParser instance. You can use the JsonParser to load a JSON stream from either a file or a buffer and then walk the hierarchy using the data types API.

json_parser_new_immutable ()

JsonParser *
json_parser_new_immutable (void);

Creates a new JsonParser instance with its “immutable” property set to TRUE to create immutable output trees.

Since: 1.2

json_parser_load_from_file ()

gboolean
json_parser_load_from_file (JsonParser *parser,
                            const gchar *filename,
                            GError **error);

Loads a JSON stream from the content of filename and parses it. See json_parser_load_from_data().

json_parser_load_from_data ()

gboolean
json_parser_load_from_data (JsonParser *parser,
                            const gchar *data,
                            gssize length,
                            GError **error);

Loads a JSON stream from a buffer and parses it. You can call this function multiple times with the same JsonParser object, but the contents of the parser will be destroyed each time.

json_parser_load_from_stream ()

gboolean
json_parser_load_from_stream (JsonParser *parser,
                              GInputStream *stream,
                              GCancellable *cancellable,
                              GError **error);

Loads the contents of an input stream and parses them.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be set on the passed error .

Since: 0.12

json_parser_load_from_stream_async ()

void
json_parser_load_from_stream_async (JsonParser *parser,
                                    GInputStream *stream,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);

Asynchronously reads the contents of stream .

For more details, see json_parser_load_from_stream() which is the synchronous version of this call.

When the operation is finished, callback will be called. You should then call json_parser_load_from_stream_finish() to get the result of the operation.

Since: 0.12

json_parser_load_from_stream_finish ()

gboolean
json_parser_load_from_stream_finish (JsonParser *parser,
                                     GAsyncResult *result,
                                     GError **error);

Finishes an asynchronous stream loading started with json_parser_load_from_stream_async().

Since: 0.12

json_parser_get_root ()

JsonNode *
json_parser_get_root (JsonParser *parser);

Retrieves the top level node from the parsed JSON stream.

json_parser_get_current_line ()

guint
json_parser_get_current_line (JsonParser *parser);

Retrieves the line currently parsed, starting from 1.

This function has defined behaviour only while parsing; calling this function from outside the signal handlers emitted by JsonParser will yield 0.

json_parser_get_current_pos ()

guint
json_parser_get_current_pos (JsonParser *parser);

Retrieves the current position inside the current line, starting from 0.

This function has defined behaviour only while parsing; calling this function from outside the signal handlers emitted by JsonParser will yield 0.

json_parser_has_assignment ()

gboolean
json_parser_has_assignment (JsonParser *parser,
                            gchar **variable_name);

A JSON data stream might sometimes contain an assignment, like:

1

var _json_data = { "member_name" : [ ...

even though it would technically constitute a violation of the RFC.

JsonParser will ignore the left hand identifier and parse the right hand value of the assignment. JsonParser will record, though, the existence of the assignment in the data stream and the variable name used.

Since: 0.4

enum JsonParserError

Error enumeration for JsonParser

This enumeration can be extended at later date

struct JsonParser

struct JsonParser;

JSON data streams parser. The contents of the JsonParser structure are private and should only be accessed via the provided API.

struct JsonParserClass

struct JsonParserClass {
  void (* parse_start)   (JsonParser   *parser);

  void (* object_start)  (JsonParser   *parser);
  void (* object_member) (JsonParser   *parser,
                          JsonObject   *object,
                          const gchar  *member_name);
  void (* object_end)    (JsonParser   *parser,
                          JsonObject   *object);

  void (* array_start)   (JsonParser   *parser);
  void (* array_element) (JsonParser   *parser,
                          JsonArray    *array,
                          gint          index_);
  void (* array_end)     (JsonParser   *parser,
                          JsonArray    *array);

  void (* parse_end)     (JsonParser   *parser);
  
  void (* error)         (JsonParser   *parser,
                          const GError *error);
};

JsonParser class.

The “immutable” property

  “immutable”                gboolean

Whether the JsonNode tree built by the JsonParser should be immutable when created. Making the output immutable on creation avoids the expense of traversing it to make it immutable later.

Flags: Read / Write / Construct Only

Default value: FALSE

Since: 1.2

The “array-element” signal

void
user_function (JsonParser *parser,
               JsonArray  *array,
               gint        index_,
               gpointer    user_data)

The ::array-element signal is emitted each time the JsonParser has successfully parsed a single element of a JsonArray. The array and element index are passed to the signal handlers.

Flags: Run Last

The “array-end” signal

void
user_function (JsonParser *parser,
               JsonArray  *array,
               gpointer    user_data)

The ::array-end signal is emitted each time the JsonParser has successfully parsed an entire JsonArray

Flags: Run Last

The “array-start” signal

void
user_function (JsonParser *parser,
               gpointer    user_data)

The ::array-start signal is emitted each time the JsonParser starts parsing a JsonArray

Flags: Run Last

The “error” signal

void
user_function (JsonParser *parser,
               gpointer    error,
               gpointer    user_data)

The ::error signal is emitted each time a JsonParser encounters an error in a JSON stream.

Flags: Run Last

The “object-end” signal

void
user_function (JsonParser *parser,
               JsonObject *object,
               gpointer    user_data)

The ::object-end signal is emitted each time the JsonParser has successfully parsed an entire JsonObject.

Flags: Run Last

The “object-member” signal

void
user_function (JsonParser *parser,
               JsonObject *object,
               gchar      *member_name,
               gpointer    user_data)

The ::object-member signal is emitted each time the JsonParser has successfully parsed a single member of a JsonObject. The object and member are passed to the signal handlers.

Flags: Run Last

The “object-start” signal

void
user_function (JsonParser *parser,
               gpointer    user_data)

The ::object-start signal is emitted each time the JsonParser starts parsing a JsonObject.

Flags: Run Last

The “parse-end” signal

void
user_function (JsonParser *parser,
               gpointer    user_data)

The ::parse-end signal is emitted when the parser successfully finished parsing a JSON data stream

Flags: Run Last

The “parse-start” signal

void
user_function (JsonParser *parser,
               gpointer    user_data)

The ::parse-start signal is emitted when the parser began parsing a JSON data stream.

Flags: Run Last