IdeCodeIndexer: Builder SDK Reference

IdeCodeIndexer

Functions

IdeCodeIndexEntries *	ide_code_indexer_index_file ()
void	ide_code_indexer_generate_key_async ()
gchar *	ide_code_indexer_generate_key_finish ()

Types and Values

#define	IDE_TYPE_CODE_INDEXER
struct	IdeCodeIndexerInterface
	IdeCodeIndexer

Object Hierarchy

    GInterface
    ╰── IdeCodeIndexer

Prerequisites

IdeCodeIndexer requires IdeObject.

Description

Functions

ide_code_indexer_index_file ()

IdeCodeIndexEntries *
ide_code_indexer_index_file (IdeCodeIndexer *self,
                             GFile *file,
                             const gchar * const *build_flags,
                             GCancellable *cancellable,
                             GError **error);

This function will take index source file and create an array of symbols in file .

Parameters

self	An IdeCodeIndexer instance.
file	Source file to index.
build_flags	array of build flags to parse `file` .	[nullable][array zero-terminated=1]
cancellable	a GCancellable.	[nullable]
error	a GError.

Returns

an IdeCodeIndexEntries contains list of IdeCodeIndexEntry.

[transfer full]

Since: 3.26

ide_code_indexer_generate_key_async ()

void
ide_code_indexer_generate_key_async (IdeCodeIndexer *self,
                                     IdeSourceLocation *location,
                                     GCancellable *cancellable,
                                     GAsyncReadyCallback callback,
                                     gpointer user_data);

This function will get key of reference located at IdeSoureLocation.

Parameters

self	An IdeCodeIndexer instance.
location	Source location of refernece.	[not nullable]
cancellable	a GCancellable.	[nullable]
callback	A callback to execute upon indexing.
user_data	User data to pass to `callback` .

Since: 3.26

ide_code_indexer_generate_key_finish ()

gchar *
ide_code_indexer_generate_key_finish (IdeCodeIndexer *self,
                                      GAsyncResult *result,
                                      GError **error);

Returns key for declaration of reference at a location.

Parameters

self	an IdeCodeIndexer
result	a GAsyncResult
error	a location for a GError, or `NULL`

Returns

(transfer full) : A string which contains key.

Since: 3.26

Types and Values

IDE_TYPE_CODE_INDEXER

#define IDE_TYPE_CODE_INDEXER (ide_code_indexer_get_type())

struct IdeCodeIndexerInterface

struct IdeCodeIndexerInterface {
  GTypeInterface parent_iface;

  IdeCodeIndexEntries *(*index_file)             (IdeCodeIndexer       *self,
                                                  GFile                *file,
                                                  const gchar * const  *build_flags,
                                                  GCancellable         *cancellable,
                                                  GError              **error);
  void                 (*generate_key_async)     (IdeCodeIndexer       *self,
                                                  IdeSourceLocation    *location,
                                                  GCancellable         *cancellable,
                                                  GAsyncReadyCallback   callback,
                                                  gpointer              user_data);
  gchar               *(*generate_key_finish)    (IdeCodeIndexer       *self,
                                                  GAsyncResult         *result,
                                                  GError              **error);
};

IdeCodeIndexer

typedef struct _IdeCodeIndexer IdeCodeIndexer;