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

Handle Eeschema job dispatches. More...

#include <eeschema_jobs_handler.h>

Inheritance diagram for EESCHEMA_JOBS_HANDLER:
JOB_DISPATCHER

Public Member Functions

 EESCHEMA_JOBS_HANDLER (KIWAY *aKiway)
 
int JobExportBom (JOB *aJob)
 
int JobExportPythonBom (JOB *aJob)
 
int JobExportNetlist (JOB *aJob)
 
int JobExportPlot (JOB *aJob)
 
int JobSchErc (JOB *aJob)
 
int JobSymUpgrade (JOB *aJob)
 
int JobSymExportSvg (JOB *aJob)
 
int JobUpgrade (JOB *aJob)
 
int JobDowngrade (JOB *aJob)
 
int JobImport (JOB *aJob)
 
int JobSchDiff (JOB *aJob)
 
int JobSymDiff (JOB *aJob)
 
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 exports, not the JOB system).
 
int OpenDiffDialog (KICAD_DIFF::DOC_KIND aKind, const wxString &aFileA, const wxString &aFileB, const wxString &aLabelA, const wxString &aLabelB, wxWindow *aParent, REPORTER *aReporter)
 
KICAD_DIFF::DIFF_CANVAS_CONTEXT * AttachDiffCanvases (KICAD_DIFF::DOC_KIND aKind, const wxString &aFileA, const wxString &aFileB, WIDGET_DIFF_CANVAS *aBefore, WIDGET_DIFF_CANVAS *aAfter, KICAD_DIFF::DOCUMENT_DIFF &aDiff, REPORTER *aReporter)
 Diff two schematics for a window outside the kiface, drawing the first on aBefore and the second on aAfter.
 
void ClearCachedSchematic ()
 Clear the cached CLI schematic so the next job reloads from the current project.
 
void InitRenderSettings (SCH_RENDER_SETTINGS *aRenderSettings, const wxString &aTheme, SCHEMATIC *aSch, const wxString &aDrawingSheetOverride=wxEmptyString)
 Configure the SCH_RENDER_SETTINGS object with the correct data to be used with plotting.
 
void Register (const std::string &aJobTypeName, std::function< int(JOB *job)> aHandler, std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler)
 
int RunJob (JOB *aJob, REPORTER *aReporter, PROGRESS_REPORTER *aProgressReporter)
 
bool HandleJobConfig (JOB *aJob, wxWindow *aParent)
 
void SetReporter (REPORTER *aReporter)
 
void SetProgressReporter (PROGRESS_REPORTER *aReporter)
 

Protected Attributes

KIWAY * m_kiway
 
REPORTER * m_reporter
 
PROGRESS_REPORTER * m_progressReporter
 

Private Member Functions

int runSchMerge (const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput, bool aInteractive)
 
int runSymLibMerge (const wxString &aAncestor, const wxString &aOurs, const wxString &aTheirs, const wxString &aOutput)
 
SCHEMATIC * getSchematic (const wxString &aPath, bool aRequireRoot=true)
 
int doSymExportSvg (JOB_SYM_EXPORT_SVG *aSvgJob, SCH_RENDER_SETTINGS *aRenderSettings, LIB_SYMBOL *symbol)
 
DS_PROXY_VIEW_ITEM * getDrawingSheetProxyView (SCHEMATIC *aSch)
 

Private Attributes

SCHEMATIC * m_cliSchematic
 
bool m_cliSchematicRootValidated = false
 
std::map< std::string, std::function< int(JOB *job)> > m_jobHandlers
 
std::map< std::string, std::function< bool(JOB *job, wxWindow *aParent)> > m_jobConfigHandlers
 

Detailed Description

Handle Eeschema job dispatches.

Definition at line 48 of file eeschema_jobs_handler.h.

Constructor & Destructor Documentation

◆ EESCHEMA_JOBS_HANDLER()

EESCHEMA_JOBS_HANDLER::EESCHEMA_JOBS_HANDLER ( KIWAY * aKiway)

Definition at line 114 of file eeschema_jobs_handler.cpp.

References _, DisplayErrorMessage(), FRAME_SCH, HPGL, JOB_DISPATCHER::JOB_DISPATCHER(), JobDowngrade(), JobExportBom(), JobExportNetlist(), JobExportPlot(), JobExportPythonBom(), JobImport(), JobSchDiff(), JobSchErc(), JobSymDiff(), JobSymExportSvg(), JobSymUpgrade(), JobUpgrade(), m_cliSchematic, KIWAY::Player(), plotJob(), JOB_DISPATCHER::Register(), DIALOG_SHIM::ShowModal(), and DIALOG_SYMBOL_FIELDS_TABLE::WasAborted().

Member Function Documentation

◆ AttachDiffCanvases()

KICAD_DIFF::DIFF_CANVAS_CONTEXT * EESCHEMA_JOBS_HANDLER::AttachDiffCanvases ( KICAD_DIFF::DOC_KIND aKind,
const wxString & aFileA,
const wxString & aFileB,
WIDGET_DIFF_CANVAS * aBefore,
WIDGET_DIFF_CANVAS * aAfter,
KICAD_DIFF::DOCUMENT_DIFF & aDiff,
REPORTER * aReporter )

Diff two schematics for a window outside the kiface, drawing the first on aBefore and the second on aAfter.

The result keeps both loaded while the canvases show them.

Definition at line 3004 of file eeschema_jobs_handler.cpp.

References KICAD_DIFF::ConfigureSchDiffCanvasContext(), loadSchDiffSides(), JOB_DISPATCHER::m_reporter, Pgm(), KICAD_DIFF::DIFF_COLOR_THEME::reference, SCHEMATIC::RootScreen(), KICAD_DIFF::SCH, and CLI::EXIT_CODES::SUCCESS.

◆ ClearCachedSchematic()

void EESCHEMA_JOBS_HANDLER::ClearCachedSchematic ( )

Clear the cached CLI schematic so the next job reloads from the current project.

Called when the API server switches documents.

Definition at line 218 of file eeschema_jobs_handler.cpp.

References m_cliSchematic, and m_cliSchematicRootValidated.

Referenced by getSchematic().

◆ doSymExportSvg()

int EESCHEMA_JOBS_HANDLER::doSymExportSvg ( JOB_SYM_EXPORT_SVG * aSvgJob,
SCH_RENDER_SETTINGS * aRenderSettings,
LIB_SYMBOL * symbol )
private

Definition at line 1073 of file eeschema_jobs_handler.cpp.

References _, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, LIB_SYMBOL::GetBodyStyleCount(), LIB_SYMBOL::GetBodyStyleNames(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetRootSymbol(), GetSymbolPlotBBox(), LIB_SYMBOL::GetUnitCount(), LIB_SYMBOL::HasDeMorganBodyStyles(), LIB_SYMBOL::IsDerived(), JOB_SYM_EXPORT_SVG::m_blackAndWhite, JOB_SYM_EXPORT_SVG::m_includeHiddenFields, JOB_SYM_EXPORT_SVG::m_outputDirectory, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, PlotSymbolToSVG(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, and FILEEXT::SVGFileExtension.

Referenced by JobSymExportSvg().

◆ getDrawingSheetProxyView()

DS_PROXY_VIEW_ITEM * EESCHEMA_JOBS_HANDLER::getDrawingSheetProxyView ( SCHEMATIC * aSch)
private

Definition at line 2664 of file eeschema_jobs_handler.cpp.

References SCHEMATIC::GetCurrentVariant(), SCH_SCREEN::GetFileName(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), SCH_SCREEN::GetPageSettings(), SCHEMATIC::GetProperties(), SCH_SCREEN::GetTitleBlock(), SCHEMATIC::GetVariantDescription(), BASE_SCREEN::GetVirtualPageNumber(), LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_SCHEMATIC_PAGE_LIMITS, SCHEMATIC::Project(), SCHEMATIC::RootScreen(), schIUScale, DS_PROXY_VIEW_ITEM::SetColorLayer(), DS_PROXY_VIEW_ITEM::SetFileName(), DS_PROXY_VIEW_ITEM::SetIsFirstPage(), DS_PROXY_VIEW_ITEM::SetPageBorderColorLayer(), DS_PROXY_VIEW_ITEM::SetPageNumber(), DS_PROXY_VIEW_ITEM::SetSheetCount(), DS_PROXY_VIEW_ITEM::SetSheetName(), DS_PROXY_VIEW_ITEM::SetSheetPath(), DS_PROXY_VIEW_ITEM::SetVariantDesc(), DS_PROXY_VIEW_ITEM::SetVariantName(), and TO_UTF8.

Referenced by JobSchErc().

◆ getSchematic()

SCHEMATIC * EESCHEMA_JOBS_HANDLER::getSchematic ( const wxString & aPath,
bool aRequireRoot = true )
private

Definition at line 229 of file eeschema_jobs_handler.cpp.

References _, ClearCachedSchematic(), FRAME_SCH, PGM_BASE::GetSettingsManager(), FILEEXT::KiCadSchematicFileExtension, EESCHEMA_HELPERS::LoadSchematic(), m_cliSchematic, m_cliSchematicRootValidated, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_reporter, path, Pgm(), SETTINGS_MANAGER::Prj(), project, RPT_SEVERITY_ERROR, and SCH_EDIT_FRAME::Schematic().

Referenced by JobExportBom(), JobExportNetlist(), JobExportPlot(), JobExportPythonBom(), JobSchErc(), and JobUpgrade().

◆ HandleJobConfig()

bool JOB_DISPATCHER::HandleJobConfig ( JOB * aJob,
wxWindow * aParent )
inherited

Definition at line 66 of file job_dispatcher.cpp.

References JOB::GetType(), and m_jobConfigHandlers.

◆ InitRenderSettings()

void EESCHEMA_JOBS_HANDLER::InitRenderSettings ( SCH_RENDER_SETTINGS * aRenderSettings,
const wxString & aTheme,
SCHEMATIC * aSch,
const wxString & aDrawingSheetOverride = wxEmptyString )

Configure the SCH_RENDER_SETTINGS object with the correct data to be used with plotting.

It's sort of a kludge due to the plotter depending on this object normally managed by the frame and canvas.

Parameters
aRenderSettingsThe object to populate with working settings.
aThemeThe theme to take color data from to stick into render settings, can be left blank for default.
aSchThe schematic to further copy settings from to be put into aRenderSettings.
aDrawingSheetOverride

Definition at line 277 of file eeschema_jobs_handler.cpp.

References _, GetColorSettings(), DS_DATA_MODEL::GetTheInstance(), SCH_RENDER_SETTINGS::LoadColors(), SCHEMATIC_SETTINGS::m_DashedLineDashRatio, SCHEMATIC_SETTINGS::m_DashedLineGapRatio, SCHEMATIC_SETTINGS::m_DefaultLineWidth, SCH_RENDER_SETTINGS::m_LabelSizeRatio, SCHEMATIC_SETTINGS::m_LabelSizeRatio, SCH_RENDER_SETTINGS::m_PinSymbolSize, SCHEMATIC_SETTINGS::m_PinSymbolSize, JOB_DISPATCHER::m_reporter, SCHEMATIC_SETTINGS::m_SchDrawingSheetFileName, SCH_RENDER_SETTINGS::m_ShowDNPMarkers, SCHEMATIC_SETTINGS::m_ShowDNPMarkers, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, SCH_RENDER_SETTINGS::m_TextOffsetRatio, SCHEMATIC_SETTINGS::m_TextOffsetRatio, path, SCHEMATIC::Project(), RPT_SEVERITY_ERROR, KIGFX::RENDER_SETTINGS::SetDashLengthRatio(), KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), DS_DATA_MODEL::SetEmptyLayout(), KIGFX::RENDER_SETTINGS::SetGapLengthRatio(), and SCHEMATIC::Settings().

Referenced by JobExportPlot().

◆ JobDowngrade()

int EESCHEMA_JOBS_HANDLER::JobDowngrade ( JOB * aJob)

Definition at line 1591 of file eeschema_jobs_handler.cpp.

References _, COMPATIBILITY_REPORT::Add(), SCHEMATIC::BuildUnorderedSheetList(), ClassifySchematicStructureForDowngrade(), ClassifyScreenForDowngrade(), classifySymbolLibraries(), DOWNGRADE_FILE_TRANSACTION::Commit(), DOWNGRADE_OUTPUT_DIRECTORIES::Commit(), CopyDowngradeLibraryDirectory(), DOWNGRADE_OUTPUT_DIRECTORIES::Create(), SCHEMATIC::DeleteVariant(), DowngradeLibraryCopyPath(), DowngradeNativePath(), DowngradeScreenInPlace(), downgradeSymbolLibraries(), DowngradeTargetNames(), DowngradeWxPath(), DROP, dummy, CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, FindDowngradeTarget(), FlattenSchematicVariant(), SCHEMATIC::GetAllBusAliases(), GetDowngradeTargets(), JSON_SETTINGS::GetJson(), SETTINGS_MANAGER::GetProject(), PROJECT::GetProjectFile(), PROJECT::GetProjectPath(), DOWNGRADE_FILE_TRANSACTION::GetRecoveryError(), SCH_SHEET::GetScreen(), PGM_BASE::GetSettingsManager(), PROJECT_FILE::GetTopLevelSheets(), SCHEMATIC::GetTopLevelSheets(), SCHEMATIC::GetVariantNames(), info, COMPATIBILITY_REPORT::IsBlocked(), COMPATIBILITY_REPORT::IsLossy(), SCH_SHEET::IsVirtualRootSheet(), library, SETTINGS_MANAGER::LoadProject(), SCHEMATIC::LoadVariants(), JOB_SCH_DOWNGRADE::m_dropInsteadOfApproximate, JOB_SCH_DOWNGRADE::m_dryRun, PROJECT_FILE::m_ErcSettings, JOB_SCH_DOWNGRADE::m_filename, JOB_SCH_DOWNGRADE::m_force, JOB_SCH_DOWNGRADE::m_foundVariants, JOB_SCH_DOWNGRADE::m_inPlace, JOB_SCH_DOWNGRADE::m_libraryDir, DOWNGRADE_TARGET::m_name, JOB_SCH_DOWNGRADE::m_outputDir, JOB_SCH_DOWNGRADE::m_report, JOB_DISPATCHER::m_reporter, PROJECT_FILE::m_SchematicSettings, DOWNGRADE_TARGET::m_schVersion, JOB_SCH_DOWNGRADE::m_target, EDA_ITEM::m_Uuid, JOB_SCH_DOWNGRADE::m_variant, COMPATIBILITY_REPORT::Merge(), name, niluuid, path, Pgm(), COMPATIBILITY_REPORT::Print(), FILEEXT::ProjectFileExtension, result, SCHEMATIC::Root(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, SaveSchematicForTarget(), SCH_VER_NET_CHAINS, SCH_VER_VARIANTS, SCH_SHEET::SetName(), SCHEMATIC::SetProject(), SCHEMATIC::SetTopLevelSheets(), source, DOWNGRADE_FILE_TRANSACTION::Stage(), CLI::EXIT_CODES::SUCCESS, THROW_IO_ERROR, ValidateDowngradeLibraryCopy(), ValidateDowngradeLibrarySource(), ValidateFreshDowngradeOutput(), VerifyDowngradedFile(), and IO_ERROR::What().

Referenced by EESCHEMA_JOBS_HANDLER(), and runDowngradeJob().

◆ JobExportBom()

int EESCHEMA_JOBS_HANDLER::JobExportBom ( JOB * aJob)

Definition at line 614 of file eeschema_jobs_handler.cpp.

References _, FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::AddColumn(), JOB::AddOutput(), FIELDS_TABLE_DATA_MODEL_BASE::ApplyBomPreset(), PROJECT::ApplyTextVars(), BOM_FMT_PRESET::BuiltInPresets(), copy, FILEEXT::CsvFileExtension, PATHS::EnsurePathExists(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, FIELDS_TABLE_DATA_MODEL_BASE::Export(), BOM_FMT_PRESET::fieldDelimiter, JOB::GetConfiguredOutputPath(), SCH_REFERENCE_LIST::GetCount(), GetDefaultFieldName(), FIELDS_TABLE_DATA_MODEL_BASE::GetFieldNameCol(), SCH_SYMBOL::GetFields(), FIELDS_TABLE_DATA_MODEL_BASE::GetFieldsOrdered(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), GetGeneratedFieldDisplayName(), PROJECT::GetProjectFile(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetReferenceList(), TEMPLATES::GetResolvedTemplateFieldNames(), getSchematic(), JOB_EXPORT_BOM::GetSelectedVariant(), SCH_SHEET_LIST::GetSymbols(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), BOM_FIELD::groupBy, SCHEMATIC::Hierarchy(), BOM_FMT_PRESET::includeByteOrderMark, IsGeneratedField(), FIELDS_TABLE_DATA_MODEL_BASE::ITEM_NUMBER_VARIABLE, BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, BOM_FIELD::label, JOB_EXPORT_BOM::m_bomFmtPresetName, FIELDS_TABLE_BOM_SETTINGS::m_BomFmtPresets, JOB_EXPORT_BOM::m_bomPresetName, FIELDS_TABLE_BOM_SETTINGS::m_BomPresets, JOB_EXPORT_BOM::m_excludeDNP, JOB_EXPORT_BOM::m_fieldDelimiter, JOB_EXPORT_BOM::m_fieldsGroupBy, JOB_EXPORT_BOM::m_fieldsLabels, JOB_EXPORT_BOM::m_fieldsOrdered, JOB_EXPORT_BOM::m_filename, JOB_EXPORT_BOM::m_filterScope, JOB_EXPORT_BOM::m_filterString, JOB_EXPORT_BOM::m_groupSymbols, JOB_EXPORT_BOM::m_includeByteOrderMark, JOB_EXPORT_BOM::m_keepLineBreaks, JOB_EXPORT_BOM::m_keepTabs, JOB_EXPORT_BOM::m_refDelimiter, JOB_EXPORT_BOM::m_refRangeDelimiter, JOB_DISPATCHER::m_reporter, JOB_EXPORT_BOM::m_sortAsc, JOB_EXPORT_BOM::m_sortField, JOB_EXPORT_BOM::m_stringDelimiter, PROJECT_FILE::m_TemplateFieldNames, JOB_EXPORT_BOM::m_variantNames, MANDATORY_FIELDS, BOM_FIELD::name, CLI::EXIT_CODES::OK, SCHEMATIC::Project(), FIELDS_TABLE_DATA_MODEL_BASE::QUANTITY_VARIABLE, BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, res, SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::SetCurrentVariant(), SCHEMATIC::SetCurrentVariant(), SCHEMATIC::Settings(), JOB::SetTitleBlock(), FIELDS_TABLE_DATA_MODEL_BASE::SetVariantNames(), BOM_FIELD::show, BOM_FMT_PRESET::stringDelimiter, SYMBOL_FILTER_NON_POWER, TRANSLATED, UNTRANSLATED, and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobExportNetlist()

int EESCHEMA_JOBS_HANDLER::JobExportNetlist ( JOB * aJob)

Definition at line 484 of file eeschema_jobs_handler.cpp.

References _, JOB::AddOutput(), JOB_EXPORT_SCH_NETLIST::ALLEGRO, PROJECT::ApplyTextVars(), JOB_EXPORT_SCH_NETLIST::CADSTAR, FILEEXT::CadstarNetlistFileExtension, SCH_REFERENCE_LIST::CheckAnnotation(), PATHS::EnsurePathExists(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, JOB_EXPORT_SCH_NETLIST::format, JOB::GetConfiguredOutputPath(), SCH_REFERENCE_LIST::GetCount(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), getSchematic(), SCH_SHEET_LIST::GetSymbols(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), SCHEMATIC::Hierarchy(), JOB_EXPORT_SCH_NETLIST::KICADSEXPR, JOB_EXPORT_SCH_NETLIST::KICADXML, JOB_EXPORT_SCH_NETLIST::m_filename, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_reporter, JOB_EXPORT_SCH_NETLIST::m_variantNames, FILEEXT::NetlistFileExtension, CLI::EXIT_CODES::OK, NETLIST_EXPORTER_SPICE::OPTION_SIM_COMMAND, JOB_EXPORT_SCH_NETLIST::ORCADPCB2, FILEEXT::OrCadPcb2NetlistFileExtension, JOB_EXPORT_SCH_NETLIST::PADS, SCHEMATIC::Project(), res, SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), SCHEMATIC::SetCurrentVariant(), JOB::SetTitleBlock(), JOB_EXPORT_SCH_NETLIST::SPICE, FILEEXT::SpiceFileExtension, JOB_EXPORT_SCH_NETLIST::SPICEMODEL, and SYMBOL_FILTER_NON_POWER.

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobExportPlot()

int EESCHEMA_JOBS_HANDLER::JobExportPlot ( JOB * aJob)

Definition at line 329 of file eeschema_jobs_handler.cpp.

References _, JOB::AddOutput(), PROJECT::ApplyTextVars(), EESCHEMA_SETTINGS::APPEARANCE::default_font, DXF, PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, GetAppSettings(), JOB::GetConfiguredOutputPath(), GetDefaultPlotExtension(), SCHEMATIC::GetFileName(), SCH_SCREENS::GetFirst(), JOB::GetFullOutputPath(), SCH_SCREENS::GetNext(), JOB::GetOutputPathIsDirectory(), getSchematic(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), SCHEMATIC::Hierarchy(), HPGL, InitRenderSettings(), KICAD_FONT_NAME, JOB_EXPORT_SCH_PLOT_PNG::m_antialias, EESCHEMA_SETTINGS::m_Appearance, JOB_EXPORT_SCH_PLOT::m_blackAndWhite, SCH_PLOT_OPTS::m_blackAndWhite, JOB_EXPORT_SCH_PLOT::m_defaultFont, JOB_EXPORT_SCH_PLOT_PNG::m_dpi, JOB_EXPORT_SCH_PLOT::m_drawingSheet, SCH_PLOT_OPTS::m_DXF_File_Unit, JOB_EXPORT_SCH_PLOT::m_filename, JOB_EXPORT_SCH_PLOT::m_minPenWidth, SCH_PLOT_OPTS::m_outputDirectory, SCH_PLOT_OPTS::m_outputFile, JOB_EXPORT_SCH_PLOT::m_pageSizeSelect, SCH_PLOT_OPTS::m_pageSizeSelect, JOB_EXPORT_SCH_PLOT::m_PDFHierarchicalLinks, SCH_PLOT_OPTS::m_PDFHierarchicalLinks, JOB_EXPORT_SCH_PLOT::m_PDFMetadata, SCH_PLOT_OPTS::m_PDFMetadata, JOB_EXPORT_SCH_PLOT::m_PDFPropertyPopups, SCH_PLOT_OPTS::m_PDFPropertyPopups, JOB_EXPORT_SCH_PLOT::m_plotAll, SCH_PLOT_OPTS::m_plotAll, JOB_EXPORT_SCH_PLOT::m_plotDrawingSheet, SCH_PLOT_OPTS::m_plotDrawingSheet, JOB_EXPORT_SCH_PLOT::m_plotFormat, SCH_PLOT_OPTS::m_plotHopOver, JOB_EXPORT_SCH_PLOT::m_plotPages, SCH_PLOT_OPTS::m_plotPages, SCH_PLOT_OPTS::m_pngAntialias, SCH_PLOT_OPTS::m_pngDPI, JOB_DISPATCHER::m_reporter, JOB_EXPORT_SCH_PLOT::m_sheetPath, SCH_PLOT_OPTS::m_sheetPath, JOB_EXPORT_SCH_PLOT::m_show_hop_over, JOB_EXPORT_SCH_PLOT::m_theme, SCH_PLOT_OPTS::m_theme, JOB_EXPORT_SCH_PLOT::m_useBackgroundColor, SCH_PLOT_OPTS::m_useBackgroundColor, JOB_EXPORT_SCH_PLOT::m_variant, SCH_PLOT_OPTS::m_variant, JOB_EXPORT_SCH_PLOT::m_variantNames, MM, CLI::EXIT_CODES::OK, PAGE_SIZE_A, PAGE_SIZE_A4, PAGE_SIZE_AUTO, PDF, PNG, POST, SCHEMATIC::Project(), SCHEMATIC::Root(), SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, JOB::SetConfiguredOutputPath(), SCHEMATIC::SetCurrentVariant(), JOB::SetTitleBlock(), and SVG.

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobExportPythonBom()

int EESCHEMA_JOBS_HANDLER::JobExportPythonBom ( JOB * aJob)

Definition at line 1002 of file eeschema_jobs_handler.cpp.

References _, JOB::AddOutput(), PROJECT::ApplyTextVars(), SCH_REFERENCE_LIST::CheckAnnotation(), PATHS::EnsurePathExists(), erc, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetConfiguredOutputPath(), SCH_REFERENCE_LIST::GetCount(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), getSchematic(), SCH_SHEET_LIST::GetSymbols(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), GNL_OPT_BOM, SCHEMATIC::Hierarchy(), JOB_EXPORT_SCH_PYTHONBOM::m_filename, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, SCHEMATIC::Project(), res, SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, JOB::SetConfiguredOutputPath(), JOB::SetTitleBlock(), SYMBOL_FILTER_NON_POWER, and FILEEXT::XmlFileExtension.

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobImport()

int EESCHEMA_JOBS_HANDLER::JobImport ( JOB * aJob)

Definition at line 2349 of file eeschema_jobs_handler.cpp.

References _, JOB_SCH_IMPORT::ALTIUM, JOB_SCH_IMPORT::AUTO, JOB_SCH_IMPORT::CADSTAR, DefaultImportOutputPath(), DELETE_REMOVED_ITEMS, JOB_SCH_IMPORT::DIPTRACE, dummy, JOB_SCH_IMPORT::EAGLE, JOB_SCH_IMPORT::EASYEDA, JOB_SCH_IMPORT::EASYEDAPRO, JOB_SCH_IMPORT::EASYPC, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, CLI::EXIT_CODES::ERR_UNKNOWN_FILE_FORMAT, fileType(), IMPORT_MESSAGE_COLLECTOR::Flush(), GetBoardNetNameMap(), JOB::GetConfiguredOutputPath(), SCH_SCREENS::GetCount(), SCH_SHEET::GetName(), SETTINGS_MANAGER::GetProject(), SCH_SCREENS::GetScreen(), PGM_BASE::GetSettingsManager(), SCH_SCREENS::GetSheet(), DS_DATA_MODEL::GetTheInstance(), GLOBAL_CLEANUP, SCH_IO_MGR::GuessPluginTypeFromSchPath(), SETTINGS_MANAGER::IsProjectOpenNotDummy(), SCH_SHEET::IsVirtualRootSheet(), SCH_SCREEN::Items(), FILEEXT::KiCadSchematicFileExtension, KICTL_NONKICAD_ONLY, Kiface(), SETTINGS_MANAGER::LoadProject(), JOB_SCH_IMPORT::LTSPICE, JOB_SCH_IMPORT::m_format, JOB_SCH_IMPORT::m_inputFile, JOB_SCH_IMPORT::m_netNameMap, JOB_DISPATCHER::m_reporter, JOB_SCH_IMPORT::m_reportFile, JOB_SCH_IMPORT::m_reportFormat, EDA_ITEM::m_Uuid, NONE, EE_RTREE::OfType(), JOB_SCH_IMPORT::ORCAD, JOB_SCH_IMPORT::PADS, path, JOB_SCH_IMPORT::PCAD, Pgm(), PrepareSaveAsFiles(), SETTINGS_MANAGER::Prj(), project, FILEEXT::ProjectFileExtension, SCH_COMMIT::Push(), ReconcileImportedSymbols(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, SCH_SYMBOL_T, DS_DATA_MODEL::SetEmptyLayout(), SCH_IO_MGR::ShowType(), SKIP_CONNECTIVITY, SKIP_UNDO, CLI::EXIT_CODES::SUCCESS, JOB_SCH_IMPORT::TARGET3001, IO_ERROR::What(), and WriteImportReport().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobSchDiff()

int EESCHEMA_JOBS_HANDLER::JobSchDiff ( JOB * aJob)

Definition at line 2754 of file eeschema_jobs_handler.cpp.

References _, KICAD_DIFF::DIFF_EMIT_OPTIONS::comparisonGeometry, KICAD_DIFF::SCH_DIFFER::Diff(), KICAD_DIFF::DiffExitCode(), SCRATCH_DOC< DOC >::doc, KICAD_DIFF::DIFF_EMIT_OPTIONS::docKind, KICAD_DIFF::EmitDiffResult(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, KICAD_DIFF::ExtractSchematicGeometry(), PGM_BASE::GetSettingsManager(), loadScratchSchematic(), JOB_DIFF_BASE::m_exitCodeOnly, JOB_DIFF_BASE::m_inputA, JOB_DIFF_BASE::m_inputB, JOB_DISPATCHER::m_reporter, KICAD_DIFF::MakeEmitOptions(), Pgm(), KICAD_DIFF::DIFF_EMIT_OPTIONS::referenceGeometry, result, RPT_SEVERITY_ERROR, and KICAD_DIFF::SCH.

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobSchErc()

int EESCHEMA_JOBS_HANDLER::JobSchErc ( JOB * aJob)

Definition at line 1351 of file eeschema_jobs_handler.cpp.

References _, PROJECT::ApplyTextVars(), LIBRARY_MANAGER_ADAPTER::AsyncLoad(), LIBRARY_MANAGER_ADAPTER::BlockUntilLoaded(), SCH_EDIT_FRAME::ClearErcMarkers(), PATHS::EnsurePathExists(), CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, CLI::EXIT_CODES::ERR_UNKNOWN, KIWAY::FACE_CVPCB, FRAME_SCH, JOB::GetConfiguredOutputPath(), getDrawingSheetProxyView(), SCHEMATIC::GetFileName(), JOB::GetFullOutputPath(), getSchematic(), SCH_SCREEN::GetTitleBlock(), JOB::GetVarOverrides(), INCH, JOB_RC::INCH, JOB_RC::JSON, FILEEXT::JsonFileExtension, JOB_RC::m_exitCodeViolations, JOB_RC::m_filename, JOB_RC::m_format, JOB_DISPATCHER::m_kiway, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, JOB_RC::m_severity, JOB_RC::m_units, MILS, JOB_RC::MILS, MM, JOB_RC::MM, Pgm(), SCHEMATIC::Project(), SCH_EDIT_FRAME::RefreshErcMarkers(), FILEEXT::ReportFileExtension, SCHEMATIC::RootScreen(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, ERC_TESTER::RunTests(), SCH_EDIT_FRAME::Schematic(), JOB::SetTitleBlock(), JOB::SetWorkingOutputPath(), CLI::EXIT_CODES::SUCCESS, PROJECT_SCH::SymbolLibAdapter(), ERC_REPORT::WriteJsonReport(), and ERC_REPORT::WriteTextReport().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobSymDiff()

int EESCHEMA_JOBS_HANDLER::JobSymDiff ( JOB * aJob)

Definition at line 2867 of file eeschema_jobs_handler.cpp.

References KICAD_DIFF::DIFF_EMIT_OPTIONS::comparisonGeometry, KICAD_DIFF::SYM_LIB_DIFFER::Diff(), KICAD_DIFF::DiffExitCode(), KICAD_DIFF::DIFF_EMIT_OPTIONS::docKind, KICAD_DIFF::EmitDiffResult(), CLI::EXIT_CODES::ERR_UNKNOWN, loadSymbolLibrarySide(), JOB_DIFF_BASE::m_exitCodeOnly, JOB_DIFF_BASE::m_inputA, JOB_DIFF_BASE::m_inputB, JOB_DISPATCHER::m_reporter, KICAD_DIFF::MakeEmitOptions(), KICAD_DIFF::DIFF_EMIT_OPTIONS::referenceGeometry, result, CLI::EXIT_CODES::SUCCESS, KICAD_DIFF::SYM_LIB, and symbolLibraryGeometry().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobSymExportSvg()

int EESCHEMA_JOBS_HANDLER::JobSymExportSvg ( JOB * aJob)

Definition at line 1144 of file eeschema_jobs_handler.cpp.

References _, DEFAULT_LINE_WIDTH_MILS, doSymExportSvg(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_UNKNOWN, GetColorSettings(), SCH_RENDER_SETTINGS::LoadColors(), JOB_SYM_EXPORT_SVG::m_colorTheme, JOB_SYM_EXPORT_SVG::m_includeHiddenFields, JOB_SYM_EXPORT_SVG::m_includeHiddenPins, JOB_SYM_EXPORT_SVG::m_libraryPath, JOB_SYM_EXPORT_SVG::m_outputDirectory, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, SCH_RENDER_SETTINGS::m_ShowHiddenFields, SCH_RENDER_SETTINGS::m_ShowHiddenPins, JOB_SYM_EXPORT_SVG::m_symbol, name, CLI::EXIT_CODES::OK, RPT_SEVERITY_ERROR, schIUScale, and KIGFX::RENDER_SETTINGS::SetDefaultPenWidth().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobSymUpgrade()

int EESCHEMA_JOBS_HANDLER::JobSymUpgrade ( JOB * aJob)

Definition at line 1267 of file eeschema_jobs_handler.cpp.

References _, SCH_IO_MGR::ConvertLibrary(), CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_UNKNOWN, fileType(), SCH_IO_KICAD_SEXPR_LIB_CACHE::GetFileFormatVersionAtLoad(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), JOB_SYM_UPGRADE::m_force, JOB_SYM_UPGRADE::m_libraryPath, JOB_SYM_UPGRADE::m_outputLibraryPath, JOB_DISPATCHER::m_progressReporter, JOB_DISPATCHER::m_reporter, CLI::EXIT_CODES::OK, RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), SCH_IO_LIB_CACHE::SetFileName(), SCH_IO_LIB_CACHE::SetModified(), and SEXPR_SYMBOL_LIB_FILE_VERSION.

Referenced by EESCHEMA_JOBS_HANDLER().

◆ JobUpgrade()

int EESCHEMA_JOBS_HANDLER::JobUpgrade ( JOB * aJob)

Definition at line 1460 of file eeschema_jobs_handler.cpp.

References _, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_UNKNOWN, SCH_SCREEN::GetFileFormatVersionAtLoad(), getSchematic(), JOB_SCH_UPGRADE::m_filename, JOB_SCH_UPGRADE::m_force, JOB_DISPATCHER::m_reporter, SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, SEXPR_SCHEMATIC_FILE_VERSION, CLI::EXIT_CODES::SUCCESS, and IO_ERROR::What().

Referenced by EESCHEMA_JOBS_HANDLER().

◆ OpenDiffDialog()

int EESCHEMA_JOBS_HANDLER::OpenDiffDialog ( KICAD_DIFF::DOC_KIND aKind,
const wxString & aFileA,
const wxString & aFileB,
const wxString & aLabelA,
const wxString & aLabelB,
wxWindow * aParent,
REPORTER * aReporter )

Definition at line 3035 of file eeschema_jobs_handler.cpp.

References KICAD_DIFF::DIFF_COLOR_THEME::comparison, KICAD_DIFF::ConfigureSchDiffCanvasContext(), SCH_DIFF_SIDES::diff, KICAD_DIFF::ExtractSchematicGeometry(), KICAD_DIFF::ITEM_CHANGE::id, KICAD_DIFF::ITEM_CHANGE::kind, loadSchDiffSides(), JOB_DISPATCHER::m_reporter, Pgm(), KICAD_DIFF::DIFF_COLOR_THEME::reference, KICAD_DIFF::REMOVED, result, SCHEMATIC::RootScreen(), KICAD_DIFF::SCH, SCH_DIFF_SIDES::schA, SCH_DIFF_SIDES::schB, and CLI::EXIT_CODES::SUCCESS.

◆ Register()

void JOB_DISPATCHER::Register ( const std::string & aJobTypeName,
std::function< int(JOB *job)> aHandler,
std::function< bool(JOB *job, wxWindow *aParent)> aConfigHandler )
inherited

Definition at line 36 of file job_dispatcher.cpp.

References m_jobConfigHandlers, and m_jobHandlers.

Referenced by EESCHEMA_JOBS_HANDLER::EESCHEMA_JOBS_HANDLER(), GERBVIEW_JOBS_HANDLER::GERBVIEW_JOBS_HANDLER(), and PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER().

◆ RunJob()

int JOB_DISPATCHER::RunJob ( JOB * aJob,
REPORTER * aReporter,
PROGRESS_REPORTER * aProgressReporter )
inherited

Definition at line 45 of file job_dispatcher.cpp.

References JOB::ClearExistingOutputs(), CLI::EXIT_CODES::ERR_UNKNOWN, JOB::GetType(), m_jobHandlers, m_progressReporter, m_reporter, and result.

◆ RunMerge()

int EESCHEMA_JOBS_HANDLER::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 exports, not the JOB system).

Definition at line 3189 of file eeschema_jobs_handler.cpp.

References JOB_DISPATCHER::m_reporter, runSchMerge(), runSymLibMerge(), and KICAD_DIFF::SYM_LIB.

◆ runSchMerge()

int EESCHEMA_JOBS_HANDLER::runSchMerge ( const wxString & aAncestor,
const wxString & aOurs,
const wxString & aTheirs,
const wxString & aOutput,
bool aInteractive )
private

Definition at line 3206 of file eeschema_jobs_handler.cpp.

References _, DIALOG_KICAD_MERGE_3WAY::ANCESTOR, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::ancestorGeometry, KICAD_DIFF::SCH_MERGE_APPLIER::Apply(), KICAD_DIFF::ApplyProjectFilePatches(), KICAD_DIFF::BuildConflictList(), SCHEMATIC::BuildSheetListSortedByPageNumbers(), KICAD_DIFF::CollectChangeBBoxes(), KICAD_DIFF::DIFF_COLOR_THEME::comparison, KICAD_DIFF::ConfigureSchDiffCanvasContext(), KICAD_DIFF::MERGE_PLAN::ConflictCount(), DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::describeItem, KICAD_DIFF::SCH_DIFFER::Diff(), SCRATCH_DOC< DOC >::doc, KICAD_DIFF::DOC_PROP_DRAWING_SHEET, KICAD_DIFF::DOC_PROP_ERC_SEVERITIES, KICAD_DIFF::SCH_MERGE_APPLIER::REPORT::drawingSheetFileTouched, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::drawSide, empty(), KICAD_DIFF::SCH_MERGE_APPLIER::REPORT::ercSeveritiesTouched, CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_CANCELLED, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, CLI::EXIT_CODES::ERR_UNKNOWN, KICAD_DIFF::ExtractSchematicGeometry(), KICAD_DIFF::VALIDATION_REPORT::failures, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::formatNotice, SCH_SCREENS::GetCount(), SCH_SCREEN::GetFileName(), PROJECT::GetProjectFile(), KICAD_DIFF::SCH_MERGE_APPLIER::GetReport(), DIALOG_KICAD_MERGE_3WAY::GetResolvedPlan(), SCH_SCREENS::GetScreen(), SCH_SHEET::GetScreen(), PGM_BASE::GetSettingsManager(), SCH_SCREENS::GetSheet(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), JSON_SETTINGS::Internals(), SCH_SCREEN::Items(), loadScratchSchematic(), JOB_DISPATCHER::m_reporter, MM, EE_RTREE::OfType(), KICAD_DIFF::OlderFormatNotice(), DIALOG_KICAD_MERGE_3WAY::OURS, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::oursBBoxes, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::oursGeometry, path, Pgm(), KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), plan(), SCRATCH_DOC< DOC >::project, FILEEXT::ProjectFileExtension, KICAD_DIFF::SCH_MERGE_APPLIER::REPORT::projectFileTouched, KICAD_DIFF::DIFF_COLOR_THEME::reference, KICAD_DIFF::MERGE_PLAN::Resolved(), SCHEMATIC::RootScreen(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, KICAD_DIFF::SCH, SCH_SHEET_T, schIUScale, SCH_SHEET::SetFileName(), SEXPR_SCHEMATIC_FILE_VERSION, KICAD_DIFF::SCH_MERGE_APPLIER::REPORT::sheetActionsSkipped, DIALOG_SHIM::ShowModal(), PROJECT_FILE::Store(), CLI::EXIT_CODES::SUCCESS, DIALOG_KICAD_MERGE_3WAY::THEIRS, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::theirsBBoxes, DIALOG_KICAD_MERGE_3WAY::CONFLICT_CONTEXT::theirsGeometry, KICAD_DIFF::SCH_MERGE_APPLIER::REPORT::validation, and IO_ERROR::What().

Referenced by RunMerge().

◆ runSymLibMerge()

int EESCHEMA_JOBS_HANDLER::runSymLibMerge ( const wxString & aAncestor,
const wxString & aOurs,
const wxString & aTheirs,
const wxString & aOutput )
private

Definition at line 3559 of file eeschema_jobs_handler.cpp.

References _, SCH_IO_LIB_CACHE::AddSymbol(), KICAD_DIFF::LIB_MERGE_APPLIER< ITEM >::Apply(), KICAD_DIFF::SYM_LIB_DIFFER::Diff(), CLI::EXIT_CODES::ERR_ARGS, CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE, CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT, CLI::EXIT_CODES::ERR_RC_VIOLATIONS, KICAD_DIFF::LIB_MERGE_APPLIER< ITEM >::GetReport(), KICAD_DIFF::SYM_LIB_DIFFER::LoadLibrary(), JOB_DISPATCHER::m_reporter, KICAD_DIFF::KICAD_MERGE_ENGINE::Plan(), plan(), KICAD_DIFF::MERGE_PLAN::Resolved(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), SCH_IO_LIB_CACHE::SetModified(), CLI::EXIT_CODES::SUCCESS, KICAD_DIFF::MERGE_PLAN::unresolved, and IO_ERROR::What().

Referenced by RunMerge().

◆ SetProgressReporter()

void JOB_DISPATCHER::SetProgressReporter ( PROGRESS_REPORTER * aReporter)
inherited

Definition at line 84 of file job_dispatcher.cpp.

References m_progressReporter.

◆ SetReporter()

void JOB_DISPATCHER::SetReporter ( REPORTER * aReporter)
inherited

Definition at line 77 of file job_dispatcher.cpp.

References m_reporter.

Referenced by runDowngradeJob().

Member Data Documentation

◆ m_cliSchematic

SCHEMATIC* EESCHEMA_JOBS_HANDLER::m_cliSchematic
private

Definition at line 119 of file eeschema_jobs_handler.h.

Referenced by ClearCachedSchematic(), EESCHEMA_JOBS_HANDLER(), and getSchematic().

◆ m_cliSchematicRootValidated

bool EESCHEMA_JOBS_HANDLER::m_cliSchematicRootValidated = false
private

Definition at line 120 of file eeschema_jobs_handler.h.

Referenced by ClearCachedSchematic(), and getSchematic().

◆ m_jobConfigHandlers

std::map<std::string, std::function<bool( JOB* job, wxWindow* aParent )> > JOB_DISPATCHER::m_jobConfigHandlers
privateinherited

Definition at line 55 of file job_dispatcher.h.

Referenced by HandleJobConfig(), and Register().

◆ m_jobHandlers

std::map<std::string, std::function<int( JOB* job )> > JOB_DISPATCHER::m_jobHandlers
privateinherited

Definition at line 53 of file job_dispatcher.h.

Referenced by Register(), and RunJob().

◆ m_kiway

KIWAY* JOB_DISPATCHER::m_kiway
protectedinherited

Definition at line 48 of file job_dispatcher.h.

Referenced by PCBNEW_JOBS_HANDLER::getBoard(), EESCHEMA_JOBS_HANDLER::getSchematic(), PCBNEW_JOBS_HANDLER::getToolManager(), JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobExportDrc(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

◆ m_progressReporter

PROGRESS_REPORTER* JOB_DISPATCHER::m_progressReporter
protectedinherited

Definition at line 50 of file job_dispatcher.h.

Referenced by JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportOdb(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), PCBNEW_JOBS_HANDLER::preparePlotLayers(), PCBNEW_JOBS_HANDLER::refillFabZones(), RunJob(), and SetProgressReporter().

◆ m_reporter

REPORTER* JOB_DISPATCHER::m_reporter
protectedinherited

Definition at line 49 of file job_dispatcher.h.

Referenced by EESCHEMA_JOBS_HANDLER::AttachDiffCanvases(), PCBNEW_JOBS_HANDLER::AttachDiffCanvases(), GERBVIEW_JOBS_HANDLER::checkStrictMode(), PCBNEW_JOBS_HANDLER::convertLayerArg(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), PCBNEW_JOBS_HANDLER::getBoard(), EESCHEMA_JOBS_HANDLER::getSchematic(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), JOB_DISPATCHER(), PCBNEW_JOBS_HANDLER::JobDiff(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), PCBNEW_JOBS_HANDLER::JobDowngrade(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIdf(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportSpecctraDsn(), PCBNEW_JOBS_HANDLER::JobExportStackup(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCBNEW_JOBS_HANDLER::JobFpDiff(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), GERBVIEW_JOBS_HANDLER::JobGerberInfo(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymDiff(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), EESCHEMA_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), PCBNEW_JOBS_HANDLER::preparePlotLayers(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), RunJob(), EESCHEMA_JOBS_HANDLER::RunMerge(), PCBNEW_JOBS_HANDLER::RunMerge(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and SetReporter().

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