Namespace

Ide – 47

An IDE for GNOME

Version47
AuthorsChristian Hergert
LicenseGPL-3.0-or-later
Websitehttps://apps.gnome.org/Builder
Sourcehttps://gitlab.gnome.org/GNOME/gnome-builder/

Build

C headerslibide-code.h, libide-core.h, libide-debugger.h, libide-editor.h, libide-foundry.h, libide-greeter.h, libide-gtk.h, libide-gui.h, libide-io.h, libide-lsp.h, libide-plugins.h, libide-projects.h, libide-search.h, libide-sourceview.h, libide-terminal.h, libide-threading.h, libide-tree.h, libide-tweaks.h, libide-vcs.h, libide-webkit.h

Dependencies

GLib—2.0 The base type system library
Browse documentation
GObject—2.0 The base type system library
Browse documentation

Additional documentation

Classes

ActionMuxer

Animation

Application

Buffer

BufferChangeMonitor

BufferManager

BuildManager

CachedListModel

CompileCommands

Config

ConfigManager

Context

Debugger

DebuggerBreakpoint

DebuggerBreakpoints

DebuggerFrame

DebuggerInstruction

DebuggerLibrary

DebuggerRegister

DebuggerThread

DebuggerThreadGroup

DebuggerVariable

DebugManager

DeployStrategy

Device

DeviceInfo

DeviceManager

DeviceProvider

Diagnostic

Diagnostics

DiagnosticsManager

DiagnosticTool

DirectoryReaper

DirectoryVcs

Doap

DoapPerson

EditorPage

EditorWorkspace

EntryPopover

EnumObject

Environment

EnvironmentEditor

EnvironmentVariable

ExtensionAdapter

ExtensionSetAdapter

FallbackBuildSystem

FileChooserEntry

FileSearchPreview

FileSettings

FileTransfer

FormatterOptions

Frame

FuzzyIndex

FuzzyIndexBuilder

FuzzyIndexCursor

FuzzyIndexMatch

GreeterRow

GreeterWorkspace

Grid

GSettingsActionGroup

HeaderBar

HighlightEngine

HtmlGenerator

InstallButton

JoinedMenu

LineChangeGutterRenderer

LocalDevice

Location

LogItem

LspClient

LspCodeAction

LspCodeActionProvider

LspCompletionItem

LspCompletionProvider

LspCompletionResults

LspDiagnostic

LspDiagnosticProvider

LspFormatter

LspHighlighter

LspHoverProvider

LspRenameProvider

LspSearchProvider

LspService

LspSymbolNode

LspSymbolResolver

LspSymbolTree

LspWorkspaceEdit

MarkedView

MenuManager

The goal of IdeMenuManager is to simplify the process of merging multiple GtkBuilder .ui files containing menus into a single representation of the application menus. Additionally, it provides the ability to “unmerge” previously merged menus.

Notification

Notifications

NotificationsButton

Object

ObjectBox

OmniBar

Page

Pane

PathCache

PersistentMap

PersistentMapBuilder

Pipeline

The IdePipeline is responsible for managing the build process for Builder. It consists of multiple build “phases” (see IdePipelinePhase for the individual phases). An IdePipelineStage can be attached with a priority to each phase and is the primary mechanism that plugins use to perform their operations in the proper ordering.

PipelineStage

PipelineStageCommand

PipelineStageLauncher

PipelineStageMkdirs

PipelineStageTransfer

PkconTransfer

Plugin

PluginSection

PrimaryWorkspace

ProgressIcon

Project

ProjectFile

ProjectInfo

This class contains information about a project that can be loaded. This information should be used to display a list of available projects.

ProjectTemplate

PropertyActionGroup

RadioBox

Range

RecentProjects

RecursiveFileMonitor

RunButton

RunCommand

RunCommands

RunContext

RunManager

Runtime

RuntimeManager

RuntimeProvider

RunTool

ScrubberRevealer

Sdk

SdkManager

SdkProvider

SearchEngine

SearchEntry

SearchPopover

SearchPreview

SearchResult

SearchResults

Session

SessionItem

Settings

SettingsFlagAction

ShortcutAccelDialog

SimpleBuildSystemDiscovery

SimpleBuildTarget

SimpleToolchain

SourceView

SubprocessLauncher

SubprocessSupervisor

Symbol

SymbolNode

Task

TaskCache

TemplateBase

TemplateInput

TemplateLocator

Terminal

TerminalLauncher

TerminalPage

TerminalPalette

TerminalPopover

TerminalSearch

Test

TestManager

TextEdit

Toolchain

ToolchainManager

Transfer

TransferManager

Tree

TreeExpander

TreeNode

TruncateModel

Tweaks

TweaksAddin

TweaksBinding

TweaksCaption

TweaksChoice

TweaksCombo

TweaksComboRow

TweaksDirectory

TweaksEntry

TweaksFactory

TweaksFont

TweaksGroup

TweaksInfo

TweaksItem

TweaksPage

TweaksProperty

TweaksRadio

TweaksSection

TweaksSetting

TweaksSpin

TweaksSwitch

TweaksWidget

TweaksWindow

UniqueListModel

UnixFDMap

UnsavedFiles

VcsCloneRequest

VcsFileInfo

VcsMonitor

WebkitPage

Workbench

Workspace

Structs

Action

ActionMixin

BuildLog

CodeIndexEntry

CodeIndexEntryBuilder

DebuggerAddressRange

File

FileTransferStat

FuzzyMutableIndex

FuzzyMutableIndexMatch

Heap

Heaps are similar to a partially sorted tree but implemented as an array. They allow for efficient O(1) lookup of the highest priority item as it will always be the first item of the array.

HighlightIndex

LineReader

MarkedContent

PatternSpec

PtyIntercept

PtyInterceptSide

SearchReducer

ShortcutInfo

TerminalPaletteFace

TestProvider

ThreadPool

Triplet

UnsavedFile

VcsUri

Enumerations

AnimationMode

ArtifactKind

BufferState

BuildLogStream

DebuggerBreakMode

The type of breakpoint.

DebuggerBreakpointChange

Describes the type of modification to perform on a breakpoint.

DebuggerDisposition

The disposition determines what should happen to the breakpoint at the next stop of the debugger.

DebuggerMovement

Describes the style of movement that should be performed by the debugger.

DebuggerStopReason

Represents the reason a process has stopped executing in the debugger.

DebuggerStream

The type of stream for the log message.

DeviceKind

DiagnosticSeverity

DoapError

HeaderBarPosition

HighlightResult

IndentStyle

LspCompletionKind

LspTrace

MarkedKind

ObjectLocation

ProcessKind

RunCommandKind

RunContextShell

Describes the type of shell to be used within the context.

ScrubberRevealPolicy

SearchCategory

SymbolKind

TaskKind

TestStatus

ThreadPoolKind

TransferError

TreeNodeVisit

TweaksItemVisitResult

VcsConfigType

VcsFileStatus

Bitfields

BufferLineChange

BufferOpenFlags

The IdeBufferOpenFlags enumeration is used to specify how the buffer manager should handle loading the buffer and if certain features should be enabled or disabled.

BuildLocality

FileTransferFlags

PipelinePhase

SpacesStyle

SymbolFlags

TemplateInputValidation

TreeNodeFlags

VcsCloneRequestValidation

Callbacks

ActionActivateFunc

BufferChangeMonitorForeachFunc

BufferCommitFunc

BufferForeachFunc

Callback prototype for ide_buffer_manager_foreach().

BuildLogObserver

DiagnosticsLineCallback

This function prototype is used to notify a caller of every line that has a diagnostic, and the most severe IdeDiagnosticSeverity for that line.

ExtensionSetAdapterForeachFunc

FileWalkCallback

HighlightCallback

PageCallback

PtyInterceptCallback

RecursiveIgnoreFunc

RunContextHandler

ShortcutInfoFunc

TaskCacheCallback

IdeTaskCacheCallback is the prototype for a function to be executed to populate an item in the cache.

TaskThreadFunc

TextIterCharPredicate

ThreadFunc

TreeNodeCompare

This callback function is a convenience wrapper around GCompareFunc.

TreeTraverseFunc

This function prototype is used to traverse a tree of IdeTreeNode.

TweaksBindingTransform

TweaksItemVisitor

Called for every matching item while visiting the item graph.

WidgetContextHandler

WorkspaceCallback

Functions

build_error_quark

cancellable_chain

If both self and other are not NULL, then the cancellation of other will be propagated to self if other is cancelled.

clear_page

clear_pane

code_get_resource

create_host_triplet

create_project_id

Escapes the project name into something suitable using as an id. This can be uesd to determine the directory name when the project name should be used.

dup_default_cache_dir

editor_encoding_menu_new

Creates a new GMenuModel with items which will activate using their encoding charset for the action action_name target.

editor_file_chooser_add_encodings

editor_file_chooser_add_line_endings

editor_file_chooser_get_encoding

editor_file_chooser_get_line_ending

editor_focus_buffer

editor_focus_location

editor_get_resource

editor_syntax_menu_new

Creates a new GMenuModel with items which will activate using their syntax id for the action action_name target.

environ_parse

Parses a KEY=VALUE style key-pair into key and value.

find_program_in_host_path

Like g_find_program_in_path() but checks the host system which may not be the same as the container we’re running within.

font_description_to_css

foundry_bytes_to_memfd

Writes all of bytes to a new memfd or tempfile and returns the file-descriptor. -1 is returned upon error.

foundry_file_to_memfd

foundry_get_launcher_for_context

A helper to get a launcher for program in the proper environment.

fuzzy_highlight

g_content_type_get_symbolic_icon

This function is similar to g_content_type_get_symbolic_icon() except that it takes our bundled icons into account to ensure that they are taken at a higher priority than the fallbacks from the current icon theme such as Adwaita.

g_date_time_format_for_display

Helper function to create a human-friendly string describing approximately how long ago a GDateTime is.

g_file_add_ignored_pattern

Adds a pattern that can be used to match ignored files. These are global to the application, so they should only include well-known ignored files such as those internal to a build system, or version control system, and similar.

g_file_find_async

Searches descendants of file for files matching pattern.

g_file_find_finish

Gets the files that were found which matched the pattern.

g_file_find_in_ancestors_async

g_file_find_in_ancestors_finish

g_file_find_with_depth

g_file_find_with_depth_async

Searches descendants of file for files matching pattern.

g_file_get_children_async

This function is like g_file_enumerate_children_async() except that it returns a GPtrArray of GFileInfo instead of an enumerator.

g_file_get_children_finish

Completes an asynchronous request to ide_g_file_get_children_async().

g_file_get_uncanonical_relative_path

This function is similar to g_file_get_relative_path() except that file and other only need to have a shared common ancestor.

g_file_is_ignored

Checks if file should be ignored using the internal ignore rules. If you care about the version control system, see IdeVcs and ide_vcs_is_ignored().

g_file_walk

Calls callback for every directory starting from directory.

g_file_walk_with_ignore

Calls callback for every directory starting from directory.

g_host_file_get_contents

This is similar to g_file_get_contents() but ensures that we get the file from the host, rather than our mount namespace.

g_time_span_to_label

Creates a string describing the time span in hours, minutes, and seconds. For example, a time span of three and a half minutes would be “3:30”. 2 days, 3 hours, 6 minutes, and 20 seconds would be “51:06:20”.

get_application_id

get_main_thread

Gets GThread of the main thread.

get_process_kind

Gets the kind of process we’re running as.

get_program_name

get_projects_dir

Gets the directory to store projects within.

get_relocatable_path

Gets the path to a resource that may be relocatable at runtime.

get_system_arch

get_system_page_size

get_system_type

get_user_default_path

Gets the default $PATH on the system for the user on the host.

get_user_shell

Gets the user preferred shell on the host.

gettext

greeter_get_resource

gtk_get_resource

gtk_list_store_insert_sorted

This function will binary search the contents of store looking for the location to insert a new row.

gtk_list_view_get_selected_row

gtk_list_view_move_next

gtk_list_view_move_previous

gtk_progress_bar_start_pulsing

gtk_progress_bar_stop_pulsing

gtk_show_uri_on_window

gtk_widget_destroyed

gtk_widget_hide_when_empty

gtk_widget_hide_with_fade

gtk_widget_show_with_fade

gtk_window_present

language_format_header

log_get_verbosity

Retrieves the log verbosity, which is the number of times -v was provided on the command line.

lsp_decode_completion_kind

lsp_decode_symbol_kind

lsp_decode_text_edit

Attempt to parse an encoded LSP text edit into an IdeTextEdit.

lsp_plugin_register_types

panel_position_get_area

panel_position_get_column

panel_position_get_depth

panel_position_get_row

path_collapse

This function will collapse a path that starts with the users home directory into a shorthand notation using ~/ for the home directory.

path_expand

This function will expand various “shell-like” features of the provided path using the POSIX wordexp(3) function. Command substitution will not be enabled, but path features such as ~user will be expanded.

path_is_c_like

path_is_cpp_like

path_is_ignored

Checks if path should be ignored using the global file ignores registered with Builder.

pty_new_sync

Creates a new VtePty suitable for Builder to be able to pass the PTY across PTY namespaces on Linux.

search_path_append

search_path_prepend

set_application_id

Sets the application id that will be used.

shell_supports_dash_c

shell_supports_dash_login

Checks if the shell is known to support login semantics. Originally, this meant --login, but now is meant to mean -l as more shells support -l than --login (notably dash).

show_tweaks

source_style_scheme_apply_style

source_style_scheme_get_variant

Gets an alternate for a style scheme if one exists. Otherwise scheme is returned.

source_style_scheme_is_dark

sourceview_get_resource

text_iter_backward_find_char

text_iter_backward_paragraph_start

Searches backwards until we find the beginning of a paragraph.

text_iter_backward_sentence_start

text_iter_backward_WORD_end

text_iter_backward_word_end

text_iter_backward_WORD_start

text_iter_backward_word_start

text_iter_current_symbol

text_iter_find_chars_backward

Search backward for a str string, starting at iter position till limit if there’s one. In case of succes, iter is updated to str start position.

text_iter_find_chars_forward

Search forward for a str string, starting at iter position till limit if there’s one. In case of succes, iter is updated to the found str start position, otherwise, its position is undefined.

text_iter_forward_find_char

Similar to gtk_text_iter_forward_find_char but lets us acces to the iter in the predicate.

text_iter_forward_paragraph_end

Searches forward until the end of a paragraph has been hit.

text_iter_forward_sentence_end

text_iter_forward_WORD_end

text_iter_forward_word_end

text_iter_forward_WORD_start

text_iter_forward_word_start

text_iter_in_string

Check if iter position in the buffer is part of str.

text_util_delete_line

text_util_int_to_string

text_util_remove_common_prefix

trace_function

vte_pty_create_producer

widget_get_context

Gets the context for the widget.

widget_get_workbench

Gets the IdeWorkbench that contains widget.

widget_get_workspace

Gets the IdeWorkspace containing widget.

widget_set_context_handler

Calls handler when the IdeContext has been set for widget.

Function Macros

BUG

CHECK_VERSION

Compile-time version checking. Evaluates to TRUE if the version of libide is greater than the required one.

context_warning

DEFINE_ACTION_GROUP

DEPRECATED_FOR

DEPRECATED_IN_43_FOR

DEPRECATED_IN_44_FOR

DEPRECATED_IN_45_FOR

DEPRECATED_IN_46_FOR

DEPRECATED_IN_47_FOR

diagnostics_get_size

DUMP_BYTES

ENCODE_VERSION

FILE_SETTINGS_PROPERTY

GOTO

Appends to the jump to label to the tracing log and then jumps to the label _l.

heap_index

heap_insert_val

heap_peek

is_flatpak

object_debug

object_message

object_warning

RETURN

Similar to IDE_EXIT but allows providing a return value.

TODO

Appends to the tracing log that unsupported code has been reached.

TRACE_MSG

Similar to IDE_PROBE but allows specifying a log message.

tweaks_addin_bind_callback

UNAVAILABLE

widget_warning

Constants

BUILD_CHANNEL

The release channel of Builder. This should be a string such as “other”, “flatpak-stable”, or “flatpak-nightly”.

BUILD_IDENTIFIER

A string containing a tag that defines the version of Builder that was built. Generally, this will be a small version tag plus some information to identify the git commit hash when applicable.

BUILD_TYPE

The build type of the installed build.

DEBUGGER_ADDRESS_INVALID

ENABLE_TRACE

FILE_SETTINGS_EXTENSION_POINT

LINE_CHANGES_FALLBACK_ADDED

LINE_CHANGES_FALLBACK_CHANGED

LINE_CHANGES_FALLBACK_REMOVED

LOG_LEVEL_TRACE

LSP_COMPLETION_PROVIDER_PRIORITY

MAJOR_VERSION

Libide major version component (e.g. 43 if IDE_VERSION is 43.1)

MINOR_VERSION

Libide minor version component (e.g. 1 if IDE_VERSION is 43.1)

PIPELINE_PHASE_MASK

PIPELINE_PHASE_WHENCE_MASK

PTY_FD_INVALID

PTY_INTERCEPT_MAGIC

RECENT_PROJECTS_BOOKMARK_FILENAME

RECENT_PROJECTS_BUILD_SYSTEM_GROUP_PREFIX

RECENT_PROJECTS_BUILD_SYSTEM_HINT_GROUP_PREFIX

RECENT_PROJECTS_DIRECTORY

RECENT_PROJECTS_GROUP

RECENT_PROJECTS_LANGUAGE_GROUP_PREFIX

TOOLCHAIN_LANGUAGE_ANY

TOOLCHAIN_LANGUAGE_C

TOOLCHAIN_LANGUAGE_CPLUSPLUS

TOOLCHAIN_LANGUAGE_D

TOOLCHAIN_LANGUAGE_FORTRAN

TOOLCHAIN_LANGUAGE_PYTHON

TOOLCHAIN_LANGUAGE_VALA

TOOLCHAIN_TOOL_AR

TOOLCHAIN_TOOL_CC

TOOLCHAIN_TOOL_CPP

TOOLCHAIN_TOOL_EXEC

TOOLCHAIN_TOOL_LD

TOOLCHAIN_TOOL_PKG_CONFIG

TOOLCHAIN_TOOL_STRIP

TREE_NODE_FLAGS_VCS_MASK

VERSION

Libide version.

VERSION_S

Libide version, encoded as a string, useful for printing and concatenation.