JOBS_RUNNER Class Reference

#include <jobs_runner.h>

Public Member Functions
	JOBS_RUNNER (KIWAY *aKiway, JOBSET *aJobsFile, PROJECT *aProject, REPORTER *aReporter=nullptr)
bool	RunJobsAllOutputs (bool aBail=false)
bool	RunJobsForOutput (JOBSET_OUTPUT *aOutput, bool aBail=false)

Private Member Functions
int	runSpecialExecute (const JOBSET_JOB *aJob, PROJECT *aProject)
int	runSpecialCopyFiles (const JOBSET_JOB *aJob, PROJECT *aProject)

Private Attributes
KIWAY *	m_kiway
JOBSET *	m_jobsFile
REPORTER *	m_reporter
PROJECT *	m_project

Detailed Description

Definition at line 30 of file jobs_runner.h.

Constructor & Destructor Documentation

JOBS_RUNNER()

JOBS_RUNNER::JOBS_RUNNER	(	KIWAY *	aKiway,
		JOBSET *	aJobsFile,
		PROJECT *	aProject,
		REPORTER *	aReporter = nullptr
	)

Definition at line 37 of file jobs_runner.cpp.

References NULL_REPORTER::GetInstance(), and m_reporter.

Member Function Documentation

RunJobsAllOutputs()

bool JOBS_RUNNER::RunJobsAllOutputs

(

bool

aBail = false

)

Definition at line 51 of file jobs_runner.cpp.

References JOBSET::GetOutputs(), m_jobsFile, and RunJobsForOutput().

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

RunJobsForOutput()

bool JOBS_RUNNER::RunJobsForOutput	(	JOBSET_OUTPUT *	aOutput,
		bool	aBail = false
	)

Definition at line 168 of file jobs_runner.cpp.

References _, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, NULL_REPORTER::GetInstance(), JOBSET::GetJobsForOutput(), JOB_REGISTRY::GetKifaceType(), JOBS_OUTPUT_HANDLER::HandleOutputs(), KIWAY::KIWAY_FACE_COUNT, JOBSET_OUTPUT::m_id, m_jobsFile, m_kiway, JOBSET_OUTPUT::m_lastRunReporters, JOBSET_OUTPUT::m_lastRunSuccess, JOBSET_OUTPUT::m_lastRunSuccessMap, JOBSET_OUTPUT::m_outputHandler, m_project, m_reporter, name, JOBS_OUTPUT_HANDLER::OutputPrecheck(), KIWAY::ProcessJob(), REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, runSpecialCopyFiles(), runSpecialExecute(), and CLI::EXIT_CODES::SUCCESS.

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform(), PANEL_JOBSET_OUTPUT::OnGenerate(), and RunJobsAllOutputs().

runSpecialCopyFiles()

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

private

Definition at line 107 of file jobs_runner.cpp.

References CopyFilesOrDirectory(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_UNKNOWN, ExpandEnvVarSubstitutions(), JOB::GetFullOutputPath(), JOBSET::GetOutputs(), 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 RunJobsForOutput().

runSpecialExecute()

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

private

Definition at line 64 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, and JOB::SetConfiguredOutputPath().

Referenced by RunJobsForOutput().

Member Data Documentation

m_jobsFile

JOBSET* JOBS_RUNNER::m_jobsFile

private

Definition at line 45 of file jobs_runner.h.

Referenced by RunJobsAllOutputs(), RunJobsForOutput(), and runSpecialCopyFiles().

m_kiway

KIWAY* JOBS_RUNNER::m_kiway

private

Definition at line 44 of file jobs_runner.h.

Referenced by RunJobsForOutput().

m_project

PROJECT* JOBS_RUNNER::m_project

private

Definition at line 47 of file jobs_runner.h.

Referenced by RunJobsForOutput(), and runSpecialExecute().

m_reporter

REPORTER* JOBS_RUNNER::m_reporter

private

Definition at line 46 of file jobs_runner.h.

Referenced by JOBS_RUNNER(), and RunJobsForOutput().

---

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

• jobs_runner.h
• jobs_runner.cpp