KiCad PCB EDA Suite
Loading...
Searching...
No Matches
job_dispatcher.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2022 Mark Roszko <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <cli/exit_codes.h>
22#include <jobs/job_dispatcher.h>
23#include <reporter.h>
24#include <wx/debug.h>
25
26class wxWindow;
27
29 m_kiway( aKiway )
30{
32 m_progressReporter = nullptr;
33}
34
35
36void JOB_DISPATCHER::Register( const std::string& aJobTypeName,
37 std::function<int( JOB* job )> aHandler,
38 std::function<bool( JOB* aJob, wxWindow* aParent )> aConfigHandler )
39{
40 m_jobHandlers.emplace( aJobTypeName, aHandler );
41 m_jobConfigHandlers.emplace( aJobTypeName, aConfigHandler );
42}
43
44
45int JOB_DISPATCHER::RunJob( JOB* job, REPORTER* aReporter, PROGRESS_REPORTER* aProgressReporter )
46{
48 REPORTER* existingReporter = m_reporter;
49
50 if( aReporter )
51 m_reporter = aReporter;
52
53 m_progressReporter = aProgressReporter;
54
56
57 if( m_jobHandlers.count( job->GetType() ) )
58 result = m_jobHandlers[job->GetType()]( job );
59
60 m_reporter = existingReporter;
61
62 return result;
63}
64
65
66bool JOB_DISPATCHER::HandleJobConfig( JOB* job, wxWindow* aParent )
67{
68 if( m_jobConfigHandlers.count( job->GetType() ) )
69 {
70 return m_jobConfigHandlers[job->GetType()]( job, aParent );
71 }
72
73 return false;
74}
75
76
78{
79 wxCHECK( aReporter != nullptr, /*void*/ );
80 m_reporter = aReporter;
81}
82
83
85{
86 wxCHECK( aReporter != nullptr, /*void*/ );
87 m_progressReporter = aReporter;
88}
void SetReporter(REPORTER *aReporter)
void Register(const std::string &aJobTypeName, std::function< int(JOB *job)> aHandler, std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler)
JOB_DISPATCHER(KIWAY *aKiway)
int RunJob(JOB *aJob, REPORTER *aReporter, PROGRESS_REPORTER *aProgressReporter)
bool HandleJobConfig(JOB *aJob, wxWindow *aParent)
PROGRESS_REPORTER * m_progressReporter
std::map< std::string, std::function< bool(JOB *job, wxWindow *aParent)> > m_jobConfigHandlers
REPORTER * m_reporter
std::map< std::string, std::function< int(JOB *job)> > m_jobHandlers
void SetProgressReporter(PROGRESS_REPORTER *aReporter)
An simple container class that lets us dispatch output jobs to kifaces.
Definition: job.h:183
const std::string & GetType() const
Definition: job.h:189
void ClearExistingOutputs()
Definition: job.h:208
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:286
static REPORTER & GetInstance()
Definition: reporter.cpp:108
A progress reporter interface for use in multi-threaded environments.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
static const int ERR_UNKNOWN
Definition: exit_codes.h:32