class: GMarkupParseContext

[15:7] extends: object

A parse context is used to parse a stream of bytes that you expect to contain marked-up text. See g_markup_parse_context_new(), #GMarkupParser, and so on for more details.

Members

handleObj
lib
retainedCallbacks
signalHandlerNames
signalSetterHandlers

Methods

GMarkupParseContext (parser = null, flags = null, user_data = null, user_data_dnotify = null)

Creates a new parse context. A parse context is used to parse marked-up documents. You can feed any number of documents into a context, as long as no errors occur; once an error occurs, the parse context can't continue to parse text (you have to free it and create a new parse context).
- @p parser is a #GMarkupParser.
- @p flags is one or more #GMarkupParseFlags.
- @p user_data is user data to pass to #GMarkupParser functions.
- @p user_data_dnotify is user data destroy notifier called when the parse context is freed.
toNativeHandle (Source)

Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.
- @p Source is the raw handle, raw buffer, wrapper, or null.
- @r A raw pointer carrier or null when no pointer is present.
getLib ()

Returns the opened native library for this generated wrapper.
- @r The opened native library.
handle ()

Returns the wrapped NativeHandle.
- @r The wrapped NativeHandle.
isNull ()

Returns true when the wrapped handle is null.
- @r A bool.
describe ()

Returns a small string for debugging generated wrappers.
- @r A string.
end_parse ()

Signals to the #GMarkupParseContext that all data has been fed into the parse context with g_markup_parse_context_parse(). This function reports an error if the document isn't complete, for example if elements are still open.
- @r %TRUE on success, %FALSE if an error was set.
free ()

Frees a #GMarkupParseContext. This function can't be called from inside one of the #GMarkupParser functions or while a subparser is pushed.
- @r None.
get_attribute_position (int attr)

Retrieves the start and end positions of an attribute assignment in a start tag. This function can be used in the start_element callback to obtain location information for error reporting. Calling it outside of the start_element callback has undefined results. Note that
- @line_number and @char_number are intended for human readable error messages and are therefore 1-based and in Unicode characters. @offset on the other hand is meant for programmatic use, and thus is 0-based and in bytes. The information is meant to accompany the values returned by [method@GLib.MarkupParseContext.get_position], and comes with the same accuracy guarantees.
- @p attr is the index of the attribute to query.
- @p start_lines is return location for the line number of the attribute assignment start.
- @p start_chars is return location for the character number of the attribute assignment start.
- @p start_offset is return location for offset of the attribute assignment.
- @p end_lines is return location for the line number of the attribute assignment end.
- @p end_chars is return location for the character number of the attribute assignment end.
- @p end_offset is return location for offset of the attribute assignment end.
- @r None.
get_element ()

Retrieves the name of the currently open element. If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see g_markup_parse_context_get_element_stack().
- @r the name of the currently open element, or %NULL.
get_element_stack ()

Retrieves the element stack from the internal state of the parser. The returned #GSList is a list of strings where the first item is the currently open tag (as would be returned by g_markup_parse_context_get_element()) and the next item is its immediate parent. This function is intended to be used in the start_element and end_element handlers where g_markup_parse_context_get_element() would merely return the name of the element that is being processed.
- @r the element stack, which must not be modified.
get_offset ()

Retrieves the current offset from the beginning of the document, in bytes. The information is meant to accompany the values returned by [method@GLib.MarkupParseContext.get_position], and comes with the same accuracy guarantees.
- @r the offset.
get_position ()

Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages."
- @p line_number is return location for a line number, or %NULL.
- @p char_number is return location for a char-on-line number, or %NULL.
- @r None.
get_tag_start ()

Retrieves the start position of the current start or end tag. This function can be used in the start_element or end_element callbacks to obtain location information for error reporting. Calling it outside of these callbacks has undefined results. Note that @line_number and
- @char_number are intended for human readable error messages and are therefore 1-based and in Unicode characters. @offset on the other hand is meant for programmatic use, and thus is 0-based and in bytes. The information is meant to accompany the values returned by [method@GLib.MarkupParseContext.get_position], and comes with the same accuracy guarantees.
- @p line_number is return location for the line number.
- @p char_number is return location for the character number.
- @p offset is return location for offset from the beginning of the document.
- @r None.
get_user_data ()

Returns the user_data associated with @context. This will either be the user_data that was provided to g_markup_parse_context_new() or to the most recent call of g_markup_parse_context_push().
- @r the provided user_data. The returned data belongs to the markup context and will be freed when g_markup_parse_context_free() is called..
parse (string text, int text_len)

Feed some data to the #GMarkupParseContext. The data need not be valid UTF-8; an error will be signaled if it's invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the #GMarkupParseContext; all errors are fatal.
- @p text is chunk of text to parse.
- @p text_len is length of @text in bytes.
- @r %FALSE if an error occurred, %TRUE on success.
pop ()

Completes the process of a temporary sub-parser redirection. This function exists to collect the user_data allocated by a matching call to g_markup_parse_context_push(). It must be called in the end_element handler corresponding to the start_element handler during which g_markup_parse_context_push() was called. You must not call this function from the error callback -- the @user_data is provided directly to the callback in that case. This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface.
- @r the user data passed to g_markup_parse_context_push().
push (object parser, user_data)

Temporarily redirects markup data to a sub-parser. This function may only be called from the start_element handler of a #GMarkupParser. It must be matched with a corresponding call to g_markup_parse_context_pop() in the matching end_element handler (except in the case that the parser aborts due to an error). All tags, text and other data between the matching tags is redirected to the subparser given by @parser. @user_data is used as the user_data for that parser. @user_data is also passed to the error callback in the event that an error occurs. This includes errors that occur in subparsers of the subparser. The end tag matching the start tag for which this call was made is handled by the previous parser (which is given its own user_data) which is why g_markup_parse_context_pop() is provided to allow "one last access" to the @user_data provided to this function. In the case of error, the @user_data provided here is passed directly to the error callback of the subparser and g_markup_parse_context_pop() should not be called. In either case, if
- @user_data was allocated then it ought to be freed from both of these locations. This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface. As an example, see the following implementation of a simple parser that counts the number of tags encountered. |[ typedef struct { gint tag_count; } CounterData; static void counter_start_element (GMarkupParseContext *context, const gchar *element_name, const gchar **attribute_names, const gchar **attribute_values, gpointer user_data, GError **error) { CounterData *data = user_data; data->tag_count++; } static void counter_error (GMarkupParseContext *context, GError *error, gpointer user_data) { CounterData *data = user_data; g_slice_free (CounterData, data); } static GMarkupParser counter_subparser = { counter_start_element, NULL, NULL, NULL, counter_error }; ]| In order to allow this parser to be easily used as a subparser, the following interface is provided: |[ void start_counting (GMarkupParseContext *context) { CounterData *data = g_slice_new (CounterData); data->tag_count = 0; g_markup_parse_context_push (context, &counter_subparser, data); } gint end_counting (GMarkupParseContext *context) { CounterData *data = g_markup_parse_context_pop (context); int result; result = data->tag_count; g_slice_free (CounterData, data); return result; } ]| The subparser would then be used as follows: |[ static void start_element (context, element_name, ...) { if (strcmp (element_name, "count-these") == 0) start_counting (context); // else, handle other tags... } static void end_element (context, element_name, ...) { if (strcmp (element_name, "count-these") == 0) g_print ("Counted %d tags\n", end_counting (context)); // else, handle other tags... } ]|
- @p parser is a #GMarkupParser.
- @p user_data is user data to pass to #GMarkupParser functions.
- @r None.
ref ()

Increases the reference count of @context.
- @r the same @context.
unref ()

Decreases the reference count of @context. When its reference count drops to 0, it is freed.
- @r None.
element_stack ()

Returns get_element_stack as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_element_stack() when lazy or change-notify access is required.
- @r An Aussom list of elements.