Class
IdePipelineStage
Instance methods
ide_pipeline_stage_get_active
Gets the “active” property, which is set to TRUE when the
build stage is actively executing or cleaning.
ide_pipeline_stage_log_subprocess
This function will begin logging subprocess by reading from the
stdout and stderr streams of the subprocess. You must have created
the subprocess with G_SUBPROCESS_FLAGS_STDERR_PIPE and
G_SUBPROCESS_FLAGS_STDOUT_PIPE so that the streams may be read.
ide_pipeline_stage_set_log_observer
Sets the log observer to handle calls to the various stage logging functions. This will be set by the pipeline to mux logs from all stages into a unified build log.
Properties
Ide.PipelineStage:active
This property is set to TRUE when the build stage is actively
running or cleaning.
Ide.PipelineStage:check-stdout
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.
Ide.PipelineStage:completed
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.
Ide.PipelineStage:disabled
If the build stage is disabled. This allows you to have a stage that is attached but will not be activated during execution.
Ide.PipelineStage:name
The name of the build stage. This is only used by UI to view the build pipeline.
Ide.PipelineStage:stdout-path
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.
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.
Ide.Object:parent
The parent IdeObject, if any.
Signals
Ide.PipelineStage::query
The IdePipelineStage::query signal is emitted to request that the
build stage update its completed stage from any external resources.
Ide.PipelineStage::reap
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.
Signals inherited from IdeObject (1)
IdeObject::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.
Signals inherited from GObject (1)
GObject::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 IdePipelineStageClass {
IdeObjectClass parent_class;
gboolean (* build) (
IdePipelineStage* self,
IdePipeline* pipeline,
GCancellable* cancellable,
GError** error
);
void (* build_async) (
IdePipelineStage* self,
IdePipeline* pipeline,
GCancellable* cancellable,
GAsyncReadyCallback callback,
gpointer user_data
);
gboolean (* build_finish) (
IdePipelineStage* self,
GAsyncResult* result,
GError** error
);
void (* clean_async) (
IdePipelineStage* self,
IdePipeline* pipeline,
GCancellable* cancellable,
GAsyncReadyCallback callback,
gpointer user_data
);
gboolean (* clean_finish) (
IdePipelineStage* self,
GAsyncResult* result,
GError** error
);
void (* query) (
IdePipelineStage* self,
IdePipeline* pipeline,
GPtrArray* targets,
GCancellable* cancellable
);
void (* reap) (
IdePipelineStage* self,
IdeDirectoryReaper* reaper
);
gboolean (* chain) (
IdePipelineStage* self,
IdePipelineStage* next
);
}Class members
parent_class: IdeObjectClass- No description available.
build: gboolean (* build) ( IdePipelineStage* self, IdePipeline* pipeline, GCancellable* cancellable, GError** error )- No description available.
build_async: void (* build_async) ( IdePipelineStage* self, IdePipeline* pipeline, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data )- No description available.
build_finish: gboolean (* build_finish) ( IdePipelineStage* self, GAsyncResult* result, GError** error )- No description available.
clean_async: void (* clean_async) ( IdePipelineStage* self, IdePipeline* pipeline, GCancellable* cancellable, GAsyncReadyCallback callback, gpointer user_data )- No description available.
clean_finish: gboolean (* clean_finish) ( IdePipelineStage* self, GAsyncResult* result, GError** error )- No description available.
query: void (* query) ( IdePipelineStage* self, IdePipeline* pipeline, GPtrArray* targets, GCancellable* cancellable )- No description available.
reap: void (* reap) ( IdePipelineStage* self, IdeDirectoryReaper* reaper )- No description available.
chain: gboolean (* chain) ( IdePipelineStage* self, IdePipelineStage* next )- No description available.