Package org.gnome.gtk

Class BuildableParseContext

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gtk.BuildableParseContext

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class BuildableParseContext
extends ProxyInstance

Provides context for parsing GtkBuilder UI files.

GtkBuildableParseContext is an opaque struct.

Field Summary

Fields inherited from class io.github.jwharm.javagi.base.ProxyInstance

address

Constructor Summary

Constructors

Constructor	Description
BuildableParseContext(MemorySegment address)	Create a BuildableParseContext proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
String	getElement()	Retrieves the name of the currently open element.
String[]	getElementStack()	Retrieves the element stack from the internal state of the parser.
void	getPosition(@Nullable Out<Integer> lineNumber, @Nullable Out<Integer> charNumber)	Retrieves the current line number and the number of the character on that line.
MemorySegment	pop()	Completes the process of a temporary sub-parser redirection.
void	push(BuildableParser parser, @Nullable MemorySegment userData)	Temporarily redirects markup data to a sub-parser.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BuildableParseContext

public BuildableParseContext(MemorySegment address)

Create a BuildableParseContext proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getElement

public String getElement()

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 gtk_buildable_parse_context_get_element_stack().

Returns:

the name of the currently open element

getElementStack

public String[] getElementStack()

Retrieves the element stack from the internal state of the parser.

The returned GPtrArray is an array of strings where the last item is the currently open tag (as would be returned by gtk_buildable_parse_context_get_element()) and the previous item is its immediate parent.

This function is intended to be used in the start_element and end_element handlers where gtk_buildable_parse_context_get_element() would merely return the name of the element that is being processed.

Returns:

the element stack, which must not be modified

getPosition

public void getPosition(@Nullable
 @Nullable Out<Integer> lineNumber,
 @Nullable
 @Nullable Out<Integer> charNumber)

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."

Parameters:

lineNumber - return location for a line number

charNumber - return location for a char-on-line number

pop

public MemorySegment pop()

Completes the process of a temporary sub-parser redirection.

This function exists to collect the user_data allocated by a matching call to gtk_buildable_parse_context_push(). It must be called in the end_element handler corresponding to the start_element handler during which gtk_buildable_parse_context_push() was called. You must not call this function from the error callback -- the userData 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.

Returns:

the user data passed to gtk_buildable_parse_context_push()

push

public void push(BuildableParser parser,
 @Nullable
 @Nullable MemorySegment userData)

Temporarily redirects markup data to a sub-parser.

This function may only be called from the start_element handler of a GtkBuildableParser. It must be matched with a corresponding call to gtk_buildable_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. userData is used as the user_data for that parser. userData 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 gtk_buildable_parse_context_pop() is provided to allow "one last access" to the userData provided to this function. In the case of error, the userData provided here is passed directly to the error callback of the subparser and gtk_buildable_parse_context_pop() should not be called. In either case, if userData 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.

For an example of how to use this, see g_markup_parse_context_push() which has the same kind of API.

Parameters:

parser - a GtkBuildableParser

userData - user data to pass to GtkBuildableParser functions