Top | ![]() |
![]() |
![]() |
![]() |
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 |
void ide_config_set_append_path (IdeConfig *self
,const gchar *append_path
);
void ide_config_set_runtime_id (IdeConfig *self
,const gchar *runtime_id
);
const gchar *
ide_config_get_toolchain_id (IdeConfig *self
);
Gets the toolchain id for the configuration.
Since: 3.32
void ide_config_set_toolchain_id (IdeConfig *self
,const gchar *toolchain_id
);
Sets the toolchain id for the configuration.
Since: 3.32
void ide_config_set_display_name (IdeConfig *self
,const gchar *display_name
);
void ide_config_set_locality (IdeConfig *self
,IdeBuildLocality locality
);
gboolean
ide_config_get_ready (IdeConfig *self
);
Determines if the configuration is ready for use.
Since: 3.32
IdeRuntime *
ide_config_get_runtime (IdeConfig *self
);
Gets the runtime for the configuration.
Since: 3.32
IdeToolchain *
ide_config_get_toolchain (IdeConfig *self
);
Gets the toolchain for the configuration.
Since: 3.32
void ide_config_set_toolchain (IdeConfig *self
,IdeToolchain *toolchain
);
Sets the toolchain for the configuration.
Since: 3.32
gchar **
ide_config_get_environ (IdeConfig *self
);
Gets the environment to use when spawning processes.
Since: 3.32
void ide_config_setenv (IdeConfig *self
,const gchar *key
,const gchar *value
);
void ide_config_set_config_opts (IdeConfig *self
,const gchar *config_opts
);
const gchar *
ide_config_get_run_opts (IdeConfig *self
);
Gets the command line options to use when running the target application.
The result should be parsed with g_shell_parse_argv()
to convert the run
options to an array suitable for use in argv.
A string containing the run options
or NULL
if none have been set.
[transfer none][nullable]
Since: 3.32
void ide_config_set_run_opts (IdeConfig *self
,const gchar *run_opts
);
Sets the run options to use when running the target application.
See ide_config_get_run_opts()
for more information.
Since: 3.32
const gchar * const *
ide_config_get_build_commands (IdeConfig *self
);
void ide_config_set_build_commands (IdeConfig *self
,const gchar *const *build_commands
);
GFile *
ide_config_get_build_commands_dir (IdeConfig *self
);
Since: 3.32
void ide_config_set_build_commands_dir (IdeConfig *self
,GFile *build_commands_dir
);
const gchar * const *
ide_config_get_post_install_commands (IdeConfig *self
);
void ide_config_set_post_install_commands (IdeConfig *self
,const gchar *const *post_install_commands
);
IdeEnvironment *
ide_config_get_environment (IdeConfig *self
);
Since: 3.32
void ide_config_set_environment (IdeConfig *self
,IdeEnvironment *environment
);
guint
ide_config_get_sequence (IdeConfig *self
);
This returns a sequence number for the configuration. This is useful for build systems that want to clear the "dirty" bit on the configuration so that they need not bootstrap a second time. This should be done by checking the sequence number before executing the bootstrap, and only cleared if the sequence number matches after performing the bootstrap. This indicates no changes have been made to the configuration in the mean time.
Since: 3.32
const gchar *
ide_config_get_app_id (IdeConfig *self
);
Gets the application ID for the configuration.
Since: 3.32
void ide_config_apply_path (IdeConfig *self
,IdeSubprocessLauncher *launcher
);
gboolean ide_config_supports_runtime (IdeConfig *self
,IdeRuntime *runtime
);
const gchar * ide_config_get_internal_string (IdeConfig *self
,const gchar *key
);
void ide_config_set_internal_string (IdeConfig *self
,const gchar *key
,const gchar *value
);
const gchar * const * ide_config_get_internal_strv (IdeConfig *self
,const gchar *key
);
void ide_config_set_internal_strv (IdeConfig *self
,const gchar *key
,const gchar *const *value
);
gboolean ide_config_get_internal_boolean (IdeConfig *self
,const gchar *key
);
void ide_config_set_internal_boolean (IdeConfig *self
,const gchar *key
,gboolean value
);
gint ide_config_get_internal_int (IdeConfig *self
,const gchar *key
);
void ide_config_set_internal_int (IdeConfig *self
,const gchar *key
,gint value
);
gint64 ide_config_get_internal_int64 (IdeConfig *self
,const gchar *key
);
void ide_config_set_internal_int64 (IdeConfig *self
,const gchar *key
,gint64 value
);
gpointer ide_config_get_internal_object (IdeConfig *self
,const gchar *key
);
Gets the value associated with key
if it is a GObject.
Since: 3.32
void ide_config_set_internal_object (IdeConfig *self
,const gchar *key
,gpointer instance
);
Sets the value for key
to instance
.
self |
an IdeConfig |
|
key |
the key to set |
|
instance |
a GObject or |
[type GObject.Object][nullable] |
Since: 3.32
GPtrArray *
ide_config_get_extensions (IdeConfig *self
);
Gets the known SDK extensions that will be used when building the project. Implementing this in your configuration backend allows plugins to know if additional binaries will be available to the build system.
an array of IdeRuntime for the runtime extensions for the configuration.
[not nullable][transfer full][element-type Ide.Runtime]
Since: 3.34
struct IdeConfigClass { IdeObjectClass parent; IdeRuntime *(*get_runtime) (IdeConfig *self); void (*set_runtime) (IdeConfig *self, IdeRuntime *runtime); gboolean (*supports_runtime) (IdeConfig *self, IdeRuntime *runtime); GPtrArray *(*get_extensions) (IdeConfig *self); };
“app-id”
property “app-id” char *
The application ID (such as org.gnome.Builder).
Owner: IdeConfig
Flags: Read / Write
Default value: NULL
“append-path”
property “append-path” char *
Append to PATH environment variable.
Owner: IdeConfig
Flags: Read / Write
Default value: NULL
“build-commands”
property “build-commands” GStrv
Build commands.
Owner: IdeConfig
Flags: Read / Write
“build-commands-dir”
property “build-commands-dir” GFile *
Directory to run build commands from.
Owner: IdeConfig
Flags: Read / Write
“config-opts”
property “config-opts” char *
Parameters to bootstrap the project.
Owner: IdeConfig
Flags: Read / Write
Default value: NULL
“debug”
property “debug” gboolean
Debug.
Owner: IdeConfig
Flags: Read / Write
Default value: TRUE
“dirty”
property “dirty” gboolean
If the configuration has been changed.
Owner: IdeConfig
Flags: Read / Write
Default value: FALSE
“display-name”
property “display-name” char *
Display Name.
Owner: IdeConfig
Flags: Read / Write
Default value: NULL
“id”
property “id” char *
Id.
Owner: IdeConfig
Flags: Read / Write / Construct Only
Default value: NULL
“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
“parallelism”
property “parallelism” int
Parallelism.
Owner: IdeConfig
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“post-install-commands”
property “post-install-commands” GStrv
Post install commands.
Owner: IdeConfig
Flags: Read / Write
“prefix”
property “prefix” char *
Prefix.
Owner: IdeConfig
Flags: Read / Write
Default value: NULL
“prefix-set”
property “prefix-set” gboolean
If Prefix is Set or not (meaning default).
Owner: IdeConfig
Flags: Read / Write
Default value: FALSE
“ready”
property “ready” gboolean
If the configuration can be used for building.
Owner: IdeConfig
Flags: Read
Default value: FALSE
“run-opts”
property “run-opts” char *
The options for running the target application.
Owner: IdeConfig
Flags: Read / Write
Default value: NULL
“runtime-id”
property “runtime-id” char *
The identifier of the runtime.
Owner: IdeConfig
Flags: Read / Write
Default value: "host"