Top | ![]() |
![]() |
![]() |
![]() |
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 | 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 |
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
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.
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.
IdeBuildSystem is implemented by IdeFallbackBuildSystem.
IdeBuildSystemDiscovery is implemented by IdeSimpleBuildSystemDiscovery.
IdeBuildTarget is implemented by IdeSimpleBuildTarget.
“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).
Flags: Read
Default value: FALSE
Since: 3.32
“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.
Flags: Read
Default value: FALSE
Since: 3.32
“error-count”
property“error-count” guint
The number of errors discovered during the build process.
Flags: Read
Default value: 0
Since: 3.32
“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.
Flags: Read
Default value: FALSE
Since: 3.32
“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.
Flags: Read
Since: 3.32
“message”
property“message” gchar *
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.
Flags: Read
Default value: NULL
Since: 3.32
“pipeline”
property“pipeline” IdePipeline *
The "pipeline" property is the build pipeline that the build manager is currently managing.
Flags: Read
Since: 3.32
“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.
Flags: Read
Allowed values: >= 0
Default value: 0
Since: 3.32
“warning-count”
property“warning-count” guint
The "warning-count" property contains the number of warnings that have been discovered in the current build request.
Flags: Read
Default value: 0
Since: 3.32
“project-file”
property“project-file” GFile *
The project file.
Flags: Read / Write / Construct Only
“app-id”
property“app-id” gchar *
The application ID (such as org.gnome.Builder).
Flags: Read / Write
Default value: NULL
“append-path”
property“append-path” gchar *
Append to PATH environment variable.
Flags: Read / Write
Default value: NULL
“build-commands-dir”
property“build-commands-dir” GFile *
Directory to run build commands from.
Flags: Read / Write
“config-opts”
property“config-opts” gchar *
Parameters to bootstrap the project.
Flags: Read / Write
Default value: NULL
“dirty”
property“dirty” gboolean
If the configuration has been changed.
Flags: Read / Write
Default value: FALSE
“display-name”
property“display-name” gchar *
Display Name.
Flags: Read / Write
Default value: NULL
“locality”
property“locality” IdeBuildLocality
Where the build may occur.
Flags: Read / Write
Default value: IDE_BUILD_LOCALITY_IN_TREE | IDE_BUILD_LOCALITY_OUT_OF_TREE
“parallelism”
property“parallelism” gint
Parallelism.
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“post-install-commands”
property“post-install-commands” GStrv
Post install commands.
Flags: Read / Write
“ready”
property“ready” gboolean
If the configuration can be used for building.
Flags: Read
Default value: FALSE
“run-opts”
property“run-opts” gchar *
The options for running the target application.
Flags: Read / Write
Default value: NULL
“runtime-id”
property“runtime-id” gchar *
The identifier of the runtime.
Flags: Read / Write
Default value: "host"
“toolchain-id”
property“toolchain-id” gchar *
The identifier of the toolchain.
Flags: Read / Write
Default value: "default"
“current”
property“current” IdeConfig *
The current configuration for the context.
Flags: Read / Write
“current-display-name”
property“current-display-name” gchar *
The display name of the current configuration.
Flags: Read
Default value: NULL
“ready”
property“ready” gboolean
If the current configuration is ready.
Flags: Read
Default value: FALSE
“display-name”
property“display-name” gchar *
The display name of the device.
Flags: Read / Write
Default value: NULL
“icon-name”
property“icon-name” gchar *
The "icon-name" property is the icon to display with the device in various UI elements of Builder.
Flags: Read / Write
Default value: NULL
Since: 3.32
“host-triplet”
property“host-triplet” IdeTriplet *
The #IdeTriplet object holding all the configuration name values.
Flags: Read / Write
“kind”
property“kind” IdeDeviceKind
The device kind.
Flags: Read / Write
Default value: IDE_DEVICE_KIND_COMPUTER
“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.
Flags: Read / Write
Since: 3.32
“progress”
property“progress” gdouble
The "progress" property is updated with a value between 0.0 and 1.0 while the deployment is in progress.
Flags: Read
Allowed values: [0,1]
Default value: 0
Since: 3.32
“triplet”
property“triplet” IdeTriplet *
The #IdeTriplet object describing the local device configuration name.
Flags: Read / Write / Construct Only
“busy”
property“busy” gboolean
Gets the "busy" property. If TRUE
, the pipeline is busy executing.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“device”
property“device” IdeDevice *
The "device" property is the device we are compiling for.
Flags: Read / Write / Construct Only
Since: 3.32
“message”
property“message” gchar *
The "message" property is descriptive text about what the the pipeline is doing or it's readiness status.
Flags: Read
Default value: NULL
Since: 3.32
“phase”
property“phase” IdePipelinePhase
The current build phase during execution of the pipeline.
Flags: Read
Since: 3.32
“pty”
property“pty” VtePty *
The "pty" property is the VtePty that is used by build stages that build subprocesses with a pseudo terminal.
Flags: Read
Since: 3.32
“active”
property“active” gboolean
This property is set to TRUE
when the build stage is actively
running or cleaning.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“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.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“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
.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“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.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“name”
property“name” gchar *
The name of the build stage. This is only used by UI to view the build pipeline.
Flags: Read / Write
Default value: NULL
Since: 3.32
“stdout-path”
property“stdout-path” gchar *
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.
Flags: Read / Write
Default value: NULL
Since: 3.32
“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.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“clean-launcher”
property“clean-launcher” IdeSubprocessLauncher *
The subprocess launcher for cleaning.
Flags: Read / Write
“ignore-exit-status”
property“ignore-exit-status” gboolean
If the exit status of the subprocess should be ignored.
Flags: Read / Write
Default value: FALSE
“launcher”
property“launcher” IdeSubprocessLauncher *
The subprocess launcher to build.
Flags: Read / Write
“use-pty”
property“use-pty” gboolean
If the subprocess should have a Pty attached.
Flags: Read / Write
Default value: TRUE
“disable-when-metered”
property“disable-when-metered” gboolean
If the transfer should fail when on a metered connection.
Flags: Read / Write
Default value: TRUE
“transfer”
property“transfer” IdeTransfer *
The transfer to perform as part of the stage.
Flags: Read / Write / Construct Only
“build-target”
property“build-target” IdeBuildTarget *
The IdeBuildTarget that will be run.
Flags: Read / Write
“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.
Flags: Read / Write
Since: 3.32
“clear-env”
property“clear-env” gboolean
If the environment should be cleared before applying overrides.
Flags: Read / Write
Default value: FALSE
“cwd”
property“cwd” gchar *
The directory to use as the working directory for the process.
Flags: Read / Write
Default value: NULL
“environment”
property“environment” IdeEnvironment *
The environment variables for the command.
Flags: Read
“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.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“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.
Flags: Read / Write
Default value: FALSE
Since: 3.32
“category”
property“category” gchar *
The runtime's category.
Flags: Read / Write / Construct
Default value: NULL
“display-name”
property“display-name” gchar *
Display Name.
Flags: Read / Write / Construct
Default value: NULL
“id”
property“id” gchar *
The runtime identifier.
Flags: Read / Write / Construct
Default value: NULL
“display-name”
property“display-name” gchar *
The display_name of the unit test.
Flags: Read / Write
Default value: NULL
“group”
property“group” gchar *
The "group" property contains the name of the gruop the test belongs to, if any.
Flags: Read / Write
Default value: NULL
Since: 3.32
“id”
property“id” gchar *
The "id" property contains the unique identifier of the test.
Flags: Read / Write
Default value: NULL
Since: 3.32
“status”
property“status” IdeTestStatus
The status of the test.
Flags: Read / Write
Default value: IDE_TEST_STATUS_NONE
“loading”
property“loading” gboolean
The "loading" property denotes if a test provider is busy loading tests in the background.
Flags: Read
Default value: FALSE
Since: 3.32
“loading”
property“loading” gboolean
If the provider is loading tests.
Flags: Read / Write
Default value: FALSE
“display-name”
property“display-name” gchar *
The displayable name of the toolchain.
Flags: Read / Write
Default value: NULL
“host-triplet”
property“host-triplet” IdeTriplet *
The #IdeTriplet object containing the architecture of the machine on which the compiled binary will run.
Flags: Read / Write
“build-failed”
signalvoid 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.
self |
||
pipeline |
An IdePipeline |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.32
“build-finished”
signalvoid user_function (IdeBuildManager *self, IdePipeline *pipeline, gpointer user_data)
The "build-finished" signal is emitted when a build completed successfully.
self |
||
pipeline |
An IdePipeline |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.32
“build-started”
signalvoid 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.
self |
||
pipeline |
An IdePipeline |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.32
“invalidate”
signalvoid 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.
Flags: Run Last
Since: 3.32
“added”
signalvoid user_function (IdeConfigProvider *ideconfigprovider, IdeConfig *arg1, gpointer user_data)
Flags: Run Last
“removed”
signalvoid user_function (IdeConfigProvider *ideconfigprovider, IdeConfig *arg1, gpointer user_data)
Flags: Run Last
“deploy-finished”
signalvoid user_function (IdeDeviceManager *idedevicemanager, gpointer user_data)
Flags: Run Last
“deploy-started”
signalvoid user_function (IdeDeviceManager *idedevicemanager, gpointer user_data)
Flags: Run Last
“device-added”
signalvoid 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.
Flags: Run Last
Since: 3.32
“device-removed”
signalvoid 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.
Flags: Run Last
Since: 3.32
“diagnostic”
signalvoid user_function (IdePipeline *self, IdeDiagnostic *diagnostic, gpointer user_data)
This signal is emitted when a plugin has detected a diagnostic while building the pipeline.
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
“finished”
signalvoid 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
.
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
“loaded”
signalvoid user_function (IdePipeline *idepipeline, gpointer user_data)
The "loaded" signal is emitted after the pipeline has finished loading addins.
Flags: Run Last
Since: 3.32
“started”
signalvoid 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.
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
“chain”
signalgboolean user_function (IdePipelineStage *idepipelinestage, IdePipelineStage *arg1, gpointer user_data)
Flags: Run Last
“query”
signalvoid 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.
self |
||
pipeline |
An IdePipeline |
|
targets |
an array
of IdeBuildTarget or |
[element-type IdeBuildTarget][nullable] |
cancellable |
a GCancellable or |
[nullable] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.32
“reap”
signalvoid 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.
Flags: Run Last
Since: 3.32
“run”
signalvoid 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.
Flags: Run Last
Since: 3.32
“stopped”
signalvoid user_function (IdeRunManager *iderunmanager, gpointer user_data)
This signal is emitted when the run manager has stopped the currently executing inferior.
Flags: Run Last
Since: 3.32
“spawned”
signalvoid user_function (IdeRunner *iderunner, gchar *arg1, gpointer user_data)
Flags: Run Last
“added”
signalvoid user_function (IdeToolchainProvider *idetoolchainprovider, IdeToolchain *arg1, gpointer user_data)
Flags: Run Last
“removed”
signalvoid user_function (IdeToolchainProvider *idetoolchainprovider, IdeToolchain *arg1, gpointer user_data)
Flags: Run Last