File indexing completed on 2024-04-28 04:37:03

 /*
     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