Foundry.Context¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`discover` (path, cancellable)
class	`error_quark` ()
class	`new` (foundry_dir, project_dir, flags, cancellable)
class	`new_for_user` (cancellable)
	`dup_action_group` ()
	`dup_build_manager` ()
	`dup_build_system` ()
	`dup_command_manager` ()
	`dup_config_manager` ()
	`dup_dbus_service` ()
	`dup_debugger_manager` ()
	`dup_default_license` ()
	`dup_dependency_manager` ()
	`dup_device_manager` ()
	`dup_diagnostic_manager` ()
	`dup_doap_service` ()
	`dup_documentation_manager` ()
	`dup_file_manager` ()
	`dup_forge_manager` ()
	`dup_intent_manager` ()
	`dup_llm_manager` ()
	`dup_log_manager` ()
	`dup_lsp_manager` ()
	`dup_operation_manager` ()
	`dup_project_directory` ()
	`dup_run_manager` ()
	`dup_sdk_manager` ()
	`dup_search_manager` ()
	`dup_secret_service` ()
	`dup_service_typed` (service_type)
	`dup_state_directory` ()
	`dup_terminal_service` ()
	`dup_test_manager` ()
	`dup_text_manager` ()
	`dup_title` ()
	`dup_tweak_manager` ()
	`dup_vcs_manager` ()
	`is_shared` ()
	`list_services` ()
	`load_project_settings` ()
	`load_settings` (schema_id, schema_path)
	`network_allowed` ()
	`save` (cancellable)
	`set_title` (title)
	`shutdown` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags
`build-manager`	`Foundry.BuildManager`	r
`build-system`	`str`	r
`command-manager`	`Foundry.CommandManager`	r
`config-manager`	`Foundry.ConfigManager`	r
`debugger-manager`	`Foundry.DebuggerManager`	r
`dependency-manager`	`Foundry.DependencyManager`	r
`device-manager`	`Foundry.DeviceManager`	r
`diagnostic-manager`	`Foundry.DiagnosticManager`	r
`doap-service`	`Foundry.DoapService`	r
`documentation-manager`	`Foundry.DocumentationManager`	r
`file-manager`	`Foundry.FileManager`	r
`forge-manager`	`Foundry.ForgeManager`	r
`intent-manager`	`Foundry.IntentManager`	r
`llm-manager`	`Foundry.LlmManager`	r
`log-manager`	`Foundry.LogManager`	r
`lsp-manager`	`Foundry.LspManager`	r
`operation-manager`	`Foundry.OperationManager`	r
`project-directory`	`Gio.File`	r
`run-manager`	`Foundry.RunManager`	r
`sdk-manager`	`Foundry.SdkManager`	r
`search-manager`	`Foundry.SearchManager`	r
`secret-service`	`Foundry.SecretService`	r
`state-directory`	`Gio.File`	r
`terminal-service`	`Foundry.TerminalService`	r
`test-manager`	`Foundry.TestManager`	r
`text-manager`	`Foundry.TextManager`	r
`title`	`str`	r/w/en
`tweak-manager`	`Foundry.TweakManager`	r
`vcs-manager`	`Foundry.VcsManager`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Foundry.Context(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Foundry.ContextClass

The central object representing an open project.

Foundry.Context serves as the main coordinator for all Foundry services and provides access to managers for files, builds, debugging, and other development tools. It maintains the application state and facilitates communication between different components of the development environment.

classmethod discover(path, cancellable)¶

Parameters:

path (str) – the starting path
cancellable (Dex.Cancellable or None) – an optional cancellable

Returns:

a Dex.Future that resolves to a path in the file system encoding.

Return type:

Dex.Future

Attempts to locate the nearest .foundry directory starting from path.

classmethod error_quark()¶

Return type:: int

classmethod new(foundry_dir, project_dir, flags, cancellable)¶

Parameters:

foundry_dir (str) – the “.foundry” directory
project_dir (str or None) – the project root directory
flags (Foundry.ContextFlags) – flags for how to create the context
cancellable (Dex.Cancellable or None) – optional cancellable to use when awaiting to propagate work cancellation

Returns:

a Dex.Future which will resolve to a Foundry.Context.

Return type:

Dex.Future

Creates a new context.

If flags has Foundry.ContextFlags.CREATE set then it will create the “.foundry” directory first.

If project_dir is not set, the current directory is used unless it was previously stored in the context state.

classmethod new_for_user(cancellable)¶

Parameters:: cancellable (Dex.Cancellable or None) – optional cancellable to use when awaiting to propagate work cancellation
Return type:: Dex.Future

dup_action_group()¶

Returns:: a [iface`Gio`.ActionGroup]
Return type:: Gio.ActionGroup

Gets a [iface`Gio`.ActionGroup] that contains various actions for the context.

Actions may be provided by subclassing Foundry.Service and implementing the [iface`Gio`.ActionGroup] interface.

dup_build_manager()¶

Returns:: a Foundry.BuildManager
Return type:: Foundry.BuildManager

Gets the Foundry.BuildManager instance.

dup_build_system()¶

Returns:: a build-system name or None
Return type:: str or None

Gets the name of the build system to use.

First the settings are checked. If set, that is preferred. After that, the configuration is checked to see if it specifies a build system.

Otherwise, None is returned.

Build addins can also affect which build system is used and you may check what the build pipeline thinks should be the build system (which checks this value) by using [property`Foundry`.BuildPipeline:build-system].

dup_command_manager()¶