Foundry.SymbolProvider

Subclasses:

None

Methods

Inherited:

Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)

Structs:

GObject.ObjectClass (5)

	find_symbol_at (file, contents, line, line_offset)
	list_symbols (file, contents)

Virtual Methods

Inherited:

GObject.Object (7), Json.Serializable (5)

	do_find_symbol_at (file, contents, line, line_offset)
	do_list_symbols (file, contents)

Properties

Inherited:

Foundry.Contextual (1)

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	Foundry.Contextual	r

Class Details

class Foundry.SymbolProvider(**kwargs)

Bases:

Foundry.Contextual

Abstract:

Yes

Structure:

Foundry.SymbolProviderClass

Abstract base class allowing plugins to introspect symbols within a specific file or file content.

find_symbol_at(file, contents, line, line_offset)

Parameters:

• file (Gio.File) – a [iface`Gio`.File]

• contents (GLib.Bytes or None) –

• line (int) – the line number (starting from 0)

• line_offset (int) – the character offset (starting from 0)

Returns:

a [class`Dex`.Future] that resolves to a [class`Foundry`.Symbol] or rejects with error

Return type:

Dex.Future

list_symbols(file, contents)

Parameters:

• file (Gio.File) – a [iface`Gio`.File]

• contents (GLib.Bytes or None) – optional modified contents for the file

Returns:

a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Symbol] or rejects with error

Return type:

Dex.Future

do_find_symbol_at(file, contents, line, line_offset) virtual

Parameters:

• file (Gio.File) – a [iface`Gio`.File]

• contents (GLib.Bytes or None) –

• line (int) – the line number (starting from 0)

• line_offset (int) – the character offset (starting from 0)

Returns:

a [class`Dex`.Future] that resolves to a [class`Foundry`.Symbol] or rejects with error

Return type:

Dex.Future

do_list_symbols(file, contents) virtual

Parameters:

• file (Gio.File) – a [iface`Gio`.File]

• contents (GLib.Bytes or None) – optional modified contents for the file

Returns:

a [class`Dex`.Future] that resolves to a [iface`Gio`.ListModel] of [class`Foundry`.Symbol] or rejects with error

Return type:

Dex.Future