IdeSymbolResolver

IdeSymbolResolver

Functions

Properties

IdeContext * context Write / Construct Only

Types and Values

Object Hierarchy

    GInterface
    ╰── IdeSymbolResolver

Prerequisites

IdeSymbolResolver requires IdeObject.

Description

Functions

IDE_TYPE_SYMBOL_RESOLVER

#define IDE_TYPE_SYMBOL_RESOLVER (ide_symbol_resolver_get_type())

ide_symbol_resolver_lookup_symbol_async ()

void
ide_symbol_resolver_lookup_symbol_async
                               (IdeSymbolResolver *self,
                                IdeSourceLocation *location,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously requests that self determine the symbol existing at the source location denoted by self . callback should call ide_symbol_resolver_lookup_symbol_finish() to retrieve the result.

Parameters

self

An IdeSymbolResolver.

 

location

An IdeSourceLocation.

 

cancellable

A GCancellable or NULL.

[allow-none]

callback

A callback to execute upon completion.

[scope async]

user_data

user data for callback .

 

ide_symbol_resolver_lookup_symbol_finish ()

IdeSymbol *
ide_symbol_resolver_lookup_symbol_finish
                               (IdeSymbolResolver *self,
                                GAsyncResult *result,
                                GError **error);

Completes an asynchronous call to lookup a symbol using ide_symbol_resolver_lookup_symbol_async().

Parameters

self

An IdeSymbolResolver.

 

result

A GAsyncResult provided to the callback.

 

error

A location for an error or NULL.

[out]

Returns

An IdeSymbol if successful; otherwise NULL.

[transfer full][nullable]


ide_symbol_resolver_get_symbol_tree_async ()

void
ide_symbol_resolver_get_symbol_tree_async
                               (IdeSymbolResolver *self,
                                GFile *file,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

ide_symbol_resolver_get_symbol_tree_finish ()

IdeSymbolTree *
ide_symbol_resolver_get_symbol_tree_finish
                               (IdeSymbolResolver *self,
                                GAsyncResult *result,
                                GError **error);

Completes an asynchronous request to get the symbol tree for the requested file.

Returns

An IdeSymbolTree; otherwise NULL and error is set.

[transfer full]

Types and Values

struct IdeSymbolResolverInterface

struct IdeSymbolResolverInterface {
  GTypeInterface parent_interface;

  void           (*lookup_symbol_async)    (IdeSymbolResolver    *self,
                                            IdeSourceLocation    *location,
                                            GCancellable         *cancellable,
                                            GAsyncReadyCallback   callback,
                                            gpointer              user_data);
  IdeSymbol     *(*lookup_symbol_finish)   (IdeSymbolResolver    *self,
                                            GAsyncResult         *result,
                                            GError              **error);
  void           (*get_symbol_tree_async)  (IdeSymbolResolver    *self,
                                            GFile                *file,
                                            GCancellable         *cancellable,
                                            GAsyncReadyCallback   callback,
                                            gpointer              user_data);
  IdeSymbolTree *(*get_symbol_tree_finish) (IdeSymbolResolver    *self,
                                            GAsyncResult         *result,
                                            GError              **error);
};

IdeSymbolResolver

typedef struct _IdeSymbolResolver IdeSymbolResolver;

Property Details

The “context” property

  “context”                  IdeContext *

Context.

Flags: Write / Construct Only