KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcbnew_jobs_handler.h
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
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#ifndef PCBNEW_JOBS_HANDLER_H
22#define PCBNEW_JOBS_HANDLER_H
23
24#include <jobs/job_dispatcher.h>
25#include <pcb_plot_params.h>
27
28class KIWAY;
29class BOARD;
31class FOOTPRINT;
35class TOOL_MANAGER;
36class REPORTER;
37class wxWindow;
38
40{
41public:
42 PCBNEW_JOBS_HANDLER( KIWAY* aKiway );
43 virtual ~PCBNEW_JOBS_HANDLER();
44
45 int JobExportStep( JOB* aJob );
46 int JobExportRender( JOB* aJob );
47 int JobExportSvg( JOB* aJob );
48 int JobExportDxf( JOB* aJob );
49 int JobExportPdf( JOB* aJob );
50 int JobExportPng( JOB* aJob );
51 int JobExportPs( JOB* aJob );
52 int JobExportGerber( JOB* aJob );
53 int JobExportGerbers( JOB* aJob );
54 int JobExportGencad( JOB* aJob );
55 int JobExportDrill( JOB* aJob );
56 int JobExportPos( JOB* aJob );
57 int JobExportFpUpgrade( JOB* aJob );
58 int JobExportFpSvg( JOB* aJob );
59 int JobExportDrc( JOB* aJob );
60 int JobExportIpc2581( JOB* aJob );
61 int JobExportOdb( JOB* aJob );
62 int JobExportIpcD356( JOB* aJob );
63 int JobExportStats( JOB* aJob );
64 int JobUpgrade( JOB* aJob );
65 int JobImport( JOB* aJob );
66 int JobDiff( JOB* aJob );
67 int JobFpDiff( JOB* aJob );
68
71 int RunMerge( KICAD_DIFF::DOC_KIND aKind, const wxString& aAncestor, const wxString& aOurs,
72 const wxString& aTheirs, const wxString& aOutput, bool aInteractive,
73 bool aSingleFile, REPORTER* aReporter );
74 int OpenDiffDialog( KICAD_DIFF::DOC_KIND aKind, const wxString& aFileA, const wxString& aFileB,
75 const wxString& aLabelA, const wxString& aLabelB, wxWindow* aParent,
76 REPORTER* aReporter );
77
78private:
79 int runPcbMerge( const wxString& aAncestor, const wxString& aOurs, const wxString& aTheirs,
80 const wxString& aOutput, bool aInteractive );
81 int runFpLibMerge( const wxString& aAncestor, const wxString& aOurs, const wxString& aTheirs,
82 const wxString& aOutput, bool aSingleFile );
83
84public:
85
90 void ClearCachedBoard();
91
92private:
93 BOARD* getBoard( const wxString& aPath = wxEmptyString );
94 LSEQ convertLayerArg( wxString& aLayerString, BOARD* aBoard ) const;
95
100 int doFpExportSvg( JOB_FP_EXPORT_SVG* aSvgJob, const FOOTPRINT* aFootprint );
101 void loadOverrideDrawingSheet( BOARD* brd, const wxString& aSheetPath );
102 wxString resolveJobOutputPath( JOB* aJob, BOARD* aBoard, const wxString* aDrawingSheet = nullptr );
103
105
107
109 std::unique_ptr<TOOL_MANAGER> m_toolManager;
110};
111
112#endif
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:372
JOB_DISPATCHER(KIWAY *aKiway)
An simple container class that lets us dispatch output jobs to kifaces.
Definition job.h:184
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:311
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition lseq.h:47
int RunMerge(KICAD_DIFF::DOC_KIND aKind, const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aInteractive, bool aSingleFile, REPORTER *aReporter)
Non-job entry points (reached via the kiface KIFACE_MERGE_DOCUMENT / KIFACE_OPEN_DIFF_DIALOG function...
void populateGerberPlotOptionsFromJob(PCB_PLOT_PARAMS &aPlotOpts, JOB_EXPORT_PCB_GERBER *aJob)
DS_PROXY_VIEW_ITEM * getDrawingSheetProxyView(BOARD *aBrd)
wxString resolveJobOutputPath(JOB *aJob, BOARD *aBoard, const wxString *aDrawingSheet=nullptr)
int runPcbMerge(const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aInteractive)
void loadOverrideDrawingSheet(BOARD *brd, const wxString &aSheetPath)
PCBNEW_JOBS_HANDLER(KIWAY *aKiway)
TOOL_MANAGER * getToolManager(BOARD *aBrd)
void populateGerberPlotOptionsFromJob(PCB_PLOT_PARAMS &aPlotOpts, JOB_EXPORT_PCB_GERBERS *aJob)
BOARD * getBoard(const wxString &aPath=wxEmptyString)
int runFpLibMerge(const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aSingleFile)
std::unique_ptr< TOOL_MANAGER > m_toolManager
int OpenDiffDialog(KICAD_DIFF::DOC_KIND aKind, const wxString &aFileA, const wxString &aFileB, const wxString &aLabelA, const wxString &aLabelB, wxWindow *aParent, REPORTER *aReporter)
LSEQ convertLayerArg(wxString &aLayerString, BOARD *aBoard) const
void ClearCachedBoard()
Clear the cached CLI board so the next job reloads from the current project.
int doFpExportSvg(JOB_FP_EXPORT_SVG *aSvgJob, const FOOTPRINT *aFootprint)
Parameters and options when plotting/printing a board.
A pure virtual class used to derive REPORTER objects from.
Definition reporter.h:71
Master controller class:
DOC_KIND
Document type a diff/merge entry point should route to, derived from a file path's extension.