ide-foundry-types: Builder SDK Reference

## ide-foundry-types ide-foundry-types |

## Properties

gboolean | busy | Read
gboolean | can-build | Read
guint | error-count | Read
gboolean | has-diagnostics | Read
GDateTime * | last-build-time | Read
char * | message | Read
IdePipeline * | pipeline | Read
gint64 | running-time | Read
guint | warning-count | Read
GFile * | project-file | Read / Write / Construct Only
char * | app-id | Read / Write
char * | append-path | Read / Write
GStrv | build-commands | Read / Write
GFile * | build-commands-dir | Read / Write
char * | config-opts | Read / Write
gboolean | debug | Read / Write
gboolean | dirty | Read / Write
char * | display-name | Read / Write
GStrv | environ | Read
char * | id | Read / Write / Construct Only
IdeBuildLocality | locality | Read / Write
int | parallelism | Read / Write
GStrv | post-install-commands | Read / Write
char * | prefix | Read / Write
gboolean | prefix-set | Read / Write
gboolean | ready | Read
char * | run-opts | Read / Write
IdeRuntime * | runtime | Read / Write
char * | runtime-id | Read / Write
IdeToolchain * | toolchain | Read / Write
char * | toolchain-id | Read / Write
IdeConfig * | current | Read / Write
char * | current-display-name | Read
gboolean | ready | Read
char * | display-name | Read / Write
char * | icon-name | Read / Write
char * | id | Read / Write
IdeTriplet * | host-triplet | Read / Write
IdeDeviceKind | kind | Read / Write
IdeDevice * | device | Read / Write
double | progress | Read
IdeTriplet * | triplet | Read / Write / Construct Only
gboolean | busy | Read / Write
IdeConfig * | config | Read / Write / Construct Only
IdeDevice * | device | Read / Write / Construct Only
char * | message | Read
IdePipelinePhase | phase | Read
VtePty * | pty | Read
gboolean | active | Read / Write
gboolean | check-stdout | Read / Write
gboolean | completed | Read / Write
gboolean | disabled | Read / Write
char * | name | Read / Write
char * | stdout-path | Read / Write
gboolean | transient | Read / Write
IdeSubprocessLauncher * | clean-launcher | Read / Write
gboolean | ignore-exit-status | Read / Write
IdeSubprocessLauncher * | launcher | Read / Write
gboolean | use-pty | Read / Write
gboolean | disable-when-metered | Read / Write
IdeTransfer * | transfer | Read / Write / Construct Only
IdeBuildTarget * | build-target | Read / Write
gboolean | busy | Read
char * | handler | Read
GStrv | argv | Read / Write
IdeBuildTarget * | build-target | Read / Write
gboolean | clear-env | Read / Write
char * | cwd | Read / Write
gboolean | disable-pty | Read / Write
IdeEnvironment * | environment | Read
gboolean | failed | Read / Write
gboolean | run-on-host | Read / Write
char * | category | Read / Write / Construct
char * | display-name | Read / Write / Construct
char * | id | Read / Write / Construct
char * | name | Read / Write / Construct
char * | display-name | Read / Write
char * | group | Read / Write
char * | id | Read / Write
IdeTestStatus | status | Read / Write
gboolean | loading | Read
gboolean | loading | Read / Write
char * | display-name | Read / Write
IdeTriplet * | host-triplet | Read / Write
char * | id | Read / Write

## Signals

void | build-failed | Run Last
void | build-finished | Run Last
void | build-started | Run Last
void | changed | Run Last
void | invalidate | Run Last
void | added | Run Last
void | removed | Run Last
void | deploy-finished | Run Last
void | deploy-started | Run Last
void | device-added | Run Last
void | device-removed | Run Last
void | diagnostic | Run Last
void | finished | Run Last
void | launcher-created | Run Last
void | loaded | Run Last
void | started | Run Last
gboolean | chain | Run Last
void | query | Run Last
void | reap | Run Last
void | run | Run Last
void | stopped | Run Last
void | exited | Run Last
void | spawned | Run Last
void | added | Run Last
void | removed | Run Last

## Types and Values

| IdeBuildLog
| IdeBuildManager
| IdeBuildSystem
| IdeBuildSystemDiscovery
| IdeBuildTarget
| IdeBuildTargetProvider
| IdeCompileCommands
| IdeConfig
| IdeConfigManager
| IdeConfigProvider
| IdeDependencyUpdater
| IdeDeployStrategy
| IdeDevice
| IdeDeviceInfo
| IdeDeviceManager
| IdeDeviceProvider
| IdeLocalDevice
| IdePipeline
| IdePipelineAddin
| IdePipelineStage
| IdePipelineStageLauncher
| IdePipelineStageMkdirs
| IdePipelineStageTransfer
| IdeRunButton
| IdeRunManager
| IdeRunner
| IdeRunnerAddin
| IdeRuntime
| IdeRuntimeManager
| IdeRuntimeProvider
| IdeSimpleBuildTarget
| IdeSimpleToolchain
| IdeTest
| IdeTestManager
| IdeTestProvider
| IdeToolchain
| IdeToolchainManager
| IdeToolchainProvider
| IdeTriplet

## Object Hierarchy

        GBoxed
        ╰── IdeTriplet
        GInterface
        ├── IdeBuildSystem
        ├── IdeBuildSystemDiscovery
        ├── IdeBuildTarget
        ├── IdeBuildTargetProvider
        ├── IdeConfigProvider
        ├── IdeDependencyUpdater
        ├── IdePipelineAddin
        ├── IdeRunnerAddin
        ├── IdeRuntimeProvider
        ╰── IdeToolchainProvider
        GObject
        ├── GInitiallyUnowned
        │   ╰── GtkWidget
        │       ╰── GtkContainer
        │           ╰── GtkBox
        │               ╰── IdeRunButton
        ├── IdeCompileCommands
        ├── IdeDeviceInfo
        ├── IdeObject
        │   ├── IdeTestManager
        │   ├── IdeTestProvider
        │   ├── IdeToolchain
        │   │   ├── IdeSimpleToolchain
        │   │   ╰── IdeSimpleToolchain
        │   ├── IdeBuildManager
        │   ├── IdeConfig
        │   ├── IdeConfigManager
        │   ├── IdeDeployStrategy
        │   ├── IdeDevice
        │   │   ╰── IdeLocalDevice
        │   ├── IdeDeviceManager
        │   ├── IdeDeviceProvider
        │   ├── IdePipeline
        │   ├── IdePipelineStage
        │   │   ├── IdePipelineStageLauncher
        │   │   ├── IdePipelineStageMkdirs
        │   │   ╰── IdePipelineStageTransfer
        │   ├── IdeRunManager
        │   ├── IdeRunner
        │   ├── IdeRuntime
        │   ├── IdeRuntimeManager
        │   ├── IdeSimpleBuildTarget
        │   ╰── IdeToolchainManager
        ╰── IdeTest

## Prerequisites

IdeBuildSystem requires IdeObject.

IdeBuildSystemDiscovery requires GObject.

IdeBuildTarget requires IdeObject.

IdeBuildTargetProvider requires GObject.

IdeConfigProvider requires IdeObject.

IdeDependencyUpdater requires IdeObject.

IdePipelineAddin requires IdeObject.

IdeRunnerAddin requires GObject.

IdeRuntimeProvider requires IdeObject.

IdeToolchainProvider requires IdeObject.

## Implemented Interfaces

IdeBuildManager implements GInitable and GActionGroup.

IdeConfigManager implements GListModel, GAsyncInitable and GActionGroup.

IdeDeviceManager implements GActionGroup, GAsyncInitable and GListModel.

IdePipeline implements GListModel and GInitable.

IdeRunButton implements AtkImplementorIface, GtkBuildable and GtkOrientable.

IdeRunManager implements GInitable and GActionGroup.

IdeRuntimeManager implements GListModel and GInitable.

IdeSimpleBuildTarget implements IdeBuildTarget.

IdeTestManager implements GInitable and GActionGroup.

IdeTestProvider implements GListModel.

IdeToolchainManager implements GListModel and GAsyncInitable.

## Known Implementations

IdeBuildSystem is implemented by IdeFallbackBuildSystem.

IdeBuildSystemDiscovery is implemented by IdeSimpleBuildSystemDiscovery.

IdeBuildTarget is implemented by IdeSimpleBuildTarget.

## Description

## Functions

## Types and Values

### IdeBuildLog

    typedef struct _IdeBuildLog IdeBuildLog;

### IdeBuildManager

    typedef struct _IdeBuildManager IdeBuildManager;

### IdeBuildSystem

    typedef struct _IdeBuildSystem IdeBuildSystem;

### IdeBuildSystemDiscovery

    typedef struct _IdeBuildSystemDiscovery IdeBuildSystemDiscovery;

### IdeBuildTarget

    typedef struct _IdeBuildTarget IdeBuildTarget;

### IdeBuildTargetProvider

    typedef struct _IdeBuildTargetProvider IdeBuildTargetProvider;

### IdeCompileCommands

    typedef struct _IdeCompileCommands IdeCompileCommands;

### IdeConfig

    typedef struct _IdeConfig IdeConfig;

### IdeConfigManager

    typedef struct _IdeConfigManager IdeConfigManager;

### IdeConfigProvider

    typedef struct _IdeConfigProvider IdeConfigProvider;

### IdeDependencyUpdater

    typedef struct _IdeDependencyUpdater IdeDependencyUpdater;

### IdeDeployStrategy

    typedef struct _IdeDeployStrategy IdeDeployStrategy;

### IdeDevice

    typedef struct _IdeDevice IdeDevice;

### IdeDeviceInfo

    typedef struct _IdeDeviceInfo IdeDeviceInfo;

### IdeDeviceManager

    typedef struct _IdeDeviceManager IdeDeviceManager;

### IdeDeviceProvider

    typedef struct _IdeDeviceProvider IdeDeviceProvider;

### IdeLocalDevice

    typedef struct _IdeLocalDevice IdeLocalDevice;

### IdePipeline

    typedef struct _IdePipeline IdePipeline;

### IdePipelineAddin

    typedef struct _IdePipelineAddin IdePipelineAddin;

### IdePipelineStage

    typedef struct _IdePipelineStage IdePipelineStage;

### IdePipelineStageLauncher

    typedef struct _IdePipelineStageLauncher IdePipelineStageLauncher;

### IdePipelineStageMkdirs

    typedef struct _IdePipelineStageMkdirs IdePipelineStageMkdirs;

### IdePipelineStageTransfer

    typedef struct _IdePipelineStageTransfer IdePipelineStageTransfer;

### IdeRunButton

    typedef struct _IdeRunButton IdeRunButton;

### IdeRunManager

    typedef struct _IdeRunManager IdeRunManager;

### IdeRunner

    typedef struct _IdeRunner IdeRunner;

### IdeRunnerAddin

    typedef struct _IdeRunnerAddin IdeRunnerAddin;

### IdeRuntime

    typedef struct _IdeRuntime IdeRuntime;

### IdeRuntimeManager

    typedef struct _IdeRuntimeManager IdeRuntimeManager;

### IdeRuntimeProvider

    typedef struct _IdeRuntimeProvider IdeRuntimeProvider;

### IdeSimpleBuildTarget

    typedef struct _IdeSimpleBuildTarget IdeSimpleBuildTarget;

### IdeSimpleToolchain

    typedef struct _IdeSimpleToolchain IdeSimpleToolchain;

### IdeTest

    typedef struct _IdeTest IdeTest;

### IdeTestManager

    typedef struct _IdeTestManager IdeTestManager;

### IdeTestProvider

    typedef struct _IdeTestProvider IdeTestProvider;

### IdeToolchain

    typedef struct _IdeToolchain IdeToolchain;

### IdeToolchainManager

    typedef struct _IdeToolchainManager IdeToolchainManager;

### IdeToolchainProvider

    typedef struct _IdeToolchainProvider IdeToolchainProvider;

### IdeTriplet

    typedef struct _IdeTriplet IdeTriplet;

## Property Details

### The `“busy”` property

      “busy”                     gboolean

The "busy" property indicates if there is currently a build executing. This can be bound to UI elements to display to the user that a build is active (and therefore other builds cannot be activated at the moment).

Owner: IdeBuildManager

Flags: Read

Default value: FALSE

Since: 3.32

### The `“can-build”` property

      “can-build”                gboolean

Gets if the build manager can queue a build request.

This might be false if the required runtime is not available or other errors in setting up the build pipeline.

Owner: IdeBuildManager

Flags: Read

Default value: FALSE

Since: 3.32

### The `“error-count”` property

      “error-count”              guint

The number of errors discovered during the build process.

Owner: IdeBuildManager

Flags: Read

Default value: 0

Since: 3.32

### The `“has-diagnostics”` property

      “has-diagnostics”          gboolean

The "has-diagnostics" property indicates that there have been diagnostics found during the last execution of the build pipeline.

Owner: IdeBuildManager

Flags: Read

Default value: FALSE

Since: 3.32

### The `“last-build-time”` property

      “last-build-time”          GDateTime *

The "last-build-time" property contains a GDateTime of the time the last build request was submitted.

Owner: IdeBuildManager

Flags: Read

Since: 3.32

### The `“message”` property

      “message”                  char *

The "message" property contains a string message describing the current state of the build process. This may be bound to UI elements to notify the user of the buid progress.

Owner: IdeBuildManager

Flags: Read

Default value: NULL

Since: 3.32

### The `“pipeline”` property

      “pipeline”                 IdePipeline *

The "pipeline" property is the build pipeline that the build manager is currently managing.

Owner: IdeBuildManager

Flags: Read

Since: 3.32

### The `“running-time”` property

      “running-time”             gint64

The "running-time" property can be bound by UI elements that want to track how long the current build has taken. `g_object_notify()` is called on a regular interval during the build so that the UI elements may automatically update.

The value of this property is a GTimeSpan, which are 64-bit signed integers with microsecond precision. See `G_USEC_PER_SEC` for a constant to tranform this to seconds.

Owner: IdeBuildManager

Flags: Read

Allowed values: >= 0

Default value: 0

Since: 3.32

### The `“warning-count”` property

      “warning-count”            guint

The "warning-count" property contains the number of warnings that have been discovered in the current build request.

Owner: IdeBuildManager

Flags: Read

Default value: 0

Since: 3.32

### The `“project-file”` property

      “project-file”             GFile *

The project file.

Owner: IdeBuildSystem

Flags: Read / Write / Construct Only

### The `“app-id”` property

      “app-id”                   char *

The application ID (such as org.gnome.Builder).

Owner: IdeConfig

Flags: Read / Write

Default value: NULL

### The `“append-path”` property

      “append-path”              char *

Append to PATH environment variable.

Owner: IdeConfig

Flags: Read / Write

Default value: NULL

### The `“build-commands”` property

      “build-commands”           GStrv

Build commands.

Owner: IdeConfig

Flags: Read / Write

### The `“build-commands-dir”` property

      “build-commands-dir”       GFile *

Directory to run build commands from.

Owner: IdeConfig

Flags: Read / Write

### The `“config-opts”` property

      “config-opts”              char *

Parameters to bootstrap the project.

Owner: IdeConfig

Flags: Read / Write

Default value: NULL

### The `“debug”` property

      “debug”                    gboolean

Debug.

Owner: IdeConfig

Flags: Read / Write

Default value: TRUE

### The `“dirty”` property

      “dirty”                    gboolean

If the configuration has been changed.

Owner: IdeConfig

Flags: Read / Write

Default value: FALSE

### The `“display-name”` property

      “display-name”             char *

Display Name.

Owner: IdeConfig

Flags: Read / Write

Default value: NULL

### The `“environ”` property

      “environ”                  GStrv

Environ.

Owner: IdeConfig

Flags: Read

### The `“id”` property

      “id”                       char *

Id.

Owner: IdeConfig

Flags: Read / Write / Construct Only

Default value: NULL

### The `“locality”` property

      “locality”                 IdeBuildLocality

Where the build may occur.

Owner: IdeConfig

Flags: Read / Write

Default value: IDE_BUILD_LOCALITY_IN_TREE | IDE_BUILD_LOCALITY_OUT_OF_TREE

### The `“parallelism”` property

      “parallelism”              int

Parallelism.

Owner: IdeConfig

Flags: Read / Write

Allowed values: >= -1

Default value: -1

### The `“post-install-commands”` property

      “post-install-commands”    GStrv

Post install commands.

Owner: IdeConfig

Flags: Read / Write

### The `“prefix”` property

      “prefix”                   char *

Prefix.

Owner: IdeConfig

Flags: Read / Write

Default value: NULL

### The `“prefix-set”` property

      “prefix-set”               gboolean

If Prefix is Set or not (meaning default).

Owner: IdeConfig

Flags: Read / Write

Default value: FALSE

### The `“ready”` property

      “ready”                    gboolean

If the configuration can be used for building.

Owner: IdeConfig

Flags: Read

Default value: FALSE

### The `“run-opts”` property

      “run-opts”                 char *

The options for running the target application.

Owner: IdeConfig

Flags: Read / Write

Default value: NULL

### The `“runtime”` property

      “runtime”                  IdeRuntime *

Runtime.

Owner: IdeConfig

Flags: Read / Write

### The `“runtime-id”` property

      “runtime-id”               char *

The identifier of the runtime.

Owner: IdeConfig

Flags: Read / Write

Default value: "host"

### The `“toolchain”` property

      “toolchain”                IdeToolchain *

Toolchain.

Owner: IdeConfig

Flags: Read / Write

### The `“toolchain-id”` property

      “toolchain-id”             char *

The identifier of the toolchain.

Owner: IdeConfig

Flags: Read / Write

Default value: "default"

### The `“current”` property

      “current”                  IdeConfig *

The current configuration for the context.

Owner: IdeConfigManager

Flags: Read / Write

### The `“current-display-name”` property

      “current-display-name”     char *

The display name of the current configuration.

Owner: IdeConfigManager

Flags: Read

Default value: NULL

### The `“ready”` property

      “ready”                    gboolean

If the current configuration is ready.

Owner: IdeConfigManager

Flags: Read

Default value: FALSE

### The `“display-name”` property

      “display-name”             char *

The display name of the device.

Owner: IdeDevice

Flags: Read / Write

Default value: NULL

### The `“icon-name”` property

      “icon-name”                char *

The "icon-name" property is the icon to display with the device in various UI elements of Builder.

Owner: IdeDevice

Flags: Read / Write

Default value: NULL

Since: 3.32

### The `“id”` property

      “id”                       char *

The device identifier.

Owner: IdeDevice

Flags: Read / Write

Default value: NULL

### The `“host-triplet”` property

      “host-triplet”             IdeTriplet *

The #IdeTriplet object holding all the configuration name values.

Owner: IdeDeviceInfo

Flags: Read / Write

### The `“kind”` property

      “kind”                     IdeDeviceKind

The device kind.

Owner: IdeDeviceInfo

Flags: Read / Write

Default value: IDE_DEVICE_KIND_COMPUTER

### The `“device”` property

      “device”                   IdeDevice *

The "device" property indicates the currently selected device by the user. This is the device we will try to deploy to when running, and execute the application on.

Owner: IdeDeviceManager

Flags: Read / Write

Since: 3.32

### The `“progress”` property

      “progress”                 double

The "progress" property is updated with a value between 0.0 and 1.0 while the deployment is in progress.

Owner: IdeDeviceManager

Flags: Read

Allowed values: [0,1]

Default value: 0

Since: 3.32

### The `“triplet”` property

      “triplet”                  IdeTriplet *

The #IdeTriplet object describing the local device configuration name.

Owner: IdeLocalDevice

Flags: Read / Write / Construct Only

### The `“busy”` property

      “busy”                     gboolean

Gets the "busy" property. If `TRUE`, the pipeline is busy executing.

Owner: IdePipeline

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“config”` property

      “config”                   IdeConfig *

Configuration.

Owner: IdePipeline

Flags: Read / Write / Construct Only

### The `“device”` property

      “device”                   IdeDevice *

The "device" property is the device we are compiling for.

Owner: IdePipeline

Flags: Read / Write / Construct Only

Since: 3.32

### The `“message”` property

      “message”                  char *

The "message" property is descriptive text about what the the pipeline is doing or it's readiness status.

Owner: IdePipeline

Flags: Read

Default value: NULL

Since: 3.32

### The `“phase”` property

      “phase”                    IdePipelinePhase

The current build phase during execution of the pipeline.

Owner: IdePipeline

Flags: Read

Since: 3.32

### The `“pty”` property

      “pty”                      VtePty *

The "pty" property is the VtePty that is used by build stages that build subprocesses with a pseudo terminal.

Owner: IdePipeline

Flags: Read

Since: 3.32

### The `“active”` property

      “active”                   gboolean

This property is set to `TRUE` when the build stage is actively running or cleaning.

Owner: IdePipelineStage

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“check-stdout”` property

      “check-stdout”             gboolean

Most build systems will preserve stderr for the processes they call, such as gcc, clang, and others. However, if your build system redirects all output to stdout, you may need to set this property to `TRUE` to ensure that Builder will extract errors from stdout.

One such example is Ninja.

Owner: IdePipelineStage

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“completed”` property

      “completed”                gboolean

The "completed" property is set to `TRUE` after the pipeline has completed processing the stage. When the pipeline invalidates phases, completed may be reset to `FALSE`.

Owner: IdePipelineStage

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“disabled”` property

      “disabled”                 gboolean

If the build stage is disabled. This allows you to have a stage that is attached but will not be activated during execution.

You may enable it later and then re-build the pipeline.

If the stage is both transient and disabled, it will not be removed during the transient cleanup phase.

Owner: IdePipelineStage

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“name”` property

      “name”                     char *

The name of the build stage. This is only used by UI to view the build pipeline.

Owner: IdePipelineStage

Flags: Read / Write

Default value: NULL

Since: 3.32

### The `“stdout-path”` property

      “stdout-path”              char *

The "stdout-path" property allows a build stage to redirect its log messages to a stdout file. Instead of passing stdout along to the build pipeline, they will be redirected to this file.

For safety reasons, the contents are first redirected to a temporary file and will be redirected to the stdout-path location after the build stage has completed executing.

Owner: IdePipelineStage

Flags: Read / Write

Default value: NULL

Since: 3.32

### The `“transient”` property

      “transient”                gboolean

If the build stage is transient.

A transient build stage is removed after the completion of `ide_pipeline_build_async()`. This can be a convenient way to add a temporary item to a build pipeline that should be immediately discarded.

Owner: IdePipelineStage

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“clean-launcher”` property

      “clean-launcher”           IdeSubprocessLauncher *

The subprocess launcher for cleaning.

Owner: IdePipelineStageLauncher

Flags: Read / Write

### The `“ignore-exit-status”` property

      “ignore-exit-status”       gboolean

If the exit status of the subprocess should be ignored.

Owner: IdePipelineStageLauncher

Flags: Read / Write

Default value: FALSE

### The `“launcher”` property

      “launcher”                 IdeSubprocessLauncher *

The subprocess launcher to build.

Owner: IdePipelineStageLauncher

Flags: Read / Write

### The `“use-pty”` property

      “use-pty”                  gboolean

If the subprocess should have a Pty attached.

Owner: IdePipelineStageLauncher

Flags: Read / Write

Default value: TRUE

### The `“disable-when-metered”` property

      “disable-when-metered”     gboolean

If the transfer should fail when on a metered connection.

Owner: IdePipelineStageTransfer

Flags: Read / Write

Default value: TRUE

### The `“transfer”` property

      “transfer”                 IdeTransfer *

The transfer to perform as part of the stage.

Owner: IdePipelineStageTransfer

Flags: Read / Write / Construct Only

### The `“build-target”` property

      “build-target”             IdeBuildTarget *

The IdeBuildTarget that will be run.

Owner: IdeRunManager

Flags: Read / Write

### The `“busy”` property

      “busy”                     gboolean

Busy.

Owner: IdeRunManager

Flags: Read

Default value: FALSE

### The `“handler”` property

      “handler”                  char *

Handler.

Owner: IdeRunManager

Flags: Read

Default value: "run"

### The `“argv”` property

      “argv”                     GStrv

The argument list for the command.

Owner: IdeRunner

Flags: Read / Write

### The `“build-target”` property

      “build-target”             IdeBuildTarget *

The `IdeBuildTarget` from which this `IdeRunner` was constructed.

This is useful to retrieve various properties related to the program that will be launched, such as what programming language it uses, or whether it's a graphical application, a command line tool or a test program.

Owner: IdeRunner

Flags: Read / Write

Since: 3.32

### The `“clear-env”` property

      “clear-env”                gboolean

If the environment should be cleared before applying overrides.

Owner: IdeRunner

Flags: Read / Write

Default value: FALSE

### The `“cwd”` property

      “cwd”                      char *

The directory to use as the working directory for the process.

Owner: IdeRunner

Flags: Read / Write

Default value: NULL

### The `“disable-pty”` property

      “disable-pty”              gboolean

If the pty should be disabled from use.

Owner: IdeRunner

Flags: Read / Write

Default value: FALSE

### The `“environment”` property

      “environment”              IdeEnvironment *

The environment variables for the command.

Owner: IdeRunner

Flags: Read

### The `“failed”` property

      “failed”                   gboolean

If the runner has "failed". This should be set if a plugin can determine that the runner cannot be executed due to an external issue. One such example might be a debugger plugin that cannot locate a suitable debugger to run the program.

Owner: IdeRunner

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“run-on-host”` property

      “run-on-host”              gboolean

The "run-on-host" property indicates the program should be run on the host machine rather than inside the application sandbox.

Owner: IdeRunner

Flags: Read / Write

Default value: FALSE

Since: 3.32

### The `“category”` property

      “category”                 char *

The runtime's category.

Owner: IdeRuntime

Flags: Read / Write / Construct

Default value: NULL

### The `“display-name”` property

      “display-name”             char *

Display Name.

Owner: IdeRuntime

Flags: Read / Write / Construct

Default value: NULL

### The `“id”` property

      “id”                       char *

The runtime identifier.

Owner: IdeRuntime

Flags: Read / Write / Construct

Default value: NULL

### The `“name”` property

      “name”                     char *

Name.

Owner: IdeRuntime

Flags: Read / Write / Construct

Default value: NULL

### The `“display-name”` property

      “display-name”             char *

The display_name of the unit test.

Owner: IdeTest

Flags: Read / Write

Default value: NULL

### The `“group”` property

      “group”                    char *

The "group" property contains the name of the gruop the test belongs to, if any.

Owner: IdeTest

Flags: Read / Write

Default value: NULL

Since: 3.32

### The `“id”` property

      “id”                       char *

The "id" property contains the unique identifier of the test.

Owner: IdeTest

Flags: Read / Write

Default value: NULL

Since: 3.32

### The `“status”` property

      “status”                   IdeTestStatus

The status of the test.

Owner: IdeTest

Flags: Read / Write

Default value: IDE_TEST_STATUS_NONE

### The `“loading”` property

      “loading”                  gboolean

The "loading" property denotes if a test provider is busy loading tests in the background.

Owner: IdeTestManager

Flags: Read

Default value: FALSE

Since: 3.32

### The `“loading”` property

      “loading”                  gboolean

If the provider is loading tests.

Owner: IdeTestProvider

Flags: Read / Write

Default value: FALSE

### The `“display-name”` property

      “display-name”             char *

The displayable name of the toolchain.

Owner: IdeToolchain

Flags: Read / Write

Default value: NULL

### The `“host-triplet”` property

      “host-triplet”             IdeTriplet *

The #IdeTriplet object containing the architecture of the machine on which the compiled binary will run.

Owner: IdeToolchain

Flags: Read / Write

### The `“id”` property

      “id”                       char *

The toolchain identifier.

Owner: IdeToolchain

Flags: Read / Write

Default value: NULL

## Signal Details

### The `“build-failed”` signal

    void
    user_function (IdeBuildManager *self,
                   IdePipeline     *pipeline,
                   gpointer         user_data)

The "build-failed" signal is emitted when a build that was previously notified via “build-started” has failed to complete successfully.

Contrast this with “build-finished” for a successful build.

#### Parameters

self | An IdeBuildManager |
pipeline | An IdePipeline |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“build-finished”` signal

    void
    user_function (IdeBuildManager *self,
                   IdePipeline     *pipeline,
                   gpointer         user_data)

The "build-finished" signal is emitted when a build completed successfully.

#### Parameters

self | An IdeBuildManager |
pipeline | An IdePipeline |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“build-started”` signal

    void
    user_function (IdeBuildManager *self,
                   IdePipeline     *pipeline,
                   gpointer         user_data)

The "build-started" signal is emitted when a new build has started. The build may be an incremental build. The `pipeline` instance is the build pipeline which is being executed.

#### Parameters

self | An IdeBuildManager |
pipeline | An IdePipeline |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“changed”` signal

    void
    user_function (IdeConfig *ideconfig,
                   gpointer   user_data)

Flags: Run Last

### The `“invalidate”` signal

    void
    user_function (IdeConfigManager *self,
                   gpointer          user_data)

This signal is emitted any time a new configuration is selected or the currently selected configurations state changes.

#### Parameters

self | an IdeConfigManager |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“added”` signal

    void
    user_function (IdeConfigProvider *ideconfigprovider,
                   IdeConfig         *arg1,
                   gpointer           user_data)

Flags: Run Last

### The `“removed”` signal

    void
    user_function (IdeConfigProvider *ideconfigprovider,
                   IdeConfig         *arg1,
                   gpointer           user_data)

Flags: Run Last

### The `“deploy-finished”` signal

    void
    user_function (IdeDeviceManager *idedevicemanager,
                   gpointer          user_data)

Flags: Run Last

### The `“deploy-started”` signal

    void
    user_function (IdeDeviceManager *idedevicemanager,
                   gpointer          user_data)

Flags: Run Last

### The `“device-added”` signal

    void
    user_function (IdeDeviceProvider *self,
                   IdeDevice         *device,
                   gpointer           user_data)

The "device-added" signal is emitted when a provider has discovered a device has become available.

Subclasses of IdeDeviceManager must chain-up if they override the IdeDeviceProviderClass.device_added vfunc.

#### Parameters

self | an IdeDeviceProvider |
device | an IdeDevice |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“device-removed”` signal

    void
    user_function (IdeDeviceProvider *self,
                   IdeDevice         *device,
                   gpointer           user_data)

The "device-removed" signal is emitted when a provider has discovered a device is no longer available.

Subclasses of IdeDeviceManager must chain-up if they override the IdeDeviceProviderClass.device_removed vfunc.

#### Parameters

self | an IdeDeviceProvider |
device | an IdeDevice |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“diagnostic”` signal

    void
    user_function (IdePipeline   *self,
                   IdeDiagnostic *diagnostic,
                   gpointer       user_data)

This signal is emitted when a plugin has detected a diagnostic while building the pipeline.

#### Parameters

self | An IdePipeline |
diagnostic | The newly created diagnostic |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“finished”` signal

    void
    user_function (IdePipeline *self,
                   gboolean     failed,
                   gpointer     user_data)

This signal is emitted when the build process has finished executing. If the build failed to complete all requested stages, then `failed` will be set to `TRUE`, otherwise `FALSE`.

#### Parameters

self | An IdePipeline |
failed | If the build was a failure |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“launcher-created”` signal

    void
    user_function (IdePipeline           *self,
                   IdeSubprocessLauncher *launcher,
                   gpointer               user_data)

The "launcher-created" signal is emitted when a new IdeSubprocessLauncher is created by the pipeline. This may be useful to plugins that wan to modify the launcher in a consistent way for all pipeline consumers.

#### Parameters

self | an IdePipeline |
launcher | an IdeSubprocessLauncher |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.34

### The `“loaded”` signal

    void
    user_function (IdePipeline *idepipeline,
                   gpointer     user_data)

The "loaded" signal is emitted after the pipeline has finished loading addins.

#### Parameters

user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“started”` signal

    void
    user_function (IdePipeline     *self,
                   IdePipelinePhase phase,
                   gpointer         user_data)

This signal is emitted when the pipeline has started executing in response to `ide_pipeline_build_async()` being called.

#### Parameters

self | An IdePipeline |
phase | the IdePipelinePhase for which we are advancing |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“chain”` signal

    gboolean
    user_function (IdePipelineStage *idepipelinestage,
                   IdePipelineStage *arg1,
                   gpointer          user_data)

Flags: Run Last

### The `“query”` signal

    void
    user_function (IdePipelineStage *self,
                   IdePipeline      *pipeline,
                   GPtrArray        *targets,
                   GCancellable     *cancellable,
                   gpointer          user_data)

The “query” signal is emitted to request that the build stage update its completed stage from any external resources.

This can be useful if you want to use an existing build stage instances and use a signal to pause forward progress until an external system has been checked.

The targets that the user would like to ensure are built are provided as `targets` . Some IdePipelineStage may use this to reduce the amount of work they perform

For example, in a signal handler, you may call `ide_pipeline_stage_pause()` and perform an external operation. Forward progress of the stage will be paused until a matching number of `ide_pipeline_stage_unpause()` calls have been made.

#### Parameters

self | An IdePipelineStage |
pipeline | An IdePipeline |
targets | an array of IdeBuildTarget or `NULL`. | [element-type IdeBuildTarget][nullable]
cancellable | a GCancellable or `NULL`. | [nullable]
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“reap”` signal

    void
    user_function (IdePipelineStage   *self,
                   DzlDirectoryReaper *reaper,
                   gpointer            user_data)

This signal is emitted when a request to rebuild the project has occurred. This allows build stages to ensure that certain files are removed from the system. For example, an autotools build stage might request that "configure" is removed so that autogen.sh will be Executed as part of the next build.

#### Parameters

self | An IdePipelineStage |
reaper | An DzlDirectoryReaper |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“run”` signal

    void
    user_function (IdeRunManager *self,
                   IdeRunner     *runner,
                   gpointer       user_data)

This signal is emitted right before `ide_runner_run_async()` is called on an IdeRunner. It can be used by plugins to tweak things right before the runner is executed.

The current run handler (debugger, profiler, etc) is run as the default handler for this function. So connect with `G_SIGNAL_AFTER` if you want to be nofied after the run handler has executed. It's unwise to change things that the run handler might expect. Generally if you want to change settings, do that before the run handler has exected.

#### Parameters

self | An IdeRunManager |
runner | An IdeRunner |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“stopped”` signal

    void
    user_function (IdeRunManager *iderunmanager,
                   gpointer       user_data)

This signal is emitted when the run manager has stopped the currently executing inferior.

#### Parameters

user_data | user data set when the signal handler was connected. |

Flags: Run Last

Since: 3.32

### The `“exited”` signal

    void
    user_function (IdeRunner *iderunner,
                   gpointer   user_data)

Flags: Run Last

### The `“spawned”` signal

    void
    user_function (IdeRunner *iderunner,
                   char      *arg1,
                   gpointer   user_data)

Flags: Run Last

### The `“added”` signal

    void
    user_function (IdeToolchainProvider *idetoolchainprovider,
                   IdeToolchain         *arg1,
                   gpointer              user_data)

Flags: Run Last

### The `“removed”` signal

    void
    user_function (IdeToolchainProvider *idetoolchainprovider,
                   IdeToolchain         *arg1,
                   gpointer              user_data)

Flags: Run Last