Parser

json.parser.Parser provides an object for parsing a JSON data stream, either inside a file or inside a static buffer.

Using json.parser.Parser

The json.parser.Parser API is fairly simple:

gboolean
parse_json (const char *filename)
{
  g_autoptr(JsonParser) parser = json_parser_new ();
  g_autoptr(GError) error = NULL

  json_parser_load_from_file (parser, filename, &error);
  if (error != NULL)
    {
      g_critical ("Unable to parse '%s': %s", filename, error->message);
      return FALSE;
    }

  g_autoptr(JsonNode) root = json_parser_get_root (parser);

  // manipulate the object tree from the root node

  return TRUE
}

By default, the entire process of loading the data and parsing it is synchronous; the json.parser.Parser.loadFromStreamAsync API will load the data asynchronously, but parse it in the main context as the signals of the parser must be emitted in the same thread. If you do not use signals, and you wish to also parse the JSON data without blocking, you should use a gio.task.Task and the synchronous json.parser.Parser API inside the task itself.

class Parser : ObjectG {

this();

static json.parser.Parser newImmutable();

uint getCurrentLine();

uint getCurrentPos();

json.node.Node getRoot();

bool hasAssignment(string variableName);

bool loadFromData(string data, ptrdiff_t length);

bool loadFromFile(string filename);

bool loadFromMappedFile(string filename);

bool loadFromStream(gio.input_stream.InputStream stream, gio.cancellable.Cancellable cancellable);

void loadFromStreamAsync(gio.input_stream.InputStream stream, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

bool loadFromStreamFinish(gio.async_result.AsyncResult result);

json.node.Node stealRoot();

ulong connectArrayElement(T callback, Flag!"After" after);

ulong connectArrayEnd(T callback, Flag!"After" after);

ulong connectArrayStart(T callback, Flag!"After" after);

ulong connectError(T callback, Flag!"After" after);

ulong connectObjectEnd(T callback, Flag!"After" after);

ulong connectObjectMember(T callback, Flag!"After" after);

ulong connectObjectStart(T callback, Flag!"After" after);

ulong connectParseEnd(T callback, Flag!"After" after);

ulong connectParseStart(T callback, Flag!"After" after);

}

Constructors

this this(): Creates a new JSON parser.

Members

Functions

connectArrayElement ulong connectArrayElement(T callback, Flag!"After" after): Connect to ArrayElement signal.
connectArrayEnd ulong connectArrayEnd(T callback, Flag!"After" after): Connect to ArrayEnd signal.
connectArrayStart ulong connectArrayStart(T callback, Flag!"After" after): Connect to ArrayStart signal.
connectError ulong connectError(T callback, Flag!"After" after): Connect to Error signal.
connectObjectEnd ulong connectObjectEnd(T callback, Flag!"After" after): Connect to ObjectEnd signal.
connectObjectMember ulong connectObjectMember(T callback, Flag!"After" after): Connect to ObjectMember signal.
connectObjectStart ulong connectObjectStart(T callback, Flag!"After" after): Connect to ObjectStart signal.
connectParseEnd ulong connectParseEnd(T callback, Flag!"After" after): Connect to ParseEnd signal.
connectParseStart ulong connectParseStart(T callback, Flag!"After" after): Connect to ParseStart signal.
getCurrentLine uint getCurrentLine(): Retrieves the line currently parsed, starting from 1.
getCurrentPos uint getCurrentPos(): Retrieves the current position inside the current line, starting from 0.
getRoot json.node.Node getRoot(): Retrieves the top level node from the parsed JSON stream.
hasAssignment bool hasAssignment(string variableName): A JSON data stream might sometimes contain an assignment, like:
loadFromData bool loadFromData(string data, ptrdiff_t length): Loads a JSON stream from a buffer and parses it.
loadFromFile bool loadFromFile(string filename): Loads a JSON stream from the content of filename and parses it.
loadFromMappedFile bool loadFromMappedFile(string filename): Loads a JSON stream from the content of filename and parses it.
loadFromStream bool loadFromStream(gio.input_stream.InputStream stream, gio.cancellable.Cancellable cancellable): Loads the contents of an input stream and parses them.
loadFromStreamAsync void loadFromStreamAsync(gio.input_stream.InputStream stream, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): Asynchronously reads the contents of a stream.
loadFromStreamFinish bool loadFromStreamFinish(gio.async_result.AsyncResult result): Finishes an asynchronous stream loading started with json.parser.Parser.loadFromStreamAsync.
stealRoot json.node.Node stealRoot(): Steals the top level node from the parsed JSON stream.

Static functions

newImmutable json.parser.Parser newImmutable(): Creates a new parser instance with its json.parser.Parser.gboolean property set to TRUE to create immutable output trees.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

json parser classes

Parser