KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
JOBS_RUNNER Class Reference

#include <jobs_runner.h>

Public Member Functions

 JOBS_RUNNER (KIWAY *aKiway, JOBSET *aJobsFile, PROJECT *aProject, REPORTER &aReporter, JOBS_PROGRESS_REPORTER *aProgressReporter)
 
bool RunJobsAllDestinations (bool aBail=false)
 
bool RunJobsForDestination (JOBSET_DESTINATION *aDestination, bool aBail=false)
 

Private Member Functions

int runSpecialExecute (const JOBSET_JOB *aJob, REPORTER *aReporter, PROJECT *aProject)
 
int runSpecialCopyFiles (const JOBSET_JOB *aJob, PROJECT *aProject)
 

Private Attributes

KIWAY * m_kiway
 
JOBSET * m_jobsFile
 
REPORTER & m_reporter
 
JOBS_PROGRESS_REPORTER * m_progressReporter
 
PROJECT * m_project
 

Detailed Description

Definition at line 60 of file jobs_runner.h.

Constructor & Destructor Documentation

◆ JOBS_RUNNER()

JOBS_RUNNER::JOBS_RUNNER ( KIWAY * aKiway,
JOBSET * aJobsFile,
PROJECT * aProject,
REPORTER & aReporter,
JOBS_PROGRESS_REPORTER * aProgressReporter )

Definition at line 38 of file jobs_runner.cpp.

References m_jobsFile, m_kiway, m_progressReporter, m_project, and m_reporter.

Member Function Documentation

◆ RunJobsAllDestinations()

bool JOBS_RUNNER::RunJobsAllDestinations ( bool aBail = false)

Definition at line 49 of file jobs_runner.cpp.

References m_jobsFile, and RunJobsForDestination().

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform(), and PANEL_JOBSET::OnGenerateAllDestinationsClick().

◆ RunJobsForDestination()

bool JOBS_RUNNER::RunJobsForDestination ( JOBSET_DESTINATION * aDestination,
bool aBail = false )

Definition at line 152 of file jobs_runner.cpp.

References _, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, NULL_REPORTER::GetInstance(), JOB_REGISTRY::GetKifaceType(), JOBS_OUTPUT_HANDLER::HandleOutputs(), KIWAY::KIWAY_FACE_COUNT, JOBSET_DESTINATION::m_id, m_jobsFile, m_kiway, JOBSET_DESTINATION::m_lastResolvedOutputPath, JOBSET_DESTINATION::m_lastRunReporters, JOBSET_DESTINATION::m_lastRunSuccess, JOBSET_DESTINATION::m_lastRunSuccessMap, JOBSET_DESTINATION::m_outputHandler, m_progressReporter, m_project, m_reporter, OUTPUT_TMP_PATH_VAR_NAME, JOBS_OUTPUT_HANDLER::OutputPrecheck(), result, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, runSpecialCopyFiles(), runSpecialExecute(), and CLI::EXIT_CODES::SUCCESS.

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform(), PANEL_DESTINATION::OnGenerate(), and RunJobsAllDestinations().

◆ runSpecialCopyFiles()

int JOBS_RUNNER::runSpecialCopyFiles ( const JOBSET_JOB * aJob,
PROJECT * aProject )
private

Definition at line 114 of file jobs_runner.cpp.

References CopyFilesOrDirectory(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_UNKNOWN, ExpandEnvVarSubstitutions(), JOB::GetFullOutputPath(), PROJECT::GetProjectPath(), JOB_SPECIAL_COPYFILES::m_dest, JOB_SPECIAL_COPYFILES::m_generateErrorOnNoCopy, JOBSET_JOB::m_job, m_jobsFile, JOB_SPECIAL_COPYFILES::m_source, and CLI::EXIT_CODES::OK.

Referenced by RunJobsForDestination().

◆ runSpecialExecute()

int JOBS_RUNNER::runSpecialExecute ( const JOBSET_JOB * aJob,
REPORTER * aReporter,
PROJECT * aProject )
private

Definition at line 60 of file jobs_runner.cpp.

References CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, ExpandEnvVarSubstitutions(), JOB::GetConfiguredOutputPath(), JOB::GetFullOutputPath(), JOB_SPECIAL_EXECUTE::m_command, JOBSET_JOB::m_id, JOB_SPECIAL_EXECUTE::m_ignoreExitcode, JOBSET_JOB::m_job, m_project, JOB_SPECIAL_EXECUTE::m_recordOutput, CLI::EXIT_CODES::OK, process, REPORTER::Report(), result, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, and JOB::SetConfiguredOutputPath().

Referenced by RunJobsForDestination().

Member Data Documentation

◆ m_jobsFile

JOBSET* JOBS_RUNNER::m_jobsFile
private

Definition at line 75 of file jobs_runner.h.

Referenced by JOBS_RUNNER(), RunJobsAllDestinations(), RunJobsForDestination(), and runSpecialCopyFiles().

◆ m_kiway

KIWAY* JOBS_RUNNER::m_kiway
private

Definition at line 74 of file jobs_runner.h.

Referenced by JOBS_RUNNER(), and RunJobsForDestination().

◆ m_progressReporter

JOBS_PROGRESS_REPORTER* JOBS_RUNNER::m_progressReporter
private

Definition at line 77 of file jobs_runner.h.

Referenced by JOBS_RUNNER(), and RunJobsForDestination().

◆ m_project

PROJECT* JOBS_RUNNER::m_project
private

Definition at line 78 of file jobs_runner.h.

Referenced by JOBS_RUNNER(), RunJobsForDestination(), and runSpecialExecute().

◆ m_reporter

REPORTER& JOBS_RUNNER::m_reporter
private

Definition at line 76 of file jobs_runner.h.

Referenced by JOBS_RUNNER(), and RunJobsForDestination().

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