1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/*
SPDX-FileCopyrightText: 2007 Andreas Pakulat <apaku@gmx.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_BUILDERJOB_H
#define KDEVPLATFORM_BUILDERJOB_H
#include "projectexport.h"
#include <util/executecompositejob.h>
namespace KDevelop
{
class ProjectBaseItem;
class IProject;
class BuilderJobPrivate;
/**
* Allows to build a list of project items or projects sequentially, where
* failing to build one item in the list will fail the whole job.
*/
class KDEVPLATFORMPROJECT_EXPORT BuilderJob : public ExecuteCompositeJob
{
Q_OBJECT
public:
/**
* Defines what action to do on the Project builder
*/
enum BuildType
{
Build /**< Build the selected items */,
Prune /**< Prune the selected items */,
Configure /**< Configure the selected items */,
Install /**< Install the selected items */,
Clean /**< Clean the selected items */
};
/**
* Creates a Builder job
*/
BuilderJob();
~BuilderJob() override;
/**
* Allows to easily schedule building a couple of @p items using the
* method identified by @p type
*
* @param type the build method to use
* @param items the project items to add
*/
void addItems( BuildType type, const QList<KDevelop::ProjectBaseItem*>& items );
/**
* Allows to easily schedule building a couple of @p projects using the
* method identified by @p type
*
* @param type the build method to use
* @param projects the projects to add
*/
void addProjects( BuildType type, const QList<KDevelop::IProject*>& projects );
/**
* Allows to add a single @p item to the end of the list. The item will be
* built using the method identified by @p type
*
* @param item The item to add to the list
* @param type The build method to be used for the item
*/
void addItem( BuildType type, ProjectBaseItem* item );
/**
* Allows to add a custom @p job to the end of the list. The build method specified by @p type
* and (optionally) an item specified by @p item are needed to create a human-readable job name.
*
* @param type The build method which is represented by the @p job
* @param job The job to add to the list
* @param item The item which is build by the @p job
*/
void addCustomJob( BuildType type, KJob* job, ProjectBaseItem* item = nullptr );
/**
* Updates the job's name.
*
* Shall be called before registering this job in the run controller, but after
* adding all required tasks to the job.
*/
void updateJobName();
/**
* Starts this job
*/
void start() override;
private:
const QScopedPointer<class BuilderJobPrivate> d_ptr;
Q_DECLARE_PRIVATE(BuilderJob)
friend class BuilderJobPrivate;
};
}
#endif
|
