Ide.Runner
Description: Reference for Ide.Runner

### Class

# IdeRunner

#### Description

    class Ide.Runner : Ide.Object {
      parent_instance: IdeObject
    }

No description available.

#### Hierarchy

#### Ancestors

- IdeObject
- GObject

#### Constructors

###### ide_runner_new

No description available.

#### Instance methods

###### ide_runner_append_argv

No description available.

###### ide_runner_force_quit

No description available.

###### ide_runner_get_argv

Gets the argument list as a newly allocated string array.

Available since: 3.32

###### ide_runner_get_build_target

No description available.

Available since: 3.32

###### ide_runner_get_clear_env

No description available.

###### ide_runner_get_cwd

No description available.

Available since: 3.32

###### ide_runner_get_disable_pty

No description available.

###### ide_runner_get_environment

No description available.

Available since: 3.32

###### ide_runner_get_failed

No description available.

###### ide_runner_get_flags

No description available.

###### ide_runner_get_max_fd

No description available.

###### ide_runner_get_pty

Gets the `VtePty` that was assigned.

Available since: 3.34

###### ide_runner_get_run_on_host

No description available.

###### ide_runner_get_runtime

This function will get the `IdeRuntime` that will be used to execute the application. Consumers may want to use this to determine if a particular program is available (such as gdb, perf, strace, etc).

Available since: 3.32

###### ide_runner_get_stderr

No description available.

Available since: 3.32

###### ide_runner_get_stdin

No description available.

Available since: 3.32

###### ide_runner_get_stdout

No description available.

Available since: 3.32

###### ide_runner_prepend_argv

No description available.

###### ide_runner_push_args

Helper to call `ide_runner_append_argv()` for every argument contained in `args`.

Available since: 3.32

###### ide_runner_run_async

No description available.

###### ide_runner_run_finish

No description available.

###### ide_runner_set_argv

No description available.

###### ide_runner_set_build_target

Sets the build target associated with this runner.

Available since: 3.32

###### ide_runner_set_clear_env

No description available.

###### ide_runner_set_cwd

Sets the directory to use when spawning the runner.

Available since: 3.32

###### ide_runner_set_disable_pty

No description available.

###### ide_runner_set_failed

No description available.

###### ide_runner_set_flags

No description available.

###### ide_runner_set_pty

Sets the `VtePty` to use for the runner.

Available since: 3.32

###### ide_runner_set_run_on_host

No description available.

###### ide_runner_take_fd

This will ensure that `source_fd` is mapped into the new process as `dest_fd`. If `dest_fd` is -1, then the next fd will be used and that value will be returned. Note that this is not a valid fd in the calling process, only within the destination process.

Available since: 3.32

###### ide_runner_take_tty_fd

No description available.

##### Methods inherited from IdeObject (28)

Please see IdeObject for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### Ide.Runner:argv

No description available.

###### Ide.Runner:build-target

The %IdeBuildTarget from which this %IdeRunner was constructed.

Available since: 3.32

###### Ide.Runner:clear-env

No description available.

###### Ide.Runner:cwd

No description available.

###### Ide.Runner:disable-pty

No description available.

###### Ide.Runner:environment

No description available.

###### Ide.Runner:failed

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.

Available since: 3.32

###### Ide.Runner:run-on-host

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

Available since: 3.32

##### Properties inherited from IdeObject (2)

###### Ide.Object:cancellable

The “cancellable” property is a `GCancellable` that can be used by operations that will be cancelled when the `IdeObject::destroy` signal is emitted on `self`.

Available since: 3.32

###### Ide.Object:parent

The parent `IdeObject`, if any.

Available since: 3.32

#### Signals

###### Ide.Runner::exited

No description available.

###### Ide.Runner::spawned

No description available.

##### Signals inherited from IdeObject (1)

###### Ide.Object::destroy

The “destroy” signal is emitted when the object should destroy itself and cleanup any state that is no longer necessary. This happens when the object has been removed from the because it was requested to be destroyed, or because a parent object is being destroyed.

Available since: 3.32

##### Signals inherited from GObject (1)

###### GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct IdeRunnerClass {
      IdeObjectClass parent;
      void (* force_quit) (
        IdeRunner* self
      );
      GOutputStream* (* get_stdin) (
        IdeRunner* self
      );
      GInputStream* (* get_stdout) (
        IdeRunner* self
      );
      GInputStream* (* get_stderr) (
        IdeRunner* self
      );
      void (* run_async) (
        IdeRunner* self,
        GCancellable* cancellable,
        GAsyncReadyCallback callback,
        gpointer user_data
      );
      gboolean (* run_finish) (
        IdeRunner* self,
        GAsyncResult* result,
        GError** error
      );
      IdeSubprocessLauncher* (* create_launcher) (
        IdeRunner* self
      );
      void (* fixup_launcher) (
        IdeRunner* self,
        IdeSubprocessLauncher* launcher
      );
      IdeRuntime* (* get_runtime) (
        IdeRunner* self
      );

    }

###### Class members

`parent` |
    IdeObjectClass
| No description available.
`force_quit` |
    void (* force_quit) (
        IdeRunner* self
      )
| No description available.
`get_stdin` |
    GOutputStream* (* get_stdin) (
        IdeRunner* self
      )
| No description available.
`get_stdout` |
    GInputStream* (* get_stdout) (
        IdeRunner* self
      )
| No description available.
`get_stderr` |
    GInputStream* (* get_stderr) (
        IdeRunner* self
      )
| No description available.
`run_async` |
    void (* run_async) (
        IdeRunner* self,
        GCancellable* cancellable,
        GAsyncReadyCallback callback,
        gpointer user_data
      )
| No description available.
`run_finish` |
    gboolean (* run_finish) (
        IdeRunner* self,
        GAsyncResult* result,
        GError** error
      )
| No description available.
`create_launcher` |
    IdeSubprocessLauncher* (* create_launcher) (
        IdeRunner* self
      )
| No description available.
`fixup_launcher` |
    void (* fixup_launcher) (
        IdeRunner* self,
        IdeSubprocessLauncher* launcher
      )
| No description available.
`get_runtime` |
    IdeRuntime* (* get_runtime) (
        IdeRunner* self
      )
| No description available.

#### Virtual methods

###### Ide.RunnerClass.create_launcher

No description available.

###### Ide.RunnerClass.fixup_launcher

No description available.

###### Ide.RunnerClass.force_quit

No description available.

###### Ide.RunnerClass.get_runtime

This function will get the `IdeRuntime` that will be used to execute the application. Consumers may want to use this to determine if a particular program is available (such as gdb, perf, strace, etc).

Available since: 3.32

###### Ide.RunnerClass.get_stderr

No description available.

Available since: 3.32

###### Ide.RunnerClass.get_stdin

No description available.

Available since: 3.32

###### Ide.RunnerClass.get_stdout

No description available.

Available since: 3.32

###### Ide.RunnerClass.run_async

No description available.

###### Ide.RunnerClass.run_finish

No description available.