AllSpiceMirrors/kicad
7
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-04-05 00:15:30 +00:00
Files Issues Releases Activity

Avoid altering the configured output path during run in case of empty paths

Browse Source
This commit is contained in:
Marek Roszko 2025-01-14 20:02:53 -05:00
parent 1d8ed071b8
commit 5c3004b96e
38 changed files with 121 additions and 87 deletions

4
common/dialogs/dialog_rc_job.cpp
View File

@ -81,7 +81,7 @@ void DIALOG_RC_JOB::OnFormatChoice( wxCommandEvent& event )
bool DIALOG_RC_JOB::TransferDataToWindow()
{
m_textCtrlOutputPath->SetValue( m_job->GetOutputPath() );
m_textCtrlOutputPath->SetValue( m_job->GetConfiguredOutputPath() );
setSelectedFormat( m_job->m_format );
m_cbHaltOutput->SetValue( m_job->m_exitCodeViolations );
@ -94,7 +94,7 @@ bool DIALOG_RC_JOB::TransferDataToWindow()
bool DIALOG_RC_JOB::TransferDataFromWindow()
{
m_job->SetOutputPath( m_textCtrlOutputPath->GetValue() );
m_job->SetConfiguredOutputPath( m_textCtrlOutputPath->GetValue() );
m_job->m_format = getSelectedFormat();
m_job->m_exitCodeViolations = m_cbHaltOutput->GetValue();

9
common/jobs/job.cpp
View File

@ -28,7 +28,8 @@ JOB::JOB( const std::string& aType, bool aOutputIsDirectory ) :
m_tempOutputDirectory(),
m_outputPath(),
m_outputPathIsDirectory( aOutputIsDirectory ),
m_description()
m_description(),
m_workingOutputPath()
{
m_params.emplace_back( new JOB_PARAM<wxString>( "description",
&m_description, m_description ) );
@ -103,7 +104,9 @@ wxString JOB::GetFullOutputPath( PROJECT* aProject ) const
return m_titleBlock.TextVarResolver( token, aProject );
};
wxString outPath = ExpandTextVars( m_outputPath, &textResolver );
// use the working output path (nonsaved) over the configured path if its not empty
wxString outPath = m_workingOutputPath.IsEmpty() ? m_outputPath : m_workingOutputPath;
outPath = ExpandTextVars( outPath, &textResolver );
if( !m_tempOutputDirectory.IsEmpty() )
{
@ -140,7 +143,7 @@ wxString JOB::GetFullOutputPath( PROJECT* aProject ) const
}
void JOB::SetOutputPath( const wxString& aPath )
void JOB::SetConfiguredOutputPath( const wxString& aPath )
{
m_outputPath = aPath;
}

37
common/jobs/job.h
View File

@ -208,15 +208,45 @@ public:
const std::vector<JOB_OUTPUT>& GetOutputs() { return m_outputs; }
void AddOutput( wxString aOutputPath ) { m_outputs.emplace_back( aOutputPath ); }
/**
* Sets the temporary output directory for the job, this is used to prefix with a given
* output path when GetFullOutputPath is called. This is intended for use with running jobsets
* and otherwise has no impact on individual job runs outside jobsets.
*/
void SetTempOutputDirectory( const wxString& aBase );
void SetOutputPath( const wxString& aPath );
wxString GetOutputPath() const { return m_outputPath; }
/**
* Sets the configured output path for the job, this path is always saved to file
*/
void SetConfiguredOutputPath( const wxString& aPath );
/**
* Returns the configured output path for the job
*/
wxString GetConfiguredOutputPath() const { return m_outputPath; }
/**
* Sets a transient output path for the job, it takes priority over the configured output path
* when GetFullOutputPath is called.
*/
void SetWorkingOutputPath( const wxString& aPath ) { m_workingOutputPath = aPath; }
/**
* Returns the working output path for the job, if one has been set
*/
wxString GetWorkingOutputPath() const { return m_workingOutputPath; }
/**
* Returns the full output path for the job, taking into account the configured output path,
* any configured working path and the temporary output directory.
*
* Additionally variable resolution will take place
*/
wxString GetFullOutputPath( PROJECT* aProject ) const;
bool OutputPathFullSpecified() const;
bool GetOutpathIsDirectory() const { return m_outputPathIsDirectory; }
bool GetOutputPathIsDirectory() const { return m_outputPathIsDirectory; }
protected:
std::string m_type;
@ -228,6 +258,7 @@ protected:
wxString m_outputPath;
bool m_outputPathIsDirectory;
wxString m_description;
wxString m_workingOutputPath;
std::vector<JOB_PARAM_BASE*> m_params;

2
common/jobs/job_export_pcb_ipc2581.cpp
View File

@ -85,7 +85,7 @@ void JOB_EXPORT_PCB_IPC2581::SetDefaultOutputPath( const wxString& aReferenceNam
fn.SetExt( FILEEXT::Ipc2581FileExtension );
SetOutputPath( fn.GetFullName() );
SetConfiguredOutputPath( fn.GetFullName() );
}
REGISTER_JOB( pcb_export_ipc2581, _HKI( "PCB: Export IPC2581" ), KIWAY::FACE_PCB,

2
common/jobs/job_export_pcb_odb.cpp
View File

@ -70,7 +70,7 @@ void JOB_EXPORT_PCB_ODB::SetDefaultOutputPath( const wxString& aReferenceName )
fn.SetExt( "zip" );
SetOutputPath( fn.GetFullName() );
SetConfiguredOutputPath( fn.GetFullName() );
}
REGISTER_JOB( pcb_export_odb, _HKI( "PCB: Export ODB++" ), KIWAY::FACE_PCB,

2
common/jobs/job_export_pcb_pos.cpp
View File

@ -109,7 +109,7 @@ void JOB_EXPORT_PCB_POS::SetDefaultOutputPath( const wxString& aReferenceName )
else if( m_format == JOB_EXPORT_PCB_POS::FORMAT::GERBER )
fn.SetExt( FILEEXT::GerberFileExtension );
SetOutputPath( fn.GetFullName() );
SetConfiguredOutputPath( fn.GetFullName() );
}
REGISTER_JOB( pcb_export_pos, _HKI( "PCB: Export Position Data" ), KIWAY::FACE_PCB, JOB_EXPORT_PCB_POS );

4
eeschema/dialogs/dialog_export_netlist.cpp
View File

@ -263,7 +263,7 @@ DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST( SCH_EDIT_FRAME* aEditFrame, wxWind
SetTitle( m_job->GetSettingsDialogTitle() );
m_MessagesBox->Hide();
m_outputPath->SetValue( m_job->GetOutputPath() );
m_outputPath->SetValue( m_job->GetConfiguredOutputPath() );
SetupStandardButtons();
@ -473,7 +473,7 @@ bool DIALOG_EXPORT_NETLIST::NetlistUpdateOpt()
}
}
m_job->SetOutputPath( m_outputPath->GetValue() );
m_job->SetConfiguredOutputPath( m_outputPath->GetValue() );
m_job->m_spiceSaveAllVoltages = saveAllVoltages;
m_job->m_spiceSaveAllCurrents = saveAllCurrents;
m_job->m_spiceSaveAllDissipations = saveAllDissipations;

4
eeschema/dialogs/dialog_plot_schematic.cpp
View File

@ -226,7 +226,7 @@ void DIALOG_PLOT_SCHEMATIC::initDlg()
// And then hide it
m_plotFormatOpt->Hide();
m_outputDirectoryName->SetValue( m_job->GetOutputPath() );
m_outputDirectoryName->SetValue( m_job->GetConfiguredOutputPath() );
}
}
@ -455,7 +455,7 @@ void DIALOG_PLOT_SCHEMATIC::OnPlotAll( wxCommandEvent& event )
m_job->m_PDFMetadata = m_plotPDFMetadata->GetValue();
m_job->m_plotDrawingSheet = m_plotDrawingSheet->GetValue();
m_job->m_plotAll = true;
m_job->SetOutputPath( m_outputDirectoryName->GetValue() );
m_job->SetConfiguredOutputPath( m_outputDirectoryName->GetValue() );
m_job->m_HPGLPlotOrigin =
static_cast<JOB_HPGL_PLOT_ORIGIN_AND_UNITS>( m_plotOriginOpt->GetSelection() );

4
eeschema/dialogs/dialog_symbol_fields_table.cpp
View File

@ -367,7 +367,7 @@ DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE( SCH_EDIT_FRAME* parent,
if( m_job )
{
m_outputFileName->SetValue( m_job->GetOutputPath() );
m_outputFileName->SetValue( m_job->GetConfiguredOutputPath() );
}
else
{
@ -1422,7 +1422,7 @@ void DIALOG_SYMBOL_FIELDS_TABLE::OnOk( wxCommandEvent& aEvent )
if( m_job )
{
m_job->SetOutputPath( m_outputFileName->GetValue() );
m_job->SetConfiguredOutputPath( m_outputFileName->GetValue() );
if( m_currentBomFmtPreset )
m_job->m_bomFmtPresetName = m_currentBomFmtPreset->name;

20
eeschema/eeschema_jobs_handler.cpp
View File

@ -337,7 +337,7 @@ int EESCHEMA_JOBS_HANDLER::JobExportPlot( JOB* aJob )
wxString outPath = aPlotJob->GetFullOutputPath( &sch->Prj() );
if( !PATHS::EnsurePathExists( outPath,
!aPlotJob->GetOutpathIsDirectory() ) )
!aPlotJob->GetOutputPathIsDirectory() ) )
{
m_reporter->Report( _( "Failed to create output directory\n" ), RPT_SEVERITY_ERROR );
return CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT;
@ -351,7 +351,7 @@ int EESCHEMA_JOBS_HANDLER::JobExportPlot( JOB* aJob )
plotOpts.m_PDFPropertyPopups = aPlotJob->m_PDFPropertyPopups;
plotOpts.m_PDFHierarchicalLinks = aPlotJob->m_PDFHierarchicalLinks;
plotOpts.m_PDFMetadata = aPlotJob->m_PDFMetadata;
if( aPlotJob->GetOutpathIsDirectory() )
if( aPlotJob->GetOutputPathIsDirectory() )
{
plotOpts.m_outputDirectory = outPath;
plotOpts.m_outputFile = wxEmptyString;
@ -467,13 +467,13 @@ int EESCHEMA_JOBS_HANDLER::JobExportNetlist( JOB* aJob )
return CLI::EXIT_CODES::ERR_UNKNOWN;
}
if( aNetJob->GetOutputPath().IsEmpty() )
if( aNetJob->GetConfiguredOutputPath().IsEmpty() )
{
wxFileName fn = sch->GetFileName();
fn.SetName( fn.GetName() );
fn.SetExt( fileExt );
aNetJob->SetOutputPath( fn.GetFullName() );
aNetJob->SetConfiguredOutputPath( fn.GetFullName() );
}
wxString outPath = aNetJob->GetFullOutputPath( &sch->Prj() );
@ -678,13 +678,13 @@ int EESCHEMA_JOBS_HANDLER::JobExportBom( JOB* aJob )
dataModel.ApplyBomPreset( preset );
if( aBomJob->GetOutputPath().IsEmpty() )
if( aBomJob->GetConfiguredOutputPath().IsEmpty() )
{
wxFileName fn = sch->GetFileName();
fn.SetName( fn.GetName() );
fn.SetExt( FILEEXT::CsvFileExtension );
aBomJob->SetOutputPath( fn.GetFullName() );
aBomJob->SetConfiguredOutputPath( fn.GetFullName() );
}
wxString outPath = aBomJob->GetFullOutputPath( &sch->Prj() );
@ -801,13 +801,13 @@ int EESCHEMA_JOBS_HANDLER::JobExportPythonBom( JOB* aJob )
std::unique_ptr<NETLIST_EXPORTER_XML> xmlNetlist =
std::make_unique<NETLIST_EXPORTER_XML>( sch );
if( aNetJob->GetOutputPath().IsEmpty() )
if( aNetJob->GetConfiguredOutputPath().IsEmpty() )
{
wxFileName fn = sch->GetFileName();
fn.SetName( fn.GetName() + "-bom" );
fn.SetExt( FILEEXT::XmlFileExtension );
aNetJob->SetOutputPath( fn.GetFullName() );
aNetJob->SetConfiguredOutputPath( fn.GetFullName() );
}
wxString outPath = aNetJob->GetFullOutputPath( &sch->Prj() );
@ -1116,7 +1116,7 @@ int EESCHEMA_JOBS_HANDLER::JobSchErc( JOB* aJob )
aJob->SetTitleBlock( sch->RootScreen()->GetTitleBlock() );
sch->Prj().ApplyTextVars( aJob->GetVarOverrides() );
if( ercJob->GetOutputPath().IsEmpty() )
if( ercJob->GetConfiguredOutputPath().IsEmpty() )
{
wxFileName fn = sch->GetFileName();
fn.SetName( fn.GetName() + wxS( "-erc" ) );
@ -1126,7 +1126,7 @@ int EESCHEMA_JOBS_HANDLER::JobSchErc( JOB* aJob )
else
fn.SetExt( FILEEXT::ReportFileExtension );
ercJob->SetOutputPath( fn.GetFullName() );
ercJob->SetConfiguredOutputPath( fn.GetFullName() );
}
wxString outPath = ercJob->GetFullOutputPath( &sch->Prj() );

2
kicad/cli/command_pcb_drc.cpp
View File

@ -95,7 +95,7 @@ int CLI::PCB_DRC_COMMAND::doPerform( KIWAY& aKiway )
{
std::unique_ptr<JOB_PCB_DRC> drcJob( new JOB_PCB_DRC() );
drcJob->SetOutputPath( m_argOutput );
drcJob->SetConfiguredOutputPath( m_argOutput );
drcJob->m_filename = m_argInput;
drcJob->SetVarOverrides( m_argDefineVars );
drcJob->m_reportAllTrackErrors = m_argParser.get<bool>( ARG_ALL_TRACK_ERRORS );

2
kicad/cli/command_pcb_export_3d.cpp
View File

@ -247,7 +247,7 @@ int CLI::PCB_EXPORT_3D_COMMAND::doPerform( KIWAY& aKiway )
params.m_IncludeUnspecified = !m_argParser.get<bool>( ARG_NO_UNSPECIFIED );
params.m_IncludeDNP = !m_argParser.get<bool>( ARG_NO_DNP );
params.m_Overwrite = m_argParser.get<bool>( ARG_FORCE );
step->SetOutputPath( m_argOutput );
step->SetConfiguredOutputPath( m_argOutput );
step->m_filename = m_argInput;
step->m_format = m_format;

6
kicad/cli/command_pcb_export_drill.cpp
View File

@ -106,11 +106,11 @@ int CLI::PCB_EXPORT_DRILL_COMMAND::doPerform( KIWAY& aKiway )
std::unique_ptr<JOB_EXPORT_PCB_DRILL> drillJob( new JOB_EXPORT_PCB_DRILL() );
drillJob->m_filename = m_argInput;
drillJob->SetOutputPath( m_argOutput );
drillJob->SetConfiguredOutputPath( m_argOutput );
if( !drillJob->GetOutputPath().IsEmpty() )
if( !drillJob->GetConfiguredOutputPath().IsEmpty() )
{
wxFileName fn( drillJob->GetOutputPath(), wxEmptyString );
wxFileName fn( drillJob->GetConfiguredOutputPath(), wxEmptyString );
if( !fn.IsDir() )
{

2
kicad/cli/command_pcb_export_dxf.cpp
View File

@ -111,7 +111,7 @@ int CLI::PCB_EXPORT_DXF_COMMAND::doPerform( KIWAY& aKiway )
std::unique_ptr<JOB_EXPORT_PCB_DXF> dxfJob( new JOB_EXPORT_PCB_DXF() );
dxfJob->m_filename = m_argInput;
dxfJob->SetOutputPath( m_argOutput );
dxfJob->SetConfiguredOutputPath( m_argOutput );
dxfJob->m_drawingSheet = m_argDrawingSheet;
dxfJob->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_pcb_export_gerber.cpp
View File

@ -99,7 +99,7 @@ CLI::PCB_EXPORT_GERBER_COMMAND::PCB_EXPORT_GERBER_COMMAND() : PCB_EXPORT_GERBER_
int CLI::PCB_EXPORT_GERBER_COMMAND::populateJob( JOB_EXPORT_PCB_GERBER* aJob )
{
aJob->m_filename = m_argInput;
aJob->SetOutputPath( m_argOutput );
aJob->SetConfiguredOutputPath( m_argOutput );
aJob->m_drawingSheet = m_argDrawingSheet;
aJob->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_pcb_export_ipc2581.cpp
View File

@ -110,7 +110,7 @@ int CLI::PCB_EXPORT_IPC2581_COMMAND::doPerform( KIWAY& aKiway )
std::unique_ptr<JOB_EXPORT_PCB_IPC2581> ipc2581Job( new JOB_EXPORT_PCB_IPC2581() );
ipc2581Job->m_filename = m_argInput;
ipc2581Job->SetOutputPath( m_argOutput );
ipc2581Job->SetConfiguredOutputPath( m_argOutput );
ipc2581Job->m_drawingSheet = m_argDrawingSheet;
ipc2581Job->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_pcb_export_odb.cpp
View File

@ -68,7 +68,7 @@ int CLI::PCB_EXPORT_ODB_COMMAND::doPerform( KIWAY& aKiway )
std::unique_ptr<JOB_EXPORT_PCB_ODB> job( new JOB_EXPORT_PCB_ODB() );
job->m_filename = m_argInput;
job->SetOutputPath( m_argOutput );
job->SetConfiguredOutputPath( m_argOutput );
job->m_drawingSheet = m_argDrawingSheet;
job->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_pcb_export_pdf.cpp
View File

@ -129,7 +129,7 @@ int CLI::PCB_EXPORT_PDF_COMMAND::doPerform( KIWAY& aKiway )
std::unique_ptr<JOB_EXPORT_PCB_PDF> pdfJob( new JOB_EXPORT_PCB_PDF() );
pdfJob->m_filename = m_argInput;
pdfJob->SetOutputPath( m_argOutput );
pdfJob->SetConfiguredOutputPath( m_argOutput );
pdfJob->m_drawingSheet = m_argDrawingSheet;
pdfJob->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_pcb_export_pos.cpp
View File

@ -99,7 +99,7 @@ int CLI::PCB_EXPORT_POS_COMMAND::doPerform( KIWAY& aKiway )
std::unique_ptr<JOB_EXPORT_PCB_POS> aPosJob( new JOB_EXPORT_PCB_POS() );
aPosJob->m_filename = m_argInput;
aPosJob->SetOutputPath( m_argOutput );
aPosJob->SetConfiguredOutputPath( m_argOutput );
if( !wxFile::Exists( aPosJob->m_filename ) )
{

2
kicad/cli/command_pcb_export_svg.cpp
View File

@ -144,7 +144,7 @@ int CLI::PCB_EXPORT_SVG_COMMAND::doPerform( KIWAY& aKiway )
svgJob->m_plotInvisibleText = m_argParser.get<bool>( ARG_PLOT_INVISIBLE_TEXT );
svgJob->m_filename = m_argInput;
svgJob->SetOutputPath( m_argOutput );
svgJob->SetConfiguredOutputPath( m_argOutput );
svgJob->m_colorTheme = From_UTF8( m_argParser.get<std::string>( ARG_THEME ).c_str() );
svgJob->m_plotDrawingSheet = !m_argParser.get<bool>( ARG_EXCLUDE_DRAWING_SHEET );
svgJob->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_pcb_render.cpp
View File

@ -322,7 +322,7 @@ int CLI::PCB_RENDER_COMMAND::doPerform( KIWAY& aKiway )
{
std::unique_ptr<JOB_PCB_RENDER> renderJob( new JOB_PCB_RENDER() );
renderJob->SetOutputPath( m_argOutput );
renderJob->SetConfiguredOutputPath( m_argOutput );
renderJob->m_filename = m_argInput;
renderJob->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_sch_erc.cpp
View File

@ -85,7 +85,7 @@ int CLI::SCH_ERC_COMMAND::doPerform( KIWAY& aKiway )
{
std::unique_ptr<JOB_SCH_ERC> ercJob( new JOB_SCH_ERC() );
ercJob->SetOutputPath( m_argOutput );
ercJob->SetConfiguredOutputPath( m_argOutput );
ercJob->m_filename = m_argInput;
ercJob->m_exitCodeViolations = m_argParser.get<bool>( ARG_EXIT_CODE_VIOLATIONS );
ercJob->SetVarOverrides( m_argDefineVars );

2
kicad/cli/command_sch_export_bom.cpp
View File

@ -138,7 +138,7 @@ int CLI::SCH_EXPORT_BOM_COMMAND::doPerform( KIWAY& aKiway )
// Basic options
bomJob->m_filename = m_argInput;
bomJob->SetOutputPath( m_argOutput );
bomJob->SetConfiguredOutputPath( m_argOutput );
bomJob->m_bomPresetName = From_UTF8( m_argParser.get<std::string>( ARG_PRESET ).c_str() );
bomJob->m_bomFmtPresetName =

2
kicad/cli/command_sch_export_netlist.cpp
View File

@ -49,7 +49,7 @@ int CLI::SCH_EXPORT_NETLIST_COMMAND::doPerform( KIWAY& aKiway )
std::make_unique<JOB_EXPORT_SCH_NETLIST>();
netJob->m_filename = m_argInput;
netJob->SetOutputPath( m_argOutput );
netJob->SetConfiguredOutputPath( m_argOutput );
if( !wxFile::Exists( netJob->m_filename ) )
{

2
kicad/cli/command_sch_export_plot.cpp
View File

@ -180,7 +180,7 @@ int CLI::SCH_EXPORT_PLOT_COMMAND::doPerform( KIWAY& aKiway )
plotJob->m_theme = From_UTF8( m_argParser.get<std::string>( ARG_THEME ).c_str() );
}
plotJob->SetOutputPath( m_argOutput );
plotJob->SetConfiguredOutputPath( m_argOutput );
plotJob->m_plotAll = plotJob->m_plotPages.size() == 0;

Some files were not shown because too many files have changed in this diff Show More