KDevelop::IProjectBuilder Class Reference

#include <iprojectbuilder.h>

Signals
void	built (ProjectBaseItem *dom)
void	cleaned (ProjectBaseItem *)
void	configured (IProject *)
void	failed (ProjectBaseItem *dom)
void	installed (ProjectBaseItem *)
void	pruned (IProject *)

Public Member Functions
virtual	~IProjectBuilder ()
virtual QList< IProjectBuilder * >	additionalBuilderPlugins (IProject *project) const
virtual KJob *	build (ProjectBaseItem *item)=0
virtual KJob *	clean (ProjectBaseItem *item)=0
virtual KJob *	configure (IProject *project)
virtual KJob *	install (ProjectBaseItem *item, const QUrl &specificPrefix={})=0
virtual KJob *	prune (IProject *project)

Detailed Description

IProjectBuilder Base class for the Project Builders.

Author

Roberto Raggi

Provides an interface that will bre useful to perform tasks upon projects, inspired on the unix-style way to build projects:

configure -> make -> make install

It will provide a job for each of the tasks and a signal to make sure it completed successfully.

Definition at line 48 of file iprojectbuilder.h.

Constructor & Destructor Documentation

~IProjectBuilder()

KDevelop::IProjectBuilder::~IProjectBuilder ( )

virtual

Definition at line 24 of file iprojectbuilder.cpp.

Member Function Documentation

additionalBuilderPlugins()

QList< IProjectBuilder * > KDevelop::IProjectBuilder::additionalBuilderPlugins ( IProject *  project ) const

virtual

Provide access to the builders related to the project.

The list returned by this method is used to select the appropriate config pages for a project. This method may safely return an empty list, as does the default implementation.

Definition at line 39 of file iprojectbuilder.cpp.

build()

virtual KJob* KDevelop::IProjectBuilder::build ( ProjectBaseItem *  item )

pure virtual

Builds the given project item, exact behaviour depends on the implementation.

built

void KDevelop::IProjectBuilder::built ( ProjectBaseItem *  dom )

signal

Emitted when the build for the given item was finished.

clean()

virtual KJob* KDevelop::IProjectBuilder::clean ( ProjectBaseItem *  item )

pure virtual

Cleans the given project item, exact behaviour depends on the implementation.

The cleaning should only include output files, like C/C++ object files, binaries, files that the builder needs shouldn't be removed.

cleaned

void KDevelop::IProjectBuilder::cleaned ( ProjectBaseItem *  )

signal

Emitted when the clean for the given item was finished.

configure()

KJob * KDevelop::IProjectBuilder::configure ( IProject *  project )

virtual

Configures the given project, exact behaviour depends on the implementation.

After calling this a build() call should succeed (given the code doesn't have errors).

This function is optional, the default implementation does nothing.

Definition at line 29 of file iprojectbuilder.cpp.

configured

void KDevelop::IProjectBuilder::configured ( IProject *  )

signal

Emitted when the configure for the given item was finished.

failed

void KDevelop::IProjectBuilder::failed ( ProjectBaseItem *  dom )

signal

Emitted when any of the scheduled actions for the given item was failed.

install()

virtual KJob* KDevelop::IProjectBuilder::install ( ProjectBaseItem *  item, const QUrl &  specificPrefix = {}  )

pure virtual

Installs the given project item, exact behaviour depends on the implementation.

Parameters

specificPrefix

defines where the project will be installed.

installed

void KDevelop::IProjectBuilder::installed ( ProjectBaseItem *  )

signal

Emitted when the install for the given item was finished.

prune()

KJob * KDevelop::IProjectBuilder::prune ( IProject *  project )

virtual

Prunes the given project, exact behaviour depends on the implementation.

Additionally to what clean() does this may also remove files used for the builder (or a "subbuilder"), for example generated Makefiles in QMake/CMake/Automake projects

This function is optional, the default implementation does nothing.

Definition at line 34 of file iprojectbuilder.cpp.

pruned

void KDevelop::IProjectBuilder::pruned ( IProject *  )

signal

Emitted when the pruning for the given item was finished.

---

The documentation for this class was generated from the following files:

• iprojectbuilder.h
• iprojectbuilder.cpp